Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Rename order.completed to order.placed

Damian Legawiec7ec392b05d3f
diff --git a/docs/plans/6.0-cart-order-split.md b/docs/plans/6.0-cart-order-split.md
index 74298339e2..782330aaa3 100644
--- a/docs/plans/6.0-cart-order-split.md
+++ b/docs/plans/6.0-cart-order-split.md
@@ -67,7 +67,7 @@ Every competitor treats this as load-bearing. `Spree::Carts::Complete`:
- Cancel/resume/approve remain services (`Orders::Cancel`/`Resume`/`Approve` — approve is already machine-free) flipping `status` and running today's side effects (restock/void/refund branches preserved verbatim). `awaiting_return`/`returned` states are **not** carried over — that lifecycle belongs to `6.0-returns-exchanges-claims.md`'s first-class Return models.
- The `confirmation_required?` self-reference (the `|| confirm?` hack from #4117) dies with the machine: whether the confirm/review step exists is computed **from data only** (`Spree::Config[:always_include_confirm_step]` or any selected payment method requiring confirmation). A confirm-stage failure no longer "falls back" to an earlier state — there are no states; the client stays on review with the failure in `requirements`/errors.
- Order `state_changes` audit rows are dropped in favor of lifecycle events (`order.placed`, `order.canceled`, `order.resumed`, `order.approved` — already published today). Payment/fulfillment machines keep their own `StateChange` rows.
-- **Event naming after the split (settled 2026-07-29):** carts publish their own `cart.created` / `cart.updated` / `cart.deleted` lifecycle events (restoring the 5.x abandonment signal that incomplete orders' `order.*` events used to provide; Shopify `carts/*` parity). `order.completed` stays the placement event — `order.created` cannot take that role because it fires for every order row, including admin drafts and the pre-payment draft copy inside `Carts::Complete` (a failed payment then emits `order.deleted` for it). Renaming would also break every 5.x webhook consumer and the emails/metrics subscribers for no semantic gain.
+- **Event naming after the split (settled 2026-07-29, revised same day):** carts publish their own `cart.created` / `cart.updated` / `cart.deleted` lifecycle events (restoring the 5.x abandonment signal that incomplete orders' `order.*` events used to provide; Shopify `carts/*` parity). The placement event is **`order.placed`** — renamed from the historical `order.completed` (Medusa's exact term; avoids Medusa's `order.completed` = "fulfillment finished" collision and reads right to newcomers, the primary audience — accepted as a 6.0 breaking change for existing webhook consumers). `order.created` cannot take that role because it fires for every order row, including admin drafts and the pre-payment draft copy inside `Carts::Complete` (a failed payment then emits `order.deleted` for it). Admin confirmation resends publish the targeted `order.resend_confirmation_email`, no longer re-blasting the placement event to all consumers. The order event payload carries `cart_id` so abandonment tooling can cancel flows on conversion (BigCommerce `store/cart/converted` parity).
- **Price-freeze guarantee** (what OSS platform C's `ArrangingPayment` lock provided): `completing_at` rejects cart mutations while payment is in flight, and the completed Order is immutable per split-adjustments' order-level freeze. Auditable price-at-completion also serves EU Omnibus.
### 7. Cart hygiene — new, and newly necessary
diff --git a/docs/plans/decisions.md b/docs/plans/decisions.md
index eadc75c4f7..b4b732789e 100644
--- a/docs/plans/decisions.md
+++ b/docs/plans/decisions.md
@@ -591,3 +591,30 @@ promotion picker is sugar over the code path — picking a coupon promotion
fills in its code; it is not a separate application mechanism. The coupon
handler now always reports ineligibility with the retryable status code so
endpoints can tell a not-yet-qualifying code from an invalid one.
+
+
+## 2026-07-29 — `order.placed` replaces `order.completed`; carts get their own events
+
+Competitor survey (Shopify, BigCommerce, Medusa v2, Saleor, Vendure): every
+platform with a separate cart entity namespaces its events (`carts/*`,
+`cart.*`, `CHECKOUT_*`), and "order created" then means *placed* only where
+drafts live in their own namespace (`draft_orders/*`, `DRAFT_ORDER_*`).
+Medusa — the same single-Order-model shape as ours — uses an explicit
+`order.placed`, and reserves `order.completed` for "fulfillment finished",
+a direct collision with our historical name.
+
+**Decisions:** carts publish `cart.created/updated/deleted` (5.x
+abandonment-signal parity). The placement event is renamed
+`order.completed` → **`order.placed`** — a deliberate 6.0 breaking change:
+newcomers are the primary audience and the old name misleads anyone
+arriving from Medusa; existing webhook consumers adjust one subscription
+on upgrade. `order.created` keeps meaning "order row exists" (admin drafts
+included). Admin confirmation resends publish the targeted
+`order.resend_confirmation_email` instead of re-blasting the placement
+event. Order payloads carry `cart_id` (BigCommerce `store/cart/converted`
+parity) so abandonment flows can cancel on conversion. Server-side
+abandonment detection (BigCommerce `store/cart/abandoned`) explicitly
+skipped. No separate draft-order entity and no `is_draft` boolean —
+`status = 'draft'` already encodes it (`cart_id` does NOT: the completion
+pipeline's draft copy has a cart_id while briefly draft; admin drafts
+have none).
diff --git a/packages/dashboard/src/schemas/webhook-endpoint.ts b/packages/dashboard/src/schemas/webhook-endpoint.ts
index b0b7d74486..fcb639cbdb 100644
--- a/packages/dashboard/src/schemas/webhook-endpoint.ts
+++ b/packages/dashboard/src/schemas/webhook-endpoint.ts
@@ -116,10 +116,10 @@ export const WEBHOOK_EVENT_GROUPS: readonly WebhookEventGroup[] = [
events: [
'order.approved',
'order.canceled',
- 'order.completed',
'order.created',
'order.deleted',
'order.paid',
+ 'order.placed',
'order.resumed',
'order.shipped',
'order.updated',
diff --git a/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb
index 21e7278441..32bc02b06a 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/orders_controller.rb
@@ -87,7 +87,7 @@ module Spree
# POST /api/v3/admin/orders/:id/resend_confirmation
def resend_confirmation
- @resource.publish_event('order.completed')
+ @resource.publish_event('order.resend_confirmation_email')
render json: serialize_resource(@resource)
end
diff --git a/spree/api/app/subscribers/spree/webhook_event_subscriber.rb b/spree/api/app/subscribers/spree/webhook_event_subscriber.rb
index 7d4a080ca6..a004ac069a 100644
--- a/spree/api/app/subscribers/spree/webhook_event_subscriber.rb
+++ b/spree/api/app/subscribers/spree/webhook_event_subscriber.rb
@@ -12,7 +12,7 @@ module Spree
#
# @example
# # Webhooks are automatically delivered when events are published
- # Spree::Events.publish('order.completed', order: order)
+ # Spree::Events.publish('order.placed', order: order)
#
class WebhookEventSubscriber < Spree::Subscriber
subscribes_to '*'
diff --git a/spree/core/README.md b/spree/core/README.md
index e5f31baa96..659a1854c5 100644
--- a/spree/core/README.md
+++ b/spree/core/README.md
@@ -53,7 +53,7 @@ Spree uses an event-driven architecture for decoupling components:
```ruby
# Publishing events
-order.publish_event('order.completed')
+order.publish_event('order.placed')
# Subscribing to events
module Spree
diff --git a/spree/core/app/jobs/spree/events/subscriber_job.rb b/spree/core/app/jobs/spree/events/subscriber_job.rb
index d4ae9d7617..c741674711 100644
--- a/spree/core/app/jobs/spree/events/subscriber_job.rb
+++ b/spree/core/app/jobs/spree/events/subscriber_job.rb
@@ -10,7 +10,7 @@ module Spree
# @example Direct usage (typically called by the adapter)
# Spree::Events::SubscriberJob.perform_later(
# 'MySubscriber',
- # { name: 'order.completed', payload: {...}, ... }
+ # { name: 'order.placed', payload: {...}, ... }
# )
#
class SubscriberJob < Spree::BaseJob
diff --git a/spree/core/app/models/concerns/spree/publishable.rb b/spree/core/app/models/concerns/spree/publishable.rb
index 0b67301f76..bc87a56f35 100644
--- a/spree/core/app/models/concerns/spree/publishable.rb
+++ b/spree/core/app/models/concerns/spree/publishable.rb
@@ -22,7 +22,7 @@ module Spree
# class Spree::Order < Spree.base_class
# def complete!
# # ... completion logic ...
- # publish_event('order.completed')
+ # publish_event('order.placed')
# end
# end
#
@@ -134,15 +134,15 @@ module Spree
# Publish an event with this model's data
#
- # @param event_name [String] The event name (e.g., 'order.completed')
+ # @param event_name [String] The event name (e.g., 'order.placed')
# @param payload [Hash, nil] Custom payload (defaults to event_payload)
# @param metadata [Hash] Additional metadata
# @return [Spree::Event] The published event
#
# @example
- # order.publish_event('order.completed')
- # order.publish_event('order.completed', { custom: 'data' })
- # order.publish_event('order.completed', metadata: { user_id: 1 })
+ # order.publish_event('order.placed')
+ # order.publish_event('order.placed', { custom: 'data' })
+ # order.publish_event('order.placed', metadata: { user_id: 1 })
#
def publish_event(event_name, payload = nil, metadata = {})
return unless Spree::Events.enabled?
diff --git a/spree/core/app/models/spree/event.rb b/spree/core/app/models/spree/event.rb
index 4a7e257884..7c787b873d 100644
--- a/spree/core/app/models/spree/event.rb
+++ b/spree/core/app/models/spree/event.rb
@@ -6,20 +6,20 @@ module Spree
# Events are immutable objects that carry information about something
# that happened in the system. They contain:
# - An id (UUID)
- # - A name (e.g., 'order.completed', 'product.created')
+ # - A name (e.g., 'order.placed', 'product.created')
# - A store_id (the store where the event originated)
# - A payload (serialized data about the event)
# - Metadata (contextual information like spree_version)
#
# @example Creating an event
# event = Spree::Event.new(
- # name: 'order.completed',
+ # name: 'order.placed',
# payload: order.serializable_hash
# )
#
# @example Accessing event data
# event.id # => "550e8400-e29b-41d4-a716-446655440000"
- # event.name # => 'order.completed'
+ # event.name # => 'order.placed'
# event.store_id # => 1
# event.payload # => { 'id' => 1, 'number' => 'R123456' }
# event.created_at # => 2024-01-15 10:30:00 UTC
@@ -61,19 +61,19 @@ module Spree
end
# Returns the resource type from the event name
- # @return [String] The resource type (e.g., 'order' from 'order.completed')
+ # @return [String] The resource type (e.g., 'order' from 'order.placed')
def resource_type
@resource_type ||= name.to_s.split('.').first
end
# Returns the action from the event name
- # @return [String] The action (e.g., 'completed' from 'order.completed')
+ # @return [String] The action (e.g., 'placed' from 'order.placed')
def action
@action ||= name.to_s.split('.').drop(1).join('.')
end
# Checks if the event matches a pattern
- # Supports wildcards: 'order.*' matches 'order.completed', 'order.canceled'
+ # Supports wildcards: 'order.*' matches 'order.placed', 'order.canceled'
# @param pattern [String] The pattern to match against
# @return [Boolean]
def matches?(pattern)
diff --git a/spree/core/app/models/spree/order.rb b/spree/core/app/models/spree/order.rb
index f3f4acbfab..e1ad776a89 100644
--- a/spree/core/app/models/spree/order.rb
+++ b/spree/core/app/models/spree/order.rb
@@ -731,7 +731,7 @@ module Spree
consider_risk
- publish_order_completed_event
+ publish_order_placed_event
end
def fulfill!
@@ -1276,8 +1276,8 @@ module Spree
end
end
- def publish_order_completed_event
- publish_event('order.completed', event_payload.merge(notify_customer: notify_customer))
+ def publish_order_placed_event
+ publish_event('order.placed', event_payload.merge(notify_customer: notify_customer))
end
def publish_order_resumed_event
diff --git a/spree/core/app/models/spree/subscriber.rb b/spree/core/app/models/spree/subscriber.rb
index 43b08636b7..d3eb3bbe23 100644
--- a/spree/core/app/models/spree/subscriber.rb
+++ b/spree/core/app/models/spree/subscriber.rb
@@ -9,7 +9,7 @@ module Spree
#
# @example Basic subscriber
# class OrderCompletedNotifier < Spree::Subscriber
- # subscribes_to 'order.completed'
+ # subscribes_to 'order.placed'
#
# def call(event)
# order_id = event.payload['id']
@@ -19,7 +19,7 @@ module Spree
#
# @example Multi-event subscriber
# class OrderAuditLogger < Spree::Subscriber
- # subscribes_to 'order.completed', 'order.canceled', 'order.resumed'
+ # subscribes_to 'order.placed', 'order.canceled', 'order.resumed'
#
# def call(event)
# AuditLog.create!(
@@ -64,7 +64,7 @@ module Spree
#
# @example Synchronous subscriber (runs immediately, not via ActiveJob)
# class CriticalOrderHandler < Spree::Subscriber
- # subscribes_to 'order.completed', async: false
+ # subscribes_to 'order.placed', async: false
#
# def call(event)
# # This runs synchronously
@@ -81,10 +81,10 @@ module Spree
# @return [void]
#
# @example
- # subscribes_to 'order.completed'
- # subscribes_to 'order.completed', 'order.canceled'
+ # subscribes_to 'order.placed'
+ # subscribes_to 'order.placed', 'order.canceled'
# subscribes_to 'order.*'
- # subscribes_to 'order.completed', async: false
+ # subscribes_to 'order.placed', async: false
#
def subscribes_to(*patterns, **options)
@subscription_patterns ||= []
diff --git a/spree/core/app/subscribers/spree/event_log_subscriber.rb b/spree/core/app/subscribers/spree/event_log_subscriber.rb
index b0ca6d1d64..33452db4fa 100644
--- a/spree/core/app/subscribers/spree/event_log_subscriber.rb
+++ b/spree/core/app/subscribers/spree/event_log_subscriber.rb
@@ -9,7 +9,7 @@ module Spree
# Rails.application.config.filter_parameters.
#
# @example Output
- # [Spree Event] order.completed | payload: {"id"=>1} | 0.5ms
+ # [Spree Event] order.placed | payload: {"id"=>1} | 0.5ms
#
class EventLogSubscriber
NAMESPACE = 'spree'
diff --git a/spree/core/app/subscribers/spree/product_metrics_subscriber.rb b/spree/core/app/subscribers/spree/product_metrics_subscriber.rb
index e1066a2957..3e2d1d5db7 100644
--- a/spree/core/app/subscribers/spree/product_metrics_subscriber.rb
+++ b/spree/core/app/subscribers/spree/product_metrics_subscriber.rb
@@ -4,9 +4,9 @@ module Spree
# Handles order completion events to update product metrics
# (+units_sold_count+, +revenue+).
class ProductMetricsSubscriber < Spree::Subscriber
- subscribes_to 'order.completed'
+ subscribes_to 'order.placed'
- on 'order.completed', :refresh_product_metrics
+ on 'order.placed', :refresh_product_metrics
def refresh_product_metrics(event)
order_id = event.payload['id']
diff --git a/spree/core/spec/lib/spree/events_spec.rb b/spree/core/spec/lib/spree/events_spec.rb
index fc4fa5b634..cee41eabc7 100644
--- a/spree/core/spec/lib/spree/events_spec.rb
+++ b/spree/core/spec/lib/spree/events_spec.rb
@@ -13,22 +13,22 @@ RSpec.describe Spree::Events, events: true do
describe '.publish' do
it 'publishes an event' do
- event = described_class.publish('order.completed', { id: 1 })
+ event = described_class.publish('order.placed', { id: 1 })
expect(event).to be_a(Spree::Event)
- expect(event.name).to eq('order.completed')
+ expect(event.name).to eq('order.placed')
expect(event.payload).to eq({ 'id' => 1 })
end
it 'notifies subscribers synchronously when async: false' do
received_events = []
- described_class.subscribe('order.completed', async: false) do |event|
+ described_class.subscribe('order.placed', async: false) do |event|
received_events << event
end
described_class.activate!
- described_class.publish('order.completed', { id: 1 })
+ described_class.publish('order.placed', { id: 1 })
expect(received_events.size).to eq(1)
end
@@ -38,12 +38,12 @@ RSpec.describe Spree::Events, events: true do
it 'subscribes with a block' do
called = false
- described_class.subscribe('order.completed', async: false) do |_event|
+ described_class.subscribe('order.placed', async: false) do |_event|
called = true
end
described_class.activate!
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
expect(called).to be true
end
@@ -56,9 +56,9 @@ RSpec.describe Spree::Events, events: true do
end
end
- described_class.subscribe('order.completed', handler_class, async: false)
+ described_class.subscribe('order.placed', handler_class, async: false)
described_class.activate!
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
expect(received.size).to eq(1)
end
@@ -71,12 +71,12 @@ RSpec.describe Spree::Events, events: true do
end
described_class.activate!
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
described_class.publish('order.canceled', {})
described_class.publish('product.created', {})
expect(received_events.size).to eq(2)
- expect(received_events.map(&:name)).to contain_exactly('order.completed', 'order.canceled')
+ expect(received_events.map(&:name)).to contain_exactly('order.placed', 'order.canceled')
end
it 'supports global wildcard' do
@@ -87,14 +87,14 @@ RSpec.describe Spree::Events, events: true do
end
described_class.activate!
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
described_class.publish('product.created', {})
expect(received_events.size).to eq(2)
end
it 'raises error when no subscriber provided' do
- expect { described_class.subscribe('order.completed') }.to raise_error(ArgumentError)
+ expect { described_class.subscribe('order.placed') }.to raise_error(ArgumentError)
end
end
@@ -103,10 +103,10 @@ RSpec.describe Spree::Events, events: true do
received_events = []
handler = ->(event) { received_events << event }
- described_class.subscribe('order.completed', handler, async: false)
- described_class.unsubscribe('order.completed', handler)
+ described_class.subscribe('order.placed', handler, async: false)
+ described_class.unsubscribe('order.placed', handler)
described_class.activate!
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
expect(received_events).to be_empty
end
@@ -114,16 +114,16 @@ RSpec.describe Spree::Events, events: true do
describe '.patterns' do
it 'returns all registered patterns' do
- described_class.subscribe('order.completed', async: false) { }
+ described_class.subscribe('order.placed', async: false) { }
described_class.subscribe('order.*', async: false) { }
- expect(described_class.patterns).to contain_exactly('order.completed', 'order.*')
+ expect(described_class.patterns).to contain_exactly('order.placed', 'order.*')
end
end
describe '.subscriptions' do
it 'returns all subscriptions' do
- described_class.subscribe('order.completed', async: false) { }
+ described_class.subscribe('order.placed', async: false) { }
described_class.subscribe('order.canceled', async: false) { }
expect(described_class.subscriptions.size).to eq(2)
@@ -134,14 +134,14 @@ RSpec.describe Spree::Events, events: true do
it 'disables events within the block' do
received = false
- described_class.subscribe('order.completed', async: false) do
+ described_class.subscribe('order.placed', async: false) do
received = true
end
described_class.activate!
described_class.disable do
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
end
expect(received).to be false
@@ -181,7 +181,7 @@ RSpec.describe Spree::Events, events: true do
describe '.reset!' do
it 'clears all subscriptions' do
- described_class.subscribe('order.completed', async: false) { }
+ described_class.subscribe('order.placed', async: false) { }
described_class.reset!
@@ -194,11 +194,11 @@ RSpec.describe Spree::Events, events: true do
received1 = []
received2 = []
- described_class.subscribe('order.completed', async: false) { |e| received1 << e }
- described_class.subscribe('order.completed', async: false) { |e| received2 << e }
+ described_class.subscribe('order.placed', async: false) { |e| received1 << e }
+ described_class.subscribe('order.placed', async: false) { |e| received2 << e }
described_class.activate!
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
expect(received1.size).to eq(1)
expect(received2.size).to eq(1)
@@ -208,11 +208,11 @@ RSpec.describe Spree::Events, events: true do
exact_received = []
pattern_received = []
- described_class.subscribe('order.completed', async: false) { |e| exact_received << e }
+ described_class.subscribe('order.placed', async: false) { |e| exact_received << e }
described_class.subscribe('order.*', async: false) { |e| pattern_received << e }
described_class.activate!
- described_class.publish('order.completed', {})
+ described_class.publish('order.placed', {})
described_class.publish('order.canceled', {})
expect(exact_received.size).to eq(1)
diff --git a/spree/core/spec/models/spree/event_spec.rb b/spree/core/spec/models/spree/event_spec.rb
index 204f746bef..1d4d55eb8b 100644
--- a/spree/core/spec/models/spree/event_spec.rb
+++ b/spree/core/spec/models/spree/event_spec.rb
@@ -12,17 +12,17 @@ RSpec.describe Spree::Event do
describe '#initialize' do
it 'creates an event with name and payload' do
event = described_class.new(
- name: 'order.completed',
+ name: 'order.placed',
payload: { id: 1, number: 'R123' }
)
- expect(event.name).to eq('order.completed')
+ expect(event.name).to eq('order.placed')
expect(event.payload).to eq({ 'id' => 1, 'number' => 'R123' })
end
it 'freezes the payload and metadata' do
event = described_class.new(
- name: 'order.completed',
+ name: 'order.placed',
payload: { id: 1 }
)
@@ -104,20 +104,20 @@ RSpec.describe Spree::Event do
describe '#store' do
it 'returns the store for the store_id' do
- event = described_class.new(name: 'order.completed', store_id: store.id)
+ event = described_class.new(name: 'order.placed', 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.completed', store_id: nil)
+ event = described_class.new(name: 'order.placed', store_id: nil)
expect(event.store).to be_nil
end
it 'memoizes the store lookup' do
- event = described_class.new(name: 'order.completed', store_id: store.id)
+ event = described_class.new(name: 'order.placed', store_id: store.id)
expect(Spree::Store).to receive(:find_by).once.and_return(store)
@@ -127,7 +127,7 @@ RSpec.describe Spree::Event do
describe '#resource_type' do
it 'extracts the resource type from the event name' do
- event = described_class.new(name: 'order.completed', payload: {})
+ event = described_class.new(name: 'order.placed', payload: {})
expect(event.resource_type).to eq('order')
end
@@ -139,8 +139,8 @@ RSpec.describe Spree::Event do
describe '#action' do
it 'extracts the action from the event name' do
- event = described_class.new(name: 'order.completed', payload: {})
- expect(event.action).to eq('completed')
+ event = described_class.new(name: 'order.placed', payload: {})
+ expect(event.action).to eq('placed')
end
it 'handles multi-part actions' do
@@ -150,10 +150,10 @@ RSpec.describe Spree::Event do
end
describe '#matches?' do
- let(:event) { described_class.new(name: 'order.completed', payload: {}) }
+ let(:event) { described_class.new(name: 'order.placed', payload: {}) }
it 'matches exact event names' do
- expect(event.matches?('order.completed')).to be true
+ expect(event.matches?('order.placed')).to be true
expect(event.matches?('order.canceled')).to be false
end
@@ -169,18 +169,18 @@ RSpec.describe Spree::Event do
describe '.matches?' do
it 'matches exact names' do
- expect(described_class.matches?('order.completed', 'order.completed')).to be true
- expect(described_class.matches?('order.completed', 'order.canceled')).to be false
+ expect(described_class.matches?('order.placed', 'order.placed')).to be true
+ expect(described_class.matches?('order.placed', 'order.canceled')).to be false
end
it 'matches wildcard patterns' do
- expect(described_class.matches?('order.completed', 'order.*')).to be true
+ expect(described_class.matches?('order.placed', 'order.*')).to be true
expect(described_class.matches?('order.canceled', 'order.*')).to be true
expect(described_class.matches?('product.create', 'order.*')).to be false
end
it 'matches global wildcard' do
- expect(described_class.matches?('order.completed', '*')).to be true
+ expect(described_class.matches?('order.placed', '*')).to be true
expect(described_class.matches?('anything.here', '*')).to be true
end
@@ -193,14 +193,14 @@ RSpec.describe Spree::Event do
describe '#attributes' do
it 'returns a hash representation with string keys' do
event = described_class.new(
- name: 'order.completed',
+ name: 'order.placed',
payload: { id: 1 },
metadata: { user_id: 5 }
)
hash = event.attributes
- expect(hash['name']).to eq('order.completed')
+ expect(hash['name']).to eq('order.placed')
expect(hash['store_id']).to eq(store.id)
expect(hash['payload']).to eq({ 'id' => 1 })
expect(hash['metadata']['user_id']).to eq(5)
@@ -210,8 +210,8 @@ RSpec.describe Spree::Event do
describe '#inspect' do
it 'returns a readable string representation' do
- event = described_class.new(name: 'order.completed', payload: {})
- expect(event.inspect).to match(/Spree::Event id="[0-9a-f-]{36}" name="order.completed" store_id=#{store.id} created_at=/)
+ event = described_class.new(name: 'order.placed', payload: {})
+ expect(event.inspect).to match(/Spree::Event id="[0-9a-f-]{36}" name="order.placed" store_id=#{store.id} created_at=/)
end
end
end
diff --git a/spree/core/spec/models/spree/order_spec.rb b/spree/core/spec/models/spree/order_spec.rb
index ded27d1918..d99595f22a 100644
--- a/spree/core/spec/models/spree/order_spec.rb
+++ b/spree/core/spec/models/spree/order_spec.rb
@@ -472,7 +472,7 @@ describe Spree::Order, type: :model do
before { order.update_columns(completed_at: Time.current, status: 'placed') }
it 'publishes order.completed event' do
- expect(order).to receive(:publish_event).with('order.completed', hash_including(:notify_customer)).at_least(:once)
+ expect(order).to receive(:publish_event).with('order.placed', hash_including(:notify_customer)).at_least(:once)
allow(order).to receive(:publish_event).with(anything)
allow(order).to receive(:publish_event).with(anything, anything)
order.finalize!
diff --git a/spree/core/spec/models/spree/subscriber_spec.rb b/spree/core/spec/models/spree/subscriber_spec.rb
index ccebdf76bb..5207c14756 100644
--- a/spree/core/spec/models/spree/subscriber_spec.rb
+++ b/spree/core/spec/models/spree/subscriber_spec.rb
@@ -14,23 +14,23 @@ RSpec.describe Spree::Subscriber, events: true do
describe '.subscribes_to' do
it 'registers subscription patterns' do
subscriber_class = Class.new(described_class) do
- subscribes_to 'order.completed'
+ subscribes_to 'order.placed'
end
- expect(subscriber_class.subscription_patterns).to eq(['order.completed'])
+ expect(subscriber_class.subscription_patterns).to eq(['order.placed'])
end
it 'accepts multiple patterns' do
subscriber_class = Class.new(described_class) do
- subscribes_to 'order.completed', 'order.canceled'
+ subscribes_to 'order.placed', 'order.canceled'
end
- expect(subscriber_class.subscription_patterns).to contain_exactly('order.completed', 'order.canceled')
+ expect(subscriber_class.subscription_patterns).to contain_exactly('order.placed', 'order.canceled')
end
it 'stores subscription options' do
subscriber_class = Class.new(described_class) do
- subscribes_to 'order.completed', async: false
+ subscribes_to 'order.placed', async: false
end
expect(subscriber_class.subscription_options).to eq({ async: false })
@@ -38,11 +38,11 @@ RSpec.describe Spree::Subscriber, events: true do
it 'accumulates patterns from multiple calls' do
subscriber_class = Class.new(described_class) do
- subscribes_to 'order.completed'
+ subscribes_to 'order.placed'
subscribes_to 'order.canceled'
end
- expect(subscriber_class.subscription_patterns).to contain_exactly('order.completed', 'order.canceled')
+ expect(subscriber_class.subscription_patterns).to contain_exactly('order.placed', 'order.canceled')
end
end
@@ -72,7 +72,7 @@ RSpec.describe Spree::Subscriber, events: true do
end
end
- event = Spree::Event.new(name: 'order.completed', payload: {})
+ event = Spree::Event.new(name: 'order.placed', payload: {})
subscriber_class.new.call(event)
expect(handled_events).to eq([event])
diff --git a/spree/core/spec/models/spree/webhook_delivery_spec.rb b/spree/core/spec/models/spree/webhook_delivery_spec.rb
index 35c9c7d3c1..1bb34c2435 100644
--- a/spree/core/spec/models/spree/webhook_delivery_spec.rb
+++ b/spree/core/spec/models/spree/webhook_delivery_spec.rb
@@ -209,7 +209,7 @@ describe Spree::WebhookDelivery, type: :model do
end
describe '#redeliver!' do
- let(:delivery) { create(:webhook_delivery, :failed, webhook_endpoint: webhook_endpoint, event_name: 'order.completed', payload: { id: 'test', name: 'order.completed' }) }
+ let(:delivery) { create(:webhook_delivery, :failed, webhook_endpoint: webhook_endpoint, event_name: 'order.placed', payload: { id: 'test', name: 'order.placed' }) }
before do
allow_any_instance_of(Spree::WebhookDelivery).to receive(:queue_for_delivery!)
diff --git a/spree/core/spec/models/spree/webhook_endpoint_spec.rb b/spree/core/spec/models/spree/webhook_endpoint_spec.rb
index 6872ea21ee..b0a17b4c05 100644
--- a/spree/core/spec/models/spree/webhook_endpoint_spec.rb
+++ b/spree/core/spec/models/spree/webhook_endpoint_spec.rb
@@ -121,11 +121,11 @@ describe Spree::WebhookEndpoint, type: :model do
end
context 'with specific subscriptions' do
- let(:endpoint) { build(:webhook_endpoint, subscriptions: %w[order.created order.completed]) }
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: %w[order.created order.placed]) }
it 'returns true for subscribed events' do
expect(endpoint.subscribed_to?('order.created')).to be true
- expect(endpoint.subscribed_to?('order.completed')).to be true
+ expect(endpoint.subscribed_to?('order.placed')).to be true
end
it 'returns false for non-subscribed events' do
@@ -139,7 +139,7 @@ describe Spree::WebhookEndpoint, type: :model do
it 'matches events that fit the pattern' do
expect(endpoint.subscribed_to?('order.created')).to be true
- expect(endpoint.subscribed_to?('order.completed')).to be true
+ expect(endpoint.subscribed_to?('order.placed')).to be true
expect(endpoint.subscribed_to?('order.updated')).to be true
end
@@ -154,7 +154,7 @@ describe Spree::WebhookEndpoint, type: :model do
it 'matches pattern events' do
expect(endpoint.subscribed_to?('order.created')).to be true
- expect(endpoint.subscribed_to?('order.completed')).to be true
+ expect(endpoint.subscribed_to?('order.placed')).to be true
end
it 'matches exact events' do
@@ -177,10 +177,10 @@ describe Spree::WebhookEndpoint, type: :model do
end
context 'with specific subscriptions' do
- let(:endpoint) { build(:webhook_endpoint, subscriptions: %w[order.created order.completed]) }
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: %w[order.created order.placed]) }
it 'returns the subscriptions' do
- expect(endpoint.subscribed_events).to eq(%w[order.created order.completed])
+ expect(endpoint.subscribed_events).to eq(%w[order.created order.placed])
end
end
end
diff --git a/spree/emails/app/subscribers/spree/order_email_subscriber.rb b/spree/emails/app/subscribers/spree/order_email_subscriber.rb
index 1828761914..7d44605bff 100644
--- a/spree/emails/app/subscribers/spree/order_email_subscriber.rb
+++ b/spree/emails/app/subscribers/spree/order_email_subscriber.rb
@@ -2,9 +2,9 @@
module Spree
class OrderEmailSubscriber < Spree::Subscriber
- subscribes_to 'order.completed', 'order.canceled', 'order.resend_confirmation_email'
+ subscribes_to 'order.placed', 'order.canceled', 'order.resend_confirmation_email'
- on 'order.completed', :send_confirmation_email
+ on 'order.placed', :send_confirmation_email
on 'order.canceled', :send_cancel_email
on 'order.resend_confirmation_email', :resend_confirmation_email
diff --git a/spree/emails/spec/models/spree/order_spec.rb b/spree/emails/spec/models/spree/order_spec.rb
index 308c905abf..e6eb4a7ddd 100644
--- a/spree/emails/spec/models/spree/order_spec.rb
+++ b/spree/emails/spec/models/spree/order_spec.rb
@@ -12,8 +12,8 @@ describe Spree::Order, type: :model do
order.update_column :status, 'placed'
end
- it 'publishes order.completed event when finalizing', events: true do
- expect(order).to receive(:publish_event).with('order.completed', hash_including(:notify_customer))
+ it 'publishes order.placed event when finalizing', events: true do
+ expect(order).to receive(:publish_event).with('order.placed', hash_including(:notify_customer))
allow(order).to receive(:publish_event).with(anything)
allow(order).to receive(:publish_event).with(anything, anything)