use schema for internal names

Author: stevensJourney

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -252,7 +252,8 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     this._isReadyPromise = this.initialize();
 
     this.triggerManager = new TriggerManagerImpl({
-      db: this
+      db: this,
+      schema: this.schema
     });
   }
 

packages/common/src/client/triggers/TriggerManager.ts

@@ -18,12 +18,13 @@ export interface BaseTriggerDiffRecord {
 
 export interface TriggerDiffUpdateRecord extends BaseTriggerDiffRecord {
   operation: DiffTriggerOperation.UPDATE;
-  change: string;
+  value: string;
+  previous_value?: string;
 }
 
 export interface TriggerDiffInsertRecord extends BaseTriggerDiffRecord {
   operation: DiffTriggerOperation.INSERT;
-  change: string;
+  value: string;
 }
 
 export interface TriggerDiffDeleteRecord extends BaseTriggerDiffRecord {
@@ -41,7 +42,8 @@ export interface TriggerCreationHooks {
 
 export interface CreateDiffTriggerOptions {
   /**
-   * Source table to trigger and track changes from.
+   * Source table/view to trigger and track changes from.
+   * This should be present in the PowerSync database's schema.
    */
   source: string;
 
@@ -102,7 +104,8 @@ export interface TriggerDiffHandlerContext {
 
 export interface TrackDiffOptions {
   /**
-   * A source SQLite table to track changes for.
+   * A source SQLite table/view to track changes for.
+   * This should be present in the PowerSync database's schema.
    */
   source: string;
   /**
@@ -138,13 +141,15 @@ export interface TriggerManager {
    * CREATE TEMP TABLE ${destination} (
    *       id TEXT,
    *       operation TEXT,
-   *       change TEXT,
    *       timestamp TEXT
+   *       value TEXT,
+   *       previous_value TEXT
    *     );
    * ```
-   * The `change` column contains the JSON representation of the change. This column is NULL for
+   * The `value` column contains the JSON representation of the change. This column is NULL for
    * {@link DiffTriggerOperation#DELETE} operations.
-   * For {@link DiffTriggerOperation#UPDATE} operations the `change` column is a JSON object containing both the `new` and `old` values.
+   * For {@link DiffTriggerOperation#UPDATE} operations the `previous_value` column contains the previous value of the changed row
+   * in a JSON format.
    *
    * @returns A callback to remove the trigger and drop the destination table.
    */

packages/common/src/client/triggers/TriggerManagerImpl.ts

@@ -1,4 +1,5 @@
 import { LockContext } from '../../db/DBAdapter.js';
+import { Schema } from '../../db/schema/Schema.js';
 import { type AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase.js';
 import {
   CreateDiffTriggerOptions,
@@ -10,10 +11,20 @@ import {
 
 export type TriggerManagerImplOptions = {
   db: AbstractPowerSyncDatabase;
+  schema: Schema;
 };
 
 export class TriggerManagerImpl implements TriggerManager {
-  constructor(protected options: TriggerManagerImplOptions) {}
+  protected schema: Schema;
+
+  constructor(protected options: TriggerManagerImplOptions) {
+    this.schema = options.schema;
+    options.db.registerListener({
+      schemaChanged: (schema) => {
+        this.schema = schema;
+      }
+    });
+  }
 
   protected get db() {
     return this.options.db;
@@ -47,6 +58,17 @@ export class TriggerManagerImpl implements TriggerManager {
       throw new Error('At least one column must be specified for the trigger.');
     }
 
+    /**
+     * Allow specifying the View name as the source.
+     * We can lookup the internal table name from the schema.
+     */
+    const sourceDefinition = this.schema.tables.find((table) => table.viewName == source);
+    if (!sourceDefinition) {
+      throw new Error(`Source table or view "${source}" not found in the schema.`);
+    }
+
+    const internalSource = sourceDefinition.internalName;
+
     /**
      * When is a tuple of the query and the parameters.
      */
@@ -79,8 +101,9 @@ export class TriggerManagerImpl implements TriggerManager {
         CREATE TEMP TABLE ${destination} (
           id TEXT,
           operation TEXT,
-          change TEXT,
-          timestamp TEXT
+          timestamp TEXT,
+          value TEXT,
+          previous_value TEXT
         );
       `);
 
@@ -89,15 +112,15 @@ export class TriggerManagerImpl implements TriggerManager {
         triggerIds.push(insertTriggerId);
 
         await tx.execute(/* sql */ `
-          CREATE TEMP TRIGGER ${insertTriggerId} AFTER INSERT ON ${source} ${whenCondition} BEGIN
+          CREATE TEMP TRIGGER ${insertTriggerId} AFTER INSERT ON ${internalSource} ${whenCondition} BEGIN
           INSERT INTO
-            ${destination} (id, operation, change, timestamp)
+            ${destination} (id, operation, timestamp, value)
           VALUES
             (
               NEW.id,
               'INSERT',
-              ${jsonFragment('NEW')},
-              strftime ('%Y-%m-%dT%H:%M:%fZ', 'now')
+              strftime ('%Y-%m-%dT%H:%M:%fZ', 'now'),
+              ${jsonFragment('NEW')}
             );
 
           END;
@@ -110,21 +133,16 @@ export class TriggerManagerImpl implements TriggerManager {
 
         await tx.execute(/* sql */ `
           CREATE TEMP TRIGGER ${updateTriggerId} AFTER
-          UPDATE ON ${source} ${whenCondition} BEGIN
+          UPDATE ON ${internalSource} ${whenCondition} BEGIN
           INSERT INTO
-            ${destination} (id, operation, change, timestamp)
+            ${destination} (id, operation, timestamp, value, previous_value)
           VALUES
             (
               NEW.id,
               'UPDATE',
-              --- Reports both the new and old values in JSON format
-              json_object (
-                'new',
-                ${jsonFragment('NEW')},
-                'old',
-                ${jsonFragment('OLD')}
-              ),
-              strftime ('%Y-%m-%dT%H:%M:%fZ', 'now')
+              strftime ('%Y-%m-%dT%H:%M:%fZ', 'now'),
+              ${jsonFragment('NEW')},
+              ${jsonFragment('OLD')}
             );
 
           END;
@@ -137,7 +155,7 @@ export class TriggerManagerImpl implements TriggerManager {
 
         // Create delete trigger for basic JSON
         await tx.execute(/* sql */ `
-          CREATE TEMP TRIGGER ${deleteTriggerId} AFTER DELETE ON ${source} ${whenCondition} BEGIN
+          CREATE TEMP TRIGGER ${deleteTriggerId} AFTER DELETE ON ${internalSource} ${whenCondition} BEGIN
           INSERT INTO
             ${destination} (id, operation, timestamp)
           VALUES

packages/node/tests/trigger.test.ts

@@ -12,7 +12,7 @@ describe('Triggers', () => {
     const tempTable = 'temp_remote_lists';
 
     await database.triggers.createDiffTrigger({
-      source: 'ps_data__lists',
+      source: 'lists',
       destination: tempTable,
       columns: ['name'],
       operations: [DiffTriggerOperation.INSERT, DiffTriggerOperation.UPDATE]
@@ -88,8 +88,7 @@ describe('Triggers', () => {
      * Watch the todos table for changes. Only track the diff for rows belonging to the first list.
      */
     await database.triggers.trackTableDiff({
-      // TODO investigate it this can be improved
-      source: 'ps_data__todos',
+      source: 'todos',
       columns: ['list_id'],
       // TODO, should/could we expose columns without json. Maybe with a temp view
       filter: `json_extract(NEW.data, '$.list_id') = '${firstList.id}'`,
@@ -174,17 +173,6 @@ describe('Triggers', () => {
 
     const todos: Database['todos'][] = [];
 
-    // const createTodo = async () =>
-    //   database.execute(
-    //     /* sql */ `
-    //       INSERT INTO
-    //         todos (id, content, list_id)
-    //       VALUES
-    //         (uuid (), 'todo', ?)
-    //     `,
-    //     [firstList.id]
-    //   );
-
     const createTodo = async () => {
       // Create todos for both lists
       await database.writeLock(async (tx) => {
@@ -204,8 +192,7 @@ describe('Triggers', () => {
       // Configure the trigger to watch for changes.
       // The onChange handler is guaranteed to see any change after the state above.
       database.triggers.trackTableDiff({
-        // TODO investigate it this can be improved
-        source: 'ps_data__todos',
+        source: 'todos',
         columns: ['list_id'],
         // TODO, should/could we expose columns without json. Maybe with a temp view
         filter: `json_extract(NEW.data, '$.list_id') = '${firstList.id}'`,