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.

Track and record Webhook Events (#11434)

seb7ef95a0fe61f
diff --git a/api/app/jobs/spree/webhooks/subscribers/make_request_job.rb b/api/app/jobs/spree/webhooks/subscribers/make_request_job.rb
index 896302f6d0..67e1940d55 100644
--- a/api/app/jobs/spree/webhooks/subscribers/make_request_job.rb
+++ b/api/app/jobs/spree/webhooks/subscribers/make_request_job.rb
@@ -4,8 +4,10 @@ module Spree
class MakeRequestJob < Spree::BaseJob
queue_as :spree_webhooks
- def perform(body, event, url)
- Spree::Webhooks::Subscribers::HandleRequest.new(body: body, event: event, url: url).call
+ def perform(body, event, subscriber)
+ Spree::Webhooks::Subscribers::HandleRequest.new(
+ body: body, event: event, subscriber: subscriber
+ ).call
end
end
end
diff --git a/api/app/models/spree/webhooks/event.rb b/api/app/models/spree/webhooks/event.rb
new file mode 100644
index 0000000000..4064dcca15
--- /dev/null
+++ b/api/app/models/spree/webhooks/event.rb
@@ -0,0 +1,9 @@
+module Spree
+ module Webhooks
+ class Event < Spree::Webhooks::Base
+ validates :name, :subscriber, presence: true
+
+ belongs_to :subscriber, inverse_of: :events, optional: false
+ end
+ end
+end
diff --git a/api/app/models/spree/webhooks/subscriber.rb b/api/app/models/spree/webhooks/subscriber.rb
index 31c1073125..cbaea5d636 100644
--- a/api/app/models/spree/webhooks/subscriber.rb
+++ b/api/app/models/spree/webhooks/subscriber.rb
@@ -1,20 +1,23 @@
module Spree
module Webhooks
class Subscriber < Spree::Webhooks::Base
+ has_many :events, inverse_of: :subscriber
+
validates :url, 'spree/url': true, presence: true
validate :check_uri_path
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
- where(where_condition).pluck(:url)
+ def self.with_urls_for(event)
+ where(
+ 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
private
diff --git a/api/app/services/spree/webhooks/subscribers/handle_request.rb b/api/app/services/spree/webhooks/subscribers/handle_request.rb
index 7caead3304..f6b9eb7618 100644
--- a/api/app/services/spree/webhooks/subscribers/handle_request.rb
+++ b/api/app/services/spree/webhooks/subscribers/handle_request.rb
@@ -4,40 +4,49 @@ module Spree
module Webhooks
module Subscribers
class HandleRequest
- def initialize(body:, event:, url:)
+ def initialize(body:, event:, subscriber:)
@body = body
@event = event
- @url = url
+ @subscriber = subscriber
end
def call
- return if body == ''
+ Rails.logger.debug(msg("sending to '#{url}'"))
+ Rails.logger.debug(msg("body: #{body}"))
- Rails.logger.debug(webhooks_log("sending to '#{url}'"))
- Rails.logger.debug(webhooks_log("body: #{body}"))
+ return create_event(:warn, msg("can not make a request to '#{url}'")) if unprocessable_uri?
+ return create_event(:warn, msg("failed for '#{url}'")) if failed_request?
- if request.unprocessable_uri?
- Rails.logger.warn(webhooks_log("can not make a request to '#{url}'"))
- return
- end
-
- if request.failed_request?
- Rails.logger.warn(webhooks_log("failed for '#{url}'"))
- return
- end
-
- Rails.logger.debug(webhooks_log("success for URL '#{url}'"))
+ create_event(:debug, msg("success for URL '#{url}'"))
end
private
- attr_reader :body, :event, :url
+ attr_reader :body, :event, :subscriber, :url
+
+ delegate :execution_time, :failed_request?, :response_code, :success?, :unprocessable_uri?,
+ to: :request
+ delegate :id, :url, to: :subscriber
def request
@request ||= Spree::Webhooks::Subscribers::MakeRequest.new(body: body, url: url)
end
- def webhooks_log(msg)
+ def create_event(log_level, msg)
+ Rails.logger.public_send(log_level, msg)
+ Spree::Webhooks::Event.create(
+ execution_time: execution_time,
+ name: event,
+ request_errors: msg,
+ response_code: response_code,
+ subscriber_id: id,
+ success: success?,
+ url: url
+ )
+ nil
+ end
+
+ def msg(msg)
"[SPREE WEBHOOKS] '#{event}' #{msg}"
end
end
diff --git a/api/app/services/spree/webhooks/subscribers/make_request.rb b/api/app/services/spree/webhooks/subscribers/make_request.rb
index dc0477d4e7..a954856335 100644
--- a/api/app/services/spree/webhooks/subscribers/make_request.rb
+++ b/api/app/services/spree/webhooks/subscribers/make_request.rb
@@ -6,12 +6,26 @@ module Spree
class MakeRequest
def initialize(body:, url:)
@body = body
+ @execution_time_in_milliseconds = 0
@url = url
@webhooks_timeout = ENV['SPREE_WEBHOOKS_TIMEOUT']
end
+ def execution_time
+ request
+ @execution_time_in_milliseconds
+ end
+
def failed_request?
- (200...300).exclude?(request_status_code)
+ (200...300).exclude?(response_code)
+ end
+
+ def response_code
+ request.code.to_i
+ end
+
+ def success?
+ !unprocessable_uri? && !failed_request?
end
def unprocessable_uri?
@@ -20,19 +34,13 @@ module Spree
private
- attr_reader :body, :url, :webhooks_timeout
+ attr_reader :body, :execution_time_in_milliseconds, :url, :webhooks_timeout
HEADERS = { 'Content-Type' => 'application/json' }.freeze
private_constant :HEADERS
delegate :host, :path, :port, to: :uri, prefix: true
- def request_status_code
- http.request(request).code.to_i
- rescue Errno::ECONNREFUSED, Net::ReadTimeout, SocketError
- 0
- end
-
def http
http = Net::HTTP.new(uri_host, uri_port)
http.read_timeout = webhooks_timeout.to_i if custom_read_timeout?
@@ -43,7 +51,18 @@ module Spree
def request
req = Net::HTTP::Post.new(uri_path, HEADERS)
req.body = body
- req
+ @request ||= begin
+ start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+ request_result = http.request(req)
+ @execution_time_in_milliseconds = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time).in_milliseconds
+ request_result
+ end
+ rescue Errno::ECONNREFUSED, Net::ReadTimeout, SocketError
+ Class.new do
+ def self.code
+ '0'
+ end
+ end
end
def custom_read_timeout?
diff --git a/api/app/services/spree/webhooks/subscribers/queue_requests.rb b/api/app/services/spree/webhooks/subscribers/queue_requests.rb
index 5aaa94e180..fdd731b56c 100644
--- a/api/app/services/spree/webhooks/subscribers/queue_requests.rb
+++ b/api/app/services/spree/webhooks/subscribers/queue_requests.rb
@@ -5,8 +5,8 @@ module Spree
prepend Spree::ServiceModule::Base
def call(body:, event:)
- Spree::Webhooks::Subscriber.active.urls_for(event).each do |url|
- Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(body, event, url)
+ Spree::Webhooks::Subscriber.active.with_urls_for(event).each do |subscriber|
+ Spree::Webhooks::Subscribers::MakeRequestJob.perform_later(body, event, subscriber)
end
end
end
diff --git a/api/db/migrate/20211025162826_create_spree_webhooks_events.rb b/api/db/migrate/20211025162826_create_spree_webhooks_events.rb
new file mode 100644
index 0000000000..da5c6e4411
--- /dev/null
+++ b/api/db/migrate/20211025162826_create_spree_webhooks_events.rb
@@ -0,0 +1,13 @@
+class CreateSpreeWebhooksEvents < ActiveRecord::Migration[5.2]
+ def change
+ create_table :spree_webhooks_events do |t|
+ t.integer "execution_time"
+ t.string "name", null: false
+ t.string "request_errors"
+ t.string "response_code", index: true
+ t.belongs_to "subscriber", null: false
+ t.boolean "success", index: true
+ t.string "url", null: false
+ end
+ end
+end
diff --git a/api/spec/factories/spree/webhooks/event_factory.rb b/api/spec/factories/spree/webhooks/event_factory.rb
new file mode 100644
index 0000000000..3c1434e90f
--- /dev/null
+++ b/api/spec/factories/spree/webhooks/event_factory.rb
@@ -0,0 +1,15 @@
+FactoryBot.define do
+ factory :webhook_event, aliases: [:event], class: Spree::Webhooks::Event do
+ subscriber
+
+ execution_time { rand(1..99_999) }
+ name { 'order.canceled' }
+ request_errors { '' }
+ sequence(:url) { |n| "https://www.url#{n}.com/" }
+
+ trait :successful do
+ response_code { '200' }
+ success { true }
+ end
+ end
+end
diff --git a/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb b/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb
index e66f2dc0ca..ae3def774d 100644
--- a/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb
+++ b/api/spec/jobs/spree/webhooks/endpoints/make_request_job_spec.rb
@@ -4,9 +4,14 @@ describe Spree::Webhooks::Subscribers::MakeRequestJob do
let(:body) { {} }
let(:event) { 'order.cancel' }
let(:queue) { 'spree_webhooks' }
- let(:url) { 'http://url.com/' }
+ let(:subscriber) { create(:subscriber, :active) }
it 'enqueues a HTTP request using Spree::Webhooks::Subscribers::HandleRequest', :job do
- expect { described_class.perform_later(body, event, url) }.to have_enqueued_job.on_queue(queue)
+ expect { described_class.perform_later(body, event, subscriber, 1) }.to have_enqueued_job.on_queue(queue)
+ end
+
+ it 'does not raise if used with the expected arguments', :job do
+ allow(Spree::Webhooks::Subscribers::HandleRequest).to receive_message_chain(:new, :call)
+ expect { described_class.perform_now(body, event, subscriber) }.not_to raise_error
end
end
diff --git a/api/spec/models/spree/webhooks/event_spec.rb b/api/spec/models/spree/webhooks/event_spec.rb
new file mode 100644
index 0000000000..a620afb48a
--- /dev/null
+++ b/api/spec/models/spree/webhooks/event_spec.rb
@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Spree::Webhooks::Event do
+ describe 'validations' do
+ context 'name' do
+ it 'is invalid with a blank name' do
+ event = build(:event, :successful, name: '')
+ expect(event.valid?).to be(false)
+ expect(event.errors.messages).to eq(name: ["can't be blank"])
+ end
+
+ it 'is valid with a non-blank name' do
+ event = build(:event, :successful, name: 'order.canceled')
+ expect(event.valid?).to be(true)
+ end
+ end
+
+ context 'susbcriber' do
+ it 'is invalid without a subscriber' do
+ event = build(:event, :successful, subscriber_id: nil)
+ expect(event.valid?).to be(false)
+ expect(event.errors.messages).to eq(subscriber: ["can't be blank", 'must exist'])
+ end
+
+ it 'is valid with a subscriber' do
+ event = build(:event, :successful, subscriber: create(:subscriber))
+ expect(event.valid?).to be(true)
+ 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 995545f895..3f234abbc6 100644
--- a/api/spec/models/spree/webhooks/subscriber_spec.rb
+++ b/api/spec/models/spree/webhooks/subscriber_spec.rb
@@ -23,8 +23,8 @@ describe Spree::Webhooks::Subscriber do
end
end
- describe '.urls_for' do
- subject { described_class.urls_for(event) }
+ describe '.with_urls_for' do
+ subject { described_class.with_urls_for(event) }
let(:event) { 'order.placed' }
let(:subscriptions) { ['order.placed'] }
@@ -32,13 +32,19 @@ describe Spree::Webhooks::Subscriber do
let(:url) { 'https://url1.com/' }
context 'with subscriptions for the given event' do
- it { expect(subject).to eq([url]) }
+ it { expect(subject).to eq([subscriber]) }
end
context 'without subscriptions for the given event, but "*"' do
let(:subscriptions) { ['*'] }
- it { expect(subject).to eq([url]) }
+ it { expect(subject).to eq([subscriber]) }
+ end
+
+ context 'without subscriptions for the given event' do
+ let(:subscriptions) { ['order.updated'] }
+
+ it { expect(subject).to be_empty }
end
end
end
diff --git a/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb b/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
index 18d30ab422..4d55e302c3 100644
--- a/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
@@ -2,84 +2,88 @@ require 'spec_helper'
describe Spree::Webhooks::Subscribers::HandleRequest do
describe '#call' do
- subject { described_class.new(body: body, event: event, url: url) }
+ subject { described_class.new(body: body, event: event, subscriber: subscriber) }
- let(:body) { { foo: :bar }.to_json }
- let(:event) { 'order.cancel' }
+ let(:body) { { data: {} }.to_json }
+ let(:event) { 'order.canceled' }
let(:headers) { { 'Content-Type' => 'application/json' } }
let(:request_double) { instance_double(Spree::Webhooks::Subscribers::MakeRequest) }
+ let(:subscriber) { create(:subscriber, url: url) }
+ let(:subscriber_id) { subscriber.id }
let(:url) { 'http://google.com/' }
- context 'with an unexpected body' do
- let(:body) { '' }
-
- it 'does not instantiate a new request' do
- expect(Spree::Webhooks::Subscribers::MakeRequest).not_to receive(:new)
- subject.call
- end
-
- it { expect(subject.call).to eq(nil) }
- end
-
- context 'with an unprocessable uri' do
- let(:url) { '' }
-
+ shared_examples 'logging and creating a webhooks event' do |with_log_level:|
before do
allow(subject).to receive(:request).and_return(request_double)
- allow(request_double).to receive(:unprocessable_uri?).and_return(true)
+ allow(request_double).to(
+ receive_messages(
+ execution_time: execution_time,
+ failed_request?: failed_request,
+ response_code: response_code,
+ success?: success,
+ unprocessable_uri?: unprocessable_uri
+ )
+ )
end
- it 'debug logs before the request' do
- allow(Rails.logger).to receive(:warn)
+ it "#{with_log_level} logs before the request" do
+ allow(Rails.logger).to receive(with_log_level)
subject.call
- message = "[SPREE WEBHOOKS] 'order.cancel' can not make a request to ''"
- expect(Rails.logger).to have_received(:warn).with(message)
+ expect(Rails.logger).to have_received(with_log_level).with(log_msg)
+ end
+
+ it 'creates a webhooks event with the process info' do
+ expect { subject.call }.to change {
+ Spree::Webhooks::Event.all.as_json(except: %i[created_at id preferences updated_at]).map(&:values)
+ }.from([]).to([[execution_time, event, log_msg, response_code.to_s, subscriber_id, success, url]])
end
it { expect(subject.call).to eq(nil) }
end
+ context 'with an unprocessable uri' do
+ let(:execution_time) { 0 }
+ let(:failed_request) { true }
+ let(:log_msg) { "[SPREE WEBHOOKS] 'order.canceled' can not make a request to 'http://google.com/'" }
+ let(:response_code) { 0 }
+ let(:success) { false }
+ let(:unprocessable_uri) { true }
+
+ it_behaves_like 'logging and creating a webhooks event', with_log_level: :warn
+ end
+
context 'with a processable uri' do
+ let(:unprocessable_uri) { false }
+
before { stub_request(:post, url) }
it 'debug logs before the request' do
allow(Rails.logger).to receive(:debug)
subject.call
- message_fst = "[SPREE WEBHOOKS] 'order.cancel' sending to 'http://google.com/'"
- message_snd = "[SPREE WEBHOOKS] 'order.cancel' body: #{body}"
+ message_fst = "[SPREE WEBHOOKS] 'order.canceled' sending to 'http://google.com/'"
+ message_snd = "[SPREE WEBHOOKS] 'order.canceled' body: #{body}"
expect(Rails.logger).to have_received(:debug).with(message_fst)
expect(Rails.logger).to have_received(:debug).with(message_snd)
end
context 'with a failed request' do
- before do
- allow(subject).to receive(:request).and_return(request_double)
- allow(request_double).to receive(:unprocessable_uri?).and_return(false)
- allow(request_double).to receive(:failed_request?).and_return(true)
- end
+ let(:execution_time) { 0 }
+ let(:failed_request) { true }
+ let(:log_msg) { "[SPREE WEBHOOKS] 'order.canceled' failed for 'http://google.com/'" }
+ let(:response_code) { 0 }
+ let(:success) { false }
- it 'warn logs after the request' do
- allow(Rails.logger).to receive(:warn)
- subject.call
- message = "[SPREE WEBHOOKS] 'order.cancel' failed for 'http://google.com/'"
- expect(Rails.logger).to have_received(:warn).with(message)
- end
-
- it { expect(subject.call).to eq(nil) }
+ it_behaves_like 'logging and creating a webhooks event', with_log_level: :warn
end
context 'without a failed request' do
- let(:message) { "[SPREE WEBHOOKS] 'order.cancel' success for URL 'http://google.com/'" }
-
- it 'debug logs after the request' do
- allow(Rails.logger).to receive(:debug)
- subject.call
- expect(Rails.logger).to have_received(:debug).with(message)
- end
+ let(:execution_time) { rand(1..999999) }
+ let(:failed_request) { false }
+ let(:log_msg) { "[SPREE WEBHOOKS] 'order.canceled' success for URL 'http://google.com/'" }
+ let(:response_code) { 200 }
+ let(:success) { true }
- it 'returns the debug logger' do
- expect(subject.call).to eq(Rails.logger.debug(message))
- end
+ it_behaves_like 'logging and creating a webhooks event', with_log_level: :debug
end
end
end
diff --git a/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb b/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
index 2682fad1ed..e93af7ec5e 100644
--- a/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
@@ -2,7 +2,38 @@ require 'spec_helper'
describe Spree::Webhooks::Subscribers::MakeRequest do
let(:body) { { data: [{}] }.to_json }
- let(:url) { 'google.com' }
+ let(:http_double) { instance_double(Net::HTTP) }
+ let(:url) { 'http://google.com/' }
+
+ describe '#execution_time' do
+ subject { described_class.new(body: body, url: url).execution_time }
+
+ before do
+ stub_request(:post, url)
+ allow(Process).to receive(:clock_gettime).and_call_original
+ allow(Process).to receive(:clock_gettime).with(Process::CLOCK_MONOTONIC).and_return(start_time, end_time)
+ end
+
+ let(:end_time) { start_time + rand_variation } # add a custom rand amount to simulate elapsed time
+ let(:execution_time_in_seconds) { ((end_time - start_time) * 1000).to_i }
+ let(:rand_variation) { rand(1..10) }
+ let(:start_time) { Process.clock_gettime(Process::CLOCK_MONOTONIC) }
+
+ it 'returns the POSIX time it took for the request to be finished' do
+ expect(subject).to eq(execution_time_in_seconds)
+ end
+
+ context 'when request raises an exception' do
+ before do
+ allow(Net::HTTP).to receive(:new).and_return(http_double)
+ allow(http_double).to receive(:request) { raise Errno::ECONNREFUSED }
+ end
+
+ it 'returns the @execution_time_in_seconds default value' do
+ expect(subject).to eq(0)
+ end
+ end
+ end
describe '#failed_request?' do
subject { described_class.new(body: body, url: url).failed_request? }
@@ -11,9 +42,7 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
let(:headers) { { 'Content-Type' => 'application/json' } }
let(:http) { Net::HTTP.new(uri.host, uri.port) }
- let(:http_double) { instance_double(Net::HTTP) }
let(:uri) { URI(url) }
- let(:url) { 'http://google.com/' }
describe 'ssl usage' do
shared_examples 'makes the request without setting use_ssl' do
@@ -123,6 +152,71 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
end
end
+ describe '#response_code' do
+ subject { described_class.new(body: body, url: url).response_code }
+
+ context 'when request raises an Errno::ECONNREFUSED exception' do
+ before do
+ allow(Net::HTTP).to receive(:new).and_return(http_double)
+ allow(http_double).to receive(:request) { raise Errno::ECONNREFUSED }
+ end
+
+ it { expect(subject).to eq(0) }
+ end
+
+ context 'when request raises a Net::ReadTimeout exception' do
+ before do
+ allow(Net::HTTP).to receive(:new).and_return(http_double)
+ allow(http_double).to receive(:request) { raise Net::ReadTimeout }
+ end
+
+ it { expect(subject).to eq(0) }
+ end
+
+ context 'when request raises a SocketError exception' do
+ before do
+ allow(Net::HTTP).to receive(:new).and_return(http_double)
+ allow(http_double).to receive(:request) { raise SocketError }
+ end
+
+ it { expect(subject).to eq(0) }
+ end
+
+ context 'when request succeeds' do
+ before { stub_request(:post, url) }
+
+ it { expect(subject).to eq(200) }
+ end
+ end
+
+ describe '#success?' do
+ subject { described_class.new(body: body, url: url) }
+
+ context 'when unprocessable_uri? equals true' do
+ before { allow(subject).to receive(:unprocessable_uri?).and_return(true) }
+
+ it { expect(subject.success?).to eq(false) }
+ end
+
+ context 'when failed_request? equals true' do
+ before do
+ allow(subject).to receive(:unprocessable_uri?).and_return(false)
+ allow(subject).to receive(:failed_request?).and_return(true)
+ end
+
+ it { expect(subject.success?).to eq(false) }
+ end
+
+ context 'when failed_request? equals false' do
+ before do
+ allow(subject).to receive(:unprocessable_uri?).and_return(false)
+ allow(subject).to receive(:failed_request?).and_return(false)
+ end
+
+ it { expect(subject.success?).to eq(true) }
+ end
+ end
+
describe '#unprocessable_uri?' do
subject { described_class.new(body: body, url: url) }
@@ -133,6 +227,7 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
end
let(:uri) { URI(url) }
+ let(:url) { 'google.com' }
context 'uri with path ""' do
before { uri.path = '' }
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 f2312e5201..5b36e2271a 100644
--- a/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/queue_requests_spec.rb
@@ -9,39 +9,39 @@ describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
let(:queue) { 'spree_webhooks' }
let(:make_request_job) { Spree::Webhooks::Subscribers::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(make_request_job).on_queue(queue)
+ shared_examples 'queues a job to make a request' do |url|
+ before { stub_request(:post, subscriber.url) }
+
+ let(:subscriber) { create(:subscriber, :active, url: url, subscriptions: subscriptions) }
+
+ it do
+ expect { subject }.to(
+ have_enqueued_job(make_request_job).with(body, event, subscriber).on_queue(queue)
+ )
end
end
+ shared_examples 'does not queue a job to make a request' do
+ it { expect { subject }.not_to have_enqueued_job(make_request_job).on_queue(queue) }
+ end
+
+ context 'without subscriptions for the given event' do
+ before { Spree::Webhooks::Subscriber.delete_all }
+
+ include_examples 'does not queue a job to make a request'
+ end
+
context 'with subscriptions for the given event' do
context 'when subscriber subscriptions includes all events (*)' do
- before { stub_request(:post, subscriber.url) }
+ let(:subscriptions) { ['*'] }
- let(:subscriber) do
- create(:subscriber, :active, url: 'https://url1.com/', subscriptions: ['*'])
- end
-
- it 'queues a job to make a request' do
- expect { subject }.to(
- have_enqueued_job(make_request_job).with(body, event, subscriber.url).on_queue(queue)
- )
- end
+ include_examples 'queues a job to make a request', 'https://url1.com/'
end
context 'when subscriber subscriptions includes the specific event being used' do
- before { stub_request(:post, subscriber.url) }
-
- let(:subscriber) do
- create(:subscriber, :active, url: 'https://url2.com/', subscriptions: [event])
- end
+ let(:subscriptions) { [event] }
- it 'queues a job to make a request' do
- expect { subject }.to(
- have_enqueued_job(make_request_job).with(body, event, subscriber.url).on_queue(queue)
- )
- end
+ include_examples 'queues a job to make a request', 'https://url2.com/'
end
context 'when subscriber subscriptions are not active' do
@@ -49,9 +49,7 @@ describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
create(:subscriber, url: 'https://url3.com/', subscriptions: [event])
end
- it 'does not queue a job to make a request' do
- expect { subject }.not_to have_enqueued_job(make_request_job).on_queue(queue)
- end
+ include_examples 'does not queue a job to make a request'
end
context 'when subscriber subscriptions do not include the event or "*"' do
@@ -59,9 +57,7 @@ describe Spree::Webhooks::Subscribers::QueueRequests, :job, :spree_webhooks do
create(:subscriber, :active, url: 'https://url4.com/', subscriptions: ['order.resumed'])
end
- it 'does not queue a job to make a request' do
- expect { subject }.not_to have_enqueued_job(make_request_job).on_queue(queue)
- end
+ include_examples 'does not queue a job to make a request'
end
end
end