fix: fix analyzer

Author: segfaultmedaddy

examples/file_example.dart

@@ -7,7 +7,7 @@ import 'package:strlog/handlers.dart' show FileHandler, LogFileRotationPolicy;
 
 final formatter = TextFormatter.withDefaults();
 final handler = FileHandler(LogFileRotationPolicy.never(),
-    path: './file_example.log', maxBackupsCount: 1, formatter: formatter.call);
+    path: './file_example.log', formatter: formatter.call);
 
 final logger = Logger.detached()..handler = handler;
 

examples/file_rotation_example.dart

@@ -0,0 +1,51 @@
+library;
+
+import 'package:strlog/formatters.dart' show TextFormatter;
+import 'package:strlog/global_logger.dart' as log;
+import 'package:strlog/strlog.dart';
+import 'package:strlog/handlers.dart' show FileHandler, LogFileRotationPolicy;
+
+final formatter = TextFormatter.withDefaults();
+final handler = FileHandler(
+    LogFileRotationPolicy.periodic(Duration(seconds: 30)), // each 30seconds
+    path: './file_rotation_periodic_example.log',
+    formatter: formatter.call);
+final logger = Logger.detached()..handler = handler;
+
+Future<void> main() async {
+  log.set(logger);
+
+  final context = log.withFields({
+    const Str('username', 'roman-vanesyan'),
+    const Group('file', [
+      Str('name', 'avatar.png'),
+      Str('mime', 'image/png'),
+    ])
+  });
+
+  final timer = context.startTimer('Uploading!', level: Level.info);
+
+  // Emulate exponential backoff retry
+  final maxAttempts = 5;
+  for (int attempt = 0; attempt < maxAttempts; attempt++) {
+    try {
+      await Future<void>.delayed(Duration(seconds: 10 * (attempt + 1)));
+
+      // resolve on the last attempt.
+      if (attempt != maxAttempts - 1) {
+        context
+            .error('Failed to upload, retrying...', {Int('attempt', attempt)});
+        throw Exception('failed');
+      }
+
+      break; // Success, exit loop
+    } catch (e) {
+      timer.stop('Aborting...');
+      context.fatal('Failed to upload!', {const Str('reason', 'Timeout')});
+
+      if (attempt == maxAttempts - 1) rethrow; // Last attempt failed
+    }
+
+    timer.stop('Uploaded!');
+  }
+}

examples/file_rotation_periodic_example.dart

@@ -7,11 +7,13 @@ import 'package:strlog/handlers.dart' show FileHandler, LogFileRotationPolicy;
 
 final formatter = TextFormatter.withDefaults();
 final handler = FileHandler(
+    // rotates log file if either log file is older than 5m, or size exceeds 10kb.
     LogFileRotationPolicy.union([
-      LogFileRotationPolicy.periodic(Duration(minutes: 5)), // each 5 minutes
-      LogFileRotationPolicy.sized(1024 * 1024) // if exceeds 1mb.
+      LogFileRotationPolicy.periodic(Duration(minutes: 5)), // older than 5m
+      LogFileRotationPolicy.sized(1024 * 10) // exceeds 10kb.
     ]),
-    formatter: formatter.call);
+    formatter: formatter.call,
+    path: './file_rotation_periodic_example.log');
 
 final logger = Logger.detached()..handler = handler;
 

examples/file_rotation_periodic_sized_example.dart

