Ensure temporal field propagates to time expression

vega · Oct 31, 2023 · c655a5f · c655a5f
1 parent 1263d66
commit c655a5f
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/src/compile/format.ts b/src/compile/format.ts
@@ -95,14 +95,25 @@ export function formatSignalRef({
     }
   }
 
+  function getTimeDef(def: FieldDef<string> | DatumDef<string>) {
+    if (!isFieldDef(def)) {
+      return {
+        unit: undefined,
+        utc: undefined
+      };
+    }
+    return normalizeTimeUnit(def.timeUnit) || {};
+  }
+
   if (isFieldOrDatumDefForTimeFormat(fieldOrDatumDef)) {
+    const {unit: timeUnit, utc: isUTCUnit} = getTimeDef(fieldOrDatumDef);
     const signal = timeFormatExpression({
       field,
-      timeUnit: isFieldDef(fieldOrDatumDef) ? normalizeTimeUnit(fieldOrDatumDef.timeUnit)?.unit : undefined,
+      timeUnit,
       format,
       formatType: config.timeFormatType,
       rawTimeFormat: config.timeFormat,
-      isUTCScale: isScaleFieldDef(fieldOrDatumDef) && fieldOrDatumDef.scale?.type === ScaleType.UTC
+      isUTCScale: isUTCUnit || (isScaleFieldDef(fieldOrDatumDef) && fieldOrDatumDef.scale?.type === ScaleType.UTC)
     });
     return signal ? {signal} : undefined;
   }

diff --git a/test/compile/format.test.ts b/test/compile/format.test.ts
@@ -70,6 +70,17 @@ describe('Format', () => {
       expect(expression).toBe(`utcFormat(datum["yearmonth_a"], '%Y')`);
     });
 
+    it('should get the right time expression for utcyearmonth', () => {
+      const fieldDef = {timeUnit: 'utcyearmonth', field: 'a', type: TEMPORAL} as const;
+      const expression = timeFormatExpression({
+        field: vgField(fieldDef, {expr: 'datum'}),
+        timeUnit: 'month',
+        format: '%Y',
+        isUTCScale: true
+      });
+      expect(expression).toBe(`utcFormat(datum["utcyearmonth_a"], '%Y')`);
+    });
+
     it('should get the right time expression for with a custom timeFormatType', () => {
       const fieldDef = {field: 'a', type: TEMPORAL} as const;
       const expression = timeFormatExpression({
@@ -157,6 +168,19 @@ describe('Format', () => {
   });
 
   describe('formatSignalRef()', () => {
+    it('should derive the correct temporal unit', () => {
+      expect(
+        formatSignalRef({
+          fieldOrDatumDef: {field: 'foo', type: TEMPORAL, timeUnit: 'utcdate'},
+          format: undefined,
+          formatType: undefined,
+          config: {}
+        })
+      ).toEqual({
+        signal:
+          'utcFormat(utcdate_foo, timeUnitSpecifier(["date"], {"year-month":"%b %Y ","year-month-date":"%b %d, %Y "}))'
+      });
+    });
     it('should format ordinal field defs if format is present', () => {
       expect(
         formatSignalRef({