feat: Add dimension SQL support (#16)

* Add group by SQL support

* Bump version and fix

* Fix typeo

Author: itsTalwar

meerkat-browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/meerkat-browser",
-  "version": "0.0.55",
+  "version": "0.0.56",
   "dependencies": {
     "@swc/helpers": "~0.5.0",
     "@devrev/meerkat-core": "*",

meerkat-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/meerkat-core",
-  "version": "0.0.55",
+  "version": "0.0.56",
   "dependencies": {
     "@swc/helpers": "~0.5.0"
   },

meerkat-core/src/cube-group-by-transformer/cube-group-by-transformer.ts

@@ -1,13 +1,17 @@
 import { Member } from '../types/cube-types/query';
-import { ExpressionClass, ExpressionType } from '../types/duckdb-serialization-types/serialization/Expression';
+import {
+  ExpressionClass,
+  ExpressionType,
+} from '../types/duckdb-serialization-types/serialization/Expression';
+import { memberKeyToSafeKey } from '../utils/member-key-to-safe-key';
 
 export const cubeDimensionToGroupByAST = (dimensions: Member[]) => {
   const groupByAST = dimensions.map((dimension) => {
     const dimensionAST = {
       class: ExpressionClass.COLUMN_REF,
       type: ExpressionType.COLUMN_REF,
       alias: '',
-      column_names: dimension.split('.'),
+      column_names: [memberKeyToSafeKey(dimension)],
     };
 
     return dimensionAST;

meerkat-core/src/cube-measure-transformer/cube-measure-transformer.spec.ts

@@ -17,7 +17,14 @@ describe('cubeMeasureToSQLSelectString', () => {
         { name: 'measure1', sql: 'COUNT(*)', type: 'number' },
         { name: 'measure2', sql: 'SUM(total)', type: 'number' },
       ],
-      dimensions: [],
+      dimensions: [
+        { name: 'dimension1', sql: 'dimension1', type: 'number' },
+        {
+          name: 'dimension2',
+          sql: `DATE_TRUNC('month', order_date)`,
+          type: 'number',
+        },
+      ],
     };
   });
 
@@ -78,7 +85,7 @@ describe('cubeMeasureToSQLSelectString', () => {
       sqlToReplace
     );
     expect(result).toBe(
-      'SELECT (COUNT(*)) AS temp__measure1 , (SUM(total)) AS temp__measure2 ,  temp.dimension1 AS temp__dimension1, temp.dimension2 AS temp__dimension2 FROM (SELECT * FROM TABLE_1)'
+      `SELECT (COUNT(*)) AS temp__measure1 , (SUM(total)) AS temp__measure2 ,   (dimension1) AS temp__dimension1,  (DATE_TRUNC('month', order_date)) AS temp__dimension2 FROM (SELECT * FROM TABLE_1)`
     );
   });
 });

meerkat-core/src/cube-measure-transformer/cube-measure-transformer.ts

@@ -31,18 +31,28 @@ export const cubeMeasureToSQLSelectString = (
 
 const addDimensionToSQLProjection = (
   dimensions: Member[],
-  selectString: string
+  selectString: string,
+  tableSchema: TableSchema
 ) => {
   if (dimensions.length === 0) {
     return selectString;
   }
   let newSelectString = selectString;
   for (let i = 0; i < dimensions.length; i++) {
     const dimension = dimensions[i];
+    const dimensionKeyWithoutTable = dimension.split('.')[1];
+    const dimensionSchema = tableSchema.dimensions.find(
+      (m) => m.name === dimensionKeyWithoutTable
+    );
+    const aliasKey = memberKeyToSafeKey(dimension);
+
+    if (!dimensionSchema) {
+      continue;
+    }
     if (i > 0) {
       newSelectString += ',';
     }
-    newSelectString += ` ${dimension} AS ${dimension.replace('.', '__')}`;
+    newSelectString += `  (${dimensionSchema.sql}) AS ${aliasKey}`;
   }
   return newSelectString;
 };
@@ -67,7 +77,8 @@ export const applyProjectionToSQLQuery = (
   }
   const selectString = addDimensionToSQLProjection(
     dimensions,
-    measureSelectString
+    measureSelectString,
+    tableSchema
   );
 
   const selectRegex = /SELECT\s\*/;

meerkat-node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/meerkat-node",
-  "version": "0.0.55",
+  "version": "0.0.56",
   "dependencies": {
     "@swc/helpers": "~0.5.0",
     "@devrev/meerkat-core": "*",

meerkat-node/src/__tests__/test-data.ts

@@ -59,13 +59,34 @@ export const TABLE_SCHEMA = {
       sql: 'product_id',
       type: 'string',
     },
+    {
+      name: 'order_month',
+      sql: `DATE_TRUNC('month', order_date)`,
+      type: 'string',
+    },
   ],
 };
 
 export const TEST_DATA = [
+  {
+    testName: 'GroupBySQLInnerQuery',
+    expectedSQL: `SELECT (SUM(order_amount)) AS orders__total_order_amount ,   (DATE_TRUNC('month', order_date)) AS orders__order_month FROM (select * from orders) AS orders GROUP BY orders__order_month LIMIT 1`,
+    cubeInput: {
+      measures: ['orders.total_order_amount'],
+      filters: [],
+      dimensions: ['orders.order_month'],
+      limit: 1,
+    },
+    expectedOutput: [
+      {
+        orders__order_month: '2022-01-01T00:00:00.000Z',
+        orders__total_order_amount: 130,
+      },
+    ],
+  },
   {
     testName: 'GroupBy',
-    expectedSQL: `SELECT (SUM(order_amount)) AS orders__total_order_amount ,  orders.customer_id AS orders__customer_id FROM (select * from orders) AS orders GROUP BY orders.customer_id`,
+    expectedSQL: `SELECT (SUM(order_amount)) AS orders__total_order_amount ,   (customer_id) AS orders__customer_id FROM (select * from orders) AS orders GROUP BY orders__customer_id`,
     cubeInput: {
       measures: ['orders.total_order_amount'],
       filters: [],