Get single page notification button from personalisation API on load #2443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
7d4ccc8 to
0daaec7
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
0daaec7 to
6282744
Compare
danacotoran
changed the title
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
117501d to
6282744
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
c8e31a1 to
7c8480e
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
aa4e566 to
1be1a48
Compare
barrucadu
reviewed
Nov 12, 2021
...assets/javascripts/govuk_publishing_components/components/single-page-notification-button.js
Outdated
Show resolved
Hide resolved
andysellick
reviewed
Nov 12, 2021
...assets/javascripts/govuk_publishing_components/components/single-page-notification-button.js
Show resolved
Hide resolved
spec/javascripts/components/single-page-notification-button-spec.js
Outdated
Show resolved
Hide resolved
barrucadu
reviewed
Nov 12, 2021
app/views/govuk_publishing_components/components/_single_page_notification_button.html.erb
Outdated
Show resolved
Hide resolved
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
1be1a48 to
22c3bb2
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
22c3bb2 to
7f39893
Compare
andysellick
reviewed
Nov 15, 2021
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
0b6cac3 to
18a8175
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
18a8175 to
78b21e1
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
78b21e1 to
b3595d2
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
b3595d2 to
96e695d
Compare
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
96e695d to
f7bfb15
Compare
alex9smith
approved these changes
Nov 16, 2021
andysellick
reviewed
Nov 17, 2021
lib/govuk_publishing_components/presenters/single_page_notification_button_helper.rb
Outdated
Show resolved
Hide resolved
...assets/javascripts/govuk_publishing_components/components/single-page-notification-button.js
Outdated
Show resolved
Hide resolved
lib/govuk_publishing_components/presenters/single_page_notification_button_helper.rb
Show resolved
Hide resolved
spec/javascripts/components/single-page-notification-button-spec.js
Outdated
Show resolved
Hide resolved
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
f7bfb15 to
a69b55d
Compare
andysellick
approved these changes
Nov 18, 2021
Introduce JS that calls our personalisation API on page load. If the user is authenticated, and already subscribed to email notifications on the current page, the account-api serves the "Already subscribed" version of the button HTML. Add data attributes for analytics.
danacotoran
force-pushed
the
js-enhancement-single-page-notif-button
branch
from
a69b55d to
674540b
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The single page notification button exists in two states: default (unsubscribed) and already subscribed.
If a user is authenticated and already subscribed to email notifications on the current page, the button should say "Stop getting emails about this page". To request the user data for this layer of personalisation, there is a need to bypass the CDN, however it is not practical to serve all such requests from origin (especially on relatively high traffic pages such as the ones it is likely this feature will be added to).
As such the solution we've landed on is to use JS to perform this check on page load as an enhancement.
account-apiserves the button HTML from the/api/personalisation/check-email-subscriptionendpoint – if the user is authenticated and already subscribed to the current page, the endpoint serves the "Already subscribed" variant of the button. The button that already exists on the page is replaced with this updated version, so the user can see that they are already subscribed to emails about the current page.