extend cube validator to support named timeshifts

Author: KSDaemon

packages/cubejs-schema-compiler/src/compiler/CubeValidator.ts

@@ -576,9 +576,12 @@ const timeShiftItemRequired = Joi.object({
 
 const timeShiftItemOptional = Joi.object({
   timeDimension: Joi.func(), // not required
-  interval: regexTimeInterval.required(),
-  type: Joi.string().valid('next', 'prior').required(),
-});
+  interval: regexTimeInterval,
+  name: identifier,
+  type: Joi.string().valid('next', 'prior'),
+})
+  .xor('name', 'interval')
+  .and('interval', 'type');
 
 const MeasuresSchema = Joi.object().pattern(identifierRegex, Joi.alternatives().conditional(Joi.ref('.multiStage'), [
   {
@@ -623,6 +626,16 @@ const MeasuresSchema = Joi.object().pattern(identifierRegex, Joi.alternatives().
   ]
 ));
 
+const CalendarTimeShiftItem = Joi.object({
+  name: identifier,
+  interval: regexTimeInterval,
+  type: Joi.string().valid('next', 'prior'),
+  sql: Joi.func().required(),
+})
+  .or('name', 'interval')
+  .with('interval', 'type')
+  .with('type', 'interval');
+
 const DimensionsSchema = Joi.object().pattern(identifierRegex, Joi.alternatives().try(
   inherit(BaseDimensionWithoutSubQuery, {
     case: Joi.object().keys({
@@ -667,11 +680,7 @@ const DimensionsSchema = Joi.object().pattern(identifierRegex, Joi.alternatives(
   inherit(BaseDimensionWithoutSubQuery, {
     type: Joi.any().valid('time').required(),
     sql: Joi.func().required(),
-    timeShift: Joi.array().items(Joi.object({
-      interval: regexTimeInterval.required(),
-      type: Joi.string().valid('next', 'prior').required(),
-      sql: Joi.func().required(),
-    })),
+    timeShift: Joi.array().items(CalendarTimeShiftItem),
   })
 ));
 

packages/cubejs-schema-compiler/test/unit/__snapshots__/schema.test.ts.snap

@@ -87,9 +87,8 @@ Object {
           "type": "prior",
         },
         Object {
-          "interval": "1 year",
+          "name": "retail_date_prev_year",
           "sql": [Function],
-          "type": "prior",
         },
         Object {
           "interval": "2 year",
@@ -273,9 +272,8 @@ Object {
           "type": "prior",
         },
         Object {
-          "interval": "1 year",
+          "name": "retail_date_prev_year",
           "sql": [Function],
-          "type": "prior",
         },
         Object {
           "interval": "2 year",

packages/cubejs-schema-compiler/test/unit/fixtures/calendar_orders.yml

@@ -46,6 +46,13 @@ cubes:
             interval: 1 year
             type: prior
 
+      - name: count_shifted_named
+        type: count
+        multi_stage: true
+        sql: "{count}"
+        time_shift:
+          - name: retail_date_prev_year
+
       - name: completed_count
         type: count
         filters:

packages/cubejs-schema-compiler/test/unit/fixtures/custom_calendar.js

@@ -41,8 +41,7 @@ cube(`custom_calendar_js`, {
               sql: `{CUBE.retail_date_prev_month}`,
           },
           {
-              interval: '1 year',
-              type: 'prior',
+              name: 'retail_date_prev_year',
               sql: `{CUBE.retail_date_prev_year}`,
           },
           {

packages/cubejs-schema-compiler/test/unit/fixtures/custom_calendar.yml

@@ -45,8 +45,7 @@ cubes:
             type: prior
             sql: "{CUBE.retail_date_prev_month}"
 
-          - interval: 1 year
-            type: prior
+          - name: retail_date_prev_year
             sql: "{CUBE.retail_date_prev_year}"
 
           # All needed intervals should be defined explicitly