@cubejs-backend/server-core 1.5.4 → 1.5.5

package/dist/src/core/CompilerApi.d.ts

@@ -1,130 +1,168 @@
-export class CompilerApi {
-    /**
-     * Class constructor.
-     * @param {SchemaFileRepository} repository
-     * @param {DbTypeAsyncFn} dbType
-     * @param {*} options
-     */
-    constructor(repository: SchemaFileRepository, dbType: DbTypeAsyncFn, options: any);
-    repository: SchemaFileRepository;
-    dbType: DbTypeAsyncFn;
-    dialectClass: any;
-    options: any;
-    allowNodeRequire: any;
-    logger: any;
-    preAggregationsSchema: any;
-    allowUngroupedWithoutPrimaryKey: any;
-    convertTzForRawTimeDimension: any;
-    schemaVersion: any;
-    contextToRoles: any;
-    contextToGroups: any;
-    compileContext: any;
-    allowJsDuplicatePropsInSchema: any;
-    sqlCache: any;
-    standalone: any;
-    nativeInstance: NativeInstance;
-    compiledScriptCache: LRUCache<{}, {}, unknown>;
-    compiledScriptCacheInterval: NodeJS.Timeout;
+/// <reference types="node" />
+/// <reference types="node" />
+import vm from 'vm';
+import { BaseQuery, CanUsePreAggregationFn, Compiler, CubeDefinition, EvaluatedCube, PreAggregationFilters, PreAggregationInfo, PreAggregationReferences, QueryFactory, TransformedQuery } from '@cubejs-backend/schema-compiler';
+import { GraphQLSchema } from 'graphql';
+import { LRUCache } from 'lru-cache';
+import { NativeInstance } from '@cubejs-backend/native';
+import type { SchemaFileRepository } from '@cubejs-backend/shared';
+import { NormalizedQuery } from '@cubejs-backend/api-gateway';
+import { DbTypeAsyncFn, DialectClassFn, LoggerFn } from './types';
+type Context = any;
+export interface CompilerApiOptions {
+    dialectClass?: DialectClassFn;
+    logger?: LoggerFn;
+    preAggregationsSchema?: string | ((context: Context) => string | Promise<string>);
+    allowUngroupedWithoutPrimaryKey?: boolean;
+    convertTzForRawTimeDimension?: boolean;
+    schemaVersion?: () => string | object | Promise<string | object>;
+    contextToRoles?: (context: Context) => string[] | Promise<string[]>;
+    contextToGroups?: (context: Context) => string[] | Promise<string[]>;
+    compileContext?: any;
+    allowJsDuplicatePropsInSchema?: boolean;
+    sqlCache?: boolean;
+    standalone?: boolean;
+    compilerCacheSize?: number;
+    maxCompilerCacheKeepAlive?: number;
+    updateCompilerCacheKeepAlive?: boolean;
+    externalDialectClass?: BaseQuery;
+    externalDbType?: string;
+    devServer?: boolean;
+    fastReload?: boolean;
+    allowNodeRequire?: boolean;
+}
+export interface GetSqlOptions {
+    includeDebugInfo?: boolean;
+    exportAnnotatedSql?: boolean;
+    requestId?: string;
+}
+export interface SqlResult {
+    external: any;
+    sql: any;
+    lambdaQueries: any;
+    timeDimensionAlias?: string;
+    timeDimensionField?: string;
+    order?: any;
+    cacheKeyQueries: any;
+    preAggregations: any;
+    dataSource: string;
+    aliasNameToMember: any;
+    rollupMatchResults?: any;
+    canUseTransformedQuery: boolean;
+    memberNames: string[];
+}
+export interface DataSourceInfo {
+    dataSource: string;
+    dbType: string;
+}
+export declare class CompilerApi {
+    protected readonly repository: SchemaFileRepository;
+    protected readonly dbType: DbTypeAsyncFn;
+    protected readonly dialectClass?: DialectClassFn;
+    readonly options: CompilerApiOptions;
+    protected readonly allowNodeRequire: boolean;
+    protected readonly logger: (msg: string, params: any) => void;
+    protected readonly preAggregationsSchema?: string | ((context: Context) => string | Promise<string>);
+    protected readonly allowUngroupedWithoutPrimaryKey?: boolean;
+    protected readonly convertTzForRawTimeDimension?: boolean;
+    schemaVersion?: () => string | object | Promise<string | object>;
+    protected readonly contextToRoles?: (context: Context) => string[] | Promise<string[]>;
+    protected readonly contextToGroups?: (context: Context) => string[] | Promise<string[]>;
+    protected readonly compileContext?: any;
+    protected readonly allowJsDuplicatePropsInSchema?: boolean;
+    protected readonly sqlCache?: boolean;
+    protected readonly standalone?: boolean;
+    protected readonly nativeInstance: NativeInstance;
+    protected readonly compiledScriptCache: LRUCache<string, vm.Script>;
+    protected readonly compiledYamlCache: LRUCache<string, string>;
+    protected readonly compiledJinjaCache: LRUCache<string, string>;
+    protected compiledScriptCacheInterval?: NodeJS.Timeout;
+    protected graphqlSchema?: GraphQLSchema;
+    protected compilers?: Promise<Compiler>;
+    protected compilerVersion?: string;
+    protected queryFactory?: QueryFactory;
+    constructor(repository: SchemaFileRepository, dbType: DbTypeAsyncFn, options: CompilerApiOptions);
     dispose(): void;
-    setGraphQLSchema(schema: any): void;
-    graphqlSchema: any;
-    getGraphQLSchema(): any;
+    setGraphQLSchema(schema: GraphQLSchema): void;
+    getGraphQLSchema(): GraphQLSchema;
     createNativeInstance(): NativeInstance;
-    getCompilers({ requestId }?: {
-        requestId: any;
-    }): Promise<any>;
-    compilers: any;
-    compilerVersion: any;
+    getCompilers(options?: {
+        requestId?: string;
+    }): Promise<Compiler>;
     /**
      * Creates the compilers instances without model compilation,
      * because it could fail and no compilers will be returned.
      */
-    createCompilerInstances(): {
-        compiler: import("@cubejs-backend/schema-compiler/dist/src/compiler/DataSchemaCompiler").DataSchemaCompiler;
-        metaTransformer: import("@cubejs-backend/schema-compiler/dist/src/compiler/CubeToMetaTransformer").CubeToMetaTransformer;
-        cubeEvaluator: import("@cubejs-backend/schema-compiler/dist/src/compiler/CubeEvaluator").CubeEvaluator;
-        contextEvaluator: import("@cubejs-backend/schema-compiler/dist/src/compiler/ContextEvaluator").ContextEvaluator;
-        joinGraph: import("@cubejs-backend/schema-compiler/dist/src/compiler/JoinGraph").JoinGraph;
-        compilerCache: import("@cubejs-backend/schema-compiler/dist/src/compiler/CompilerCache").CompilerCache;
-        headCommitId: string;
-        compilerId: string;
-    };
-    compileSchema(compilerVersion: any, requestId: any): Promise<any>;
-    queryFactory: QueryFactory;
-    createQueryFactory(compilers: any): Promise<QueryFactory>;
-    getDbType(dataSource?: string): Promise<any>;
-    getDialectClass(dataSource: string, dbType: any): any;
-    getSqlGenerator(query: any, dataSource: any): Promise<{
+    createCompilerInstances(): Compiler;
+    compileSchema(compilerVersion: string, requestId?: string): Promise<Compiler>;
+    createQueryFactory(compilers: Compiler): Promise<QueryFactory>;
+    getDbType(dataSource?: string): Promise<string>;
+    getDialectClass(dataSource: string, dbType: string): BaseQuery;
+    getSqlGenerator(query: NormalizedQuery, dataSource?: string): Promise<{
         sqlGenerator: any;
-        compilers: any;
+        compilers: Compiler;
     }>;
-    getSql(query: any, options?: {}): Promise<any>;
-    getRolesFromContext(context: any): Promise<Set<any>>;
-    getGroupsFromContext(context: any): Promise<Set<any>>;
-    userHasRole(userRoles: any, role: any): any;
-    userHasGroup(userGroups: any, group: any): any;
-    roleMeetsConditions(evaluatedConditions: any): any;
-    getCubesFromQuery(query: any, context: any): Promise<Set<any>>;
-    hashRequestContext(context: any): any;
-    getApplicablePolicies(cube: any, context: any, compilers: any): Promise<any>;
-    evaluateNestedFilter(filter: any, cube: any, context: any, cubeEvaluator: any): {
-        member: any;
-        operator: any;
-        values: any;
-        or: any;
-        and: any;
-    };
+    getSql(query: NormalizedQuery, options?: GetSqlOptions): Promise<SqlResult>;
+    protected getRolesFromContext(context: Context): Promise<Set<string>>;
+    protected getGroupsFromContext(context: Context): Promise<Set<string>>;
+    protected userHasRole(userRoles: Set<string>, role: string): boolean;
+    protected userHasGroup(userGroups: Set<string>, group: string | string[]): boolean;
+    protected roleMeetsConditions(evaluatedConditions?: any[]): boolean;
+    protected getCubesFromQuery(query: NormalizedQuery, context?: Context): Promise<Set<string>>;
+    protected hashRequestContext(context: Context): string;
+    protected getApplicablePolicies(cube: EvaluatedCube, context: Context, compilers: Compiler): Promise<any[]>;
+    protected evaluateNestedFilter(filter: any, cube: any, context: Context, cubeEvaluator: any): any;
     /**
      * This method rewrites the query according to RBAC row level security policies.
      *
      * If RBAC is enabled, it looks at all the Cubes from the query with accessPolicy defined.
      * It extracts all policies applicable to for the current user context (contextToRoles() + conditions).
-     * It then generates an rls filter by
+     * It then generates a rls filter by
      * - combining all filters for the same role with AND
      * - combining all filters for different roles with OR
      * - combining cube and view filters with AND
     */
-    applyRowLevelSecurity(query: any, evaluatedQuery: any, context: any): Promise<{
-        query: any;
+    applyRowLevelSecurity(query: NormalizedQuery, evaluatedQuery: NormalizedQuery, context: Context): Promise<{
+        query: NormalizedQuery;
         denied: boolean;
     }>;
-    removeEmptyFilters(filter: any): any;
-    buildFinalRlsFilter(cubeFiltersPerCubePerRole: any, viewFiltersPerCubePerRole: any, hasAllowAllForCube: any): any;
-    compilerCacheFn(requestId: any, key: any, path: any): Promise<(subKey: any, cacheFn: any) => any>;
-    /**
-     *
-     * @param {unknown|undefined} filter
-     * @returns {Promise<Array<PreAggregationInfo>>}
-     */
-    preAggregations(filter: unknown | undefined): Promise<Array<PreAggregationInfo>>;
-    scheduledPreAggregations(): Promise<any>;
-    createQueryByDataSource(compilers: any, query: any, dataSource: any, dbType: any): Promise<any>;
-    createQuery(compilers: any, dbType: any, dialectClass: any, query: any): any;
+    protected removeEmptyFilters(filter: any): any;
+    protected buildFinalRlsFilter(cubeFiltersPerCubePerRole: Record<string, Record<string, any[]>>, viewFiltersPerCubePerRole: Record<string, Record<string, any[]>>, hasAllowAllForCube: Record<string, boolean>): any;
+    compilerCacheFn(requestId: string, key: any, path: string[]): Promise<(subKey: string[], cacheFn: () => any) => any>;
+    preAggregations(filter?: PreAggregationFilters): Promise<PreAggregationInfo[]>;
+    scheduledPreAggregations(): Promise<PreAggregationInfo[]>;
+    createQueryByDataSource(compilers: Compiler, query: NormalizedQuery | {}, dataSource?: string, dbType?: string): Promise<BaseQuery>;
+    createQuery(compilers: Compiler, dbType: string, dialectClass: BaseQuery, query: NormalizedQuery | {}): BaseQuery;
     /**
      * if RBAC is enabled, this method is used to patch isVisible property of cube members
      * based on access policies.
     */
-    patchVisibilityByAccessPolicy(compilers: any, context: any, cubes: any): Promise<{
-        cubes: any;
-        visibilityMaskHash: string;
+    protected patchVisibilityByAccessPolicy(compilers: Compiler, context: Context, cubes: any[]): Promise<{
+        cubes: any[];
+        visibilityMaskHash: string | null;
     }>;
-    mixInVisibilityMaskHash(compilerId: any, visibilityMaskHash: any): string;
-    metaConfig(requestContext: any, options?: {}): Promise<any>;
-    metaConfigExtended(requestContext: any, options: any): Promise<{
+    protected mixInVisibilityMaskHash(compilerId: string, visibilityMaskHash: string): string;
+    metaConfig(requestContext: Context, options?: {
+        includeCompilerId?: boolean;
+        requestId?: string;
+    }): Promise<any>;
+    metaConfigExtended(requestContext: Context, options?: {
+        requestId?: string;
+    }): Promise<{
         metaConfig: any;
-        cubeDefinitions: any;
-    }>;
-    compilerId(options?: {}): Promise<any>;
-    cubeNameToDataSource(query: any): Promise<any>;
-    memberToDataSource(query: any): Promise<{
-        [k: string]: any;
+        cubeDefinitions: Record<string, CubeDefinition>;
     }>;
-    dataSources(orchestratorApi: any, query: any): Promise<{
-        dataSources: any[];
+    compilerId(options?: {
+        requestId?: string;
+    }): Promise<string>;
+    cubeNameToDataSource(query: {
+        requestId?: string;
+    }): Promise<Record<string, string>>;
+    memberToDataSource(query: NormalizedQuery): Promise<Record<string, string>>;
+    dataSources(orchestratorApi: any, query?: NormalizedQuery): Promise<{
+        dataSources: DataSourceInfo[];
     }>;
-    canUsePreAggregationForTransformedQuery(transformedQuery: any, refs: any): import("@cubejs-backend/schema-compiler").CanUsePreAggregationFn;
+    canUsePreAggregationForTransformedQuery(transformedQuery: TransformedQuery, refs?: PreAggregationReferences | null): CanUsePreAggregationFn;
 }
-import { NativeInstance } from '@cubejs-backend/native';
-import { LRUCache } from 'lru-cache';
-import { QueryFactory } from '@cubejs-backend/schema-compiler';
+export {};
 //# sourceMappingURL=CompilerApi.d.ts.map

package/dist/src/core/CompilerApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CompilerApi.d.ts","sourceRoot":"","sources":["../../../src/core/CompilerApi.js"],"names":[],"mappings":"AAaA;IACE;;;;;OAKG;IAEH,mFA+BC;IA9BC,iCAA4B;IAC5B,sBAAoB;IACpB,kBAAwC;IACxC,aAA4B;IAC5B,sBAA0F;IAC1F,YAAiC;IACjC,2BAA+D;IAC/D,qCAAmF;IACnF,kCAA6E;IAC7E,mBAA+C;IAC/C,oBAAiD;IACjD,qBAAmD;IACnD,oBAA4C;IAC5C,mCAA0E;IAC1E,cAAgC;IAChC,gBAAoC;IACpC,+BAAiD;IACjD,+CAIE;IAIA,4CAGC;IAIL,gBAIC;IAED,oCAEC;IADC,mBAA2B;IAG7B,wBAEC;IAED,uCAEC;IAED;;qBAwBC;IARG,eAGE;IACF,qBAAsC;IAM1C;;;OAGG;IACH;;;;;;;;;MASC;IAED,kEAkCC;IAlBG,2BAA4D;IAoBhE,0DAcC;IAED,6CAEC;IAED,sDAEC;IAED;;;OAiCC;IAED,+CA6BC;IAED,qDAKC;IAED,sDAKC;IAED,4CAEC;IAED,+CAKC;IAED,mDAUC;IAED,+DAGC;IAED,sCAKC;IAED,6EAkDC;IAED;;;;;;MAoBC;IAED;;;;;;;;;MASE;IACF;;;OAuEC;IAED,qCAUC;IAED,kHAoCC;IAED,kGAOC;IAED;;;;OAIG;IACH,wBAHW,OAAO,GAAC,SAAS,GACf,QAAQ,yBAAyB,CAAC,CAK9C;IAED,yCAGC;IAED,gGAMC;IAED,6EAeC;IAED;;;MAGE;IACF;;;OA4EC;IAED,0EAKC;IAED,4DAoBC;IAED;;;OAWC;IAED,uCAEC;IAED,+CAOC;IAED;;OA0BC;IAED;;OAsBC;IAED,4IAEC;CACF;+BArtB8B,wBAAwB;yBAD9B,WAAW;6BAF7B,iCAAiC"}
+{"version":3,"file":"CompilerApi.d.ts","sourceRoot":"","sources":["../../../src/core/CompilerApi.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAEL,SAAS,EACT,sBAAsB,EAEtB,QAAQ,EAER,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,kBAAkB,EAClB,wBAAwB,EAIxB,YAAY,EACZ,gBAAgB,EAEjB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAE,eAAe,EAAoB,MAAM,6BAA6B,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAElE,KAAK,OAAO,GAAG,GAAG,CAAC;AAEnB,MAAM,WAAW,kBAAkB;IACjC,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAClF,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,aAAa,CAAC,EAAE,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IACjE,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACrE,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,oBAAoB,CAAC,EAAE,SAAS,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,GAAG,CAAC;IACT,aAAa,EAAE,GAAG,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,eAAe,EAAE,GAAG,CAAC;IACrB,eAAe,EAAE,GAAG,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,GAAG,CAAC;IACvB,kBAAkB,CAAC,EAAE,GAAG,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,WAAW;IACtB,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAEpD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAEzC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC;IAEjD,SAAgB,OAAO,EAAE,kBAAkB,CAAC;IAE5C,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IAE7C,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,IAAI,CAAC;IAE9D,SAAS,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAErG,SAAS,CAAC,QAAQ,CAAC,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE7D,SAAS,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEnD,aAAa,CAAC,EAAE,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAExE,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEvF,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAExF,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC;IAExC,SAAS,CAAC,QAAQ,CAAC,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAE3D,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEtC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAExC,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAElD,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;IAEpE,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE/D,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhE,SAAS,CAAC,2BAA2B,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAEvD,SAAS,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IAExC,SAAS,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAExC,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEnC,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;gBAEnB,UAAU,EAAE,oBAAoB,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,kBAAkB;IAkDhG,OAAO,IAAI,IAAI;IAaf,gBAAgB,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAI7C,gBAAgB,IAAI,aAAa;IAIjC,oBAAoB,IAAI,cAAc;IAIhC,YAAY,CAAC,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0BlF;;;OAGG;IACI,uBAAuB,IAAI,QAAQ;IAW7B,aAAa,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsC7E,kBAAkB,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;IAgB9D,SAAS,CAAC,UAAU,GAAE,MAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIhE,eAAe,CAAC,UAAU,EAAE,MAAkB,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS;IAIpE,eAAe,CAAC,KAAK,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,GAAG,CAAC;QAAC,SAAS,EAAE,QAAQ,CAAA;KAAE,CAAC;IAmCjH,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;cA+B5E,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;cAO3D,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAO5E,SAAS,CAAC,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAIpE,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO;IAOlF,SAAS,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO;cAYnD,iBAAiB,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAKlG,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;cAOtC,qBAAqB,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoDjH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,GAAG,GAAG;IAqBjG;;;;;;;;;MASE;IACW,qBAAqB,CAChC,KAAK,EAAE,eAAe,EACtB,cAAc,EAAE,eAAe,EAC/B,OAAO,EAAE,OAAO,GACf,OAAO,CAAC;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAyEvD,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG;IAY9C,SAAS,CAAC,mBAAmB,CAC3B,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAChE,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAChE,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,GAAG;IAsCO,eAAe,CAC1B,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,CAAC;IAS5C,eAAe,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAK9E,wBAAwB,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAKzD,uBAAuB,CAClC,SAAS,EAAE,QAAQ,EACnB,KAAK,EAAE,eAAe,GAAG,EAAE,EAC3B,UAAU,CAAC,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,SAAS,CAAC;IAQd,WAAW,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe,GAAG,EAAE,GAAG,SAAS;IAiBxH;;;MAGE;cACc,6BAA6B,CAC3C,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,GAAG,EAAE,GACX,OAAO,CAAC;QAAE,KAAK,EAAE,GAAG,EAAE,CAAC;QAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IA8E/D,SAAS,CAAC,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,MAAM;IAO5E,UAAU,CACrB,cAAc,EAAE,OAAO,EACvB,OAAO,GAAE;QAAE,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAChE,OAAO,CAAC,GAAG,CAAC;IAsBF,kBAAkB,CAC7B,cAAc,EAAE,OAAO,EACvB,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/B,OAAO,CAAC;QAAE,UAAU,EAAE,GAAG,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;KAAE,CAAC;IAanE,UAAU,CAAC,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAIjE,oBAAoB,CAAC,KAAK,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IASpF,kBAAkB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IA4B3E,WAAW,CACtB,eAAe,EAAE,GAAG,EACpB,KAAK,CAAC,EAAE,eAAe,GACtB,OAAO,CAAC;QAAE,WAAW,EAAE,cAAc,EAAE,CAAA;KAAE,CAAC;IAwBtC,uCAAuC,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,GAAE,wBAAwB,GAAG,IAAW,GAAG,sBAAsB;CAGzJ"}

package/dist/src/core/CompilerApi.js

@@ -9,20 +9,41 @@ const schema_compiler_1 = require("@cubejs-backend/schema-compiler");
 const uuid_1 = require("uuid");
 const lru_cache_1 = require("lru-cache");
 const native_1 = require("@cubejs-backend/native");
+const shared_1 = require("@cubejs-backend/shared");
 class CompilerApi {
-    /**
-     * Class constructor.
-     * @param {SchemaFileRepository} repository
-     * @param {DbTypeAsyncFn} dbType
-     * @param {*} options
-     */
+    repository;
+    dbType;
+    dialectClass;
+    options;
+    allowNodeRequire;
+    logger;
+    preAggregationsSchema;
+    allowUngroupedWithoutPrimaryKey;
+    convertTzForRawTimeDimension;
+    schemaVersion;
+    contextToRoles;
+    contextToGroups;
+    compileContext;
+    allowJsDuplicatePropsInSchema;
+    sqlCache;
+    standalone;
+    nativeInstance;
+    compiledScriptCache;
+    compiledYamlCache;
+    compiledJinjaCache;
+    compiledScriptCacheInterval;
+    graphqlSchema;
+    compilers;
+    compilerVersion;
+    queryFactory;
     constructor(repository, dbType, options) {
         this.repository = repository;
         this.dbType = dbType;
         this.dialectClass = options.dialectClass;
         this.options = options || {};
         this.allowNodeRequire = options.allowNodeRequire == null ? true : options.allowNodeRequire;
-        this.logger = this.options.logger;
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        this.logger = this.options.logger || (() => { });
         this.preAggregationsSchema = this.options.preAggregationsSchema;
         this.allowUngroupedWithoutPrimaryKey = this.options.allowUngroupedWithoutPrimaryKey;
         this.convertTzForRawTimeDimension = this.options.convertTzForRawTimeDimension;
@@ -34,20 +55,41 @@ class CompilerApi {
         this.sqlCache = options.sqlCache;
         this.standalone = options.standalone;
         this.nativeInstance = this.createNativeInstance();
+        // Caching stuff
         this.compiledScriptCache = new lru_cache_1.LRUCache({
             max: options.compilerCacheSize || 250,
             ttl: options.maxCompilerCacheKeepAlive,
             updateAgeOnGet: options.updateCompilerCacheKeepAlive
         });
+        this.compiledYamlCache = new lru_cache_1.LRUCache({
+            max: options.compilerCacheSize || 250,
+            ttl: options.maxCompilerCacheKeepAlive,
+            updateAgeOnGet: options.updateCompilerCacheKeepAlive
+        });
+        this.compiledJinjaCache = new lru_cache_1.LRUCache({
+            max: options.compilerCacheSize || 250,
+            ttl: options.maxCompilerCacheKeepAlive,
+            updateAgeOnGet: options.updateCompilerCacheKeepAlive
+        });
         // proactively free up old cache values occasionally
         if (this.options.maxCompilerCacheKeepAlive) {
-            this.compiledScriptCacheInterval = setInterval(() => this.compiledScriptCache.purgeStale(), this.options.maxCompilerCacheKeepAlive);
+            this.compiledScriptCacheInterval = setInterval(() => {
+                this.compiledScriptCache.purgeStale();
+                this.compiledYamlCache.purgeStale();
+                this.compiledJinjaCache.purgeStale();
+            }, this.options.maxCompilerCacheKeepAlive);
         }
     }
     dispose() {
         if (this.compiledScriptCacheInterval) {
             clearInterval(this.compiledScriptCacheInterval);
+            this.compiledScriptCacheInterval = null;
         }
+        // freeing memory-heavy allocated instances
+        // using safeguard for potential dangling references.
+        this.compilers = (0, shared_1.disposedProxy)('compilers', 'disposed CompilerApi instance');
+        this.queryFactory = (0, shared_1.disposedProxy)('queryFactory', 'disposed CompilerApi instance');
+        this.graphqlSchema = undefined;
     }
     setGraphQLSchema(schema) {
         this.graphqlSchema = schema;
@@ -58,7 +100,7 @@ class CompilerApi {
     createNativeInstance() {
         return new native_1.NativeInstance();
     }
-    async getCompilers({ requestId } = {}) {
+    async getCompilers(options = {}) {
         let compilerVersion = (this.schemaVersion && await this.schemaVersion() ||
             'default_schema_version');
         if (typeof compilerVersion === 'object') {
@@ -69,7 +111,7 @@ class CompilerApi {
             compilerVersion += `_${crypto_1.default.createHash('md5').update(JSON.stringify(files)).digest('hex')}`;
         }
         if (!this.compilers || this.compilerVersion !== compilerVersion) {
-            this.compilers = this.compileSchema(compilerVersion, requestId).catch(e => {
+            this.compilers = this.compileSchema(compilerVersion, options.requestId).catch(e => {
                 this.compilers = undefined;
                 throw e;
             });
@@ -105,6 +147,8 @@ class CompilerApi {
                 standalone: this.standalone,
                 nativeInstance: this.nativeInstance,
                 compiledScriptCache: this.compiledScriptCache,
+                compiledJinjaCache: this.compiledJinjaCache,
+                compiledYamlCache: this.compiledYamlCache,
             });
             this.queryFactory = await this.createQueryFactory(compilers);
             this.logger('Compiling schema completed', {
@@ -135,7 +179,7 @@ class CompilerApi {
         return new schema_compiler_1.QueryFactory(cubeToQueryClass);
     }
     async getDbType(dataSource = 'default') {
-        return this.dbType({ dataSource, });
+        return this.dbType({ dataSource, securityContext: {}, requestId: '' });
     }
     getDialectClass(dataSource = 'default', dbType) {
         return this.dialectClass?.({ dataSource, dbType });
@@ -225,7 +269,7 @@ class CompilerApi {
         return true;
     }
     async getCubesFromQuery(query, context) {
-        const sql = await this.getSql(query, { requestId: context.requestId });
+        const sql = await this.getSql(query, { requestId: context?.requestId });
         return new Set(sql.memberNames.map(memberName => memberName.split('.')[0]));
     }
     hashRequestContext(context) {
@@ -240,7 +284,7 @@ class CompilerApi {
         if (!cache.has(cacheKey)) {
             const userRoles = await this.getRolesFromContext(context);
             const userGroups = await this.getGroupsFromContext(context);
-            const policies = cube.accessPolicy.filter(policy => {
+            const policies = cube.accessPolicy.filter((policy) => {
                 // Validate that policy doesn't have both role and group/groups - this is invalid
                 if (policy.role && (policy.group || policy.groups)) {
                     const groupValue = policy.group || policy.groups;
@@ -254,7 +298,7 @@ class CompilerApi {
                     const groupsDisplay = Array.isArray(policy.groups) ? policy.groups.join(', ') : policy.groups;
                     throw new Error(`Access policy cannot have both 'group' and 'groups' properties.\nPolicy in cube '${cube.name}' has group '${groupDisplay}' and groups '${groupsDisplay}'.\nUse either 'group' or 'groups', not both.`);
                 }
-                const evaluatedConditions = (policy.conditions || []).map(condition => compilers.cubeEvaluator.evaluateContextFunction(cube, condition.if, context));
+                const evaluatedConditions = (policy.conditions || []).map((condition) => compilers.cubeEvaluator.evaluateContextFunction(cube, condition.if, context));
                 // Check if policy matches by role, group, or groups
                 let hasAccess = false;
                 if (policy.role) {
@@ -286,10 +330,10 @@ class CompilerApi {
             result.values = evaluatedValues;
         }
         if (filter.or) {
-            result.or = filter.or.map(f => this.evaluateNestedFilter(f, cube, context, cubeEvaluator));
+            result.or = filter.or.map((f) => this.evaluateNestedFilter(f, cube, context, cubeEvaluator));
         }
         if (filter.and) {
-            result.and = filter.and.map(f => this.evaluateNestedFilter(f, cube, context, cubeEvaluator));
+            result.and = filter.and.map((f) => this.evaluateNestedFilter(f, cube, context, cubeEvaluator));
         }
         return result;
     }
@@ -298,7 +342,7 @@ class CompilerApi {
      *
      * If RBAC is enabled, it looks at all the Cubes from the query with accessPolicy defined.
      * It extracts all policies applicable to for the current user context (contextToRoles() + conditions).
-     * It then generates an rls filter by
+     * It then generates a rls filter by
      * - combining all filters for the same role with AND
      * - combining all filters for different roles with OR
      * - combining cube and view filters with AND
@@ -323,7 +367,7 @@ class CompilerApi {
                 const userPolicies = await this.getApplicablePolicies(cube, context, compilers);
                 for (const policy of userPolicies) {
                     hasAccessPermission = true;
-                    (policy?.rowLevel?.filters || []).forEach(filter => {
+                    (policy?.rowLevel?.filters || []).forEach((filter) => {
                         filtersMap[cubeName] = filtersMap[cubeName] || {};
                         // Create a unique key for the policy (either role, group, or groups)
                         const groupValue = policy.group || policy.groups;
@@ -335,7 +379,7 @@ class CompilerApi {
                     });
                     if (!policy?.rowLevel || policy?.rowLevel?.allowAll) {
                         hasAllowAllForCube[cubeName] = true;
-                        // We don't have a way to add an "all alloed" filter like `WHERE 1 = 1` or something.
+                        // We don't have a way to add an "all allowed" filter like `WHERE 1 = 1` or something.
                         // Instead, we'll just mark that the user has "all" access to a given cube and remove
                         // all filters later
                         break;
@@ -363,11 +407,11 @@ class CompilerApi {
     }
     removeEmptyFilters(filter) {
         if (filter?.and) {
-            const and = filter.and.map(f => this.removeEmptyFilters(f)).filter(f => f);
+            const and = filter.and.map((f) => this.removeEmptyFilters(f)).filter((f) => f);
             return and.length > 1 ? { and } : and.at(0) || null;
         }
         if (filter?.or) {
-            const or = filter.or.map(f => this.removeEmptyFilters(f)).filter(f => f);
+            const or = filter.or.map((f) => this.removeEmptyFilters(f)).filter((f) => f);
             return or.length > 1 ? { or } : or.at(0) || null;
         }
         return filter;
@@ -409,11 +453,6 @@ class CompilerApi {
             return (subKey, cacheFn) => cacheFn();
         }
     }
-    /**
-     *
-     * @param {unknown|undefined} filter
-     * @returns {Promise<Array<PreAggregationInfo>>}
-     */
     async preAggregations(filter) {
         const { cubeEvaluator } = await this.getCompilers();
         return cubeEvaluator.preAggregations(filter);
@@ -494,10 +533,10 @@ class CompilerApi {
                 public: item.public && isMemberVisibleInContext[item.name]
             });
         };
-        const visibiliyMask = JSON.stringify(isMemberVisibleInContext, Object.keys(isMemberVisibleInContext).sort());
+        const visibilityMask = JSON.stringify(isMemberVisibleInContext, Object.keys(isMemberVisibleInContext).sort());
         // This hash will be returned along the modified meta config and can be used
         // to distinguish between different "schema versions" after DAP visibility is applied
-        const visibilityMaskHash = crypto_1.default.createHash('sha256').update(visibiliyMask).digest('hex');
+        const visibilityMaskHash = crypto_1.default.createHash('sha256').update(visibilityMask).digest('hex');
         return {
             cubes: cubes
                 .map((cube) => ({
@@ -513,7 +552,7 @@ class CompilerApi {
         };
     }
     mixInVisibilityMaskHash(compilerId, visibilityMaskHash) {
-        const uuidBytes = (0, uuid_1.parse)(compilerId);
+        const uuidBytes = Buffer.from((0, uuid_1.parse)(compilerId));
         const hashBytes = Buffer.from(visibilityMaskHash, 'hex');
         return (0, uuid_1.v4)({ random: crypto_1.default.createHash('sha256').update(uuidBytes).update(hashBytes).digest()
                 .subarray(0, 16) });
@@ -527,8 +566,8 @@ class CompilerApi {
             return {
                 cubes: patchedCubes,
                 // This compilerId is primarily used by the cubejs-backend-native or caching purposes.
-                // By default it doesn't account for member visibility changes introduced above by DAP.
-                // Here we're modifying the originila compilerId in a way that it's distinct for
+                // By default, it doesn't account for member visibility changes introduced above by DAP.
+                // Here we're modifying the original compilerId in a way that it's distinct for
                 // distinct schema versions while still being a valid UUID.
                 compilerId: visibilityMaskHash ? this.mixInVisibilityMaskHash(compilers.compilerId, visibilityMaskHash) : compilers.compilerId,
             };
@@ -560,7 +599,7 @@ class CompilerApi {
             const cubeDef = cubeEvaluator.cubeFromPath(cube);
             if (cubeDef.isView) {
                 const viewName = cubeDef.name;
-                return cubeDef.includedMembers?.map(included => {
+                return cubeDef.includedMembers?.map((included) => {
                     const memberName = `${viewName}.${included.name}`;
                     const refCubeDef = cubeEvaluator.cubeFromPath(included.memberPath);
                     const dataSource = refCubeDef.dataSource ?? 'default';
@@ -583,7 +622,7 @@ class CompilerApi {
         const cubeNameToDataSource = await this.cubeNameToDataSource(query || { requestId: `datasources-${(0, uuid_1.v4)()}` });
         let dataSources = Object.keys(cubeNameToDataSource).map(c => cubeNameToDataSource[c]);
         dataSources = [...new Set(dataSources)];
-        dataSources = await Promise.all(dataSources.map(async (dataSource) => {
+        const dataSourcesInfo = await Promise.all(dataSources.map(async (dataSource) => {
             try {
                 await orchestratorApi.driverFactory(dataSource);
                 const dbType = await this.getDbType(dataSource);
@@ -594,10 +633,10 @@ class CompilerApi {
             }
         }));
         return {
-            dataSources: dataSources.filter((source) => source),
+            dataSources: dataSourcesInfo.filter((source) => !!source),
         };
     }
-    canUsePreAggregationForTransformedQuery(transformedQuery, refs) {
+    canUsePreAggregationForTransformedQuery(transformedQuery, refs = null) {
         return schema_compiler_1.PreAggregations.canUsePreAggregationForTransformedQueryFn(transformedQuery, refs);
     }
 }