Fix KeyError when using config.background_jobs = false due to not stringifying the keys

Author: westonganger

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ### Unreleased
 - [View Diff](https://github.com/westonganger/rails_local_analytics/compare/v0.2.3...master)
-- Nothing yet
+- [#18](https://github.com/westonganger/rails_local_analytics/pull/18) - Fix KeyError when using `config.background_jobs = false` due to not stringifying the keys
 
 ### v0.2.3 - Dec 17 2024
 - [View Diff](https://github.com/westonganger/rails_local_analytics/compare/v0.2.2...v0.2.3)

lib/rails_local_analytics.rb

@@ -29,7 +29,7 @@ def self.record_request(request:, custom_attributes: nil)
       json_str = JSON.generate(json_hash) # convert to json string so that its compatible with all job backends
       RecordRequestJob.perform_later(json_str)
     else
-      RecordRequestJob.new.perform(json_hash)
+      RecordRequestJob.new.perform(json_hash.deep_stringify_keys)
     end
   end
 

spec/model/rails_local_analytics_spec.rb

@@ -8,14 +8,6 @@
   end
 
   context "config.background_jobs" do
-    before do
-      @prev_background_jobs = described_class.config.background_jobs
-    end
-
-    after do
-      described_class.config.background_jobs = @prev_background_jobs
-    end
-
     it "defaults to true" do
       expect(described_class.config.background_jobs).to eq(true)
     end

spec/request/record_request_spec.rb

@@ -26,4 +26,28 @@
       "url_path" => "/",
     })
   end
+
+  it "works with config.background_jobs = false" do
+    RailsLocalAnalytics.config.background_jobs = false
+
+    get root_path
+    expect(response.status).to eq(200)
+
+    expect(TrackedRequestsByDaySite.last.attributes.except("id")).to eq({
+      "browser_engine" => nil,
+      "day" => Date.today,
+      "platform" => nil,
+      "total" => 1,
+      "url_hostname" => "www.example.com",
+    })
+
+    expect(TrackedRequestsByDayPage.last.attributes.except("id")).to eq({
+      "day" => Date.today,
+      "referrer_hostname" => nil,
+      "referrer_path" => nil,
+      "total" => 1,
+      "url_hostname" => "www.example.com",
+      "url_path" => "/",
+    })
+  end
 end

spec/spec_helper.rb

@@ -48,4 +48,12 @@
     end
   end
 
+  DEFAULT_CONFIG ||= RailsLocalAnalytics.config.instance_variables.map{|name| [name, RailsLocalAnalytics.config.instance_variable_get(name)] }.to_h
+
+  config.after(:each) do
+    DEFAULT_CONFIG.each do |k,v|
+      RailsLocalAnalytics.config.send("#{k}=", v)
+    end
+  end
+
 end