feat(server-core): Support for scheduledRefreshTimeZones as function, passing securityContext

Author: KSDaemon

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

@@ -456,7 +456,7 @@ class ApiGateway {
 
       app.get('/cubejs-system/v1/pre-aggregations/timezones', systemMiddlewares, systemAsyncHandler(async (req, res) => {
         this.resToResultFn(res)({
-          timezones: this.scheduledRefreshTimeZones || []
+          timezones: this.scheduledRefreshTimeZones ? this.scheduledRefreshTimeZones(req.context) : []
         });
       }));
 
@@ -630,7 +630,7 @@ class ApiGateway {
           context,
           normalizeQueryPreAggregations(
             {
-              timezones: this.scheduledRefreshTimeZones,
+              timezones: this.scheduledRefreshTimeZones ? this.scheduledRefreshTimeZones(context) : [],
               preAggregations: preAggregations.map(p => ({
                 id: p.id,
                 cacheOnly,
@@ -654,7 +654,7 @@ class ApiGateway {
     try {
       query = normalizeQueryPreAggregations(
         this.parseQueryParam(query),
-        { timezones: this.scheduledRefreshTimeZones }
+        { timezones: this.scheduledRefreshTimeZones ? this.scheduledRefreshTimeZones(context) : [] }
       );
       const orchestratorApi = await this.getAdapterApi(context);
       const compilerApi = await this.getCompilerApi(context);

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

@@ -34,15 +34,24 @@ type UserBackgroundContext = {
   authInfo?: any;
 };
 
+type RequestContext = {
+  // @deprecated Renamed to securityContext, please use securityContext.
+  authInfo?: any;
+  securityContext: any;
+  requestId: string;
+};
+
 /**
- * Function that should provides a logic of scheduled returning of
+ * Function that should provide a logic of scheduled returning of
  * the user background context. Used as a part of a main
  * configuration object of the Gateway to provide extendability to
  * this logic.
  */
 type ScheduledRefreshContextsFn =
   () => Promise<UserBackgroundContext[]>;
 
+type ScheduledRefreshTimeZonesFn = (context: RequestContext) => string[] | Promise<string[]>;
+
 /**
  * Gateway configuration options interface.
  */
@@ -52,7 +61,7 @@ interface ApiGatewayOptions {
   dataSourceStorage: any;
   refreshScheduler: any;
   scheduledRefreshContexts?: ScheduledRefreshContextsFn;
-  scheduledRefreshTimeZones?: String[];
+  scheduledRefreshTimeZones?: ScheduledRefreshTimeZonesFn;
   basePath: string;
   extendContext?: ExtendContextFn;
   jwt?: JWTOptions;

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

@@ -849,7 +849,7 @@ describe('API Gateway', () => {
           playgroundAuthSecret,
           refreshScheduler: () => new RefreshSchedulerMock(),
           scheduledRefreshContexts: () => Promise.resolve(scheduledRefreshContextsFactory()),
-          scheduledRefreshTimeZones: scheduledRefreshTimeZonesFactory()
+          scheduledRefreshTimeZones: scheduledRefreshTimeZonesFactory
         }
       );
       const token = generateAuthToken({ uid: 5, scope }, {}, playgroundAuthSecret);

packages/cubejs-server-core/src/core/server.ts

@@ -5,11 +5,23 @@ import LRUCache from 'lru-cache';
 import isDocker from 'is-docker';
 import pLimit from 'p-limit';
 
-import { ApiGateway, ApiGatewayOptions, UserBackgroundContext } from '@cubejs-backend/api-gateway';
+import {
+  ApiGateway,
+  ApiGatewayOptions,
+  UserBackgroundContext
+} from '@cubejs-backend/api-gateway';
 import {
   CancelableInterval,
-  createCancelableInterval, formatDuration, getAnonymousId,
-  getEnv, assertDataSource, getRealType, internalExceptions, track, FileRepository, SchemaFileRepository,
+  createCancelableInterval,
+  formatDuration,
+  getAnonymousId,
+  getEnv,
+  assertDataSource,
+  getRealType,
+  internalExceptions,
+  track,
+  FileRepository,
+  SchemaFileRepository,
 } from '@cubejs-backend/shared';
 
 import type { Application as ExpressApplication } from 'express';
@@ -46,8 +58,15 @@ import type {
   DriverContext,
   LoggerFn,
   DriverConfig,
+  ScheduledRefreshTimeZonesFn,
+} from './types';
+import {
+  ContextToOrchestratorIdFn,
+  ContextAcceptanceResult,
+  ContextAcceptanceResultHttp,
+  ContextAcceptanceResultWs,
+  ContextAcceptor
 } from './types';
-import { ContextToOrchestratorIdFn, ContextAcceptanceResult, ContextAcceptanceResultHttp, ContextAcceptanceResultWs, ContextAcceptor } from './types';
 
 const { version } = require('../../../package.json');
 
@@ -119,6 +138,8 @@ export class CubejsServerCore {
 
   protected readonly preAggregationsSchema: PreAggregationsSchemaFn;
 
+  protected readonly scheduledRefreshTimeZones: ScheduledRefreshTimeZonesFn;
+
   protected readonly orchestratorOptions: OrchestratorOptionsFn;
 
   public logger: LoggerFn;
@@ -173,6 +194,7 @@ export class CubejsServerCore {
     this.contextToExternalDbType = wrapToFnIfNeeded(this.options.externalDbType);
     this.preAggregationsSchema = wrapToFnIfNeeded(this.options.preAggregationsSchema);
     this.orchestratorOptions = wrapToFnIfNeeded(this.options.orchestratorOptions);
+    this.scheduledRefreshTimeZones = wrapToFnIfNeeded(this.options.scheduledRefreshTimeZones || []);
 
     this.compilerCache = new LRUCache<string, CompilerApi>({
       max: this.options.compilerCacheSize || 250,
@@ -453,7 +475,7 @@ export class CubejsServerCore {
         jwt: this.options.jwt,
         refreshScheduler: this.getRefreshScheduler.bind(this),
         scheduledRefreshContexts: this.options.scheduledRefreshContexts,
-        scheduledRefreshTimeZones: this.options.scheduledRefreshTimeZones,
+        scheduledRefreshTimeZones: this.scheduledRefreshTimeZones,
         serverCoreVersion: this.coreServerVersion,
         contextToApiScopes: this.options.contextToApiScopes,
         gatewayPort: this.options.gatewayPort,
@@ -700,7 +722,7 @@ export class CubejsServerCore {
   }
 
   /**
-   * @internal Please dont use this method directly, use refreshTimer
+   * @internal Please don't use this method directly, use refreshTimer
    */
   public handleScheduledRefreshInterval = async (options) => {
     const allContexts = await this.options.scheduledRefreshContexts();
@@ -730,7 +752,10 @@ export class CubejsServerCore {
             concurrency: this.options.scheduledRefreshConcurrency,
           };
 
-          if (this.options.scheduledRefreshTimeZones) {
+          const timezonesFromSecurityContext = await this.scheduledRefreshTimeZones(context);
+          if (timezonesFromSecurityContext.length > 0) {
+            queryingOptions.timezones = timezonesFromSecurityContext;
+          } else if (this.options.scheduledRefreshTimeZones) {
             queryingOptions.timezones = this.options.scheduledRefreshTimeZones;
           }
 
@@ -746,7 +771,7 @@ export class CubejsServerCore {
   }
 
   /**
-   * @internal Please dont use this method directly, use refreshTimer
+   * @internal Please don't use this method directly, use refreshTimer
    */
   public async runScheduledRefresh(context: UserBackgroundContext | null, queryingOptions?: ScheduledRefreshOptions) {
     return this.getRefreshScheduler().runScheduledRefresh(

packages/cubejs-server-core/src/core/types.ts

@@ -128,6 +128,16 @@ export type OrchestratorOptionsFn = (context: RequestContext) => OrchestratorOpt
 
 export type PreAggregationsSchemaFn = (context: RequestContext) => string | Promise<string>;
 
+export type ScheduledRefreshTimeZonesFn = (context: RequestContext) => string[] | Promise<string[]>;
+
+/**
+ * Function that should provide a logic of scheduled returning of
+ * the user background context. Used as a part of a main
+ * configuration object of the Gateway to provide extendability to
+ * this logic.
+ */
+export type ScheduledRefreshContextsFn = () => Promise<UserBackgroundContext[]>;
+
 // internal
 export type DriverOptions = {
   dataSource?: string,
@@ -194,7 +204,7 @@ export interface CreateOptions {
   schemaVersion?: (context: RequestContext) => string | Promise<string>;
   extendContext?: ExtendContextFn;
   scheduledRefreshTimer?: boolean | number;
-  scheduledRefreshTimeZones?: string[];
+  scheduledRefreshTimeZones?: string[] | ScheduledRefreshTimeZonesFn;
   scheduledRefreshContexts?: () => Promise<UserBackgroundContext[]>;
   scheduledRefreshConcurrency?: number;
   scheduledRefreshBatchSize?: number;