From 09849acd2f62fe2e50a3506bacec93de806a17bc Mon Sep 17 00:00:00 2001
From: Pete Matsyburka <pete@docuseal.com>
Date: Mon, 10 Mar 2025 18:27:35 +0200
Subject: [PATCH] add submission.expired webhook

---
 app/jobs/process_submission_expired_job.rb    | 19 ++++++++++++
 ..._submission_expired_webhook_request_job.rb | 31 +++++++++++++++++++
 app/models/webhook_url.rb                     |  6 ++--
 lib/submissions/create_from_submitters.rb     | 18 +++++++++--
 4 files changed, 69 insertions(+), 5 deletions(-)
 create mode 100644 app/jobs/process_submission_expired_job.rb
 create mode 100644 app/jobs/send_submission_expired_webhook_request_job.rb

diff --git a/app/jobs/process_submission_expired_job.rb b/app/jobs/process_submission_expired_job.rb
new file mode 100644
index 00000000..99bee5e8
--- /dev/null
+++ b/app/jobs/process_submission_expired_job.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class ProcessSubmissionExpiredJob
+  include Sidekiq::Job
+
+  def perform(params = {})
+    submission = Submission.find(params['submission_id'])
+
+    return if submission.archived_at?
+    return if submission.template.archived_at?
+    return if submission.submitters.where.not(declined_at: nil).exists?
+    return unless submission.submitters.exists?(completed_at: nil)
+
+    WebhookUrls.for_account_id(submission.account_id, %w[submission.expired]).each do |webhook|
+      SendSubmissionExpiredWebhookRequestJob.perform_async('submission_id' => submission.id,
+                                                           'webhook_url_id' => webhook.id)
+    end
+  end
+end
diff --git a/app/jobs/send_submission_expired_webhook_request_job.rb b/app/jobs/send_submission_expired_webhook_request_job.rb
new file mode 100644
index 00000000..c2a5691b
--- /dev/null
+++ b/app/jobs/send_submission_expired_webhook_request_job.rb
@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class SendSubmissionExpiredWebhookRequestJob
+  include Sidekiq::Job
+
+  sidekiq_options queue: :webhooks
+
+  MAX_ATTEMPTS = 10
+
+  def perform(params = {})
+    submission = Submission.find(params['submission_id'])
+    webhook_url = WebhookUrl.find(params['webhook_url_id'])
+
+    attempt = params['attempt'].to_i
+
+    return if webhook_url.url.blank? || webhook_url.events.exclude?('submission.expired')
+
+    resp = SendWebhookRequest.call(webhook_url, event_type: 'submission.expired',
+                                                data: Submissions::SerializeForApi.call(submission))
+
+    if (resp.nil? || resp.status.to_i >= 400) && attempt <= MAX_ATTEMPTS &&
+       (!Docuseal.multitenant? || submission.account.account_configs.exists?(key: :plan))
+      SendSubmissionExpiredWebhookRequestJob.perform_in((2**attempt).minutes, {
+                                                          'submission_id' => submission.id,
+                                                          'webhook_url_id' => webhook_url.id,
+                                                          'attempt' => attempt + 1,
+                                                          'last_status' => resp&.status.to_i
+                                                        })
+    end
+  end
+end
diff --git a/app/models/webhook_url.rb b/app/models/webhook_url.rb
index 011bf5a1..1ee046cb 100644
--- a/app/models/webhook_url.rb
+++ b/app/models/webhook_url.rb
@@ -28,10 +28,12 @@ class WebhookUrl < ApplicationRecord
     form.started
     form.completed
     form.declined
-    template.created
-    template.updated
     submission.created
+    submission.completed
+    submission.expired
     submission.archived
+    template.created
+    template.updated
   ].freeze
 
   belongs_to :account
diff --git a/lib/submissions/create_from_submitters.rb b/lib/submissions/create_from_submitters.rb
index 083c3573..dfcfb372 100644
--- a/lib/submissions/create_from_submitters.rb
+++ b/lib/submissions/create_from_submitters.rb
@@ -6,11 +6,11 @@ module Submissions
 
     module_function
 
-    # rubocop:disable Metrics/BlockLength
+    # rubocop:disable Metrics
     def call(template:, user:, submissions_attrs:, source:, submitters_order:, params: {})
       preferences = Submitters.normalize_preferences(user.account, user, params)
 
-      Array.wrap(submissions_attrs).filter_map do |attrs|
+      submissions = Array.wrap(submissions_attrs).filter_map do |attrs|
         submission_preferences = Submitters.normalize_preferences(user.account, user, attrs)
         submission_preferences = preferences.merge(submission_preferences)
 
@@ -51,8 +51,20 @@ module Submissions
 
         submission.tap(&:save!)
       end
+
+      maybe_enqueue_expire_at(submissions)
+
+      submissions
+    end
+    # rubocop:enable Metrics
+
+    def maybe_enqueue_expire_at(submissions)
+      submissions.each do |submission|
+        next unless submission.expire_at?
+
+        ProcessSubmissionExpiredJob.perform_in(submission.expire_at, 'submission_id' => submission.id)
+      end
     end
-    # rubocop:enable Metrics/BlockLength
 
     def maybe_add_invite_submitters(submission, template)
       template.submitters.each_with_index do |item, index|