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.

Webhooks 2.0

Damian Legawiece2d09cf41530
diff --git a/admin/app/assets/tailwind/spree/admin/base/_theme.css b/admin/app/assets/tailwind/spree/admin/base/_theme.css
index 921787243c..af157bc3ec 100644
--- a/admin/app/assets/tailwind/spree/admin/base/_theme.css
+++ b/admin/app/assets/tailwind/spree/admin/base/_theme.css
@@ -9,7 +9,7 @@
/* Legacy Colors, kept for old HTML from extensions/developer apps work properly */
--color-primary: var(--color-zinc-950);
--color-success: var(--color-green-900);
- --color-danger: var(--color-red-900);
+ --color-danger: var(--color-red-600);
--color-warning: var(--color-yellow-900);
--color-info: var(--color-blue-900);
diff --git a/admin/app/assets/tailwind/spree/admin/components/_layout.css b/admin/app/assets/tailwind/spree/admin/components/_layout.css
index f74c2d5360..51a9a05b99 100644
--- a/admin/app/assets/tailwind/spree/admin/components/_layout.css
+++ b/admin/app/assets/tailwind/spree/admin/components/_layout.css
@@ -198,7 +198,7 @@
}
#main-sidebar .nav-link .ti {
- @apply mr-2 rounded-lg shrink-0 text-gray-400;
+ @apply mr-2 rounded-lg shrink-0 text-gray-400 transition-colors duration-200 ease-in-out;
padding: 0.2rem;
}
diff --git a/admin/app/controllers/spree/admin/webhook_deliveries_controller.rb b/admin/app/controllers/spree/admin/webhook_deliveries_controller.rb
new file mode 100644
index 0000000000..1963c24d75
--- /dev/null
+++ b/admin/app/controllers/spree/admin/webhook_deliveries_controller.rb
@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Spree
+ module Admin
+ class WebhookDeliveriesController < ResourceController
+ include Spree::Admin::SettingsConcern
+
+ helper 'spree/admin/webhook_endpoints'
+
+ belongs_to 'spree/webhook_endpoint'
+
+ def retry
+ if @webhook_delivery.webhook_endpoint.active?
+ Spree::WebhookDeliveryJob.perform_later(@webhook_delivery.id, @webhook_delivery.webhook_endpoint.secret_key)
+ flash[:success] = Spree.t('admin.webhook_deliveries.retry_queued')
+ else
+ flash[:error] = Spree.t('admin.webhook_deliveries.endpoint_inactive')
+ end
+ redirect_to spree.admin_webhook_endpoint_webhook_deliveries_path(@webhook_delivery.webhook_endpoint)
+ end
+
+ private
+
+ def collection_default_sort
+ 'created_at desc'
+ end
+ end
+ end
+end
diff --git a/admin/app/controllers/spree/admin/webhook_endpoints_controller.rb b/admin/app/controllers/spree/admin/webhook_endpoints_controller.rb
new file mode 100644
index 0000000000..ce82bc7d45
--- /dev/null
+++ b/admin/app/controllers/spree/admin/webhook_endpoints_controller.rb
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Spree
+ module Admin
+ class WebhookEndpointsController < ResourceController
+ include Spree::Admin::SettingsConcern
+
+ helper 'spree/admin/webhook_endpoints'
+
+ private
+
+ def permitted_resource_params
+ params.require(:webhook_endpoint).permit(permitted_webhook_endpoint_attributes)
+ end
+
+ def location_after_save
+ spree.admin_webhook_endpoint_path(@object)
+ end
+ end
+ end
+end
diff --git a/admin/app/helpers/spree/admin/base_helper.rb b/admin/app/helpers/spree/admin/base_helper.rb
index fc27a5bf52..b44f47a846 100644
--- a/admin/app/helpers/spree/admin/base_helper.rb
+++ b/admin/app/helpers/spree/admin/base_helper.rb
@@ -243,6 +243,7 @@ module Spree
# @return [String] the button
def clipboard_button(options = {})
options[:class] ||= 'btn btn-light btn-sm btn-clipboard'
+ options[:icon_class] ||= 'mr-0 text-sm'
options[:type] ||= 'button'
options[:data] ||= {}
options[:data][:action] = 'clipboard#copy'
@@ -251,7 +252,7 @@ module Spree
options[:aria_label] ||= Spree.t('admin.copy_to_clipboard') # screen-reader label
content_tag(:button, options) do
- icon('copy', class: 'mr-0 text-sm') + tooltip(Spree.t('admin.copy_to_clipboard'))
+ icon('copy', class: options[:icon_class]) + tooltip(Spree.t('admin.copy_to_clipboard'))
end
end
@@ -261,15 +262,17 @@ module Spree
# @option options [String] :class the CSS class(es) of the component
# @option options [Hash] :data the data attributes for the component
# @option options [String] :title the title of the component
+ # @option options [String] :button_class the CSS class(es) of the button
+ # @option options [String] :icon_class the CSS class(es) of the icon
# @return [String] the component
def clipboard_component(text, options = {})
options[:data] ||= {}
options[:data][:controller] = 'clipboard'
- options[:data][:clipboard_success_content_value] ||= raw(icon('check', class: 'mr-0 text-sm'))
+ options[:data][:clipboard_success_content_value] ||= raw(icon('check', class: options[:icon_class]))
- content_tag(:span, data: options[:data]) do
+ content_tag(:span, data: options[:data], class: options[:class]) do
hidden_field_tag(:clipboard_source, text, data: { clipboard_target: 'source' }) +
- clipboard_button
+ clipboard_button(class: options[:button_class], icon_class: options[:icon_class])
end
end
diff --git a/admin/app/helpers/spree/admin/navigation_helper.rb b/admin/app/helpers/spree/admin/navigation_helper.rb
index 15128d57b8..616d64d1cd 100644
--- a/admin/app/helpers/spree/admin/navigation_helper.rb
+++ b/admin/app/helpers/spree/admin/navigation_helper.rb
@@ -42,7 +42,7 @@ module Spree
selected_option = (params[:per_page].try(:to_i) || per_page_default).to_i
selected_option_label = selected_option.to_s + icon('chevron-down', class: 'ml-1 mr-0 arrow')
- dropdown(id: 'per-page-dropdown') do
+ dropdown(id: 'per-page-dropdown', portal: false) do
dropdown_toggle(class: 'btn-light btn-sm') do
raw(selected_option_label)
end +
diff --git a/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb b/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb
new file mode 100644
index 0000000000..296f333a08
--- /dev/null
+++ b/admin/app/helpers/spree/admin/webhook_endpoints_helper.rb
@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Spree
+ module Admin
+ module WebhookEndpointsHelper
+ def available_webhook_events
+ @available_webhook_events ||= begin
+ events = []
+
+ # Add lifecycle events from eventable models
+ Spree.eventable_models.each do |model_class|
+ base_name = model_class.name.demodulize.underscore
+ events << "#{base_name}.created"
+ events << "#{base_name}.updated"
+ events << "#{base_name}.deleted"
+ end
+
+ # Add custom events
+ events += custom_webhook_events
+
+ events.sort.uniq
+ end
+ end
+
+ def webhook_delivery_status_badge(delivery)
+ if delivery.pending?
+ content_tag(:span, Spree.t(:pending), class: 'badge badge-light')
+ elsif delivery.successful?
+ content_tag(:span, Spree.t(:success), class: 'badge badge-success')
+ else
+ content_tag(:span, Spree.t('state_machine_states.failed'), class: 'badge badge-danger')
+ end
+ end
+
+ def webhook_endpoint_success_percentage(webhook_endpoint)
+ return '' if webhook_endpoint.webhook_deliveries.none?
+
+ (webhook_endpoint.webhook_deliveries.successful.count / webhook_endpoint.webhook_deliveries.count.to_f * 100).round(2)
+ end
+
+ private
+
+ def custom_webhook_events
+ %w[
+ order.completed
+ order.paid
+ order.canceled
+ order.resumed
+ order.shipped
+ payment.paid
+ payment.voided
+ shipment.shipped
+ product.activated
+ product.archived
+ product.drafted
+ product.back_in_stock
+ product.out_of_stock
+ ]
+ end
+ end
+ end
+end
diff --git a/admin/app/views/spree/admin/webhook_deliveries/_table_header.html.erb b/admin/app/views/spree/admin/webhook_deliveries/_table_header.html.erb
new file mode 100644
index 0000000000..695a701aaf
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_deliveries/_table_header.html.erb
@@ -0,0 +1,8 @@
+<tr>
+ <th scope="col"><%= sort_link(@search, :event_name, Spree.t('admin.webhook_deliveries.event')) %></th>
+ <th scope="col"><%= sort_link(@search, :success, Spree.t(:status)) %></th>
+ <th scope="col"><%= sort_link(@search, :delivered_at, Spree.t('admin.webhook_deliveries.delivered_at')) %></th>
+ <th scope="col"><%= sort_link(@search, :execution_time, Spree.t('admin.webhook_deliveries.execution_time')) %></th>
+ <th scope="col"><%= sort_link(@search, :response_code, Spree.t('admin.webhook_deliveries.response_code')) %></th>
+ <th scope="col"><%= Spree.t(:details) %></th>
+</tr>
diff --git a/admin/app/views/spree/admin/webhook_deliveries/_table_row.html.erb b/admin/app/views/spree/admin/webhook_deliveries/_table_row.html.erb
new file mode 100644
index 0000000000..5cad47bcd3
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_deliveries/_table_row.html.erb
@@ -0,0 +1,22 @@
+<tr id="<%= spree_dom_id webhook_delivery %>">
+ <td class="w-40">
+ <code><%= webhook_delivery.event_name %></code>
+ </td>
+ <td class="text-center w-10">
+ <%= webhook_delivery_status_badge(webhook_delivery) %>
+ </td>
+ <td class="w-20">
+ <%= spree_time(webhook_delivery.delivered_at) %>
+ </td>
+ <td class="w-20">
+ <%= webhook_delivery.execution_time ? "#{webhook_delivery.execution_time}ms" : '-' %>
+ </td>
+ <td class="w-20">
+ <code><%= webhook_delivery.response_code || '-' %></code>
+ </td>
+ <td class="w-20">
+ <%= link_to icon('eye'), spree.admin_webhook_endpoint_webhook_delivery_path(webhook_delivery.webhook_endpoint, webhook_delivery),
+ class: 'btn btn-sm btn-light px-2',
+ data: { action: 'drawer#open', turbo_frame: :drawer } %>
+ </td>
+</tr>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/webhook_deliveries/index.html.erb b/admin/app/views/spree/admin/webhook_deliveries/index.html.erb
new file mode 100644
index 0000000000..6800adbe2c
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_deliveries/index.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/index_table', new_object_url: nil %>
diff --git a/admin/app/views/spree/admin/webhook_deliveries/show.html.erb b/admin/app/views/spree/admin/webhook_deliveries/show.html.erb
new file mode 100644
index 0000000000..75fa6a6e65
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_deliveries/show.html.erb
@@ -0,0 +1,32 @@
+<%= turbo_frame_tag :drawer do %>
+ <%= drawer_header(Spree.t(:details)) %>
+ <div class="drawer-body flex flex-col gap-6" data-controller="highlight">
+
+ <ul class="list-group">
+ <li class="list-group-item flex justify-between items-center">
+ <span class="text-gray-600"><%= Spree.t(:event) %></span>
+ <span><code><%= @webhook_delivery.event_name %></code></span>
+ </li>
+ <li class="list-group-item flex justify-between items-center">
+ <span class="text-gray-600"><%= Spree.t(:url) %></span>
+ <span><%= external_link_to(@webhook_delivery.url, @webhook_delivery.url) %></span>
+ </li>
+ <% if @webhook_delivery.delivered_at.present? %>
+ <li class="list-group-item flex justify-between items-center">
+ <span class="text-gray-600"><%= Spree.t('admin.webhook_deliveries.delivered_at') %></span>
+
+ <span><%= l(@webhook_delivery.delivered_at, format: :long) %></span>
+ </li>
+ <% end %>
+ </ul>
+
+ <h5 class="text-lg font-bold"><%= Spree.t('admin.webhook_deliveries.request_payload') %></h5>
+ <pre class="m-0"><code data-highlight-target="code" class="language-json block overflow-auto rounded-lg"><%= JSON.pretty_generate(@webhook_delivery.payload) rescue @webhook_delivery.payload.to_s %></code></pre>
+
+ <% if @webhook_delivery.response_body.present? %>
+ <h5 class="text-lg font-bold"><%= Spree.t('admin.webhook_deliveries.response_body') %></h5>
+ <pre class="m-0"><code data-highlight-target="code" class="language-json block overflow-auto rounded-lg"><%= @webhook_delivery.response_body.truncate(2000) %></code></pre>
+ <% end %>
+
+ </div>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/webhook_endpoints/_details.html.erb b/admin/app/views/spree/admin/webhook_endpoints/_details.html.erb
new file mode 100644
index 0000000000..936c33464c
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/_details.html.erb
@@ -0,0 +1,40 @@
+<div class="card mb-6">
+ <div class="card-header flex justify-between">
+ <h5 class="card-title">
+ <%= Spree.t(:details) %>
+ </h5>
+ <%= link_to_with_icon 'edit', Spree.t(:edit), spree.edit_admin_webhook_endpoint_path(@webhook_endpoint), icon: 'pencil', class: 'btn btn-sm btn-light' %>
+ </div>
+ <div class="card-body p-0">
+ <ul class="list-group list-group-flush">
+ <li class="list-group-item flex justify-between items-top gap-10">
+ <span class="text-gray-600">
+ <%= Spree.t('admin.webhook_endpoints.event_subscriptions') %>
+ </span>
+ <span class="flex gap-2 flex-wrap justify-end">
+ <% @webhook_endpoint.subscriptions.each do |subscription| %>
+ <span class="badge badge-light"><%= subscription %></span>
+ <% end %>
+ </span>
+ </li>
+
+ <li class="list-group-item flex justify-between items-center">
+ <span class="text-gray-600">
+ <%= Spree.t(:created_at) %>
+ </span>
+ <span>
+ <%= spree_time(@webhook_endpoint.created_at, format: :long) %>
+ </span>
+ </li>
+
+ <li class="list-group-item flex justify-between items-center">
+ <span class="text-gray-600">
+ <%= Spree.t(:updated_at) %>
+ </span>
+ <span>
+ <%= spree_time(@webhook_endpoint.updated_at, format: :long) %>
+ </span>
+ </li>
+ </ul>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/webhook_endpoints/_form.html.erb b/admin/app/views/spree/admin/webhook_endpoints/_form.html.erb
new file mode 100644
index 0000000000..9f32789a72
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/_form.html.erb
@@ -0,0 +1,28 @@
+<div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title"><%= Spree.t('admin.webhook_endpoints.endpoint_settings') %></h5>
+ </div>
+ <div class="card-body">
+ <%= f.spree_text_field :url, required: true, autofocus: f.object.new_record?, placeholder: 'https://example.com/webhooks', disabled: f.object.persisted? %>
+ <%= f.spree_check_box :active %>
+ </div>
+</div>
+
+<div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title"><%= Spree.t('admin.webhook_endpoints.event_subscriptions') %></h5>
+ </div>
+ <div class="card-body">
+ <p class="text-gray-600 mb-3"><%= Spree.t('admin.webhook_endpoints.event_subscriptions_help') %></p>
+ <div class="grid lg:grid-cols-2 gap-4">
+ <% available_webhook_events.each do |event| %>
+ <div class="form-checkbox">
+ <%= check_box_tag 'webhook_endpoint[subscriptions][]', event, @webhook_endpoint.subscriptions&.include?(event), id: "subscription_#{event.parameterize}", class: 'custom-control-input' %>
+ <label class="custom-control-label" for="subscription_<%= event.parameterize %>">
+ <code><%= event %></code>
+ </label>
+ </div>
+ <% end %>
+ </div>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/webhook_endpoints/_secret_key.html.erb b/admin/app/views/spree/admin/webhook_endpoints/_secret_key.html.erb
new file mode 100644
index 0000000000..97f2fb93a7
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/_secret_key.html.erb
@@ -0,0 +1,23 @@
+<div class="card mb-6">
+ <div class="card-header flex justify-between">
+ <h5 class="card-title">
+ <%= Spree.t('admin.webhook_endpoints.secret_key') %>
+ </h5>
+ </div>
+ <div class="card-body">
+ <p class="text-gray-600 mb-3"><%= Spree.t('admin.webhook_endpoints.secret_key_help') %></p>
+ <div data-controller="password-visibility" class="input-group gap-0 pr-1">
+ <input type="password" class="grow text-truncate" data-password-visibility-target="input" spellcheck="false" value="<%= @webhook_endpoint.secret_key %>" readonly>
+
+ <button type="button" class="btn hover:bg-gray-100 p-1 mr-1 rounded" data-action="password-visibility#toggle">
+ <span data-password-visibility-target="icon"><%= icon 'eye', class: 'mr-0' %></span>
+ <span data-password-visibility-target="icon" class="hidden"><%= icon 'eye-off', class: 'mr-0' %></span>
+ </button>
+
+ <%= clipboard_component(@webhook_endpoint.secret_key,
+ button_class: 'btn hover:bg-gray-100 p-1 rounded',
+ icon_class: 'mr-0') %>
+ </div>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/webhook_endpoints/_summary.html.erb b/admin/app/views/spree/admin/webhook_endpoints/_summary.html.erb
new file mode 100644
index 0000000000..5bfd8e5055
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/_summary.html.erb
@@ -0,0 +1,26 @@
+<div class="card mb-6">
+ <div class="card-body">
+ <div class="grid grid-cols-2 lg:grid-cols-3 gap-6">
+ <div class="flex flex-col mb-6 lg:mb-0 border-r gap-2">
+ <span class="text-sm text-gray-500"><%= Spree.t('admin.webhook_endpoints.deliveries') %></span>
+ <span class="text-lg text-gray-900 font-bold">
+ <%= @webhook_endpoint.webhook_deliveries.count %>
+ </span>
+ </div>
+
+ <div class="flex flex-col mb-6 lg:mb-0 border-r gap-2">
+ <span class="text-sm text-gray-500"><%= Spree.t('admin.webhook_endpoints.successful_deliveries') %></span>
+ <span class="text-lg text-gray-900 font-bold">
+ <%= @webhook_endpoint.webhook_deliveries.successful.count %>
+ </span>
+ </div>
+
+ <div class="flex flex-col mb-6 lg:mb-0 gap-2">
+ <span class="text-sm text-gray-500"><%= Spree.t('admin.webhook_endpoints.failed_deliveries') %></span>
+ <span class="text-lg text-gray-900 font-bold">
+ <%= @webhook_endpoint.webhook_deliveries.failed.count %>
+ </span>
+ </div>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/webhook_endpoints/_table_header.html.erb b/admin/app/views/spree/admin/webhook_endpoints/_table_header.html.erb
new file mode 100644
index 0000000000..93726fa488
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/_table_header.html.erb
@@ -0,0 +1,7 @@
+<tr>
+ <th scope="col"><%= Spree.t(:url) %></th>
+ <th scope="col" class="text-center"><%= Spree.t(:active) %></th>
+ <th scope="col"><%= Spree.t('admin.webhook_endpoints.subscriptions') %></th>
+ <th scope="col"><%= Spree.t('admin.webhook_endpoints.deliveries') %></th>
+ <th scope="col"><%= Spree.t(:created_at) %></th>
+</tr>
diff --git a/admin/app/views/spree/admin/webhook_endpoints/_table_row.html.erb b/admin/app/views/spree/admin/webhook_endpoints/_table_row.html.erb
new file mode 100644
index 0000000000..e59a4ab02f
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/_table_row.html.erb
@@ -0,0 +1,24 @@
+<tr id="<%= spree_dom_id webhook_endpoint %>" data-controller="row-link">
+ <td class="w-40 p-0">
+ <%= link_to webhook_endpoint.url,
+ spree.admin_webhook_endpoint_path(webhook_endpoint),
+ class: 'font-bold w-full h-full block p-3',
+ data: { row_link_target: 'link', turbo_frame: '_top' } %>
+ </td>
+ <td class="text-center w-10 cursor-pointer" data-action="click->row-link#openLink">
+ <%= active_badge(webhook_endpoint.active?) %>
+ </td>
+ <td class="w-10 cursor-pointer" data-action="click->row-link#openLink">
+ <span class="text-gray-600">
+ <%= webhook_endpoint.subscriptions.size %> <%= Spree.t('admin.webhook_endpoints.events') %>
+ </span>
+ </td>
+ <td class="w-20 cursor-pointer" data-action="click->row-link#openLink">
+ <span class="text-green-500">
+ <%= webhook_endpoint.webhook_deliveries.successful.count %>
+ </span> / <%= webhook_endpoint.webhook_deliveries.count %>
+ </td>
+ <td class="w-20 cursor-pointer" data-action="click->row-link#openLink">
+ <%= spree_time(webhook_endpoint.created_at) %>
+ </td>
+</tr>
diff --git a/admin/app/views/spree/admin/webhook_endpoints/edit.html.erb b/admin/app/views/spree/admin/webhook_endpoints/edit.html.erb
new file mode 100644
index 0000000000..520a6f47c2
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/edit.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/edit_resource' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/webhook_endpoints/index.html.erb b/admin/app/views/spree/admin/webhook_endpoints/index.html.erb
new file mode 100644
index 0000000000..cffe722815
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/index.html.erb
@@ -0,0 +1,9 @@
+<%= render 'spree/admin/shared/developers_nav' %>
+
+<%= content_for(:title, Spree.t(:webhook_endpoints)) %>
+
+<% content_for :page_actions do %>
+ <%= link_to_with_icon 'plus', Spree.t(:new_webhook_endpoint), new_object_url, class: "btn btn-primary" if can? :create, Spree::WebhookEndpoint %>
+<% end %>
+
+<%= render 'spree/admin/shared/index_table' %>
diff --git a/admin/app/views/spree/admin/webhook_endpoints/new.html.erb b/admin/app/views/spree/admin/webhook_endpoints/new.html.erb
new file mode 100644
index 0000000000..65a817edc9
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/new.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/new_resource' %>
diff --git a/admin/app/views/spree/admin/webhook_endpoints/show.html.erb b/admin/app/views/spree/admin/webhook_endpoints/show.html.erb
new file mode 100644
index 0000000000..8e781b9c24
--- /dev/null
+++ b/admin/app/views/spree/admin/webhook_endpoints/show.html.erb
@@ -0,0 +1,18 @@
+<%= content_for :page_title do %>
+ <%= page_header_back_button(collection_url) %>
+ <%= @webhook_endpoint.url %>
+<% end %>
+
+<div class="grid grid-cols-12 gap-6">
+ <div class="col-span-12 lg:col-span-8">
+ <%= render 'summary' %>
+
+ <%= turbo_frame_tag :webhook_deliveries, src: spree.admin_webhook_endpoint_webhook_deliveries_path(@webhook_endpoint), loading: :lazy, autoscroll: true, data: { autoscroll_block: :nearest, autoscroll_behavior: :smooth } do %>
+ <%= render 'spree/admin/shared/spinner' %>
+ <% end %>
+ </div>
+
+ <div class="col-span-12 lg:col-span-4">
+ <%= render 'details' %>
+ <%= render 'secret_key' %>
+</div>
\ No newline at end of file
diff --git a/admin/config/initializers/spree_admin_navigation.rb b/admin/config/initializers/spree_admin_navigation.rb
index ae84bbdcf7..47813e1b63 100644
--- a/admin/config/initializers/spree_admin_navigation.rb
+++ b/admin/config/initializers/spree_admin_navigation.rb
@@ -331,7 +331,7 @@ Rails.application.config.after_initialize do
url: :admin_oauth_applications_path,
icon: 'terminal',
position: 150,
- active: -> { %w[oauth_applications webhooks_subscribers].include?(controller_name) },
+ active: -> { %w[oauth_applications webhooks_subscribers webhook_endpoints webhook_deliveries].include?(controller_name) },
if: -> { can?(:manage, Spree::OauthApplication) }
# Edit Profile
@@ -446,6 +446,13 @@ Rails.application.config.after_initialize do
active: -> { controller_name == 'oauth_applications' },
if: -> { can?(:manage, Spree::OauthApplication) }
+ developers_tabs_nav.add :webhook_endpoints,
+ label: :webhook_endpoints,
+ url: :admin_webhook_endpoints_path,
+ position: 20,
+ active: -> { %w[webhook_endpoints webhook_deliveries].include?(controller_name) },
+ if: -> { can?(:manage, Spree::WebhookEndpoint) }
+
# Audit Tab Navigation
audit_tabs_nav = Spree.admin.navigation.audit_tabs
diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.yml
index e2fe8b1a41..ad9dd6bbff 100644
--- a/admin/config/locales/en.yml
+++ b/admin/config/locales/en.yml
@@ -302,6 +302,33 @@ en:
total_inventory_html: 'Total inventory at %{stock_location} location: %{count} available'
vendors:
enterprise_feature: Multi-Vendor Marketplace is available in the Enterprise Edition
+ webhook_deliveries:
+ delivered_at: Delivered at
+ delivery_details: Delivery Details
+ delivery_info: Delivery Information
+ endpoint_inactive: Cannot retry - endpoint is inactive
+ event: Event
+ execution_time: Execution Time
+ failed: Failed
+ pending: Pending
+ request_payload: Request Payload
+ response_body: Response Body
+ response_code: Response Code
+ retry: Retry
+ retry_queued: Delivery has been queued for retry
+ webhook_endpoints:
+ back_to_endpoint: Back to endpoint
+ deliveries: Deliveries
+ endpoint_settings: Endpoint Settings
+ event_subscriptions: Event Subscriptions
+ event_subscriptions_help: Select which events should trigger a webhook delivery to this endpoint.
+ events: events
+ failed_deliveries: Failed Deliveries
+ new: New Webhook Endpoint
+ secret_key: Secret Key
+ secret_key_help: Use this key to verify webhook signatures. Keep it secure and do not share it publicly.
+ subscriptions: Subscriptions
+ successful_deliveries: Successful Deliveries
webhooks_subscribers:
all_events: All Events
new_webhooks_subscriber: New Webhooks Subscriber
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index ddee0f566a..0d9ecd1f2d 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -219,6 +219,13 @@ Spree::Core::Engine.add_routes do
# developer tools
resources :oauth_applications
+ resources :webhook_endpoints do
+ resources :webhook_deliveries, only: [:index, :show] do
+ member do
+ post :retry
+ end
+ end
+ end
# errors
get '/forbidden', to: 'errors#show', code: 403, as: :forbidden
diff --git a/api/app/jobs/spree/webhook_delivery_job.rb b/api/app/jobs/spree/webhook_delivery_job.rb
new file mode 100644
index 0000000000..4fca11fd81
--- /dev/null
+++ b/api/app/jobs/spree/webhook_delivery_job.rb
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spree
+ class WebhookDeliveryJob < Spree::BaseJob
+ queue_as Spree.queues.webhooks
+
+ retry_on StandardError, wait: :polynomially_longer, attempts: 5
+
+ def perform(delivery_id, secret_key)
+ delivery = Spree::WebhookDelivery.find_by(id: delivery_id)
+ return if delivery.nil?
+
+ Spree::Webhooks::DeliverWebhook.call(delivery: delivery, secret_key: secret_key)
+ end
+ end
+end
diff --git a/api/app/services/spree/webhooks/deliver_webhook.rb b/api/app/services/spree/webhooks/deliver_webhook.rb
new file mode 100644
index 0000000000..a7d19fb984
--- /dev/null
+++ b/api/app/services/spree/webhooks/deliver_webhook.rb
@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'openssl'
+
+module Spree
+ module Webhooks
+ class DeliverWebhook
+ TIMEOUT = 30
+
+ def self.call(delivery:, secret_key:)
+ new(delivery: delivery, secret_key: secret_key).call
+ end
+
+ def initialize(delivery:, secret_key:)
+ @delivery = delivery
+ @secret_key = secret_key
+ end
+
+ def call
+ start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+ response = make_request
+ execution_time = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000).round
+
+ @delivery.complete!(
+ response_code: response.code.to_i,
+ execution_time: execution_time,
+ response_body: response.body.to_s.truncate(10_000)
+ )
+ rescue Net::OpenTimeout, Net::ReadTimeout => e
+ execution_time = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000).round
+ Rails.error.report(e, context: { webhook_delivery_id: @delivery.id, url: @delivery.url })
+ @delivery.complete!(
+ execution_time: execution_time,
+ error_type: 'timeout',
+ request_errors: e.message
+ )
+ rescue StandardError => e
+ execution_time = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000).round
+ Rails.error.report(e, context: { webhook_delivery_id: @delivery.id, url: @delivery.url })
+ @delivery.complete!(
+ execution_time: execution_time,
+ error_type: 'connection_error',
+ request_errors: e.message
+ )
+ end
+
+ private
+
+ def make_request
+ uri = URI.parse(@delivery.url)
+ http = Net::HTTP.new(uri.host, uri.port)
+ http.use_ssl = uri.scheme == 'https'
+ http.verify_mode = ssl_verify_mode
+ http.open_timeout = TIMEOUT
+ http.read_timeout = TIMEOUT
+
+ request = Net::HTTP::Post.new(uri.request_uri)
+ request['Content-Type'] = 'application/json'
+ request['User-Agent'] = 'Spree-Webhooks/1.0'
+ request['X-Spree-Webhook-Signature'] = generate_signature
+ request['X-Spree-Webhook-Event'] = @delivery.event_name
+ request.body = @delivery.payload.to_json
+
+ http.request(request)
+ end
+
+ def generate_signature
+ payload_json = @delivery.payload.to_json
+ OpenSSL::HMAC.hexdigest('SHA256', @secret_key, payload_json)
+ end
+
+ def ssl_verify_mode
+ if Spree::Api::Config.webhooks_verify_ssl
+ OpenSSL::SSL::VERIFY_PEER
+ else
+ OpenSSL::SSL::VERIFY_NONE
+ end
+ end
+ end
+ end
+end
diff --git a/api/app/subscribers/spree/webhook_event_subscriber.rb b/api/app/subscribers/spree/webhook_event_subscriber.rb
new file mode 100644
index 0000000000..977210c080
--- /dev/null
+++ b/api/app/subscribers/spree/webhook_event_subscriber.rb
@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Spree
+ # Listens to Spree events and queues webhook deliveries for enabled endpoints.
+ #
+ # This subscriber listens to all Spree events and for each event, finds
+ # all enabled webhook endpoints that are subscribed to that event and queues
+ # a delivery job for each one.
+ #
+ # The event payload is passed through directly without transformation.
+ # Events should already be serialized by the EventSerializer.
+ #
+ # @example
+ # # Webhooks are automatically delivered when events are published
+ # Spree::Events.publish('order.completed', order: order)
+ #
+ class WebhookEventSubscriber < Spree::Subscriber
+ subscribes_to '*'
+
+ def handle(event)
+ return unless Spree::Api::Config.webhooks_enabled
+
+ store = Spree::Current.store
+
+ # Find all active endpoints for this store subscribed to this event
+ endpoints = Spree::WebhookEndpoint.active.where(store: store).select { |endpoint| endpoint.subscribed_to?(event.name) }
+
+ return if endpoints.empty?
+
+ # Queue delivery for each endpoint
+ endpoints.each do |endpoint|
+ queue_delivery(endpoint, event)
+ end
+ rescue StandardError => e
+ Rails.logger.error "[Spree Webhooks] Error processing event: #{e.message}"
+ Rails.error.report(e)
+ end
+
+ private
+
+ def queue_delivery(endpoint, event)
+ # Build base payload (without delivery ID)
+ payload = build_payload(event)
+
+ # Create delivery record
+ delivery = endpoint.webhook_deliveries.create!(
+ event_name: event.name,
+ payload: payload
+ )
+
+ # Add webhook_delivery_id to payload
+ delivery.update_column(:payload, payload.merge(webhook_delivery_id: delivery.id))
+
+ # Queue the delivery job
+ Spree::WebhookDeliveryJob.perform_later(delivery.id, endpoint.secret_key)
+ rescue StandardError => e
+ Rails.logger.error "[Spree Webhooks] Error queuing delivery for endpoint #{endpoint.id}: #{e.message}"
+ Rails.error.report(e)
+ end
+
+ def build_payload(event)
+ {
+ id: event.id,
+ event: event.name,
+ created_at: event.created_at.iso8601,
+ data: event.payload
+ }
+ end
+ end
+end
diff --git a/api/lib/generators/spree/api/install/install_generator.rb b/api/lib/generators/spree/api/install/install_generator.rb
new file mode 100644
index 0000000000..4e5832ccfc
--- /dev/null
+++ b/api/lib/generators/spree/api/install/install_generator.rb
@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+ module Api
+ module Generators
+ class InstallGenerator < Rails::Generators::Base
+ class_option :migrate, type: :boolean, default: true
+
+ def add_migrations
+ run 'bundle exec rake railties:install:migrations FROM=spree_api'
+ end
+
+ def run_migrations
+ run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+ if run_migrations
+ run 'bin/rails db:migrate'
+ else
+ puts 'Skipping rails db:migrate, don\'t forget to run it!'
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/api/lib/spree/api/configuration.rb b/api/lib/spree/api/configuration.rb
index 05eb1d8479..8427dbc206 100644
--- a/api/lib/spree/api/configuration.rb
+++ b/api/lib/spree/api/configuration.rb
@@ -8,6 +8,9 @@ module Spree
preference :api_v2_collection_cache_namespace, :string, default: 'api_v2_collection_cache'
preference :api_v2_content_type, :string, default: 'application/vnd.api+json'
preference :api_v2_per_page_limit, :integer, default: 500
+
+ preference :webhooks_enabled, :boolean, default: true
+ preference :webhooks_verify_ssl, :boolean, default: !Rails.env.development?
end
end
end
diff --git a/api/lib/spree/api/engine.rb b/api/lib/spree/api/engine.rb
index 9700d51c0e..4ab6cf0156 100644
--- a/api/lib/spree/api/engine.rb
+++ b/api/lib/spree/api/engine.rb
@@ -18,6 +18,11 @@ module Spree
Migrations.new(config, engine_name).check unless Rails.env.test?
end
+ # Add API event subscribers
+ config.after_initialize do
+ Spree.subscribers << Spree::WebhookEventSubscriber
+ end
+
def self.root
@root ||= Pathname.new(File.expand_path('../../..', __dir__))
end
diff --git a/api/spec/jobs/spree/webhook_delivery_job_spec.rb b/api/spec/jobs/spree/webhook_delivery_job_spec.rb
new file mode 100644
index 0000000000..cf96afb2db
--- /dev/null
+++ b/api/spec/jobs/spree/webhook_delivery_job_spec.rb
@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Spree
+ describe WebhookDeliveryJob, type: :job do
+ let(:store) { create(:store) }
+ let(:webhook_endpoint) { create(:webhook_endpoint, store: store) }
+ let(:delivery) { create(:webhook_delivery, :pending, webhook_endpoint: webhook_endpoint) }
+ let(:secret_key) { webhook_endpoint.secret_key }
+
+ describe '#perform' do
+ before do
+ stub_request(:post, delivery.url).to_return(status: 200, body: '{}')
+ end
+
+ it 'calls DeliverWebhook service' do
+ expect(Spree::Webhooks::DeliverWebhook).to receive(:call).with(
+ delivery: delivery,
+ secret_key: secret_key
+ )
+
+ described_class.new.perform(delivery.id, secret_key)
+ end
+
+ context 'when delivery does not exist' do
+ it 'returns early without calling service' do
+ expect(Spree::Webhooks::DeliverWebhook).not_to receive(:call)
+
+ described_class.new.perform(-1, secret_key)
+ end
+ end
+
+ context 'when delivery has been deleted' do
+ before { delivery.destroy }
+
+ it 'returns early without calling service' do
+ expect(Spree::Webhooks::DeliverWebhook).not_to receive(:call)
+
+ described_class.new.perform(delivery.id, secret_key)
+ end
+ end
+ end
+
+ describe 'queue' do
+ it 'uses the webhooks queue' do
+ expect(described_class.new.queue_name).to eq(Spree.queues.webhooks.to_s)
+ end
+ end
+
+ describe 'retry behavior' do
+ it 'has retry_on configured' do
+ # Verify the job class has retry behavior configured
+ expect(described_class.ancestors).to include(ActiveJob::Exceptions)
+ end
+ end
+ end
+end
diff --git a/api/spec/services/spree/webhooks/deliver_webhook_spec.rb b/api/spec/services/spree/webhooks/deliver_webhook_spec.rb
new file mode 100644
index 0000000000..55c307b73a
--- /dev/null
+++ b/api/spec/services/spree/webhooks/deliver_webhook_spec.rb
@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Spree
+ module Webhooks
+ describe DeliverWebhook do
+ let(:store) { create(:store) }
+ let(:webhook_endpoint) { create(:webhook_endpoint, store: store) }
+ let(:delivery) { create(:webhook_delivery, :pending, webhook_endpoint: webhook_endpoint) }
+ let(:secret_key) { webhook_endpoint.secret_key }
+
+ describe '.call' do
+ context 'with successful response' do
+ before do
+ stub_request(:post, delivery.url)
+ .to_return(status: 200, body: '{"status":"ok"}', headers: { 'Content-Type' => 'application/json' })
+ end
+
+ it 'marks delivery as successful' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ delivery.reload
+ expect(delivery.success).to be true
+ expect(delivery.response_code).to eq(200)
+ expect(delivery.response_body).to eq('{"status":"ok"}')
+ expect(delivery.delivered_at).to be_present
+ expect(delivery.execution_time).to be_present
+ end
+
+ it 'sends correct headers' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ expect(WebMock).to have_requested(:post, delivery.url)
+ .with(headers: {
+ 'Content-Type' => 'application/json',
+ 'User-Agent' => 'Spree-Webhooks/1.0',
+ 'X-Spree-Webhook-Event' => delivery.event_name
+ })
+ end
+
+ it 'includes HMAC signature in headers' do
+ expected_signature = OpenSSL::HMAC.hexdigest('SHA256', secret_key, delivery.payload.to_json)
+
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ expect(WebMock).to have_requested(:post, delivery.url)
+ .with(headers: { 'X-Spree-Webhook-Signature' => expected_signature })
+ end
+
+ it 'sends payload as JSON body' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ expect(WebMock).to have_requested(:post, delivery.url)
+ .with(body: delivery.payload.to_json)
+ end
+ end
+
+ context 'with 201 response' do
+ before do
+ stub_request(:post, delivery.url)
+ .to_return(status: 201, body: '')
+ end
+
+ it 'marks delivery as successful' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ delivery.reload
+ expect(delivery.success).to be true
+ expect(delivery.response_code).to eq(201)
+ end
+ end
+
+ context 'with 4xx response' do
+ before do
+ stub_request(:post, delivery.url)
+ .to_return(status: 404, body: 'Not Found')
+ end
+
+ it 'marks delivery as failed' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ delivery.reload
+ expect(delivery.success).to be false
+ expect(delivery.response_code).to eq(404)
+ expect(delivery.response_body).to eq('Not Found')
+ end
+ end
+
+ context 'with 5xx response' do
+ before do
+ stub_request(:post, delivery.url)
+ .to_return(status: 500, body: 'Internal Server Error')
+ end
+
+ it 'marks delivery as failed' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ delivery.reload
+ expect(delivery.success).to be false
+ expect(delivery.response_code).to eq(500)
+ end
+ end
+
+ context 'with timeout' do
+ before do
+ stub_request(:post, delivery.url).to_timeout
+ allow(Rails.error).to receive(:report)
+ end
+
+ it 'marks delivery as failed with timeout error' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ delivery.reload
+ expect(delivery.success).to be false
+ expect(delivery.response_code).to be_nil
+ expect(delivery.error_type).to eq('timeout')
+ expect(delivery.request_errors).to be_present
+ end
+
+ it 'reports error to Rails.error' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ expect(Rails.error).to have_received(:report).with(
+ an_instance_of(Net::OpenTimeout),
+ context: { webhook_delivery_id: delivery.id, url: delivery.url }
+ )
+ end
+ end
+
+ context 'with connection error' do
+ before do
+ stub_request(:post, delivery.url).to_raise(Errno::ECONNREFUSED)
+ allow(Rails.error).to receive(:report)
+ end
+
+ it 'marks delivery as failed with connection error' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ delivery.reload
+ expect(delivery.success).to be false
+ expect(delivery.response_code).to be_nil
+ expect(delivery.error_type).to eq('connection_error')
+ expect(delivery.request_errors).to be_present
+ end
+
+ it 'reports error to Rails.error' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ expect(Rails.error).to have_received(:report).with(
+ an_instance_of(Errno::ECONNREFUSED),
+ context: { webhook_delivery_id: delivery.id, url: delivery.url }
+ )
+ end
+ end
+
+ context 'with large response body' do
+ let(:large_body) { 'x' * 15_000 }
+
+ before do
+ stub_request(:post, delivery.url)
+ .to_return(status: 200, body: large_body)
+ end
+
+ it 'truncates the response body' do
+ described_class.call(delivery: delivery, secret_key: secret_key)
+
+ delivery.reload
+ expect(delivery.response_body.length).to be <= 10_003 # 10_000 + '...'
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb b/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb
new file mode 100644
index 0000000000..8e40d7162a
--- /dev/null
+++ b/api/spec/subscribers/spree/webhook_event_subscriber_spec.rb
@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Spree
+ describe WebhookEventSubscriber do
+ let(:store) { create(:store) }
+ let!(:webhook_endpoint) { create(:webhook_endpoint, store: store, subscriptions: ['order.created']) }
+ let(:event_name) { 'order.created' }
+ let(:event_payload) { { id: 1, number: 'R123456' } }
+ let(:event_id) { SecureRandom.uuid }
+ let(:event_created_at) { Time.current }
+ let(:event_metadata) { {} }
+ let(:event) { double('Event', id: event_id, name: event_name, payload: event_payload, metadata: event_metadata, created_at: event_created_at) }
+
+ before do
+ allow(Spree::Current).to receive(:store).and_return(store)
+ allow(Spree::Api::Config).to receive(:webhooks_enabled).and_return(true)
+ end
+
+ describe '#handle' do
+ context 'when webhooks are enabled' do
+ it 'creates a webhook delivery record' do
+ expect {
+ described_class.new.handle(event)
+ }.to change(Spree::WebhookDelivery, :count).by(1)
+ end
+
+ it 'queues a webhook delivery job' do
+ expect {
+ described_class.new.handle(event)
+ }.to have_enqueued_job(Spree::WebhookDeliveryJob)
+ end
+
+ it 'creates delivery with correct attributes' do
+ described_class.new.handle(event)
+
+ delivery = Spree::WebhookDelivery.last
+ expect(delivery.event_name).to eq(event_name)
+ expect(delivery.url).to eq(webhook_endpoint.url)
+ expect(delivery.webhook_endpoint).to eq(webhook_endpoint)
+
+ # Reload to get the updated payload with webhook_delivery_id
+ delivery.reload
+ expect(delivery.payload).to include(
+ 'id' => event_id,
+ 'event' => event_name,
+ 'webhook_delivery_id' => delivery.id,
+ 'data' => event_payload.stringify_keys
+ )
+ expect(delivery.payload['created_at']).to eq(event_created_at.iso8601)
+ end
+ end
+
+ context 'when webhooks are disabled' do
+ before do
+ allow(Spree::Api::Config).to receive(:webhooks_enabled).and_return(false)
+ end
+
+ it 'does not create a webhook delivery' do
+ expect {
+ described_class.new.handle(event)
+ }.not_to change(Spree::WebhookDelivery, :count)
+ end
+
+ it 'does not queue a job' do
+ expect {
+ described_class.new.handle(event)
+ }.not_to have_enqueued_job(Spree::WebhookDeliveryJob)
+ end
+ end
+
+ context 'when endpoint is not subscribed to event' do
+ let(:event_name) { 'product.created' }
+
+ it 'does not create a webhook delivery' do
+ expect {
+ described_class.new.handle(event)
+ }.not_to change(Spree::WebhookDelivery, :count)
+ end
+ end
+
+ context 'when endpoint is inactive' do
+ before { webhook_endpoint.update!(active: false) }
+
+ it 'does not create a webhook delivery' do
+ expect {
+ described_class.new.handle(event)
+ }.not_to change(Spree::WebhookDelivery, :count)
+ end
+ end
+
+ context 'with multiple endpoints' do
+ let!(:second_endpoint) { create(:webhook_endpoint, store: store, subscriptions: ['order.created']) }
+ let!(:other_event_endpoint) { create(:webhook_endpoint, store: store, subscriptions: ['product.created']) }
+
+ it 'creates deliveries for all subscribed endpoints' do
+ expect {
+ described_class.new.handle(event)
+ }.to change(Spree::WebhookDelivery, :count).by(2)
+ end
+
+ it 'queues jobs for each endpoint' do
+ expect {
+ described_class.new.handle(event)
+ }.to have_enqueued_job(Spree::WebhookDeliveryJob).exactly(:twice)
+ end
+ end
+
+ context 'with wildcard subscription' do
+ let!(:wildcard_endpoint) { create(:webhook_endpoint, :all_events, store: store) }
+
+ it 'creates delivery for any event' do
+ random_event = double('Event', id: SecureRandom.uuid, name: 'random.event', payload: {}, metadata: event_metadata, created_at: event_created_at)
+
+ expect {
+ described_class.new.handle(random_event)
+ }.to change(wildcard_endpoint.webhook_deliveries, :count).by(1)
+ end
+ end
+
+ context 'with pattern subscription' do
+ let!(:pattern_endpoint) { create(:webhook_endpoint, store: store, subscriptions: ['order.*']) }
+ let(:event_name) { 'order.completed' }
+
+ it 'creates delivery for matching pattern events' do
+ expect {
+ described_class.new.handle(event)
+ }.to change(pattern_endpoint.webhook_deliveries, :count).by(1)
+ end
+ end
+
+ context 'when an error occurs' do
+ before do
+ allow(Spree::WebhookEndpoint).to receive(:active).and_raise(StandardError, 'Database error')
+ allow(Rails.logger).to receive(:error)
+ allow(Rails.error).to receive(:report)
+ end
+
+ it 'logs the error' do
+ described_class.new.handle(event)
+
+ expect(Rails.logger).to have_received(:error).with(/Error processing event/)
+ end
+
+ it 'reports error to Rails.error' do
+ described_class.new.handle(event)
+
+ expect(Rails.error).to have_received(:report).with(an_instance_of(StandardError))
+ end
+
+ it 'does not raise the error' do
+ expect {
+ described_class.new.handle(event)
+ }.not_to raise_error
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/models/concerns/spree/publishable.rb b/core/app/models/concerns/spree/publishable.rb
index 76321a8e41..4ecfd4726f 100644
--- a/core/app/models/concerns/spree/publishable.rb
+++ b/core/app/models/concerns/spree/publishable.rb
@@ -79,6 +79,9 @@ module Spree
# publishes_lifecycle_events except: [:update]
#
def publishes_lifecycle_events(options = {})
+ # Guard against duplicate callback registration (important for code reload in development)
+ return if lifecycle_events_enabled
+
self.lifecycle_events_enabled = true
events = [:create, :update, :delete]
@@ -210,6 +213,7 @@ module Spree
def event_context
{
event_name: @_current_event_name,
+ store_id: Spree::Current.store&.id,
triggered_at: Time.current
}
end
diff --git a/core/app/models/spree/asset.rb b/core/app/models/spree/asset.rb
index 7c8b97e77b..14ff43e1f4 100644
--- a/core/app/models/spree/asset.rb
+++ b/core/app/models/spree/asset.rb
@@ -60,5 +60,9 @@ module Spree
def skip_import?
false
end
+
+ def event_prefix
+ 'asset'
+ end
end
end
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index c9928b2085..0949572260 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -113,6 +113,9 @@ module Spree
has_many :policies, class_name: 'Spree::Policy', dependent: :destroy, as: :owner
+ has_many :webhook_endpoints, class_name: 'Spree::WebhookEndpoint', dependent: :destroy, inverse_of: :store
+ has_many :webhook_deliveries, through: :webhook_endpoints, class_name: 'Spree::WebhookDelivery'
+
#
# ActionText
#
diff --git a/core/app/models/spree/webhook_delivery.rb b/core/app/models/spree/webhook_delivery.rb
new file mode 100644
index 0000000000..f3b0973d80
--- /dev/null
+++ b/core/app/models/spree/webhook_delivery.rb
@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Spree
+ class WebhookDelivery < Spree.base_class
+ belongs_to :webhook_endpoint, class_name: 'Spree::WebhookEndpoint'
+ delegate :url, to: :webhook_endpoint
+
+ validates :event_name, presence: true
+ validates :payload, presence: true
+
+ ERROR_TYPES = %w[timeout connection_error].freeze
+
+ scope :successful, -> { where(success: true) }
+ scope :failed, -> { where(success: false) }
+ scope :pending, -> { where(delivered_at: nil) }
+ scope :recent, -> { order(created_at: :desc) }
+ scope :for_event, ->(event_name) { where(event_name: event_name) }
+
+ # Ransack configuration
+ self.whitelisted_ransackable_attributes = %w[event_name response_code execution_time success delivered_at]
+
+ # Check if the delivery was successful
+ #
+ # @return [Boolean]
+ def successful?
+ success == true
+ end
+
+ # Check if the delivery failed
+ #
+ # @return [Boolean]
+ def failed?
+ success == false
+ end
+
+ # Check if the delivery is pending
+ #
+ # @return [Boolean]
+ def pending?
+ delivered_at.nil?
+ end
+
+ # Mark delivery as completed with HTTP response
+ #
+ # @param response_code [Integer] HTTP response code
+ # @param execution_time [Integer] time in milliseconds
+ # @param response_body [String] response body from the webhook endpoint
+ def complete!(response_code: nil, execution_time:, error_type: nil, request_errors: nil, response_body: nil)
+ update!(
+ response_code: response_code,
+ execution_time: execution_time,
+ error_type: error_type,
+ request_errors: request_errors,
+ response_body: response_body,
+ success: response_code.present? && response_code.to_s.start_with?('2'),
+ delivered_at: Time.current
+ )
+ end
+ end
+end
diff --git a/core/app/models/spree/webhook_endpoint.rb b/core/app/models/spree/webhook_endpoint.rb
new file mode 100644
index 0000000000..b477940884
--- /dev/null
+++ b/core/app/models/spree/webhook_endpoint.rb
@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Spree
+ class WebhookEndpoint < Spree.base_class
+ acts_as_paranoid
+
+ include Spree::SingleStoreResource
+
+ belongs_to :store, class_name: 'Spree::Store'
+ has_many :webhook_deliveries, class_name: 'Spree::WebhookDelivery', dependent: :destroy_async
+
+ validates :store, :url, presence: true
+ validates :url, format: { with: URI::DEFAULT_PARSER.make_regexp(%w[http https]), message: :invalid_url }
+ validates :active, inclusion: { in: [true, false] }
+
+ before_create :generate_secret_key
+
+ scope :active, -> { where(active: true) }
+ scope :inactive, -> { where(active: false) }
+
+ # Check if this endpoint is subscribed to a specific event
+ #
+ # @param event_name [String] the event name to check
+ # @return [Boolean]
+ def subscribed_to?(event_name)
+ return true if subscriptions.blank? || subscriptions.include?('*')
+
+ subscriptions.any? do |subscription|
+ if subscription.include?('*')
+ pattern = Regexp.escape(subscription).gsub('\*', '.*')
+ event_name.match?(Regexp.new("^#{pattern}$"))
+ else
+ subscription == event_name
+ end
+ end
+ end
+
+ # Returns all events this endpoint is subscribed to
+ #
+ # @return [Array<String>]
+ def subscribed_events
+ return ['*'] if subscriptions.blank?
+
+ subscriptions
+ end
+
+ private
+
+ def generate_secret_key
+ self.secret_key ||= SecureRandom.hex(32)
+ end
+ end
+end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index d189b31e61..61a00c75a4 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -1380,6 +1380,7 @@ en:
new_tracker: New Tracker
new_user: New User
new_variant: New Variant
+ new_webhook_endpoint: New Webhook Endpoint
new_zone: New Zone
newsletter_mailer:
email_confirmation:
@@ -2319,6 +2320,7 @@ en:
we_are_busy_updating: We're updating the %{store_name} homepage.
we_are_busy_updating_page: We're busy updating this page.
we_will_be_back: We will be back.
+ webhook_endpoints: Webhook Endpoints
webhooks: Webhooks
weight: Weight
weight_unit: Weight unit
diff --git a/core/db/migrate/20251214000001_create_spree_webhook_endpoints.rb b/core/db/migrate/20251214000001_create_spree_webhook_endpoints.rb
new file mode 100644
index 0000000000..b6d96904d9
--- /dev/null
+++ b/core/db/migrate/20251214000001_create_spree_webhook_endpoints.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CreateSpreeWebhookEndpoints < ActiveRecord::Migration[7.0]
+ def change
+ create_table :spree_webhook_endpoints do |t|
+ t.belongs_to :store, null: false, foreign_key: false, index: true
+ t.string :url, null: false
+ t.boolean :active, null: false, default: true, index: true
+ if t.respond_to? :jsonb
+ t.jsonb :subscriptions, null: false
+ else
+ t.json :subscriptions, null: false
+ end
+ t.string :secret_key, null: false
+ t.datetime :deleted_at, index: true
+ t.timestamps
+ end
+ end
+end
diff --git a/core/db/migrate/20251214000002_create_spree_webhook_deliveries.rb b/core/db/migrate/20251214000002_create_spree_webhook_deliveries.rb
new file mode 100644
index 0000000000..db2da62440
--- /dev/null
+++ b/core/db/migrate/20251214000002_create_spree_webhook_deliveries.rb
@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class CreateSpreeWebhookDeliveries < ActiveRecord::Migration[7.0]
+ def change
+ create_table :spree_webhook_deliveries do |t|
+ t.belongs_to :webhook_endpoint, null: false, foreign_key: false, index: true
+ t.string :event_name, null: false, index: true
+ if t.respond_to?(:jsonb)
+ t.jsonb :payload, null: false
+ else
+ t.json :payload, null: false
+ end
+ t.integer :response_code, index: true
+ t.text :response_body
+ t.string :error_type
+ t.integer :execution_time
+ t.text :request_errors
+ t.boolean :success, index: true
+ t.datetime :delivered_at, index: true
+ t.timestamps
+ end
+ end
+end
diff --git a/core/lib/generators/spree/install/install_generator.rb b/core/lib/generators/spree/install/install_generator.rb
index 9f97a7e85f..da2d67871c 100644
--- a/core/lib/generators/spree/install/install_generator.rb
+++ b/core/lib/generators/spree/install/install_generator.rb
@@ -110,7 +110,7 @@ module Spree
silence_warnings { rake 'active_storage:install:migrations' }
silence_warnings { rake 'action_text:install:migrations' }
silence_warnings { rake 'spree:install:migrations' }
- silence_warnings { rake 'spree_api:install:migrations' } if defined?(Spree::Api)
+ silence_warnings { rake 'spree_api:install:migrations' }
silence_warnings { rake 'spree_page_builder:install:migrations' } if @install_storefront
end
end
diff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rb
index 568b2b0ede..c05a547c74 100644
--- a/core/lib/spree/permitted_attributes.rb
+++ b/core/lib/spree/permitted_attributes.rb
@@ -68,6 +68,7 @@ module Spree
:theme_attributes,
:user_attributes,
:variant_attributes,
+ :webhook_endpoint_attributes,
:wishlist_attributes,
:wished_item_attributes,
:zone_attributes
@@ -308,6 +309,8 @@ module Spree
}
]
+ @@webhook_endpoint_attributes = [:url, :secret, :active, subscriptions: []]
+
@@wishlist_attributes = [:name, :is_default, :is_private]
@@wished_item_attributes = [:variant_id, :quantity]
diff --git a/core/lib/spree/testing_support/common_rake.rb b/core/lib/spree/testing_support/common_rake.rb
index 80e6c11cff..8bbf6cba18 100644
--- a/core/lib/spree/testing_support/common_rake.rb
+++ b/core/lib/spree/testing_support/common_rake.rb
@@ -76,7 +76,8 @@ namespace :common do
else
"#{ENV['LIB_NAME'].camelize}::Generators::InstallGenerator".constantize.start(['--force', '--auto-run-migrations'])
end
- rescue LoadError
+ rescue LoadError => e
+ puts "Error loading generator: #{e.message}"
puts 'Skipping installation no generator to run...'
end
diff --git a/core/lib/spree/testing_support/factories/webhook_delivery_factory.rb b/core/lib/spree/testing_support/factories/webhook_delivery_factory.rb
new file mode 100644
index 0000000000..1b6db05af7
--- /dev/null
+++ b/core/lib/spree/testing_support/factories/webhook_delivery_factory.rb
@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+ factory :webhook_delivery, class: Spree::WebhookDelivery do
+ webhook_endpoint
+ event_name { 'order.created' }
+ payload { { event: 'order.created', data: { id: 1 } } }
+
+ trait :pending do
+ response_code { nil }
+ execution_time { nil }
+ success { nil }
+ delivered_at { nil }
+ end
+
+ trait :successful do
+ response_code { 200 }
+ execution_time { 150 }
+ success { true }
+ delivered_at { Time.current }
+ end
+
+ trait :failed do
+ response_code { 500 }
+ execution_time { 200 }
+ success { false }
+ delivered_at { Time.current }
+ end
+
+ trait :timeout do
+ response_code { nil }
+ error_type { 'timeout' }
+ execution_time { 30_000 }
+ success { false }
+ request_errors { 'execution expired' }
+ delivered_at { Time.current }
+ end
+
+ trait :connection_error do
+ response_code { nil }
+ error_type { 'connection_error' }
+ execution_time { 100 }
+ success { false }
+ request_errors { 'Connection refused' }
+ delivered_at { Time.current }
+ end
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/webhook_endpoint_factory.rb b/core/lib/spree/testing_support/factories/webhook_endpoint_factory.rb
new file mode 100644
index 0000000000..92adc7f497
--- /dev/null
+++ b/core/lib/spree/testing_support/factories/webhook_endpoint_factory.rb
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+ factory :webhook_endpoint, class: Spree::WebhookEndpoint do
+ store
+ sequence(:url) { |n| "https://example.com/webhooks/#{n}" }
+ active { true }
+ subscriptions { [] }
+
+ trait :inactive do
+ active { false }
+ end
+
+ trait :with_subscriptions do
+ subscriptions { %w[order.created order.completed product.created] }
+ end
+
+ trait :all_events do
+ subscriptions { ['*'] }
+ end
+ end
+end
diff --git a/core/spec/models/spree/webhook_delivery_spec.rb b/core/spec/models/spree/webhook_delivery_spec.rb
new file mode 100644
index 0000000000..8104b9604e
--- /dev/null
+++ b/core/spec/models/spree/webhook_delivery_spec.rb
@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Spree::WebhookDelivery, type: :model do
+ let(:store) { create(:store) }
+ let(:webhook_endpoint) { create(:webhook_endpoint, store: store) }
+ let(:webhook_delivery) { build(:webhook_delivery, webhook_endpoint: webhook_endpoint) }
+
+ describe 'scopes' do
+ let!(:pending_delivery) { create(:webhook_delivery, :pending, webhook_endpoint: webhook_endpoint) }
+ let!(:successful_delivery) { create(:webhook_delivery, :successful, webhook_endpoint: webhook_endpoint) }
+ let!(:failed_delivery) { create(:webhook_delivery, :failed, webhook_endpoint: webhook_endpoint) }
+
+ describe '.successful' do
+ it 'returns only successful deliveries' do
+ expect(described_class.successful).to include(successful_delivery)
+ expect(described_class.successful).not_to include(failed_delivery)
+ expect(described_class.successful).not_to include(pending_delivery)
+ end
+ end
+
+ describe '.failed' do
+ it 'returns only failed deliveries' do
+ expect(described_class.failed).to include(failed_delivery)
+ expect(described_class.failed).not_to include(successful_delivery)
+ expect(described_class.failed).not_to include(pending_delivery)
+ end
+ end
+
+ describe '.pending' do
+ it 'returns only pending deliveries' do
+ expect(described_class.pending).to include(pending_delivery)
+ expect(described_class.pending).not_to include(successful_delivery)
+ expect(described_class.pending).not_to include(failed_delivery)
+ end
+ end
+
+ describe '.recent' do
+ it 'orders by created_at desc' do
+ expect(described_class.recent.first).to eq(failed_delivery)
+ end
+ end
+
+ describe '.for_event' do
+ let!(:order_delivery) { create(:webhook_delivery, webhook_endpoint: webhook_endpoint, event_name: 'order.created') }
+ let!(:product_delivery) { create(:webhook_delivery, webhook_endpoint: webhook_endpoint, event_name: 'product.created') }
+
+ it 'returns deliveries for the specified event' do
+ expect(described_class.for_event('order.created')).to include(order_delivery)
+ expect(described_class.for_event('order.created')).not_to include(product_delivery)
+ end
+ end
+ end
+
+ describe '#successful?' do
+ it 'returns true when success is true' do
+ delivery = build(:webhook_delivery, :successful)
+ expect(delivery.successful?).to be true
+ end
+
+ it 'returns false when success is false' do
+ delivery = build(:webhook_delivery, :failed)
+ expect(delivery.successful?).to be false
+ end
+
+ it 'returns false when success is nil' do
+ delivery = build(:webhook_delivery, :pending)
+ expect(delivery.successful?).to be false
+ end
+ end
+
+ describe '#failed?' do
+ it 'returns true when success is false' do
+ delivery = build(:webhook_delivery, :failed)
+ expect(delivery.failed?).to be true
+ end
+
+ it 'returns false when success is true' do
+ delivery = build(:webhook_delivery, :successful)
+ expect(delivery.failed?).to be false
+ end
+
+ it 'returns false when success is nil' do
+ delivery = build(:webhook_delivery, :pending)
+ expect(delivery.failed?).to be false
+ end
+ end
+
+ describe '#pending?' do
+ it 'returns true when delivered_at is nil' do
+ delivery = build(:webhook_delivery, :pending)
+ expect(delivery.pending?).to be true
+ end
+
+ it 'returns false when delivered_at is present' do
+ delivery = build(:webhook_delivery, :successful)
+ expect(delivery.pending?).to be false
+ end
+ end
+
+ describe '#complete!' do
+ let(:delivery) { create(:webhook_delivery, :pending, webhook_endpoint: webhook_endpoint) }
+
+ context 'with successful HTTP response' do
+ it 'marks the delivery as successful' do
+ delivery.complete!(
+ response_code: 200,
+ execution_time: 150,
+ response_body: '{"status":"ok"}'
+ )
+
+ expect(delivery.response_code).to eq(200)
+ expect(delivery.execution_time).to eq(150)
+ expect(delivery.response_body).to eq('{"status":"ok"}')
+ expect(delivery.success).to be true
+ expect(delivery.delivered_at).to be_present
+ expect(delivery.error_type).to be_nil
+ expect(delivery.request_errors).to be_nil
+ end
+
+ it 'marks 201 as successful' do
+ delivery.complete!(response_code: 201, execution_time: 100)
+ expect(delivery.success).to be true
+ end
+
+ it 'marks 204 as successful' do
+ delivery.complete!(response_code: 204, execution_time: 100)
+ expect(delivery.success).to be true
+ end
+ end
+
+ context 'with failed HTTP response' do
+ it 'marks the delivery as failed for 4xx responses' do
+ delivery.complete!(
+ response_code: 404,
+ execution_time: 200,
+ response_body: 'Not Found'
+ )
+
+ expect(delivery.response_code).to eq(404)
+ expect(delivery.success).to be false
+ expect(delivery.delivered_at).to be_present
+ end
+
+ it 'marks the delivery as failed for 5xx responses' do
+ delivery.complete!(
+ response_code: 500,
+ execution_time: 200,
+ response_body: 'Internal Server Error'
+ )
+
+ expect(delivery.response_code).to eq(500)
+ expect(delivery.success).to be false
+ end
+ end
+
+ context 'with timeout error' do
+ it 'records the timeout error' do
+ delivery.complete!(
+ execution_time: 30_000,
+ error_type: 'timeout',
+ request_errors: 'execution expired'
+ )
+
+ expect(delivery.response_code).to be_nil
+ expect(delivery.error_type).to eq('timeout')
+ expect(delivery.request_errors).to eq('execution expired')
+ expect(delivery.success).to be false
+ expect(delivery.delivered_at).to be_present
+ end
+ end
+
+ context 'with connection error' do
+ it 'records the connection error' do
+ delivery.complete!(
+ execution_time: 100,
+ error_type: 'connection_error',
+ request_errors: 'Connection refused'
+ )
+
+ expect(delivery.response_code).to be_nil
+ expect(delivery.error_type).to eq('connection_error')
+ expect(delivery.request_errors).to eq('Connection refused')
+ expect(delivery.success).to be false
+ expect(delivery.delivered_at).to be_present
+ end
+ end
+ end
+end
diff --git a/core/spec/models/spree/webhook_endpoint_spec.rb b/core/spec/models/spree/webhook_endpoint_spec.rb
new file mode 100644
index 0000000000..f5ab47ccbd
--- /dev/null
+++ b/core/spec/models/spree/webhook_endpoint_spec.rb
@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Spree::WebhookEndpoint, type: :model do
+ let(:store) { create(:store) }
+ let(:webhook_endpoint) { build(:webhook_endpoint, store: store) }
+
+ describe 'associations' do
+ it { is_expected.to belong_to(:store).class_name('Spree::Store').without_validating_presence }
+ it { is_expected.to have_many(:webhook_deliveries).class_name('Spree::WebhookDelivery').dependent(:destroy_async) }
+ end
+
+ describe 'validations' do
+ it { is_expected.to validate_presence_of(:store) }
+ it { is_expected.to validate_presence_of(:url) }
+
+ describe 'url format' do
+ it 'accepts valid https urls' do
+ webhook_endpoint.url = 'https://example.com/webhooks'
+ expect(webhook_endpoint).to be_valid
+ end
+
+ it 'accepts valid http urls' do
+ webhook_endpoint.url = 'http://example.com/webhooks'
+ expect(webhook_endpoint).to be_valid
+ end
+
+ it 'rejects invalid urls' do
+ webhook_endpoint.url = 'not-a-url'
+ expect(webhook_endpoint).not_to be_valid
+ expect(webhook_endpoint.errors[:url]).to be_present
+ end
+
+ it 'rejects ftp urls' do
+ webhook_endpoint.url = 'ftp://example.com/webhooks'
+ expect(webhook_endpoint).not_to be_valid
+ end
+ end
+
+ describe 'active inclusion' do
+ it 'accepts true' do
+ webhook_endpoint.active = true
+ expect(webhook_endpoint).to be_valid
+ end
+
+ it 'accepts false' do
+ webhook_endpoint.active = false
+ expect(webhook_endpoint).to be_valid
+ end
+
+ it 'rejects nil' do
+ webhook_endpoint.active = nil
+ expect(webhook_endpoint).not_to be_valid
+ end
+ end
+ end
+
+ describe 'scopes' do
+ let!(:active_endpoint) { create(:webhook_endpoint, store: store, active: true) }
+ let!(:inactive_endpoint) { create(:webhook_endpoint, :inactive, store: store) }
+
+ describe '.active' do
+ it 'returns only active endpoints' do
+ expect(described_class.active).to include(active_endpoint)
+ expect(described_class.active).not_to include(inactive_endpoint)
+ end
+ end
+
+ describe '.inactive' do
+ it 'returns only inactive endpoints' do
+ expect(described_class.inactive).to include(inactive_endpoint)
+ expect(described_class.inactive).not_to include(active_endpoint)
+ end
+ end
+ end
+
+ describe 'callbacks' do
+ describe 'before_create :generate_secret_key' do
+ it 'generates a secret key on create' do
+ endpoint = build(:webhook_endpoint, store: store, secret_key: nil)
+ endpoint.save!
+ expect(endpoint.secret_key).to be_present
+ expect(endpoint.secret_key.length).to eq(64)
+ end
+
+ it 'does not overwrite existing secret key' do
+ endpoint = build(:webhook_endpoint, store: store, secret_key: 'existing_key')
+ endpoint.save!
+ expect(endpoint.secret_key).to eq('existing_key')
+ end
+ end
+ end
+
+ describe '#subscribed_to?' do
+ context 'with empty subscriptions' do
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: []) }
+
+ it 'returns true for any event' do
+ expect(endpoint.subscribed_to?('order.created')).to be true
+ expect(endpoint.subscribed_to?('product.updated')).to be true
+ end
+ end
+
+ context 'with wildcard subscription' do
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: ['*']) }
+
+ it 'returns true for any event' do
+ expect(endpoint.subscribed_to?('order.created')).to be true
+ expect(endpoint.subscribed_to?('product.updated')).to be true
+ end
+ end
+
+ context 'with specific subscriptions' do
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: %w[order.created order.completed]) }
+
+ it 'returns true for subscribed events' do
+ expect(endpoint.subscribed_to?('order.created')).to be true
+ expect(endpoint.subscribed_to?('order.completed')).to be true
+ end
+
+ it 'returns false for non-subscribed events' do
+ expect(endpoint.subscribed_to?('order.updated')).to be false
+ expect(endpoint.subscribed_to?('product.created')).to be false
+ end
+ end
+
+ context 'with pattern subscriptions' do
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: ['order.*']) }
+
+ it 'matches events that fit the pattern' do
+ expect(endpoint.subscribed_to?('order.created')).to be true
+ expect(endpoint.subscribed_to?('order.completed')).to be true
+ expect(endpoint.subscribed_to?('order.updated')).to be true
+ end
+
+ it 'does not match events outside the pattern' do
+ expect(endpoint.subscribed_to?('product.created')).to be false
+ expect(endpoint.subscribed_to?('shipment.shipped')).to be false
+ end
+ end
+
+ context 'with mixed subscriptions' do
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: ['order.*', 'product.created']) }
+
+ it 'matches pattern events' do
+ expect(endpoint.subscribed_to?('order.created')).to be true
+ expect(endpoint.subscribed_to?('order.completed')).to be true
+ end
+
+ it 'matches exact events' do
+ expect(endpoint.subscribed_to?('product.created')).to be true
+ end
+
+ it 'does not match non-subscribed events' do
+ expect(endpoint.subscribed_to?('product.updated')).to be false
+ end
+ end
+ end
+
+ describe '#subscribed_events' do
+ context 'with empty subscriptions' do
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: []) }
+
+ it 'returns wildcard' do
+ expect(endpoint.subscribed_events).to eq(['*'])
+ end
+ end
+
+ context 'with specific subscriptions' do
+ let(:endpoint) { build(:webhook_endpoint, subscriptions: %w[order.created order.completed]) }
+
+ it 'returns the subscriptions' do
+ expect(endpoint.subscribed_events).to eq(%w[order.created order.completed])
+ end
+ end
+ end
+
+ describe 'soft delete' do
+ let!(:endpoint) { create(:webhook_endpoint, store: store) }
+
+ it 'soft deletes the record' do
+ endpoint.destroy
+ expect(endpoint.deleted_at).to be_present
+ expect(described_class.with_deleted.find(endpoint.id)).to eq(endpoint)
+ end
+ end
+end