feat(schema-compiler): Support folders via views extends

Author: KSDaemon

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

@@ -224,8 +224,9 @@ export class CubeEvaluator extends CubeSymbols {
   }
 
   private prepareFolders(cube: any, errorReporter: ErrorReporter) {
-    if (Array.isArray(cube.folders)) {
-      cube.folders = cube.folders.map(it => {
+    const folders = cube.rawFolders();
+    if (folders.length) {
+      cube.folders = folders.map(it => {
         const includedMembers = this.allMembersOrList(cube, it.includes);
         const includes = includedMembers.map(memberName => {
           if (memberName.includes('.')) {

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

@@ -26,6 +26,7 @@ interface CubeDefinition {
   pre_aggregations?: Record<string, any>;
   joins?: Record<string, any>;
   accessPolicy?: any[];
+  folders?: any[];
   includes?: any;
   excludes?: any;
   cubes?: any;
@@ -118,6 +119,7 @@ export class CubeSymbols {
     let segments: any;
     let hierarchies: any;
     let accessPolicy: any;
+    let folders: any;
 
     const cubeObject = Object.assign({
       allDefinitions(type: string) {
@@ -131,6 +133,22 @@ export class CubeSymbols {
         }
       },
 
+      // Folders are not a part of Cube Symbols and are constructed in the CubeEvaluator,
+      // but views can extend other views, so we need the ability to access parent's folders.
+      rawFolders() {
+        if (!folders) {
+          if (cubeDefinition.extends) {
+            folders = [
+              ...super.rawFolders(),
+              ...(cubeDefinition.folders || [])
+            ];
+          } else {
+            folders = [...(cubeDefinition.folders || [])];
+          }
+        }
+        return folders;
+      },
+
       get preAggregations() {
         // For preAggregations order is important, and destructing parents cube pre-aggs first will lead to
         // unexpected results, so we can not use common approach with allDefinitions('preAggregations') here.

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

@@ -745,7 +745,8 @@ const baseSchema = {
   refreshKey: CubeRefreshKeySchema,
   fileName: Joi.string().required(),
   extends: Joi.func(),
-  allDefinitions: Joi.func(),
+  allDefinitions: Joi.func(), // Helpers function for extending
+  rawFolders: Joi.func(), // Helpers function for extending
   title: Joi.string(),
   sqlAlias: Joi.string(),
   dataSource: Joi.string(),

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

@@ -1348,67 +1348,6 @@ Array [
 ]
 `;
 
-exports[`Schema Testing Views extends custom granularities and timeshifts 1`] = `
-Object {
-  "aliasMember": "orders.createdAt",
-  "description": undefined,
-  "format": undefined,
-  "granularities": Object {
-    "half_year": Object {
-      "interval": "6 months",
-      "title": "6 month intervals",
-    },
-    "half_year_by_1st_april": Object {
-      "interval": "6 months",
-      "offset": "3 months",
-      "title": "Half year from Apr to Oct",
-    },
-    "half_year_by_1st_june": Object {
-      "interval": "6 months",
-      "origin": "2020-06-01 10:00:00",
-    },
-    "half_year_by_1st_march": Object {
-      "interval": "6 months",
-      "origin": "2020-03-01",
-    },
-  },
-  "meta": undefined,
-  "ownedByCube": false,
-  "sql": [Function],
-  "title": undefined,
-  "type": "time",
-}
-`;
-
-exports[`Schema Testing Views extends custom granularities and timeshifts 2`] = `
-Object {
-  "aggType": "count",
-  "aliasMember": "orders.count_shifted_year",
-  "description": undefined,
-  "format": undefined,
-  "meta": undefined,
-  "multiStage": true,
-  "ownedByCube": false,
-  "sql": [Function],
-  "timeShift": Array [
-    Object {
-      "interval": "1 year",
-      "timeDimension": [Function],
-      "type": "prior",
-    },
-  ],
-  "timeShiftReferences": Array [
-    Object {
-      "interval": "1 year",
-      "timeDimension": "createdAt",
-      "type": "prior",
-    },
-  ],
-  "title": undefined,
-  "type": "number",
-}
-`;
-
 exports[`Schema Testing Views allows to override \`title\`, \`description\`, \`meta\`, and \`format\` on includes members 1`] = `
 Object {
   "accessPolicy": undefined,
@@ -1570,6 +1509,68 @@ Object {
   },
   "name": "orders_view",
   "preAggregations": Object {},
+  "rawFolders": [Function],
   "segments": Object {},
 }
 `;
+
+exports[`Schema Testing Views extends custom granularities and timeshifts 1`] = `
+Object {
+  "aliasMember": "orders.createdAt",
+  "description": undefined,
+  "format": undefined,
+  "granularities": Object {
+    "half_year": Object {
+      "interval": "6 months",
+      "title": "6 month intervals",
+    },
+    "half_year_by_1st_april": Object {
+      "interval": "6 months",
+      "offset": "3 months",
+      "title": "Half year from Apr to Oct",
+    },
+    "half_year_by_1st_june": Object {
+      "interval": "6 months",
+      "origin": "2020-06-01 10:00:00",
+    },
+    "half_year_by_1st_march": Object {
+      "interval": "6 months",
+      "origin": "2020-03-01",
+    },
+  },
+  "meta": undefined,
+  "ownedByCube": false,
+  "sql": [Function],
+  "title": undefined,
+  "type": "time",
+}
+`;
+
+exports[`Schema Testing Views extends custom granularities and timeshifts 2`] = `
+Object {
+  "aggType": "count",
+  "aliasMember": "orders.count_shifted_year",
+  "description": undefined,
+  "format": undefined,
+  "meta": undefined,
+  "multiStage": true,
+  "ownedByCube": false,
+  "sql": [Function],
+  "timeShift": Array [
+    Object {
+      "interval": "1 year",
+      "timeDimension": [Function],
+      "type": "prior",
+    },
+  ],
+  "timeShiftReferences": Array [
+    Object {
+      "interval": "1 year",
+      "timeDimension": "createdAt",
+      "type": "prior",
+    },
+  ],
+  "title": undefined,
+  "type": "number",
+}
+`;

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

@@ -90,6 +90,20 @@ views:
           - users_age
           - users_state
           - renamed_orders_status
+  - name: test_view3
+    extends: test_view2
+    cubes:
+      - join_path: users
+        prefix: true
+        includes:
+          - city
+          - gender
+    folders:
+      - name: folder2
+        includes:
+          - users_city
+          - users_gender
+
   # - name: empty_view
   #   cubes:
   #     - join_path: orders

packages/cubejs-schema-compiler/test/unit/folders.test.ts

@@ -43,6 +43,43 @@ describe('Cube Folders', () => {
     );
   });
 
+  it('folders from view extending other view', async () => {
+    const view2 = metaTransformer.cubes.find(
+      (it) => it.config.name === 'test_view2'
+    );
+    const view3 = metaTransformer.cubes.find(
+      (it) => it.config.name === 'test_view3'
+    );
+
+    expect(view2.config.folders.length).toBe(1);
+    expect(view3.config.folders.length).toBe(2);
+
+    const folder1 = view2.config.folders.find(
+      (it) => it.name === 'folder1'
+    );
+    expect(folder1.members).toEqual([
+      'test_view2.users_age',
+      'test_view2.users_state',
+      'test_view2.renamed_orders_status',
+    ]);
+
+    const folder1v3 = view3.config.folders.find(
+      (it) => it.name === 'folder1'
+    );
+    expect(folder1v3.members).toEqual([
+      'test_view3.users_age',
+      'test_view3.users_state',
+      'test_view3.renamed_orders_status',
+    ]);
+
+    const folder2 = view3.config.folders.find(
+      (it) => it.name === 'folder2'
+    );
+    expect(folder2.members).toEqual(
+      expect.arrayContaining(['test_view3.users_city', 'test_view3.users_gender'])
+    );
+  });
+
   it('throws errors for folder members with path', async () => {
     const modelContent = fs.readFileSync(
       path.join(process.cwd(), '/test/unit/fixtures/folders_invalid_path.yml'),