Back to Repositories

Testing Submission Archive Webhook Processing in DocuSeal

This test suite validates the SendSubmissionArchivedWebhookRequestJob functionality in DocuSeal, focusing on webhook request handling for archived submissions. The tests ensure proper webhook delivery, secret handling, and retry mechanisms for failed requests.

Test Coverage Overview

The test suite provides comprehensive coverage of webhook request handling for archived submissions.

Key areas tested include:

Basic webhook request sending with correct payload and headers
Secret header handling in webhook requests
Event filtering based on webhook configuration
Retry mechanism for failed requests
Maximum retry attempt handling

Implementation Analysis

The testing approach utilizes RSpec’s behavior-driven development patterns with factory-based test data setup. The implementation leverages WebMock for HTTP request stubbing and uses let blocks for efficient test data management.

The tests demonstrate proper use of RSpec’s expectation syntax and WebMock’s request matching capabilities for precise verification of HTTP requests.

Technical Details

Testing tools and configuration:

RSpec as the testing framework
WebMock for HTTP request stubbing
FactoryBot for test data generation
Rails test helpers for database interaction
Encrypted configuration setup for e-sign certificates

Best Practices Demonstrated

The test suite exemplifies several testing best practices.

Notable practices include:

Isolated test scenarios with proper setup and teardown
Comprehensive edge case coverage
Clear test descriptions using RSpec’s descriptive syntax
Proper mocking of external HTTP requests
Efficient test data setup using factories

docusealco/docuseal

spec/jobs/send_submission_archived_webhook_request_job_spec.rb

            
# frozen_string_literal: true

require 'rails_helper'

RSpec.describe SendSubmissionArchivedWebhookRequestJob do
  let(:account) { create(:account) }
  let(:user) { create(:user, account:) }
  let(:template) { create(:template, account:, author: user) }
  let(:submission) { create(:submission, template:, created_by_user: user) }
  let(:webhook_url) { create(:webhook_url, account:, events: ['submission.archived']) }

  before do
    create(:encrypted_config, key: EncryptedConfig::ESIGN_CERTS_KEY,
                              value: GenerateCertificate.call.transform_values(&:to_pem))
  end

  describe '#perform' do
    before do
      stub_request(:post, webhook_url.url).to_return(status: 200)
    end

    it 'sends a webhook request' do
      described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => webhook_url.id)

      expect(WebMock).to have_requested(:post, webhook_url.url).with(
        body: {
          'event_type' => 'submission.archived',
          'timestamp' => /.*/,
          'data' => JSON.parse(submission.reload.as_json(only: %i[id archived_at]).to_json)
        },
        headers: {
          'Content-Type' => 'application/json',
          'User-Agent' => 'DocuSeal.com Webhook'
        }
      ).once
    end

    it 'sends a webhook request with the secret' do
      webhook_url.update(secret: { 'X-Secret-Header' => 'secret_value' })
      described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => webhook_url.id)

      expect(WebMock).to have_requested(:post, webhook_url.url).with(
        body: {
          'event_type' => 'submission.archived',
          'timestamp' => /.*/,
          'data' => JSON.parse(submission.reload.as_json(only: %i[id archived_at]).to_json)
        },
        headers: {
          'Content-Type' => 'application/json',
          'User-Agent' => 'DocuSeal.com Webhook',
          'X-Secret-Header' => 'secret_value'
        }
      ).once
    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'])

      described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => webhook_url.id)

      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)

      expect do
        described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => webhook_url.id)
      end.to change(described_class.jobs, :size).by(1)

      expect(WebMock).to have_requested(:post, webhook_url.url).once

      args = described_class.jobs.last['args'].first

      expect(args['attempt']).to eq(1)
      expect(args['last_status']).to eq(401)
      expect(args['webhook_url_id']).to eq(webhook_url.id)
      expect(args['submission_id']).to eq(submission.id)
    end

    it "doesn't send again if the max attempts is reached" do
      stub_request(:post, webhook_url.url).to_return(status: 401)

      expect do
        described_class.new.perform('submission_id' => submission.id, 'webhook_url_id' => webhook_url.id,
                                    'attempt' => 11)
      end.not_to change(described_class.jobs, :size)

      expect(WebMock).to have_requested(:post, webhook_url.url).once
    end
  end
end