chore!: Remove support for USER_CONTEXT (#8705)

BREAKING CHANGE: This functionality was deprecated starting from v0.26.0. Please migrate to SECURITY_CONTEXT.
cube-js · Sep 13, 2024 · 8a796f8 · 8a796f8
1 parent 0f0ab9e
commit 8a796f8
Show file tree

Hide file tree

Showing 8 changed files with 97 additions and 128 deletions.
diff --git a/DEPRECATION.md b/DEPRECATION.md
@@ -46,7 +46,7 @@ features:
 | Deprecated | [`checkAuthMiddleware`](#checkauthmiddleware)                                                                                     | v0.26.0    | v0.36.0   |
 | Removed    | [Node.js 10](#nodejs-10)                                                                                                          | v0.26.0    | v0.29.0   |
 | Removed    | [Node.js 15](#nodejs-15)                                                                                                          | v0.26.0    | v0.32.0   |
-| Deprecated | [`USER_CONTEXT`](#user_context)                                                                                                   | v0.26.0    | v0.36.0   |
+| Removed    | [`USER_CONTEXT`](#user_context)                                                                                                   | v0.26.0    | v0.36.0   |
 | Deprecated | [`authInfo`](#authinfo)                                                                                                           | v0.26.0    |           |
 | Deprecated | [Prefix Redis environment variables with `CUBEJS_`](#prefix-redis-environment-variables-with-cubejs_)                             | v0.27.0    | v0.36.0   |
 | Removed    | [Node.js 12](#nodejs-12)                                                                                                          | v0.29.0    | v0.32.0   |
@@ -211,14 +211,6 @@ no more updates. Please upgrade to Node.js 12 or higher.
 
 `USER_CONTEXT` has been renamed to `SECURITY_CONTEXT`.
 
-Deprecated:
-
-```js
-cube(`visitors`, {
-  sql: `select * from visitors WHERE ${USER_CONTEXT.source.filter("source")}`,
-});
-```
-
 You should use:
 
 ```js

diff --git a/packages/cubejs-schema-compiler/src/compiler/CubeSymbols.js b/packages/cubejs-schema-compiler/src/compiler/CubeSymbols.js
@@ -9,7 +9,6 @@ import { BaseQuery } from '../adapter';
 
 const FunctionRegex = /function\s+\w+\(([A-Za-z0-9_,]*)|\(([\s\S]*?)\)\s*=>|\(?(\w+)\)?\s*=>/;
 const CONTEXT_SYMBOLS = {
-  USER_CONTEXT: 'securityContext',
   SECURITY_CONTEXT: 'securityContext',
   FILTER_PARAMS: 'filterParams',
   FILTER_GROUP: 'filterGroup',
@@ -495,6 +494,11 @@ export class CubeSymbols {
 
   resolveSymbol(cubeName, name) {
     const { sqlResolveFn, contextSymbols, collectJoinHints } = this.resolveSymbolsCallContext || {};
+
+    if (name === 'USER_CONTEXT') {
+      throw new Error('Support for USER_CONTEXT was removed, please migrate to SECURITY_CONTEXT.');
+    }
+
     if (CONTEXT_SYMBOLS[name]) {
       // always resolves if contextSymbols aren't passed for transpile step
       const symbol = contextSymbols && contextSymbols[CONTEXT_SYMBOLS[name]] || {};

diff --git a/packages/cubejs-schema-compiler/src/compiler/transpilers/ValidationTranspiler.ts b/packages/cubejs-schema-compiler/src/compiler/transpilers/ValidationTranspiler.ts
@@ -1,18 +1,17 @@
-/* eslint-disable no-restricted-syntax */
-import { TranspilerInterface, TraverseObject } from './transpiler.interface';
-import { ErrorReporter } from '../ErrorReporter';
+import type { TranspilerInterface, TraverseObject } from './transpiler.interface';
+import type { ErrorReporter } from '../ErrorReporter';
 
-// @todo It's not possible to do a warning inside CubeSymbols.resolveSymbol,
-// because it doesnt have ErrorReporter, restructure?
 export class ValidationTranspiler implements TranspilerInterface {
   public traverseObject(reporter: ErrorReporter): TraverseObject {
     return {
       Identifier: path => {
         if (path.node.name === 'USER_CONTEXT') {
-          reporter.warning({
-            message: 'USER_CONTEXT was deprecated in favor of SECURITY_CONTEXT.',
-            loc: path.node.loc,
-          });
+          reporter.error(
+            'Support for USER_CONTEXT was removed, please migrate to SECURITY_CONTEXT.',
+            path.node.loc?.filename,
+            path.node.loc?.start.line,
+            path.node.loc?.start.column,
+          );
         }
       }
     };

diff --git a/packages/cubejs-schema-compiler/test/integration/clickhouse/clickhouse-graph-builder.test.ts b/packages/cubejs-schema-compiler/test/integration/clickhouse/clickhouse-graph-builder.test.ts
@@ -18,13 +18,13 @@ describe('ClickHouse JoinGraph', () => {
       type: 'number',
       sql: new Function('visitor_revenue', 'visitor_count', 'return visitor_revenue + "/" + visitor_count')
     }
-  
+
     cube(\`visitors\`, {
       sql: \`
-      select * from visitors WHERE \${USER_CONTEXT.source.filter('source')} AND
-      \${USER_CONTEXT.sourceArray.filter(sourceArray => \`source in (\${sourceArray.join(',')})\`)}
+      select * from visitors WHERE \${SECURITY_CONTEXT.source.filter('source')} AND
+      \${SECURITY_CONTEXT.sourceArray.filter(sourceArray => \`source in (\${sourceArray.join(',')})\`)}
       \`,
-      
+
       refreshKey: {
         sql: 'SELECT 1',
       },
@@ -113,24 +113,24 @@ describe('ClickHouse JoinGraph', () => {
           type: 'time',
           sql: 'created_at'
         },
-        
+
         createdAtSqlUtils: {
           type: 'time',
           sql: SQL_UTILS.convertTz('created_at')
         },
-        
+
         checkins: {
           sql: \`\${visitor_checkins.visitor_checkins_count}\`,
           type: \`number\`,
           subQuery: true
         },
-        
+
         subQueryFail: {
           sql: '2',
           type: \`number\`,
           subQuery: true
         },
-        
+
         doubledCheckings: {
           sql: \`\${checkins} * 2\`,
           type: 'number'
@@ -210,7 +210,7 @@ describe('ClickHouse JoinGraph', () => {
           subQuery: true
         },
       },
-      
+
       // preAggregations: {
       //   checkinSource: {
       //     type: 'rollup',
@@ -255,27 +255,27 @@ describe('ClickHouse JoinGraph', () => {
         }
       }
     })
-    
+
     cube('ReferenceVisitors', {
       sql: \`
-        select * from \${visitors.sql()} as t 
+        select * from \${visitors.sql()} as t
         WHERE \${FILTER_PARAMS.ReferenceVisitors.createdAt.filter(\`addDays(t.created_at, 28)\`)} AND
         \${FILTER_PARAMS.ReferenceVisitors.createdAt.filter((from, to) => \`(addDays(t.created_at,28)) >= parseDateTimeBestEffort(\${from}) AND (addDays(t.created_at, 28)) <= parseDateTimeBestEffort(\${to})\`)}
       \`,
-      
+
       measures: {
         count: {
           type: 'count'
         },
-        
+
         googleSourcedCount: {
           type: 'count',
           filters: [{
             sql: \`\${CUBE}.source = 'google'\`
           }]
         },
       },
-      
+
       dimensions: {
         createdAt: {
           type: 'time',

diff --git a/packages/cubejs-schema-compiler/test/integration/mssql/mssql-ungrouped.test.ts b/packages/cubejs-schema-compiler/test/integration/mssql/mssql-ungrouped.test.ts
@@ -16,15 +16,15 @@ describe('MSSqlUngrouped', () => {
       type: 'number',
       sql: new Function('visitor_revenue', 'visitor_count', 'return visitor_revenue + "/" + visitor_count')
     }
-  
+
     cube(\`visitors\`, {
       sql: \`
-      select * from ##visitors WHERE \${USER_CONTEXT.source.filter('source')} AND
-      \${USER_CONTEXT.sourceArray.filter(sourceArray => \`source in (\${sourceArray.join(',')})\`)}
+      select * from ##visitors WHERE \${SECURITY_CONTEXT.source.filter('source')} AND
+      \${SECURITY_CONTEXT.sourceArray.filter(sourceArray => \`source in (\${sourceArray.join(',')})\`)}
       \`,
-      
+
       rewriteQueries: true,
-      
+
       refreshKey: {
         sql: 'SELECT 1',
       },
@@ -122,37 +122,37 @@ describe('MSSqlUngrouped', () => {
           type: 'time',
           sql: 'created_at'
         },
-        
+
         createdAtSqlUtils: {
           type: 'time',
           sql: SQL_UTILS.convertTz('created_at')
         },
-        
+
         checkins: {
           sql: \`\${visitor_checkins.visitor_checkins_count}\`,
           type: \`number\`,
           subQuery: true
         },
-        
+
         checkinsRolling: {
           sql: \`\${visitor_checkins.visitorCheckinsRolling}\`,
           type: \`number\`,
           subQuery: true
         },
-        
+
         checkinsWithPropagation: {
           sql: \`\${visitor_checkins.visitor_checkins_count}\`,
           type: \`number\`,
           subQuery: true,
           propagateFiltersToSubQuery: true
         },
-        
+
         subQueryFail: {
           sql: '2',
           type: \`number\`,
           subQuery: true
         },
-        
+
         doubledCheckings: {
           sql: \`\${checkins} * 2\`,
           type: 'number'
@@ -181,11 +181,11 @@ describe('MSSqlUngrouped', () => {
 
     cube('visitor_checkins', {
       sql: \`
-      select * from ##visitor_checkins WHERE 
+      select * from ##visitor_checkins WHERE
       \${FILTER_PARAMS.visitor_checkins.created_at.filter('created_at')} AND
       \${FILTER_GROUP(FILTER_PARAMS.visitor_checkins.created_at.filter("dateadd(day, -3, created_at)"), FILTER_PARAMS.visitor_checkins.source.filter('source'))}
       \`,
-      
+
       rewriteQueries: true,
 
       joins: {
@@ -199,14 +199,14 @@ describe('MSSqlUngrouped', () => {
         visitor_checkins_count: {
           type: 'count'
         },
-        
+
         visitorCheckinsRolling: {
           type: 'count',
           rollingWindow: {
             trailing: 'unbounded'
           }
         },
-        
+
         revenue_per_checkin: {
           type: 'number',
           sql: \`\${visitors.visitor_revenue} / \${visitor_checkins_count}\`
@@ -259,7 +259,7 @@ describe('MSSqlUngrouped', () => {
           subQuery: true
         },
       },
-      
+
       preAggregations: {
         checkinSource: {
           type: 'rollup',
@@ -331,9 +331,9 @@ describe('MSSqlUngrouped', () => {
         }
       }
     })
-    
-    
-    
+
+
+
     `);
 
   async function runQueryTest(q, expectedResult) {