@powersync/web 1.38.7 → 2.0.0

package/src/db/sync/SharedWebStreamingSyncImplementation.ts

@@ -1,21 +1,16 @@
-import {
-  PowerSyncConnectionOptions,
-  PowerSyncCredentials,
-  SubscribedStream,
-  SyncStatusOptions
-} from '@powersync/common';
+import { LogRecord, PowerSyncCredentials } from '@powersync/common';
 import * as Comlink from 'comlink';
-import { getNavigatorLocks } from '../../shared/navigator.js';
 import { AbstractSharedSyncClientProvider } from '../../worker/sync/AbstractSharedSyncClientProvider.js';
 import { ManualSharedSyncPayload, SharedSyncClientEvent } from '../../worker/sync/SharedSyncImplementation.js';
 import { WorkerClient } from '../../worker/sync/WorkerClient.js';
 import { WebDBAdapter } from '../adapters/WebDBAdapter.js';
-import { DEFAULT_CACHE_SIZE_KB, TemporaryStorageOption, resolveWebSQLFlags } from '../adapters/web-sql-flags.js';
 import {
   WebStreamingSyncImplementation,
   WebStreamingSyncImplementationOptions
 } from './WebStreamingSyncImplementation.js';
 import { generateTabCloseSignal } from '../../shared/tab_close_signal.js';
+import { SubscribedStream, SyncStatusJson, ResolvedSyncOptions } from '@powersync/shared-internals';
+import { connectToExistingWorker, connectToWorker, WorkerConnection } from '../../worker/client.js';
 
 /**
  * The shared worker will trigger methods on this side of the message port
@@ -24,7 +19,7 @@ import { generateTabCloseSignal } from '../../shared/tab_close_signal.js';
 class SharedSyncClientProvider extends AbstractSharedSyncClientProvider {
   constructor(
     protected options: WebStreamingSyncImplementationOptions,
-    public statusChanged: (status: SyncStatusOptions) => void,
+    public statusChanged: (status: SyncStatusJson) => void,
     protected webDB: WebDBAdapter
   ) {
     super();
@@ -68,34 +63,15 @@ class SharedSyncClientProvider extends AbstractSharedSyncClientProvider {
     return this.options.logger;
   }
 
-  trace(...x: any[]): void {
-    this.logger?.trace(...x);
-  }
-  debug(...x: any[]): void {
-    this.logger?.debug(...x);
-  }
-  info(...x: any[]): void {
-    this.logger?.info(...x);
-  }
-  log(...x: any[]): void {
-    this.logger?.log(...x);
-  }
-  warn(...x: any[]): void {
-    this.logger?.warn(...x);
-  }
-  error(...x: any[]): void {
-    this.logger?.error(...x);
-  }
-  time(label: string): void {
-    this.logger?.time(label);
-  }
-  timeEnd(label: string): void {
-    this.logger?.timeEnd(label);
+  log(record: LogRecord): void {
+    this.logger.log(record);
   }
 }
 
 export interface SharedWebStreamingSyncImplementationOptions extends WebStreamingSyncImplementationOptions {
+  logLevel: number;
   db: WebDBAdapter;
+  enableBroadcastLogs: boolean;
 }
 
 /**
@@ -104,46 +80,30 @@ export interface SharedWebStreamingSyncImplementationOptions extends WebStreamin
 export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplementation {
   protected syncManager: Comlink.Remote<WorkerClient>;
   protected clientProvider: SharedSyncClientProvider;
-  protected messagePort: MessagePort;
+  protected worker: WorkerConnection;
 
   protected isInitialized: Promise<void>;
   protected dbAdapter: WebDBAdapter;
   private abortOnClose = new AbortController();
+  private logLevel: number;
+  private enableBroadcastLogs: boolean;
 
   constructor(options: SharedWebStreamingSyncImplementationOptions) {
     super(options);
     this.dbAdapter = options.db;
-    /**
-     * Configure or connect to the shared sync worker.
-     * This worker will manage all syncing operations remotely.
-     */
-    const resolvedWorkerOptions = {
-      dbFilename: this.options.identifier!,
-      temporaryStorage: TemporaryStorageOption.MEMORY,
-      cacheSizeKb: DEFAULT_CACHE_SIZE_KB,
-      ...options,
-      flags: resolveWebSQLFlags(options.flags)
-    };
+    this.logLevel = options.logLevel;
+    this.enableBroadcastLogs = options.enableBroadcastLogs;
 
     const syncWorker = options.sync?.worker;
