Simplify logger design

Author: simolus3

packages/adapter-sql-js/src/SQLJSAdapter.ts

@@ -123,10 +123,10 @@ class SqlJsConnectionPool extends BaseObserver<DBAdapterListener> implements Con
     const SQL = await SQLJs({
       locateFile: (filename: any) => `../dist/${filename}`,
       print: (text) => {
-        this.options.logger.log(LogLevels.info, text);
+        this.options.logger.log({ level: LogLevels.info, message: text });
       },
       printErr: (text) => {
-        this.options.logger.log(LogLevels.error, '[stderr]', text);
+        this.options.logger.log({ level: LogLevels.error, message: `[stderr]: ${text}` });
       }
     });
     const existing = await this.options.persister?.readFile();

packages/attachments/src/AbstractAttachmentQueue.ts

@@ -127,7 +127,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
   async watchAttachmentIds() {
     this.onAttachmentIdsChange(async (ids) => {
       const _ids = `${ids.map((id) => `'${id}'`).join(',')}`;
-      this.logger.log(LogLevels.debug, `Queuing for sync, attachment IDs: [${_ids}]`);
+      this.logger.log({ level: LogLevels.debug, message: `Queuing for sync, attachment IDs: [${_ids}]` });
 
       if (this.initialSync) {
         this.initialSync = false;
@@ -155,14 +155,17 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
             id: id,
             state: AttachmentState.QUEUED_SYNC
           });
-          this.logger.log(LogLevels.debug, `Attachment (${id}) not found in database, creating new record`);
+          this.logger.log({
+            level: LogLevels.debug,
+            message: `Attachment (${id}) not found in database, creating new record`
+          });
           await this.saveToQueue(newRecord);
         } else if (record.local_uri == null || !(await this.storage.fileExists(this.getLocalUri(record.local_uri)))) {
           // 2. Attachment in database but no local file, mark as queued download
-          this.logger.log(
-            LogLevels.debug,
-            `Attachment (${id}) found in database but no local file, marking as queued download`
-          );
+          this.logger.log({
+            level: LogLevels.debug,
+            message: `Attachment (${id}) found in database but no local file, marking as queued download`
+          });
           await this.update({
             ...record,
             state: AttachmentState.QUEUED_DOWNLOAD
@@ -247,8 +250,8 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
       await this.storage.deleteFile(localFilePathUri, {
         filename: record.filename
       });
-    } catch (e) {
-      this.logger.log(LogLevels.error, e);
+    } catch (error) {
+      this.logger.log({ level: LogLevels.error, message: 'Error deleting attachment', error });
     }
   }
 
@@ -274,7 +277,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
     const localFilePathUri = this.getLocalUri(record.local_uri);
     try {
       if (!(await this.storage.fileExists(localFilePathUri))) {
-        this.logger.log(LogLevels.warn, `File for ${record.id} does not exist, skipping upload`);
+        this.logger.log({ level: LogLevels.warn, message: `File for ${record.id} does not exist, skipping upload` });
         await this.update({
           ...record,
           state: AttachmentState.QUEUED_DOWNLOAD
@@ -292,11 +295,11 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
       });
       // Mark as uploaded
       await this.update({ ...record, state: AttachmentState.SYNCED });
-      this.logger.log(LogLevels.debug, `Uploaded attachment "${record.id}" to Cloud Storage`);
+      this.logger.log({ level: LogLevels.debug, message: `Uploaded attachment "${record.id}" to Cloud Storage` });
       return true;
     } catch (e: any) {
       if (e.error == 'Duplicate') {
-        this.logger.log(LogLevels.debug, `File already uploaded, marking ${record.id} as synced`);
+        this.logger.log({ level: LogLevels.debug, message: `File already uploaded, marking ${record.id} as synced` });
         await this.update({ ...record, state: AttachmentState.SYNCED });
         return false;
       }
@@ -307,7 +310,10 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
           return true;
         }
       }
-      this.logger.log(LogLevels.error, `UploadAttachment error for record ${JSON.stringify(record, null, 2)}`);
+      this.logger.log({
+        level: LogLevels.error,
+        message: `UploadAttachment error for record ${JSON.stringify(record, null, 2)}`
+      });
       return false;
     }
   }
