chore(schema-compiler): Collect sqlTable in CubeToMetaTransformer

packages/cubejs-api-gateway/src/gateway.ts

@@ -153,7 +153,7 @@
 
   protected readonly playgroundAuthSecret?: string;
 
   protected readonly event: (name: string, props?: object) => void;
 
   public constructor(
     protected readonly apiSecret: string,
@@ -186,7 +186,7 @@
     this.contextRejectionMiddleware = options.contextRejectionMiddleware || (async (req, res, next) => next());
     this.wsContextAcceptor = options.wsContextAcceptor || (() => ({ accepted: true }));
     // eslint-disable-next-line @typescript-eslint/no-empty-function
     this.event = options.event || function () {};
   }
 
   public initApp(app: ExpressApplication) {
@@ -579,7 +579,11 @@
         return;
       }
       const cubesConfig = includeCompilerId ? metaConfig.cubes : metaConfig;
-      const cubes = this.filterVisibleItemsInMeta(context, cubesConfig).map(cube => cube.config);
+      const cubes = this.filterVisibleItemsInMeta(context, cubesConfig).map(cube => ({
+        ...cube.config,
+        // we dont want to expose sqlTable
+        sqlTable: undefined,
+      }));
       const response: { cubes: any[], compilerId?: string } = { cubes };
       if (includeCompilerId) {
         response.compilerId = metaConfig.compilerId;

packages/cubejs-api-gateway/src/helpers/transformMetaExtended.ts

@@ -34,9 +34,11 @@
   };
 }
 
-function transformCube(cube: any, cubeDefinitions: any) {
+function transformCube(cube: any, cubeDefinitions: any, extended: boolean = true) {
   return {
     ...cube,
+    // we dont want to expose sqlTable
+    sqlTable: undefined,
     extends: stringifyMemberSql(cubeDefinitions[cube?.name]?.extends),
     sql: stringifyMemberSql(cubeDefinitions[cube?.name]?.sql),
     fileName: cubeDefinitions[cube?.name]?.fileName,

packages/cubejs-api-gateway/test/__snapshots__/index.test.ts.snap

@@ -0,0 +1,73 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`API Gateway meta endpoint extended to get schema information with additional data 1`] = `
+Array [
+  Object {
+    "dimensions": Array [
+      Object {
+        "isVisible": true,
+        "name": "Foo.id",
+      },
+      Object {
+        "isVisible": true,
+        "name": "Foo.time",
+      },
+    ],
+    "measures": Array [
+      Object {
+        "isVisible": true,
+        "name": "Foo.bar",
+      },
+    ],
+    "name": "Foo",
+    "sql": "'SELECT * FROM Foo'",
+  },
+]
+`;
+
+exports[`API Gateway meta endpoint to get schema information 1`] = `
+Array [
+  Object {
+    "dimensions": Array [
+      Object {
+        "isVisible": true,
+        "name": "Foo.id",
+      },
+      Object {
+        "isVisible": true,
+        "name": "Foo.time",
+      },
+    ],
+    "measures": Array [
+      Object {
+        "isVisible": true,
+        "name": "Foo.bar",
+      },
+    ],
+    "name": "Foo",
+    "title": "My Cube called Foo",
+    "type": "cube",
+  },
+  Object {
+    "dimensions": Array [
+      Object {
+        "isVisible": true,
+        "name": "Bar.id",
+      },
+      Object {
+        "isVisible": true,
+        "name": "Bar.time",
+      },
+    ],
+    "measures": Array [
+      Object {
+        "isVisible": true,
+        "name": "Bar.bar",
+      },
+    ],
+    "name": "Bar",
+    "title": "My Cube called Bar",
+    "type": "cube",
+  },
+]
+`;

packages/cubejs-api-gateway/test/index.test.ts

@@ -400,7 +400,7 @@
             req.authInfo = authorization;
           }
         },
         queryRewrite: async (query, context) => {
           query.limit = 2;
           return query;
         }
@@ -583,6 +583,8 @@
     expect(res.body).toHaveProperty('cubes');
     expect(res.body.cubes[0]?.name).toBe('Foo');
     expect(res.body.cubes[0]?.hasOwnProperty('sql')).toBe(false);
+
+    expect(res.body.cubes).toMatchSnapshot();
   });
 
   test('meta endpoint extended to get schema information with additional data', async () => {
@@ -596,6 +598,8 @@
     expect(res.body).toHaveProperty('cubes');
     expect(res.body.cubes[0]?.name).toBe('Foo');
     expect(res.body.cubes[0]?.hasOwnProperty('sql')).toBe(true);
+
+    expect(res.body.cubes).toMatchSnapshot();
   });
 
   describe('multi query support', () => {
@@ -737,7 +741,7 @@
       expect(res.body).toMatchObject(successResult);
     };
 
     const wrongPayloadsTestFactory = ({ route, wrongPayloads, scope }: {
       route: string,
       method: string,
       scope?: string[],

packages/cubejs-api-gateway/test/mocks.ts

@@ -80,6 +80,8 @@ export const compilerApi = jest.fn().mockImplementation(async () => ({
       {
         config: {
           name: 'Foo',
+          type: 'cube',
+          title: 'My Cube called Foo',
           measures: [
             {
               name: 'Foo.bar',
@@ -98,6 +100,30 @@ export const compilerApi = jest.fn().mockImplementation(async () => ({
           ],
         },
       },
+      {
+        config: {
+          name: 'Bar',
+          type: 'cube',
+          title: 'My Cube called Bar',
+          sqlTable: 'my_sql_table',
+          measures: [
+            {
+              name: 'Bar.bar',
+              isVisible: true,
+            },
+          ],
+          dimensions: [
+            {
+              name: 'Bar.id',
+              isVisible: true,
+            },
+            {
+              name: 'Bar.time',
+              isVisible: true,
+            },
+          ],
+        },
+      }
     ];
   },
 

packages/cubejs-schema-compiler/src/compiler/CubeToMetaTransformer.js

@@ -52,6 +52,9 @@ export class CubeToMetaTransformer {
         description: cube.description,
         connectedComponent: this.joinGraph.connectedComponents()[cube.name],
         meta: cube.meta,
+        sqlTable: cube.sqlTable && this.cubeEvaluator.evaluateReferences(
+          cube.name, cube.sqlTable, {}
+        ),
         measures: R.compose(
           R.map((nameToMetric) => ({
             ...this.measureConfig(cube.name, cubeTitle, nameToMetric),

packages/cubejs-server-core/src/core/CompilerApi.js

@@ -225,11 +225,13 @@ export class CompilerApi {
         compilerId: compilers.compilerId,
       };
     }
+
     return compilers.metaTransformer.cubes;
   }
 
   async metaConfigExtended(options) {
     const { metaTransformer } = await this.getCompilers(options);
+
     return {
       metaConfig: metaTransformer?.cubes,
       cubeDefinitions: metaTransformer?.cubeEvaluator?.cubeDefinitions,

packages/cubejs-testing-drivers/src/tests/testQueries.ts

@@ -178,6 +178,11 @@ export function testQueries(type: string, { includeIncrementalSchemaSuite, exten
       }
     });
 
+    execute('meta snapshot', async () => {
+      const meta = await client.meta();
+      expect(meta.cubes).toMatchSnapshot();
+    });
+
     execute('must not fetch a hidden cube', async () => {
       const meta = await client.meta();
       expect(meta.cubes.find(cube => cube.name === 'HiddenECommerce')).toBe(undefined);