Hide a specific header from dio logger

packages/talker_dio_logger/lib/dio_logs.dart

@@ -5,6 +5,7 @@ import 'package:talker/talker.dart';
 import 'package:talker_dio_logger/talker_dio_logger.dart';
 
 const _encoder = JsonEncoder.withIndent('  ');
+const _hiddenValue = '*****';
 
 class DioRequestLog extends TalkerLog {
   DioRequestLog(
@@ -37,6 +38,15 @@ class DioRequestLog extends TalkerLog {
         msg += '\nData: $prettyData';
       }
       if (settings.printRequestHeaders && headers.isNotEmpty) {
+        if (settings.hideHeaderValuesForKeys.isNotEmpty) {
+          headers.updateAll((key, value) {
+            return settings.hideHeaderValuesForKeys
+                    .map((v) => v.toLowerCase())
+                    .contains(key.toLowerCase())
+                ? _hiddenValue
+                : value;
+          });
+        }
         final prettyHeaders = _encoder.convert(headers);
         msg += '\nHeaders: $prettyHeaders';
       }

packages/talker_dio_logger/lib/talker_dio_logger_settings.dart

@@ -13,6 +13,7 @@ class TalkerDioLoggerSettings {
     this.printErrorMessage = true,
     this.printRequestData = true,
     this.printRequestHeaders = false,
+    this.hideHeaderValuesForKeys = const <String>{},
     this.requestPen,
     this.responsePen,
     this.errorPen,
@@ -93,6 +94,10 @@ class TalkerDioLoggerSettings {
   /// You can add your custom logic to log only specific Dio error [DioException].
   final bool Function(DioException response)? errorFilter;
 
+  /// Header values for the specified keys in the Set will be replaced with *****.
+  /// Case insensitive
+  final Set<String> hideHeaderValuesForKeys;
+
   TalkerDioLoggerSettings copyWith({
     bool? printResponseData,
     bool? printResponseHeaders,
@@ -108,6 +113,7 @@ class TalkerDioLoggerSettings {
     bool Function(RequestOptions requestOptions)? requestFilter,
     bool Function(Response response)? responseFilter,
     bool Function(DioException response)? errorFilter,
+    Set<String>? hideHeaderValuesForKeys,
   }) {
     return TalkerDioLoggerSettings(
       printResponseData: printResponseData ?? this.printResponseData,
@@ -124,6 +130,8 @@ class TalkerDioLoggerSettings {
       requestFilter: requestFilter ?? this.requestFilter,
       responseFilter: responseFilter ?? this.responseFilter,
       errorFilter: errorFilter ?? this.errorFilter,
+      hideHeaderValuesForKeys:
+          hideHeaderValuesForKeys ?? this.hideHeaderValuesForKeys,
     );
   }
 }

packages/talker_dio_logger/test/logger_test.dart

@@ -68,5 +68,29 @@ void main() {
           '  ]\n'
           '}');
     });
+
+    test('onRequest method should hide specific header values in log', () {
+      final logger = TalkerDioLogger(
+          talker: talker,
+          settings: TalkerDioLoggerSettings(
+              printRequestHeaders: true,
+              hideHeaderValuesForKeys: {'Authorization'}));
+
+      final options = RequestOptions(path: '/test', headers: {
+        "firstHeader": "firstHeaderValue",
+        "authorization": "bearer super_secret_token",
+        "lastHeader": "lastHeaderValue",
+      });
+      logger.onRequest(options, RequestInterceptorHandler());
+      print(talker.history);
+      expect(
+          talker.history.last.generateTextMessage(),
+          '[http-request] [GET] /test\n'
+          'Headers: {\n'
+          '  "firstHeader": "firstHeaderValue",\n'
+          '  "authorization": "*****",\n'
+          '  "lastHeader": "lastHeaderValue"\n'
+          '}');
+    });
   });
 }

packages/talker_http_logger/example/talker_http_logger_example.dart

@@ -1,10 +1,17 @@
 import 'package:http_interceptor/http_interceptor.dart';
 import 'package:talker_http_logger/talker_http_logger.dart';
