Rename trackOld

Author: simolus3

.changeset/giant-ladybugs-dress.md

@@ -2,7 +2,7 @@
 '@powersync/common': minor
 ---
 
-- Add `trackOld` option on `Table` which sets `CrudEntry.oldData` to previous values on updates.
+- Add `trackPreviousValues` option on `Table` which sets `CrudEntry.previousValues` to previous values on updates.
 - Add `trackMetadata` option on `Table` which adds a `_metadata` column that can be used for updates.
   The configured metadata is available through `CrudEntry.metadata`.
 - Add `ignoreEmptyUpdates` option which skips creating CRUD entries for updates that don't change any values.

packages/common/src/client/sync/bucket/CrudEntry.ts

@@ -66,10 +66,10 @@ export class CrudEntry {
   opData?: Record<string, any>;
 
   /**
-   * For tables where the `trackOld` option has been enabled, this tracks previous values for
+   * For tables where the `trackPreviousValues` option has been enabled, this tracks previous values for
    * `UPDATE` and `DELETE` statements.
    */
-  oldData?: Record<string, any>;
+  previousValues?: Record<string, any>;
 
   /**
    * Table that contained the change.
@@ -109,7 +109,7 @@ export class CrudEntry {
     id: string,
     transactionId?: number,
     opData?: Record<string, any>,
-    oldData?: Record<string, any>,
+    previousValues?: Record<string, any>,
     metadata?: string
   ) {
     this.clientId = clientId;
@@ -118,7 +118,7 @@ export class CrudEntry {
     this.opData = opData;
     this.table = table;
     this.transactionId = transactionId;
-    this.oldData = oldData;
+    this.previousValues = previousValues;
     this.metadata = metadata;
   }
 

packages/common/src/db/schema/Table.ts

@@ -14,17 +14,17 @@ interface SharedTableOptions {
   localOnly?: boolean;
   insertOnly?: boolean;
   viewName?: string;
-  trackOld?: boolean | TrackOldOptions;
+  trackPrevious?: boolean | TrackPreviousOptions;
   trackMetadata?: boolean;
   ignoreEmptyUpdates?: boolean;
 }
 
-/** Whether to include old columns when PowerSync tracks local changes.
+/** Whether to include previous column values when PowerSync tracks local changes.
  *
- * Including old columns may be helpful for some backend connector implementations, which is
+ * Including old values may be helpful for some backend connector implementations, which is
  * why it can be enabled on per-table or per-columm basis.
  */
-export interface TrackOldOptions {
+export interface TrackPreviousOptions {
   /** When defined, a list of column names for which old values should be tracked. */
   columns?: string[];
   /** When enabled, only include values that have actually been changed by an update. */
@@ -56,7 +56,7 @@ export const DEFAULT_TABLE_OPTIONS = {
   indexes: [],
   insertOnly: false,
   localOnly: false,
-  trackOld: false,
+  trackPrevious: false,
   trackMetadata: false,
   ignoreEmptyUpdates: false
 };
@@ -200,7 +200,7 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
       viewName: options?.viewName,
       insertOnly: options?.insertOnly,
       localOnly: options?.localOnly,
-      trackOld: options?.trackOld,
+      trackPrevious: options?.trackPrevious,
       trackMetadata: options?.trackMetadata,
       ignoreEmptyUpdates: options?.ignoreEmptyUpdates
     };
@@ -212,7 +212,7 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
   private applyDefaultOptions() {
     this.options.insertOnly ??= DEFAULT_TABLE_OPTIONS.insertOnly;
     this.options.localOnly ??= DEFAULT_TABLE_OPTIONS.localOnly;
-    this.options.trackOld ??= DEFAULT_TABLE_OPTIONS.trackOld;
+    this.options.trackPrevious ??= DEFAULT_TABLE_OPTIONS.trackPrevious;
     this.options.trackMetadata ??= DEFAULT_TABLE_OPTIONS.trackMetadata;
     this.options.ignoreEmptyUpdates ??= DEFAULT_TABLE_OPTIONS.ignoreEmptyUpdates;
   }
@@ -255,8 +255,8 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
     return this.options.insertOnly!;
   }
 
-  get trackOld() {
-    return this.options.trackOld!;
+  get trackPrevious() {
+    return this.options.trackPrevious!;
   }
 
   get trackMetadata() {
@@ -301,7 +301,7 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
     if (this.trackMetadata && this.localOnly) {
       throw new Error(`Can't include metadata for local-only tables.`);
     }
-    if (this.trackOld != false && this.localOnly) {
+    if (this.trackPrevious != false && this.localOnly) {
       throw new Error(`Can't include old values for local-only tables.`);
     }
 
@@ -341,15 +341,15 @@ export class Table<Columns extends ColumnsType = ColumnsType> {
   }
 
   toJSON() {
-    const trackOld = this.trackOld;
+    const trackPrevious = this.trackPrevious;
 
     return {
       name: this.name,
       view_name: this.viewName,
       local_only: this.localOnly,
       insert_only: this.insertOnly,
-      include_old: trackOld && ((trackOld as any).columns ?? true),
-      include_old_only_when_changed: typeof trackOld == 'object' && trackOld.onlyWhenChanged == true,
+      include_old: trackPrevious && ((trackPrevious as any).columns ?? true),
+      include_old_only_when_changed: typeof trackPrevious == 'object' && trackPrevious.onlyWhenChanged == true,
       include_metadata: this.trackMetadata,
       ignore_empty_update: this.ignoreEmptyUpdates,
       columns: this.columns.map((c) => c.toJSON()),

packages/common/tests/db/schema/Table.test.ts

@@ -138,10 +138,10 @@ describe('Table', () => {
     expect(createTable({}).toJSON().include_metadata).toBe(false);
     expect(createTable({ trackMetadata: true }).toJSON().include_metadata).toBe(true);
 
-    expect(createTable({ trackOld: true }).toJSON().include_old).toBe(true);
-    expect(createTable({ trackOld: true }).toJSON().include_old_only_when_changed).toBe(false);
+    expect(createTable({ trackPrevious: true }).toJSON().include_old).toBe(true);
+    expect(createTable({ trackPrevious: true }).toJSON().include_old_only_when_changed).toBe(false);
 
-    const complexIncldueOld = createTable({ trackOld: {
+    const complexIncldueOld = createTable({ trackPrevious: {
       columns: ['foo', 'bar'],
       onlyWhenChanged: true,
     } });
@@ -216,7 +216,7 @@ describe('Table', () => {
           {
             name: column.text
           },
-          { localOnly: true, trackOld: true }
+          { localOnly: true, trackPrevious: true }
         ).validate()
       ).toThrowError("Can't include old values for local-only tables.");
 
@@ -225,7 +225,7 @@ describe('Table', () => {
           {
             name: column.text
           },
-          { localOnly: true, trackOld: { onlyWhenChanged: false } }
+          { localOnly: true, trackPrevious: { onlyWhenChanged: false } }
         ).validate()
       ).toThrowError("Can't include old values for local-only tables.");
     });

packages/node/tests/crud.test.ts

@@ -26,7 +26,7 @@ databaseTest('include old values', async ({ database }) => {
       {
         name: column.text
       },
-      { trackOld: true }
+      { trackPrevious: true }
     )
   });
   await database.updateSchema(schema);
@@ -35,7 +35,7 @@ databaseTest('include old values', async ({ database }) => {
   await database.execute('UPDATE lists SET name = ?', ['new name']);
 
   const batch = await database.getNextCrudTransaction();
-  expect(batch?.crud[0].oldData).toStrictEqual({name: 'entry'});
+  expect(batch?.crud[0].previousValues).toStrictEqual({name: 'entry'});
 });
 
 databaseTest('include old values with column filter', async ({ database }) => {
@@ -46,7 +46,7 @@ databaseTest('include old values with column filter', async ({ database }) => {
         name: column.text,
         content: column.text
       },
-      { trackOld: { columns: ['name'] } }
+      { trackPrevious: { columns: ['name'] } }
     )
   });
   await database.updateSchema(schema);
@@ -55,7 +55,7 @@ databaseTest('include old values with column filter', async ({ database }) => {
   await database.execute('UPDATE lists SET name = ?, content = ?', ['new name', 'new content']);
 
   const batch = await database.getNextCrudTransaction();
-  expect(batch?.crud[0].oldData).toStrictEqual({name: 'name'});
+  expect(batch?.crud[0].previousValues).toStrictEqual({name: 'name'});
 });
 
 databaseTest('include old values when changed', async ({ database }) => {
@@ -66,7 +66,7 @@ databaseTest('include old values when changed', async ({ database }) => {
         name: column.text,
         content: column.text
       },
-      { trackOld: { onlyWhenChanged: true } }
+      { trackPrevious: { onlyWhenChanged: true } }
     )
   });
   await database.updateSchema(schema);
@@ -75,7 +75,7 @@ databaseTest('include old values when changed', async ({ database }) => {
   await database.execute('UPDATE lists SET name = ?', ['new name']);
 
   const batch = await database.getNextCrudTransaction();
-  expect(batch?.crud[0].oldData).toStrictEqual({name: 'name'});
+  expect(batch?.crud[0].previousValues).toStrictEqual({name: 'name'});
 });
 
 databaseTest('ignore empty update', async ({ database }) => {