feat: ✨ Use Logging library.

Author: Chralu

.dart_tool/extension_discovery/vs_code.json

@@ -1 +1 @@
-{"version":2,"entries":[{"package":"archethic_dapp_framework_flutter","rootUri":"../","packageUri":"lib/"}]}
+{"version":2,"entries":[{"package":"archethic_dapp_framework_flutter","rootUri":"../","packageUri":"lib/"},{"package":"flutter_gen","rootUri":"flutter_gen/","packageUri":"flutter_gen/"}]}

.dart_tool/flutter_gen/gen_l10n/localizations-ae-dapp-framework.dart

@@ -8,6 +8,8 @@ import 'package:intl/intl.dart' as intl;
 import 'localizations-ae-dapp-framework_en.dart';
 import 'localizations-ae-dapp-framework_fr.dart';
 
+// ignore_for_file: type=lint
+
 /// Callers can lookup localized strings with an instance of AppLocalizations
 /// returned by `AppLocalizations.of(context)`.
 ///

.dart_tool/flutter_gen/gen_l10n/localizations-ae-dapp-framework_en.dart

@@ -1,5 +1,7 @@
 import 'localizations-ae-dapp-framework.dart';
 
+// ignore_for_file: type=lint
+
 /// The translations for English (`en`).
 class AppLocalizationsEn extends AppLocalizations {
   AppLocalizationsEn([String locale = 'en']) : super(locale);

lib/archethic_dapp_framework_flutter.dart

@@ -75,6 +75,7 @@ export 'src/util/custom_logs.dart';
 export 'src/util/file_util.dart';
 export 'src/util/generic/get_it_instance.dart';
 export 'src/util/generic/providers_observer.dart';
+export 'src/util/logger_output.dart';
 export 'src/util/periodic_future.dart';
 export 'src/util/router_util.dart';
 export 'src/util/transaction_util.dart';

lib/src/util/custom_logs.dart

@@ -1,52 +1,54 @@
 /// SPDX-License-Identifier: AGPL-3.0-or-later
 import 'dart:async';
 import 'dart:convert';
-import 'dart:developer' as developer;
+
+import 'package:archethic_dapp_framework_flutter/src/util/logger_output.dart';
 import 'package:flutter/foundation.dart';
 import 'package:http/http.dart' as http;
+import 'package:logging/logging.dart';
 
+/// Logger which sends logs to grafana.
+///
+/// Grafana logs can be disabled using [remoteLogsEnabled] flag.
+/// Logs are sent to the server in batches of [batchSize] every [sendInterval].
+///
+/// Logs are sent to the standard output. Visible log level can be set using [LoggerOutput.setup].
 class LogManager {
   LogManager({
     required this.url,
     this.sendInterval = const Duration(seconds: 60),
     this.batchSize = 1,
-    this.logsActived = true,
+    this.remoteLogsEnabled = true,
   }) {
     if (!kDebugMode) {
       _timer = Timer.periodic(sendInterval, (Timer t) => _sendLogs());
     }
   }
   final Duration sendInterval;
   final int batchSize;
-  bool logsActived;
+  bool remoteLogsEnabled;
   List<Map<String, dynamic>> _logQueue = [];
   Timer? _timer;
   final String url;
 
   void log(
     String message, {
     String? name,
+    Object? error,
     StackTrace? stackTrace,
     LogLevel level = LogLevel.info,
   }) {
-    final timeStamp = DateTime.now().toIso8601String();
-    if (logsActived == false) return;
+    final _logger = Logger(name ?? 'ArchethicDApp');
+
     if (message.isEmpty) return;
-    if (kDebugMode) {
-      if (name != null) {
-        if (stackTrace != null) {
-          debugPrint('$timeStamp, $message, $name, $stackTrace');
-        } else {
-          debugPrint('$timeStamp, $message, $name');
-        }
-      } else {
-        if (stackTrace != null) {
-          debugPrint('$timeStamp, $message, $stackTrace');
-        } else {
-          debugPrint('$timeStamp, $message');
-        }
-      }
-    } else {
+    _logger.log(
+      level.toLogger,
+      message,
+      error,
+      stackTrace,
+    );
+    if (remoteLogsEnabled && !kDebugMode) {
+      final timeStamp = DateTime.now().toIso8601String();
       final logEntry = <String, dynamic>{
         'timestamp': timeStamp,
         'message': message,
@@ -64,6 +66,7 @@ class LogManager {
   Future<void> _sendLogs() async {
     if (_logQueue.isEmpty) return;
 
+    final _logger = Logger('ArchethicDAppLogger');
     try {
       final response = await http.post(
         Uri.parse(
@@ -75,12 +78,14 @@ class LogManager {
       if (response.statusCode == 200) {
         _logQueue = [];
       } else {
-        developer.log(
+        _logger.warning(
           'Failed to send logs to server, response status code: ${response.statusCode}',
         );
       }
     } catch (e) {
-      developer.log('Error sending logs to server: $e');
+      _logger.warning(
+        'Error sending logs to server: $e',
+      );
     }
   }
 
@@ -90,3 +95,18 @@ class LogManager {
 }
 
 enum LogLevel { debug, info, warning, error }
+
+extension _LogLevelToLoggerExt on LogLevel {
+  Level get toLogger {
+    switch (this) {
+      case LogLevel.debug:
+        return Level.FINE;
+      case LogLevel.info:
+        return Level.INFO;
+      case LogLevel.warning:
+        return Level.WARNING;
+      case LogLevel.error:
+        return Level.SEVERE;
+    }
+  }
+}

lib/src/util/generic/providers_observer.dart

@@ -1,20 +1,20 @@
-import 'dart:developer';
-
 import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:logging/logging.dart';
 
 class ProvidersLogger extends ProviderObserver {
-  ProvidersLogger({this.logger = true});
+  ProvidersLogger();
+
+  Logger _logger(ProviderBase<Object?> provider) => Logger(
+        '${provider.name ?? 'Provider'}<${provider.hashCode}>',
+      );
 
-  final bool logger;
   @override
   void didAddProvider(
     ProviderBase<Object?> provider,
     Object? value,
     ProviderContainer container,
   ) {
-    if (provider.name != null && logger) {
-      log('didAddProvider($value)', name: '${provider.name}');
-    }
+    _logger(provider).fine('didAddProvider($value)');
   }
 
   @override
@@ -24,9 +24,7 @@ class ProvidersLogger extends ProviderObserver {
     Object? newValue,
     ProviderContainer container,
   ) {
-    if (provider.name != null && logger) {
-      log('didUpdateProvider($newValue)', name: '${provider.name}');
-    }
+    _logger(provider).fine('didUpdateProvider($newValue)');
   }
 
   @override
@@ -36,15 +34,11 @@ class ProvidersLogger extends ProviderObserver {
     StackTrace stackTrace,
     ProviderContainer container,
   ) {
-    if (provider.name != null && logger) {
-      log('providerDidFail($error)', name: '${provider.name}');
-    }
+    _logger(provider).fine('providerDidFail($error)');
   }
 
   @override
   void didDisposeProvider(ProviderBase provider, ProviderContainer container) {
-    if (provider.name != null && logger) {
-      log('didDisposeProvider', name: '${provider.name}');
-    }
+    _logger(provider).fine('didDisposeProvider');
   }
 }

lib/src/util/logger_output.dart

@@ -0,0 +1,52 @@
+// ignore_for_file: avoid_print
+
+import 'dart:developer' as dev;
+
+import 'package:flutter/foundation.dart';
+import 'package:logging/logging.dart';
+
+/// [LoggerOutput] is used to fine tune log level sent to standard output.
+class LoggerOutput {
+  static void setup({Level? level}) {
+    Logger.root.level = level ?? (kDebugMode ? Level.ALL : Level.SEVERE);
+
+    /// Note : When in debug mode, logs are displayed
+    /// in debug console. There is no need to register log listeners.
+    if (!kDebugMode) {
+      _registerLogListeners();
+    }
+  }
+
+  static void _registerLogListeners() {
+    Logger.root.clearListeners();
+
+    if (kIsWeb) {
+      Logger.root.onRecord.listen((event) {
+        print(
+          '${event.time.toIso8601String()} [${event.loggerName}] ${event.message}',
+        );
+        if (event.error != null) {
+          print('\t${event.error}');
+        }
+        if (event.stackTrace != null) {
+          print('\t${event.stackTrace}');
+        }
+      });
+    }
+
+    if (!kIsWeb) {
+      Logger.root.onRecord.listen((event) {
+        dev.log(
+          event.message,
+          name: event.loggerName,
+          error: event.error,
+          stackTrace: event.stackTrace,
+          level: event.level.value,
+          time: event.time,
+          sequenceNumber: event.sequenceNumber,
+          zone: event.zone,
+        );
+      });
+    }
+  }
+}

pubspec.lock

@@ -580,18 +580,18 @@ packages:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
+      sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec
       url: "https://pub.dev"
     source: hosted
-    version: "0.8.0"
+    version: "0.11.1"
   meta:
     dependency: transitive
     description:
       name: meta
-      sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136"
+      sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
       url: "https://pub.dev"
     source: hosted
-    version: "1.12.0"
+    version: "1.15.0"
   mime:
     dependency: transitive
     description: