Fix Rails session data not being reported

The Rails session data was a non Hash object. It would not be stored on the transaction because it wasn't a Hash. It can be cast to a Hash, so let's explicitly cast it before setting the session data.
appsignal · Aug 23, 2024 · 1565c7f · 1565c7f
1 parent 0a658e5
commit 1565c7f
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 3 deletions.
diff --git a/.changesets/fix-rails-session-data-not-being-reported.md b/.changesets/fix-rails-session-data-not-being-reported.md
@@ -0,0 +1,6 @@
+---
+bump: patch
+type: fix
+---
+
+Fix Rails session data not being reported.
diff --git a/lib/appsignal/rack/abstract_middleware.rb b/lib/appsignal/rack/abstract_middleware.rb
@@ -142,9 +142,7 @@ def add_transaction_metadata_after(transaction, request)
         transaction.set_metadata("method", request_method) if request_method
 
         transaction.add_params { params_for(request) }
-        transaction.add_session_data do
-          request.session if request.respond_to?(:session)
-        end
+        transaction.add_session_data { session_data_for(request) }
         transaction.add_headers do
           request.env if request.respond_to?(:env)
         end
@@ -174,6 +172,18 @@ def request_method_for(request)
         nil
       end
 
+      def session_data_for(request)
+        return unless request.respond_to?(:session)
+
+        request.session.to_h
+      rescue => error
+        Appsignal.internal_logger.error(
+          "Exception while fetching session data from '#{@request_class}': " \
+            "#{error.class} #{error}"
+        )
+        nil
+      end
+
       def request_for(env)
         @request_class.new(env)
       end

diff --git a/spec/lib/appsignal/rack/abstract_middleware_spec.rb b/spec/lib/appsignal/rack/abstract_middleware_spec.rb
@@ -1,4 +1,14 @@
 describe Appsignal::Rack::AbstractMiddleware do
+  class HashLike < Hash
+    def initialize(value)
+      @value = value
+    end
+
+    def to_h
+      @value
+    end
+  end
+
   let(:app) { DummyApp.new }
   let(:request_path) { "/some/path" }
   let(:env) do
@@ -261,6 +271,13 @@ def params
 
           expect(last_transaction).to include_session_data("session" => "data", "user_id" => 123)
         end
+
+        it "sets session data if the session is a Hash-like type" do
+          env["rack.session"] = HashLike.new("hash-like" => "value", "user_id" => 123)
+          make_request
+
+          expect(last_transaction).to include_session_data("hash-like" => "value", "user_id" => 123)
+        end
       end
 
       context "with queue start header" do