A platform for community discussion. Free, open, simple.
FIX: Anon pageview session id reused across cached responses (#39879)
Alan Guo Xiang Tanef90ef7d8dcc
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rbindex 6ecf719a9ec..cc381c5ec93 100644--- a/app/helpers/application_helper.rb+++ b/app/helpers/application_helper.rb@@ -71,6 +71,12 @@ module ApplicationHelperContentSecurityPolicy.nonce_placeholder(response.headers)end+ def track_view_session_id_placeholder+ response.headers[+ ::Middleware::TrackViewSessionIdInjector::PLACEHOLDER_HEADER+ ] ||= "[[track_view_session_id_placeholder_#{SecureRandom.hex}]]"+ end+def shared_session_keyif SiteSetting.long_polling_base_url != "/" && current_usersk = "shared_session_key"@@ -434,7 +440,10 @@ module ApplicationHelperendtags = +""- tags << tag.meta(name: "discourse-track-view-session-id", content: SecureRandom.base64(32))+ tags << tag.meta(+ name: "discourse-track-view-session-id",+ content: track_view_session_id_placeholder,+ )if SiteSetting.use_beacon_for_browser_page_viewstags << tag.meta(name: "discourse-beacon-pageview-enabled", content: "true")enddiff --git a/config/application.rb b/config/application.rbindex 596b560a887..ec970f07e0e 100644--- a/config/application.rb+++ b/config/application.rb@@ -167,6 +167,9 @@ module Discourserequire "middleware/csp_script_nonce_injector"config.middleware.insert_after(ActionDispatch::Flash, Middleware::CspScriptNonceInjector)+ require "middleware/track_view_session_id_injector"+ config.middleware.insert_after(ActionDispatch::Flash, Middleware::TrackViewSessionIdInjector)+require "middleware/discourse_public_exceptions"config.exceptions_app = Middleware::DiscoursePublicExceptions.new(Rails.public_path)diff --git a/lib/middleware/track_view_session_id_injector.rb b/lib/middleware/track_view_session_id_injector.rbnew file mode 100644index 00000000000..6ec165c6efe--- /dev/null+++ b/lib/middleware/track_view_session_id_injector.rb@@ -0,0 +1,24 @@+# frozen_string_literal: true++module Middleware+ class TrackViewSessionIdInjector+ PLACEHOLDER_HEADER = "Discourse-Track-View-Session-Id-Placeholder"++ def initialize(app, settings = {})+ @app = app+ end++ def call(env)+ status, headers, response = @app.call(env)++ if placeholder = headers.delete(PLACEHOLDER_HEADER)+ session_id = SecureRandom.alphanumeric(Middleware::RequestTracker::MAX_SESSION_ID_LENGTH)+ parts = []+ response.each { |part| parts << part.to_s.sub(placeholder, session_id) }+ [status, headers, parts]+ else+ [status, headers, response]+ end+ end+ end+enddiff --git a/spec/integrity/middleware_order_spec.rb b/spec/integrity/middleware_order_spec.rbindex 8ca31df4a8f..67089050731 100644--- a/spec/integrity/middleware_order_spec.rb+++ b/spec/integrity/middleware_order_spec.rb@@ -27,6 +27,7 @@ RSpec.describe "Middleware order" doDiscourse::Cors,ActionDispatch::Flash,RspecErrorTracker,+ Middleware::TrackViewSessionIdInjector,Middleware::CspScriptNonceInjector,Middleware::AnonymousCache,ContentSecurityPolicy::Middleware,diff --git a/spec/requests/application_controller_spec.rb b/spec/requests/application_controller_spec.rbindex f7865e274f5..64fe5bcfcd1 100644--- a/spec/requests/application_controller_spec.rb+++ b/spec/requests/application_controller_spec.rb@@ -1109,6 +1109,47 @@ RSpec.describe ApplicationController doendend+ describe "browser pageview tracking session id" do+ it "doesn't reuse session ids between requests served from the anon cache" do+ global_setting :anon_cache_store_threshold, 1+ Middleware::AnonymousCache.enable_anon_cache+ Middleware::AnonymousCache.clear_all_cache!++ SiteSetting.trigger_browser_pageview_events = true++ get "/latest"++ expect(response.headers["X-Discourse-Cached"]).to eq("store")+ expect(response.headers).not_to include(+ Middleware::TrackViewSessionIdInjector::PLACEHOLDER_HEADER,+ )++ session_id_format = /\A[A-Za-z0-9]{#{Middleware::RequestTracker::MAX_SESSION_ID_LENGTH}}\z/++ first_session_id = extract_session_id_from_body(response.body)+ expect(first_session_id).to match(session_id_format)++ get "/latest"++ expect(response.headers["X-Discourse-Cached"]).to eq("true")+ expect(response.headers).not_to include(+ Middleware::TrackViewSessionIdInjector::PLACEHOLDER_HEADER,+ )++ second_session_id = extract_session_id_from_body(response.body)+ expect(second_session_id).to match(session_id_format)++ expect(first_session_id).not_to eq(second_session_id)+ end++ def extract_session_id_from_body(body)+ meta_tag =+ Nokogiri::HTML5.fragment(body).css("meta[name='discourse-track-view-session-id']").first+ expect(meta_tag).to be_present+ meta_tag["content"]+ end+ end+it "can respond to a request with */* accept header" doget "/", headers: { HTTP_ACCEPT: "*/*" }expect(response.status).to eq(200)diff --git a/spec/system/page_objects/pages/pageview_tracking.rb b/spec/system/page_objects/pages/pageview_tracking.rbnew file mode 100644index 00000000000..aecffa101a5--- /dev/null+++ b/spec/system/page_objects/pages/pageview_tracking.rb@@ -0,0 +1,11 @@+# frozen_string_literal: true++module PageObjects+ module Pages+ class PageviewTracking < PageObjects::Pages::Base+ def session_id+ find("meta[name='discourse-track-view-session-id']", visible: :all)[:content]+ end+ end+ end+enddiff --git a/spec/system/request_tracker_spec.rb b/spec/system/request_tracker_spec.rbindex 44177917c78..177ee0cd971 100644--- a/spec/system/request_tracker_spec.rb+++ b/spec/system/request_tracker_spec.rb@@ -15,6 +15,8 @@ describe "Request tracking" doCachedCounting.disableend+ let(:pageview_tracking) { PageObjects::Pages::PageviewTracking.new }+describe "pageviews" doit "tracks an anonymous visit correctly" doevents =@@ -44,7 +46,7 @@ describe "Request tracking" doexpect(event[:url]).to eq("#{Discourse.base_url_no_prefix}/")expect(event[:ip_address]).to eq("::1")expect(event[:referrer]).to be_blank- expect(event[:session_id]).to be_present+ expect(event[:session_id]).to eq(pageview_tracking.session_id)events =DiscourseEvent.track_events(:browser_pageview) do