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
Add store_id to Spree::NewsletterSubscriber (#14035)
Kacper Mękarskia348379be405
diff --git a/spree/admin/spec/controllers/spree/admin/newsletter_subscribers_controller_spec.rb b/spree/admin/spec/controllers/spree/admin/newsletter_subscribers_controller_spec.rbindex b114b0189d..731ad55acb 100644--- a/spree/admin/spec/controllers/spree/admin/newsletter_subscribers_controller_spec.rb+++ b/spree/admin/spec/controllers/spree/admin/newsletter_subscribers_controller_spec.rb@@ -16,7 +16,7 @@ RSpec.describe Spree::Admin::NewsletterSubscribersController, type: :controllerenddescribe '#destroy' do- let!(:newsletter_subscriber) { Spree::NewsletterSubscriber.create!(email: '[email protected]') }+ let!(:newsletter_subscriber) { create(:newsletter_subscriber) }it 'destroys the newsletter subscriber and redirects' doexpect {diff --git a/spree/core/app/models/spree/newsletter_subscriber.rb b/spree/core/app/models/spree/newsletter_subscriber.rbindex 9282774eb2..e0a2e8a93d 100644--- a/spree/core/app/models/spree/newsletter_subscriber.rb+++ b/spree/core/app/models/spree/newsletter_subscriber.rb@@ -3,6 +3,7 @@ module Spreehas_prefix_id :subinclude Spree::Metafields+ include Spree::SingleStoreResourcepublishes_lifecycle_events@@ -12,6 +13,7 @@ module Spree# Associations#belongs_to :user, optional: true, class_name: Spree.user_class&.name+ belongs_to :store, class_name: 'Spree::Store', required: true## Validations@@ -19,7 +21,7 @@ module Spreevalidates :email,presence: true,format: { with: URI::MailTo::EMAIL_REGEXP },- uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope }+ uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope + [:store_id] }## Scopes@@ -30,6 +32,7 @@ module Spree## Callbacks#+ before_validation :set_store, unless: :store_id?normalizes :email, with: ->(email) { email.to_s.strip.downcase.presence }#@@ -52,8 +55,10 @@ module SpreeSpree::CSV::NewsletterSubscriberPresenter.new(self).callend- def self.subscribe(email:, user: nil)- Spree::Newsletter::Subscribe.new(email: email, current_user: user).call+ def self.subscribe(email:, user: nil, store: nil)+ store ||= Spree::Current.store++ Spree::Newsletter::Subscribe.new(email: email, current_user: user, current_store: store).callenddef self.verify(token:)@@ -61,5 +66,11 @@ module SpreeSpree::Newsletter::Verify.new(subscriber: subscriber).callend++ private++ def set_store+ self.store ||= Spree::Current.store+ endendenddiff --git a/spree/core/app/models/spree/order/checkout.rb b/spree/core/app/models/spree/order/checkout.rbindex 12ad2893a5..276763ef00 100644--- a/spree/core/app/models/spree/order/checkout.rb+++ b/spree/core/app/models/spree/order/checkout.rb@@ -135,7 +135,7 @@ module Spreedef subscribe_to_newsletterreturn unless accept_marketing?- Spree::NewsletterSubscriber.subscribe(email: email, user: user)+ Spree::NewsletterSubscriber.subscribe(email: email, user: user, store: store)enddef self.go_to_state(name, options = {})diff --git a/spree/core/app/services/spree/newsletter/subscribe.rb b/spree/core/app/services/spree/newsletter/subscribe.rbindex d2c067f611..63827d4c04 100644--- a/spree/core/app/services/spree/newsletter/subscribe.rb+++ b/spree/core/app/services/spree/newsletter/subscribe.rb@@ -1,9 +1,10 @@module Spreemodule Newsletterclass Subscribe- def initialize(email:, current_user: nil)+ def initialize(email:, current_user: nil, current_store: nil)@email = email@current_user = current_user+ @current_store = current_store || Spree::Store.currentenddef call@@ -26,17 +27,17 @@ module Spreeprivate- attr_reader :email, :current_user+ attr_reader :email, :current_user, :current_storedef upsert_subscriber- @upsert_subscriber ||= Spree::NewsletterSubscriber.find_or_create_by(email: email) do |new_record|+ @upsert_subscriber ||= Spree::NewsletterSubscriber.find_or_create_by(email: email, store: current_store) do |new_record|new_record.user = Spree.user_class.find_by(email: new_record.email) || current_userendendalias_method :subscriber, :upsert_subscriberdef existed_subscription- @existed_subscription ||= Spree::NewsletterSubscriber.verified.find_by(email: email)+ @existed_subscription ||= Spree::NewsletterSubscriber.verified.find_by(email: email, store: current_store)endendenddiff --git a/spree/core/db/migrate/20260515000001_add_store_id_to_spree_newsletter_subscribers.rb b/spree/core/db/migrate/20260515000001_add_store_id_to_spree_newsletter_subscribers.rbnew file mode 100644index 0000000000..1b390b02f1--- /dev/null+++ b/spree/core/db/migrate/20260515000001_add_store_id_to_spree_newsletter_subscribers.rb@@ -0,0 +1,26 @@+class AddStoreIdToSpreeNewsletterSubscribers < ActiveRecord::Migration[7.2]+ def up+ add_reference :spree_newsletter_subscribers, :store++ if defined?(SpreeMultiTenant)+ Spree::Tenant.find_each do |tenant|+ SpreeMultiTenant.with_tenant(tenant) do+ Spree::NewsletterSubscriber.where(store_id: nil).update_all(store_id: Spree::Store.default.id)+ end+ end+ else+ Spree::NewsletterSubscriber.update_all(store_id: Spree::Store.default.id)+ end++ change_column_null :spree_newsletter_subscribers, :store_id, false++ remove_index :spree_newsletter_subscribers, :email, unique: true, if_exists: true+ add_index :spree_newsletter_subscribers, [:email, :store_id], unique: true, if_not_exists: true+ end++ def down+ remove_index :spree_newsletter_subscribers, [:email, :store_id], if_exists: true+ add_index :spree_newsletter_subscribers, :email, unique: true, if_not_exists: true+ remove_reference :spree_newsletter_subscribers, :store+ end+enddiff --git a/spree/core/lib/spree/testing_support/factories/newsletter_subscriber_factory.rb b/spree/core/lib/spree/testing_support/factories/newsletter_subscriber_factory.rbindex c32f54846a..642d960c13 100644--- a/spree/core/lib/spree/testing_support/factories/newsletter_subscriber_factory.rb+++ b/spree/core/lib/spree/testing_support/factories/newsletter_subscriber_factory.rb@@ -3,6 +3,8 @@ FactoryBot.define doemail { FFaker::Internet.unique.email }verified_at { nil }+ store { Spree::Current.store || create(:store) }+trait :with_user doassociation :user, factory: :userenddiff --git a/spree/core/lib/tasks/core.rake b/spree/core/lib/tasks/core.rakeindex bc3140a1ed..14807d1da0 100644--- a/spree/core/lib/tasks/core.rake+++ b/spree/core/lib/tasks/core.rake@@ -43,6 +43,7 @@ namespace :core douser_id: id,verified_at: updated_at,verification_token: nil,+ store_id: Spree::Store.default&.id,updated_at: DateTime.current,created_at: DateTime.current}diff --git a/spree/core/spec/models/spree/newsletter_subscriber_spec.rb b/spree/core/spec/models/spree/newsletter_subscriber_spec.rbindex 57cbde80a2..803dcfd033 100644--- a/spree/core/spec/models/spree/newsletter_subscriber_spec.rb+++ b/spree/core/spec/models/spree/newsletter_subscriber_spec.rb@@ -15,11 +15,37 @@ describe Spree::NewsletterSubscriber, type: :model, newsletter: true dodescribe 'validations' doit { is_expected.to validate_presence_of(:email) }- it { is_expected.to validate_uniqueness_of(:email).ignoring_case_sensitivity }+ it { is_expected.to validate_uniqueness_of(:email).scoped_to(:store_id).ignoring_case_sensitivity }it { is_expected.to allow_value('[email protected]').for(:email) }it { is_expected.not_to allow_value('test@').for(:email) }end+ describe 'associations' do+ it { is_expected.to belong_to(:user).optional }+ it { is_expected.to belong_to(:store).without_validating_presence }+ end++ describe 'callbacks' do+ describe 'set_store' do+ let(:current_store) { create(:store) }++ before { allow(Spree::Current).to receive(:store).and_return(current_store) }++ it 'sets store from Spree::Current.store when store is not set' do+ record = build(:newsletter_subscriber, store: nil)+ record.valid?+ expect(record.store).to eq(current_store)+ end++ it 'does not override store when already set' do+ existing_store = create(:store)+ record = build(:newsletter_subscriber, store: existing_store)+ record.valid?+ expect(record.store).to eq(existing_store)+ end+ end+ end+describe 'scopes' dolet!(:verified_subscriber) { create(:newsletter_subscriber, :verified) }let!(:unverified_subscriber) { create(:newsletter_subscriber, :unverified) }@@ -40,13 +66,14 @@ describe Spree::NewsletterSubscriber, type: :model, newsletter: true dodescribe 'subscribe' dolet(:subscribe_service) { double(Spree::Newsletter::Subscribe) }- context 'with user' do- subject { described_class.subscribe(email: email, user: user) }+ context 'with user and store' do+ subject { described_class.subscribe(email: email, user: user, store: store) }let(:user) { create(:user) }+ let(:store) { create(:store) }before do- allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, current_user: user).and_return(subscribe_service)+ allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, current_user: user, current_store: store).and_return(subscribe_service)endit 'calls subscribe service' do@@ -56,11 +83,14 @@ describe Spree::NewsletterSubscriber, type: :model, newsletter: true doendend- context 'without user' do+ context 'without user and store' dosubject { described_class.subscribe(email: email) }+ let(:current_store) { create(:store) }+before do- allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, current_user: nil).and_return(subscribe_service)+ allow(Spree::Current).to receive(:store).and_return(current_store)+ allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, current_user: nil, current_store: current_store).and_return(subscribe_service)endit 'calls subscribe service' dodiff --git a/spree/core/spec/models/spree/order/checkout_spec.rb b/spree/core/spec/models/spree/order/checkout_spec.rbindex 8f548b5cde..5c4a02adea 100644--- a/spree/core/spec/models/spree/order/checkout_spec.rb+++ b/spree/core/spec/models/spree/order/checkout_spec.rb@@ -498,7 +498,7 @@ describe Spree::Order, type: :model dolet(:accept_marketing) { true }it 'subscribes to newsletter' do- expect(Spree::NewsletterSubscriber).to receive(:subscribe).with(email: order.email, user: order.user)+ expect(Spree::NewsletterSubscriber).to receive(:subscribe).with(email: order.email, user: order.user, store: order.store)order.next!endenddiff --git a/spree/core/spec/services/spree/newsletter/subscribe_spec.rb b/spree/core/spec/services/spree/newsletter/subscribe_spec.rbindex 65703819a4..c1a12659ed 100644--- a/spree/core/spec/services/spree/newsletter/subscribe_spec.rb+++ b/spree/core/spec/services/spree/newsletter/subscribe_spec.rb@@ -7,12 +7,19 @@ module Spreelet(:params) do{email: email,- current_user: user+ current_user: user,+ current_store: store}endlet(:email) { '[email protected]' }let(:user) { nil }+ let(:store) { nil }+ let(:default_store) { @default_store || create(:store) }++ before do+ allow(Spree::Current).to receive(:store).and_return(default_store)+ endcontext 'with invalid params' dolet(:email) { 'hehe' }@@ -71,7 +78,7 @@ module Spreeendcontext 'when verified subscription already exists' do- let!(:subscriber) { create(:newsletter_subscriber, :verified, email: email) }+ let!(:subscriber) { create(:newsletter_subscriber, :verified, email: email, store: default_store) }it 'returns an instance of NewsletterSubscriber' doexpect(service).to be_a(NewsletterSubscriber)@@ -89,7 +96,7 @@ module Spreeendcontext 'when unverified subscription has been already created' do- let!(:subscriber) { create(:newsletter_subscriber, :unverified, email: email) }+ let!(:subscriber) { create(:newsletter_subscriber, :unverified, email: email, store: default_store) }it 'returns an instance of NewsletterSubscriber' doexpect(service).to be_a(NewsletterSubscriber)@@ -105,5 +112,19 @@ module Spreeserviceendend++ context 'when subscription does not exist for given store' do+ it 'creates a new subscriber for the given store' do+ expect { service }.to change(Spree::NewsletterSubscriber, :count).by(1)+ end+ end++ context 'when subscription exists but for a different store' do+ let!(:subscriber) { create(:newsletter_subscriber, :verified, email: email, store: create(:store)) }++ it 'creates a new subscriber for the given store' do+ expect { service }.to change(Spree::NewsletterSubscriber, :count).by(1)+ end+ endendenddiff --git a/spree/emails/app/mailers/spree/newsletter_mailer.rb b/spree/emails/app/mailers/spree/newsletter_mailer.rbindex d442dd84e8..a1add9156b 100644--- a/spree/emails/app/mailers/spree/newsletter_mailer.rb+++ b/spree/emails/app/mailers/spree/newsletter_mailer.rb@@ -2,7 +2,8 @@ module Spreeclass NewsletterMailer < BaseMailerdef email_confirmation(subscriber)@subscriber = subscriber- @confirm_email_url = spree.verify_newsletter_subscribers_url(token: @subscriber.verification_token, host: Spree::Current.store.storefront_url)+ store = subscriber.store || Spree::Current.store || Spree::Store.default+ @confirm_email_url = spree.verify_newsletter_subscribers_url(token: @subscriber.verification_token, host: store.storefront_url)mail(to: @subscriber.email, from: from_address, subject: Spree.t('newsletter_mailer.email_confirmation.subject'))endenddiff --git a/spree/emails/app/subscribers/spree/newsletter_subscriber_email_subscriber.rb b/spree/emails/app/subscribers/spree/newsletter_subscriber_email_subscriber.rbindex c9b20d1614..efee60c26b 100644--- a/spree/emails/app/subscribers/spree/newsletter_subscriber_email_subscriber.rb+++ b/spree/emails/app/subscribers/spree/newsletter_subscriber_email_subscriber.rb@@ -9,7 +9,7 @@ module Spreereturn unless subscriberreturn if subscriber.verified?- store = Spree::Current.store || Spree::Store.default+ store = subscriber.store || Spree::Current.store || Spree::Store.defaultreturn unless store.prefers_send_consumer_transactional_emails?NewsletterMailer.email_confirmation(subscriber).deliver_laterdiff --git a/spree/emails/spec/subscribers/spree/newsletter_subscriber_email_subscriber_spec.rb b/spree/emails/spec/subscribers/spree/newsletter_subscriber_email_subscriber_spec.rbindex a695235c71..a82273ef76 100644--- a/spree/emails/spec/subscribers/spree/newsletter_subscriber_email_subscriber_spec.rb+++ b/spree/emails/spec/subscribers/spree/newsletter_subscriber_email_subscriber_spec.rb@@ -4,7 +4,7 @@ require 'spec_helper'RSpec.describe Spree::NewsletterSubscriberEmailSubscriber dolet(:store) { create(:store) }- let(:newsletter_subscriber) { create(:newsletter_subscriber) }+ let(:newsletter_subscriber) { create(:newsletter_subscriber, store: store) }let(:subscriber) { described_class.new }def mock_event(newsletter_subscriber)@@ -12,7 +12,6 @@ RSpec.describe Spree::NewsletterSubscriberEmailSubscriber doendbefore do- allow(Spree::Current).to receive(:store).and_return(store)store.update!(preferences: store.preferences.merge(send_consumer_transactional_emails: true))end