Merge remote-tracking branch 'origin/main' into node-electron-sample

simolus3 · simolus3 · commit 7dbecbe05194 · 2025-03-24T10:26:40.000+02:00
diff --git a/.changeset/grumpy-panthers-own.md b/.changeset/grumpy-panthers-own.md
diff --git a/.changeset/new-doors-unite.md b/.changeset/new-doors-unite.md
@@ -0,0 +1,5 @@
+---
+'@powersync/web': patch
+---
+
+Ensuring encryption pragma executes before setting cache size, fixes issue where encryption would throw an error during initialization.
diff --git a/.changeset/slimy-glasses-jog.md b/.changeset/slimy-glasses-jog.md
diff --git a/.changeset/tame-boats-hammer.md b/.changeset/tame-boats-hammer.md
diff --git a/.changeset/yellow-countries-warn.md b/.changeset/yellow-countries-warn.md
diff --git a/README.md b/README.md
@@ -74,6 +74,7 @@ Demo applications are located in the [`demos/`](./demos/) directory. Also see ou
 
 - [demos/example-webpack](./demos/example-webpack/README.md): A minimal example demonstrating bundling with Webpack.
 - [demos/example-vite](./demos/example-vite/README.md): A minimal example demonstrating bundling with Vite.
+- [demos/example-vite-encryption](./demos/example-vite-encryption/README.md): A minimal example demonstrating web encryption.
 - [demos/example-nextjs](./demos/example-nextjs/README.md): An example demonstrating setup with Next.js.
 
 ### Electron
diff --git a/demos/example-vite-encryption/README.md b/demos/example-vite-encryption/README.md
@@ -0,0 +1,11 @@
+# PowerSync Web Encryption example
+
+This is a minimal example demonstrating web encryption. It prompts an encryption key, which is used for the database.
+If the database doesn't exist yet, it will apply the encryption key when creating the database for the specified database name.
+If the database does exist, it will use the encryption key to access the database - should the provided key be different to the one provided upon creation it fail to open the database.
+
+To see it in action:
+
+1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
+2. `cd` into this directory, and run `pnpm start`.
+3. Open the localhost URL displayed in the terminal output in your browser.
diff --git a/demos/example-vite-encryption/package.json b/demos/example-vite-encryption/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "example-vite-encryption",
+  "private": true,
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "start": "pnpm build && pnpm preview",
+    "test:build": "pnpm build"
+  },
+  "dependencies": {
+    "@powersync/web": "workspace:*"
+  },
+  "devDependencies": {
+    "@swc/core": "~1.6.0",
+    "vite": "^5.0.12",
+    "vite-plugin-top-level-await": "^1.4.1",
+    "vite-plugin-wasm": "^3.3.0"
+  }
+}
diff --git a/demos/example-vite-encryption/src/index.html b/demos/example-vite-encryption/src/index.html
@@ -0,0 +1,9 @@
+<!doctype html>
+<html>
+  <head>
+    <script type="module" src="./index.js"></script>
+  </head>
+  <body>
+    Vite bundling test: Check the console to see it in action!
+  </body>
+</html>
diff --git a/demos/example-vite-encryption/src/index.js b/demos/example-vite-encryption/src/index.js
@@ -0,0 +1,37 @@
+import { column, Schema, Table, PowerSyncDatabase } from '@powersync/web';
+import Logger from 'js-logger';
+
+Logger.useDefaults();
+
+const customers = new Table({ name: column.text });
+
+export const AppSchema = new Schema({ customers });
+
+let PowerSync;
+
+const openDatabase = async (encryptionKey) => {
+  PowerSync = new PowerSyncDatabase({
+    schema: AppSchema,
+    database: { dbFilename: 'example-encryption.db' },
+    encryptionKey: encryptionKey
+  });
+
+  await PowerSync.init();
+
+  // Run local statements.
+  await PowerSync.execute('INSERT INTO customers(id, name) VALUES(uuid(), ?)', ['Fred']);
+
+  const result = await PowerSync.getAll('SELECT * FROM customers');
+  console.log('contents of customers: ', result);
+  console.table(result);
+};
+
+document.addEventListener('DOMContentLoaded', async (event) => {
+  let encryptionKey = '';
+
+  while (!encryptionKey) {
+    encryptionKey = prompt('Enter encryption key (non-empty string):');
+  }
+
+  openDatabase(encryptionKey);
+});
diff --git a/demos/example-vite-encryption/vite.config.ts b/demos/example-vite-encryption/vite.config.ts
@@ -0,0 +1,27 @@
+import wasm from 'vite-plugin-wasm';
+import topLevelAwait from 'vite-plugin-top-level-await';
+import { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  root: 'src',
+  build: {
+    outDir: '../dist',
+    rollupOptions: {
+      input: 'src/index.html'
+    },
+    emptyOutDir: true
+  },
+  envDir: '..', // Use this dir for env vars, not 'src'.
+  optimizeDeps: {
+    // Don't optimize these packages as they contain web workers and WASM files.
+    // https://github.com/vitejs/vite/issues/11672#issuecomment-1415820673
+    exclude: ['@journeyapps/wa-sqlite', '@powersync/web'],
+    include: ['@powersync/web > js-logger'] 
+  },
+  plugins: [wasm(), topLevelAwait()],
+  worker: {
+    format: 'es',
+    plugins: () => [wasm(), topLevelAwait()]
+  }
+});
diff --git a/packages/attachments/CHANGELOG.md b/packages/attachments/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @powersync/attachments
 
