+ <% events.each do |event| %>
+ <%= f.fields_for :events do |ff| %>
+
+
+
+ <% end %>
<% end %>
<% end %>
diff --git a/config/routes.rb b/config/routes.rb
index c2b6e762..a2d5af4b 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -81,6 +81,7 @@ Rails.application.routes.draw do
resources :submitters_autocomplete, only: %i[index]
resources :template_folders_autocomplete, only: %i[index]
resources :webhook_secret, only: %i[show update]
+ resources :webhook_preferences, only: %i[update]
resource :templates_upload, only: %i[create]
authenticated do
resource :templates_upload, only: %i[show], path: 'new'
diff --git a/db/migrate/20241028162000_add_secret_to_webhook_urls.rb b/db/migrate/20241028162000_add_secret_to_webhook_urls.rb
index 0befc646..5da2b6bd 100644
--- a/db/migrate/20241028162000_add_secret_to_webhook_urls.rb
+++ b/db/migrate/20241028162000_add_secret_to_webhook_urls.rb
@@ -1,7 +1,21 @@
# frozen_string_literal: true
class AddSecretToWebhookUrls < ActiveRecord::Migration[7.2]
+ class MigrationWebhookUrl < ApplicationRecord
+ self.table_name = 'webhook_urls'
+
+ serialize :secret, coder: JSON
+
+ encrypts :url, :secret
+ end
+
def change
add_column :webhook_urls, :secret, :text
+
+ MigrationWebhookUrl.all.each do |url|
+ url.update_columns(secret: {})
+ end
+
+ change_column_null :webhook_urls, :secret, false
end
end
diff --git a/db/migrate/20241029192232_populate_webhook_urls.rb b/db/migrate/20241029192232_populate_webhook_urls.rb
index 36c393db..cb8b5546 100644
--- a/db/migrate/20241029192232_populate_webhook_urls.rb
+++ b/db/migrate/20241029192232_populate_webhook_urls.rb
@@ -3,42 +3,45 @@
class PopulateWebhookUrls < ActiveRecord::Migration[7.2]
disable_ddl_transaction
- class MigrationWebhookUrl < ApplicationRecord
+ class MigrationWebhookUrl < ActiveRecord::Base
self.table_name = 'webhook_urls'
serialize :events, coder: JSON
serialize :secret, coder: JSON
- encrypts :url, :secret
- before_validation -> { self.sha1 = Digest::SHA1.hexdigest(url) }
+ encrypts :url, :secret
end
- class MigrationEncryptedConfig < ApplicationRecord
+ class MigrationEncryptedConfig < ActiveRecord::Base
self.table_name = 'encrypted_configs'
encrypts :value
serialize :value, coder: JSON
end
- class MigrationAccountConfig < ApplicationRecord
+ class MigrationAccountConfig < ActiveRecord::Base
self.table_name = 'account_configs'
serialize :value, coder: JSON
end
def up
- MigrationEncryptedConfig.joins('INNER JOIN accounts a ON a.id = encrypted_configs.account_id')
- .where(key: 'webhook_url')
- .find_each do |config|
- webhook_url = MigrationWebhookUrl.find_or_initialize_by(account_id: config.account_id, url: config.value)
- webhook_url.secret = MigrationEncryptedConfig.find_by(account_id: config.account_id, key: 'webhook_secret')&.value
-
- preferences = MigrationAccountConfig.find_by(account_id: config.account_id,
- key: 'webhook_preferences')&.value.to_h
+ MigrationEncryptedConfig.where(key: 'webhook_url').find_each do |config|
+ webhook_url = MigrationWebhookUrl.find_or_initialize_by(account_id: config.account_id,
+ sha1: Digest::SHA1.hexdigest(config.value))
+
+ webhook_url.secret =
+ MigrationEncryptedConfig.find_by(account_id: config.account_id, key: 'webhook_secret')&.value.to_h
+
+ preferences =
+ MigrationAccountConfig.find_by(account_id: config.account_id, key: 'webhook_preferences')&.value.to_h
+
events = %w[form.viewed form.started form.completed form.declined].reject { |event| preferences[event] == false }
+
events += preferences.compact_blank.keys
webhook_url.events = events.uniq
+ webhook_url.url = config.value
webhook_url.save!
end
diff --git a/db/schema.rb b/db/schema.rb
index 6521993d..92e6a982 100644
--- a/db/schema.rb
+++ b/db/schema.rb
@@ -367,7 +367,7 @@ ActiveRecord::Schema[7.2].define(version: 2024_10_29_192232) do
t.string "sha1", null: false
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
- t.text "secret"
+ t.text "secret", null: false
t.index ["account_id"], name: "index_webhook_urls_on_account_id"
t.index ["sha1"], name: "index_webhook_urls_on_sha1"
end
diff --git a/lib/submitters/submit_values.rb b/lib/submitters/submit_values.rb
index be32fb91..40e96618 100644
--- a/lib/submitters/submit_values.rb
+++ b/lib/submitters/submit_values.rb
@@ -14,9 +14,9 @@ module Submitters
unless submitter.submission_events.exists?(event_type: 'start_form')
SubmissionEvents.create_with_tracking_data(submitter, 'start_form', request)
- submitter.account.webhook_urls.with_event('form.started').each do |webhook_url|
- SendFormStartedWebhookRequestJob.perform_async({ 'submitter_id' => submitter.id,
- 'webhook_url_id' => webhook_url.id })
+ WebhookUrls.for_account_id(submitter.account_id, 'form.started').each do |webhook_url|
+ SendFormStartedWebhookRequestJob.perform_async('submitter_id' => submitter.id,
+ 'webhook_url_id' => webhook_url.id)
end
end
@@ -24,7 +24,7 @@ module Submitters
submitter.submission.save!
- ProcessSubmitterCompletionJob.perform_async({ 'submitter_id' => submitter.id }) if submitter.completed_at?
+ ProcessSubmitterCompletionJob.perform_async('submitter_id' => submitter.id) if submitter.completed_at?
submitter
end
diff --git a/lib/webhook_urls.rb b/lib/webhook_urls.rb
new file mode 100644
index 00000000..482e66a7
--- /dev/null
+++ b/lib/webhook_urls.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WebhookUrls
+ module_function
+
+ def for_account_id(account_id, events)
+ events = Array.wrap(events)
+
+ rel = WebhookUrl.where(account_id:)
+
+ event_arel = events.map { |event| Arel::Table.new(:webhook_urls)[:events].matches("%\"#{event}\"%") }.reduce(:or)
+
+ if Docuseal.multitenant?
+ rel.where(event_arel)
+ else
+ linked_account_rel =
+ AccountLinkedAccount.where(linked_account_id: account_id).where.not(account_type: :testing).select(:account_id)
+
+ webhook_urls = rel.or(WebhookUrl.where(account_id: linked_account_rel).where(event_arel))
+
+ account_urls, linked_urls = webhook_urls.partition { |w| w.account_id == account_id }
+
+ account_urls.select { |w| w.events.intersect?(events) }.presence ||
+ (account_urls.present? ? WebhookUrl.none : linked_urls)
+ end
+ end
+end
diff --git a/spec/jobs/send_form_completed_webhook_request_job_spec.rb b/spec/jobs/send_form_completed_webhook_request_job_spec.rb
index f9fd7cad..e4046cd9 100644
--- a/spec/jobs/send_form_completed_webhook_request_job_spec.rb
+++ b/spec/jobs/send_form_completed_webhook_request_job_spec.rb
@@ -56,14 +56,6 @@ RSpec.describe SendFormCompletedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the submitter doesn't exist" do
- expect do
- described_class.new.perform('submitter_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['form.declined'])
@@ -72,12 +64,6 @@ RSpec.describe SendFormCompletedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('submitter_id' => submitter.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_form_declined_webhook_request_job_spec.rb b/spec/jobs/send_form_declined_webhook_request_job_spec.rb
index e6900fca..be2872b2 100644
--- a/spec/jobs/send_form_declined_webhook_request_job_spec.rb
+++ b/spec/jobs/send_form_declined_webhook_request_job_spec.rb
@@ -56,14 +56,6 @@ RSpec.describe SendFormDeclinedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the submitter doesn't exist" do
- expect do
- described_class.new.perform('submitter_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['form.completed'])
@@ -72,12 +64,6 @@ RSpec.describe SendFormDeclinedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('submitter_id' => submitter.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_form_started_webhook_request_job_spec.rb b/spec/jobs/send_form_started_webhook_request_job_spec.rb
index 258e7274..3bff34eb 100644
--- a/spec/jobs/send_form_started_webhook_request_job_spec.rb
+++ b/spec/jobs/send_form_started_webhook_request_job_spec.rb
@@ -56,14 +56,6 @@ RSpec.describe SendFormStartedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the submitter doesn't exist" do
- expect do
- described_class.new.perform('submitter_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['form.declined'])
@@ -72,12 +64,6 @@ RSpec.describe SendFormStartedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('submitter_id' => submitter.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_form_viewed_webhook_request_job_spec.rb b/spec/jobs/send_form_viewed_webhook_request_job_spec.rb
index cb23dcaa..66e1accb 100644
--- a/spec/jobs/send_form_viewed_webhook_request_job_spec.rb
+++ b/spec/jobs/send_form_viewed_webhook_request_job_spec.rb
@@ -56,14 +56,6 @@ RSpec.describe SendFormViewedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the submitter doesn't exist" do
- expect do
- described_class.new.perform('submitter_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['form.started'])
@@ -72,12 +64,6 @@ RSpec.describe SendFormViewedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('submitter_id' => submitter.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_submission_archived_webhook_request_job_spec.rb b/spec/jobs/send_submission_archived_webhook_request_job_spec.rb
index 3753ece8..87970214 100644
--- a/spec/jobs/send_submission_archived_webhook_request_job_spec.rb
+++ b/spec/jobs/send_submission_archived_webhook_request_job_spec.rb
@@ -53,14 +53,6 @@ RSpec.describe SendSubmissionArchivedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the submission doesn't exist" do
- expect do
- described_class.new.perform('submission_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['submission.created'])
@@ -69,12 +61,6 @@ RSpec.describe SendSubmissionArchivedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_submission_completed_webhook_request_job_spec.rb b/spec/jobs/send_submission_completed_webhook_request_job_spec.rb
index 999ffbb5..f4ba884c 100644
--- a/spec/jobs/send_submission_completed_webhook_request_job_spec.rb
+++ b/spec/jobs/send_submission_completed_webhook_request_job_spec.rb
@@ -53,14 +53,6 @@ RSpec.describe SendSubmissionCompletedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the submission doesn't exist" do
- expect do
- described_class.new.perform('submission_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['submission.archived'])
@@ -69,12 +61,6 @@ RSpec.describe SendSubmissionCompletedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_submission_created_webhook_request_job_spec.rb b/spec/jobs/send_submission_created_webhook_request_job_spec.rb
index a3f804c1..ba635493 100644
--- a/spec/jobs/send_submission_created_webhook_request_job_spec.rb
+++ b/spec/jobs/send_submission_created_webhook_request_job_spec.rb
@@ -53,14 +53,6 @@ RSpec.describe SendSubmissionCreatedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the submission doesn't exist" do
- expect do
- described_class.new.perform('submission_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['submission.completed'])
@@ -69,12 +61,6 @@ RSpec.describe SendSubmissionCreatedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_template_created_webhook_request_job_spec.rb b/spec/jobs/send_template_created_webhook_request_job_spec.rb
index 83a36c48..f6a09ba6 100644
--- a/spec/jobs/send_template_created_webhook_request_job_spec.rb
+++ b/spec/jobs/send_template_created_webhook_request_job_spec.rb
@@ -52,14 +52,6 @@ RSpec.describe SendTemplateCreatedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the template doesn't exist" do
- expect do
- described_class.new.perform('template_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['template.updated'])
@@ -68,12 +60,6 @@ RSpec.describe SendTemplateCreatedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('template_id' => template.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/jobs/send_template_updated_webhook_request_job_spec.rb b/spec/jobs/send_template_updated_webhook_request_job_spec.rb
index bf463eca..58e46b63 100644
--- a/spec/jobs/send_template_updated_webhook_request_job_spec.rb
+++ b/spec/jobs/send_template_updated_webhook_request_job_spec.rb
@@ -52,14 +52,6 @@ RSpec.describe SendTemplateUpdatedWebhookRequestJob do
).once
end
- it "doesn't send a webhook request if the template doesn't exist" do
- expect do
- described_class.new.perform('template_id' => 100_500, 'webhook_url_id' => webhook_url.id)
- end.to raise_error ActiveRecord::RecordNotFound
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it "doesn't send a webhook request if the event is not in the webhook's events" do
webhook_url.update!(events: ['template.created'])
@@ -68,12 +60,6 @@ RSpec.describe SendTemplateUpdatedWebhookRequestJob do
expect(WebMock).not_to have_requested(:post, webhook_url.url)
end
- it "doesn't send a webhook request if the webhook doesn't exist" do
- described_class.new.perform('template_id' => template.id, 'webhook_url_id' => 100_500)
-
- expect(WebMock).not_to have_requested(:post, webhook_url.url)
- end
-
it 'sends again if the response status is 400 or higher' do
stub_request(:post, webhook_url.url).to_return(status: 401)
diff --git a/spec/system/webhook_settings_spec.rb b/spec/system/webhook_settings_spec.rb
index a6c1e214..a12b98f8 100644
--- a/spec/system/webhook_settings_spec.rb
+++ b/spec/system/webhook_settings_spec.rb
@@ -80,7 +80,7 @@ RSpec.describe 'Webhook Settings' do
visit settings_webhooks_path
- expect(webhook_url.secret).to be_nil
+ expect(webhook_url.secret).to eq({})
click_link 'Add Secret'