notable 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b31d4143d14d64607e2def24347627f2fd28d9b5b3870fb676d675c6c2960ba
-  data.tar.gz: 7a00b522829922dbf5fe67790a3f34876bf4f72872e371aa85eb1c0f54d183c9
+  metadata.gz: 5541640f476e0e97318e6767a54afaa5cdeb0d35891372f87eef3d528e5ceaaa
+  data.tar.gz: 8d16fd5688ad556b83c72ab9787ccac3fb2c0ba55468a3d6c829a4166110e64a
 SHA512:
-  metadata.gz: a81365335fd37a237c60e3da09ce271d5758c32a28a033d4424d65dc7e540d8dae170f692900b495f5a8de0a82372abe10c6faf642dbfe387017708f30aa6914
-  data.tar.gz: cbcd5b896609b8d54c25c1aa6c05e61672c0f49b46e3c9152acb9d3c40e923900d4e04244b71b22155cf661a6b277baf594948ff679ec14eea8e983bda468ef9
+  metadata.gz: ba086c17aa9de949c21349d6c754addb8de84f31635b3a57f7a52bce63aee66cce22476926c347a231456f4cd837765c83543636624f61237e197f5896ec227c
+  data.tar.gz: 135bebfd4c0acfa206d6acd39099040db35a90c98b5b13fe01e056253e953e685fe6ad00836a98e8443d412324d7e517ead6332ed2332f6c891b2a7dd146bb9c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.6.1 (2026-02-07)
+
+- Added `scrub_invalid_utf8` option
+- Improved handling of invalid parameters
+
+## 0.6.0 (2025-04-03)
+
+- Dropped support for Ruby < 3.2 and Rails < 7.1
+
 ## 0.5.2 (2023-12-26)
 
 - Fixed deprecation warning with Rack 3
@@ -56,4 +65,16 @@
 
 ## 0.1.0 (2016-02-20)
 
-- Launched
+- Switched to `Module#prepend`
+
+## 0.0.3 (2015-03-15)
+
+- Added `track_error` method
+
+## 0.0.2 (2014-12-22)
+
+- Fixed method name
+
+## 0.0.1 (2014-12-22)
+
+- First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2023 Andrew Kane
+Copyright (c) 2014-2025 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,7 +1,5 @@
 # Notable
 
-:star2: :star2: :star2:
-
 Notable tracks notable requests and background jobs and stores them in your database.  What makes a request or job notable? There are a number of default situations, but ultimately you decide what interests you.
 
 By default, Notable tracks:
@@ -19,7 +17,7 @@ You can track custom notes as well.
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://github.com/ankane/notable/workflows/build/badge.svg?branch=master)](https://github.com/ankane/notable/actions)
+[![Build Status](https://github.com/ankane/notable/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/notable/actions)
 
 ## Installation
 
@@ -108,6 +106,12 @@ Anonymize IP addresses
 Notable.mask_ips = true
 ```
 
+Scrub invalid UTF-8 from data
+
+```ruby
+Notable.scrub_invalid_utf8 = true
+```
+
 ### Jobs
 
 Set slow threshold

data/app/models/notable/request.rb

@@ -3,10 +3,6 @@ module Notable
     self.table_name = "notable_requests"
 
     belongs_to :user, polymorphic: true, optional: true
-    if ActiveRecord::VERSION::STRING.to_f >= 7.1
-      serialize :params, coder: JSON
-    else
-      serialize :params, JSON
-    end
+    serialize :params, coder: JSON
   end
 end

data/lib/notable/engine.rb

@@ -6,7 +6,7 @@ module Notable
       if Notable.requests_enabled?
         # insert in same place as request_store
         app.config.middleware.insert_after ActionDispatch::RequestId, Notable::Middleware
-        # TODO switch to register_interceptor in 0.6.0
+        # TODO switch to register_interceptor in 0.7.0
         ActionDispatch::DebugExceptions.prepend Notable::DebugExceptions
       end
     end

data/lib/notable/middleware.rb

@@ -10,8 +10,7 @@ module Notable
       request_time = Notable.monotonic_time - start_time
 
       Safely.safely do
-        if env["action_dispatch.exception"]
-          e = env["action_dispatch.exception"]
+        if (e = env["action_dispatch.exception"]) && (!defined?(ActionController::TooManyRequests) || !e.is_a?(ActionController::TooManyRequests))
           message =
             case status.to_i
             when 404
@@ -37,11 +36,19 @@ module Notable
           url = request.original_url
 
           controller = env["action_controller.instance"]
-          action = controller && "#{controller.params["controller"]}##{controller.params["action"]}"
-          params = controller && controller.request.filtered_parameters.except("controller", "action")
+          action = controller && "#{controller.controller_path}##{controller.action_name}"
+          params = controller && (controller.request.filtered_parameters.except("controller", "action") rescue nil)
 
           user = Notable.user_method.call(env)
 
+          user_agent = request.user_agent
+          referrer = request.referer
+
+          if Notable.scrub_invalid_utf8
+            user_agent = user_agent.scrub
+            referrer = referrer.scrub
+          end
+
           notes.each do |note|
             ip = request.remote_ip
             if ip && Notable.mask_ips
@@ -57,9 +64,9 @@ module Notable
               params: params,
               request_id: request.uuid,
               ip: ip,
-              user_agent: request.user_agent,
+              user_agent: user_agent,
               url: url,
-              referrer: request.referer,
+              referrer: referrer,
               request_time: request_time
             }
             Notable.track_request_method.call(data, env)

data/lib/notable/throttle.rb

@@ -5,3 +5,8 @@ ActiveSupport::Notifications.subscribe "rack.attack" do |_name, _start, _finish,
     Notable.track "Throttle", request.env["rack.attack.matched"]
   end
 end
+
+# TODO uncomment in 0.7.0
+# ActiveSupport::Notifications.subscribe "rate_limit.action_controller" do |_|
+#   Notable.track "Throttle", "throttle note"
+# end

data/lib/notable/version.rb

@@ -1,3 +1,3 @@
 module Notable
-  VERSION = "0.5.2"
+  VERSION = "0.6.1"
 end

data/lib/notable.rb

@@ -22,6 +22,7 @@ module Notable
     attr_accessor :user_method
     attr_accessor :slow_request_threshold
     attr_accessor :mask_ips
+    attr_accessor :scrub_invalid_utf8
 
     # jobs
     attr_accessor :track_job_method
@@ -31,6 +32,8 @@ module Notable
   self.requests_enabled = true
   self.jobs_enabled = true
   self.mask_ips = false
+  # TODO default to true in 0.7.0
+  self.scrub_invalid_utf8 = false
 
   def self.requests_enabled?
     enabled && requests_enabled
@@ -41,12 +44,12 @@ module Notable
   end
 
   # requests
-  self.track_request_method = -> (data, _) { Notable::Request.create!(data) }
-  self.user_method = -> (env) { env["warden"].user if env["warden"] }
+  self.track_request_method = ->(data, _) { Notable::Request.create!(data) }
+  self.user_method = ->(env) { env["warden"].user if env["warden"] }
   self.slow_request_threshold = 5
 
   # jobs
-  self.track_job_method = -> (data) { Notable::Job.create!(data) }
+  self.track_job_method = ->(data) { Notable::Job.create!(data) }
   self.slow_job_threshold = 60
 
   def self.track(note_type, note = nil)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: notable
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: safely_block
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
-description:
 email: andrew@ankane.org
 executables: []
 extensions: []
@@ -67,7 +65,6 @@ homepage: https://github.com/ankane/notable
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,15 +72,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Track notable requests and background jobs
 test_files: []