logtail-rack 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73931379e41a5b92e72919963376a2f6b6b8ec06871b9a410bc6c8339228387d
-  data.tar.gz: 01b32fd44ea670b47d5d7340a8c02c1305b203332f298818dff9ec68058e79e2
+  metadata.gz: 43f0b7693831d0097e1496ba79258afc7b8b7cda69d805fa99248cbc79812181
+  data.tar.gz: 23bdde6dc4a16420b3f8604edc3266775b248e2a51177be01c64a314577612d9
 SHA512:
-  metadata.gz: 02f9dcd2e699b1c52d9f31265bb1f77f057c8e63bab5d2e87475e7b22823a16723ef3b69e5cd99827b1d9bdf0a27db35ba7f7c3a1b7656e099a60171a0c1476d
-  data.tar.gz: 4e2a9cbb7b647f1ef6574ecea49db83616e7ea9082dec902c5bba980aaebc14a5cefa325ade3ed3a4d3085aba2c07610f8469b362560f94a5ef3bea6248e77f4
+  metadata.gz: f9dc63f41ea21c4f31360608d82ec1cbf6652cac1774a28695a845a36858a95215ee24d49696278f07267266922659559cee8790a85767e64cd143e833232950
+  data.tar.gz: c1faf9719cac776039dac04d3acc9b91b9520f9f7983a4db242344e9f66cfedd37feb0bfe8b6575185b883918e45b37eaf76a61708f364dd627a8805349f6989

data/.github/workflows/main.yml

@@ -23,7 +23,6 @@ jobs:
           - 2.5
           - 2.4
           - 2.3
-          - 2.2
           - jruby-9.4.3.0
           - jruby-9.2.14.0
           - truffleruby-23.0.0

data/lib/logtail-rack/http_context.rb

@@ -1,6 +1,7 @@
 require "logtail/contexts/http"
 require "logtail/current_context"
 require "logtail-rack/middleware"
+require "logtail-rack/util/encoding"
 require "logtail-rack/util/request"
 
 module Logtail
@@ -11,10 +12,10 @@ module Logtail
         def call(env)
           request = Util::Request.new(env)
           context = Contexts::HTTP.new(
-            host: request.host.force_encoding('UTF-8'),
-            method: request.request_method.force_encoding('UTF-8'),
+            host: Util::Encoding.force_utf8_encoding(request),
+            method: Util::Encoding.force_utf8_encoding(request.request_method),
             path: request.path,
-            remote_addr: request.ip.force_encoding('UTF-8'),
+            remote_addr: Util::Encoding.force_utf8_encoding(request.ip),
             request_id: request.request_id
           )
 

data/lib/logtail-rack/http_events.rb

@@ -6,6 +6,7 @@ require "logtail/current_context"
 require "logtail-rack/http_request"
 require "logtail-rack/http_response"
 require "logtail-rack/middleware"
+require "logtail-rack/util/encoding"
 
 module Logtail
   module Integrations
@@ -102,23 +103,24 @@ module Logtail
             @silence_request
           end
 
-          def http_body_limit=(value)
-            @http_body_limit = value
-          end
-
-          # Accessor method for {#http_body_limit=}
-          def http_body_limit
-            @http_body_limit
-          end
-
+          # Filter sensitive HTTP headers (such as "Authorization: Bearer secret_token")
+          #
+          # Filtered HTTP header values will be sent to Better Stack as "[FILTERED]"
+          #
+          # @example
+          #   Logtail::Integrations::Rack::HTTPEvents.http_header_filters = ["Authorization"]
           def http_header_filters=(value)
-            @http_header_filters = value
+            @http_header_filters = value.map { |header_name| normalize_header_name(header_name) }
           end
 
           # Accessor method for {#http_header_filters=}
           def http_header_filters
             @http_header_filters
           end