@@ -321,7 +327,10 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
     }
     const localFilePathUri = this.getLocalUri(record.local_uri);
     if (await this.storage.fileExists(localFilePathUri)) {
-      this.logger.log(LogLevels.debug, `Local file already downloaded, marking "${record.id}" as synced`);
+      this.logger.log({
+        level: LogLevels.debug,
+        message: `Local file already downloaded, marking "${record.id}" as synced`
+      });
       await this.update({ ...record, state: AttachmentState.SYNCED });
       return true;
     }
@@ -352,7 +361,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
         media_type: fileBlob.type,
         state: AttachmentState.SYNCED
       });
-      this.logger.log(LogLevels.debug, `Downloaded attachment "${record.id}"`);
+      this.logger.log({ level: LogLevels.debug, message: `Downloaded attachment "${record.id}"` });
       return true;
     } catch (e) {
       if (this.options.onDownloadError) {
@@ -362,7 +371,11 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
           return true;
         }
       }
-      this.logger.log(LogLevels.error, `Download attachment error for record ${JSON.stringify(record, null, 2)}`, e);
+      this.logger.log({
+        level: LogLevels.error,
+        message: `Download attachment error for record ${JSON.stringify(record, null, 2)}`,
+        error: e
+      });
     }
     return false;
   }
@@ -403,7 +416,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
       if (!record) {
         return;
       }
-      this.logger.log(LogLevels.debug, `Uploading attachments...`);
+      this.logger.log({ level: LogLevels.debug, message: `Uploading attachments...` });
       while (record) {
         const uploaded = await this.uploadAttachment(record);
         if (!uploaded) {
@@ -412,9 +425,9 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
         }
         record = await this.getNextUploadRecord();
       }
-      this.logger.log(LogLevels.debug, 'Finished uploading attachments');
+      this.logger.log({ level: LogLevels.debug, message: 'Finished uploading attachments' });
     } catch (error) {
-      this.logger.log(LogLevels.error, 'Upload failed:', error);
+      this.logger.log({ level: LogLevels.error, message: 'Upload failed:', error });
     } finally {
       this.uploading = false;
     }
@@ -471,7 +484,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
 
     this.downloading = true;
     try {
-      this.logger.log(LogLevels.debug, `Downloading ${this.downloadQueue.size} attachments...`);
+      this.logger.log({ level: LogLevels.debug, message: `Downloading ${this.downloadQueue.size} attachments...` });
       while (this.downloadQueue.size > 0) {
         const id = this.downloadQueue.values().next().value;
         this.downloadQueue.delete(id);
@@ -481,9 +494,9 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
         }
         await this.downloadRecord(record);
       }
-      this.logger.log(LogLevels.debug, 'Finished downloading attachments');
-    } catch (e) {
-      this.logger.log(LogLevels.error, 'Downloads failed:', e);
+      this.logger.log({ level: LogLevels.debug, message: 'Finished downloading attachments' });
+    } catch (error) {
+      this.logger.log({ level: LogLevels.error, message: 'Downloads failed:', error });
     } finally {
       this.downloading = false;
     }
@@ -525,7 +538,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
       return;
     }
 