+## 2.3.0
+
+### Minor Changes
+
+- 420a083: Added `attachmentTableName` option to attachment queue which allows you to specify the table name it should work with.
+
 ## 2.2.1
 
 ### Patch Changes
diff --git a/packages/attachments/package.json b/packages/attachments/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@powersync/attachments",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
diff --git a/packages/attachments/src/AbstractAttachmentQueue.ts b/packages/attachments/src/AbstractAttachmentQueue.ts
@@ -14,9 +14,14 @@ export interface AttachmentQueueOptions {
    */
   cacheLimit?: number;
   /**
-   * The name of the directory where attachments are stored on the device, not the full path
+   * The name of the directory where attachments are stored on the device, not the full path. Defaults to `attachments`.
    */
   attachmentDirectoryName?: string;
+
+  /**
+   * The name of the table where attachments are stored, defaults to `attachments` table.
+   */
+  attachmentTableName?: string;
   /**
    * Whether to mark the initial watched attachment IDs to be synced
    */
@@ -36,7 +41,8 @@ export interface AttachmentQueueOptions {
 }
 
 export const DEFAULT_ATTACHMENT_QUEUE_OPTIONS: Partial<AttachmentQueueOptions> = {
-  attachmentDirectoryName: 'attachments',
+  attachmentDirectoryName: ATTACHMENT_TABLE,
+  attachmentTableName: ATTACHMENT_TABLE,
   syncInterval: 30_000,
   cacheLimit: 100,
   performInitialSync: true,
@@ -90,7 +96,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
   }
 
   get table() {
-    return ATTACHMENT_TABLE;
+    return this.options.attachmentTableName!;
   }
 
   async init() {
diff --git a/packages/node/CHANGELOG.md b/packages/node/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @powersync/node
 
+## 0.1.1
+
+### Patch Changes
+
+- 0c8ddda: Update package description
+- 2551b40: Update readme to reflect alpha status.
+- 7c118b6: Update readme to refer to Node.js docs
+
 ## 0.1.0
 
 ### Minor Changes
diff --git a/packages/node/package.json b/packages/node/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@powersync/node",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
diff --git a/packages/node/src/db/options.ts b/packages/node/src/db/options.ts
@@ -1,7 +1,7 @@
 import { type Worker } from 'node:worker_threads';
 import { SQLOpenOptions } from '@powersync/common';
 
-export type OpenWorker = (...args: ConstructorParameters<typeof Worker>) => InstanceType<typeof Worker>;
+export type WorkerOpener = (...args: ConstructorParameters<typeof Worker>) => InstanceType<typeof Worker>;
 
 /**
  * The {@link SQLOpenOptions} available across all PowerSync SDKs for JavaScript extended with
@@ -20,5 +20,5 @@ export interface NodeSQLOpenOptions extends SQLOpenOptions {
    * @param args The arguments that would otherwise be passed to the {@link Worker} constructor.
    * @returns the resolved worker.
    */
-  openWorker?: OpenWorker;
+  openWorker?: WorkerOpener;
 }
diff --git a/packages/node/tests/PowerSyncDatabase.test.ts b/packages/node/tests/PowerSyncDatabase.test.ts
@@ -4,6 +4,7 @@ import fs from 'node:fs/promises';
 import { vi, expect, test, onTestFinished } from 'vitest';
 import { AppSchema, createTempDir, databaseTest } from './utils';
 import { PowerSyncDatabase } from '../lib';
+import { WorkerOpener } from '../lib/db/options';
 
 test('validates options', async () => {
   await expect(async () => {
@@ -20,14 +21,16 @@ test('validates options', async () => {
 
 test('can customize loading workers', async () => {
   const directory = await createTempDir();
-  const openFunction = vi.fn((...args: ConstructorParameters<typeof Worker>) => new Worker(...args));
+  const defaultWorker: WorkerOpener = (...args) => new Worker(...args);
+
+  const openFunction = vi.fn(defaultWorker); // Wrap in vi.fn to count invocations
 
   const database = new PowerSyncDatabase({
     schema: AppSchema,
     database: {
       dbFilename: 'test.db',
       dbLocation: directory,
-      openWorker: openFunction as any,
+      openWorker: openFunction,
       readWorkerCount: 2
     }
   });
diff --git a/packages/react-native/CHANGELOG.md b/packages/react-native/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @powersync/react-native
 
+## 1.18.2
+
+### Patch Changes
+
+- 0c8ddda: Update package description
+- fcb9d58: Fixed an issue with `useQuery` where initial query/parameter changes could cause a race condition if the first query took long.
+- Updated dependencies [fcb9d58]
+  - @powersync/react@1.5.2
+
 ## 1.18.1
 
 ### Patch Changes
diff --git a/packages/react-native/package.json b/packages/react-native/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@powersync/react-native",
-  "version": "1.18.1",
+  "version": "1.18.2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @powersync/react
 
+## 1.5.2
+
+### Patch Changes
+
+- fcb9d58: Fixed an issue with `useQuery` where initial query/parameter changes could cause a race condition if the first query took long.
+
 ## 1.5.1
 
 ### Patch Changes
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@powersync/react",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
diff --git a/packages/tanstack-react-query/CHANGELOG.md b/packages/tanstack-react-query/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @powersync/tanstack-react-query
 
+## 0.0.16
+
+### Patch Changes
+
+- Updated dependencies [fcb9d58]
+  - @powersync/react@1.5.2
+
 ## 0.0.15
 
 ### Patch Changes
diff --git a/packages/tanstack-react-query/package.json b/packages/tanstack-react-query/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@powersync/tanstack-react-query",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
diff --git a/packages/web/CHANGELOG.md b/packages/web/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @powersync/web
 
+## 1.15.1
+
+### Patch Changes
+
+- 0c8ddda: Update package description
+
 ## 1.15.0
 
 ### Minor Changes
diff --git a/packages/web/package.json b/packages/web/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@powersync/web",
-  "version": "1.15.0",
+  "version": "1.15.1",
   "description": "PowerSync web SDK. Sync Postgres, MongoDB or MySQL with SQLite in your web app",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",
diff --git a/packages/web/src/db/adapters/wa-sqlite/WASQLiteConnection.ts b/packages/web/src/db/adapters/wa-sqlite/WASQLiteConnection.ts
@@ -235,8 +235,8 @@ export class WASqliteConnection
     await this.openDB();
     this.registerBroadcastListeners();
     await this.executeSingleStatement(`PRAGMA temp_store = ${this.options.temporaryStorage};`);
-    await this.executeSingleStatement(`PRAGMA cache_size = -${this.options.cacheSizeKb};`);
     await this.executeEncryptionPragma();
+    await this.executeSingleStatement(`PRAGMA cache_size = -${this.options.cacheSizeKb};`);
 
     this.sqliteAPI.update_hook(this.dbP, (updateType: number, dbName: string | null, tableName: string | null) => {
       if (!tableName) {
diff --git a/packages/web/tests/encryption.test.ts b/packages/web/tests/encryption.test.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tools/diagnostics-app/CHANGELOG.md b/tools/diagnostics-app/CHANGELOG.md
diff --git a/tools/diagnostics-app/package.json b/tools/diagnostics-app/package.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@powersync/web': patch
 +---
++
 +Ensuring encryption pragma executes before setting cache size, fixes issue where encryption would throw an error during initialization.