feat: redaction only when path matches

Author: gildesmarais

app/web/security/log_sanitizer.rb

@@ -8,19 +8,15 @@ module Web
     ##
     # Sanitizes request paths and log payloads before they are emitted.
     module LogSanitizer
-      FEED_TOKEN_ROUTE = %r{\A(/api/v1/feeds/)([^/?]+)\z}
+      FEED_TOKEN_ROUTE = %r{\A(/api/v1/feeds/)([^/?]+?)(\.(?:json|xml|rss))?\z}
 
       class << self
         # @param path [String, nil]
         # @return [String, nil]
         def sanitize_path(path)
           return if path.nil?
 
-          path_string = path.to_s
-          suffix = feed_suffix(path_string)
-          token_path = suffix ? path_string.delete_suffix(suffix) : path_string
-
-          token_path.gsub(FEED_TOKEN_ROUTE, "\\1[REDACTED]#{suffix}")
+          path.to_s.gsub(FEED_TOKEN_ROUTE, '\1[REDACTED]\3')
         end
 
         # @param details [Hash]
@@ -33,16 +29,6 @@ def sanitize_details(details)
 
         private
 
-        # @param path [String]
-        # @return [String, nil]
-        def feed_suffix(path)
-          return '.json' if path.end_with?('.json')
-          return '.xml' if path.end_with?('.xml')
-          return '.rss' if path.end_with?('.rss')
-
-          nil
-        end
-
         # @param key [Object]
         # @param value [Object]
         # @return [Object]

spec/html2rss/web/log_sanitizer_spec.rb

@@ -51,6 +51,12 @@
     ).to eq('/api/v1/feeds/[REDACTED].xml')
   end
 
+  it 'leaves non-feed paths unchanged when they use supported suffixes', :aggregate_failures do
+    expect(described_class.sanitize_path('/api/v1/health.json')).to eq('/api/v1/health.json')
+    expect(described_class.sanitize_path('/api/v1/status.xml')).to eq('/api/v1/status.xml')
+    expect(described_class.sanitize_path('/feeds/public.rss')).to eq('/feeds/public.rss')
+  end
+
   it 'replaces logged urls with hashed host metadata' do
     expect(described_class.sanitize_details(url: 'https://news.ycombinator.com')).to eq(url: expected_news_url)
   end