A platform for community discussion. Free, open, simple.
FIX: Handle out-of-range values in session engagement beacons (#43715)
Krzysztof Kotlarekdccc47b0e90b
diff --git a/app/models/browser_pageview_session_engagement.rb b/app/models/browser_pageview_session_engagement.rbindex 96e2a286dce..cd4b8fc33d6 100644--- a/app/models/browser_pageview_session_engagement.rb+++ b/app/models/browser_pageview_session_engagement.rb@@ -2,6 +2,7 @@class BrowserPageviewSessionEngagement < ActiveRecord::BaseMAX_SESSION_ID_LENGTH = 32+ MAX_COLUMN_VALUE = 2**31 - 1BEACON_SETTLE_PERIOD = 30.minutesINTERACTION_COLUMNS = %i[@@ -37,20 +38,21 @@ class BrowserPageviewSessionEngagement < ActiveRecord::Basesession_id = session_id.slice(0, MAX_SESSION_ID_LENGTH)+ time_to_first_interaction_ms = nil if time_to_first_interaction_ms.to_i > MAX_COLUMN_VALUE++ counters =+ {+ mouse_move_events:,+ click_events:,+ key_events:,+ scroll_events:,+ touch_events:,+ back_forward_events:,+ engaged_seconds:,+ }.transform_values { |value| value.clamp(0, MAX_COLUMN_VALUE) }+upsert_all(- [- {- session_id:,- mouse_move_events:,- click_events:,- key_events:,- scroll_events:,- touch_events:,- back_forward_events:,- engaged_seconds:,- time_to_first_interaction_ms:,- },- ],+ [{ session_id:, **counters, time_to_first_interaction_ms: }],unique_by: :session_id,on_duplicate: greatest_on_duplicate_clause,record_timestamps: true,diff --git a/lib/middleware/request_tracker.rb b/lib/middleware/request_tracker.rbindex cddaaa42dce..fd4a7ef3999 100644--- a/lib/middleware/request_tracker.rb+++ b/lib/middleware/request_tracker.rb@@ -710,7 +710,9 @@ class Middleware::RequestTrackertime_to_first_interaction_ms: payload["time_to_first_interaction_ms"].presence&.to_i,)rescue => e- Rails.logger.warn("Discarding session engagement: #{e.message}")+ Rails.logger.warn(+ "#{RailsMultisite::ConnectionManagement.current_db}: Discarding session engagement: #{e.message}",+ )endenddiff --git a/spec/lib/middleware/request_tracker_spec.rb b/spec/lib/middleware/request_tracker_spec.rbindex 7cb052d3768..6cc82322c23 100644--- a/spec/lib/middleware/request_tracker_spec.rb+++ b/spec/lib/middleware/request_tracker_spec.rb@@ -1733,7 +1733,6 @@ RSpec.describe Middleware::RequestTracker do[payload.merge(session_id: 123),payload.merge(mouse_move_events: { "x" => 1 }),- payload.merge(mouse_move_events: 9_999_999_999),].each do |malformed|expect {status, = middleware.call(engagement_env(malformed, same_origin))@@ -1742,6 +1741,25 @@ RSpec.describe Middleware::RequestTracker doendend+ it "clamps out-of-range values instead of discarding the payload" do+ middleware = Middleware::RequestTracker.new(lambda { |_env| [200, {}, ["OK"]] })++ middleware.call(+ engagement_env(+ payload.merge(+ mouse_move_events: 9_999_999_999,+ time_to_first_interaction_ms: 3_781_140_981,+ ),+ same_origin,+ ),+ )++ expect(BrowserPageviewSessionEngagement.find_by(session_id: "sess-1")).to have_attributes(+ mouse_move_events: BrowserPageviewSessionEngagement::MAX_COLUMN_VALUE,+ time_to_first_interaction_ms: nil,+ )+ end+it "clamps engaged seconds to the configured maximum" doSiteSetting.browser_pageview_max_engaged_seconds = 60middleware = Middleware::RequestTracker.new(lambda { |_env| [200, {}, ["OK"]] })diff --git a/spec/models/browser_pageview_session_engagement_spec.rb b/spec/models/browser_pageview_session_engagement_spec.rbindex f52a7f1d210..03ea3efba3f 100644--- a/spec/models/browser_pageview_session_engagement_spec.rb+++ b/spec/models/browser_pageview_session_engagement_spec.rb@@ -39,6 +39,31 @@ RSpec.describe BrowserPageviewSessionEngagement doexpect(described_class.find_by(session_id: "sess-1").time_to_first_interaction_ms).to be_nilend+ it "clamps counters that exceed the integer column limit" do+ described_class.upsert_from_payload(**attributes.merge(mouse_move_events: 2**33))++ expect(described_class.find_by(session_id: "sess-1").mouse_move_events).to eq(+ described_class::MAX_COLUMN_VALUE,+ )+ end++ it "drops a time to first interaction that exceeds the integer column limit" do+ described_class.upsert_from_payload(+ **attributes.merge(time_to_first_interaction_ms: 3_781_140_981),+ )++ expect(described_class.find_by(session_id: "sess-1").time_to_first_interaction_ms).to be_nil+ end++ it "keeps a previously recorded time to first interaction when a later one is out of range" do+ described_class.upsert_from_payload(**attributes.merge(time_to_first_interaction_ms: 800))+ described_class.upsert_from_payload(+ **attributes.merge(time_to_first_interaction_ms: 3_781_140_981),+ )++ expect(described_class.find_by(session_id: "sess-1").time_to_first_interaction_ms).to eq(800)+ end+it "truncates an over-long session id to the column limit" dolong_id = "a" * (described_class::MAX_SESSION_ID_LENGTH + 10)