chore(core): Move logger to aws_common

Moves logging to `aws_common` and adds an `AWSLogger` class which can be used throughout core packages.

commit-id:d64ce8ca

Author: Dillon Nys

packages/amplify_core/lib/amplify_core.dart

@@ -47,9 +47,6 @@ export 'src/hub/hub_event.dart';
 
 // Logger
 export 'src/logger/amplify_logger.dart';
-export 'src/logger/log_entry.dart';
-export 'src/logger/log_level.dart';
-export 'src/logger/simple_printer.dart';
 
 /// Plugin
 export 'src/plugin/amplify_analytics_plugin_interface.dart';

packages/amplify_core/lib/src/amplify_class.dart

@@ -103,8 +103,6 @@ abstract class AmplifyClass {
       );
     }
 
-    AmplifyLogger().registerPlugin(const SimplePrinter());
-
     await configurePlatform(configuration);
     _configCompleter.complete(amplifyConfig);
   }

packages/amplify_core/lib/src/logger/amplify_logger.dart

@@ -12,113 +12,52 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import 'dart:async';
 import 'package:amplify_core/amplify_core.dart';
-import 'package:amplify_core/src/logger/logging_ext.dart';
 import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
 
-/// {@template amplify_core.logger.amplify_logger}
-/// A logging utility providing the ability to emit log entries, configure the
-/// level at which entries are emitted, and register plugins which can handle
-/// log entries as they're emitted.
-/// {@endtemplate}
-///
-/// Plugins are created by implementing [AmplifyLoggerPlugin] and calling
-/// [AmplifyLogger.registerPlugin] on an [AmplifyLogger] instance.
-///
-/// By default, a [SimplePrinter] is registered on the root [AmplifyLogger]
-/// which impacts all category and child loggers.
-class AmplifyLogger {
-  /// The root namespace for all [AmplifyLogger] instances.
-  static const rootNamespace = 'AWS.Amplify';
-
-  static final Map<AmplifyLoggerPlugin, StreamSubscription<LogRecord>>
-      _subscriptions = {};
-  final Logger _logger;
-
+/// {@macro aws_common.logging.aws_logger}
+class AmplifyLogger extends AWSLogger {
   /// Creates a top-level [AmplifyLogger].
   ///
-  /// {@macro amplify_core.logger.amplify_logger}
-  factory AmplifyLogger([String namespace = rootNamespace]) =>
-      AmplifyLogger._(Logger(namespace));
+  /// {@macro aws_common.logging.aws_logger}
+  factory AmplifyLogger([String namespace = rootNamespace]) {
+    // Create a logger inside the Amplify hierarchy so that printing and log
+    // level behavior are consistent with public API.
+    //
+    // Use AWSLogger to create a logger which can have its own hierarchy.
+    if (!namespace.startsWith(rootNamespace)) {
+      namespace = '$rootNamespace.$namespace';
+    }
+    return (AWSLogger.activeLoggers[namespace] ??=
+        AmplifyLogger._(Logger(namespace))) as AmplifyLogger;
+  }
 
   /// Creates a [AmplifyLogger] for the Amplify [category].
   ///
-  /// {@macro amplify_core.logger.amplify_logger}
+  /// {@macro aws_common.logging.aws_logger}
   factory AmplifyLogger.category(Category category) =>
-      AmplifyLogger._(Logger('$rootNamespace.${category.name}'));
-
-  AmplifyLogger._(this._logger) {
-    hierarchicalLoggingEnabled = true;
-  }
-
-  /// Creates an [AmplifyLogger] with `this` as the parent.
-  AmplifyLogger createChild(String name) =>
-      AmplifyLogger('${_logger.fullName}.$name');
-
-  /// Registers an [AmplifyLoggerPlugin] to handle logs emitted by this logger
-  /// instance.
-  void registerPlugin(AmplifyLoggerPlugin plugin) {
-    unregisterPlugin(plugin);
-    _subscriptions[plugin] = _logger.onRecord.listen(
-      (record) => plugin.handleLogEntry(record.toLogEntry()),
-    );
-  }
-
-  /// Unregisters [plugin] from this logger instance.
-  void unregisterPlugin(AmplifyLoggerPlugin plugin) {
-    final currentSubscription = _subscriptions.remove(plugin);
-    if (currentSubscription != null) {
-      unawaited(currentSubscription.cancel());
-    }
-  }
+      AmplifyLogger().createChild(category.name);
 
-  /// Unregisters all [AmplifyLoggerPlugin]s on this logger instance.
-  void unregisterAllPlugins() {
-    for (final plugin in List.of(_subscriptions.keys)) {
-      unregisterPlugin(plugin);
-    }
-  }
-
-  /// The minimum [LogLevel] that will be emitted by the logger.
-  LogLevel get logLevel => _logger.level.logLevel;
-
-  set logLevel(LogLevel logLevel) {
-    _logger.level = logLevel.level;
-  }
-
-  /// Logs a message with level [LogLevel.verbose].
-  void verbose(String message, [Object? error, StackTrace? stackTrace]) {
-    _logger.finer(message, error, stackTrace);
-  }
+  AmplifyLogger._(Logger logger) : super.protected(logger);
 
-  /// Logs a message with level [LogLevel.debug].
-  void debug(String message, [Object? error, StackTrace? stackTrace]) {
-    _logger.fine(message, error, stackTrace);
-  }
-
-  /// Logs a message with level [LogLevel.info].
-  void info(String message, [Object? error, StackTrace? stackTrace]) {
-    _logger.info(message, error, stackTrace);
-  }
-
-  /// Logs a message with level [LogLevel.warn].
-  void warn(String message, [Object? error, StackTrace? stackTrace]) {
-    _logger.warning(message, error, stackTrace);
-  }
+  /// The root namespace for all [AmplifyLogger] instances.
+  static const rootNamespace = '${AWSLogger.rootNamespace}.Amplify';
 
-  /// Logs a message with level [LogLevel.error].
-  void error(String message, [Object? error, StackTrace? stackTrace]) {
-    _logger.severe(message, error, stackTrace);
+  @override
+  AmplifyLogger createChild(String name) {
+    assert(name.isNotEmpty, 'Name should not be empty');
+    return AmplifyLogger('$namespace.$name');
   }
 }
 
+/// {@template amplify_core.logger.amplify_logger_plugin}
 /// A plugin to an [AmplifyLogger] which handles log entries emitted at the
 /// [LogLevel] of the logger instance.
-abstract class AmplifyLoggerPlugin {
-  /// Handles a log entry emitted by the [AmplifyLogger].
-  void handleLogEntry(LogEntry logEntry);
+/// {@endtemplate}
+abstract class AmplifyLoggerPlugin extends AWSLoggerPlugin {
+  /// {@macro amplify_core.logger.amplify_logger_plugin}
+  const AmplifyLoggerPlugin();
 }
 
 /// Mixin providing an [AmplifyLogger] to Amplify classes.