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
Use Order/Payment/Shipment serializers.
Sebastian Palma23706a09b63b
diff --git a/api/app/models/concerns/spree/webhooks/has_webhooks.rb b/api/app/models/concerns/spree/webhooks/has_webhooks.rbindex cb3dd1fb60..df74e623a7 100644--- a/api/app/models/concerns/spree/webhooks/has_webhooks.rb+++ b/api/app/models/concerns/spree/webhooks/has_webhooks.rb@@ -4,9 +4,9 @@ module Spreeextend ActiveSupport::Concernincluded do- after_create_commit proc { queue_webhooks_requests!(event_name(:create)) }- after_destroy_commit proc { queue_webhooks_requests!(event_name(:destroy)) }- after_update_commit proc { queue_webhooks_requests!(event_name(:update)) }+ after_create_commit(proc { queue_webhooks_requests!(event_name(:create)) })+ after_destroy_commit(proc { queue_webhooks_requests!(event_name(:destroy)) })+ after_update_commit(proc { queue_webhooks_requests!(event_name(:update)) })def queue_webhooks_requests!(event)return if disable_spree_webhooks?@@ -24,17 +24,17 @@ module Spreeenddef webhooks_descendant?- if Rails::VERSION::MAJOR < 6- self.class.parent == Spree::Webhooks- else+ if Rails::VERSION::MAJOR >= 6self.class.module_parent == Spree::Webhooks+ else+ self.class.parent == Spree::Webhooksendenddef payload- resource_serializer.new(self).serializable_hash+ resource_serializer.new(self).serializable_hash.to_jsonrescue NameError- {}+ ''enddef resource_serializerdiff --git a/api/app/models/spree/api/webhooks/order.rb b/api/app/models/spree/api/webhooks/order.rbindex 1a7eaa7b01..2685ef94e0 100644--- a/api/app/models/spree/api/webhooks/order.rb+++ b/api/app/models/spree/api/webhooks/order.rb@@ -4,12 +4,12 @@ module Spreemodule Orderdef after_cancelsuper- Spree::Webhooks::Endpoints::QueueRequests.call(event: 'order.cancel', payload: {})+ queue_webhooks_requests!('order.cancel')enddef finalize!super- Spree::Webhooks::Endpoints::QueueRequests.call(event: 'order.complete', payload: {})+ queue_webhooks_requests!('order.complete')endendenddiff --git a/api/app/models/spree/api/webhooks/payment.rb b/api/app/models/spree/api/webhooks/payment.rbindex ade2261f19..0efcbd26db 100644--- a/api/app/models/spree/api/webhooks/payment.rb+++ b/api/app/models/spree/api/webhooks/payment.rb@@ -4,7 +4,7 @@ module Spreemodule Paymentdef after_voidsuper- Spree::Webhooks::Endpoints::QueueRequests.call(event: 'payment.void', payload: {})+ queue_webhooks_requests!('payment.void')endendenddiff --git a/api/app/models/spree/api/webhooks/shipment.rb b/api/app/models/spree/api/webhooks/shipment.rbindex 7f46977c5d..74cf7b1d78 100644--- a/api/app/models/spree/api/webhooks/shipment.rb+++ b/api/app/models/spree/api/webhooks/shipment.rb@@ -4,7 +4,7 @@ module Spreemodule Shipmentdef after_shipsuper- Spree::Webhooks::Endpoints::QueueRequests.call(event: 'shipment.ship', payload: {})+ queue_webhooks_requests!('shipment.ship')endendenddiff --git a/api/app/services/spree/webhooks/endpoints/queue_requests.rb b/api/app/services/spree/webhooks/endpoints/queue_requests.rbindex 77e5bb198b..f8b1e68b1b 100644--- a/api/app/services/spree/webhooks/endpoints/queue_requests.rb+++ b/api/app/services/spree/webhooks/endpoints/queue_requests.rb@@ -5,20 +5,13 @@ module Spreeprepend Spree::ServiceModule::Basedef call(event:, payload:)- return failure(false) if ENV['DISABLE_SPREE_WEBHOOKS'] == 'true'-- run :queue_requests- end-- private-- def queue_requests(event:, payload:)urls_subscribed_to(event).each do |url|Spree::Webhooks::Endpoints::MakeRequestJob.perform_later(payload, url)end- success(true)end+ private+def urls_subscribed_to(event)Spree::Webhooks::Endpoint.where(enabled: true).diff --git a/api/lib/spree/api/testing_support/spree_webhooks.rb b/api/lib/spree/api/testing_support/spree_webhooks.rbnew file mode 100644index 0000000000..27ce53020f--- /dev/null+++ b/api/lib/spree/api/testing_support/spree_webhooks.rb@@ -0,0 +1,9 @@+RSpec.configure do |config|+ config.before(:each, :spree_webhooks) do+ ENV['DISABLE_SPREE_WEBHOOKS'] = nil+ end++ config.after(:each, :spree_webhooks) do+ ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'+ end+enddiff --git a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rbindex 79d51b3f73..06c7b93a22 100644--- a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb+++ b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb@@ -10,6 +10,8 @@ module Spreeendend+Spree::TestProduct = Spree::Webhooks::TestProduct+describe Spree::Webhooks::HasWebhooks dobefore(:all) doActiveRecord::Base.connection.create_table :test_products, force: true do |t|@@ -37,13 +39,8 @@ describe Spree::Webhooks::HasWebhooks dolet(:store) { create(:store) }let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }- context 'with DISABLE_SPREE_WEBHOOKS equals "true"' do- before do- ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'- product.save- end-- after { ENV['DISABLE_SPREE_WEBHOOKS'] = nil }+ context 'with DISABLE_SPREE_WEBHOOKS equals "true" (set in spec_helper)' do+ before { product.save }context 'after_create_commit' doit 'does not queue a request' do@@ -66,10 +63,11 @@ describe Spree::Webhooks::HasWebhooks doendend- context 'without DISABLE_SPREE_WEBHOOKS' do- before { ENV['DISABLE_SPREE_WEBHOOKS'] = nil; product.save }-- after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }+ context 'without DISABLE_SPREE_WEBHOOKS', :spree_webhooks do+ before do+ ENV['DISABLE_SPREE_WEBHOOKS'] = nil+ product.save+ endcontext 'with a Spree::Webhooks descendant class' dolet(:product) { Spree::Webhooks::TestProduct.new(name: 'test') }@@ -97,7 +95,7 @@ describe Spree::Webhooks::HasWebhooks docontext 'without a Spree::Webhooks descendant class' docontext 'with a resource serializer' do- let(:payload) { Spree::Api::V2::Platform::ProductSerializer.new(product).serializable_hash }+ let(:payload) { Spree::Api::V2::Platform::ProductSerializer.new(product).serializable_hash.to_json }context 'after_create_commit' doit 'queues a request through QueueRequests for product.create' do@@ -122,7 +120,7 @@ describe Spree::Webhooks::HasWebhooks docontext 'with a class name with multiple words' dolet!(:cms_page) { create(:cms_homepage, store: store, locale: 'en') }let(:payload) do- Spree::Api::V2::Platform::CmsPageSerializer.new(cms_page).serializable_hash+ Spree::Api::V2::Platform::CmsPageSerializer.new(cms_page).serializable_hash.to_jsonendlet(:underscore_event) { 'cms_page.create' }@@ -132,26 +130,26 @@ describe Spree::Webhooks::HasWebhooks doendend- context 'without a resource serializer' do- let!(:shipment) { create(:shipment) }+ context 'without a resource serializer - blank payload' do+ let(:product) { Spree::TestProduct.new(name: 'test') }context 'after_create_commit' doit 'does not queue a request' do- expect(queue_requests).not_to have_received(:call).with(hash_including(event: 'shipment.create'))+ expect(queue_requests).not_to have_received(:call).with(hash_including(event: 'test_product.create'))endendcontext 'after_destroy_commit' doit 'does not queue a request' do- shipment.destroy- expect(queue_requests).not_to have_received(:call).with(hash_including(event: 'shipment.destroy'))+ product.destroy+ expect(queue_requests).not_to have_received(:call).with(hash_including(event: 'test_product.destroy'))endendcontext 'after_update_commit' doit 'does not queue a request' do- shipment.update(tracking: 'U10001')- expect(queue_requests).not_to have_received(:call).with(hash_including(event: 'shipment.update'))+ product.update(name: 'new name')+ expect(queue_requests).not_to have_received(:call).with(hash_including(event: 'test_product.update'))endendenddiff --git a/api/spec/models/spree/api/webhooks/order_spec.rb b/api/spec/models/spree/api/webhooks/order_spec.rbindex 18d8094a2e..179ed2f4d2 100644--- a/api/spec/models/spree/api/webhooks/order_spec.rb+++ b/api/spec/models/spree/api/webhooks/order_spec.rb@@ -2,26 +2,33 @@ require 'spec_helper'describe Spree::Order dodescribe 'sending webhooks after transitioning from states' do- let(:payload) { {} }let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }- let!(:store) { create(:store, default: true) }+ let(:store) { create(:store, default: true) }+ let(:payload) do+ Spree::Api::V2::Platform::OrderSerializer.new(order).serializable_hash.to_json+ endbefore do+ ENV['DISABLE_SPREE_WEBHOOKS'] = nilallow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)allow(queue_requests).to receive(:call).with(any_args)end- context '#after_cancel' do+ after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }++ describe '#after_cancel' dolet(:order) { create(:completed_order_with_totals, store: store) }it 'executes QueueRequests.call with a order.cancel event and {} payload after invoking cancel' do- order.cancel- expect(queue_requests).to have_received(:call).with(event: 'order.cancel', payload: payload).once+ Timecop.freeze(Time.local(1990)) do+ order.cancel+ expect(queue_requests).to have_received(:call).with(event: 'order.cancel', payload: payload).once+ endendend- context '#finalize!' do- let(:order) { Spree::Order.create(email: '[email protected]', store: store) }+ describe '#finalize!' do+ let(:order) { described_class.create(email: '[email protected]', store: store) }it 'executes QueueRequests.call with a order.complete event and {} payload after invoking finalize!' doorder.finalize!diff --git a/api/spec/models/spree/api/webhooks/payment_spec.rb b/api/spec/models/spree/api/webhooks/payment_spec.rbindex 92d3a10fb4..b9dbc61354 100644--- a/api/spec/models/spree/api/webhooks/payment_spec.rb+++ b/api/spec/models/spree/api/webhooks/payment_spec.rb@@ -4,15 +4,22 @@ describe Spree::Payment dolet(:payment) { create(:payment) }describe '#void' do- let(:payload) { {} }+ let(:payload) { Spree::Api::V2::Platform::PaymentSerializer.new(payment).serializable_hash.to_json }let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }- before do- allow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)- allow(queue_requests).to receive(:call).with(any_args)- end-shared_examples 'queues a webhook request' do+ before do+ ENV['DISABLE_SPREE_WEBHOOKS'] = nil+ # Avoid creating a new state change after transitioning as is defined in the model+ # because after_void queues the HTTP request before finishing the transition, hence+ # the total state changes that are sent in the payload is one less.+ allow(payment).to receive_message_chain(:state_changes, :create!)+ allow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)+ allow(queue_requests).to receive(:call).with(any_args)+ end++ after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }+it 'executes QueueRequests.call with a payment.void event and {} payload after invoking void' dopayment.voidexpect(queue_requests).to have_received(:call).with(event: 'payment.void', payload: payload).oncediff --git a/api/spec/models/spree/api/webhooks/shipment_spec.rb b/api/spec/models/spree/api/webhooks/shipment_spec.rbindex 381892a9d1..7a664cbb4a 100644--- a/api/spec/models/spree/api/webhooks/shipment_spec.rb+++ b/api/spec/models/spree/api/webhooks/shipment_spec.rb@@ -2,14 +2,21 @@ require 'spec_helper'describe Spree::Shipment dolet(:shipment) { create(:shipment) }+ let(:payload) { Spree::Api::V2::Platform::ShipmentSerializer.new(shipment).serializable_hash.to_json }- context '#after_ship' do+ describe '#after_ship' dobefore do+ ENV['DISABLE_SPREE_WEBHOOKS'] = nil+ # Avoid creating a new state change after transitioning as is defined in the model+ # because after_void queues the HTTP request before finishing the transition, hence+ # the total state changes that are sent in the payload is one less.+ allow(shipment).to receive_message_chain(:state_changes, :create!)allow(Spree::Webhooks::Endpoints::QueueRequests).to receive(:new).and_return(queue_requests)allow(queue_requests).to receive(:call).with(any_args)end- let(:payload) { {} }+ after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }+let(:queue_requests) { instance_double(Spree::Webhooks::Endpoints::QueueRequests) }it 'executes QueueRequests.call with a shipment.ship event and {} payload after invoking ship' dodiff --git a/api/spec/services/spree/webhooks/endpoints/queue_request_spec.rb b/api/spec/services/spree/webhooks/endpoints/queue_request_spec.rbindex e677307048..4113406b03 100644--- a/api/spec/services/spree/webhooks/endpoints/queue_request_spec.rb+++ b/api/spec/services/spree/webhooks/endpoints/queue_request_spec.rb@@ -1,126 +1,88 @@require 'spec_helper'-describe Spree::Webhooks::Endpoints::QueueRequests, :job do+describe Spree::Webhooks::Endpoints::QueueRequests, :job, :spree_webhooks dodescribe '#call' dosubject { described_class.call(event: event, payload: payload) }let(:event) { 'order.finalize' }let(:payload) { {} }-- context 'with DISABLE_SPREE_WEBHOOKS equals "true"' do- before do- ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'- Spree::Webhooks::Endpoint.create(url: url, subscriptions: ['*'], enabled: true)- end-- after { ENV.delete('DISABLE_SPREE_WEBHOOKS') }-- let(:url) { 'https://url1.com/' }-- it 'returns early without querying for the subscribed events' do- instance = Spree::Webhooks::Endpoints::QueueRequests.new- expect(instance).to receive(:call).and_call_original- expect(instance).not_to receive(:urls_subscribed_to)- instance.call(event: event, payload: payload)- end-- it 'does not succeed' do- expect(subject.success).to eq(false)- end-- it 'returns a false value' do- expect(subject.value).to eq(false)+ let(:queue) { 'spree_webhooks' }+ let(:make_request_job) { Spree::Webhooks::Endpoints::MakeRequestJob }++ context 'without subscriptions for the given event' do+ it 'does not queue a job to make a request' do+ expect { subject }.not_to(+ have_enqueued_job(Spree::Webhooks::Endpoints::MakeRequest).on_queue(queue)+ )endend- context 'without DISABLE_SPREE_WEBHOOKS' do- before { ENV['DISABLE_SPREE_WEBHOOKS'] = nil }+ context 'with subscriptions for the given event' do+ context 'when endpoint subscriptions includes all events (*)' do+ before { stub_request(:post, endpoint.url) }- after { ENV['DISABLE_SPREE_WEBHOOKS'] = 'true' }+ let(:endpoint) do+ Spree::Webhooks::Endpoint.create(+ url: 'https://url1.com/',+ subscriptions: ['*'],+ enabled: true+ )+ end- context 'without subscriptions for the given event' do- it 'does not queue a job to make a request' do- expect { subject }.not_to(- have_enqueued_job(Spree::Webhooks::Endpoints::MakeRequest).on_queue('spree_webhooks')+ it 'queues a job to make a request' do+ expect { subject }.to(+ have_enqueued_job(make_request_job).with(payload, endpoint.url).on_queue(queue))endend- context 'with subscriptions for the given event' do- context 'when endpoint subscriptions includes all events (*)' do- before { stub_request(:post, endpoint.url) }-- let(:endpoint) do- Spree::Webhooks::Endpoint.create(- url: 'https://url1.com/',- subscriptions: ['*'],- enabled: true- )- end+ context 'when endpoint subscriptions includes the specific event being used' do+ before { stub_request(:post, endpoint.url) }- it 'queues a job to make a request' do- expect { subject }.to(- have_enqueued_job(Spree::Webhooks::Endpoints::MakeRequestJob).- with(payload, endpoint.url).- on_queue('spree_webhooks')- )- end+ let(:endpoint) do+ Spree::Webhooks::Endpoint.create(+ url: 'https://url2.com/',+ subscriptions: [event],+ enabled: true+ )end- context 'when endpoint subscriptions includes the specific event being used' do- before { stub_request(:post, endpoint.url) }-- let(:endpoint) do- Spree::Webhooks::Endpoint.create(- url: 'https://url2.com/',- subscriptions: [event],- enabled: true- )- end-- it 'queues a job to make a request' do- expect { subject }.to(- have_enqueued_job(Spree::Webhooks::Endpoints::MakeRequestJob).- with(payload, endpoint.url).- on_queue('spree_webhooks')- )- end+ it 'queues a job to make a request' do+ expect { subject }.to(+ have_enqueued_job(make_request_job).with(payload, endpoint.url).on_queue(queue)+ )end+ end- context 'when endpoint subscriptions are not enabled' do- let(:endpoint) do- Spree::Webhooks::Endpoint.create(- url: 'https://url3.com/',- subscriptions: [event],- enabled: false- )- end+ context 'when endpoint subscriptions are not enabled' do+ let(:endpoint) do+ Spree::Webhooks::Endpoint.create(+ url: 'https://url3.com/',+ subscriptions: [event],+ enabled: false+ )+ end- it 'does not queue a job to make a request' do- expect { subject }.not_to(- have_enqueued_job(Spree::Webhooks::Endpoints::MakeRequestJob).- with(payload, endpoint.url).- on_queue('spree_webhooks')- )- end+ it 'does not queue a job to make a request' do+ expect { subject }.not_to(+ have_enqueued_job(make_request_job).with(payload, endpoint.url).on_queue(queue)+ )end+ end- context 'when endpoint subscriptions do not include the event or "*"' do- let(:endpoint) do- Spree::Webhooks::Endpoint.create(- url: 'https://url4.com/',- subscriptions: ['order.resume'],- enabled: true- )- end+ context 'when endpoint subscriptions do not include the event or "*"' do+ let(:endpoint) do+ Spree::Webhooks::Endpoint.create(+ url: 'https://url4.com/',+ subscriptions: ['order.resume'],+ enabled: true+ )+ end- it 'does not queue a job to make a request' do- expect { subject }.not_to(- have_enqueued_job(Spree::Webhooks::Endpoints::MakeRequestJob).- with(endpoint.url).- on_queue('spree_webhooks')- )- end+ it 'does not queue a job to make a request' do+ expect { subject }.not_to(+ have_enqueued_job(make_request_job).with(payload, endpoint.url).on_queue(queue)+ )endendenddiff --git a/api/spec/spec_helper.rb b/api/spec/spec_helper.rbindex f42793b3d9..6e9cc381c3 100644--- a/api/spec/spec_helper.rb+++ b/api/spec/spec_helper.rb@@ -43,6 +43,7 @@ require 'spree/api/testing_support/caching'require 'spree/api/testing_support/jobs'require 'spree/api/testing_support/helpers'require 'spree/api/testing_support/setup'+require 'spree/api/testing_support/spree_webhooks'require 'spree/api/testing_support/v2/base'require 'spree/api/testing_support/v2/current_order'require 'spree/api/testing_support/v2/platform_contexts'diff --git a/core/spec/lib/i18n_spec.rb b/core/spec/lib/i18n_spec.rbindex b114b49543..52753bbb38 100644--- a/core/spec/lib/i18n_spec.rb+++ b/core/spec/lib/i18n_spec.rb@@ -30,7 +30,7 @@ describe 'i18n' dolocales = Spree.available_localesexpected_locales = [:en, :de, :nl, :ar, :az, :bg, :ca, :cs, :da, :el, :es, :fa, :fi, :fr, :hu, :id, :it, :ja, :"pt-BR", :ro, :ru, :sk, :tr, :"zh-CN", :"zh-TW", :pl, :uk, :vi]- expect(locales).to eq expected_locales+ expect(locales.sort).to eq expected_locales.sortendit 'returns an array with the string "en" removed' do@@ -46,7 +46,7 @@ describe 'i18n' doexpected_locales = [:en, :ar, :az, :bg, :ca, :cs, :da, :de, :el, :es, :fa, :fi, :fr, :hu, :id, :it, :ja, :nl, :"pt-BR", :ro, :ru, :sk, :tr, :"zh-CN", :"zh-TW", :pl, :uk, :vi]- expect(locales).to eq expected_locales+ expect(locales.sort).to eq expected_locales.sortendendenddiff --git a/core/spec/services/spree/stock_locations/stock_items/create_spec.rb b/core/spec/services/spree/stock_locations/stock_items/create_spec.rbindex b72a8d7a89..6df6441aa9 100644--- a/core/spec/services/spree/stock_locations/stock_items/create_spec.rb+++ b/core/spec/services/spree/stock_locations/stock_items/create_spec.rb@@ -62,19 +62,18 @@ module Spreeendit 'sets the stock location data necessary for the inserted stock items' do- unrelated_variant.reload- Timecop.freeze(time_current)- result- expect(created_stock_item_attrs).to(- eq([- stock_location.id,- unrelated_variant.id,- stock_location.backorderable_default,- time_current,- time_current- ])- )- Timecop.return+ Timecop.freeze(time_current) do+ result+ expect(created_stock_item_attrs).to(+ eq([+ stock_location.id,+ unrelated_variant.id,+ stock_location.backorderable_default,+ time_current,+ time_current+ ])+ )+ endendit 'invalidates the Variant cache' do