astute_logger

Releases

1. ▸▾2.6.027 Sept 2026Deprecated2 sources agree

   `AstuteLogger.getAppMode()` — replaced by the appMode getter. (Deprecated alias not retained; migration is a one-line rename.)

   Added

   • AppMode enum (debug, profile, release, unknown) exposed via the AstuteLogger.appMode getter, replacing the semantically confusing getAppMode() method that returned a LogLevel.
   • LogConfig.redactEmails flag (default true). Disabling it preserves email addresses in logs for improved observability while still redacting credit cards and other sensitive patterns.
   • AstuteLogger.redactObject(Object?) — public key-based redaction helper for nested maps and lists. Used internally by json() and exposed for callers (including the Dio interceptor).
   • AstuteLogger.flush() (@visibleForTesting) — awaits full drain of the async write queue. Enables deterministic tests and shutdown-time flushing.
   • AstuteLogger.resetFileCache() (@visibleForTesting) — clears the internal File cache, primarily for test isolation.
   • AstuteLogger.getLogsByTag(tag, {fileName}) now accepts a fileName parameter so callers can read from non-default log files.
   • lib/service/logging_interceptor.dart — a new LoggingInterceptor for Dio that logs request/response/error traffic with structured redaction, truncation, and response-time measurement.
   • LoggingInterceptor options: logRequestHeaders, logRequestBody, logResponseHeaders, logResponseBody, maxBodyLength, maxHeaderValueLength (all configurable via constructor with assertions).
   • FormData body logging — only field names and file basenames are logged, never full paths or raw bytes.
   • Truncation for both body strings and header values, with a ... [truncated, total N chars] suffix.
   • Comprehensive test suites:
     • test/astute_logger_test.dart
     • test/logging_interceptor_test.dart

   Changed

   • Async write pipeline — replaced the StreamController-based queue with an explicit bounded queue (Queue<_QueuedLogEvent>) with a 1024-event capacity. Guarantees strict FIFO write ordering, back-pressure via slot waiters, and per-event Future completion only after the log line is persisted.
   • All public write methods now return Future<void> — write, json, debug, info, warning, error, critical. Awaiting them provides a durability guarantee; ignoring them preserves the old fire-and-forget behavior.
   • File writes now open and close a fresh IOSink per call (openWrite → flush → close) instead of writeAsString(flush: true). This releases the OS file handle immediately, preventing Windows file locks and improving durability semantics.
   • getLogFile() now caches File instances correctly. The previous implementation read from _logFilesCache but never populated it, defeating the cache. Fixed.
   • Pretty-print redaction — pretty-printed JSON is now redacted via key-based rules (_redactObject) instead of the free-text regex, which failed on multi-line JSON (quoted keys broke the pattern match).
   • json() now reuses _tryDecodeJson internally, avoiding duplicated jsonDecode logic.
   • Regex redaction rule #1 — clarified with inline examples in the source.
   • Stack-trace parsing regex now allows $ in identifiers (closures and generics) and includes a fallback pattern for frames without a trailing (, matching real VM output more reliably.
   • logExecutionTime and logExecutionTimeAsync now log via try/finally so the timing line is always emitted, even when the measured function throws. The original exception propagates unchanged.
   • _processLogQueue write path now uses the new _appendToFile helper.

   Fixed

   • Out-of-order writes under concurrency — the async queue now serializes every event strictly in enqueue order, even across multiple logger instances writing to the same file.
   • Broken prettyPrint flag — previously a no-op because jsonDecode was attempted on the fully-formatted log line. Now the raw message is decoded and pretty-printed correctly, with the log prefix and suffix preserved.
   • Redaction bypass for structured bodies in the Dio interceptor — bodies are now routed through redactObject() before serialization.
   • getLogFile never caching (see Changed).
   • Windows PathAccessException on file deletion — resolved by the close-per-write change described above.

   Removed

   • AstuteLogger.getAppMode() — replaced by the appMode getter. (Deprecated alias not retained; migration is a one-line rename.)

   ---