feat: Logger API/Helpers (#570)

Author: Chriztiaan

.changeset/giant-moose-crash.md

@@ -0,0 +1,5 @@
+---
+'@powersync/web': minor
+---
+
+Removed `js-logger` dependency, using the logger helper exposed by `@powersync/common`.

.changeset/lemon-shrimps-pretend.md

@@ -0,0 +1,5 @@
+---
+'@powersync/common': minor
+---
+
+Added logger helpers, which can be used instead of the `js-logger` dependency.

packages/common/rollup.config.mjs

@@ -32,9 +32,7 @@ export default (commandLineArgs) => {
     // This makes life easier
     external: [
       // This has dynamic logic - makes bundling hard
-      'cross-fetch',
-      // TODO: make the useDefaults logic better. Currently need access to this package directly
-      'js-logger'
+      'cross-fetch'
     ]
   };
 };

packages/common/src/index.ts

@@ -34,6 +34,7 @@ export * from './db/DBAdapter.js';
 export * from './utils/AbortOperation.js';
 export * from './utils/BaseObserver.js';
 export * from './utils/DataStream.js';
+export * from './utils/Logger.js';
 export * from './utils/parseQuery.js';
 
 export * from './types/types.js';

packages/common/src/utils/Logger.ts

@@ -0,0 +1,47 @@
+import Logger, { type ILogger, type ILogLevel } from 'js-logger';
+
+export { GlobalLogger, ILogger, ILoggerOpts, ILogHandler, ILogLevel } from 'js-logger';
+
+const TypedLogger: ILogger = Logger as any;
+
+export const LogLevel = {
+  TRACE: TypedLogger.TRACE,
+  DEBUG: TypedLogger.DEBUG,
+  INFO: TypedLogger.INFO,
+  TIME: TypedLogger.TIME,
+  WARN: TypedLogger.WARN,
+  ERROR: TypedLogger.ERROR,
+  OFF: TypedLogger.OFF
+};
+
+export interface CreateLoggerOptions {
+  logLevel?: ILogLevel;
+}
+
+/**
+ * Retrieves the base (default) logger instance.
+ *
+ * This base logger controls the default logging configuration and is shared
+ * across all loggers created with `createLogger`. Adjusting settings on this
+ * base logger affects all loggers derived from it unless explicitly overridden.
+ *
+ */
+export function createBaseLogger() {
+  return Logger;
+}
+
+/**
+ * Creates and configures a new named logger based on the base logger.
+ *
+ * Named loggers allow specific modules or areas of your application to have
+ * their own logging levels and behaviors. These loggers inherit configuration
+ * from the base logger by default but can override settings independently.
+ */
+export function createLogger(name: string, options: CreateLoggerOptions = {}): ILogger {
+  const logger = Logger.get(name);
+  if (options.logLevel) {
+    logger.setLevel(options.logLevel);
+  }
+
+  return logger;
+}

packages/web/package.json

@@ -68,8 +68,7 @@
     "async-mutex": "^0.4.0",
     "bson": "^6.6.0",
     "comlink": "^4.4.2",
-    "commander": "^12.1.0",
-    "js-logger": "^1.6.1"
+    "commander": "^12.1.0"
   },
   "devDependencies": {
     "@journeyapps/wa-sqlite": "^1.2.2",

packages/web/src/db/adapters/AbstractWebSQLOpenFactory.ts

@@ -1,5 +1,4 @@
-import { DBAdapter, SQLOpenFactory } from '@powersync/common';
-import Logger, { ILogger } from 'js-logger';
+import { type ILogger, createLogger, DBAdapter, SQLOpenFactory } from '@powersync/common';
 import { SSRDBAdapter } from './SSRDBAdapter';
 import { ResolvedWebSQLFlags, WebSQLOpenFactoryOptions, isServerSide, resolveWebSQLFlags } from './web-sql-flags';
 
@@ -9,7 +8,7 @@ export abstract class AbstractWebSQLOpenFactory implements SQLOpenFactory {
 
   constructor(protected options: WebSQLOpenFactoryOptions) {
     this.resolvedFlags = resolveWebSQLFlags(options.flags);
-    this.logger = options.logger ?? Logger.get(`AbstractWebSQLOpenFactory - ${this.options.dbFilename}`);
+    this.logger = options.logger ?? createLogger(`AbstractWebSQLOpenFactory - ${this.options.dbFilename}`);
   }
 
   /**

packages/web/src/db/adapters/LockedAsyncDatabaseAdapter.ts

@@ -1,5 +1,7 @@
 import {
+  type ILogger,
   BaseObserver,
+  createLogger,
   DBAdapter,
   DBAdapterListener,
   DBGetUtils,
@@ -8,7 +10,6 @@ import {
   QueryResult,
   Transaction
 } from '@powersync/common';
-import Logger, { ILogger } from 'js-logger';
 import { getNavigatorLocks } from '../..//shared/navigator';
 import { AsyncDatabaseConnection } from './AsyncDatabaseConnection';
 import { SharedConnectionWorker, WebDBAdapter } from './WebDBAdapter';
@@ -50,7 +51,7 @@ export class LockedAsyncDatabaseAdapter
   constructor(protected options: LockedAsyncDatabaseAdapterOptions) {
     super();
     this._dbIdentifier = options.name;
-    this.logger = options.logger ?? Logger.get(`LockedAsyncDatabaseAdapter - ${this._dbIdentifier}`);
+    this.logger = options.logger ?? createLogger(`LockedAsyncDatabaseAdapter - ${this._dbIdentifier}`);
     // Set the name if provided. We can query for the name if not available yet
     this.debugMode = options.debugMode ?? false;
     if (this.debugMode) {

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

@@ -1,5 +1,4 @@
-import { SQLOpenOptions } from '@powersync/common';
-import { ILogger } from 'js-logger';
+import { type ILogger, SQLOpenOptions } from '@powersync/common';
 
 /**
  * Common settings used when creating SQL connections on web.

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

@@ -1,12 +1,11 @@
-import { type ILogger } from 'js-logger';
-
 import {
   AbstractRemote,
   AbstractRemoteOptions,
   BSONImplementation,
   DEFAULT_REMOTE_LOGGER,
   FetchImplementation,
   FetchImplementationProvider,
+  ILogger,
   RemoteConnector
 } from '@powersync/common';