Migrate web package

Author: simolus3

packages/common/src/utils/Logger.ts

@@ -45,12 +45,14 @@ export interface CreateLoggerOptions {
  *
  * @param options Options to configure a minimum severity of the logger or a prefix to make messages more recognizable.
  */
-export function createPowerSyncLogger(options?: Partial<CreateLoggerOptions>): PowerSyncLogger {
+export function createPowerSyncLogger(options?: Partial<CreateLoggerOptions>): PowerSyncLogger & CreateLoggerOptions {
   const { prefix = 'PowerSync', minLevel = LogLevels.info } = options ?? {};
 
   return {
+    prefix,
+    minLevel,
     log(level, ...message) {
-      if (level < minLevel) return;
+      if (level < this.minLevel) return;
 
       let emitter = console.log;
       if (level >= LogLevels.error) {
@@ -59,7 +61,7 @@ export function createPowerSyncLogger(options?: Partial<CreateLoggerOptions>): P
         emitter = console.warn;
       }
 
-      emitter(prefix, ...message);
+      emitter(this.prefix, ...message);
     }
   };
 }

packages/web/src/db/PowerSyncDatabase.ts

@@ -14,7 +14,8 @@ import {
   type BucketStorageAdapter,
   type PowerSyncBackendConnector,
   type PowerSyncCloseOptions,
-  type RequiredAdditionalConnectionOptions
+  type RequiredAdditionalConnectionOptions,
+  LogLevels
 } from '@powersync/common';
 import { getNavigatorLocks } from '../shared/navigator.js';
 import { NAVIGATOR_TRIGGER_CLAIM_MANAGER } from './NavigatorTriggerClaimManager.js';
@@ -44,6 +45,13 @@ export interface WebPowerSyncFlags extends WebSQLFlags {
    * instances before the window unloads
    */
   externallyUnload?: boolean;
+
+  /**
+   * The log level for database workers.
+   *
+   * Defaults to {@link LogLevels.info}.
+   */
+  databaseWorkerLogLevel?: number;
 }
 
 type WithWebFlags<Base> = Base & { flags?: WebPowerSyncFlags };
@@ -56,6 +64,13 @@ export interface WebSyncOptions {
    * or a factory method that returns a worker.
    */
   worker?: string | URL | ((options: ResolvedWebSQLOpenOptions) => SharedWorker);
+
+  /**
+   * The log level for logs from the sync worker.
+   *
+   * Defaults to {@link LogLevels.info}.
+   */
+  logLevel?: number;
 }
 
 type WithWebSyncOptions<Base> = Base & {
@@ -86,7 +101,8 @@ export type WebPowerSyncDatabaseOptions = WithWebSyncOptions<WithWebFlags<PowerS
 
 export const DEFAULT_POWERSYNC_FLAGS: Required<WebPowerSyncFlags> = {
   ...DEFAULT_WEB_SQL_FLAGS,
-  externallyUnload: false
+  externallyUnload: false,
+  databaseWorkerLogLevel: LogLevels.info
 };
 
 export const resolveWebPowerSyncFlags = (flags?: WebPowerSyncFlags): Required<WebPowerSyncFlags> => {
@@ -171,10 +187,13 @@ export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
   }
 
   protected openDBAdapter(options: WebPowerSyncDatabaseOptionsWithSettings): DBAdapter {
+    const resolvedFlags = resolveWebPowerSyncFlags(options.flags);
     const defaultFactory = new WASQLiteOpenFactory({
       ...options.database,
-      flags: resolveWebPowerSyncFlags(options.flags),
-      encryptionKey: options.encryptionKey
+      flags: resolvedFlags,
+      encryptionKey: options.encryptionKey,
+      logger: this.logger,
+      logLevel: resolvedFlags.databaseWorkerLogLevel
     });
     return defaultFactory.openDB();
   }
@@ -206,7 +225,7 @@ export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
   }
 
   protected generateBucketStorageAdapter(): BucketStorageAdapter {
-    return new SqliteBucketStorage(this.database);
+    return new SqliteBucketStorage(this.database, this.logger);
   }
 
   protected async runExclusive<T>(cb: () => Promise<T>) {
@@ -245,11 +264,12 @@ export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
             Logs for shared sync worker will only be available in the shared worker context
           `;
           const logger = this.options.logger;
-          logger ? logger.warn(warning) : console.warn(warning);
+          logger ? logger.log(LogLevels.warn, warning) : console.warn(warning);
         }
         return new SharedWebStreamingSyncImplementation({
           ...syncOptions,
-          db: this.database as WebDBAdapter // This should always be the case
+          db: this.database as WebDBAdapter, // This should always be the case
+          logLevel: this.options.sync?.logLevel ?? LogLevels.info
         });
       default:
         return new WebStreamingSyncImplementation(syncOptions);

packages/web/src/db/adapters/wa-sqlite/DatabaseServer.ts

@@ -1,11 +1,11 @@
-import { ILogger } from '@powersync/common';
+import { LogLevels, PowerSyncLogger } from '@powersync/common';
 import { ConcurrentSqliteConnection, ConnectionLeaseToken } from './ConcurrentConnection.js';
 import { RawQueryResult } from './RawSqliteConnection.js';
 
 export interface DatabaseServerOptions {
   inner: ConcurrentSqliteConnection;
   onClose: () => void;
-  logger: ILogger;
+  logger: PowerSyncLogger;
 }
 
 /**
@@ -85,7 +85,7 @@ export class DatabaseServer {
 
         // If the client holds a connection lease it hasn't returned, return that now.
         for (const { lease } of connectionLeases.values()) {
-          this.#logger.debug(`Closing connection lease that hasn't been returned.`);
+          this.#logger.log(LogLevels.debug, `Closing connection lease that hasn't been returned.`);
           await lease.returnLease();
         }
 
@@ -94,7 +94,7 @@ export class DatabaseServer {
         if (this.#activeClients.size == 0) {
           await this.forceClose();
         } else {
-          this.#logger.debug('Keeping underlying connection active since its used by other clients.');
+          this.#logger.log(LogLevels.debug, 'Keeping underlying connection active since its used by other clients.');
         }
       }
     };
@@ -169,7 +169,7 @@ export class DatabaseServer {
   }
 
   async forceClose() {
-    this.#logger.debug(`Closing connection to ${this.#inner.options}.`);
+    this.#logger.log(LogLevels.debug, `Closing connection to ${this.#inner.options}.`);
     const connection = this.#inner;
     this.#options.onClose();
     this.#updateBroadcastChannel.close();

packages/web/src/db/adapters/wa-sqlite/WASQLiteOpenFactory.ts

@@ -1,4 +1,4 @@
-import { createLogger, DBAdapter, ILogger, SQLOpenFactory, type ILogLevel } from '@powersync/common';
+import { createPowerSyncLogger, DBAdapter, LogLevels, PowerSyncLogger, SQLOpenFactory } from '@powersync/common';
 import * as Comlink from 'comlink';
 import { openWorkerDatabasePort, resolveWorkerDatabasePortFactory } from '../../../worker/db/open-worker-database.js';
 import {
@@ -29,6 +29,13 @@ export interface WASQLiteOpenFactoryOptions extends WebSQLOpenFactoryOptions {
    * Defaults to 1.
    */
   additionalReaders?: number;
+
+  /**
+   * The {@link LogLevels} value to use for logs in the worker.
+   */
+  logLevel: number;
+
+  logger: PowerSyncLogger;
 }
 
 export interface ResolvedWASQLiteOpenFactoryOptions extends ResolvedWebSQLOpenOptions {
@@ -41,7 +48,7 @@ export interface ResolvedWASQLiteOpenFactoryOptions extends ResolvedWebSQLOpenOp
 }
 
 export interface WorkerDBOpenerOptions extends ResolvedWASQLiteOpenFactoryOptions {
-  logLevel: ILogLevel;
+  logLevel: number;
   /**
    * A lock that is currently held by the client. When the lock is returned, we know the client is gone and that we need
    * to clean up resources.
@@ -54,12 +61,12 @@ export interface WorkerDBOpenerOptions extends ResolvedWASQLiteOpenFactoryOption
  */
 export class WASQLiteOpenFactory implements SQLOpenFactory {
   private resolvedFlags: ResolvedWebSQLFlags;
-  private logger: ILogger;
+  private logger: PowerSyncLogger;
 
   constructor(private options: WASQLiteOpenFactoryOptions) {
     assertValidWASQLiteOpenFactoryOptions(options);
     this.resolvedFlags = resolveWebSQLFlags(options.flags);
-    this.logger = options.logger ?? createLogger(`WASQLiteOpenFactory - ${this.options.dbFilename}`);
+    this.logger = options.logger;
   }
 
   get waOptions(): WASQLiteOpenFactoryOptions {
@@ -77,7 +84,8 @@ export class WASQLiteOpenFactory implements SQLOpenFactory {
     } = this;
     if (ssrMode) {
       if (!disableSSRWarning) {
-        this.logger.warn(
+        this.logger.log(
+          LogLevels.warn,
           `
       Running PowerSync in SSR mode.
       Only empty query results will be returned.
@@ -89,7 +97,8 @@ export class WASQLiteOpenFactory implements SQLOpenFactory {
     }
 
     if (!enableMultiTabs) {
-      this.logger.warn(
+      this.logger.log(
+        LogLevels.warn,
         'Multiple tab support is not enabled. Using this site across multiple tabs may not function correctly.'
       );
     }
@@ -107,7 +116,7 @@ export class WASQLiteOpenFactory implements SQLOpenFactory {
     } = this.waOptions;
 
     if (!enableMultiTabs) {
-      this.logger.warn('Multiple tabs are not enabled in this browser');
+      this.logger.log(LogLevels.warn, 'Multiple tabs are not enabled in this browser');
     }
 
     const resolveOptions = (isReadOnly: boolean): ResolvedWASQLiteOpenFactoryOptions => ({
@@ -149,7 +158,7 @@ export class WASQLiteOpenFactory implements SQLOpenFactory {
         const closeSignal = new AbortController();
         const connection = await source.connect({
           ...resolvedOptions,
-          logLevel: this.logger.getLevel(),
+          logLevel: this.options.logLevel,
           lockName: await generateTabCloseSignal(closeSignal.signal)
         });
         const clientOptions = {
@@ -190,7 +199,7 @@ export class WASQLiteOpenFactory implements SQLOpenFactory {
       requiresPersistentTriggers = true;
 
       const resolvedOptions = resolveOptions(false);
-      const connection = await localServer.openConnectionLocally(resolvedOptions);
+      const connection = await localServer.openConnectionLocally(this.logger, resolvedOptions);
       client = new DatabaseClient(
         { connection, source: null, remoteCanCloseUnexpectedly: false },
         {

packages/web/src/db/adapters/wa-sqlite/WASQLitePowerSyncDatabaseOpenFactory.ts

@@ -1,4 +1,10 @@
-import { AbstractPowerSyncDatabase, DBAdapter, PowerSyncDatabaseOptions } from '@powersync/common';
+import {
+  AbstractPowerSyncDatabase,
+  createPowerSyncLogger,
+  DBAdapter,
+  LogLevels,
+  PowerSyncDatabaseOptions
+} from '@powersync/common';
 import { PowerSyncDatabase } from '../../../db/PowerSyncDatabase.js';
 import { AbstractWebPowerSyncDatabaseOpenFactory } from '../AbstractWebPowerSyncDatabaseOpenFactory.js';
 import { WASQLiteOpenFactory } from './WASQLiteOpenFactory.js';
@@ -14,7 +20,11 @@ import { WASQLiteOpenFactory } from './WASQLiteOpenFactory.js';
  */
 export class WASQLitePowerSyncDatabaseOpenFactory extends AbstractWebPowerSyncDatabaseOpenFactory {
   protected openDB(): DBAdapter {
-    const factory = new WASQLiteOpenFactory(this.options);
+    const factory = new WASQLiteOpenFactory({
+      logger: createPowerSyncLogger(),
+      logLevel: LogLevels.info,
+      ...this.options
+    });
     return factory.openDB();
   }
 

packages/web/src/db/adapters/web-sql-flags.ts

@@ -1,4 +1,4 @@
-import { type ILogger, SQLOpenOptions } from '@powersync/common';
+import { type PowerSyncLogger, SQLOpenOptions } from '@powersync/common';
 
 /**
  * Common settings used when creating SQL connections on web.
@@ -82,7 +82,7 @@ export interface WebSQLOpenFactoryOptions extends SQLOpenOptions {
    */
   workerPort?: MessagePort;
 
-  logger?: ILogger;
+  logger?: PowerSyncLogger;
 
   /**
    * Where to store SQLite temporary files. Defaults to 'MEMORY'.

packages/web/src/db/sync/SharedWebStreamingSyncImplementation.ts

@@ -5,7 +5,6 @@ import {
   SyncStatusOptions
 } 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';
@@ -68,33 +67,13 @@ 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(level: number, ...message: any[]): void {
+    this.logger?.log(level, message);
   }
 }
 
 export interface SharedWebStreamingSyncImplementationOptions extends WebStreamingSyncImplementationOptions {
+  logLevel: number;
   db: WebDBAdapter;
 }
 
@@ -109,10 +88,12 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
   protected isInitialized: Promise<void>;
   protected dbAdapter: WebDBAdapter;
   private abortOnClose = new AbortController();
+  private logLevel: number;
 
   constructor(options: SharedWebStreamingSyncImplementationOptions) {
     super(options);
     this.dbAdapter = options.db;
+    this.logLevel = options.logLevel;
     /**
      * Configure or connect to the shared sync worker.
      * This worker will manage all syncing operations remotely.
@@ -165,7 +146,7 @@ export class SharedWebStreamingSyncImplementation extends WebStreamingSyncImplem
      */
     Comlink.expose(this.clientProvider, this.messagePort);
 
-    this.syncManager.setLogLevel(this.logger.getLevel());
+    this.syncManager.setLogLevel(this.logLevel);
 
     this.triggerCrudUpload = this.syncManager.triggerCrudUpload;
 

packages/web/src/db/sync/WebRemote.ts

@@ -1,10 +1,10 @@
 import {
   AbstractRemote,
   AbstractRemoteOptions,
-  DEFAULT_REMOTE_LOGGER,
   FetchImplementation,
   FetchImplementationProvider,
-  ILogger,
+  LogLevels,
+  PowerSyncLogger,
   RemoteConnector
 } from '@powersync/common';
 
@@ -22,7 +22,7 @@ class WebFetchProvider extends FetchImplementationProvider {
 export class WebRemote extends AbstractRemote {
   constructor(
     protected connector: RemoteConnector,
-    protected logger: ILogger = DEFAULT_REMOTE_LOGGER,
+    protected logger: PowerSyncLogger,
     options?: Partial<AbstractRemoteOptions>
   ) {
     super(connector, logger, {
@@ -36,7 +36,7 @@ export class WebRemote extends AbstractRemote {
     try {
       ua.push(...getUserAgentInfo());
     } catch (e) {
-      this.logger.warn('Failed to get user agent info', e);
+      this.logger.log(LogLevels.warn, 'Failed to get user agent info', e);
     }
     return ua.join(' ');
   }