webhukhs 0.5.0

data/test/webhukhs_test.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "test_app"
+
+class TestWebhukhs < ActionDispatch::IntegrationTest
+  teardown { Webhukhs::ReceivedWebhook.delete_all }
+
+  def test_that_it_has_a_version_number
+    refute_nil ::Webhukhs::VERSION
+  end
+
+  def webhook_body
+    <<~JSON
+      {
+        "provider_id": "musterbank-flyio",
+        "starts_at": "<%= Time.now.utc %>",
+        "external_source": "The Forge Of Downtime",
+        "external_ticket_title": "DOWN-123",
+        "internal_description_markdown": "A test has failed"
+      }
+    JSON
+  end
+
+  self.app = WebhukhsTestApp
+
+  def self.xtest(msg)
+    test(msg) { skip }
+  end
+
+  test "ensure webhook is processed only once during creation" do
+    tf = Tempfile.new
+    body = {isValid: true, outputToFilename: tf.path}
+    body_json = body.to_json
+
+    assert_enqueued_jobs 1, only: Webhukhs::ProcessingJob do
+      post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
+      assert_response 200
+    end
+  end
+
+  test "accepts a webhook, stores and processes it" do
+    tf = Tempfile.new
+    body = {isValid: true, outputToFilename: tf.path}
+    body_json = body.to_json
+
+    post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
+    assert_response 200
+
+    webhook = Webhukhs::ReceivedWebhook.last!
+
+    assert_predicate webhook, :received?
+    assert_equal "WebhookTestHandler", webhook.handler_module_name
+    assert_equal webhook.status, "received"
+    assert_equal webhook.body, body_json
+
+    perform_enqueued_jobs
+    assert_predicate webhook.reload, :processed?
+    tf.rewind
+    assert_equal tf.read, body_json
+  end
+
+  test "accepts a webhook but does not process it if it is invalid" do
+    tf = Tempfile.new
+    body = {isValid: false, outputToFilename: tf.path}
+    body_json = body.to_json
+
+    post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
+    assert_response 200
+
+    webhook = Webhukhs::ReceivedWebhook.last!
+
+    assert_predicate webhook, :received?
+    assert_equal "WebhookTestHandler", webhook.handler_module_name
+    assert_equal webhook.status, "received"
+    assert_equal webhook.body, body_json
+
+    perform_enqueued_jobs
+    assert_predicate webhook.reload, :failed_validation?
+
+    tf.rewind
+    assert_predicate tf.read, :empty?
+  end
+
+  test "marks a webhook as errored if it raises during processing" do
+    tf = Tempfile.new
+    body = {isValid: true, raiseDuringProcessing: true, outputToFilename: tf.path}
+    body_json = body.to_json
+
+    post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
+    assert_response 200
+
+    webhook = Webhukhs::ReceivedWebhook.last!
+
+    assert_predicate webhook, :received?
+    assert_equal "WebhookTestHandler", webhook.handler_module_name
+    assert_equal webhook.status, "received"
+    assert_equal webhook.body, body_json
+
+    assert_raises(StandardError) { perform_enqueued_jobs }
+    assert_predicate webhook.reload, :error?
+
+    tf.rewind
+    assert_predicate tf.read, :empty?
+  end
+
+  test "does not accept a test payload that is larger than the configured maximum size" do
+    oversize = Webhukhs.configuration.request_body_size_limit + 1
+    utf8_junk = Base64.strict_encode64(Random.bytes(oversize))
+    body = {isValid: true, filler: utf8_junk, raiseDuringProcessing: false, outputToFilename: "/tmp/nothing"}
+    body_json = body.to_json
+
+    post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
+    assert_raises(ActiveRecord::RecordNotFound) { Webhukhs::ReceivedWebhook.last! }
+  end
+
+  test "does not try to process a webhook if it is not in `received' state" do
+    tf = Tempfile.new
+    body = {isValid: true, raiseDuringProcessing: true, outputToFilename: tf.path}
+    body_json = body.to_json
+
+    post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
+    assert_response 200
+
+    webhook = Webhukhs::ReceivedWebhook.last!
+    webhook.processing!
+
+    perform_enqueued_jobs
+    assert_predicate webhook.reload, :processing?
+
+    tf.rewind
+    assert_predicate tf.read, :empty?
+  end
+
+  test "raises an error if the service_id is not known" do
+    post "/webhukhs/missing_service", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+    assert_response 404
+  end
+
+  test "returns a 503 when a handler is inactive" do
+    post "/webhukhs/inactive", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+
+    assert_response 503
+    assert_equal 'Webhook handler "inactive" is inactive', response.parsed_body["error"]
+  end
+
+  test "returns a 200 status and error message if the handler does not expose errors" do
+    post "/webhukhs/failing-with-concealed-errors", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+
+    assert_response 200
+    assert_equal false, response.parsed_body["ok"]
+    assert response.parsed_body["error"]
+  end
+
+  test "returns a 500 status and error message if the handler does not expose errors" do
+    post "/webhukhs/failing-with-exposed-errors", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+
+    assert_response 500
+    # The response generation in this case is done by Rails, through the
+    # common Rails error page
+  end
+
+  test "deduplicates received webhooks based on the event ID" do
+    body = {event_id: SecureRandom.uuid, body: "test"}.to_json
+
+    assert_changes_by -> { Webhukhs::ReceivedWebhook.count }, exactly: 1 do
+      3.times do
+        post "/webhukhs/extract_id", params: body, headers: {"CONTENT_TYPE" => "application/json"}
+        assert_response 200
+      end
+    end
+  end
+
+  test "preserves the route params and the request params in the serialised request stored with the webhook" do
+    body = {user_name: "John", number_of_dependents: 14}.to_json
+
+    Webhukhs::ReceivedWebhook.delete_all
+    post "/per-user-webhukhs/123/private", params: body, headers: {"CONTENT_TYPE" => "application/json"}
+    assert_response 200
+
+    received_webhook = Webhukhs::ReceivedWebhook.first!
+    assert_predicate received_webhook, :received?
+    assert_equal body, received_webhook.request.body.read
+    assert_equal "John", received_webhook.request.params["user_name"]
+    assert_equal 14, received_webhook.request.params["number_of_dependents"]
+    assert_equal "123", received_webhook.request.params["user_id"]
+  end
+
+  test "erroneous webhook could be processed again" do
+    webhook = Webhukhs::ReceivedWebhook.create(
+      handler_event_id: "test",
+      handler_module_name: "WebhookTestHandler",
+      status: "error",
+      body: {isValid: true}.to_json
+    )
+
+    assert_enqueued_jobs 1, only: Webhukhs::ProcessingJob do
+      webhook.received!
+
+      assert_equal "received", webhook.status
+    end
+  end
+end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: webhukhs
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Stanislav Katkov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: state_machine_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: magic_frozen_string_literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Webhukhs is a Rails engine for processing webhooks from various services.
+  Engine saves webhook in database first and later processes webhook in async process.
+  Supports custom handlers with Webhukhs::BaseHandler and integrates with Rails common
+  error reporter.
+email:
+- github@skatkov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- ".standard.yml"
+- Appraisals
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- config/routes.rb
+- example/.gitattributes
+- example/.gitignore
+- example/.ruby-version
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.md
+- example/Rakefile
+- example/app/assets/images/.keep
+- example/app/assets/stylesheets/application.css
+- example/app/controllers/application_controller.rb
+- example/app/controllers/concerns/.keep
+- example/app/helpers/application_helper.rb
+- example/app/models/application_record.rb
+- example/app/models/concerns/.keep
+- example/app/views/layouts/application.html.erb
+- example/app/webhooks/webhook_test_handler.rb
+- example/bin/bundle
+- example/bin/rails
+- example/bin/rake
+- example/bin/setup
+- example/config.ru
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/credentials.yml.enc
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/assets.rb
+- example/config/initializers/content_security_policy.rb
+- example/config/initializers/filter_parameter_logging.rb
+- example/config/initializers/generators.rb
+- example/config/initializers/inflections.rb
+- example/config/initializers/permissions_policy.rb
+- example/config/initializers/webhukhs.rb
+- example/config/locales/en.yml
+- example/config/puma.rb
+- example/config/routes.rb
+- example/db/migrate/20240523125859_create_webhukhs_tables.rb
+- example/db/schema.rb
+- example/db/seeds.rb
+- example/lib/assets/.keep
+- example/lib/tasks/.keep
+- example/log/.keep
+- example/public/404.html
+- example/public/422.html
+- example/public/500.html
+- example/public/apple-touch-icon-precomposed.png
+- example/public/apple-touch-icon.png
+- example/public/favicon.ico
+- example/public/robots.txt
+- example/test/controllers/.keep
+- example/test/fixtures/files/.keep
+- example/test/helpers/.keep
+- example/test/integration/.keep
+- example/test/models/.keep
+- example/test/test_helper.rb
+- example/tmp/.keep
+- example/tmp/pids/.keep
+- example/vendor/.keep
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.1.gemfile.lock
+- gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.0.gemfile.lock
+- gemfiles/rails_8.1.gemfile
+- gemfiles/rails_8.1.gemfile.lock
+- handler-examples/customer_io_handler.rb
+- handler-examples/revolut_business_v1_handler.rb
+- handler-examples/revolut_business_v2_handler.rb
+- handler-examples/starling_payments_handler.rb
+- lib/tasks/webhukhs_tasks.rake
+- lib/webhukhs.rb
+- lib/webhukhs/base_handler.rb
+- lib/webhukhs/controllers/receive_webhooks_controller.rb
+- lib/webhukhs/engine.rb
+- lib/webhukhs/install_generator.rb
+- lib/webhukhs/jobs/processing_job.rb
+- lib/webhukhs/models/received_webhook.rb
+- lib/webhukhs/templates/add_headers_to_webhukhs_webhooks.rb.erb
+- lib/webhukhs/templates/create_webhukhs_tables.rb.erb
+- lib/webhukhs/templates/webhukhs.rb
+- lib/webhukhs/version.rb
+- test/test-webhook-handlers/.DS_Store
+- test/test-webhook-handlers/extract_id_handler.rb
+- test/test-webhook-handlers/failing_with_concealed_errors.rb
+- test/test-webhook-handlers/failing_with_exposed_errors.rb
+- test/test-webhook-handlers/inactive_handler.rb
+- test/test-webhook-handlers/invalid_handler.rb
+- test/test-webhook-handlers/private_handler.rb
+- test/test-webhook-handlers/webhook_test_handler.rb
+- test/test_app.rb
+- test/test_helper.rb
+- test/webhukhs_test.rb
+homepage: https://github.com/skatkov/webhukhs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/skatkov/webhukhs
+  source_code_uri: https://github.com/skatkov/webhukhs
+  changelog_uri: https://github.com/skatkov/webhukhs/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.1
+specification_version: 4
+summary: Webhooks processing engine for Rails applications
+test_files: []