@powersync/web 0.0.0-dev-20260630141119 → 0.0.0-dev-20260708103617

package/src/worker/sync/BroadcastLogger.ts

@@ -1,39 +1,113 @@
-import { PowerSyncLogger, LogLevels, CreateLoggerOptions, createConsoleLogger, LogRecord } from '@powersync/common';
+import { type ILogger, type ILogLevel, LogLevel } from '@powersync/common';
 import { type WrappedSyncPort } from './SharedSyncImplementation.js';
 
 /**
  * Broadcasts logs to all clients
  */
-export class BroadcastLogger implements PowerSyncLogger {
-  private readonly inner: PowerSyncLogger & CreateLoggerOptions;
-  private currentLevel: number = LogLevels.info;
+export class BroadcastLogger implements ILogger {
+  TRACE: ILogLevel;
+  DEBUG: ILogLevel;
+  INFO: ILogLevel;
+  TIME: ILogLevel;
+  WARN: ILogLevel;
+  ERROR: ILogLevel;
+  OFF: ILogLevel;
 
-  sendBroadcasts = true;
+  private currentLevel: ILogLevel = LogLevel.INFO;
 
-  constructor(
-    prefix: string,
-    private clients: WrappedSyncPort[]
-  ) {
-    this.inner = createConsoleLogger({ prefix: prefix });
+  constructor(protected clients: WrappedSyncPort[]) {
+    this.TRACE = LogLevel.TRACE;
+    this.DEBUG = LogLevel.DEBUG;
+    this.INFO = LogLevel.INFO;
+    this.TIME = LogLevel.TIME;
+    this.WARN = LogLevel.WARN;
+    this.ERROR = LogLevel.ERROR;
+    this.OFF = LogLevel.OFF;
   }
 
-  log(record: LogRecord) {
-    this.inner.log(record);
+  trace(...x: any[]): void {
+    if (!this.enabledFor(this.TRACE)) return;
 
-    if (this.sendBroadcasts && record.level >= this.currentLevel) {
-      const sanitized = this.sanitizeRecord(record);
-      this.iterateClients((client) => client.clientProvider.log(sanitized));
-    }
+    console.trace(...x);
+    const sanitized = this.sanitizeArgs(x);
+    this.iterateClients((client) => client.clientProvider.trace(...sanitized));
+  }
+
+  debug(...x: any[]): void {
+    if (!this.enabledFor(this.DEBUG)) return;
+
+    console.debug(...x);
+    const sanitized = this.sanitizeArgs(x);
+    this.iterateClients((client) => client.clientProvider.debug(...sanitized));
+  }
+
+  info(...x: any[]): void {
+    if (!this.enabledFor(this.INFO)) return;
+
+    console.info(...x);
+    const sanitized = this.sanitizeArgs(x);
+    this.iterateClients((client) => client.clientProvider.info(...sanitized));
+  }
+
+  log(...x: any[]): void {
+    if (!this.enabledFor(this.INFO)) return;
+
+    console.log(...x);
+    const sanitized = this.sanitizeArgs(x);
+    this.iterateClients((client) => client.clientProvider.log(...sanitized));
+  }
+
+  warn(...x: any[]): void {
+    if (!this.enabledFor(this.WARN)) return;
+
+    console.warn(...x);
+    const sanitized = this.sanitizeArgs(x);
+    this.iterateClients((client) => client.clientProvider.warn(...sanitized));
+  }
+
+  error(...x: any[]): void {
+    if (!this.enabledFor(this.ERROR)) return;
+
+    console.error(...x);
+    const sanitized = this.sanitizeArgs(x);
+    this.iterateClients((client) => client.clientProvider.error(...sanitized));
+  }
+
+  time(label: string): void {
+    if (!this.enabledFor(this.TIME)) return;
+
+    console.time(label);
+    this.iterateClients((client) => client.clientProvider.time(label));
+  }
+
+  timeEnd(label: string): void {
+    if (!this.enabledFor(this.TIME)) return;
+
+    console.timeEnd(label);
+    this.iterateClients((client) => client.clientProvider.timeEnd(label));
   }
 
   /**
    * Set the global log level.
    */
-  setLevel(level: number): void {
-    this.inner.minLevel = level;
+  setLevel(level: ILogLevel): void {
     this.currentLevel = level;
   }
 
+  /**
+   * Get the current log level.
+   */
+  getLevel(): ILogLevel {
+    return this.currentLevel;
+  }
+
+  /**
+   * Returns true if the given level is enabled.
+   */
+  enabledFor(level: ILogLevel): boolean {
+    return level.value >= this.currentLevel.value;
+  }
+
   /**
    * Iterates all clients, catches individual client exceptions
    * and proceeds to execute for all clients.
@@ -52,23 +126,17 @@ export class BroadcastLogger implements PowerSyncLogger {
    * Guards against any logging errors.
    * We don't want a logging exception to cause further issues upstream
    */
-  protected sanitizeRecord(record: LogRecord): LogRecord {
-    if (!record.error) {
-      return record;
-    }
-
-    let error;
-    try {
-      // Try and clone here first. If it fails it won't be passable over a MessagePort
-      error = structuredClone(record.error);
-    } catch (ex) {
-      console.error(ex);
-      error = 'Could not serialize log params. Check shared worker logs for more details.';
-    }
+  protected sanitizeArgs(x: any[]): any[] {
+    const sanitizedParams = x.map((param) => {
+      try {
+        // Try and clone here first. If it fails it won't be passable over a MessagePort
+        return structuredClone(param);
+      } catch (ex) {
+        console.error(ex);
+        return 'Could not serialize log params. Check shared worker logs for more details.';
+      }
+    });
 
-    return {
-      ...record,
-      error
-    };
+    return sanitizedParams;
   }
 }

package/src/worker/sync/SharedSyncImplementation.ts

@@ -1,24 +1,26 @@
 import {
+  AbortOperation,
   BaseObserver,
+  ConnectionManager,
+  ConnectionPool,
   DBAdapter,
+  DBAdapterDefaultMixin,
+  DBAdapterListener,
   DBLockOptions,
   LockContext,
   PowerSyncBackendConnector,
-  SyncStatus,
-  LogLevels,
-  SyncStreamConnectionMethod
-} from '@powersync/common';
-import {
-  AbortOperation,
-  ConnectionManager,
   SqliteBucketStorage,
   SubscribedStream,
+  SyncStatus,
+  createLogger,
+  Mutex,
+  type ILogLevel,
+  type ILogger,
+  type PowerSyncConnectionOptions,
   type StreamingSyncImplementation,
   type StreamingSyncImplementationListener,
-  Mutex,
-  ResolvedSyncOptions,
-  SyncStatusSnapshot
-} from '@powersync/shared-internals';
+  type SyncStatusOptions
+} from '@powersync/common';
 import * as Comlink from 'comlink';
 import { WebRemote } from '../../db/sync/WebRemote.js';
 import {
@@ -26,11 +28,11 @@ import {
   WebStreamingSyncImplementationOptions
 } from '../../db/sync/WebStreamingSyncImplementation.js';
 
+import { ResolvedWebSQLOpenOptions } from '../../db/adapters/web-sql-flags.js';
 import { AbstractSharedSyncClientProvider } from './AbstractSharedSyncClientProvider.js';
 import { BroadcastLogger } from './BroadcastLogger.js';
 import { DatabaseClient, OpenWorkerConnection } from '../../db/adapters/wa-sqlite/DatabaseClient.js';
 import { generateTabCloseSignal } from '../../shared/tab_close_signal.js';
-import { ResolvedWebSQLOpenOptions } from '../../db/adapters/options.js';
 
 /**
  * @internal
@@ -58,12 +60,8 @@ export type ManualSharedSyncPayload = {
  * @internal
  */
 export type SharedSyncInitOptions = {
-  streamOptions: Omit<
-    WebStreamingSyncImplementationOptions,
-    'adapter' | 'uploadCrud' | 'remote' | 'subscriptions' | 'logger'
-  >;
+  streamOptions: Omit<WebStreamingSyncImplementationOptions, 'adapter' | 'uploadCrud' | 'remote' | 'subscriptions'>;
   dbParams: ResolvedWebSQLOpenOptions;
-  enableBroadcastLogs: boolean;
 };
 
 /**
@@ -114,19 +112,21 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
   protected uploadDataController?: RemoteOperationAbortController;
 
   protected syncParams: SharedSyncInitOptions | null;
-  protected lastConnectOptions: ResolvedSyncOptions | undefined;
+  protected logger: ILogger;
+  protected lastConnectOptions: PowerSyncConnectionOptions | undefined;
   protected portMutex: Mutex;
   private subscriptions: SubscribedStream[] = [];
 
   protected connectionManager: ConnectionManager;
-  private syncStatus?: SyncStatusSnapshot;
-  logger: BroadcastLogger;
+  syncStatus: SyncStatus;
+  broadCastLogger: ILogger;
   protected readonly database = this.generateReconnectableDatabase();
 
   constructor() {
     super();
     this.ports = [];
     this.syncParams = null;
+    this.logger = createLogger('shared-sync');
     this.lastConnectOptions = undefined;
     this.portMutex = new Mutex();
 
@@ -139,7 +139,8 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
       });
     });
 
-    this.logger = new BroadcastLogger('shared-sync', this.ports);
+    this.syncStatus = new SyncStatus({});
+    this.broadCastLogger = new BroadcastLogger(this.ports);
 
     this.connectionManager = new ConnectionManager({
       createSyncImplementation: async () => {
@@ -147,10 +148,8 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
 
         const sync = this.generateStreamingImplementation();
         const onDispose = sync.registerListener({
-          statusChanged: (snapshot) => {
-            this.syncStatus = snapshot;
-            const json = snapshot.toJSON();
-            this.ports.forEach((p) => p.clientProvider.statusChanged(json));
+          statusChanged: (status) => {
+            this.updateAllStatuses(status.toJSON());
           }
         });
 
@@ -159,8 +158,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
           onDispose
         };
       },
-      logger: this.logger,
-      defaultConnectionMethod: SyncStreamConnectionMethod.HTTP
+      logger: this.logger
     });
   }
 
@@ -194,6 +192,12 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
     });
   }
 
+  async waitForStatus(status: SyncStatusOptions): Promise<void> {
+    return this.withSyncImplementation(async (sync) => {
+      return sync.waitForStatus(status);
+    });
+  }
+
   async waitUntilStatusMatches(predicate: (status: SyncStatus) => boolean): Promise<void> {
     return this.withSyncImplementation(async (sync) => {
       return sync.waitUntilStatusMatches(predicate);
@@ -205,7 +209,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
   }
 
   private collectActiveSubscriptions() {
-    this.logger.log({ level: LogLevels.debug, message: 'Collecting active stream subscriptions across tabs' });
+    this.logger.debug('Collecting active stream subscriptions across tabs');
     const active = new Map<string, SubscribedStream>();
     for (const port of this.ports) {
       for (const stream of port.currentSubscriptions) {
@@ -214,10 +218,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
       }
     }
     this.subscriptions = [...active.values()];
-    this.logger.log({
-      level: LogLevels.debug,
-      message: `Collected stream subscriptions, ${JSON.stringify(this.subscriptions)}`
-    });
+    this.logger.debug('Collected stream subscriptions', this.subscriptions);
     this.connectionManager.syncStreamImplementation?.updateSubscriptions(this.subscriptions);
   }
 
@@ -226,8 +227,9 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
     this.collectActiveSubscriptions();
   }
 
-  setLogLevel(level: number) {
+  setLogLevel(level: ILogLevel) {
     this.logger.setLevel(level);
+    this.broadCastLogger.setLevel(level);
   }
 
   /**
@@ -245,18 +247,16 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
 
     // First time setting params
     this.syncParams = params;
-    this.logger.sendBroadcasts = params.enableBroadcastLogs;
+    if (params.streamOptions?.flags?.broadcastLogs) {
+      this.logger = this.broadCastLogger;
+    }
 
     // Ensure we have a usable database connection, the reconnectable database will connect lazily on first use.
     await this.database.readLock(async () => {});
 
     self.onerror = (event) => {
       // Share any uncaught events on the broadcast logger
-      this.logger.log({
-        level: LogLevels.error,
-        message: 'Uncaught exception in PowerSync shared sync worker',
-        error: event
-      });
+      this.logger.error('Uncaught exception in PowerSync shared sync worker', event);
     };
 
     this.iterateListeners((l) => l.initialized?.());
@@ -274,9 +274,9 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
    * The connection will simply be reconnected whenever a new tab
    * connects.
    */
-  async connect(options: ResolvedSyncOptions, serializedSchema: any) {
+  async connect(options?: PowerSyncConnectionOptions) {
     this.lastConnectOptions = options;
-    return this.connectionManager.connect(CONNECTOR_PLACEHOLDER, options ?? {}, serializedSchema);
+    return this.connectionManager.connect(CONNECTOR_PLACEHOLDER, options ?? {});
   }
 
   async disconnect() {
@@ -298,7 +298,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
       this.ports.push(portProvider);
 
       // Give the newly connected client the latest status
-      const status = this.syncStatus;
+      const status = this.connectionManager.syncStreamImplementation?.syncStatus;
       if (status) {
         portProvider.clientProvider.statusChanged(status.toJSON());
       }
@@ -321,10 +321,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
     return await this.portMutex.runExclusive(async () => {
       const index = this.ports.findIndex((p) => p == port);
       if (index < 0) {
-        this.logger.log({
-          level: LogLevels.warn,
-          message: `Could not remove port ${port} since it is not present in active ports.`
-        });
+        this.logger.warn(`Could not remove port ${port} since it is not present in active ports.`);
         return () => {};
       }
 
@@ -400,13 +397,10 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
               throw new Error('No client port found to invalidate credentials');
             }
             try {
-              this.logger.log({
-                level: LogLevels.info,
-                message: 'calling the last port client provider to invalidate credentials'
-              });
+              this.logger.log('calling the last port client provider to invalidate credentials');
               lastPort.clientProvider.invalidateCredentials();
-            } catch (error) {
-              this.logger.log({ level: LogLevels.error, message: 'error invalidating credentials', error });
+            } catch (ex) {
+              this.logger.error('error invalidating credentials', ex);
             }
           },
           fetchCredentials: async () => {
@@ -423,10 +417,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
 
               abortController.signal.onabort = reject;
               try {
-                this.logger.log({
-                  level: LogLevels.info,
-                  message: 'calling the last port client provider for credentials'
-                });
+                this.logger.log('calling the last port client provider for credentials');
                 resolve(await lastPort.clientProvider.fetchCredentials());
               } catch (ex) {
                 reject(ex);
@@ -551,7 +542,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
     clearTimeout(timeout);
 
     client.closeListeners.push(async () => {
-      this.logger.log({ level: LogLevels.info, message: 'Aborting open connection because associated tab closed.' });
+      this.logger.info('Aborting open connection because associated tab closed.');
       handleClosed(db);
       /**
        * Don't await this close operation. It might never resolve if the tab is closed.
@@ -559,9 +550,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
        * We then call close. The close operation is configured to fire-and-forget, the main promise will reject immediately.
        */
       db.markRemoteClosed();
-      db.close().catch((error) =>
-        this.logger.log({ level: LogLevels.warn, message: 'error closing database connection', error })
-      );
+      db.close().catch((ex) => this.logger.warn('error closing database connection', ex));
     });
     return db;
   }
@@ -570,7 +559,7 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
     const syncParams = this.syncParams;
     const sharedSync = this;
 
-    return new (class extends DBAdapter {
+    class ReconnectPool extends BaseObserver<DBAdapterListener> implements ConnectionPool {
       private connectionState:
         | null
         | DatabaseClient<ResolvedWebSQLOpenOptions>
@@ -639,7 +628,19 @@ export class SharedSyncImplementation extends BaseObserver<SharedSyncImplementat
       async refreshSchema(): Promise<void> {
         // Not used by sync client.
       }
-    })();
+    }
+
+    const Adapter = DBAdapterDefaultMixin(ReconnectPool);
+    return new Adapter();
+  }
+
+  /**
+   * A method to update the all shared statuses for each
+   * client.
+   */
+  private updateAllStatuses(status: SyncStatusOptions) {
+    this.syncStatus = new SyncStatus(status);
+    this.ports.forEach((p) => p.clientProvider.statusChanged(status));
   }
 }
 

package/src/worker/sync/SharedSyncImplementation.worker.ts

@@ -0,0 +1,14 @@
+import { createBaseLogger } from '@powersync/common';
+import { SharedSyncImplementation } from './SharedSyncImplementation.js';
+import { WorkerClient } from './WorkerClient.js';
+
+const _self: SharedWorkerGlobalScope = self as any;
+const logger = createBaseLogger();
+logger.useDefaults();
+
+const sharedSyncImplementation = new SharedSyncImplementation();
+
+_self.onconnect = async function (event: MessageEvent<string>) {
+  const port = event.ports[0];
+  new WorkerClient(sharedSyncImplementation, port);
+};

package/src/worker/sync/WorkerClient.ts

@@ -1,3 +1,4 @@
+import { ILogLevel, PowerSyncConnectionOptions, SubscribedStream } from '@powersync/common';
 import * as Comlink from 'comlink';
 import { getNavigatorLocks } from '../../shared/navigator.js';
 import {
@@ -7,7 +8,6 @@ import {
   SharedSyncInitOptions,
   WrappedSyncPort
 } from './SharedSyncImplementation.js';
-import { SubscribedStream, ResolvedSyncOptions } from '@powersync/shared-internals';
 
 /**
  * A client to the shared sync worker.
@@ -65,7 +65,7 @@ export class WorkerClient {
     });
   }
 
-  setLogLevel(level: number) {
+  setLogLevel(level: ILogLevel) {
     this.sync.setLogLevel(level);
   }
 
@@ -82,8 +82,8 @@ export class WorkerClient {
     return this.sync.getWriteCheckpoint();
   }
 
-  connect(options: ResolvedSyncOptions, schema: any) {
-    return this.sync.connect(options, schema);
+  connect(options?: PowerSyncConnectionOptions) {
+    return this.sync.connect(options);
   }
 
   updateSubscriptions(subscriptions: SubscribedStream[]) {