Remove ruleId; rename id -> queryId.

Author: rkistner

packages/sync-rules/src/BaseSqlDataQuery.ts

@@ -22,8 +22,6 @@ export interface BaseSqlDataQueryOptions {
   bucketParameters: string[];
   tools: SqlTools;
 
-  ruleId: string;
-
   errors?: SqlRuleError[];
 }
 
@@ -73,8 +71,6 @@ export class BaseSqlDataQuery {
    */
   private readonly tools: SqlTools;
 
-  readonly ruleId: string;
-
   readonly errors: SqlRuleError[];
 
   constructor(options: BaseSqlDataQueryOptions) {
@@ -86,7 +82,6 @@ export class BaseSqlDataQuery {
     this.descriptorName = options.descriptorName;
     this.bucketParameters = options.bucketParameters;
     this.tools = options.tools;
-    this.ruleId = options.ruleId;
     this.errors = options.errors ?? [];
   }
 

packages/sync-rules/src/SqlBucketDescriptor.ts

@@ -31,10 +31,7 @@ export class SqlBucketDescriptor {
   name: string;
   bucketParameters?: string[];
 
-  constructor(
-    name: string,
-    public idSequence: IdSequence
-  ) {
+  constructor(name: string) {
     this.name = name;
   }
 
@@ -51,7 +48,7 @@ export class SqlBucketDescriptor {
     if (this.bucketParameters == null) {
       throw new Error('Bucket parameters must be defined');
     }
-    const dataRows = SqlDataQuery.fromSql(this.name, this.bucketParameters, sql, options, this.idSequence.nextId());
+    const dataRows = SqlDataQuery.fromSql(this.name, this.bucketParameters, sql, options);
 
     this.dataQueries.push(dataRows);
 

packages/sync-rules/src/SqlDataQuery.ts

@@ -18,13 +18,7 @@ export interface SqlDataQueryOptions extends BaseSqlDataQueryOptions {
 }
 
 export class SqlDataQuery extends BaseSqlDataQuery {
-  static fromSql(
-    descriptorName: string,
-    bucketParameters: string[],
-    sql: string,
-    options: SyncRulesOptions,
-    ruleId?: string
-  ) {
+  static fromSql(descriptorName: string, bucketParameters: string[], sql: string, options: SyncRulesOptions) {
     const parsed = parse(sql, { locationTracking: true });
     const schema = options.schema;
 
@@ -172,7 +166,6 @@ export class SqlDataQuery extends BaseSqlDataQuery {
       descriptorName,
       bucketParameters,
       tools,
-      ruleId: ruleId ?? '',
       errors,
       extractors
     });
@@ -218,8 +211,7 @@ export class SqlDataQuery extends BaseSqlDataQuery {
           bucket: bucketId,
           table: outputTable,
           id: id,
-          data,
-          ruleId: this.ruleId
+          data
         } as EvaluationResult;
       });
     } catch (e) {

packages/sync-rules/src/SqlParameterQuery.ts

@@ -37,7 +37,7 @@ export interface SqlParameterQueryOptions {
   inputParameters: InputParameter[];
   expandedInputParameter: InputParameter | undefined;
   bucketParameters: string[];
-  id: string;
+  queryId: string;
   tools: SqlTools;
   errors?: SqlRuleError[];
 }
@@ -178,7 +178,7 @@ export class SqlParameterQuery {
       inputParameters: filter.inputParameters,
       expandedInputParameter: expandedParams[0],
       bucketParameters,
-      id: queryId,
+      queryId,
       tools,
       errors
     });
@@ -263,7 +263,14 @@ export class SqlParameterQuery {
    */
   readonly bucketParameters: string[];
 
-  readonly id: string;
+  /**
+   * Unique identifier for this query within a bucket definition.
+   *
+   * Typically auto-generated based on query order.
+   *
+   * This is used when persisting lookup values.
+   */
+  readonly queryId: string;
   readonly tools: SqlTools;
 
   readonly errors: SqlRuleError[];
@@ -280,7 +287,7 @@ export class SqlParameterQuery {
     this.inputParameters = options.inputParameters;
     this.expandedInputParameter = options.expandedInputParameter;
     this.bucketParameters = options.bucketParameters;
-    this.id = options.id;
+    this.queryId = options.queryId;
     this.tools = options.tools;
     this.errors = options.errors ?? [];
   }
@@ -300,7 +307,7 @@ export class SqlParameterQuery {
       const filterParameters = this.filter.filterRow(tables);
       let result: EvaluatedParametersResult[] = [];
       for (let filterParamSet of filterParameters) {
-        let lookup: SqliteJsonValue[] = [this.descriptorName, this.id];
+        let lookup: SqliteJsonValue[] = [this.descriptorName, this.queryId];
         lookup.push(
           ...this.inputParameters.map((param) => {
             return normalizeParameterValue(param.filteredRowToLookupValue(filterParamSet));
@@ -374,7 +381,7 @@ export class SqlParameterQuery {
    */
   getLookups(parameters: RequestParameters): ParameterLookup[] {
     if (!this.expandedInputParameter) {
-      let lookup: SqliteJsonValue[] = [this.descriptorName, this.id];
+      let lookup: SqliteJsonValue[] = [this.descriptorName, this.queryId];
 
       let valid = true;
       lookup.push(
@@ -412,7 +419,7 @@ export class SqlParameterQuery {
 
       return values
         .map((expandedValue) => {
-          let lookup: SqliteJsonValue[] = [this.descriptorName, this.id];
+          let lookup: SqliteJsonValue[] = [this.descriptorName, this.queryId];
           let valid = true;
           const normalizedExpandedValue = normalizeParameterValue(expandedValue);
           lookup.push(

packages/sync-rules/src/SqlSyncRules.ts

@@ -42,7 +42,6 @@ export interface SyncRulesOptions {
 export class SqlSyncRules implements SyncRules {
   bucketDescriptors: SqlBucketDescriptor[] = [];
   eventDescriptors: SqlEventDescriptor[] = [];
-  idSequence = new IdSequence();
 
   content: string;
 
@@ -137,7 +136,7 @@ export class SqlSyncRules implements SyncRules {
       const parameters = value.get('parameters', true) as unknown;
       const dataQueries = value.get('data', true) as unknown;
 
-      const descriptor = new SqlBucketDescriptor(key, rules.idSequence);
+      const descriptor = new SqlBucketDescriptor(key);
 
       if (parameters instanceof Scalar) {
         rules.withScalar(parameters, (q) => {
@@ -180,7 +179,7 @@ export class SqlSyncRules implements SyncRules {
         continue;
       }
 
-      const eventDescriptor = new SqlEventDescriptor(key.toString(), rules.idSequence);
+      const eventDescriptor = new SqlEventDescriptor(key.toString());
       for (let item of payloads.items) {
         if (!isScalar(item)) {
           rules.errors.push(new YamlError(new Error(`Payload queries for events must be scalar.`)));

packages/sync-rules/src/StaticSqlParameterQuery.ts

@@ -12,7 +12,7 @@ export interface StaticSqlParameterQueryOptions {
   priority: BucketPriority;
   descriptorName: string;
   bucketParameters: string[];
-  id: string;
+  queryId: string;
   filter: ParameterValueClause | undefined;
   errors?: SqlRuleError[];
 }
@@ -84,7 +84,7 @@ export class StaticSqlParameterQuery {
       parameterExtractors,
       priority: priority ?? DEFAULT_BUCKET_PRIORITY,
       filter: isClauseError(filter) ? undefined : filter,
-      id: queryId,
+      queryId,
       errors
     });
     if (query.usesDangerousRequestParameters && !options?.accept_potentially_dangerous_queries) {
@@ -124,7 +124,14 @@ export class StaticSqlParameterQuery {
    */
   readonly bucketParameters: string[];
 
-  readonly id: string;
+  /**
+   * Unique identifier for this query within a bucket definition.
+   *
+   * Typically auto-generated based on query order.
+   *
+   * This is not used directly, but we keep this to match behavior of other parameter queries.
+   */
+  readonly queryId: string;
 
   /**
    * The query filter (WHERE clause). Given request parameters, the filter will determine whether or not this query returns a row.
@@ -141,7 +148,7 @@ export class StaticSqlParameterQuery {
     this.priority = options.priority;
     this.descriptorName = options.descriptorName;
     this.bucketParameters = options.bucketParameters;
-    this.id = options.id;
+    this.queryId = options.queryId;
     this.filter = options.filter;
     this.errors = options.errors ?? [];
   }

packages/sync-rules/src/TableValuedFunctionSqlParameterQuery.ts

@@ -19,9 +19,8 @@ export interface TableValuedFunctionSqlParameterQueryOptions {
   parameterExtractors: Record<string, ParameterValueClause>;
   priority: BucketPriority;
   descriptorName: string;
-  /** _Output_ bucket parameters */
   bucketParameters: string[];
-  id: string;
+  queryId: string;
 
   filter: ParameterValueClause | undefined;
   callClause: ParameterValueClause | undefined;
@@ -107,7 +106,7 @@ export class TableValuedFunctionSqlParameterQuery {
       function: functionImpl,
       callTableName: callTable,
       priority: priority ?? DEFAULT_BUCKET_PRIORITY,
-      id: queryId,
+      queryId,
       errors
     });
 
@@ -148,7 +147,14 @@ export class TableValuedFunctionSqlParameterQuery {
    */
   readonly bucketParameters: string[];
 
-  readonly id: string;
+  /**
+   * Unique identifier for this query within a bucket definition.
+   *
+   * Typically auto-generated based on query order.
+   *
+   * This is not used directly, but we keep this to match behavior of other parameter queries.
+   */
+  readonly queryId: string;
 
   /**
    * The WHERE clause. This is applied on (request parameters + individual function call result row).
@@ -186,7 +192,7 @@ export class TableValuedFunctionSqlParameterQuery {
     this.priority = options.priority;
     this.descriptorName = options.descriptorName;
     this.bucketParameters = options.bucketParameters;
-    this.id = options.id;
+    this.queryId = options.queryId;
 
     this.filter = options.filter;
     this.callClause = options.callClause;

packages/sync-rules/src/events/SqlEventDescriptor.ts

@@ -14,15 +14,12 @@ export class SqlEventDescriptor {
   name: string;
   sourceQueries: SqlEventSourceQuery[] = [];
 
-  constructor(
-    name: string,
-    public idSequence: IdSequence
-  ) {
+  constructor(name: string) {
     this.name = name;
   }
 
   addSourceQuery(sql: string, options: SyncRulesOptions): QueryParseResult {
-    const source = SqlEventSourceQuery.fromSql(this.name, sql, options, this.idSequence.nextId());
+    const source = SqlEventSourceQuery.fromSql(this.name, sql, options);
 
     // Each source query should be for a unique table
     const existingSourceQuery = this.sourceQueries.find((q) => q.table == source.table);

packages/sync-rules/src/events/SqlEventSourceQuery.ts

@@ -13,7 +13,6 @@ import { isSelectStatement } from '../utils.js';
 
 export type EvaluatedEventSourceRow = {
   data: SqliteJsonRow;
-  ruleId?: string;
 };
 
 export type EvaluatedEventRowWithErrors = {
@@ -25,7 +24,7 @@ export type EvaluatedEventRowWithErrors = {
  * Defines how a Replicated Row is mapped to source parameters for events.
  */
 export class SqlEventSourceQuery extends BaseSqlDataQuery {
-  static fromSql(descriptor_name: string, sql: string, options: SyncRulesOptions, ruleId: string) {
+  static fromSql(descriptor_name: string, sql: string, options: SyncRulesOptions) {
     const parsed = parse(sql, { locationTracking: true });
     const schema = options.schema;
 
@@ -125,7 +124,6 @@ export class SqlEventSourceQuery extends BaseSqlDataQuery {
       extractors: extractors,
       tools,
       bucketParameters: [],
-      ruleId: ruleId,
       errors: errors
     });
   }
@@ -141,8 +139,7 @@ export class SqlEventSourceQuery extends BaseSqlDataQuery {
       const data = this.transformRow(tables);
       return {
         result: {
-          data,
-          ruleId: this.ruleId
+          data
         },
         errors: []
       };

packages/sync-rules/src/types.ts

@@ -44,9 +44,6 @@ export interface EvaluatedRow {
 
   /** Must be JSON-serializable. */
   data: SqliteJsonRow;
-
-  /** For debugging purposes only. */
-  ruleId?: string;
 }
 
 export interface EvaluationError {