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.

Add List of custom webhook events in Webhooks::Subscriber (#11495)

Aleksandar Petrushev1638a151a41f
diff --git a/api/app/models/concerns/spree/webhooks/has_webhooks.rb b/api/app/models/concerns/spree/webhooks/has_webhooks.rb
index 691435bbab..7c08f99c79 100644
--- a/api/app/models/concerns/spree/webhooks/has_webhooks.rb
+++ b/api/app/models/concerns/spree/webhooks/has_webhooks.rb
@@ -13,6 +13,17 @@ module Spree
Spree::Webhooks::Subscribers::QueueRequests.call(body: body, event_name: event_name)
end
+
+ def self.default_webhook_events
+ model_name = name.demodulize.tableize.singularize
+ %W[#{model_name}.create #{model_name}.delete #{model_name}.update]
+ end
+
+ def self.supported_webhook_events
+ events = default_webhook_events
+ events += custom_webhook_events if respond_to?(:custom_webhook_events)
+ events
+ end
end
private
diff --git a/api/app/models/spree/api/webhooks/order_decorator.rb b/api/app/models/spree/api/webhooks/order_decorator.rb
index c3896a0c6a..61de7584c2 100644
--- a/api/app/models/spree/api/webhooks/order_decorator.rb
+++ b/api/app/models/spree/api/webhooks/order_decorator.rb
@@ -3,6 +3,10 @@ module Spree
module Webhooks
module OrderDecorator
def self.prepended(base)
+ def base.custom_webhook_events
+ %w[order.canceled order.placed order.resumed order.shipped]
+ end
+
base.after_update_commit :queue_webhooks_requests_for_order_resumed!
end
diff --git a/api/app/models/spree/api/webhooks/payment_decorator.rb b/api/app/models/spree/api/webhooks/payment_decorator.rb
index 68e7fa46de..00b46bcf62 100644
--- a/api/app/models/spree/api/webhooks/payment_decorator.rb
+++ b/api/app/models/spree/api/webhooks/payment_decorator.rb
@@ -2,6 +2,12 @@ module Spree
module Api
module Webhooks
module PaymentDecorator
+ def self.prepended(base)
+ def base.custom_webhook_events
+ %w[payment.paid payment.voided]
+ end
+ end
+
def after_void
super
queue_webhooks_requests!('payment.voided')
diff --git a/api/app/models/spree/api/webhooks/product_decorator.rb b/api/app/models/spree/api/webhooks/product_decorator.rb
index 22d1299509..6a07c66935 100644
--- a/api/app/models/spree/api/webhooks/product_decorator.rb
+++ b/api/app/models/spree/api/webhooks/product_decorator.rb
@@ -3,6 +3,10 @@ module Spree
module Webhooks
module ProductDecorator
def self.prepended(base)
+ def base.custom_webhook_events
+ %w[product.back_in_stock product.backorderable product.discontinued product.out_of_stock]
+ end
+
base.after_update_commit :queue_webhooks_requests_for_product_discontinued!
end
diff --git a/api/app/models/spree/api/webhooks/shipment_decorator.rb b/api/app/models/spree/api/webhooks/shipment_decorator.rb
index 3f46b0cca9..ee2181cf8c 100644
--- a/api/app/models/spree/api/webhooks/shipment_decorator.rb
+++ b/api/app/models/spree/api/webhooks/shipment_decorator.rb
@@ -2,6 +2,12 @@ module Spree
module Api
module Webhooks
module ShipmentDecorator
+ def self.prepended(base)
+ def base.custom_webhook_events
+ %w[shipment.shipped]
+ end
+ end
+
def after_ship
super
queue_webhooks_requests!('shipment.shipped')
diff --git a/api/app/models/spree/api/webhooks/variant_decorator.rb b/api/app/models/spree/api/webhooks/variant_decorator.rb
index 7e041037de..39bd5e99bc 100644
--- a/api/app/models/spree/api/webhooks/variant_decorator.rb
+++ b/api/app/models/spree/api/webhooks/variant_decorator.rb
@@ -3,6 +3,10 @@ module Spree
module Webhooks
module VariantDecorator
def self.prepended(base)
+ def base.custom_webhook_events
+ %w[variant.back_in_stock variant.backorderable variant.discontinued variant.out_of_stock]
+ end
+
base.after_update_commit :queue_webhooks_requests_for_variant_discontinued!
end
diff --git a/api/app/models/spree/webhooks/subscriber.rb b/api/app/models/spree/webhooks/subscriber.rb
index dd08c10aa0..f75e642a55 100644
--- a/api/app/models/spree/webhooks/subscriber.rb
+++ b/api/app/models/spree/webhooks/subscriber.rb
@@ -26,6 +26,15 @@ module Spree
)
end
+ def self.supported_events
+ Spree::Base.descendants.
+ select { |model| model.included_modules.include? Spree::Webhooks::HasWebhooks }.
+ to_h do |model|
+ model_name = model.name.demodulize.underscore.to_sym
+ [model_name, model.supported_webhook_events]
+ end
+ end
+
private
def check_uri_path
diff --git a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb
index 8886f62a13..584791ed50 100644
--- a/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb
+++ b/api/spec/models/concerns/spree/webhooks/has_webhooks_spec.rb
@@ -113,4 +113,25 @@ describe Spree::Webhooks::HasWebhooks do
end
end
end
+
+ describe '.default_webhook_events' do
+ it 'return the default events' do
+ expect(Spree::Order.default_webhook_events).to eq(%w[order.create order.delete order.update])
+ end
+ end
+
+ describe '.supported_webhook_events' do
+ context 'when there are custom supported events' do
+ it 'returns the default and custom events' do
+ expected_webhook_events = %w[order.create order.delete order.update order.canceled order.placed order.resumed order.shipped]
+ expect(Spree::Order.supported_webhook_events).to contain_exactly(*expected_webhook_events)
+ end
+ end
+
+ context 'when there are no custom supported events' do
+ it 'return the default events' do
+ expect(Spree::Zone.supported_webhook_events).to eq(Spree::Zone.default_webhook_events)
+ end
+ end
+ end
end
diff --git a/api/spec/models/spree/webhooks/subscriber_spec.rb b/api/spec/models/spree/webhooks/subscriber_spec.rb
index 405fcff163..fe5a6894c9 100644
--- a/api/spec/models/spree/webhooks/subscriber_spec.rb
+++ b/api/spec/models/spree/webhooks/subscriber_spec.rb
@@ -65,4 +65,16 @@ describe Spree::Webhooks::Subscriber do
it { expect(subject).to be_empty }
end
end
+
+ describe '.supported_events' do
+ subject { described_class.supported_events }
+
+ it 'includes the webhookable model in supported events list' do
+ class WebhookableDummy < Spree::Base
+ include Spree::Webhooks::HasWebhooks
+ end
+
+ expect(subject[:webhookable_dummy]).to contain_exactly('webhookable_dummy.create', 'webhookable_dummy.update', 'webhookable_dummy.delete')
+ end
+ end
end