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
Carry workflow rejections as ActiveModel::Errors
Damian Legawieceb38ebcf593c
diff --git a/spree/core/app/services/spree/returns/eligibility_validator.rb b/spree/core/app/services/spree/returns/eligibility_validator.rbindex 846e38eb3d..044391e2e1 100644--- a/spree/core/app/services/spree/returns/eligibility_validator.rb+++ b/spree/core/app/services/spree/returns/eligibility_validator.rb@@ -29,9 +29,12 @@ module Spree# same way. The override is attributable through `created_by`.return if workflow.created_by.present?- workflow.reject!(- Spree.t('return_errors.outside_window', days: window)+ workflow.errors.add(+ :base,+ :outside_return_window,+ message: Spree.t('return_errors.outside_window', days: window))+ workflow.reject!endprivatediff --git a/spree/core/lib/spree/core/engine.rb b/spree/core/lib/spree/core/engine.rbindex aeb4f13dcd..071d4d12cb 100644--- a/spree/core/lib/spree/core/engine.rb+++ b/spree/core/lib/spree/core/engine.rb@@ -526,6 +526,17 @@ module SpreeSpree.hooks.register('exchanges.create.validate', 'Spree::Returns::EligibilityValidator')end+ # A hook registered against a key no workflow declares would never fire+ # and never say so. Checking after eager load turns that typo into a+ # boot failure. Skipped when eager loading is off (development,+ # console): workflow classes load lazily there, so a declared hook may+ # simply not be defined yet.+ initializer 'spree.hooks.validate', after: :load_config_initializers do |app|+ app.config.after_initialize do+ Spree.hooks.validate! if app.config.eager_load+ end+ end+config.to_prepare do# Ensure spree locale paths are present before decoratorsI18n.load_path.unshift(*(Dir.glob(diff --git a/spree/core/lib/spree/workflow.rb b/spree/core/lib/spree/workflow.rbindex 37a03a5067..1371039de8 100644--- a/spree/core/lib/spree/workflow.rb+++ b/spree/core/lib/spree/workflow.rb@@ -81,9 +81,21 @@ module Spreeendprepend ControlFlow+ # ActiveModel::Errors asks its base for these when turning a symbolic+ # error into a message — a workflow is not a model, but it answers the+ # same three questions so `errors.add(:field, :symbol)` resolves against+ # the workflow's own i18n scope.+ extend ActiveModel::Naming+ extend ActiveModel::Translation+class << selfattr_reader :declared_hooks+ # Anonymous test doubles have no name to derive a model name from.+ def model_name+ @model_name ||= ActiveModel::Name.new(self, nil, name || 'Workflow')+ end+# A subclass inherits the parent's declared hooks but dispatches them# under its OWN key — Spree::Orders::AddItem fires# 'orders.add_item.validate', not the cart key — so it registers@@ -161,16 +173,42 @@ module Spreeraise Halted.new(value)end+ # Rejections a handler collected, rendered by the API through the same+ # path as model validation errors — an extension veto and a failed+ # `validates` produce the same 422 shape.+ #+ # @return [ActiveModel::Errors]+ def errors+ @errors ||= ActiveModel::Errors.new(self)+ end++ delegate :model_name, to: :class++ # ActiveModel::Errors reads attribute values off its base when+ # interpolating a message; a workflow's "attributes" are its argument+ # readers, and an error on an attribute the workflow doesn't expose+ # (:base, or a field name belonging to the record) must not raise.+ def read_attribute_for_validation(attribute)+ respond_to?(attribute) ? public_send(attribute) : nil+ end+# Vetoes the flow from a hook handler — the extension-facing twin of# failure(...). Same mechanics (raises, unwinds the undo stack, rolls# back an open transaction); the distinct name keeps "an extension# rejected this" legible against "this step failed" at the call site.# Public because handlers call it on the dispatched instance.#- # @param message [String, Symbol] surfaced as the failure Result's error+ # Preferred form is argument-less, after adding symbolic errors:+ #+ # workflow.errors.add(:quantity, :purchase_limit_exceeded, message: '…')+ # workflow.reject!+ #+ # @param message [String, Symbol, nil] legacy flat rejection; recorded on+ # :base so it renders through the same field-error payload# @param value [Object, nil] subject of the failure Result- def reject!(message, value = nil)- failure(value, message)+ def reject!(message = nil, value = nil)+ errors.add(:base, message) if message.present?+ failure(value, errors)endprivatediff --git a/spree/core/spec/lib/spree/workflow_spec.rb b/spree/core/spec/lib/spree/workflow_spec.rbindex b78736f00b..28263c5be1 100644--- a/spree/core/spec/lib/spree/workflow_spec.rb+++ b/spree/core/spec/lib/spree/workflow_spec.rb@@ -383,7 +383,46 @@ RSpec.describe Spree::Workflow doresult = workflow.call(subject: 1)expect(result).to be_failure- expect(result.error.value).to eq('outside the return window')+ expect(result.error.to_s).to eq('outside the return window')+ end++ it 'carries field-scoped symbolic errors a handler added' do+ workflow = build_workflow do+ hooks :validate++ def perform(subject:)+ super+ run_hooks :validate+ success(subject)+ end+ end++ Spree.hooks.register('testing.sample_workflow.validate') do |flow|+ flow.errors.add(:quantity, :purchase_limit_exceeded, message: 'at most 10 per order')+ flow.reject!+ end++ errors = workflow.call(subject: 1).error.value++ expect(errors).to be_a(ActiveModel::Errors)+ expect(errors.messages[:quantity]).to eq(['at most 10 per order'])+ expect(errors.details[:quantity].first[:error]).to eq(:purchase_limit_exceeded)+ end++ it 'records a legacy flat message on :base' do+ workflow = build_workflow do+ hooks :validate++ def perform(subject:)+ super+ run_hooks :validate+ success(subject)+ end+ end++ Spree.hooks.register('testing.sample_workflow.validate') { |flow| flow.reject!('nope') }++ expect(workflow.call(subject: 1).error.value.messages[:base]).to eq(['nope'])endit 'rolls back work committed by earlier steps in the same transaction' dodiff --git a/spree/core/spec/workflows/spree/carts/merge_spec.rb b/spree/core/spec/workflows/spree/carts/merge_spec.rbindex 8fdbb178b6..cf94166b50 100644--- a/spree/core/spec/workflows/spree/carts/merge_spec.rb+++ b/spree/core/spec/workflows/spree/carts/merge_spec.rb@@ -57,7 +57,7 @@ RSpec.describe Spree::Carts::Merge doresult = described_class.call(cart: cart, other_cart: other_cart)expect(result).to be_failure- expect(result.error.value).to eq('merging is disabled')+ expect(result.error.to_s).to eq('merging is disabled')expect(cart.reload.line_items).to be_emptyexpect(other_cart.reload.line_items.count).to eq(1)enddiff --git a/spree/core/spec/workflows/spree/customers/create_spec.rb b/spree/core/spec/workflows/spree/customers/create_spec.rbindex d4995ccb93..478f46899f 100644--- a/spree/core/spec/workflows/spree/customers/create_spec.rb+++ b/spree/core/spec/workflows/spree/customers/create_spec.rb@@ -68,7 +68,7 @@ RSpec.describe Spree::Customers::Create doendexpect(result).to be_failure- expect(result.error.value).to eq('disposable emails are not accepted')+ expect(result.error.to_s).to eq('disposable emails are not accepted')expect(Spree.customer_class.find_by(email: '[email protected]')).to be_nilenddiff --git a/spree/core/spec/workflows/spree/payments/capture_spec.rb b/spree/core/spec/workflows/spree/payments/capture_spec.rbindex 2064ec54e2..712cafc505 100644--- a/spree/core/spec/workflows/spree/payments/capture_spec.rb+++ b/spree/core/spec/workflows/spree/payments/capture_spec.rb@@ -56,7 +56,7 @@ RSpec.describe Spree::Payments::Capture doresult = described_class.call(payment: payment)expect(result).to be_failure- expect(result.error.value).to eq('on fraud hold')+ expect(result.error.to_s).to eq('on fraud hold')endit 'runs after_capture once the gateway call succeeds' dodiff --git a/spree/core/spec/workflows/spree/payments/refund_spec.rb b/spree/core/spec/workflows/spree/payments/refund_spec.rbindex 12a133a466..d2b3594fd6 100644--- a/spree/core/spec/workflows/spree/payments/refund_spec.rb+++ b/spree/core/spec/workflows/spree/payments/refund_spec.rb@@ -58,7 +58,7 @@ RSpec.describe Spree::Payments::Refund doresult = described_class.call(payment: payment)expect(result).to be_failure- expect(result.error.value).to eq('refunds disabled')+ expect(result.error.to_s).to eq('refunds disabled')expect(payment.refunds).to be_emptyenddiff --git a/spree/core/spec/workflows/spree/returns/lifecycle_spec.rb b/spree/core/spec/workflows/spree/returns/lifecycle_spec.rbindex 12b318aed6..330c278282 100644--- a/spree/core/spec/workflows/spree/returns/lifecycle_spec.rb+++ b/spree/core/spec/workflows/spree/returns/lifecycle_spec.rb@@ -62,7 +62,7 @@ RSpec.describe 'Spree::Returns workflows' doresult = create_returnexpect(result).to be_failure- expect(result.error.value).to eq('outside the return window')+ expect(result.error.to_s).to eq('outside the return window')expect(order.reload.returns).to be_emptyendend