+
+          def normalize_header_name(name)
+            name.to_s.downcase.gsub("-", "_")
+          end
         end
 
         CONTENT_LENGTH_KEY = 'Content-Length'.freeze
@@ -147,13 +149,11 @@ module Logtail
 
               http_response = HTTPResponse.new(
                 content_length: content_length,
-                headers: headers,
+                headers: filter_http_headers(headers),
                 http_context: http_context,
                 request_id: request.request_id,
                 status: status,
                 duration_ms: duration_ms,
-                body_limit: self.class.http_body_limit,
-                headers_to_sanitize: self.class.http_header_filters,
               )
 
               {
@@ -179,16 +179,14 @@ module Logtail
               http_request = HTTPRequest.new(
                 body: event_body,
                 content_length: safe_to_i(request.content_length),
-                headers: request.headers,
-                host: force_encoding(request.host),
+                headers: filter_http_headers(request.headers),
+                host: Util::Encoding.force_utf8_encoding(request.host),
                 method: request.request_method,
                 path: request.path,
                 port: request.port,
-                query_string: force_encoding(request.query_string),
+                query_string: Util::Encoding.force_utf8_encoding(request.query_string),
                 request_id: request.request_id,
-                scheme: force_encoding(request.scheme),
-                body_limit: self.class.http_body_limit,
-                headers_to_sanitize: self.class.http_header_filters,
+                scheme: Util::Encoding.force_utf8_encoding(request.scheme),
               )
 
               {
@@ -223,12 +221,10 @@ module Logtail
               http_response = HTTPResponse.new(
                 body: event_body,
                 content_length: content_length,
-                headers: headers,
+                headers: filter_http_headers(headers),
                 request_id: request.request_id,
                 status: status,
                 duration_ms: duration_ms,
-                body_limit: self.class.http_body_limit,
-                headers_to_sanitize: self.class.http_header_filters,
               )
 
               {
@@ -272,16 +268,15 @@ module Logtail
             end
           end
 
-          def safe_to_i(val)
-            val.nil? ? nil : val.to_i
+          def filter_http_headers(headers)
+            headers.each do |name, _|
+              normalized_header_name = self.class.normalize_header_name(name)
+              headers[name] = "[FILTERED]" if self.class.http_header_filters&.include?(normalized_header_name)
+            end
           end
 
-          def force_encoding(value)
-            if value.respond_to?(:force_encoding)
-              value.dup.force_encoding('UTF-8')
-            else
-              value
-            end
+          def safe_to_i(val)
+            val.nil? ? nil : val.to_i
           end
       end
     end

data/lib/logtail-rack/util/encoding.rb

@@ -3,7 +3,10 @@ module Logtail
     class Encoding
       def self.force_utf8_encoding(data)
         if data.respond_to?(:force_encoding)
-          data.dup.force_encoding('UTF-8')
+          encoded_data = data.dup.force_encoding('UTF-8')
+          encoded_data = data.dup.force_encoding("ISO-8859-1").encode("UTF-8") unless encoded_data.valid_encoding?
+          encoded_data = data.dup.encode('UTF-8', invalid: :replace, undef: :replace) unless encoded_data.valid_encoding?
+          encoded_data
         elsif data.respond_to?(:transform_values)
           data.transform_values { |val| Logtail::Util::Encoding.force_utf8_encoding(val) }
         else

data/lib/logtail-rack/version.rb

@@ -1,7 +1,7 @@
 module Logtail
   module Integrations
     module Rack
-      VERSION = "0.2.1"
+      VERSION = "0.2.3"
     end
   end
 end

data/logtail-ruby-rack.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/logtail/logtail-ruby-rack"
   spec.license       = "ISC"
 
-  spec.required_ruby_version     = '>= 2.2.10'
+  spec.required_ruby_version     = '>= 2.3'
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/logtail/logtail-ruby-rack"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail-rack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Logtail
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logtail
@@ -129,14 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.10
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Logtail integration for Rack