feat: propagateFiltersToSubQuery flag

Author: paveltiunov

packages/cubejs-schema-compiler/adapter/BaseQuery.js

@@ -635,19 +635,54 @@ class BaseQuery {
     ON ${subQueryAlias}.${primaryKey.aliasName()} = ${this.primaryKeySql(this.cubeEvaluator.primaryKeys[cubeName], cubeName)}`;
   }
 
+  get filtersWithoutSubQueries() {
+    if (!this.filtersWithoutSubQueriesValue) {
+      this.filtersWithoutSubQueriesValue = this.allFilters.filter(
+        f => this.collectFrom([f], this.collectSubQueryDimensionsFor.bind(this)).length === 0
+      );
+    }
+    return this.filtersWithoutSubQueriesValue;
+  }
+
   subQueryDescription(dimension) {
     const symbol = this.cubeEvaluator.dimensionByPath(dimension);
     const [cubeName, name] = this.cubeEvaluator.parsePath('dimensions', dimension);
     const prefix = this.subQueryName(cubeName, name);
+    let filters;
+    let segments;
+    let timeDimensions;
+    if (symbol.propagateFiltersToSubQuery) {
+      filters = this.filtersWithoutSubQueries.filter(
+        f => f instanceof BaseFilter && !(f instanceof BaseTimeDimension)
+      ).map(f => ({
+        dimension: f.dimension,
+        operator: f.operator,
+        values: f.values
+      }));
+
+      timeDimensions = this.filtersWithoutSubQueries.filter(
+        f => f instanceof BaseTimeDimension
+      ).map(f => ({
+        dimension: f.dimension,
+        dateRange: f.dateRange
+      }));
+
+      segments = this.filtersWithoutSubQueries.filter(
+        f => f instanceof BaseSegment
+      ).map(f => f.segment);
+    }
     const subQuery = this.newSubQuery({
       cubeAliasPrefix: prefix,
       rowLimit: null,
       measures: [{
         expression: symbol.sql,
-        cubeName: cubeName,
+        cubeName,
         name
       }],
-      dimensions: [this.primaryKeyName(cubeName)]
+      dimensions: [this.primaryKeyName(cubeName)],
+      filters,
+      segments,
+      timeDimensions
     });
     return { prefix, subQuery, cubeName };
   }

packages/cubejs-schema-compiler/compiler/CubeValidator.js

@@ -30,7 +30,8 @@ const BaseDimensionWithoutSubQuery = {
 };
 
 const BaseDimension = Object.assign({
-  subQuery: Joi.boolean()
+  subQuery: Joi.boolean(),
+  propagateFiltersToSubQuery: Joi.boolean()
 }, BaseDimensionWithoutSubQuery);
 
 const BaseMeasure = {

packages/cubejs-schema-compiler/test/SQLGenerationTest.js

@@ -129,6 +129,13 @@ describe('SQL Generation', function test() {
           subQuery: true
         },
         
+        checkinsWithPropagation: {
+          sql: \`\${visitor_checkins.visitor_checkins_count}\`,
+          type: \`number\`,
+          subQuery: true,
+          propagateFiltersToSubQuery: true
+        },
+        
         subQueryFail: {
           sql: '2',
           type: \`number\`,
@@ -920,6 +927,52 @@ describe('SQL Generation', function test() {
     return result;
   });
 
+  it('subquery with propagated filters', () => compiler.compile().then(() => {
+    const query = new PostgresQuery({ joinGraph, cubeEvaluator, compiler }, {
+      measures: [
+        'visitors.visitor_count'
+      ],
+      dimensions: [
+        'visitors.checkinsWithPropagation'
+      ],
+      timeDimensions: [{
+        dimension: 'visitors.created_at',
+        granularity: 'day',
+        dateRange: ['2017-01-01', '2017-01-30']
+      }],
+      timezone: 'America/Los_Angeles',
+      filters: [],
+      order: [{
+        id: 'visitors.checkins'
+      }]
+    });
+
+    console.log(query.buildSqlAndParams());
+
+    return dbRunner.testQuery(query.buildSqlAndParams()).then(res => {
+      console.log(JSON.stringify(res));
+      res.should.be.deepEqual(
+        [{
+          "visitors__checkins_with_propagation": "0",
+          "visitors__created_at_day": "2017-01-06T00:00:00.000Z",
+          "visitors__visitor_count": "2"
+        }, {
+          "visitors__checkins_with_propagation": "1",
+          "visitors__created_at_day": "2017-01-05T00:00:00.000Z",
+          "visitors__visitor_count": "1"
+        }, {
+          "visitors__checkins_with_propagation": "2",
+          "visitors__created_at_day": "2017-01-04T00:00:00.000Z",
+          "visitors__visitor_count": "1"
+        }, {
+          "visitors__checkins_with_propagation": "3",
+          "visitors__created_at_day": "2017-01-02T00:00:00.000Z",
+          "visitors__visitor_count": "1"
+        }]
+      );
+    });
+  }));
+
   it('average subquery', () => {
     const result = compiler.compile().then(() => {
       let query = new PostgresQuery({ joinGraph, cubeEvaluator, compiler }, {