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
Associate `Spree::Event` with Store (#13407)
Damian Legawiec9f2dfdacc0fb
diff --git a/api/app/subscribers/spree/webhook_event_subscriber.rb b/api/app/subscribers/spree/webhook_event_subscriber.rbindex e429910bf5..321b8d6e97 100644--- a/api/app/subscribers/spree/webhook_event_subscriber.rb+++ b/api/app/subscribers/spree/webhook_event_subscriber.rb@@ -19,11 +19,10 @@ module Spreedef handle(event)return unless Spree::Api::Config.webhooks_enabled-- store = Spree::Current.store+ return if event.store_id.blank?# Find all active endpoints for this store subscribed to this event- endpoints = Spree::WebhookEndpoint.active.where(store: store).select { |endpoint| endpoint.subscribed_to?(event.name) }+ endpoints = Spree::WebhookEndpoint.active.where(store_id: event.store_id).select { |endpoint| endpoint.subscribed_to?(event.name) }return if endpoints.empty?diff --git a/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb b/api/spec/subscribers/spree/webhook_event_subscriber_spec.rbindex ef274efd2b..8e7e900009 100644--- a/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb+++ b/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb@@ -11,10 +11,9 @@ module Spreelet(:event_id) { SecureRandom.uuid }let(:event_created_at) { Time.current }let(:event_metadata) { {} }- let(:event) { double('Event', id: event_id, name: event_name, payload: event_payload, metadata: event_metadata, created_at: event_created_at) }+ let(:event) { double('Event', id: event_id, name: event_name, store_id: store.id, payload: event_payload, metadata: event_metadata, created_at: event_created_at) }before do- allow(Spree::Current).to receive(:store).and_return(store)allow(Spree::Api::Config).to receive(:webhooks_enabled).and_return(true)end@@ -110,7 +109,7 @@ module Spreelet!(:wildcard_endpoint) { create(:webhook_endpoint, :all_events, store: store) }it 'creates delivery for any event' do- random_event = double('Event', id: SecureRandom.uuid, name: 'random.event', payload: {}, metadata: event_metadata, created_at: event_created_at)+ random_event = double('Event', id: SecureRandom.uuid, name: 'random.event', store_id: store.id, payload: {}, metadata: {}, created_at: event_created_at)expect {described_class.new.handle(random_event)@@ -129,6 +128,45 @@ module Spreeendend+ context 'with store isolation' do+ let(:other_store) { create(:store) }+ let!(:other_store_endpoint) { create(:webhook_endpoint, store: other_store, subscriptions: ['order.created']) }++ it 'only creates deliveries for endpoints in the event store' do+ expect {+ described_class.new.handle(event)+ }.to change(webhook_endpoint.webhook_deliveries, :count).by(1)+ .and change(other_store_endpoint.webhook_deliveries, :count).by(0)+ end++ it 'does not create deliveries for other store endpoints' do+ described_class.new.handle(event)++ expect(other_store_endpoint.webhook_deliveries.count).to eq(0)+ end++ context 'when event has different store_id' do+ let(:event) { double('Event', id: event_id, name: event_name, store_id: other_store.id, payload: event_payload, metadata: event_metadata, created_at: event_created_at) }++ it 'creates deliveries for endpoints matching the event store_id' do+ expect {+ described_class.new.handle(event)+ }.to change(other_store_endpoint.webhook_deliveries, :count).by(1)+ .and change(webhook_endpoint.webhook_deliveries, :count).by(0)+ end+ end++ context 'when event has no store_id' do+ let(:event) { double('Event', id: event_id, name: event_name, store_id: nil, payload: event_payload, metadata: event_metadata, created_at: event_created_at) }++ it 'does not create any deliveries' do+ expect {+ described_class.new.handle(event)+ }.not_to change(Spree::WebhookDelivery, :count)+ end+ end+ end+context 'when an error occurs' dobefore doallow(Spree::WebhookEndpoint).to receive(:active).and_raise(StandardError, 'Database error')diff --git a/core/app/jobs/spree/events/subscriber_job.rb b/core/app/jobs/spree/events/subscriber_job.rbindex 415a1e58ef..4d9c032d28 100644--- a/core/app/jobs/spree/events/subscriber_job.rb+++ b/core/app/jobs/spree/events/subscriber_job.rb@@ -51,11 +51,7 @@ module Spreedef reconstruct_event(event_hash)event_hash = event_hash.deep_symbolize_keys- Spree::Event.new(- name: event_hash[:name],- payload: event_hash[:payload],- metadata: event_hash[:metadata]- )+ Spree::Event.new(**event_hash.slice(:id, :name, :store_id, :payload, :metadata, :created_at))endendenddiff --git a/core/app/models/spree/event.rb b/core/app/models/spree/event.rbindex fa8e3f83e6..d03eb08707 100644--- a/core/app/models/spree/event.rb+++ b/core/app/models/spree/event.rb@@ -7,8 +7,9 @@ module Spree# that happened in the system. They contain:# - An id (UUID)# - A name (e.g., 'order.complete', 'product.create')+ # - A store_id (the store where the event originated)# - A payload (serialized data about the event)- # - Metadata (contextual information like store_id, timestamps)+ # - Metadata (contextual information like spree_version)## @example Creating an event# event = Spree::Event.new(@@ -19,6 +20,7 @@ module Spree# @example Accessing event data# event.id # => "550e8400-e29b-41d4-a716-446655440000"# event.name # => 'order.complete'+ # event.store_id # => 1# event.payload # => { 'id' => 1, 'number' => 'R123456' }# event.created_at # => 2024-01-15 10:30:00 UTC#@@ -27,24 +29,35 @@ module Spreeinclude ActiveModel::Attributesinclude ActiveModel::Serializers::JSON- attribute :id, :string+ attribute :id, :string, default: -> { SecureRandom.uuid }attribute :name, :string- attribute :payload, default: -> { {} }- attribute :metadata, default: -> { {} }- attribute :created_at, :datetime+ attribute :store_id, :integer, default: -> { Spree::Current.store&.id }+ attribute :payload, default: -> { {}.freeze }+ attribute :metadata, default: -> { { 'spree_version' => Spree.version }.freeze }+ attribute :created_at, :datetime, default: -> { Time.current }- # @param id [String] Optional UUID (generated if not provided)- # @param name [String] The event name (e.g., 'order.complete')- # @param payload [Hash] The serialized event data- # @param metadata [Hash] Additional contextual information- # @param created_at [Time, String] Optional timestamp (generated if not provided)- def initialize(id: nil, name: nil, payload: {}, metadata: {}, created_at: nil)- super()- self.id = id || SecureRandom.uuid- self.created_at = created_at ? Time.zone.parse(created_at.to_s) : Time.current- self.name = name.to_s.freeze if name- self.payload = (payload || {}).deep_stringify_keys.freeze- self.metadata = build_metadata(metadata).freeze+ validates :name, presence: true+ validates :store_id, presence: true++ def name=(value)+ super(value.to_s.freeze) if value+ end++ def payload=(value)+ super((value || {}).deep_stringify_keys.freeze)+ end++ def metadata=(value)+ base = { 'spree_version' => Spree.version }+ super(base.merge((value || {}).deep_stringify_keys).freeze)+ end++ # Returns the store where the event originated+ # @return [Spree::Store, nil]+ def store+ return nil if store_id.blank?++ @store ||= Spree::Store.find_by(id: store_id)end# Returns the resource type from the event name@@ -82,33 +95,10 @@ module Spreeendend- def attributes- {- 'id' => id,- 'name' => name,- 'payload' => payload,- 'metadata' => metadata,- 'created_at' => created_at- }- end-- def to_h- attributes.symbolize_keys- end+ alias_method :to_h, :attributesdef inspect- "#<Spree::Event id=#{id.inspect} name=#{name.inspect} created_at=#{created_at&.iso8601}>"- end-- private-- def build_metadata(custom_metadata)- base_metadata = {- 'spree_version' => Spree.version,- 'store_id' => Spree::Store.current&.id- }-- base_metadata.merge((custom_metadata || {}).deep_stringify_keys)+ "#<Spree::Event id=#{id.inspect} name=#{name.inspect} store_id=#{store_id.inspect} created_at=#{created_at&.iso8601}>"endendenddiff --git a/core/lib/spree/testing_support/factories/stock_item_factory.rb b/core/lib/spree/testing_support/factories/stock_item_factory.rbindex 6a7b5f6c39..06111be818 100644--- a/core/lib/spree/testing_support/factories/stock_item_factory.rb+++ b/core/lib/spree/testing_support/factories/stock_item_factory.rb@@ -5,10 +5,12 @@ FactoryBot.define dovariantbefore(:create) do |stock_item|- Spree::StockItem.find_by(- variant: stock_item.variant,- stock_location: stock_item.stock_location- )&.destroy+ # Use really_destroy! (hard delete) to avoid unique index conflicts+ # with deleted_at timestamps in MySQL when tests run quickly+ Spree::StockItem.where(+ variant_id: stock_item.variant_id,+ stock_location_id: stock_item.stock_location_id+ ).delete_allendtransient dodiff --git a/core/spec/models/spree/event_spec.rb b/core/spec/models/spree/event_spec.rbindex ef65bf4a4a..7549eeb612 100644--- a/core/spec/models/spree/event_spec.rb+++ b/core/spec/models/spree/event_spec.rb@@ -3,6 +3,12 @@require 'spec_helper'RSpec.describe Spree::Event do+ let(:store) { create(:store) }++ before do+ allow(Spree::Current).to receive(:store).and_return(store)+ end+describe '#initialize' doit 'creates an event with name and payload' doevent = described_class.new(@@ -58,6 +64,65 @@ RSpec.describe Spree::Event doexpect(event.payload).to eq({ 'nested' => { 'deep_key' => 'value' } })end++ it 'sets store_id from Spree::Current.store' do+ event = described_class.new(name: 'test', payload: {})++ expect(event.store_id).to eq(store.id)+ end++ it 'accepts explicit store_id' do+ other_store = create(:store)+ event = described_class.new(name: 'test', store_id: other_store.id, payload: {})++ expect(event.store_id).to eq(other_store.id)+ end+ end++ describe 'validations' do+ it 'requires name' do+ event = described_class.new(store_id: store.id, payload: {})++ expect(event).not_to be_valid+ expect(event.errors[:name]).to include("can't be blank")+ end++ it 'requires store_id' do+ allow(Spree::Current).to receive(:store).and_return(nil)+ event = described_class.new(name: 'test', payload: {})++ expect(event).not_to be_valid+ expect(event.errors[:store_id]).to include("can't be blank")+ end++ it 'is valid with name and store_id' do+ event = described_class.new(name: 'test', store_id: store.id, payload: {})++ expect(event).to be_valid+ end+ end++ describe '#store' do+ it 'returns the store for the store_id' do+ event = described_class.new(name: 'order.complete', store_id: store.id)++ expect(event.store).to eq(store)+ end++ it 'returns nil when store_id is blank' do+ allow(Spree::Current).to receive(:store).and_return(nil)+ event = described_class.new(name: 'order.complete', store_id: nil)++ expect(event.store).to be_nil+ end++ it 'memoizes the store lookup' do+ event = described_class.new(name: 'order.complete', store_id: store.id)++ expect(Spree::Store).to receive(:find_by).once.and_return(store)++ 2.times { event.store }+ endenddescribe '#resource_type' do@@ -136,6 +201,7 @@ RSpec.describe Spree::Event dohash = event.attributesexpect(hash['name']).to eq('order.complete')+ expect(hash['store_id']).to eq(store.id)expect(hash['payload']).to eq({ 'id' => 1 })expect(hash['metadata']['user_id']).to eq(5)expect(hash['created_at']).to eq(event.created_at)@@ -145,7 +211,7 @@ RSpec.describe Spree::Event dodescribe '#inspect' doit 'returns a readable string representation' doevent = described_class.new(name: 'order.complete', payload: {})- expect(event.inspect).to match(/Spree::Event id="[0-9a-f-]{36}" name="order.complete" created_at=/)+ expect(event.inspect).to match(/Spree::Event id="[0-9a-f-]{36}" name="order.complete" store_id=#{store.id} created_at=/)endendend