Refactor parameter queries.

Author: rkistner

packages/sync-rules/src/BucketSource.ts

@@ -48,24 +48,18 @@ export interface BucketParameterSourceDefinition {
   readonly name: string;
   readonly type: BucketSourceType;
   readonly subscribedToByDefault: boolean;
+  /**
+   * For debug use only.
+   */
+  readonly bucketParameters: string[];
 
   getSourceTables(): Set<TablePattern>;
   createParameterSource(params: CreateSourceParams): BucketParameterSource;
 
-  /**
-   * Whether {@link pushBucketParameterQueriers} may include a querier where
-   * {@link BucketParameterQuerier.hasDynamicBuckets} is true.
-   *
-   * This is mostly used for testing.
-   */
-  hasDynamicBucketQueries(): boolean;
-
   getSourceTables(): Set<TablePattern>;
 
   /** Whether the table possibly affects the buckets resolved by this source. */
   tableSyncsParameters(table: SourceTableInterface): boolean;
-
-  debugRepresentation(): any;
 }
 
 /**

packages/sync-rules/src/SqlBucketDescriptor.ts

@@ -1,35 +1,22 @@
-import { BucketInclusionReason, ResolvedBucket } from './BucketDescription.js';
-import { BucketParameterQuerier, mergeBucketParameterQueriers, PendingQueriers } from './BucketParameterQuerier.js';
 import {
   BucketDataSource,
   BucketDataSourceDefinition,
-  BucketParameterSource,
   BucketParameterSourceDefinition,
   BucketSourceType,
-  CreateSourceParams,
-  ResultSetDescription
+  CreateSourceParams
 } from './BucketSource.js';
 import { ColumnDefinition } from './ExpressionType.js';
 import { IdSequence } from './IdSequence.js';
 import { SourceTableInterface } from './SourceTableInterface.js';
 import { SqlDataQuery } from './SqlDataQuery.js';
 import { SqlParameterQuery } from './SqlParameterQuery.js';
-import { GetQuerierOptions, SyncRulesOptions } from './SqlSyncRules.js';
+import { SyncRulesOptions } from './SqlSyncRules.js';
 import { StaticSqlParameterQuery } from './StaticSqlParameterQuery.js';
 import { TablePattern } from './TablePattern.js';
 import { TableValuedFunctionSqlParameterQuery } from './TableValuedFunctionSqlParameterQuery.js';
-import { SqlRuleError } from './errors.js';
 import { CompatibilityContext } from './compatibility.js';
-import {
-  BucketIdTransformer,
-  EvaluatedParametersResult,
-  EvaluateRowOptions,
-  EvaluationResult,
-  QueryParseOptions,
-  RequestParameters,
-  SourceSchema,
-  SqliteRow
-} from './types.js';
+import { SqlRuleError } from './errors.js';
+import { EvaluationResult, QueryParseOptions, SourceSchema } from './types.js';
 
 export interface QueryParseResult {
   /**
@@ -40,7 +27,7 @@ export interface QueryParseResult {
   errors: SqlRuleError[];
 }
 
-export class SqlBucketDescriptor implements BucketDataSourceDefinition, BucketParameterSourceDefinition {
+export class SqlBucketDescriptor implements BucketDataSourceDefinition {
   name: string;
   private bucketParametersInternal: string[] | null = null;
 
@@ -124,76 +111,8 @@ export class SqlBucketDescriptor implements BucketDataSourceDefinition, BucketPa
     };
   }
 
-  createParameterSource(params: CreateSourceParams): BucketParameterSource {
-    return {
-      definition: this,
-
-      evaluateParameterRow: (sourceTable: SourceTableInterface, row: SqliteRow): EvaluatedParametersResult[] => {
-        let results: EvaluatedParametersResult[] = [];
-        for (let query of this.parameterQueries) {
-          if (query.applies(sourceTable)) {
-            results.push(...query.evaluateParameterRow(row));
-          }
-        }
-        return results;
-      },
-      pushBucketParameterQueriers: (result: PendingQueriers, options: GetQuerierOptions) => {
-        const reasons = [this.bucketInclusionReason()];
-        const staticBuckets = this.getStaticBucketDescriptions(
-          options.globalParameters,
-          reasons,
-          params.bucketIdTransformer
-        );
-        const staticQuerier = {
-          staticBuckets,
-          hasDynamicBuckets: false,
-          parameterQueryLookups: [],
-          queryDynamicBucketDescriptions: async () => []
-        } satisfies BucketParameterQuerier;
-        result.queriers.push(staticQuerier);
-
-        if (this.parameterQueries.length == 0) {
-          return;
-        }
-
-        const dynamicQueriers = this.parameterQueries.map((query) =>
-          query.getBucketParameterQuerier(options.globalParameters, reasons, params.bucketIdTransformer)
-        );
-        result.queriers.push(...dynamicQueriers);
-      },
-
-      /**
-       * @deprecated Use `pushBucketParameterQueriers` instead and merge at the top-level.
-       */
-      getBucketParameterQuerier(options: GetQuerierOptions): BucketParameterQuerier {
-        const queriers: BucketParameterQuerier[] = [];
-        this.pushBucketParameterQueriers({ queriers, errors: [] }, options);
-
-        return mergeBucketParameterQueriers(queriers);
-      }
-    };
-  }
-
-  getStaticBucketDescriptions(
-    parameters: RequestParameters,
-    reasons: BucketInclusionReason[],
-    transformer: BucketIdTransformer
-  ): ResolvedBucket[] {
-    let results: ResolvedBucket[] = [];
-    for (let query of this.globalParameterQueries) {
-      for (const desc of query.getStaticBucketDescriptions(parameters, transformer)) {
-        results.push({
-          ...desc,
-          definition: this.name,
-          inclusion_reasons: reasons
-        });
-      }
-    }
-    return results;
-  }
-
-  hasDynamicBucketQueries(): boolean {
-    return this.parameterQueries.length > 0;
+  getParameterSourceDefinitions(): BucketParameterSourceDefinition[] {
+    return [...this.parameterQueries, ...this.globalParameterQueries];
   }
 
   getSourceTables(): Set<TablePattern> {
@@ -210,10 +129,6 @@ export class SqlBucketDescriptor implements BucketDataSourceDefinition, BucketPa
     return result;
   }
 
-  private bucketInclusionReason(): BucketInclusionReason {
-    return 'default';
-  }
-
   tableSyncsData(table: SourceTableInterface): boolean {
     for (let query of this.dataQueries) {
       if (query.applies(table)) {
@@ -223,15 +138,6 @@ export class SqlBucketDescriptor implements BucketDataSourceDefinition, BucketPa
     return false;
   }
 
-  tableSyncsParameters(table: SourceTableInterface): boolean {
-    for (let query of this.parameterQueries) {
-      if (query.applies(table)) {
-        return true;
-      }
-    }
-    return false;
-  }
-
   resolveResultSets(schema: SourceSchema, tables: Record<string, Record<string, ColumnDefinition>>) {
     for (let query of this.dataQueries) {
       query.resolveResultSets(schema, tables);

packages/sync-rules/src/SqlParameterQuery.ts

@@ -5,7 +5,13 @@ import {
   BucketPriority,
   DEFAULT_BUCKET_PRIORITY
 } from './BucketDescription.js';
-import { BucketParameterQuerier, ParameterLookup, ParameterLookupSource } from './BucketParameterQuerier.js';
+import {
+  BucketParameterQuerier,
+  mergeBucketParameterQueriers,
+  ParameterLookup,
+  ParameterLookupSource,
+  PendingQueriers
+} from './BucketParameterQuerier.js';
 import { SqlRuleError } from './errors.js';
 import { SourceTableInterface } from './SourceTableInterface.js';
 import { AvailableTable, SqlTools } from './sql_filters.js';
@@ -31,6 +37,13 @@ import {
 } from './types.js';
 import { filterJsonRow, getBucketId, isJsonValue, isSelectStatement, normalizeParameterValue } from './utils.js';
 import { DetectRequestParameters } from './validators.js';
+import {
+  BucketParameterSource,
+  BucketParameterSourceDefinition,
+  BucketSourceType,
+  CreateSourceParams
+} from './BucketSource.js';
+import { GetQuerierOptions } from './index.js';
 
 export interface SqlParameterQueryOptions {
   sourceTable: TablePattern;
@@ -55,7 +68,7 @@ export interface SqlParameterQueryOptions {
  *  SELECT id as user_id FROM users WHERE users.user_id = token_parameters.user_id
  *  SELECT id as user_id, token_parameters.is_admin as is_admin FROM users WHERE users.user_id = token_parameters.user_id
  */
-export class SqlParameterQuery {
+export class SqlParameterQuery implements BucketParameterSourceDefinition {
   static fromSql(
     descriptorName: string,
     sql: string,
@@ -282,6 +295,10 @@ export class SqlParameterQuery {
   readonly queryId: string;
   readonly tools: SqlTools;
 
+  readonly type: BucketSourceType = BucketSourceType.SYNC_RULE;
+
+  readonly subscribedToByDefault: boolean = true;
+
   readonly errors: SqlRuleError[];
 
   constructor(options: SqlParameterQueryOptions) {
@@ -301,10 +318,46 @@ export class SqlParameterQuery {
     this.errors = options.errors ?? [];
   }
 
-  applies(table: SourceTableInterface) {
+  tableSyncsParameters(table: SourceTableInterface): boolean {
     return this.sourceTable.matches(table);
   }
 
+  get name(): string {
+    return this.descriptorName;
+  }
+
+  getSourceTables(): Set<TablePattern> {
+    return new Set([this.sourceTable]);
+  }
+
+  createParameterSource(params: CreateSourceParams): BucketParameterSource {
+    return {
+      definition: this,
+
+      evaluateParameterRow: (sourceTable: SourceTableInterface, row: SqliteRow): EvaluatedParametersResult[] => {
+        if (this.tableSyncsParameters(sourceTable)) {
+          return this.evaluateParameterRow(row);
+        } else {
+          return [];
+        }
+      },
+      pushBucketParameterQueriers: (result: PendingQueriers, options: GetQuerierOptions) => {
+        const q = this.getBucketParameterQuerier(options.globalParameters, ['default'], params.bucketIdTransformer);
+        result.queriers.push(q);
+      },
+
+      /**
+       * @deprecated Use `pushBucketParameterQueriers` instead and merge at the top-level.
+       */
+      getBucketParameterQuerier(options: GetQuerierOptions): BucketParameterQuerier {
+        const queriers: BucketParameterQuerier[] = [];
+        this.pushBucketParameterQueriers({ queriers, errors: [] }, options);
+
+        return mergeBucketParameterQueriers(queriers);
+      }
+    };
+  }
+
   /**
    * Given a replicated row, results an array of bucket parameter rows to persist.
    */

packages/sync-rules/src/SqlSyncRules.ts

@@ -232,7 +232,7 @@ export class SqlSyncRules {
         });
       }
       rules.bucketDataSources.push(descriptor);
-      rules.bucketParameterSources.push(descriptor);
+      rules.bucketParameterSources.push(...descriptor.getParameterSourceDefinitions());
     }
 
     for (const entry of streamMap?.items ?? []) {
@@ -400,10 +400,6 @@ export class SqlSyncRules {
     return applyRowContext(source, this.compatibility);
   }
 
-  hasDynamicBucketQueries() {
-    return this.bucketParameterSources.some((s) => s.hasDynamicBucketQueries());
-  }
-
   getSourceTables(): TablePattern[] {
     const sourceTables = new Map<String, TablePattern>();
     for (const bucket of this.bucketDataSources) {