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
Don't try to generate payload body when there aren't any subscribers … (#11610)
Damian Legawiecdadad988ff65
diff --git a/api/app/models/concerns/spree/webhooks/has_webhooks.rb b/api/app/models/concerns/spree/webhooks/has_webhooks.rbindex a97ecc715e..8f5e3c15fc 100644--- a/api/app/models/concerns/spree/webhooks/has_webhooks.rb+++ b/api/app/models/concerns/spree/webhooks/has_webhooks.rb@@ -9,8 +9,10 @@ module Spreeafter_update_commit(proc { queue_webhooks_requests!(inferred_event_name(:update)) })def queue_webhooks_requests!(event_name)- return if disable_spree_webhooks? || webhook_payload_body.blank?+ return if disable_spree_webhooks?+ return if Spree::Webhooks::Subscriber.active.with_urls_for(event_name).none?return if update_event?(event_name) && updating_only_timestamps?+ return if webhook_payload_body.blank?Spree::Webhooks::Subscribers::QueueRequests.call(event_name: event_name, webhook_payload_body: webhook_payload_body)enddiff --git a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rbindex fb6b1ecbe3..f35e9f70d6 100644--- a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb+++ b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb@@ -13,6 +13,7 @@ describe Spree::Webhooks::HasWebhooks do)endlet(:store) { create(:store) }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: ['*']) }context 'with DISABLE_SPREE_WEBHOOKS equals "true" (set in spec_helper)' dolet(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }@@ -125,6 +126,14 @@ describe Spree::Webhooks::HasWebhooks doexpect { cms_page.update(title: 'Homepage #1') }.not_to emit_webhook_event('store.update')endend++ context 'when no subscribers are active' do+ before { webhook_subscriber.update(active: false) }++ it 'does not emit the event' do+ expect { product.save }.not_to emit_webhook_event('product.create')+ end+ endenddescribe '.default_webhook_events' dodiff --git a/api/spec/models/spree/api/webhooks/order_decorator_spec.rb b/api/spec/models/spree/api/webhooks/order_decorator_spec.rbindex 70a602d5a9..a15abc991a 100644--- a/api/spec/models/spree/api/webhooks/order_decorator_spec.rb+++ b/api/spec/models/spree/api/webhooks/order_decorator_spec.rb@@ -7,6 +7,7 @@ describe Spree::Api::Webhooks::OrderDecorator dodescribe 'order.canceled' dodescribe 'completed -> canceled' dolet(:event_name) { 'order.canceled' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let(:order) { create(:completed_order_with_totals, store: store) }it { expect { Timecop.freeze { order.cancel } }.to emit_webhook_event(event_name) }@@ -16,6 +17,7 @@ describe Spree::Api::Webhooks::OrderDecorator dodescribe 'order.placed' dodescribe 'checkout -> completed' dolet(:event_name) { 'order.placed' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let(:order) { create(:order, email: '[email protected]', store: store) }it { expect { order.finalize! }.to emit_webhook_event(event_name) }@@ -24,6 +26,7 @@ describe Spree::Api::Webhooks::OrderDecorator dodescribe 'order.resumed' dolet(:event_name) { 'order.resumed' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let(:order) { create(:order, store: store, state: :canceled) }context 'when order state changes' dodiff --git a/api/spec/models/spree/api/webhooks/payment_decorator_spec.rb b/api/spec/models/spree/api/webhooks/payment_decorator_spec.rbindex c271ced7fd..4427bbe361 100644--- a/api/spec/models/spree/api/webhooks/payment_decorator_spec.rb+++ b/api/spec/models/spree/api/webhooks/payment_decorator_spec.rb@@ -8,6 +8,7 @@ describe Spree::Api::Webhooks::PaymentDecorator dodescribe 'payment.paid' dolet(:event_name) { 'payment.paid' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }context 'processing -> completed' dobefore { payment.started_processing }@@ -28,6 +29,7 @@ describe Spree::Api::Webhooks::PaymentDecorator dodescribe 'payment.voided' dolet(:event_name) { 'payment.voided' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }context 'pending -> void' dobefore { payment.pend }@@ -59,6 +61,7 @@ describe Spree::Api::Webhooks::PaymentDecorator dolet(:order) { payment.order }let(:event_name) { 'order.paid' }let!(:another_payment) { create(:payment, order: order) }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }context 'order.paid? == true' docontext 'processing -> complete' dodiff --git a/api/spec/models/spree/api/webhooks/product_decorator_spec.rb b/api/spec/models/spree/api/webhooks/product_decorator_spec.rbindex 249f73ce73..9b2f42a603 100644--- a/api/spec/models/spree/api/webhooks/product_decorator_spec.rb+++ b/api/spec/models/spree/api/webhooks/product_decorator_spec.rb@@ -5,6 +5,7 @@ describe Spree::Api::Webhooks::ProductDecorator docontext 'emitting product.discontinued' dolet(:webhook_payload_body) { Spree::Api::V2::Platform::ProductSerializer.new(product).serializable_hash }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let(:event_name) { 'product.discontinued' }context 'when product discontinued_on changes' dodiff --git a/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rb b/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rbindex 356e81ffbc..ff60fa5bff 100644--- a/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rb+++ b/api/spec/models/spree/api/webhooks/shipment_decorator_spec.rb@@ -15,6 +15,7 @@ describe Spree::Api::Webhooks::ShipmentDecorator docontext 'emitting shipment.shipped' dolet(:webhook_payload_body) { Spree::Api::V2::Platform::ShipmentSerializer.new(shipment).serializable_hash }let(:event_name) { 'shipment.shipped' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }context 'ready -> ship' dolet(:shipment) { create(:shipment, order: order) }@@ -38,6 +39,7 @@ describe Spree::Api::Webhooks::ShipmentDecorator docontext 'emitting order.shipped' dolet(:webhook_payload_body) { Spree::Api::V2::Platform::OrderSerializer.new(order.reload).serializable_hash }let(:event_name) { 'order.shipped' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let!(:shipments) docreate_list(:shipment, 2,diff --git a/api/spec/models/spree/api/webhooks/stock_item_decorator_spec.rb b/api/spec/models/spree/api/webhooks/stock_item_decorator_spec.rbindex 9fb66f862d..07607c0d6e 100644--- a/api/spec/models/spree/api/webhooks/stock_item_decorator_spec.rb+++ b/api/spec/models/spree/api/webhooks/stock_item_decorator_spec.rb@@ -12,6 +12,7 @@ describe Spree::Api::Webhooks::StockItemDecorator dolet(:webhook_payload_body) { Spree::Api::V2::Platform::ProductSerializer.new(product).serializable_hash }let(:product) { variant.product }let(:event_name) { 'product.backorderable' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let!(:variant2) { create(:variant, product: product) }before { Spree::StockItem.update_all(backorderable: false) }@@ -65,6 +66,7 @@ describe Spree::Api::Webhooks::StockItemDecorator dosubject { stock_item.save }let(:event_name) { 'variant.backorderable' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }context 'when variant was out of stock' dobefore dodiff --git a/api/spec/models/spree/api/webhooks/stock_movement_decorator_spec.rb b/api/spec/models/spree/api/webhooks/stock_movement_decorator_spec.rbindex 9eaa622bd3..1ede4b1acc 100644--- a/api/spec/models/spree/api/webhooks/stock_movement_decorator_spec.rb+++ b/api/spec/models/spree/api/webhooks/stock_movement_decorator_spec.rb@@ -14,6 +14,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator dodescribe 'emitting product.out_of_stock' dolet(:event_name) { 'product.out_of_stock' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }before { Spree::StockItem.update_all(backorderable: false) }@@ -100,7 +101,8 @@ describe Spree::Api::Webhooks::StockMovementDecorator doenddescribe 'emitting product.back_in_stock' do- let(:params) { 'product.back_in_stock' }+ let(:event_name) { 'product.back_in_stock' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }before { Spree::StockItem.update_all(backorderable: false) }@@ -115,7 +117,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator doproduct.reloadend- it { expect { subject }.to emit_webhook_event(params) }+ it { expect { subject }.to emit_webhook_event(event_name) }endcontext 'when none of the variants is back in stock' do@@ -128,7 +130,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator doproduct.reloadend- it { expect { subject }.not_to emit_webhook_event(params) }+ it { expect { subject }.not_to emit_webhook_event(event_name) }endend@@ -149,14 +151,15 @@ describe Spree::Api::Webhooks::StockMovementDecorator doendend- it { expect { subject }.not_to emit_webhook_event(params) }+ it { expect { subject }.not_to emit_webhook_event(event_name) }endendenddescribe 'emitting variant.back_in_stock' dolet(:variant) { create(:variant, track_inventory: true) }- let(:params) { 'variant.back_in_stock' }+ let(:event_name) { 'variant.back_in_stock' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }context 'when stock item was out of stock' docontext 'when stock item changes to be in stock' do@@ -168,7 +171,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator dostock_movement.stock_item = stock_location.set_up_stock_item(variant)stock_movement.saveend- end.to emit_webhook_event(params)+ end.to emit_webhook_event(event_name)endend@@ -181,7 +184,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator dostock_movement.stock_item = stock_location.set_up_stock_item(variant)stock_movement.saveend- end.not_to emit_webhook_event(params)+ end.not_to emit_webhook_event(event_name)endendend@@ -196,7 +199,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator dostock_movement.stock_item = stock_location.set_up_stock_item(variant)stock_movement.saveend- end.not_to emit_webhook_event(params)+ end.not_to emit_webhook_event(event_name)endendend@@ -205,7 +208,8 @@ describe Spree::Api::Webhooks::StockMovementDecorator dosubject { stock_movement }let(:stock_movement) { create(:stock_movement, stock_item: stock_item, quantity: movement_quantity) }- let(:params) { 'variant.out_of_stock' }+ let(:event_name) { 'variant.out_of_stock' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let!(:variant) { stock_item.variant }before { Spree::StockItem.update_all(backorderable: false) }@@ -214,7 +218,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator dolet(:movement_quantity) { -stock_item.count_on_hand }it 'emits the variant.out_of_stock event' do- expect { subject }.to emit_webhook_event(params)+ expect { subject }.to emit_webhook_event(event_name)endend@@ -222,7 +226,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator dolet(:movement_quantity) { -stock_item.count_on_hand + 1 }it 'does not emit the variant.out_of_stock event' do- expect { subject }.not_to emit_webhook_event(params)+ expect { subject }.not_to emit_webhook_event(event_name)endend@@ -232,7 +236,7 @@ describe Spree::Api::Webhooks::StockMovementDecorator dolet(:movement_quantity) { 0 }it 'does not emit the variant.out_of_stock event' do- expect { subject }.not_to emit_webhook_event(params)+ expect { subject }.not_to emit_webhook_event(event_name)endendenddiff --git a/api/spec/models/spree/api/webhooks/variant_decorator_spec.rb b/api/spec/models/spree/api/webhooks/variant_decorator_spec.rbindex b262d635c4..497f8368e2 100644--- a/api/spec/models/spree/api/webhooks/variant_decorator_spec.rb+++ b/api/spec/models/spree/api/webhooks/variant_decorator_spec.rb@@ -6,6 +6,7 @@ describe Spree::Api::Webhooks::VariantDecorator docontext 'emitting variant.discontinued' dolet(:webhook_payload_body) { Spree::Api::V2::Platform::VariantSerializer.new(variant).serializable_hash }let(:event_name) { 'variant.discontinued' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }context 'when variant discontinued_on changes' docontext 'when the new value is "present"' dodiff --git a/api/spec/services/spree/webhooks_spec.rb b/api/spec/services/spree/webhooks_spec.rbindex a6d8efdb12..7d5b428f31 100644--- a/api/spec/services/spree/webhooks_spec.rb+++ b/api/spec/services/spree/webhooks_spec.rb@@ -4,6 +4,7 @@ describe Spree::Webhooks dodescribe '#disable_webhooks' dolet(:webhook_payload_body) { Spree::Api::V2::Platform::VariantSerializer.new(variant).serializable_hash }let(:event_name) { 'variant.discontinued' }+ let!(:webhook_subscriber) { create(:webhook_subscriber, :active, subscriptions: [event_name]) }let(:queue_requests) { instance_double(Spree::Webhooks::Subscribers::QueueRequests) }let(:variant) { create(:variant) }