Added switch to online tests.

Author: Chriztiaan

packages/web/tests/offline.test.ts

@@ -0,0 +1,174 @@
+import { AbstractPowerSyncDatabase, column, Column, ColumnType, Schema, Table } from '@powersync/common';
+import { PowerSyncDatabase } from '@powersync/web';
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+
+const assetId = '2290de4f-0488-4e50-abed-f8e8eb1d0b42';
+const userId = '3390de4f-0488-4e50-abed-f8e8eb1d0b42';
+const customerId = '4490de4f-0488-4e50-abed-f8e8eb1d0b42';
+
+const assetsDef = {
+  name: 'assets',
+  columns: {
+    created_at: column.text,
+    make: column.text,
+    model: column.text,
+    serial_number: column.text,
+    quantity: column.integer,
+    user_id: column.text,
+    customer_id: column.text,
+    description: column.text
+  },
+  options: { indexes: { makemodel: ['make, model'] } }
+};
+
+const customersDef = {
+  name: 'customers',
+  columns: {
+    name: column.text,
+    email: column.text
+  },
+  options: {}
+};
+
+function makeSchema(synced: boolean) {
+  const syncedName = (table: string): string => {
+    if (synced) {
+      return table;
+    } else {
+      return `inactive_synced_${table}`;
+    }
+  };
+
+  const localName = (table: string): string => {
+    if (synced) {
+      return `inactive_local_${table}`;
+    } else {
+      return table;
+    }
+  };
+  return new Schema({
+    assets: new Table(assetsDef.columns, { ...assetsDef.options, viewName: syncedName(assetsDef.name) }),
+    local_assets: new Table(assetsDef.columns, {
+      ...assetsDef.options,
+      localOnly: true,
+      viewName: localName(assetsDef.name)
+    }),
+    customers: new Table(customersDef.columns, { ...customersDef.options, viewName: syncedName(customersDef.name) }),
+    local_customers: new Table(customersDef.columns, {
+      ...customersDef.options,
+      localOnly: true,
+      viewName: localName(customersDef.name)
+    })
+  });
+}
+
+describe('Schema Tests', () => {
+  let db: AbstractPowerSyncDatabase;
+
+  beforeEach(async () => {
+    db = new PowerSyncDatabase({
+      /**
+       * Deleting the IndexDB seems to freeze the test.
+       * Use a new DB for each run to keep CRUD counters
+       * consistent
+       */
+      database: { dbFilename: 'test.db' },
+      schema: makeSchema(false),
+      flags: {
+        enableMultiTabs: false
+      }
+    });
+  });
+
+  afterEach(async () => {
+    await db.disconnectAndClear();
+    await db.close();
+  });
+
+  it('Switch from offline-only to online schema', async () => {
+    await db.execute('INSERT INTO customers(id, name, email) VALUES(?, ?, ?)', [
+      customerId,
+      'test customer',
+      '[email protected]'
+    ]);
+
+    await db.execute('INSERT INTO assets(id, description, customer_id) VALUES(?, ?, ?)', [assetId, 'test', customerId]);
+    await db.execute('UPDATE assets SET description = description || ?', ['.']);
+
+    expect(await db.getAll('SELECT data FROM ps_crud ORDER BY id')).toEqual([]);
+
+    // Now switch to the "online" schema
+    await db.updateSchema(makeSchema(true));
+
+    // Note that updateSchema cannot be called inside a transaction, and there
+    // is a possibility of crash between updating the schema, and when the data
+    // has been moved. It may be best to attempt the data move on every application
+    // start where the online schema is used, if there is any local_ data still present.
+
+    await db.writeTransaction(async (tx) => {
+      // Copy local data to the "online" views.
+      // This records each operation to the crud queue.
+      await tx.execute('INSERT INTO customers SELECT * FROM inactive_local_customers');
+      await tx.execute(
+        'INSERT INTO assets(id, description, customer_id, user_id) SELECT id, description, customer_id, ? FROM inactive_local_assets',
+        [userId]
+      );
+
+      // Delete the "offline-only" data.
+      await tx.execute('DELETE FROM inactive_local_customers');
+      await tx.execute('DELETE FROM inactive_local_assets');
+    });
+
+    const crud = (await db.getAll<{ data: string }>('SELECT data FROM ps_crud ORDER BY id')).map((d) =>
+      JSON.parse(d.data)
+    );
+
+    expect(crud).toEqual([
+      {
+        op: 'PUT',
+        type: 'customers',
+        id: customerId,
+        data: { email: '[email protected]', name: 'test customer' }
+      },
+      {
+        op: 'PUT',
+        type: 'assets',
+        id: assetId,
+        data: {
+          user_id: userId,
+          customer_id: customerId,
+          description: 'test.'
+        }
+      }
+    ]);
+  });
+
+  // Indicates that we don't need to refresh the refresh the schema explicitly
+  it('Correct source table after switching schema', async () => {
+    const customerWatchTables = await getSourceTables(db, 'SELECT * FROM customers');
+    expect(customerWatchTables.includes('ps_data_local__local_customers')).toBeTruthy();
+
+    await db.updateSchema(makeSchema(true));
+
+    const onlineCustomerWatchTables = await getSourceTables(db, 'SELECT * FROM customers');
+    expect(onlineCustomerWatchTables.includes('ps_data__customers')).toBeTruthy();
+  });
+});
+
+export async function getSourceTables(db: AbstractPowerSyncDatabase, sql: string, parameters: Array<any> = []) {
+  const rows = await db.getAll<{ opcode: string; p3: number; p2: string }>(`EXPLAIN ${sql}`, parameters);
+  const rootpages: number[] = [];
+
+  for (const row of rows) {
+    if (row.opcode === 'OpenRead' && row.p3 === 0 && typeof row.p2 === 'number') {
+      rootpages.push(row.p2);
+    }
+  }
+
+  const tableRows = await db.getAll<{ tbl_name: string }>(
+    `SELECT tbl_name FROM sqlite_master WHERE rootpage IN (SELECT json_each.value FROM json_each(?))`,
+    [JSON.stringify(rootpages)]
+  );
+
+  return tableRows.map((row: { tbl_name: string }) => row.tbl_name);
+}