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 Subscriber#urls_for.

Sebastian Palmac116e8e7ea82
diff --git a/api/app/models/spree/webhooks/subscriber.rb b/api/app/models/spree/webhooks/subscriber.rb
index 9c004a2ec2..5636059ea1 100644
--- a/api/app/models/spree/webhooks/subscriber.rb
+++ b/api/app/models/spree/webhooks/subscriber.rb
@@ -7,6 +7,16 @@ module Spree
scope :active, -> { where(active: true) }
+ def self.urls_for(event)
+ where_condition = case ActiveRecord::Base.connection.adapter_name
+ when 'Mysql2'
+ ["('*' MEMBER OF(subscriptions) OR ? MEMBER OF(subscriptions))", event]
+ when 'PostgreSQL'
+ ["subscriptions @> '[\"*\"]' OR subscriptions @> ?", [event].to_json]
+ end
+ active.where(where_condition).pluck(:url)
+ end
+
private
def check_uri_path
diff --git a/api/app/services/spree/webhooks/subscribers/queue_requests.rb b/api/app/services/spree/webhooks/subscribers/queue_requests.rb
index c957af06a4..ec8b3ace89 100644
--- a/api/app/services/spree/webhooks/subscribers/queue_requests.rb
+++ b/api/app/services/spree/webhooks/subscribers/queue_requests.rb
@@ -5,26 +5,10 @@ module Spree
prepend Spree::ServiceModule::Base
def call(body:, event:)
- subscriberd_urls_for(event).each do |url|
+ Spree::Webhooks::Subscriber.urls_for(event).each do |url|
Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(body, event, url)
end
end
-
- private
-
- def subscriberd_urls_for(event)
- Spree::Webhooks::Subscriber.active.where(subscriptions_where_statement(event)).pluck(:url)
- end
-
- # FIXME: this should be written as scope
- def subscriptions_where_statement(event)
- case ActiveRecord::Base.connection.adapter_name
- when 'Mysql2'
- ["('*' MEMBER OF(subscriptions) OR ? MEMBER OF(subscriptions))", event]
- when 'PostgreSQL'
- ["subscriptions @> '[\"*\"]' OR subscriptions @> ?", [event].to_json]
- end
- 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 4ae897297c..779a08a87c 100644
--- a/api/spec/models/spree/webhooks/subscriber_spec.rb
+++ b/api/spec/models/spree/webhooks/subscriber_spec.rb
@@ -22,4 +22,30 @@ describe Spree::Webhooks::Subscriber do
end
end
end
+
+ describe '.urls_for' do
+ subject { described_class.urls_for(event) }
+
+ let(:active) { true }
+ let(:event) { 'order.complete' }
+ let(:subscriptions) { ['order.complete'] }
+ let!(:subscriber) { described_class.create(url: url, subscriptions: subscriptions, active: active) }
+ let(:url) { 'https://url1.com/' }
+
+ context 'with subscriptions for the given event' do
+ it { expect(subject).to eq([url]) }
+ end
+
+ context 'without subscriptions for the given event, but "*"' do
+ let(:subscriptions) { ['*'] }
+
+ it { expect(subject).to eq([url]) }
+ end
+
+ context 'without active subscriptions' do
+ let(:active) { false }
+
+ it { expect(subject).to eq([]) }
+ end
+ end
end
diff --git a/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb b/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
index 769591395d..5e8c309c04 100644
--- a/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
@@ -16,10 +16,10 @@ describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
end
context 'with subscriptions for the given event' do
- context 'when endpoint subscriptions includes all events (*)' do
- before { stub_request(:post, endpoint.url) }
+ context 'when subscriber subscriptions includes all events (*)' do
+ before { stub_request(:post, subscriber.url) }
- let(:endpoint) do
+ let(:subscriber) do
Spree::Webhooks::Subscriber.create(
url: 'https://url1.com/',
subscriptions: ['*'],
@@ -29,15 +29,15 @@ describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
it 'queues a job to make a request' do
expect { subject }.to(
- have_enqueued_job(make_request_job).with(body, event, endpoint.url).on_queue(queue)
+ have_enqueued_job(make_request_job).with(body, event, subscriber.url).on_queue(queue)
)
end
end
- context 'when endpoint subscriptions includes the specific event being used' do
- before { stub_request(:post, endpoint.url) }
+ context 'when subscriber subscriptions includes the specific event being used' do
+ before { stub_request(:post, subscriber.url) }
- let(:endpoint) do
+ let(:subscriber) do
Spree::Webhooks::Subscriber.create(
url: 'https://url2.com/',
subscriptions: [event],
@@ -47,13 +47,13 @@ describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
it 'queues a job to make a request' do
expect { subject }.to(
- have_enqueued_job(make_request_job).with(body, event, endpoint.url).on_queue(queue)
+ have_enqueued_job(make_request_job).with(body, event, subscriber.url).on_queue(queue)
)
end
end
- context 'when endpoint subscriptions are not enabled' do
- let(:endpoint) do
+ context 'when subscriber subscriptions are not enabled' do
+ let(:subscriber) do
Spree::Webhooks::Subscriber.create(
url: 'https://url3.com/',
subscriptions: [event],
@@ -66,8 +66,8 @@ describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
end
end
- context 'when endpoint subscriptions do not include the event or "*"' do
- let(:endpoint) do
+ context 'when subscriber subscriptions do not include the event or "*"' do
+ let(:subscriber) do
Spree::Webhooks::Subscriber.create(
url: 'https://url4.com/',
subscriptions: ['order.resume'],
diff --git a/core/app/validators/spree/url_validator.rb b/core/app/validators/spree/url_validator.rb
index 559167973c..63bc79bc28 100644
--- a/core/app/validators/spree/url_validator.rb
+++ b/core/app/validators/spree/url_validator.rb
@@ -1,7 +1,6 @@
module Spree
class UrlValidator < ActiveModel::EachValidator
def validate_each(record, attribute, value)
- value = value[:url] if value.is_a?(Hash)
unless url_valid?(value)
record.errors.add(attribute, (options[:message] || ERROR_MESSAGE))
end
diff --git a/core/spec/validators/spree/url_validator_spec.rb b/core/spec/validators/spree/url_validator_spec.rb
index 14f298323f..499d7678ce 100644
--- a/core/spec/validators/spree/url_validator_spec.rb
+++ b/core/spec/validators/spree/url_validator_spec.rb
@@ -2,7 +2,7 @@ require 'spec_helper'
module Spree
module Test
- Product = Struct.new(:url) do
+ Product = Struct.new(:url, keyword_init: true) do
include ActiveModel::Validations
validates :url, 'spree/url': true