webhukhs 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3649db576ac151f62fa71f5e929d9b62f9a7dcbbff4c9b831e67fc4141e6524
-  data.tar.gz: 6d1fa28e296c7449e1c5a55b7f0758f043ff1b3c66098cd16c0e9a55db9d3f16
+  metadata.gz: ac61cd0cbe0da35c7a6ad5f2be48cfff0dae74f712ce215eee4e3577fb3ce864
+  data.tar.gz: a27c3a7d108b70ddf72a073fba8333641e14530d9afea09e720c54b2ffd41867
 SHA512:
-  metadata.gz: 2c05c1b968a0ac107f3366e9d07903a460da24c1d835c9d60e94948e7cd46946d9f067c733433c18fc092a80c2bf0c1eabee4c6d161a6ec2779bc5ccc30214a9
-  data.tar.gz: 211a266f0ff4951265f2d568427c034010f9367c5a9a0cf653d767457fa9a57b2da0c45b98c2b534015a2e58900e8592d71342accfd247b888060f4f8e54f8c0
+  metadata.gz: b09a61434f3b2b92edd9d5774363f29556f790963bd31e6e93684284cd03395685f1d61f5cb2477bf268168d31ce1cb6ab95da5b6c234e28d98a010fa14cebb9
+  data.tar.gz: ebb82e8c71c7e449a76bbf87e0db2c3c8350ae7ad85f2ba13708af3cef6554805d1e759310c46da9f78e08db49441e991740d9eb301155eee5b9a33c12768e5d

data/CHANGELOG.md

@@ -5,8 +5,16 @@ This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## Unreleased
 
+## 0.6.0
+
+### Changed
+- ProcessingJob to discard job and report an error on DeserializationError
+- ProcessingJob to handle nil or wrong class argument gracefully
+- Ensure that ID is always generated for ReceivedWebhook model
+
 ## 0.5.0
 
+### Changed
 - Forked from [munster](https://github.com/cheddar-me/munster) and renamed to webhukhs
 - Changed GitHub repository to https://github.com/skatkov/webhukhs
 - Testing against rails 7.1, rails 8.0 and rails 8.1

data/lib/webhukhs/jobs/processing_job.rb

@@ -4,8 +4,27 @@ require "active_job/railtie"
 
 module Webhukhs
   class ProcessingJob < ActiveJob::Base
+    class InvalidWebhookArgument < StandardError; end
+
+    discard_on ActiveJob::DeserializationError do |job, error|
+      Rails.error.report(error, context: {
+        job_id: job.job_id,
+        arguments: job.arguments.map(&:inspect)
+      }, severity: :error)
+    end
+
+    discard_on InvalidWebhookArgument do |job, error|
+      Rails.error.report(error, context: {
+        job_id: job.job_id,
+        arguments: job.arguments.map(&:inspect)
+      }, severity: :error)
+    end
+
     def perform(webhook)
-      Rails.error.set_context(webhukhs_handler_module_name: webhook.handler_module_name, **Webhukhs.configuration.error_context)
+      raise InvalidWebhookArgument, "ProcessingJob received nil webhook argument" if webhook.nil?
+      unless webhook.is_a?(Webhukhs::ReceivedWebhook)
+        raise InvalidWebhookArgument, "ProcessingJob expected Webhukhs::ReceivedWebhook, got #{webhook.class}"
+      end
 
       webhook_details_for_logs = "Webhukhs::ReceivedWebhook#%s (handler: %s)" % [webhook.id, webhook.handler]
       webhook.with_lock do

data/lib/webhukhs/models/received_webhook.rb

@@ -9,6 +9,8 @@ module Webhukhs
 
     include StateMachineEnum
 
+    before_create :ensure_id
+
     state_machine_enum :status do |s|
       s.permit_transition(:received, :processing)
       s.permit_transition(:processing, :failed_validation)
@@ -95,5 +97,21 @@ module Webhukhs
     def handler
       handler_module_name.constantize.new
     end
+
+    private
+
+    def ensure_id
+      return if id.present?
+      # let DB auto-increment handle it
+      return if self.class.columns_hash["id"].type == :integer
+
+      self.id = if SecureRandom.respond_to?(:uuid_v7)
+        # Requires Ruby 3.3+. This is preferred approach for time-sortable id's.
+        SecureRandom.uuid_v7
+      else
+        # Ruby < 3.2 fallback - uuid v4
+        SecureRandom.uuid
+      end
+    end
   end
 end

data/lib/webhukhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Webhukhs
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/test/processing_job_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require_relative "test_app"
+
+class ProcessingJobTest < ActiveJob::TestCase
+  teardown { Webhukhs::ReceivedWebhook.delete_all }
+
+  test "discards job and reports error when webhook argument is nil" do
+    assert_error_reported(Webhukhs::ProcessingJob::InvalidWebhookArgument) do
+      Webhukhs::ProcessingJob.perform_now(nil)
+    end
+
+    assert_no_enqueued_jobs only: Webhukhs::ProcessingJob
+  end
+
+  test "discards job and reports error when webhook argument is not a ReceivedWebhook" do
+    assert_error_reported(Webhukhs::ProcessingJob::InvalidWebhookArgument) do
+      Webhukhs::ProcessingJob.perform_now("not a webhook")
+    end
+
+    assert_no_enqueued_jobs only: Webhukhs::ProcessingJob
+  end
+
+  test "discards job and reports error when webhook record has been deleted (DeserializationError)" do
+    webhook = Webhukhs::ReceivedWebhook.create!(
+      handler_event_id: "deserialization-test",
+      handler_module_name: "WebhookTestHandler",
+      status: "received",
+      body: {isValid: true}.to_json
+    )
+
+    Webhukhs::ProcessingJob.perform_later(webhook)
+    webhook.destroy!
+
+    assert_error_reported(ActiveJob::DeserializationError) do
+      perform_enqueued_jobs
+    end
+
+    assert_no_enqueued_jobs only: Webhukhs::ProcessingJob
+  end
+end

data/test/webhukhs_test.rb

@@ -200,4 +200,16 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
       assert_equal "received", webhook.status
     end
   end
+
+  test "ensure_id does not override id for integer primary key columns" do
+    webhook = Webhukhs::ReceivedWebhook.create!(
+      handler_event_id: SecureRandom.uuid,
+      handler_module_name: "WebhookTestHandler",
+      status: "received",
+      body: {isValid: true}.to_json
+    )
+
+    assert_kind_of Integer, webhook.id
+    assert webhook.id > 0
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webhukhs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stanislav Katkov
@@ -209,6 +209,7 @@ files:
 - lib/webhukhs/templates/create_webhukhs_tables.rb.erb
 - lib/webhukhs/templates/webhukhs.rb
 - lib/webhukhs/version.rb
+- test/processing_job_test.rb
 - test/test-webhook-handlers/.DS_Store
 - test/test-webhook-handlers/extract_id_handler.rb
 - test/test-webhook-handlers/failing_with_concealed_errors.rb