diff --git a/lib/common/dcc_logger.dart b/lib/common/dcc_logger.dart deleted file mode 100644 index bda22b5..0000000 --- a/lib/common/dcc_logger.dart +++ /dev/null @@ -1,113 +0,0 @@ -import 'package:flutter/foundation.dart'; -import 'package:intl/intl.dart'; -import 'package:logging/logging.dart'; - -/// A logger that can be used to log messages. -@Deprecated('Use BoltLogger instead') -class DCCLogger { - static Logger? _logger; - static final DateFormat _formatter = DateFormat(DateFormat.HOUR24_MINUTE); - - /// Initialise the logger. This needs to be called before using the logger. - /// Using this is done in the main.dart file. - @Deprecated('Use BoltLogger.charge instead') - static void initialise([ - String? name, - String? tag, - Logger? logger, - ]) { - _logger = - logger ?? Logger('${name ?? 'DCC'}${tag != null ? ' ($tag)' : ''}'); - final rootLogger = Logger.root; - rootLogger.onRecord.listen((event) { - if (kDebugMode) { - _prettyPrinter(event); - } - }); - } - - static void _prettyPrinter(LogRecord record) { - final error = record.error; - final stacktrace = record.stackTrace; - final message = record.object is DCCLogRecord - ? record.object.toString() - : record.message; - - debugPrint(_formatLogPrint(record, message)); - - if (error != null) { - debugPrint(_formatLogPrint(record, '${error.runtimeType}: $error')); - } - - if (stacktrace != null) { - final lines = - stacktrace.toString().split('\n').where((e) => e.isNotEmpty); - for (final line in lines) { - debugPrint(_formatLogPrint(record, line)); - } - } - } - - static String _formatLogPrint(LogRecord record, String message) { - final logMessage = - '[${_formatter.format(record.time)}] [${record.level.name}] ${record.loggerName}: $message'; - return record.level == Level.SEVERE - ? _addWarningColor(logMessage) - : logMessage; - } - - static String _addWarningColor(String message) { - return '⚠️$message'; - } - - /// Log an info message - /// This will be included in the sentry breadcrumbs. - /// Example: - /// ```dart - /// DCCLogger.info('test bericht', tag: 'test'); - /// ``` - /// prints: [[13:46]] [[INFO]] DCC: <test> test bericht - @Deprecated('Use BoltLogger.zap instead') - static void info( - String message, { - Object? error, - StackTrace? stackTrace, - String? tag, - }) { - assert(_logger != null, 'initialise DCCLogger first'); - _logger?.info(DCCLogRecord(message, tag), error, stackTrace); - } - - /// Log an severe message. - /// This will also be sent to sentry. - /// Example: - /// ```dart - /// DCCLogger.severe('test bericht', tag: 'test'); - /// ``` - /// prints: [[13:46]] [[SEVERE]] DCC: <test> test bericht - @Deprecated('Use BoltLogger.shock instead') - static void severe( - String message, { - Object? error, - StackTrace? stackTrace, - String? tag, - }) { - assert(_logger != null, 'initialise DCCLogger first'); - _logger?.severe(DCCLogRecord(message, tag), error, stackTrace); - } -} - -/// A log entry representation used to propagate information to the logger. -class DCCLogRecord { - /// Creates a new log record. - const DCCLogRecord(this.message, this.tag); - - /// The message to be logged. - final String message; - - /// The tag to be logged. - final String? tag; - - @override - String toString() => '${tag != null ? '<$tag> ' : ''}$message'; -} diff --git a/test/dcc_logger_test.dart b/test/dcc_logger_test.dart deleted file mode 100644 index 9187b40..0000000 --- a/test/dcc_logger_test.dart +++ /dev/null @@ -1,47 +0,0 @@ -// For testing purposes. -//ignore_for_file: deprecated_member_use_from_same_package -import 'package:dcc_toolkit/common/dcc_logger.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:logging/logging.dart'; -import 'package:mocktail/mocktail.dart'; - -class MockLogger extends Mock implements Logger {} - -void main() { - group('uninitialised tests', () { - test('throws assertion error when logger is not initialised', () { - expect( - () => DCCLogger.info('test message'), - throwsA(isA()), - ); - expect( - () => DCCLogger.severe('test message'), - throwsA(isA()), - ); - }); - }); - - group('DCCLogger', () { - late MockLogger mockLogger; - - setUp(() { - mockLogger = MockLogger(); - when(() => mockLogger.info(any())).thenReturn(null); - when(() => mockLogger.severe(any())).thenReturn(null); - - DCCLogger.initialise(null, null, mockLogger); - }); - - test('logs info message correctly', () { - DCCLogger.info('test message', tag: 'test'); - - verify(() => mockLogger.info(any())).called(1); - }); - - test('logs severe message correctly', () { - DCCLogger.severe('test message', tag: 'test'); - - verify(() => mockLogger.severe(any())).called(1); - }); - }); -}