-    if (syncWorker) {
-      if (typeof syncWorker === 'function') {
-        this.messagePort = syncWorker(resolvedWorkerOptions).port;
-      } else {
-        this.messagePort = new SharedWorker(`${syncWorker}`, {
-          /* @vite-ignore */
-          name: `shared-sync-${this.webOptions.identifier}`
-        }).port;
-      }
+    if (typeof syncWorker === 'function') {
+      this.worker = connectToExistingWorker(syncWorker(), 'sync');
     } else {
-      this.messagePort = new SharedWorker(
-        new URL('../../worker/sync/SharedSyncImplementation.worker.js', import.meta.url),
-        {
-          /* @vite-ignore */
-          name: `shared-sync-${this.webOptions.identifier}`,
-          type: 'module'
-        }
-      ).port;
+      this.worker = connectToWorker({
+        service: 'sync',
+        databaseIdentifier: this.webOptions.identifier!,
+        shared: true,
+        customWorker: syncWorker
+      });
     }
 
     /**
@@ -151,21 +111,21 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
      */
     this.clientProvider = new SharedSyncClientProvider(
       this.webOptions,
-      (status) => {
-        this.updateSyncStatus(status);
+      ({ core, dataFlow }) => {
+        this.updateSyncStatus(core, dataFlow);
       },
       options.db
     );
 
-    this.syncManager = Comlink.wrap<WorkerClient>(this.messagePort);
+    this.syncManager = Comlink.wrap<WorkerClient>(this.worker.endpoint);
     /**
      * The sync worker will call this client provider when it needs
      * to fetch credentials or upload data.
      * This performs bi-directional method calling.
      */
-    Comlink.expose(this.clientProvider, this.messagePort);
+    Comlink.expose(this.clientProvider, this.worker.endpoint);
 
-    this.syncManager.setLogLevel(this.logger.getLevel());
+    this.syncManager.setLogLevel(this.logLevel);
 
     this.triggerCrudUpload = this.syncManager.triggerCrudUpload;
 
@@ -197,18 +157,16 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
     // Awaiting here ensures the worker is waiting for the lock
     await this.syncManager.addLockBasedCloseSignal(closeSignal);
 
-    const { crudUploadThrottleMs, identifier, retryDelayMs } = this.options;
-    const flags = { ...this.webOptions.flags, workers: undefined };
+    const { identifier } = this.options;
 
     await this.syncManager.setParams(
       {
         dbParams: this.dbAdapter.getConfiguration(),
         streamOptions: {
-          crudUploadThrottleMs,
           identifier,
-          retryDelayMs,
-          flags: flags
-        }
+          serializedSchema: this.options.serializedSchema
+        },
+        enableBroadcastLogs: this.enableBroadcastLogs
       },
       this.options.subscriptions
     );
@@ -218,9 +176,9 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
    * Starts the sync process, this effectively acts as a call to
    * `connect` if not yet connected.
    */
-  async connect(options?: PowerSyncConnectionOptions): Promise<void> {
+  async connect(options: ResolvedSyncOptions): Promise<void> {
     await this.waitForReady();
-    return this.syncManager.connect(options);
+    return this.syncManager.connect(options, this.options.serializedSchema);
   }
 
   async disconnect(): Promise<void> {
@@ -237,8 +195,11 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
     await this.waitForReady();
 
     await new Promise<void>((resolve) => {
+      // This will always be a message port since we use shared workers.
+      const messagePort = this.worker.endpoint as MessagePort;
+
       // Listen for the close acknowledgment from the worker
-      this.messagePort.addEventListener('message', (event) => {
+      messagePort.addEventListener('message', (event) => {
         const payload = event.data as ManualSharedSyncPayload;
         if (payload?.event === SharedSyncClientEvent.CLOSE_ACK) {
           resolve();
@@ -250,7 +211,7 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
         event: SharedSyncClientEvent.CLOSE_CLIENT,
         data: {}
       };
-      this.messagePort.postMessage(closeMessagePayload);
+      messagePort.postMessage(closeMessagePayload);
     });
 
     await super.dispose();
@@ -259,7 +220,7 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
 
     // Release the proxy
     this.syncManager[Comlink.releaseProxy]();
-    this.messagePort.close();
+    this.worker.close();
   }
 
   async waitForReady() {

package/src/db/sync/WebRemote.ts

@@ -1,43 +1,40 @@
-import {
-  AbstractRemote,
-  AbstractRemoteOptions,
-  DEFAULT_REMOTE_LOGGER,
-  FetchImplementation,
-  FetchImplementationProvider,
-  ILogger,
-  RemoteConnector
-} from '@powersync/common';
+import { LogLevels, PowerSyncLogger } from '@powersync/common';
+import { AbstractRemote, FetchOptions, RemoteConnector } from '@powersync/shared-internals';
 
 import { getUserAgentInfo } from './userAgent.js';
-
-/*
- * Depends on browser's implementation of global fetch.
- */
-class WebFetchProvider extends FetchImplementationProvider {
-  getFetch(): FetchImplementation {
-    return fetch.bind(globalThis);
-  }
-}
+import type { WebSocketSyncStreamPlatform, WebSocketSupport } from '@powersync/shared-internals/websockets';
 
 export class WebRemote extends AbstractRemote {
   constructor(
     protected connector: RemoteConnector,
-    protected logger: ILogger = DEFAULT_REMOTE_LOGGER,
-    options?: Partial<AbstractRemoteOptions>
+    logger: PowerSyncLogger
   ) {
-    super(connector, logger, {
-      ...(options ?? {}),
-      fetchImplementation: options?.fetchImplementation ?? new WebFetchProvider()
-    });
+    super(connector, logger);
+  }
+
+  protected fetch({ resource, request }: FetchOptions): Promise<Response> {
+    return fetch(resource, request);
+  }
+
+  protected async loadWebSocketSupport(platform: WebSocketSyncStreamPlatform): Promise<WebSocketSupport> {
+    if (!websockets) {
+      // loadWebSocketSupport being called concurrently is safe, the import resolves to the same module in that case.
+      const module = await import('@powersync/shared-internals/websockets');
+      websockets = new module.WebSocketSupport(platform);
+    }
+
+    return websockets;
   }
 
   getUserAgent(): string {
     let ua = [super.getUserAgent(), `powersync-web`];
     try {
       ua.push(...getUserAgentInfo());
-    } catch (e) {
-      this.logger.warn('Failed to get user agent info', e);
+    } catch (error) {
+      this.logger.log({ level: LogLevels.warn, message: 'Failed to get user agent info', error });
     }
     return ua.join(' ');
   }
 }
+
+let websockets: WebSocketSupport | undefined;

package/src/db/sync/WebStreamingSyncImplementation.ts

@@ -1,16 +1,15 @@
+import { LogLevels } from '@powersync/common';
 import {
   AbstractStreamingSyncImplementation,
   AbstractStreamingSyncImplementationOptions,
   LockOptions,
   LockType
-} from '@powersync/common';
+} from '@powersync/shared-internals';
 import { getNavigatorLocks } from '../../shared/navigator.js';
-import { ResolvedWebSQLOpenOptions, WebSQLFlags } from '../adapters/web-sql-flags.js';
 
 export interface WebStreamingSyncImplementationOptions extends AbstractStreamingSyncImplementationOptions {
-  flags?: WebSQLFlags;
   sync?: {
-    worker?: string | URL | ((options: ResolvedWebSQLOpenOptions) => SharedWorker);
+    worker?: string | URL | (() => SharedWorker);
   };
 }
 
@@ -27,7 +26,7 @@ export class WebStreamingSyncImplementation extends AbstractStreamingSyncImpleme
   async obtainLock<T>(lockOptions: LockOptions<T>): Promise<T> {
     const identifier = `streaming-sync-${lockOptions.type}-${this.webOptions.identifier}`;
     if (lockOptions.type == LockType.SYNC) {
-      this.logger.debug('requesting lock for ', identifier);
+      this.logger.log({ level: LogLevels.debug, message: `requesting lock for ${identifier}` });
     }
     return getNavigatorLocks().request(identifier, { signal: lockOptions.signal }, lockOptions.callback);
   }

package/src/index.ts

@@ -1,10 +1,8 @@
 export * from '@powersync/common';
 export * from './attachments/IndexDBFileSystemAdapter.js';
-export * from './db/adapters/AbstractWebPowerSyncDatabaseOpenFactory.js';
 export { WASQLiteVFS } from './db/adapters/wa-sqlite/vfs.js';
 export * from './db/adapters/wa-sqlite/WASQLiteOpenFactory.js';
-export * from './db/adapters/wa-sqlite/WASQLitePowerSyncDatabaseOpenFactory.js';
-export * from './db/adapters/web-sql-flags.js';
+export * from './db/adapters/options.js';
 export * from './db/PowerSyncDatabase.js';
 export * from './db/sync/SharedWebStreamingSyncImplementation.js';
 export * from './db/sync/WebRemote.js';

package/src/worker/SharedWorkerConnectionRequest.ts

@@ -0,0 +1,6 @@
+export type WorkerService = 'database' | 'sync';
+
+export interface SharedWorkerConnectionRequest {
+  service: WorkerService;
+  port: MessagePort;
+}

package/src/worker/client.ts

@@ -0,0 +1,100 @@
+import { SharedWorkerConnectionRequest, WorkerService } from './SharedWorkerConnectionRequest.js';
+
+export interface OpenWorkerOptions {
+  service: WorkerService;
+  databaseIdentifier: string;
+  customWorker?: string | URL;
+  shared: boolean;
+}
+
+export interface WorkerConnection {
+  endpoint: MessagePort | Worker;
+  worker: Worker | SharedWorker;
+  close: () => void;
+}
+
+export function connectToWorker({
+  service,
+  databaseIdentifier,
+  customWorker,
+  shared
+}: OpenWorkerOptions): WorkerConnection {
+  const name = `${shared ? 'shared-' : ''}powersync-${databaseIdentifier}`;
+  let worker: Worker | SharedWorker;
+
+  if (customWorker) {
+    worker = shared
+      ? new SharedWorker(customWorker, {
+          /* @vite-ignore */
+          name,
+          type: 'module'
+        })
+      : new Worker(customWorker, {
+          /* @vite-ignore */
+          name,
+          type: 'module'
+        });
+  } else {
+    worker = spawnDefaultPowerSyncWorker(shared, name);
+  }
+
+  return connectToExistingWorker(worker, service);
+}
+
+/**
+ * Opens the default PowerSync worker.
+ *
+ * When users depend on the web SDK, we assume they use their own bundler (either vite or webpack). Both recognize the
+ * syntax of worker constructors with a string literal and will rewrite the URL as part of their bundling processes.
+ *
+ * React Native / Metro users can't rely on this on the web, as their app is not a JavaScript module and import.meta.url
+ * is not rewritten by Metro. For those users, we include a pre-bundled worker they can copy into a static assets
+ * directory and load with a custom URI. This also means that defaultWorker cannot work with Metro for React Native Web.
+ * We have a custom rollup plugin and conditional exports that replaces this function with a throwing stub for that
+ * platform. This allows a helpful error message.
+ */
+// Note: When changing this function, also update disableDefaultWorkers in rollup.config.ts.
+function spawnDefaultPowerSyncWorker(shared: boolean, name: string): Worker | SharedWorker {
+  return shared
+    ? new SharedWorker(new URL('./worker.js', import.meta.url), {
+        /* @vite-ignore */
+        name,
+        type: 'module'
+      })
+    : new Worker(new URL('./worker.js', import.meta.url), {
+        /* @vite-ignore */
+        name,
+        type: 'module'
+      });
+}
+
+export function connectToExistingWorker(worker: Worker | SharedWorker, service: WorkerService): WorkerConnection {
+  const isShared = isSharedWorker(worker);
+  if (isShared) {
+    const { port1, port2 } = new MessageChannel();
+    const mainPort = (worker as SharedWorker).port;
+    mainPort.start();
+    mainPort.postMessage({ port: port1, service } satisfies SharedWorkerConnectionRequest, [port1]);
+
+    port2.start();
+    return {
+      endpoint: port2,
+      worker,
+      close() {
+        port2.close();
+      }
+    };
+  } else {
+    return {
+      endpoint: worker as Worker,
+      worker,
+      close() {
+        worker.terminate();
+      }
+    };
+  }
+}
+
+export function isSharedWorker(worker: Worker | SharedWorker): worker is SharedWorker {
+  return 'port' in worker;
+}

package/src/worker/db/MultiDatabaseServer.ts

@@ -1,27 +1,39 @@
-import { ILogger } from '@powersync/common';
+import { LogLevels, PowerSyncLogger } from '@powersync/common';
 import * as Comlink from 'comlink';
 import { ClientConnectionView, DatabaseServer } from '../../db/adapters/wa-sqlite/DatabaseServer.js';
-import {
-  ResolvedWASQLiteOpenFactoryOptions,
-  WorkerDBOpenerOptions
-} from '../../db/adapters/wa-sqlite/WASQLiteOpenFactory.js';
 import { getNavigatorLocks } from '../../shared/navigator.js';
-import { RawSqliteConnection } from '../../db/adapters/wa-sqlite/RawSqliteConnection.js';
+import { RawSqliteConnection, RawWaSqliteDatabaseOptions } from '../../db/adapters/wa-sqlite/RawSqliteConnection.js';
 import { ConcurrentSqliteConnection } from '../../db/adapters/wa-sqlite/ConcurrentConnection.js';
+import { WASQLiteVFS } from '../../db/adapters/wa-sqlite/vfs.js';
 
 const OPEN_DB_LOCK = 'open-wasqlite-db';
 
+export interface ConnectToMultiDatabaseServerOptions {
+  logLevel: number;
+  database: RawWaSqliteDatabaseOptions;
+  lockName: string;
+}
+
 /**
  * Shared state to manage multiple database connections hosted by a worker.
  */
 export class MultiDatabaseServer {
   private activeDatabases = new Map<string, DatabaseServer>();
 
-  constructor(readonly logger: ILogger) {}
+  constructor(readonly logger: PowerSyncLogger) {}
 
-  async handleConnection(options: WorkerDBOpenerOptions): Promise<ClientConnectionView> {
-    this.logger.setLevel(options.logLevel);
-    return Comlink.proxy(await this.openConnectionLocally(options, options.lockName));
+  async handleConnection({
+    logLevel,
+    database,
+    lockName
+  }: ConnectToMultiDatabaseServerOptions): Promise<ClientConnectionView> {
+    const logger: PowerSyncLogger = {
+      log: (record) => {
+        if (record.level >= logLevel) this.logger.log(record);
+      }
+    };
+
+    return Comlink.proxy(await this.openConnectionLocally(logger, database, lockName));
   }
 
   async connectToExisting(name: string, lockName: string): Promise<ClientConnectionView> {
@@ -35,7 +47,7 @@ export class MultiDatabaseServer {
     });
   }
 
-  async openConnectionLocally(options: ResolvedWASQLiteOpenFactoryOptions, lockName?: string) {
+  async openConnectionLocally(logger: PowerSyncLogger, options: RawWaSqliteDatabaseOptions, lockName?: string) {
     // Especially on Firefox, we're sometimes seeing "NoModificationAllowedError"s when opening OPFS databases we can
     // work around by retrying.
     const maxAttempts = 3;
@@ -43,28 +55,36 @@ export class MultiDatabaseServer {
 
     for (let count = 0; count < maxAttempts - 1; count++) {
       try {
-        server = await this.databaseOpenAttempt(options);
-      } catch (ex) {
-        this.logger.warn(`Attempt ${count + 1} of ${maxAttempts} to open database failed, retrying in 1 second...`, ex);
+        server = await this.databaseOpenAttempt(logger, options);
+      } catch (error) {
+        this.logger.log({
+          level: LogLevels.warn,
+          message: `Attempt ${count + 1} of ${maxAttempts} to open database failed, retrying in 1 second...`,
+          error
+        });
         await new Promise((resolve) => setTimeout(resolve, 1000));
       }
     }
 
     // Final attempt if we haven't been able to open the server - rethrow errors if we still can't open.
-    server ??= await this.databaseOpenAttempt(options);
+    server ??= await this.databaseOpenAttempt(logger, options);
     return server.connect(lockName);
   }
 
-  private async databaseOpenAttempt(options: ResolvedWASQLiteOpenFactoryOptions): Promise<DatabaseServer> {
+  private async databaseOpenAttempt(
+    logger: PowerSyncLogger,
+    options: RawWaSqliteDatabaseOptions
+  ): Promise<DatabaseServer> {
     return getNavigatorLocks().request(OPEN_DB_LOCK, async () => {
-      const { dbFilename } = options;
+      const { filename, readonly, vfs } = options;
 
-      let server: DatabaseServer | undefined = this.activeDatabases.get(dbFilename);
+      let server: DatabaseServer | undefined = this.activeDatabases.get(filename);
       if (server == null) {
         // We don't need navigator locks for shared workers because all queries run in this shared worker exclusively.
         // For read-only connections, we use a VFS that supports concurrent reads (so a single lock on the connection is
-        // fine).
-        const needsNavigatorLocks = !(isSharedWorker || options.isReadOnly);
+        // fine). In-memory databases either run in a shared worker or aren't shared across tabs at all, so the internal
+        // lock is enough.
+        const needsNavigatorLocks = !(isSharedWorker || readonly || vfs == WASQLiteVFS.InMemoryVfs);
         const connection = new RawSqliteConnection(options);
         const withSafeConcurrency = new ConcurrentSqliteConnection(connection, needsNavigatorLocks);
 
@@ -81,13 +101,13 @@ export class MultiDatabaseServer {
         }
         returnLease();
 
-        const onClose = () => this.activeDatabases.delete(dbFilename);
+        const onClose = () => this.activeDatabases.delete(filename);
         server = new DatabaseServer({
           inner: withSafeConcurrency,
-          logger: this.logger,
+          logger,
           onClose
         });
-        this.activeDatabases.set(dbFilename, server);
+        this.activeDatabases.set(filename, server);
       }
 
       return server;

package/src/worker/sync/AbstractSharedSyncClientProvider.ts

@@ -1,4 +1,5 @@
-import type { PowerSyncCredentials, SyncStatusOptions } from '@powersync/common';
+import type { LogRecord, PowerSyncCredentials } from '@powersync/common';
+import { SyncStatusJson } from '@powersync/shared-internals';
 
 /**
  * The client side port should provide these methods.
@@ -7,15 +8,8 @@ export abstract class AbstractSharedSyncClientProvider {
   abstract fetchCredentials(): Promise<PowerSyncCredentials | null>;
   abstract invalidateCredentials(): void;
   abstract uploadCrud(): Promise<void>;
-  abstract statusChanged(status: SyncStatusOptions): void;
+  abstract statusChanged(status: SyncStatusJson): void;
   abstract getDBWorkerPort(): Promise<MessagePort>;
 
-  abstract trace(...x: any[]): void;
-  abstract debug(...x: any[]): void;
-  abstract info(...x: any[]): void;
-  abstract log(...x: any[]): void;
-  abstract warn(...x: any[]): void;
-  abstract error(...x: any[]): void;
-  abstract time(label: string): void;
-  abstract timeEnd(label: string): void;
+  abstract log(record: LogRecord): void;
 }