Merge pull request #260 from relaystr/copilot/create-custom-modular-logger

Replace logger package with custom WASM-compatible modular logger

Author: 1-leo

packages/isar/pubspec.lock

@@ -329,14 +329,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "5.1.0"
-  logger:
-    dependency: transitive
-    description:
-      name: logger
-      sha256: a7967e31b703831a893bbc3c3dd11db08126fe5f369b5c648a36f821979f5be3
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.6.2"
   logging:
     dependency: transitive
     description:

packages/ndk/example/nwc/get_balance.dart

@@ -3,14 +3,13 @@
 import 'dart:io';
 
 import 'package:ndk/ndk.dart';
-import 'package:logger/logger.dart' as lib_logger;
 
 void main() async {
   // We use an empty bootstrap relay list,
   // since NWC will provide the relay we connect to so we don't need default relays
   final ndk = Ndk.emptyBootstrapRelaysConfig();
 
-  Logger.setLogLevel(lib_logger.Level.warning);
+  Logger.setLogLevel(LogLevel.warning);
 
   // You need an NWC_URI env var or to replace with your NWC uri connection
   final nwcUri = Platform.environment['NWC_URI']!;

packages/ndk/example/nwc/get_budget.dart

@@ -4,14 +4,13 @@ import 'dart:io';
 
 import 'package:ndk/domain_layer/usecases/nwc/responses/get_budget_response.dart';
 import 'package:ndk/ndk.dart';
-import 'package:logger/logger.dart' as lib_logger;
 
 void main() async {
   // We use an empty bootstrap relay list,
   // since NWC will provide the relay we connect to so we don't need default relays
   final ndk = Ndk.emptyBootstrapRelaysConfig();
 
-  Logger.setLogLevel(lib_logger.Level.warning);
+  Logger.setLogLevel(LogLevel.warning);
 
   // You need an NWC_URI env var or to replace with your NWC uri connection
   final nwcUri = Platform.environment['NWC_URI']!;

packages/ndk/lib/config/logger_defaults.dart

@@ -1,4 +1,4 @@
-import 'package:logger/logger.dart' as lib_logger;
+import '../shared/logger/log_level.dart';
 
 /// The default log level for the logger.
-const defaultLogLevel = lib_logger.Level.warning;
+const defaultLogLevel = LogLevel.warning;

packages/ndk/lib/ndk.dart

@@ -88,6 +88,10 @@ export 'domain_layer/usecases/bunkers/models/nostr_connect.dart';
  */
 
 export 'shared/logger/logger.dart';
+export 'shared/logger/log_level.dart';
+export 'shared/logger/log_output.dart';
+export 'shared/logger/ndk_logger.dart';
+export 'shared/logger/console_output.dart';
 
 /**
  * event filters

packages/ndk/lib/presentation_layer/ndk_config.dart

@@ -6,7 +6,7 @@ import '../config/request_defaults.dart';
 import '../domain_layer/entities/event_filter.dart';
 import '../domain_layer/repositories/cache_manager.dart';
 import '../domain_layer/repositories/event_verifier.dart';
-import 'package:logger/logger.dart' as lib_logger;
+import '../shared/logger/log_level.dart';
 
 /// Configuration class for the Nostr Development Kit (NDK)
 ///
@@ -48,7 +48,7 @@ class NdkConfig {
   double defaultBroadcastConsiderDonePercent;
 
   /// log level
-  lib_logger.Level logLevel;
+  LogLevel logLevel;
 
   /// User agent string for Http requests and websockets.
   String userAgent;

packages/ndk/lib/shared/logger/README.md

@@ -0,0 +1,147 @@
+# NDK Custom Logger
+
+The NDK now uses a custom, modular logger implementation that is WASM-compatible (no `dart:io` dependency).
+
+## Features
+
+- **WASM Compatible**: No dependency on `dart:io`, making it suitable for web/WASM targets
+- **Modular Output System**: Support for multiple log outputs (console, file, network, etc.)
+- **Log Levels**: Support for trace, debug, info, warning, error, fatal, all, and off levels
+- **Flexible Configuration**: Easy to configure and customize
+
+## Usage
+
+### Basic Usage
+
+The logger is already configured and ready to use:
+
+```dart
+import 'package:ndk/ndk.dart';
+
+// Use the static logger instance
+Logger.log.d('Debug message');
+Logger.log.i('Info message');
+Logger.log.w('Warning message');
+Logger.log.e('Error message');
+```
+
+### Setting Log Level
+
+You can change the log level at runtime:
+
+```dart
+// Set to debug level
+Logger.setLogLevel(LogLevel.debug);
+
+// Or use the logLevels constants
+Logger.setLogLevel(Logger.logLevels.warning);
+```
+
+### Available Log Levels
+
+- `LogLevel.all` - Log everything (lowest priority)
+- `LogLevel.trace` - Very detailed debugging
+- `LogLevel.debug` - Debugging information
+- `LogLevel.info` - Informational messages
+- `LogLevel.warning` - Warning messages (default)
+- `LogLevel.error` - Error messages
+- `LogLevel.fatal` - Fatal error messages
+- `LogLevel.off` - Disable logging
+
+### Custom Log Outputs
+
+You can create custom log outputs by implementing the `LogOutput` interface:
+
+```dart
+import 'package:ndk/ndk.dart';
+
+class MyCustomOutput implements LogOutput {
+  @override
+  void output(LogEvent event) {
+    // Handle the log event
+    print('Custom: [${event.level.name}] ${event.message}');
+  }
+
+  @override
+  void destroy() {
+    // Cleanup when the logger is destroyed
+  }
+}
+
+// Add the custom output to the logger
+final customOutput = MyCustomOutput();
+Logger.log.addOutput(customOutput);
+
+// Now logs will go to both console and your custom output
+Logger.log.i('This goes to multiple outputs');
+
+// Remove when done
+Logger.log.removeOutput(customOutput);
+```
+
+### Multiple Outputs
+
+The logger supports sending logs to multiple outputs simultaneously:
+
+```dart
+// Add multiple outputs
+Logger.log.addOutput(fileOutput);
+Logger.log.addOutput(networkOutput);
+Logger.log.addOutput(customOutput);
+
+// Logs will be sent to console + all added outputs
+Logger.log.i('This goes everywhere!');
+```
+
+### Custom Logger Instance
+
+You can create custom logger instances for specific components:
+
+```dart
+final myLogger = NdkLogger(
+  level: LogLevel.info,
+  outputs: [
+    ConsoleOutput(includeTimestamp: true),
+    MyCustomOutput(),
+  ],
+);
+
+myLogger.i('Message from custom logger');
+```
+
+## Configuration via NdkConfig
+
+You can set the log level when initializing NDK:
+
+```dart
+final ndk = Ndk(NdkConfig(
+  cache: MemCacheManager(),
+  eventVerifier: Bip340EventVerifier(),
+  logLevel: LogLevel.debug,  // Set desired log level
+));
+```
+
+## Migration from logger package
+
+If you were using the `logger` package directly, update your code:
+
+**Before:**
+```dart
+import 'package:logger/logger.dart' as lib_logger;
+Logger.setLogLevel(lib_logger.Level.warning);
+```
+
+**After:**
+```dart
+import 'package:ndk/ndk.dart';
+Logger.setLogLevel(LogLevel.warning);
+```
+
+## Example
+
+See [example/logger_example.dart](../../example/logger_example.dart) for a complete example showing:
+- Basic usage
+- Custom outputs
+- Multiple outputs
+- Changing log levels
+- Custom logger instances

packages/ndk/lib/shared/logger/console_output.dart

@@ -0,0 +1,56 @@
+// coverage:ignore-file
+
+import 'log_event.dart';
+import 'log_output.dart';
+import 'log_color.dart';
+
+/// Console output with color support
+class ConsoleOutput extends LogOutput {
+  final bool useColors;
+  final bool showTime;
+  final bool detailedTime;
+
+  ConsoleOutput({
+    this.useColors = true,
+    this.showTime = true,
+    this.detailedTime = false,
+  });
+
+  @override
+  void output(LogEvent event) {
+    final levelStr = event.level.name.toUpperCase();
+
+    String timestamp = '';
+    if (showTime) {
+      if (detailedTime) {
+        timestamp = '${event.timestamp.toIso8601String()} ';
+      } else {
+        final hour = event.timestamp.hour.toString().padLeft(2, '0');
+        final minute = event.timestamp.minute.toString().padLeft(2, '0');
+        timestamp = '$hour:$minute ';
+      }
+    }
+
+    String message;
+    if (useColors) {
+      final coloredLevel = LogColor.colorizeLevel(event.level, '[$levelStr]');
+      message = '$timestamp$coloredLevel ${event.message}';
+    } else {
+      message = '$timestamp[$levelStr] ${event.message}';
+    }
+
+    if (event.error != null) {
+      message += '\nError: ${event.error}';
+    }
+    if (event.stackTrace != null) {
+      message += '\n${event.stackTrace}';
+    }
+
+    print(message);
+  }
+
+  @override
+  void destroy() {
+    // Nothing to cleanup for console output
+  }
+}

packages/ndk/lib/shared/logger/log_color.dart

@@ -0,0 +1,48 @@
+// coverage:ignore-file
+import 'log_level.dart';
+
+/// ANSI color codes for terminal output
+class LogColor {
+  static const String reset = '\x1B[0m';
+  static const String black = '\x1B[30m';
+  static const String red = '\x1B[31m';
+  static const String green = '\x1B[32m';
+  static const String yellow = '\x1B[33m';
+  static const String blue = '\x1B[34m';
+  static const String magenta = '\x1B[35m';
+  static const String cyan = '\x1B[36m';
+  static const String white = '\x1B[37m';
+  static const String gray = '\x1B[90m';
+
+  /// Get color for log level
+  static String forLevel(LogLevel level) {
+    switch (level) {
+      case LogLevel.trace:
+        return gray;
+      case LogLevel.debug:
+        return cyan;
+      case LogLevel.info:
+        return green;
+      case LogLevel.warning:
+        return yellow;
+      case LogLevel.error:
+        return red;
+      case LogLevel.fatal:
+        return magenta;
+      case LogLevel.all:
+        return blue;
+      case LogLevel.off:
+        return reset;
+    }
+  }
+
+  /// Wrap text with color
+  static String colorize(String text, String color) {
+    return '$color$text$reset';
+  }
+
+  /// Colorize message based on log level
+  static String colorizeLevel(LogLevel level, String text) {
+    return colorize(text, forLevel(level));
+  }
+}

packages/ndk/lib/shared/logger/log_event.dart

@@ -0,0 +1,27 @@
+import 'log_level.dart';
+
+/// A log event that contains the log level, message, and optional error/stacktrace.
+class LogEvent {
+  /// The log level
+  final LogLevel level;
+
+  /// The log message
+  final String message;
+
+  /// Optional error object
+  final Object? error;
+
+  /// Optional stack trace
+  final StackTrace? stackTrace;
+
+  /// Timestamp when the log was created
+  final DateTime timestamp;
+
+  /// Constructor
+  LogEvent({
+    required this.level,
+    required this.message,
+    this.error,
+    this.stackTrace,
+  }) : timestamp = DateTime.now();
+}