Pass in a logger instead of LogType.

Author: rkistner

demos/supabase-todolist/lib/powersync.dart

@@ -151,7 +151,8 @@ Future<String> getDatabasePath() async {
 
 Future<void> openDatabase() async {
   // Open the local database
-  db = PowerSyncDatabase(schema: schema, path: await getDatabasePath());
+  db = PowerSyncDatabase(
+      schema: schema, path: await getDatabasePath(), logger: attachedLogger);
   await db.initialize();
 
   await loadSupabase();

packages/powersync/lib/powersync.dart

@@ -10,3 +10,4 @@ export 'src/crud.dart';
 export 'src/sync_status.dart';
 export 'src/uuid.dart';
 export 'src/open_factory.dart';
+export 'src/log.dart' show attachedLogger, autoLogger, debugLogger;

packages/powersync/lib/src/log.dart

@@ -5,4 +5,46 @@ const bool kReleaseMode = bool.fromEnvironment('dart.vm.product');
 const bool kProfileMode = bool.fromEnvironment('dart.vm.profile');
 const bool kDebugMode = !kReleaseMode && !kProfileMode;
 
+// Implementation note: The loggers here are only initialized if used - it adds
+// no overhead when not used in the client app.
+
 final isolateLogger = Logger.detached('PowerSync');
+
+/// Logger that outputs to the console in debug mode, and nothing
+/// in release and profile modes.
+final Logger autoLogger = _makeAutoLogger();
+
+/// Logger that always outputs debug info to the console.
+final Logger debugLogger = _makeDebugLogger();
+
+/// Standard logger. Does not automatically log to the console,
+/// use the `Logger.root.onRecord` stream to get log messages.
+final Logger attachedLogger = Logger('PowerSync');
+
+Logger _makeDebugLogger() {
+  // Use a detached logger to log directly to the console
+  final logger = Logger.detached('PowerSync');
+  logger.level = Level.FINE;
+  logger.onRecord.listen((record) {
+    print(
+        '[${record.loggerName}] ${record.level.name}: ${record.time}: ${record.message}');
+
+    if (record.error != null) {
+      print(record.error);
+    }
+    if (record.stackTrace != null) {
+      print(record.stackTrace);
+    }
+  });
+  return logger;
+}
+
+Logger _makeAutoLogger() {
+  if (kDebugMode) {
+    return _makeDebugLogger();
+  } else {
+    final logger = Logger.detached('PowerSync');
+    logger.level = Level.OFF;
+    return logger;
+  }
+}

packages/powersync/lib/src/powersync_database.dart

@@ -68,7 +68,11 @@ class PowerSyncDatabase with SqliteQueries implements SqliteConnection {
   /// null when disconnected, present when connecting or connected
   AbortController? _disconnecter;
 
-  /// The Logger internally used by this PowerSyncDatabase
+  /// The Logger used by this [PowerSyncDatabase].
+  ///
+  /// The default is [autoLogger], which logs to the console in debug builds.
+  /// Use [debugLogger] to always log to the console.
+  /// Use [attachedLogger] to propagate logs to [Logger.root] for custom logging.
   late final Logger logger;
 
   /// Open a [PowerSyncDatabase].
@@ -83,17 +87,20 @@ class PowerSyncDatabase with SqliteQueries implements SqliteConnection {
   /// from the last committed write transaction.
   ///
   /// A maximum of [maxReaders] concurrent read transactions are allowed.
+  ///
+  /// [logger] defaults to [autoLogger], which logs to the console in debug builds.
   factory PowerSyncDatabase(
       {required Schema schema,
       required String path,
       int maxReaders = SqliteDatabase.defaultMaxReaders,
-      LogType log = LogType.auto,
+      Logger? logger,
       @Deprecated("Use [PowerSyncDatabase.withFactory] instead")
       // ignore: deprecated_member_use_from_same_package
       SqliteConnectionSetup? sqliteSetup}) {
     // ignore: deprecated_member_use_from_same_package
     var factory = PowerSyncOpenFactory(path: path, sqliteSetup: sqliteSetup);
-    return PowerSyncDatabase.withFactory(factory, schema: schema, log: log);
+    return PowerSyncDatabase.withFactory(factory,
+        schema: schema, logger: logger);
   }
 
   /// Open a [PowerSyncDatabase] with a [PowerSyncOpenFactory].
@@ -102,53 +109,33 @@ class PowerSyncDatabase with SqliteQueries implements SqliteConnection {
   /// additional logic to run inside the database isolate before or after opening.
   ///
   /// Subclass [PowerSyncOpenFactory] to add custom logic to this process.
+  ///
+  /// [logger] defaults to [autoLogger], which logs to the console in debug builds.
   factory PowerSyncDatabase.withFactory(
     PowerSyncOpenFactory openFactory, {
     required Schema schema,
     int maxReaders = SqliteDatabase.defaultMaxReaders,
-    LogType log = LogType.auto,
+    Logger? logger,
   }) {
     final db = SqliteDatabase.withFactory(openFactory, maxReaders: maxReaders);
     return PowerSyncDatabase.withDatabase(
-        schema: schema, database: db, log: log);
+        schema: schema, database: db, logger: logger);
   }
 
   /// Open a PowerSyncDatabase on an existing [SqliteDatabase].
   ///
   /// Migrations are run on the database when this constructor is called.
+  ///
+  /// [logger] defaults to [autoLogger], which logs to the console in debug builds.
   PowerSyncDatabase.withDatabase({
     required this.schema,
     required this.database,
-    LogType log = LogType.auto,
+    Logger? logger,
   }) {
-    if (log == LogType.debug || log == LogType.auto) {
-      // Use a detached logger to log directly to the console
-      logger = Logger.detached('PowerSync');
-
-      final debug = log == LogType.debug || kDebugMode;
-      if (debug) {
-        logger.level = Level.FINE;
-        logger.onRecord.listen((record) {
-          print(
-              '[${record.loggerName}] ${record.level.name}: ${record.time}: ${record.message}');
-
-          if (record.error != null) {
-            print(record.error);
-          }
-          if (record.stackTrace != null) {
-            print(record.stackTrace);
-          }
-        });
-      } else {
-        logger.level = Level.OFF;
-      }
-    } else if (log == LogType.logger) {
-      // Standard logger. The app is responsible for adding an onRecord listener
-      // on the root logger.
-      logger = Logger('PowerSync');
+    if (logger != null) {
+      this.logger = logger;
     } else {
-      // Should not happen
-      logger = Logger.detached('PowerSync');
+      this.logger = autoLogger;
     }
 
     updates = database.updates
@@ -643,15 +630,3 @@ Future<void> _powerSyncDatabaseIsolate(
     throw error;
   });
 }
-
-enum LogType {
-  /// Log to the console, with FINE level in debug mode, no logs in release mode
-  auto,
-
-  /// Always log to the console with FINE level
-  debug,
-
-  /// Uses a Logger instance.
-  /// Use Logger.root.onRecord to handle log messages
-  logger,
-}

packages/powersync/test/bucket_storage_test.dart

@@ -38,8 +38,6 @@ const removeAsset1_5 = OplogEntry(
     opId: '5', op: OpType.remove, rowType: 'assets', rowId: 'O1', checksum: 5);
 
 void main() {
-  setupLogger();
-
   group('Bucket Storage Tests', () {
     late PowerSyncDatabase powersync;
     late sqlite.Database db;

packages/powersync/test/crud_test.dart

@@ -7,8 +7,6 @@ import 'util.dart';
 const testId = "2290de4f-0488-4e50-abed-f8e8eb1d0b42";
 
 void main() {
-  setupLogger();
-
   group('CRUD Tests', () {
     late PowerSyncDatabase powersync;
     late String path;

packages/powersync/test/offline_online_test.dart

@@ -68,8 +68,6 @@ Schema makeSchema(bool online) {
 }
 
 void main() {
-  setupLogger();
-
   group('Offline-online Tests', () {
     late String path;
 

packages/powersync/test/performance_test.dart

@@ -18,8 +18,6 @@ const pschema = Schema([
 ]);
 
 void main() {
-  setupLogger();
-
   group('Performance Tests', () {
     late String path;
 

packages/powersync/test/powersync_test.dart

@@ -8,8 +8,6 @@ import 'package:sqlite_async/sqlite3.dart' as sqlite;
 import 'util.dart';
 
 void main() {
-  setupLogger();
-
   group('Basic Tests', () {
     late String path;
 

packages/powersync/test/stream_test.dart

@@ -6,11 +6,7 @@ import 'package:http/http.dart';
 import 'package:powersync/src/stream_utils.dart';
 import 'package:test/test.dart';
 
-import 'util.dart';
-
 void main() {
-  setupLogger();
-
   group('Stream Tests', () {
     setUp(() async {});