Back to Repositories

Testing Webhook Notification System for Submission Events in DocuSeal

This test suite validates the webhook notification system for submission creation events in DocuSeal. It ensures proper handling of webhook requests, authentication, and retry mechanisms for failed deliveries.

Test Coverage Overview

The test suite provides comprehensive coverage of the SendSubmissionCreatedWebhookRequestJob functionality.

Validates basic webhook request sending with correct payload structure
Tests secret header authentication
Verifies event filtering logic
Examines retry behavior for failed requests
Confirms maximum retry attempt limitations

Implementation Analysis

The testing approach utilizes RSpec’s behavior-driven development patterns with factory-based test data setup.

Key implementation aspects include:

WebMock for HTTP request stubbing
Factory-based test data generation
Isolated test scenarios with proper setup/teardown
Dynamic payload verification using regex matchers

Technical Details

Testing infrastructure includes:

RSpec as the testing framework
WebMock for HTTP request mocking
FactoryBot for test data generation
Rails test helpers for database interaction
JSON schema validation for API responses

Best Practices Demonstrated

The test suite exemplifies several testing best practices for webhook implementations.

Isolated test scenarios with proper setup
Comprehensive edge case coverage
Explicit verification of request headers and payload
Clear test organization and naming
Proper mocking of external service calls

docusealco/docuseal

spec/jobs/send_submission_created_webhook_request_job_spec.rb

            
# frozen_string_literal: true

require 'rails_helper'

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

  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.created',
          'timestamp' => /.*/,
          'data' => JSON.parse(Submissions::SerializeForApi.call(submission.reload).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.created',
          'timestamp' => /.*/,
          'data' => JSON.parse(Submissions::SerializeForApi.call(submission.reload).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.completed'])

      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