@@ -57,5 +57,5 @@ class _Any {
 ///
 /// As [Any] makes runtime type checking make sure that it is used only
 /// where it is necessary, otherwise use one of predefined fields.
-// ignore:constant_identifier_names
+// ignore:library_private_types_in_public_api,constant_identifier_names
 const _Any Any = _Any();

file_example.log

@@ -2,7 +2,7 @@ import 'package:strlog/strlog.dart' show Record, Level, Field, FieldKind;
 
 typedef LevelFormatter<R> = R Function(Level);
 typedef TimestampFormatter<R> = R Function(DateTime);
-typedef FieldFormatter<R> = R Function(Field<dynamic>);
+typedef FieldFormatter<R> = R Function(Field);
 
 /// [Formatter] is capable to format single [Record] entry.
 typedef Formatter = List<int> Function(Record);

lib/src/fields/any.dart

@@ -0,0 +1,2 @@
+/// Maximum number of backup files to keep at a time.
+const int maxBackupCount = 3;

lib/src/formatters/formatter.dart

@@ -8,14 +8,15 @@ import 'package:path/path.dart'
 import 'package:strlog/formatters.dart' show Formatter;
 import 'package:strlog/strlog.dart' show Handler, Record, Filter;
 import 'package:strlog/src/handlers/file_handler/policy.dart';
+import 'package:strlog/src/handlers/file_handler/defaults.dart' as defaults;
 
 const _localFs = LocalFileSystem();
 
 class _LogFileStat implements LogFileStat {
-  _LogFileStat({required this.modified, required this.size});
+  _LogFileStat({required this.firstChanged, required this.size});
 
   @override
-  DateTime modified;
+  DateTime firstChanged;
 
   @override
   int size;
@@ -30,15 +31,16 @@ class _LogFileStat implements LogFileStat {
 /// and can maintain a maximum number of backup files. When rotation occurs, the current
 /// log file is archived with a timestamp and a new file is created.
 class FileHandler extends Handler {
-  FileHandler(this._policy,
-      {required Formatter formatter,
-      required String path,
-      required int maxBackupsCount,
-      FileSystem? fs})
-      : assert(path != ""),
+  FileHandler(
+    this._policy, {
+    required Formatter formatter,
+    required String path,
+    FileSystem? fs,
+    int? maxBackupsCount,
+  })  : assert(path != ""),
         _formatter = formatter,
         _fs = fs ?? _localFs,
-        _maxBackupsCount = maxBackupsCount,
+        _maxBackupsCount = maxBackupsCount ?? defaults.maxBackupCount,
         _isClosed = false,
         _path = _ParsedPath.fromString(path) {
     _open();
@@ -52,10 +54,10 @@ class FileHandler extends Handler {
   bool _isClosed;
 
   final FileSystem _fs;
+  final _ParsedPath _path;
   late File _file; // created in _open
   late IOSink _sink; // created in _open
   late _LogFileStat _stat; // created in _open
-  final _ParsedPath _path;
 
   /// Sets records filter.
   ///
@@ -76,7 +78,7 @@ class FileHandler extends Handler {
       case FileSystemEntityType.file:
         {
           final nextStat =
-              _LogFileStat(size: stat.size, modified: stat.modified);
+              _LogFileStat(size: stat.size, firstChanged: stat.changed);
           if (_policy.shouldRotate(nextStat)) {
             _rotate();
           } else {
@@ -87,7 +89,7 @@ class FileHandler extends Handler {
 
       case FileSystemEntityType.notFound:
         _file.createSync(recursive: true);
-        _stat = _LogFileStat(size: 0, modified: DateTime.now());
+        _stat = _LogFileStat(size: 0, firstChanged: DateTime.now());
         break;
 
       default:
@@ -141,7 +143,6 @@ class FileHandler extends Handler {
 
     _sink.add(bytes);
     _stat.size += bytes.lengthInBytes;
-    _stat.modified = DateTime.now();
   }
 
   /// Closes the file handler and underlying file sink.

lib/src/handlers/file_handler/defaults.dart

@@ -5,11 +5,13 @@ import 'package:strlog/strlog.dart' show Handler, Record;
 import './policy.dart';
 
 class FileHandler extends Handler {
-  FileHandler(LogFileRotationPolicy policy,
-      {required String path,
-      required int maxBackupsCount,
-      required Formatter formatter,
-      FileSystem? fs});
+  FileHandler(
+    LogFileRotationPolicy policy, {
+    required String path,
+    required Formatter formatter,
+    FileSystem? fs,
+    int? maxBackupsCount,
+  });
 
   @override
   void handle(Record record) {