-    this.logger.log(LogLevels.debug, `Deleting ${res.length} attachments from cache...`);
+    this.logger.log({ level: LogLevels.debug, message: `Deleting ${res.length} attachments from cache...` });
     await this.powersync.writeTransaction(async (tx) => {
       for (const record of res) {
         await this.delete(record, tx);
@@ -534,7 +547,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
   }
 
   async clearQueue(): Promise<void> {
-    this.logger.log(LogLevels.debug, `Clearing attachment queue...`);
+    this.logger.log({ level: LogLevels.debug, message: `Clearing attachment queue...` });
     await this.powersync.writeTransaction(async (tx) => {
       await tx.execute(`DELETE FROM ${this.table}`);
     });

packages/capacitor/src/PowerSyncDatabase.ts

@@ -38,10 +38,10 @@ export class PowerSyncDatabase extends WebPowerSyncDatabase {
       ? SyncStreamConnectionMethod.HTTP
       : DEFAULT_STREAM_CONNECTION_OPTIONS.connectionMethod;
     if (options?.connectionMethod == SyncStreamConnectionMethod.WEB_SOCKET && isUsingCapacitorDriver) {
-      this.logger.log(
-        LogLevels.warn,
-        `Connecting via 'SyncStreamConnectionMethod.WEB_SOCKET' when using the 'CapacitorSQLiteAdapter' will result in poor sync performance. Use 'SyncStreamConnectionMethod.HTTP' (the default for native) instead.`
-      );
+      this.logger.log({
+        level: LogLevels.warn,
+        message: `Connecting via 'SyncStreamConnectionMethod.WEB_SOCKET' when using the 'CapacitorSQLiteAdapter' will result in poor sync performance. Use 'SyncStreamConnectionMethod.HTTP' (the default for native) instead.`
+      });
     }
 
     return super.connect(connector, {
@@ -59,20 +59,23 @@ export class PowerSyncDatabase extends WebPowerSyncDatabase {
     const platform = Capacitor.getPlatform();
     if (platform == 'ios' || platform == 'android') {
       if (options.database.dbLocation) {
-        options.logger?.log(
-          LogLevels.warn,
-          `
+        options.logger?.log({
+          level: LogLevels.warn,
+          message: `
           dbLocation is ignored on iOS and Android platforms. 
           The database directory can be configured in the Capacitor project.
           See https://github.com/capacitor-community/sqlite?tab=readme-ov-file#installation`
-        );
+        });
       }
-      options.logger?.log(LogLevels.debug, `Using CapacitorSQLiteAdapter for platform: ${platform}`);
+      options.logger?.log({
+        level: LogLevels.debug,
+        message: `Using CapacitorSQLiteAdapter for platform: ${platform}`
+      });
       return new CapacitorSQLiteAdapter({
         ...options.database
       });
     } else {
-      options.logger?.log(LogLevels.debug, `Using default web adapter for web platform`);
+      options.logger?.log({ level: LogLevels.debug, message: `Using default web adapter for web platform` });
       return super.openDBAdapter(options);
     }
   }
@@ -107,12 +110,12 @@ export class PowerSyncDatabase extends WebPowerSyncDatabase {
     if (this.isNativeCapacitorPlatform) {
       // We don't want to support multi-tab on mobile platforms.
       // We technically can, but it's not a common use case and requires additional work/testing.
-      this.logger.log(LogLevels.debug, `Using Capacitor sync implementation`);
+      this.logger.log({ level: LogLevels.debug, message: `Using Capacitor sync implementation` });
       if (this.options.flags?.enableMultiTabs) {
-        this.logger.log(
-          LogLevels.warn,
-          `enableMultiTabs is not supported on Capacitor mobile platforms. Ignoring the flag.`
-        );
+        this.logger.log({
+          level: LogLevels.warn,
+          message: `enableMultiTabs is not supported on Capacitor mobile platforms. Ignoring the flag.`
+        });
       }
 
       const remote = new CapacitorRemote(connector, this.logger);
@@ -132,7 +135,7 @@ export class PowerSyncDatabase extends WebPowerSyncDatabase {
         subscriptions: options.subscriptions
       });
     } else {
-      this.logger.log(LogLevels.debug, `Using default web sync implementation for web platform`);
+      this.logger.log({ level: LogLevels.debug, message: `Using default web sync implementation for web platform` });
       return super.generateSyncStreamImplementation(connector, options);
     }
   }

packages/common/src/attachments/AttachmentContext.ts

@@ -233,10 +233,10 @@ export class AttachmentContext {
     if (archivedAttachments.length === 0) return false;
 
     await callback?.(archivedAttachments);
-    this.logger.log(
-      LogLevels.info,
-      `Deleting ${archivedAttachments.length} archived attachments. Archived attachment exceeds cache archiveCacheLimit of ${this.archivedCacheLimit}.`
-    );
+    this.logger.log({
+      level: LogLevels.info,
+      message: `Deleting ${archivedAttachments.length} archived attachments. Archived attachment exceeds cache archiveCacheLimit of ${this.archivedCacheLimit}.`
+    });
 
     const ids = archivedAttachments.map((attachment) => attachment.id);
 
@@ -255,7 +255,7 @@ export class AttachmentContext {
       [JSON.stringify(ids)]
     );
 
-    this.logger.log(LogLevels.info, `Deleted ${archivedAttachments.length} archived attachments`);
+    this.logger.log({ level: LogLevels.info, message: `Deleted ${archivedAttachments.length} archived attachments` });
     return archivedAttachments.length < limit;
   }
 

packages/common/src/attachments/AttachmentQueue.ts

@@ -190,7 +190,7 @@ export class AttachmentQueue {
         if (status.connected) {
           // Device came online, process attachments immediately
           this.syncStorage().catch((error) => {
-            this.logger.log(LogLevels.error, 'Error syncing storage on connection:', error);
+            this.logger.log({ level: LogLevels.error, message: 'Error syncing storage on connection:', error });
           });
         }
       }

packages/common/src/attachments/AttachmentService.ts

@@ -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.log(LogLevels.info, 'Watching active attachments...');
+    this.logger.log({ level: LogLevels.info, message: 'Watching active attachments...' });
     const watch = this.db
       .query<AttachmentRecord>({
         sql: /* sql */ `

packages/common/src/attachments/SyncingService.ts

@@ -75,7 +75,7 @@ export class SyncingService {
    * @throws Error if the attachment has no localUri
    */
   async uploadAttachment(attachment: AttachmentRecord): Promise<AttachmentRecord> {
-    this.logger.log(LogLevels.info, `Uploading attachment ${attachment.filename}`);
+    this.logger.log({ level: LogLevels.info, message: `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.log(LogLevels.info, `Downloading attachment ${attachment.filename}`);
+    this.logger.log({ level: LogLevels.info, message: `Downloading attachment ${attachment.filename}` });
     try {
       const fileData = await this.remoteStorage.downloadFile(attachment);
 
@@ -183,7 +183,11 @@ export class SyncingService {
           try {
             await this.localStorage.deleteFile(attachment.localUri);
           } catch (error) {
-            this.logger.log(LogLevels.error, 'Error deleting local file for archived attachment', error);
+            this.logger.log({
+              level: LogLevels.error,
+              message: 'Error deleting local file for archived attachment',
+              error
+            });
           }
         }
       }

packages/common/src/client/AbstractPowerSyncDatabase.ts

@@ -495,7 +495,11 @@ export abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDB
     try {
       schema.validate();
     } catch (ex) {
-      this.logger.log(LogLevels.warn, 'Schema validation failed. Unexpected behaviour could occur', ex);
+      this.logger.log({
+        level: LogLevels.warn,
+        message: 'Schema validation failed. Unexpected behaviour could occur',
+        error: ex
+      });
     }
     this._schema = schema;
 
@@ -1079,7 +1083,10 @@ 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.log(LogLevels.error, e) } = handler ?? {};
+    const {
+      onResult,
+      onError = (e: Error) => this.logger.log({ level: LogLevels.error, message: 'Error in watch', error: e })
+    } = handler ?? {};
     if (!onResult) {
       throw new Error('onResult is required');
     }
@@ -1240,7 +1247,10 @@ 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.log(LogLevels.error, e) } = handler ?? {};
+    const {
+      onChange,
+      onError = (e: Error) => this.logger.log({ level: LogLevels.error, message: 'error in onChange', error: e })
+    } = handler ?? {};
     if (!onChange) {
       throw new Error('onChange is required');
     }