Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Wire in new `CustomerMailer` to handle customer facing reset passwords
Damian Legawiec487088fdd749
diff --git a/spree/api/app/controllers/spree/api/v3/store/customer/password_resets_controller.rb b/spree/api/app/controllers/spree/api/v3/store/customer/password_resets_controller.rbindex 6aaf4e08ac..7f5cd108bd 100644--- a/spree/api/app/controllers/spree/api/v3/store/customer/password_resets_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/customer/password_resets_controller.rb@@ -33,7 +33,7 @@ module Spreeif usertoken = user.generate_token_for(:password_reset)- event_payload = { reset_token: token, email: user.email }+ event_payload = { reset_token: token, email: user.email, store_id: current_store.prefixed_id }event_payload[:redirect_url] = redirect_url if redirect_url.present?user.publish_event('customer.password_reset_requested', event_payload)enddiff --git a/spree/core/app/mailers/spree/base_mailer.rb b/spree/core/app/mailers/spree/base_mailer.rbindex 4e5f883545..39e9e80331 100644--- a/spree/core/app/mailers/spree/base_mailer.rb+++ b/spree/core/app/mailers/spree/base_mailer.rb@@ -88,6 +88,19 @@ module Spree"#{resend ? "[#{Spree.t(:resend).upcase}] " : ''}#{store.name} #{subject} ##{number}"end+ # URI-based merge preserves existing query params and fragments so the token+ # doesn't get swallowed by a `#section` or clobber an existing `?source=`.+ def append_token(url, token)+ uri = URI.parse(url.to_s)+ params = URI.decode_www_form(uri.query || '')+ params << ['token', token.to_s]+ uri.query = URI.encode_www_form(params)+ uri.to_s+ rescue URI::InvalidURIError+ separator = url.include?('?') ? '&' : '?'+ "#{url}#{separator}token=#{CGI.escape(token.to_s)}"+ end+private# this ensures that ActionMailer::Base.default_url_options[:host] is always setdiff --git a/spree/core/config/locales/en.yml b/spree/core/config/locales/en.ymlindex 41fe97f467..193ca227e5 100644--- a/spree/core/config/locales/en.yml+++ b/spree/core/config/locales/en.yml@@ -820,6 +820,7 @@ en:greeting: Hi %{name},ignore_notice: If you did not request a password reset, you can safely ignore this email. Your password will not be changed.instructions: We received a request to reset your password. Click the button below to choose a new password.+ subject: Password Reset Instructionscustomer_return: Customer Returncustomer_returns: Customer Returnscustomer_support_email: Customer Support Emaildiff --git a/spree/core/lib/spree/core/previews/preview_data.rb b/spree/core/lib/spree/core/previews/preview_data.rbindex 25cb1453c9..41cce0aff7 100644--- a/spree/core/lib/spree/core/previews/preview_data.rb+++ b/spree/core/lib/spree/core/previews/preview_data.rb@@ -22,6 +22,15 @@ module SpreeSpree.admin_user_class.new(email: '[email protected]', first_name: 'Alex', last_name: 'Doe')end+ # A customer for previews of customer-facing account emails. Falls back to+ # an unsaved instance when the database has no users.+ def customer+ Spree.user_class.first ||+ Spree.user_class.new(email: '[email protected]').tap do |user|+ user.first_name = 'Alex' if user.respond_to?(:first_name=)+ end+ end+# The store previews render for. When the preview toolbar's locale dropdown# sets `?locale=`, return an unsaved copy of the default store with that# `default_locale`, so mailers that render in `store.default_locale` honourdiff --git a/spree/emails/app/mailers/spree/customer_mailer.rb b/spree/emails/app/mailers/spree/customer_mailer.rbnew file mode 100644index 0000000000..17a9194a1b--- /dev/null+++ b/spree/emails/app/mailers/spree/customer_mailer.rb@@ -0,0 +1,23 @@+module Spree+ class CustomerMailer < BaseMailer+ # Password reset requested through the Store API (`customer.password_reset_requested`).+ # The link goes to the validated redirect URL when the storefront supplied one,+ # falling back to the store's storefront URL, with the reset token appended.+ def password_reset_email(user, reset_token, store, redirect_url: nil)+ @user = user+ @current_store = store+ base_url = redirect_url.presence || store.storefront_url+ @reset_url = append_token(base_url, reset_token)++ with_store_locale(store) do+ mail(+ to: user.email,+ from: from_address,+ reply_to: reply_to_address,+ subject: "#{store.name} #{Spree.t('customer_mailer.password_reset_email.subject')}",+ store_url: store.storefront_url+ )+ end+ end+ end+enddiff --git a/spree/emails/app/mailers/spree/newsletter_mailer.rb b/spree/emails/app/mailers/spree/newsletter_mailer.rbindex d12b520948..ccbe87e1f0 100644--- a/spree/emails/app/mailers/spree/newsletter_mailer.rb+++ b/spree/emails/app/mailers/spree/newsletter_mailer.rb@@ -10,19 +10,5 @@ module Spreeendend- private-- # URI-based merge preserves existing query params and fragments so the token- # doesn't get swallowed by a `#section` or clobber an existing `?source=`.- def append_token(url, token)- uri = URI.parse(url.to_s)- params = URI.decode_www_form(uri.query || '')- params << ['token', token.to_s]- uri.query = URI.encode_www_form(params)- uri.to_s- rescue URI::InvalidURIError- separator = url.include?('?') ? '&' : '?'- "#{url}#{separator}token=#{CGI.escape(token.to_s)}"- endendenddiff --git a/spree/emails/app/subscribers/spree/customer_email_subscriber.rb b/spree/emails/app/subscribers/spree/customer_email_subscriber.rbnew file mode 100644index 0000000000..ba51f24677--- /dev/null+++ b/spree/emails/app/subscribers/spree/customer_email_subscriber.rb@@ -0,0 +1,30 @@+# frozen_string_literal: true++module Spree+ class CustomerEmailSubscriber < Spree::Subscriber+ subscribes_to 'customer.password_reset_requested'++ def handle(event)+ user = Spree.user_class.find_by(email: event.payload['email'])+ return unless user++ store = find_store(event)+ return unless store.prefers_send_consumer_transactional_emails?++ CustomerMailer.password_reset_email(+ user,+ event.payload['reset_token'],+ store,+ redirect_url: event.payload['redirect_url']+ ).deliver_later+ end++ private++ def find_store(event)+ Spree::Store.find_by_prefix_id(event.payload['store_id']) ||+ Spree::Current.store ||+ Spree::Store.default+ end+ end+enddiff --git a/spree/emails/lib/spree/emails/engine.rb b/spree/emails/lib/spree/emails/engine.rbindex fbe68523fb..93ce9e45ae 100644--- a/spree/emails/lib/spree/emails/engine.rb+++ b/spree/emails/lib/spree/emails/engine.rb@@ -23,7 +23,8 @@ module SpreeSpree::OrderEmailSubscriber,Spree::ShipmentEmailSubscriber,Spree::ReimbursementEmailSubscriber,- Spree::NewsletterSubscriberEmailSubscriber+ Spree::NewsletterSubscriberEmailSubscriber,+ Spree::CustomerEmailSubscriber]endenddiff --git a/spree/emails/lib/spree/emails/previews/customer_preview.rb b/spree/emails/lib/spree/emails/previews/customer_preview.rbnew file mode 100644index 0000000000..7d9bce16c0--- /dev/null+++ b/spree/emails/lib/spree/emails/previews/customer_preview.rb@@ -0,0 +1,14 @@+require 'spree/core/previews/preview_data'++# Preview Spree customer account emails at /rails/mailers/spree/customer+class Spree::CustomerPreview < ActionMailer::Preview+ include Spree::PreviewData::LocaleParam++ def password_reset_email+ Spree::CustomerMailer.password_reset_email(+ Spree::PreviewData.customer,+ 'preview-token',+ Spree::PreviewData.store(locale)+ )+ end+enddiff --git a/spree/emails/spec/mailers/spree/customer_mailer_spec.rb b/spree/emails/spec/mailers/spree/customer_mailer_spec.rbnew file mode 100644index 0000000000..b7fcb037ec--- /dev/null+++ b/spree/emails/spec/mailers/spree/customer_mailer_spec.rb@@ -0,0 +1,34 @@+require 'spec_helper'+require 'email_spec'++describe Spree::CustomerMailer, type: :mailer do+ include EmailSpec::Helpers+ include EmailSpec::Matchers++ let(:store) { @default_store }+ let(:user) { create(:user, email: '[email protected]') }+ let(:reset_token) { 'secret-reset-token' }++ describe '#password_reset_email' do+ it 'sends to the user with the store-prefixed subject' do+ message = described_class.password_reset_email(user, reset_token, store)++ expect(message.to).to eq(['[email protected]'])+ expect(message.from).to eq([store.mail_from_address])+ expect(message.subject).to eq("#{store.name} #{Spree.t('customer_mailer.password_reset_email.subject')}")+ end++ it 'links to the storefront URL with the reset token appended' do+ message = described_class.password_reset_email(user, reset_token, store)++ expect(message).to have_body_text("token=#{reset_token}")+ expect(message).to have_body_text(store.storefront_url.to_s)+ end++ it 'prefers the redirect URL when one was validated by the API' do+ message = described_class.password_reset_email(user, reset_token, store, redirect_url: 'https://storefront.example.com/account/reset-password')++ expect(message).to have_body_text("https://storefront.example.com/account/reset-password?token=#{reset_token}")+ end+ end+enddiff --git a/spree/emails/spec/subscribers/spree/customer_email_subscriber_spec.rb b/spree/emails/spec/subscribers/spree/customer_email_subscriber_spec.rbnew file mode 100644index 0000000000..d1f21e40e8--- /dev/null+++ b/spree/emails/spec/subscribers/spree/customer_email_subscriber_spec.rb@@ -0,0 +1,51 @@+# frozen_string_literal: true++require 'spec_helper'++RSpec.describe Spree::CustomerEmailSubscriber do+ let(:store) { @default_store }+ let(:user) { create(:user, email: '[email protected]') }+ let(:subscriber) { described_class.new }++ def mock_event(email:, redirect_url: nil, store_id: store.prefixed_id)+ payload = { 'email' => email, 'reset_token' => 'secret-reset-token', 'store_id' => store_id }+ payload['redirect_url'] = redirect_url if redirect_url+ double('Event', payload: payload)+ end++ before do+ store.update!(preferences: store.preferences.merge(send_consumer_transactional_emails: true))+ end++ describe 'customer.password_reset_requested event' do+ it 'sends the password reset email' do+ expect(Spree::CustomerMailer).to receive(:password_reset_email).+ with(user, 'secret-reset-token', store, redirect_url: nil).+ and_return(double(deliver_later: true))++ subscriber.handle(mock_event(email: user.email))+ end++ it 'forwards the redirect URL from the event payload' do+ expect(Spree::CustomerMailer).to receive(:password_reset_email).+ with(user, 'secret-reset-token', store, redirect_url: 'https://storefront.example.com/reset').+ and_return(double(deliver_later: true))++ subscriber.handle(mock_event(email: user.email, redirect_url: 'https://storefront.example.com/reset'))+ end++ it 'does nothing when no user matches the email' do+ expect(Spree::CustomerMailer).not_to receive(:password_reset_email)++ subscriber.handle(mock_event(email: '[email protected]'))+ end++ it 'does nothing when the store disabled consumer transactional emails' do+ store.update!(preferences: store.preferences.merge(send_consumer_transactional_emails: false))++ expect(Spree::CustomerMailer).not_to receive(:password_reset_email)++ subscriber.handle(mock_event(email: user.email))+ end+ end+end