Standardize on symbol keys for the payload

Author: adrianna-chang-shopify

activesupport/lib/active_support/event_reporter.rb

@@ -209,6 +209,15 @@ def clear
   #       end
   #     end
   #
+  # The Event Reporter standardizes on symbol keys for all payload data, tags, and context store entries.
+  # String keys are automatically converted to symbols for consistency.
+  #
+  #   Rails.event.notify("user.created", { "id" => 123 })
+  #   # Emits event:
+  #   #  {
+  #   #    name: "user.created",
+  #   #    payload: { id: 123 },
+  #   #  }
   class EventReporter
     attr_reader :subscribers
     attr_accessor :raise_on_error
@@ -482,9 +491,9 @@ def resolve_payload(name_or_object, payload, **kwargs)
         when String, Symbol
           handle_unexpected_args(name_or_object, payload, kwargs) if payload && kwargs.any?
           if kwargs.any?
-            kwargs
+            kwargs.transform_keys(&:to_sym)
           elsif payload
-            payload
+            payload.transform_keys(&:to_sym)
           end
         else
           handle_unexpected_args(name_or_object, payload, kwargs) if payload || kwargs.any?

activesupport/test/event_reporter_test.rb

@@ -79,6 +79,14 @@ def initialize(http_method, http_status)
       end
     end
 
+    test "#notify symbolizes keys in hash payload" do
+      assert_called_with(@subscriber, :emit, [
+        event_matcher(name: "test_event", payload: { key: "value" })
+      ]) do
+        @reporter.notify(:test_event, { "key" => "value" })
+      end
+    end
+
     test "#notify with hash payload and kwargs raises" do
       error = assert_raises(ArgumentError) do
         @reporter.notify(:test_event, { key: "value" }, extra: "arg")
@@ -378,7 +386,7 @@ def test_method_debug
       http_tag = HttpRequestTag.new("GET", 200)
       @reporter.tagged("foobar", http_tag, shop_id: 123) do
         assert_called_with(@subscriber, :emit, [
-          event_matcher(name: "test_event", payload: { key: "value" }, tags: { "foobar": true, "HttpRequestTag": http_tag, shop_id: 123 })
+          event_matcher(name: "test_event", payload: { key: "value" }, tags: { foobar: true, "HttpRequestTag": http_tag, shop_id: 123 })
         ]) do
           @reporter.notify(:test_event, key: "value")
         end