Rename BucketParameterLookupSource -> ParameterIndexLookupCreator.

Author: rkistner

packages/sync-rules/src/BucketSource.ts

@@ -61,7 +61,7 @@ export interface BucketSource {
    *
    * The same source could in theory be present in multiple stream definitions.
    */
-  readonly parameterLookupSources: BucketParameterLookupSourceDefinition[];
+  readonly parameterIndexLookupCreators: ParameterIndexLookupCreator[];
 
   debugRepresentation(): any;
 }
@@ -118,11 +118,11 @@ export interface BucketDataSource {
 }
 
 /**
- * A parameter lookup source defines how to extract parameter lookup values from parameter queries.
+ * This defines how to extract parameter index lookup values from parameter queries or stream subqueries.
  *
- * This is only relevant for parameter queries that query tables.
+ * This is only relevant for parameter queries and subqueries that query tables.
  */
-export interface BucketParameterLookupSourceDefinition {
+export interface ParameterIndexLookupCreator {
   /**
    * lookupName + queryId is used to uniquely identify parameter queries for parameter storage.
    *
@@ -207,9 +207,9 @@ export function hydrateEvaluateRow(hydrationState: HydrationState, source: Bucke
 
 export function hydrateEvaluateParameterRow(
   hydrationState: HydrationState,
-  source: BucketParameterLookupSourceDefinition
+  source: ParameterIndexLookupCreator
 ): ScopedEvaluateParameterRow {
-  const scope = hydrationState.getParameterLookupScope(source);
+  const scope = hydrationState.getParameterIndexLookupScope(source);
   return (sourceTable: SourceTableInterface, row: SqliteRow): EvaluatedParametersResult[] => {
     return source.evaluateParameterRow(sourceTable, row).map((result) => {
       if (isEvaluationError(result)) {
@@ -235,9 +235,9 @@ export function mergeDataSources(
   };
 }
 
-export function mergeParameterLookupSources(
+export function mergeParameterIndexLookupCreators(
   hydrationState: HydrationState,
-  sources: BucketParameterLookupSourceDefinition[]
+  sources: ParameterIndexLookupCreator[]
 ): { evaluateParameterRow: ScopedEvaluateParameterRow } {
   const withScope = sources.map((source) => hydrateEvaluateParameterRow(hydrationState, source));
   return {
@@ -265,7 +265,10 @@ export function debugHydratedMergedSource(bucketSource: BucketSource, params?: C
   const hydrationState = params?.hydrationState ?? DEFAULT_HYDRATION_STATE;
   const resolvedParams = { hydrationState };
   const dataSource = mergeDataSources(hydrationState, bucketSource.dataSources);
-  const parameterLookupSource = mergeParameterLookupSources(hydrationState, bucketSource.parameterLookupSources);
+  const parameterLookupSource = mergeParameterIndexLookupCreators(
+    hydrationState,
+    bucketSource.parameterIndexLookupCreators
+  );
   const parameterQuerierSource = mergeParameterQuerierSources(
     bucketSource.parameterQuerierSources.map((source) => source.createParameterQuerierSource(resolvedParams))
   );

packages/sync-rules/src/HydratedSyncRules.ts

@@ -2,7 +2,7 @@ import { Scope } from 'ajv/dist/compile/codegen/scope.js';
 import { BucketDataSource, CreateSourceParams, HydratedBucketSource } from './BucketSource.js';
 import { BucketDataScope, ParameterLookupScope } from './HydrationState.js';
 import {
-  BucketParameterLookupSourceDefinition,
+  ParameterIndexLookupCreator,
   BucketParameterQuerier,
   buildBucketName,
   CompatibilityContext,
@@ -16,7 +16,7 @@ import {
   isEvaluationError,
   mergeBucketParameterQueriers,
   mergeDataSources,
-  mergeParameterLookupSources,
+  mergeParameterIndexLookupCreators,
   QuerierError,
   ScopedEvaluateParameterRow,
   ScopedEvaluateRow,
@@ -46,17 +46,17 @@ export class HydratedSyncRules {
     definition: SqlSyncRules;
     createParams: CreateSourceParams;
     bucketDataSources: BucketDataSource[];
-    bucketParameterLookupSources: BucketParameterLookupSourceDefinition[];
+    bucketParameterIndexLookupCreators: ParameterIndexLookupCreator[];
     eventDescriptors?: SqlEventDescriptor[];
     compatibility?: CompatibilityContext;
   }) {
     const hydrationState = params.createParams.hydrationState;
 
     this.definition = params.definition;
     this.innerEvaluateRow = mergeDataSources(hydrationState, params.bucketDataSources).evaluateRow;
-    this.innerEvaluateParameterRow = mergeParameterLookupSources(
+    this.innerEvaluateParameterRow = mergeParameterIndexLookupCreators(
       hydrationState,
-      params.bucketParameterLookupSources
+      params.bucketParameterIndexLookupCreators
     ).evaluateParameterRow;
 
     if (params.eventDescriptors) {

packages/sync-rules/src/HydrationState.ts

@@ -1,4 +1,4 @@
-import { BucketDataSource, BucketParameterLookupSourceDefinition } from './BucketSource.js';
+import { BucketDataSource, ParameterIndexLookupCreator } from './BucketSource.js';
 
 export interface BucketDataScope {
   /** The prefix is the bucket name before the parameters. */
@@ -29,7 +29,7 @@ export interface HydrationState<
   /**
    * Given a bucket parameter lookup definition, get the persistence name to use.
    */
-  getParameterLookupScope(source: BucketParameterLookupSourceDefinition): U;
+  getParameterIndexLookupScope(source: ParameterIndexLookupCreator): U;
 }
 
 /**
@@ -43,7 +43,7 @@ export const DEFAULT_HYDRATION_STATE: HydrationState = {
       bucketPrefix: source.uniqueName
     };
   },
-  getParameterLookupScope(source) {
+  getParameterIndexLookupScope(source) {
     return source.defaultLookupScope;
   }
 };
@@ -68,7 +68,7 @@ export function versionedHydrationState(version: number): HydrationState {
       };
     },
 
-    getParameterLookupScope(source: BucketParameterLookupSourceDefinition): ParameterLookupScope {
+    getParameterIndexLookupScope(source: ParameterIndexLookupCreator): ParameterLookupScope {
       // No transformations applied here
       return source.defaultLookupScope;
     }

packages/sync-rules/src/SqlBucketDescriptor.ts

@@ -54,7 +54,7 @@ export class SqlBucketDescriptor implements BucketSource {
     return [this.dataSource];
   }
 
-  get parameterLookupSources() {
+  get parameterIndexLookupCreators() {
     return this.parameterQueries;
   }
 

packages/sync-rules/src/SqlParameterQuery.ts

@@ -12,7 +12,7 @@ import {
   PendingQueriers
 } from './BucketParameterQuerier.js';
 import {
-  BucketParameterLookupSourceDefinition,
+  ParameterIndexLookupCreator,
   BucketParameterQuerierSource,
   BucketParameterQuerierSourceDefinition,
   CreateSourceParams
@@ -81,9 +81,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
-  implements BucketParameterLookupSourceDefinition, BucketParameterQuerierSourceDefinition
-{
+export class SqlParameterQuery implements ParameterIndexLookupCreator, BucketParameterQuerierSourceDefinition {
   static fromSql(
     descriptorName: string,
     sql: string,
@@ -360,7 +358,7 @@ export class SqlParameterQuery
   createParameterQuerierSource(params: CreateSourceParams): BucketParameterQuerierSource {
     const hydrationState = params.hydrationState;
     const bucketScope = hydrationState.getBucketSourceScope(this.querierDataSource);
-    const lookupState = hydrationState.getParameterLookupScope(this);
+    const lookupState = hydrationState.getParameterIndexLookupScope(this);
 
     return {
       pushBucketParameterQueriers: (result: PendingQueriers, options: GetQuerierOptions) => {

packages/sync-rules/src/SqlSyncRules.ts

@@ -3,7 +3,7 @@ import { isValidPriority } from './BucketDescription.js';
 import { BucketParameterQuerier, QuerierError } from './BucketParameterQuerier.js';
 import {
   BucketDataSource,
-  BucketParameterLookupSourceDefinition,
+  ParameterIndexLookupCreator,
   BucketParameterQuerierSourceDefinition,
   BucketSource,
   CreateSourceParams
@@ -90,7 +90,7 @@ export interface GetBucketParameterQuerierResult {
 
 export class SqlSyncRules {
   bucketDataSources: BucketDataSource[] = [];
-  bucketParameterLookupSources: BucketParameterLookupSourceDefinition[] = [];
+  bucketParameterLookupSources: ParameterIndexLookupCreator[] = [];
   bucketParameterQuerierSources: BucketParameterQuerierSourceDefinition[] = [];
   bucketSources: BucketSource[] = [];
 
@@ -258,7 +258,7 @@ export class SqlSyncRules {
 
       rules.bucketSources.push(descriptor);
       rules.bucketDataSources.push(...descriptor.dataSources);
-      rules.bucketParameterLookupSources.push(...descriptor.parameterLookupSources);
+      rules.bucketParameterLookupSources.push(...descriptor.parameterIndexLookupCreators);
       rules.bucketParameterQuerierSources.push(...descriptor.parameterQuerierSources);
     }
 
@@ -286,7 +286,7 @@ export class SqlSyncRules {
           const [parsed, errors] = syncStreamFromSql(key, q, queryOptions);
           rules.bucketSources.push(parsed);
           rules.bucketDataSources.push(...parsed.dataSources);
-          rules.bucketParameterLookupSources.push(...parsed.parameterLookupSources);
+          rules.bucketParameterLookupSources.push(...parsed.parameterIndexLookupCreators);
           rules.bucketParameterQuerierSources.push(...parsed.parameterQuerierSources);
           return {
             parsed: true,
@@ -417,7 +417,7 @@ export class SqlSyncRules {
       definition: this,
       createParams: resolvedParams,
       bucketDataSources: this.bucketDataSources,
-      bucketParameterLookupSources: this.bucketParameterLookupSources,
+      bucketParameterIndexLookupCreators: this.bucketParameterLookupSources,
       eventDescriptors: this.eventDescriptors,
       compatibility: this.compatibility
     });

packages/sync-rules/src/streams/filter.ts

@@ -16,7 +16,7 @@ import {
 import { isJsonValue, normalizeParameterValue } from '../utils.js';
 
 import { NodeLocation } from 'pgsql-ast-parser';
-import { BucketParameterLookupSourceDefinition, CreateSourceParams } from '../BucketSource.js';
+import { ParameterIndexLookupCreator, CreateSourceParams } from '../BucketSource.js';
 import { HydrationState, ParameterLookupScope } from '../HydrationState.js';
 import { SourceTableInterface } from '../SourceTableInterface.js';
 import { SubqueryEvaluator } from './parameter.js';
@@ -263,16 +263,16 @@ export class Subquery {
 
     const column = this.column;
 
-    let lookupSources: BucketParameterLookupSourceDefinition[] = [];
+    let lookupCreators: ParameterIndexLookupCreator[] = [];
     let lookupsForRequest: ((
       hydrationState: HydrationState
     ) => (parameters: RequestParameters) => ScopedParameterLookup[])[] = [];
 
     for (let [variant, id] of innerVariants) {
       const source = new SubqueryParameterLookupSource(this.table, column, variant, id, context.streamName);
-      lookupSources.push(source);
+      lookupCreators.push(source);
       lookupsForRequest.push((hydrationState: HydrationState) => {
-        const scope = hydrationState.getParameterLookupScope(source);
+        const scope = hydrationState.getParameterIndexLookupScope(source);
         return (parameters: RequestParameters) => {
           const lookups: ScopedParameterLookup[] = [];
           const instantiations = variant.findStaticInstantiations(parameters);
@@ -286,8 +286,8 @@ export class Subquery {
 
     const evaluator: SubqueryEvaluator = {
       parameterTable: this.table,
-      lookupSources() {
-        return lookupSources;
+      indexLookupCreators() {
+        return lookupCreators;
       },
       hydrateLookupsForRequest(hydrationState: HydrationState) {
         const hydrated = lookupsForRequest.map((fn) => fn(hydrationState));
@@ -531,7 +531,7 @@ export class EvaluateSimpleCondition extends FilterOperator {
   }
 }
 
-export class SubqueryParameterLookupSource implements BucketParameterLookupSourceDefinition {
+export class SubqueryParameterLookupSource implements ParameterIndexLookupCreator {
   constructor(
     private parameterTable: TablePattern,
     private column: RowValueClause,

packages/sync-rules/src/streams/parameter.ts

@@ -1,5 +1,5 @@
 import { ScopedParameterLookup, UnscopedParameterLookup } from '../BucketParameterQuerier.js';
-import { BucketParameterLookupSourceDefinition } from '../BucketSource.js';
+import { ParameterIndexLookupCreator } from '../BucketSource.js';
 import { HydrationState } from '../HydrationState.js';
 import { TablePattern } from '../TablePattern.js';
 import { ParameterValueSet, RequestParameters, SqliteJsonValue, SqliteValue, TableRow } from '../types.js';
@@ -31,7 +31,7 @@ export interface BucketParameter {
 export interface SubqueryEvaluator {
   parameterTable: TablePattern;
 
-  lookupSources(): BucketParameterLookupSourceDefinition[];
+  indexLookupCreators(): ParameterIndexLookupCreator[];
   // TODO: Is there a better design here?
   // This is used for parameter _queries_. But the queries need to know which lookup scopes to
   // use, and each querier may use multiple lookup sources, each with their own scope.

packages/sync-rules/src/streams/stream.ts

@@ -2,7 +2,7 @@ import { BaseSqlDataQuery } from '../BaseSqlDataQuery.js';
 import { BucketPriority, DEFAULT_BUCKET_PRIORITY } from '../BucketDescription.js';
 import {
   BucketDataSource,
-  BucketParameterLookupSourceDefinition,
+  ParameterIndexLookupCreator,
   BucketParameterQuerierSourceDefinition,
   BucketSource,
   BucketSourceType
@@ -21,7 +21,7 @@ export class SyncStream implements BucketSource {
   data: BaseSqlDataQuery;
 
   public readonly dataSources: BucketDataSource[];
-  public readonly parameterLookupSources: BucketParameterLookupSourceDefinition[];
+  public readonly parameterIndexLookupCreators: ParameterIndexLookupCreator[];
   public readonly parameterQuerierSources: BucketParameterQuerierSourceDefinition[];
 
   constructor(name: string, data: BaseSqlDataQuery, variants: StreamVariant[]) {
@@ -32,15 +32,15 @@ export class SyncStream implements BucketSource {
     this.data = data;
 
     this.dataSources = [];
-    this.parameterLookupSources = [];
+    this.parameterIndexLookupCreators = [];
     this.parameterQuerierSources = [];
 
     for (let variant of variants) {
       const dataSource = new SyncStreamDataSource(this, data, variant);
       this.dataSources.push(dataSource);
-      const lookupSources = variant.lookupSources();
+      const lookupCreators = variant.indexLookupCreators();
       this.parameterQuerierSources.push(variant.querierSource(this, dataSource));
-      this.parameterLookupSources.push(...lookupSources);
+      this.parameterIndexLookupCreators.push(...lookupCreators);
     }
   }
 

packages/sync-rules/src/streams/variant.ts

@@ -2,7 +2,7 @@ import { BucketInclusionReason, ResolvedBucket } from '../BucketDescription.js';
 import { BucketParameterQuerier, UnscopedParameterLookup, PendingQueriers } from '../BucketParameterQuerier.js';
 import {
   BucketDataSource,
-  BucketParameterLookupSourceDefinition,
+  ParameterIndexLookupCreator,
   BucketParameterQuerierSource,
   BucketParameterQuerierSourceDefinition,
   CreateSourceParams
@@ -69,8 +69,8 @@ export class StreamVariant {
     return `${streamName}|${this.id}`;
   }
 
-  lookupSources(): BucketParameterLookupSourceDefinition[] {
-    return this.subqueries.flatMap((subquery) => subquery.lookupSources());
+  indexLookupCreators(): ParameterIndexLookupCreator[] {
+    return this.subqueries.flatMap((subquery) => subquery.indexLookupCreators());
   }
 
   querierSource(stream: SyncStream, dataSource: SyncStreamDataSource): BucketParameterQuerierSourceDefinition {