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.

Raise exception when event can not be created. (#11536)

sebe8bddb906df7
diff --git a/api/app/services/spree/webhooks/subscribers/handle_request.rb b/api/app/services/spree/webhooks/subscribers/handle_request.rb
index 9d5dec2c50..d3063c75da 100644
--- a/api/app/services/spree/webhooks/subscribers/handle_request.rb
+++ b/api/app/services/spree/webhooks/subscribers/handle_request.rb
@@ -12,10 +12,12 @@ module Spree
def call
Rails.logger.debug(msg("sending to '#{url}'"))
- Rails.logger.debug(msg("body: #{body}"))
+ Rails.logger.debug(msg("body: #{body_with_event_metadata}"))
- return process(:warn, msg("can not make a request to '#{url}'")) if unprocessable_uri?
- return process(:warn, msg("failed for '#{url}'")) if failed_request?
+ if request.unprocessable_uri?
+ return process(:warn, msg("can not make a request to '#{url}'"))
+ end
+ return process(:warn, msg("failed for '#{url}'")) if request.failed_request?
process(:debug, msg("success for URL '#{url}'"))
end
@@ -24,40 +26,40 @@ module Spree
attr_reader :body, :event_name, :subscriber
- delegate :execution_time, :failed_request?, :response_code, :success?, :unprocessable_uri?, to: :request
- delegate :id, :url, to: :subscriber
- delegate :created_at, :id, to: :event, prefix: true
+ delegate :url, to: :subscriber
def process(log_level, msg)
Rails.logger.public_send(log_level, msg)
+ make_request
update_event(msg)
nil
end
- def update_event(msg)
- Spree::Webhooks::Event.
- find(event_id).
- update(
- execution_time: execution_time,
- request_errors: msg,
- response_code: response_code,
- success: success?
- )
- end
-
def request
@request ||=
Spree::Webhooks::Subscribers::MakeRequest.new(body: body_with_event_metadata, url: url)
end
+ alias make_request request
def body_with_event_metadata
body.
- merge(event_created_at: event_created_at, event_id: event_id, event_type: event.name).
+ merge(event_created_at: event.created_at, event_id: event.id, event_type: event.name).
to_json
end
def event
- @event ||= Spree::Webhooks::Event.create(name: event_name, subscriber_id: id, url: url)
+ @event ||= Spree::Webhooks::Event.create!(
+ name: event_name, subscriber_id: subscriber.id, url: url
+ )
+ end
+
+ def update_event(msg)
+ event.update(
+ execution_time: request.execution_time,
+ request_errors: msg,
+ response_code: request.response_code,
+ success: request.success?
+ )
end
def msg(msg)
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 9797bff39b..daef918a56 100644
--- a/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/handle_request_spec.rb
@@ -5,65 +5,80 @@ describe Spree::Webhooks::Subscribers::HandleRequest do
subject { described_class.new(body: body, event_name: event_name, subscriber: subscriber) }
let(:body) do
- Spree::Api::V2::Platform::AddressSerializer.new(resource).serializable_hash.merge(
- event_created_at: event.created_at,
- event_id: event.id,
- event_type: event.name
- ).to_json
+ Spree::Api::V2::Platform::AddressSerializer.new(resource).serializable_hash.to_json
end
let(:event_name) { 'order.canceled' }
- let(:event) { create(:event, :blank, name: event_name, subscriber_id: subscriber.id, url: url) }
+ let(:event) { Spree::Webhooks::Event.find_by(name: event_name, subscriber_id: subscriber.id, url: url) }
let(:make_request_double) { instance_double(Spree::Webhooks::Subscribers::MakeRequest) }
let(:subscriber) { create(:subscriber, :active, subscriptions: [event_name], url: url) }
let(:url) { 'http://google.com/' }
let(:resource) { create(:address) }
shared_examples 'logging and creating a webhooks event' do |with_log_level:|
- before do
- expect(Spree::Webhooks::Event).to(
- receive(:create).
- with(name: event_name, subscriber_id: subscriber.id, url: url).
- and_return(event)
- )
+ before { stub_request(:post, url) }
+
+ context 'before making the request' do
+ let(:body_with_event_metadata) do
+ JSON.parse(body).merge(
+ event_created_at: event.created_at,
+ event_id: event.id,
+ event_type: event.name
+ ).to_json
+ end
+
+ it 'debug logs' do
+ allow(Rails.logger).to receive(:debug)
+ allow(Spree::Webhooks::Subscribers::MakeRequest).to receive(:new).and_call_original
+ subject.call
+ message_fst = "[SPREE WEBHOOKS] 'order.canceled' sending to 'http://google.com/'"
+ message_snd = "[SPREE WEBHOOKS] 'order.canceled' body: #{body_with_event_metadata}"
+ expect(Rails.logger).to have_received(:debug).with(message_fst)
+ expect(Rails.logger).to have_received(:debug).with(message_snd)
+ expect(Spree::Webhooks::Subscribers::MakeRequest).to(
+ have_received(:new).with(body: body_with_event_metadata, url: url)
+ )
+ end
+
+ it "#{with_log_level} logs" do
+ # in this case the content of body isn't necessary
+ expect(Spree::Webhooks::Subscribers::MakeRequest).to(
+ receive(:new).with(hash_including(url: url)).and_return(make_request_double)
+ )
+ expect(make_request_double).to(
+ receive_messages(
+ execution_time: execution_time,
+ response_code: response_code,
+ success?: success,
+ unprocessable_uri?: unprocessable_uri
+ )
+ )
+ allow(Rails.logger).to receive(with_log_level)
+ subject.call
+ expect(Rails.logger).to have_received(with_log_level).with(log_msg)
+ end
+ end
+
+ it 'updates the event record created previously with the missing data' do
expect(Spree::Webhooks::Subscribers::MakeRequest).to(
- receive(:new).with(body: body, url: url).and_return(make_request_double)
+ receive(:new).with(hash_including(url: url)).and_return(make_request_double)
)
- allow(make_request_double).to(
+ expect(make_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(:debug)
- subject.call
- message_fst = "[SPREE WEBHOOKS] 'order.canceled' sending to 'http://google.com/'"
- message_snd = "[SPREE WEBHOOKS] 'order.canceled' body: #{JSON.parse(body)}"
- expect(Rails.logger).to have_received(:debug).with(message_fst)
- expect(Rails.logger).to have_received(:debug).with(message_snd)
- end
-
- it "#{with_log_level} logs before the request" do
- allow(Rails.logger).to receive(with_log_level)
- subject.call
- expect(Rails.logger).to have_received(with_log_level).with(log_msg)
- end
-
- it 'updates the event record created previously with the missing data' do
expect { subject.call }.to change {
Spree::Webhooks::Event.
- find(event.id).
- as_json(except: %i[created_at id preferences updated_at]).
- values
+ all.
+ as_json(except: %i[id created_at id preferences updated_at]).
+ map(&:values)
}.from(
- [nil, event_name, nil, nil, subscriber.id, nil, url]
+ []
).to(
- [execution_time, event_name, log_msg, response_code.to_s, subscriber.id, success, url]
+ [[execution_time, event_name, log_msg, response_code.to_s, subscriber.id, success, url]]
)
end
@@ -72,7 +87,6 @@ describe Spree::Webhooks::Subscribers::HandleRequest do
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 }
@@ -84,7 +98,13 @@ describe Spree::Webhooks::Subscribers::HandleRequest do
context 'with a processable uri' do
let(:unprocessable_uri) { false }
- before { stub_request(:post, url) }
+ before do
+ allow(make_request_double).to(
+ receive_messages(
+ failed_request?: failed_request
+ )
+ )
+ end
context 'with a failed request' do
let(:execution_time) { 0 }
@@ -109,8 +129,7 @@ describe Spree::Webhooks::Subscribers::HandleRequest do
context 'full flow' do
let(:body) { Spree::Api::V2::Platform::OrderSerializer.new(order.reload).serializable_hash }
- let(:body_with_event_metadata) { body.merge(event_created_at: event.created_at, event_id: event.id, event_type: event.name).to_json }
- let(:event) { Spree::Webhooks::Event.find_by(name: event_name, subscriber_id: subscriber.id) }
+ let(:event) { Spree::Webhooks::Event.find_by(name: event_name, subscriber_id: subscriber.id, url: url) }
let(:event_name) { 'order.placed' }
let(:order) { create(:order, email: '[email protected]') }
@@ -131,11 +150,35 @@ describe Spree::Webhooks::Subscribers::HandleRequest do
end
end
- it 'adds the event data to the body after executing the job' do
+ context 'after executing the job' do
+ let(:body_with_event_metadata) do
+ body.merge(
+ event_created_at: event.created_at, event_id: event.id, event_type: event.name
+ ).to_json
+ end
+
+ it 'adds the event data to the body' do
+ with_webhooks_enabled do
+ allow(Spree::Webhooks::Subscribers::MakeRequest).to receive(:new).and_call_original
+ order.finalize!
+ expect(Spree::Webhooks::Subscribers::MakeRequest).to(
+ have_received(:new).with(body: body_with_event_metadata, url: url)
+ )
+ end
+ end
+ end
+ end
+
+ context 'when the event can not be created' do
+ it 'raises ActiveRecord::RecordInvalid' do
with_webhooks_enabled do
- allow(Spree::Webhooks::Subscribers::MakeRequest).to receive(:new).and_call_original
- order.finalize!
- expect(Spree::Webhooks::Subscribers::MakeRequest).to have_received(:new).with(body: body_with_event_metadata, url: url)
+ expect do
+ described_class.new(
+ body: body,
+ event_name: nil, # forces a validation error
+ subscriber: subscriber
+ ).call
+ end.to raise_error(ActiveRecord::RecordInvalid)
end
end
end