Merge pull request rails#55418 from jrochkind/rate_limit_notification_payload

rate_limit notification instrumentation to include more payload

Author: byroot

actionpack/CHANGELOG.md

@@ -1,3 +1,9 @@
+*   `rate_limit.action_controller` notification has additional payload
+
+    additonal values: count, to, within, by, name, cache_key
+
+    *Jonathan Rochkind*
+
 *   Add JSON support to the built-in health controller.
 
     The health controller now responds to JSON requests with a structured response

actionpack/lib/action_controller/metal/rate_limiting.rb

@@ -59,10 +59,18 @@ def rate_limit(to:, within:, by: -> { request.remote_ip }, with: -> { head :too_
 
     private
       def rate_limiting(to:, within:, by:, with:, store:, name:)
-        cache_key = ["rate-limit", controller_path, name, instance_exec(&by)].compact.join(":")
+        by = instance_exec(&by)
+        cache_key = ["rate-limit", controller_path, name, by].compact.join(":")
         count = store.increment(cache_key, 1, expires_in: within)
         if count && count > to
-          ActiveSupport::Notifications.instrument("rate_limit.action_controller", request: request) do
+          ActiveSupport::Notifications.instrument("rate_limit.action_controller",
+              request: request,
+              count: count,
+              to: to,
+              within: within,
+              by: by,
+              name: name,
+              cache_key: cache_key) do
             instance_exec(&with)
           end
         end

actionpack/test/controller/rate_limiting_test.rb

@@ -33,6 +33,20 @@ class RateLimitingTest < ActionController::TestCase
     assert_response :too_many_requests
   end
 
+  test "notification on limit action" do
+    get :limited
+    get :limited
+
+    assert_notification("rate_limit.action_controller",
+        count: 3,
+        to: 2,
+        within: 2.seconds,
+        name: nil,
+        by: request.remote_ip) do
+      get :limited
+    end
+  end
+
   test "multiple rate limits" do
     get :limited
     get :limited