A platform for community discussion. Free, open, simple.
FIX: Skip third-party analytics tags in full app embed iframes (#39534)
Rafael dos Santos Silva4ce1685a726f
diff --git a/app/helpers/common_helper.rb b/app/helpers/common_helper.rbindex 78b5c8716e5..ac59113dde1 100644--- a/app/helpers/common_helper.rb+++ b/app/helpers/common_helper.rb@@ -2,22 +2,32 @@module CommonHelperdef render_google_universal_analytics_code+ return if suppress_analytics_in_embed?if Rails.env.production? && SiteSetting.ga_universal_tracking_code.present?render partial: "common/google_universal_analytics"endenddef render_google_tag_manager_head_code+ return if suppress_analytics_in_embed?render partial: "common/google_tag_manager_head" if SiteSetting.gtm_container_id.present?enddef render_google_tag_manager_body_code+ return if suppress_analytics_in_embed?render partial: "common/google_tag_manager_body" if SiteSetting.gtm_container_id.present?enddef render_adobe_analytics_tags_code+ return if suppress_analytics_in_embed?if SiteSetting.adobe_analytics_tags_url.present?content_tag(:script, "", src: SiteSetting.adobe_analytics_tags_url, async: true)endend++ private++ def suppress_analytics_in_embed?+ params[:embed_mode].present? && SiteSetting.suppress_third_party_analytics_in_embed+ endenddiff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex aa092cd7170..ff23cb6ff51 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -2570,6 +2570,7 @@ en:allowed_embed_selectors: "A comma separated list of CSS elements that are allowed in embeds."allowed_href_schemes: "Schemes allowed in links in addition to http and https."embed_full_app: "Enable full app mode for embedded comments. When enabled, embedded comments will load the full Discourse application in an iframe, allowing users to interact with topics directly"+ suppress_third_party_analytics_in_embed: "Skip rendering third-party analytics scripts (Google Tag Manager, Google Analytics, Adobe Analytics) when Discourse is loaded inside a full app embed iframe. Prevents duplicate pageviews and tag firing when the host page already loads the same scripts."embed_post_limit: "Maximum number of posts to embed."embed_username_required: "The username for topic creation is required."notify_about_reviewable_item_after: "If there are reviewable items that haven’t been handled after this many hours, send a personal message to moderators. Set to 0 to disable."diff --git a/config/site_settings.yml b/config/site_settings.ymlindex 42df0cabdb2..4d86862a3de 100644--- a/config/site_settings.yml+++ b/config/site_settings.yml@@ -3284,6 +3284,9 @@ embedding:default: falseclient: truearea: "embedding"+ suppress_third_party_analytics_in_embed:+ default: true+ area: "embedding"embed_by_username:default: ""type: usernamediff --git a/spec/requests/topics_controller_spec.rb b/spec/requests/topics_controller_spec.rbindex 31f0fc51c0f..e2afd679a07 100644--- a/spec/requests/topics_controller_spec.rb+++ b/spec/requests/topics_controller_spec.rb@@ -7254,4 +7254,43 @@ RSpec.describe TopicsController doexpect(response.headers["X-Frame-Options"]).to eq("SAMEORIGIN")endend++ describe "third-party analytics in embed mode" do+ fab!(:topic)++ before do+ SiteSetting.embed_full_app = true+ SiteSetting.gtm_container_id = "GTM-ABCDEF"+ SiteSetting.adobe_analytics_tags_url = "https://assets.adobedtm.com/launch-EN.min.js"+ end++ def parsed_body+ Nokogiri::HTML5.fragment(response.body)+ end++ it "renders analytics tags by default" do+ get "/t/#{topic.slug}/#{topic.id}"+ expect(parsed_body.css("#data-google-tag-manager")).to be_present+ expect(+ parsed_body.css("script[src='https://assets.adobedtm.com/launch-EN.min.js']"),+ ).to be_present+ end++ it "skips analytics tags when loaded in embed mode" do+ get "/t/#{topic.slug}/#{topic.id}", params: { embed_mode: "true" }+ expect(parsed_body.css("#data-google-tag-manager")).to be_empty+ expect(+ parsed_body.css("script[src='https://assets.adobedtm.com/launch-EN.min.js']"),+ ).to be_empty+ end++ it "still renders analytics tags in embed mode when suppression setting is disabled" do+ SiteSetting.suppress_third_party_analytics_in_embed = false+ get "/t/#{topic.slug}/#{topic.id}", params: { embed_mode: "true" }+ expect(parsed_body.css("#data-google-tag-manager")).to be_present+ expect(+ parsed_body.css("script[src='https://assets.adobedtm.com/launch-EN.min.js']"),+ ).to be_present+ end+ endend