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 the event's signature to the request

Stefan Vermaasbd341efb3605
diff --git a/api/app/services/spree/webhooks/subscribers/make_request.rb b/api/app/services/spree/webhooks/subscribers/make_request.rb
index eb673bdeb9..db716d87f3 100644
--- a/api/app/services/spree/webhooks/subscribers/make_request.rb
+++ b/api/app/services/spree/webhooks/subscribers/make_request.rb
@@ -4,8 +4,9 @@ module Spree
module Webhooks
module Subscribers
class MakeRequest
- def initialize(url:, webhook_payload_body:)
+ def initialize(signature:, url:, webhook_payload_body:)
@execution_time_in_milliseconds = 0
+ @signature = signature
@url = url
@webhook_payload_body = webhook_payload_body
@webhooks_timeout = ENV['SPREE_WEBHOOKS_TIMEOUT']
@@ -49,7 +50,7 @@ module Spree
end
def request
- req = Net::HTTP::Post.new(uri_path, HEADERS)
+ req = Net::HTTP::Post.new(uri_path, HEADERS.merge('X-Spree-Hmac-SHA256' => @signature))
req.body = webhook_payload_body
@request ||= begin
start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
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 e761ea995b..f72b41f34c 100644
--- a/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
+++ b/api/spec/services/spree/webhooks/subscribers/make_request_spec.rb
@@ -4,9 +4,10 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
let(:http_double) { instance_double(Net::HTTP) }
let(:url) { 'http://google.com/' }
let(:webhook_payload_body) { { data: [{}] }.to_json }
+ let(:signature) { 'some-signature-of-data' }
describe '#execution_time' do
- subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url).execution_time }
+ subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url, signature: signature).execution_time }
before do
stub_request(:post, url)
@@ -36,7 +37,7 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
end
describe '#failed_request?' do
- subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url).failed_request? }
+ subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url, signature: signature).failed_request? }
before { stub_request(:post, url) }
@@ -152,8 +153,34 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
end
end
+ describe 'HTTP request headers' do
+ subject do
+ described_class.new(
+ signature: signature,
+ url: url,
+ webhook_payload_body: webhook_payload_body
+ )
+ end
+
+ before do
+ stub_request(:post, url)
+ end
+
+ it 'marks the HTTP request as a JSON request' do
+ expect(subject.send(:request)).to \
+ have_requested(:post, url).
+ with(headers: { 'Content-Type' => 'application/json' })
+ end
+
+ it "includes the event's signature in the HTTP headers" do
+ expect(subject.send(:request)).to \
+ have_requested(:post, url).
+ with(headers: { 'X-Spree-Hmac-SHA256' => signature })
+ end
+ end
+
describe '#response_code' do
- subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url).response_code }
+ subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url, signature: signature).response_code }
context 'when request raises an Errno::ECONNREFUSED exception' do
before do
@@ -190,7 +217,7 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
end
describe '#success?' do
- subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url) }
+ subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url, signature: signature) }
context 'when unprocessable_uri? equals true' do
before { allow(subject).to receive(:unprocessable_uri?).and_return(true) }
@@ -218,7 +245,7 @@ describe Spree::Webhooks::Subscribers::MakeRequest do
end
describe '#unprocessable_uri?' do
- subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url) }
+ subject { described_class.new(webhook_payload_body: webhook_payload_body, url: url, signature: signature) }
before { allow(subject).to receive(:URI).with(url).and_return(uri) }