make redact public method on logger

Invoca · Dec 8, 2023 · 9317acb · 9317acb
1 parent c3698e2
commit 9317acb
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/lib/contextual_logger.rb b/lib/contextual_logger.rb
@@ -51,7 +51,7 @@ def normalize_message(message)
   module LoggerMixin
     include Context
 
-    delegate :register_secret, :register_secret_regex, to: :redactor
+    delegate :register_secret, :register_secret_regex, :redact, to: :redactor
 
     def global_context
       @global_context ||= Context::EMPTY_CONTEXT

diff --git a/lib/contextual_logger/redactor.rb b/lib/contextual_logger/redactor.rb
@@ -21,6 +21,8 @@ def register_secret_regex(regex)
       end
     end
 
+    # @param log_line [String]
+    # @return [String]
     def redact(log_line)
       if redaction_regex
         log_line.gsub(redaction_regex, '<redacted>')

diff --git a/spec/lib/contextual_logger_spec.rb b/spec/lib/contextual_logger_spec.rb
@@ -27,6 +27,7 @@ def expect_log_line_to_be_written(log_line)
   it { is_expected.to respond_to(:with_context) }
   it { is_expected.to respond_to(:current_context) }
   it { is_expected.to respond_to(:current_context_for_thread) } # for backward-compatibility
+  it { is_expected.to respond_to(:redact) }
 
   context 'with logger writing to log_stream' do
     let(:log_stream) { StringIO.new }