Include link to unsubscribe in email notifications #4301

taitus · 2020-12-29T14:37:13Z

Objectives

Allow users to unsubscribe from email notifications through an "Unsubscribe" link in the footer of the email without the need to log in.
This link will take them to a unsubscribe page where they can manage the notifications they want to receive.

Visual Changes

app/views/mailer/comment.html.erb

app/controllers/unsubscribes_controller.rb

config/routes/unsubscribe.rb

spec/models/user_spec.rb

spec/system/emails_spec.rb

spec/system/unsubscribes_spec.rb

javierm

@taitus Here's an initial review. Let me know what you think! 😉

app/controllers/unsubscribes_controller.rb

config/routes/unsubscribe.rb

lib/tasks/users.rake

db/schema.rb

app/models/user.rb

app/views/mailer/comment.html.erb

spec/system/subscriptions_spec.rb

javierm

Probably my final review here; just found a couple of typos and a possible cause of flaky tests. I'm gonna miss this pull request 😄.

spec/models/user_spec.rb

spec/system/subscriptions_spec.rb

spec/mailers/mailer_spec.rb

Note that we only update a user with a new token if the user has not yet been assigned one.

The user can access this page without being logged in. We identify the user through the "subscriptions_token" parameter and show a list of the notifications that can be enable/disable. We will return a 404 error in case someone accesses the page with a non-existent token. We also control the case that some anonymous user tries to access the page without any token, by returning the CanCan::AccessDenied exception.

You can update the same "notifications" section that we allow you to update in "my account". This "subscriptions" section differs from the "my account" section because we do not need to be logged in to update the status of the notifications.

We modified the link that previously redirected us to the "My content" page to redirect us to the new page for managing subscriptions. We also adapted the existing generic text by adding a description of the related notification.

We modified the link that previously redirected us to the "My content" page to redirect us to the new page for managing subscriptions.

I think the "slashes" can be removed. The specs work fine without the "slashes".

We modified the link that previously redirected us to the "My content" page to redirect us to the new page for managing subscriptions. We also adapted the existing generic text by adding a description of the related notification.

We add new method set_user_locale to render the page with the user's preferred locale. Note that we add a condition 'if params[:locale].blank?' to recover the user's preferred locale. This is necessary because it may be the case that the user does not have an associated locale, and when execute '@user.locale' when this value is 'nil', by default returns the default locale. As we do not want this to happen and we want the locale we receive as parameter to prevail in this case.

Currently the translation: "Notify me by email when someone comments on my proposals or debates" It only refers to proposals and debates, but actually it also refers to budget investments, topics and polls.

taitus force-pushed the unsubscribe branch from 4b0681c to 5fc7cde Compare December 29, 2020 14:40

javierm added this to Reviewing in Consul Democracy via automation Dec 29, 2020

javierm moved this from Reviewing to Doing in Consul Democracy Dec 29, 2020

javierm assigned taitus Dec 29, 2020

javierm added the Newsletters label Dec 29, 2020

taitus force-pushed the unsubscribe branch 3 times, most recently from 71aacc6 to 7d9689f Compare February 2, 2021 09:58

taitus marked this pull request as ready for review February 2, 2021 10:02

taitus moved this from Doing to Reviewing in Consul Democracy Feb 2, 2021

javierm added the post-1.3 label Feb 14, 2021

javierm removed the post-1.3 label Apr 23, 2021

taitus force-pushed the unsubscribe branch from 7d9689f to 387ec72 Compare June 17, 2021 06:37