Skip to content

[DO NOT MERGE] Pass attachment name to GA4 details component tracking #4601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+30 −6
Draft

[DO NOT MERGE] Pass attachment name to GA4 details component tracking #4601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/views/govuk_publishing_components/components/_attachment.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
attributes = []
url_data_attributes ||= {}
details_ga4_attributes ||= {}
details_ga4_attributes[:section] = attachment.title unless details_ga4_attributes[:section]
shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)

component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
Expand Down
1 change: 0 additions & 1 deletion app/views/govuk_publishing_components/components/_details.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
event_name: "select_content",
type: "detail",
text: title,
section: title,
index_section: @ga4[:index_section],
}
ga4_event.merge!(ga4_attributes)
Expand Down
26 changes: 25 additions & 1 deletion spec/components/attachment_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,38 @@ def component_name
event_name: "select_content",
type: "detail",
text: "Request an accessible format.",
section: "Request an accessible format.",
index_section: 1,
index_section_count: 4,
another_attribute: "here",
section: "Attachment",
}.to_json
assert_select ".govuk-details[data-ga4-event='#{attributes}']"
end

it "allows the default GA4 section on the details component to be overwritten" do
render_component(
attachment: {
title: "Attachment",
url: "attachment",
content_type: "application/vnd.oasis.opendocument.spreadsheet",
alternative_format_contact_email: "[email protected]",
},
details_ga4_attributes: {
section: "Hello",
},
)
assert_select "a[href='mailto:[email protected]']"
attributes = {
event_name: "select_content",
type: "detail",
text: "Request an accessible format.",
index_section: 1,
section: "Hello",
}.to_json
puts rendered
assert_select ".govuk-details[data-ga4-event='#{attributes}']"
end

it "does not show opendocument metadata if disabled" do
render_component(
attachment: {
Expand Down
8 changes: 4 additions & 4 deletions spec/components/details_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,26 +58,26 @@ def component_name

it "increments the GA4 index_section parameter when more than one component instance" do
render_component(title: "first details")
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"detail","text":"first details","section":"first details","index_section":1}\']'
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"detail","text":"first details","index_section":1}\']'

render_component(title: "second details")
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"detail","text":"second details","section":"second details","index_section":2}\']'
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"detail","text":"second details","index_section":2}\']'
end

it "accepts GA4 event data parameters" do
render_component(
title: "some title",
ga4_attributes: { index_section_count: 12 },
)
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"detail","text":"some title","section":"some title","index_section":1,"index_section_count":12}\']'
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"detail","text":"some title","index_section":1,"index_section_count":12}\']'
end

it "can override GA4 event data parameters" do
render_component(
title: "some title",
ga4_attributes: { type: "a mouse!", index_section_count: 12 },
)
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"a mouse!","text":"some title","section":"some title","index_section":1,"index_section_count":12}\']'
assert_select '.govuk-details[data-ga4-event=\'{"event_name":"select_content","type":"a mouse!","text":"some title","index_section":1,"index_section_count":12}\']'
end

it "can disable GA4" do
Expand Down