+import 'package:talker_http_logger/talker_http_logger_settings.dart';
 
 void main(List<String> args) async {
   final client = InterceptedClient.build(interceptors: [
-    TalkerHttpLogger(),
+    TalkerHttpLogger(
+        settings: TalkerHttpLoggerSettings(
+            hideHeaderValuesForKeys: {'Authorization'})),
   ]);
 
-  await client.get("https://google.com".toUri());
+  await client.get("https://google.com".toUri(), headers: {
+    "firstHeader": "firstHeaderValue",
+    "authorization": "bearer super_secret_token",
+    "lastHeader": "lastHeaderValue",
+  });
 }

packages/talker_http_logger/lib/talker_http_logger.dart

@@ -4,20 +4,26 @@ import 'dart:convert';
 
 import 'package:http_interceptor/http_interceptor.dart';
 import 'package:talker/talker.dart';
+import 'package:talker_http_logger/talker_http_logger_settings.dart';
 
 class TalkerHttpLogger extends InterceptorContract {
-  TalkerHttpLogger({Talker? talker}) {
+  TalkerHttpLogger(
+      {Talker? talker, this.settings = const TalkerHttpLoggerSettings()}) {
     _talker = talker ?? Talker();
   }
 
   late Talker _talker;
 
+  /// [TalkerHttpLogger] settings and customization
+  TalkerHttpLoggerSettings settings;
+
   @override
   Future<BaseRequest> interceptRequest({
     required BaseRequest request,
   }) async {
     final message = '${request.url}';
-    _talker.logCustom(HttpRequestLog(message, request: request));
+    _talker.logCustom(
+        HttpRequestLog(message, request: request, settings: settings));
     return request;
   }
 
@@ -38,15 +44,19 @@ class TalkerHttpLogger extends InterceptorContract {
 }
 
 const encoder = JsonEncoder.withIndent('  ');
+const _hiddenValue = '*****';
 
 class HttpRequestLog extends TalkerLog {
   HttpRequestLog(
     String title, {
     required this.request,
+    this.settings = const TalkerHttpLoggerSettings(),
   }) : super(title);
 
   final BaseRequest request;
 
+  final TalkerHttpLoggerSettings settings;
+
   @override
   AnsiPen get pen => (AnsiPen()..xterm(219));
 
@@ -62,6 +72,15 @@ class HttpRequestLog extends TalkerLog {
 
     try {
       if (headers.isNotEmpty) {
+        if (settings.hideHeaderValuesForKeys.isNotEmpty) {
+          headers.updateAll((key, value) {
+            return settings.hideHeaderValuesForKeys
+                    .map((v) => v.toLowerCase())
+                    .contains(key.toLowerCase())
+                ? _hiddenValue
+                : value;
+          });
+        }
         final prettyHeaders = encoder.convert(headers);
         msg += '\nHeaders: $prettyHeaders';
       }
@@ -76,10 +95,13 @@ class HttpResponseLog extends TalkerLog {
   HttpResponseLog(
     String title, {
     required this.response,
+    this.settings = const TalkerHttpLoggerSettings(),
   }) : super(title);
 
   final BaseResponse response;
 
+  final TalkerHttpLoggerSettings settings;
+
   @override
   AnsiPen get pen => (AnsiPen()..xterm(46));
 
@@ -111,10 +133,13 @@ class HttpErrorLog extends TalkerLog {
   HttpErrorLog(
     String title, {
     required this.response,
+    this.settings = const TalkerHttpLoggerSettings(),
   }) : super(title);
 
   final BaseResponse response;
 
+  final TalkerHttpLoggerSettings settings;
+
   @override
   AnsiPen get pen => AnsiPen()..red();
 

packages/talker_http_logger/lib/talker_http_logger_settings.dart

@@ -0,0 +1,9 @@
+class TalkerHttpLoggerSettings {
+  const TalkerHttpLoggerSettings({
+    this.hideHeaderValuesForKeys = const <String>{},
+  });
+
+  /// Header values for the specified keys in the Set will be replaced with *****.
+  /// Case insensitive
+  final Set<String> hideHeaderValuesForKeys;
+}