Remove JS logger dependency

Author: simolus3

packages/common/package.json

@@ -59,8 +59,7 @@
     "test:exports": "attw --pack . --exclude-entrypoints internal/sync_protocol"
   },
   "dependencies": {
-    "event-iterator": "^2.0.0",
-    "js-logger": "catalog:"
+    "event-iterator": "^2.0.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "catalog:",

packages/common/src/attachments/AttachmentContext.ts

@@ -1,5 +1,5 @@
 import { AbstractPowerSyncDatabase } from '../client/AbstractPowerSyncDatabase.js';
-import { ILogger } from '../utils/Logger.js';
+import { LogLevels, PowerSyncLogger } from '../utils/Logger.js';
 import { Transaction } from '../db/DBAdapter.js';
 import { AttachmentRecord, AttachmentState, attachmentFromSql } from './Schema.js';
 
@@ -19,7 +19,7 @@ export class AttachmentContext {
   tableName: string;
 
   /** Logger instance for diagnostic information */
-  logger: ILogger;
+  logger: PowerSyncLogger;
 
   /** Maximum number of archived attachments to keep before cleanup */
   archivedCacheLimit: number = 100;
@@ -34,7 +34,7 @@ export class AttachmentContext {
   constructor(
     db: AbstractPowerSyncDatabase,
     tableName: string = 'attachments',
-    logger: ILogger,
+    logger: PowerSyncLogger,
     archivedCacheLimit: number
   ) {
     this.db = db;
@@ -233,7 +233,8 @@ export class AttachmentContext {
     if (archivedAttachments.length === 0) return false;
 
     await callback?.(archivedAttachments);
-    this.logger.info(
+    this.logger.log(
+      LogLevels.info,
       `Deleting ${archivedAttachments.length} archived attachments. Archived attachment exceeds cache archiveCacheLimit of ${this.archivedCacheLimit}.`
     );
 
@@ -254,7 +255,7 @@ export class AttachmentContext {
       [JSON.stringify(ids)]
     );
 
-    this.logger.info(`Deleted ${archivedAttachments.length} archived attachments`);
+    this.logger.log(LogLevels.info, `Deleted ${archivedAttachments.length} archived attachments`);
     return archivedAttachments.length < limit;
   }
 

packages/common/src/attachments/AttachmentQueue.ts

@@ -1,7 +1,7 @@
 import { AbstractPowerSyncDatabase } from '../client/AbstractPowerSyncDatabase.js';
 import { DEFAULT_WATCH_THROTTLE_MS } from '../client/watched/WatchedQuery.js';
 import { DifferentialWatchedQuery } from '../client/watched/processors/DifferentialQueryProcessor.js';
-import { ILogger } from '../utils/Logger.js';
+import { LogLevels, PowerSyncLogger } from '../utils/Logger.js';
 import { Transaction } from '../db/DBAdapter.js';
 import { AttachmentData, LocalStorageAdapter } from './LocalStorageAdapter.js';
 import { RemoteStorageAdapter } from './RemoteStorageAdapter.js';
@@ -49,7 +49,7 @@ export class AttachmentQueue {
   readonly tableName: string;
 
   /** Logger instance for diagnostic information */
-  readonly logger: ILogger;
+  readonly logger: PowerSyncLogger;
 
   /** Interval in milliseconds between periodic sync operations. Acts as a polling timer to retry
    *  failed uploads/downloads, especially after the app goes offline. Default: 30000 (30 seconds) */
@@ -78,9 +78,9 @@ export class AttachmentQueue {
   /** Cleanup function for status change listener */
   private statusListenerDispose?: () => void;
 
-  private watchActiveAttachments: DifferentialWatchedQuery<AttachmentRecord>;
+  private watchActiveAttachments!: DifferentialWatchedQuery<AttachmentRecord>;
 
-  private watchAttachmentsAbortController: AbortController;
+  private watchAttachmentsAbortController!: AbortController;
 
   /**
    * Creates a new AttachmentQueue instance.
@@ -115,7 +115,7 @@ export class AttachmentQueue {
     localStorage: LocalStorageAdapter;
     watchAttachments: (onUpdate: (attachment: WatchedAttachmentItem[]) => Promise<void>, signal: AbortSignal) => void;
     tableName?: string;
-    logger?: ILogger;
+    logger?: PowerSyncLogger;
     syncIntervalMs?: number;
     syncThrottleDuration?: number;
     downloadAttachments?: boolean;
@@ -190,7 +190,7 @@ export class AttachmentQueue {
         if (status.connected) {
           // Device came online, process attachments immediately
           this.syncStorage().catch((error) => {
-            this.logger.error('Error syncing storage on connection:', error);
+            this.logger.log(LogLevels.error, 'Error syncing storage on connection:', error);
           });
         }
       }

packages/common/src/attachments/AttachmentService.ts

@@ -1,6 +1,6 @@
 import { AbstractPowerSyncDatabase } from '../client/AbstractPowerSyncDatabase.js';
 import { DifferentialWatchedQuery } from '../client/watched/processors/DifferentialQueryProcessor.js';
-import { ILogger } from '../utils/Logger.js';
+import { PowerSyncLogger, LogLevels } from '../utils/Logger.js';
 import { Mutex } from '../utils/mutex.js';
 import { AttachmentContext } from './AttachmentContext.js';
 import { AttachmentRecord, AttachmentState } from './Schema.js';
@@ -16,7 +16,7 @@ export class AttachmentService {
 
   constructor(
     private db: AbstractPowerSyncDatabase,
-    private logger: ILogger,
+    private logger: PowerSyncLogger,
     private tableName: string = 'attachments',
     archivedCacheLimit: number = 100
   ) {
@@ -28,7 +28,7 @@ export class AttachmentService {
    * @returns Watch query that emits changes for queued uploads, downloads, and deletes
    */
   watchActiveAttachments({ throttleMs }: { throttleMs?: number } = {}): DifferentialWatchedQuery<AttachmentRecord> {
-    this.logger.info('Watching active attachments...');
+    this.logger.log(LogLevels.info, 'Watching active attachments...');
     const watch = this.db
       .query<AttachmentRecord>({
         sql: /* sql */ `

packages/common/src/attachments/SyncingService.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../utils/Logger.js';
+import { LogLevels, PowerSyncLogger } from '../utils/Logger.js';
 import { AttachmentService } from './AttachmentService.js';
 import { LocalStorageAdapter } from './LocalStorageAdapter.js';
 import { RemoteStorageAdapter } from './RemoteStorageAdapter.js';
@@ -16,14 +16,14 @@ export class SyncingService {
   private attachmentService: AttachmentService;
   private localStorage: LocalStorageAdapter;
   private remoteStorage: RemoteStorageAdapter;
-  private logger: ILogger;
+  private logger: PowerSyncLogger;
   private errorHandler?: AttachmentErrorHandler;
 
   constructor(
     attachmentService: AttachmentService,
     localStorage: LocalStorageAdapter,
     remoteStorage: RemoteStorageAdapter,
-    logger: ILogger,
+    logger: PowerSyncLogger,
     errorHandler?: AttachmentErrorHandler
   ) {
     this.attachmentService = attachmentService;
@@ -75,7 +75,7 @@ export class SyncingService {
    * @throws Error if the attachment has no localUri
    */
   async uploadAttachment(attachment: AttachmentRecord): Promise<AttachmentRecord> {
-    this.logger.info(`Uploading attachment ${attachment.filename}`);
+    this.logger.log(LogLevels.info, `Uploading attachment ${attachment.filename}`);
     try {
       if (attachment.localUri == null) {
         throw new Error(`No localUri for attachment ${attachment.id}`);
@@ -111,7 +111,7 @@ export class SyncingService {
    * @returns Updated attachment record with local URI and new state
    */
   async downloadAttachment(attachment: AttachmentRecord): Promise<AttachmentRecord> {
-    this.logger.info(`Downloading attachment ${attachment.filename}`);
+    this.logger.log(LogLevels.info, `Downloading attachment ${attachment.filename}`);
     try {
       const fileData = await this.remoteStorage.downloadFile(attachment);
 
@@ -183,7 +183,7 @@ export class SyncingService {
           try {
             await this.localStorage.deleteFile(attachment.localUri);
           } catch (error) {
-            this.logger.error('Error deleting local file for archived attachment', error);
+            this.logger.log(LogLevels.error, 'Error deleting local file for archived attachment', error);
           }
         }
       }

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -1,5 +1,4 @@
 import { EventIterator } from 'event-iterator';
-import Logger, { ILogger } from 'js-logger';
 import {
   BatchedUpdateNotification,
   DBAdapter,
@@ -46,6 +45,7 @@ import { DEFAULT_WATCH_THROTTLE_MS, WatchCompatibleQuery } from './watched/Watch
 import { OnChangeQueryProcessor } from './watched/processors/OnChangeQueryProcessor.js';
 import { WatchedQueryComparator } from './watched/processors/comparators.js';
 import { Mutex } from '../utils/mutex.js';
+import { createPowerSyncLogger, LogLevels, PowerSyncLogger } from '../utils/Logger.js';
 
 export interface DisconnectAndClearOptions {
   /** When set to false, data in local-only tables is preserved. */
@@ -59,7 +59,7 @@ export interface BasePowerSyncDatabaseOptions extends AdditionalConnectionOption
    * @deprecated Use {@link retryDelayMs} instead as this will be removed in future releases.
    */
   retryDelay?: number;
-  logger?: ILogger;
+  logger?: PowerSyncLogger;
 }
 
 export interface PowerSyncDatabaseOptions extends BasePowerSyncDatabaseOptions {
@@ -225,7 +225,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
   readonly triggers: TriggerManager;
   protected triggersImpl: TriggerManagerImpl;
 
-  logger: ILogger;
+  logger: PowerSyncLogger;
 
   constructor(options: PowerSyncDatabaseOptionsWithDBAdapter);
   constructor(options: PowerSyncDatabaseOptionsWithOpenFactory);
@@ -250,7 +250,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
       throw new Error('The provided `database` option is invalid.');
     }
 
-    this.logger = options.logger ?? Logger.get(`PowerSyncDatabase[${this._database.name}]`);
+    this.logger = options.logger ?? createPowerSyncLogger({ prefix: `PowerSyncDatabase[${this._database.name}]` });
 
     this.bucketStorageAdapter = this.generateBucketStorageAdapter();
     this.closed = false;
@@ -495,7 +495,7 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     try {
       schema.validate();
     } catch (ex) {
-      this.logger.warn('Schema validation failed. Unexpected behaviour could occur', ex);
+      this.logger.log(LogLevels.warn, 'Schema validation failed. Unexpected behaviour could occur', ex);
     }
     this._schema = schema;
 
@@ -1079,7 +1079,7 @@ SELECT * FROM crud_entries;
    * @param options Options for configuring watch behavior
    */
   watchWithCallback(sql: string, parameters?: any[], handler?: WatchHandler, options?: SQLWatchOptions): void {
-    const { onResult, onError = (e: Error) => this.logger.error(e) } = handler ?? {};
+    const { onResult, onError = (e: Error) => this.logger.log(LogLevels.error, e) } = handler ?? {};
     if (!onResult) {
       throw new Error('onResult is required');
     }
@@ -1240,7 +1240,7 @@ SELECT * FROM crud_entries;
    * @returns A dispose function to stop watching for changes
    */
   onChangeWithCallback(handler?: WatchOnChangeHandler, options?: SQLOnChangeOptions): () => void {
-    const { onChange, onError = (e: Error) => this.logger.error(e) } = handler ?? {};
+    const { onChange, onError = (e: Error) => this.logger.log(LogLevels.error, e) } = handler ?? {};
     if (!onChange) {
       throw new Error('onChange is required');
     }

packages/common/src/client/AbstractPowerSyncOpenFactory.ts

@@ -1,4 +1,4 @@
-import Logger from 'js-logger';
+import { createPowerSyncLogger } from '../utils/Logger.js';
 import { DBAdapter } from '../db/DBAdapter.js';
 import { Schema } from '../db/schema/Schema.js';
 import { AbstractPowerSyncDatabase, PowerSyncDatabaseOptions } from './AbstractPowerSyncDatabase.js';
@@ -11,7 +11,7 @@ export interface PowerSyncOpenFactoryOptions extends Partial<PowerSyncDatabaseOp
 
 export abstract class AbstractPowerSyncDatabaseOpenFactory {
   constructor(protected options: PowerSyncOpenFactoryOptions) {
-    options.logger = options.logger ?? Logger.get(`PowerSync ${this.options.dbFilename}`);
+    options.logger = options.logger ?? createPowerSyncLogger({ prefix: `PowerSync ${this.options.dbFilename}` });
   }
 
   /**

packages/common/src/client/ConnectionManager.ts

@@ -1,4 +1,4 @@
-import { ILogger } from 'js-logger';
+import { LogLevels, PowerSyncLogger } from '../utils/Logger.js';
 import { SyncStatus } from '../db/crud/SyncStatus.js';
 import { BaseListener, BaseObserver } from '../utils/BaseObserver.js';
 import { PowerSyncBackendConnector } from './connection/PowerSyncBackendConnector.js';
@@ -51,7 +51,7 @@ export interface ConnectionManagerOptions {
     options: CreateSyncImplementationOptions
   ): Promise<ConnectionManagerSyncImplementationResult>;
 
-  logger: ILogger;
+  logger: PowerSyncLogger;
 }
 
 type StoredConnectionOptions = {
@@ -194,7 +194,10 @@ export class ConnectionManager extends BaseObserver<ConnectionManagerListener> {
     this.syncStreamInitPromise = new Promise(async (resolve, reject) => {
       try {
         if (!this.pendingConnectionOptions) {
-          this.logger.debug('No pending connection options found, not creating sync stream implementation');
+          this.logger.log(
+            LogLevels.debug,
+            'No pending connection options found, not creating sync stream implementation'
+          );
           // A disconnect could have cleared this.
           resolve();
           return;
@@ -236,7 +239,7 @@ export class ConnectionManager extends BaseObserver<ConnectionManagerListener> {
     // and this point. Awaiting here allows the sync stream to be cleared if disconnected.
     await this.disconnectingPromise;
 
-    this.logger.debug('Attempting to connect to PowerSync instance');
+    this.logger.log(LogLevels.debug, 'Attempting to connect to PowerSync instance');
     await this.syncStreamImplementation?.connect(appliedOptions!);
   }
 
@@ -350,7 +353,7 @@ class ActiveSubscription {
   constructor(
     readonly name: string,
     readonly parameters: Record<string, any> | null,
-    readonly logger: ILogger,
+    readonly logger: PowerSyncLogger,
     readonly waitForFirstSync: (abort?: AbortSignal) => Promise<void>,
     private clearSubscription: () => void
   ) {}
@@ -395,7 +398,8 @@ class SyncStreamSubscriptionHandle implements SyncStreamSubscription {
 const _finalizer =
   'FinalizationRegistry' in globalThis
     ? new FinalizationRegistry<ActiveSubscription>((sub) => {
-        sub.logger.warn(
+        sub.logger.log(
+          LogLevels.warn,
           `A subscription to ${sub.name} with params ${JSON.stringify(sub.parameters)} leaked! Please ensure calling unsubscribe() when you don't need a subscription anymore. For global subscriptions, consider storing them in global fields to avoid this warning.`
         );
       })

packages/common/src/client/sync/bucket/SqliteBucketStorage.ts

@@ -1,4 +1,4 @@
-import Logger, { ILogger } from 'js-logger';
+import { LogLevels, PowerSyncLogger } from '../../../utils/Logger.js';
 import { DBAdapter, extractTableUpdates, Transaction } from '../../../db/DBAdapter.js';
 import { BaseObserver } from '../../../utils/BaseObserver.js';
 import { MAX_OP_ID } from '../../constants.js';
@@ -18,7 +18,7 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
 
   constructor(
     private db: DBAdapter,
-    private logger: ILogger = Logger.get('SqliteBucketStorage')
+    private logger: PowerSyncLogger
   ) {
     super();
     this.tableNames = new Set();
@@ -84,7 +84,10 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
       const anyData = await tx.execute('SELECT 1 FROM ps_crud LIMIT 1');
       if (anyData.rows?.length) {
         // if isNotEmpty
-        this.logger.debug(`New data uploaded since write checkpoint ${opId} - need new write checkpoint`);
+        this.logger.log(
+          LogLevels.debug,
+          `New data uploaded since write checkpoint ${opId} - need new write checkpoint`
+        );
         return false;
       }
 
@@ -96,15 +99,16 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
 
       const seqAfter: number = rs.rows?.item(0)['seq'];
       if (seqAfter != seqBefore) {
-        this.logger.debug(
+        this.logger.log(
+          LogLevels.debug,
           `New data uploaded since write checpoint ${opId} - need new write checkpoint (sequence updated)`
         );
 
         // New crud data may have been uploaded since we got the checkpoint. Abort.
         return false;
       }
 
-      this.logger.debug(`Updating target write checkpoint to ${opId}`);
+      this.logger.log(LogLevels.debug, `Updating target write checkpoint to ${opId}`);
       await tx.execute("UPDATE ps_buckets SET target_op = CAST(? as INTEGER) WHERE name='$local'", [opId]);
       return true;
     });