sidekiq-amigo 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53361c37c9ec31b3886fb7b33ff61bd022802128b458f93e624c4f0d0cbcc963
-  data.tar.gz: 54a9e75e5b011d6441b8906404a0d856394e19c4d27e66e7580c37d4928e3d41
+  metadata.gz: 56470f3e16978212a6e8a23d970c7709c0f24854b80c15d522989389e0cc829e
+  data.tar.gz: 2bed22f2a190e056aa715814f460ba009fd2c2d3884e6d34eb866084659af962
 SHA512:
-  metadata.gz: b469583cc5c2e339d359834763d3a67c154e9977212b35f039623f937b4b55997b7a523ba8f5c414898295c18c65d401a020b9679c4d695c50d636ef5c7334db
-  data.tar.gz: ab70f5da69a2bb8868c9ec864c760eb1d6fc124a99d71e2ad332a8dccd7ba8503971dfb0ee3a60d19d122e5ce079b5f9a4dc6a5a3df2a8c05057b19f2963c172
+  metadata.gz: 18ac44e7cffa487844980f937193ac4601585e380aa08c85599591181271e3ded429271be3407d120e0bf280c541c0f9c28ca23c2c5e9a528deda26c16ca8735
+  data.tar.gz: 243229bf9a1f661eb6ef4b9fe847a979634fa729df34e756016f6f2c403ae1e8f73d444e437e640b86d300e38169a391b72f1676a49e985aeac11d41684c4974

data/lib/amigo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Amigo
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/amigo.rb

@@ -140,7 +140,18 @@ module Amigo
     # An Array of callbacks to be run when an event is published.
     attr_accessor :subscribers
 
-    # A single callback to be run when an event publication errors.
+    # A single callback to be run when an event publication errors,
+    # almost always due to an error in a subscriber.
+    #
+    # The callback receives the exception, the event being published, and the erroring subscriber.
+    #
+    # If this is not set, errors from subscribers will be re-raised immediately,
+    # since broken subscribers usually indicate a broken application.
+    #
+    # Note also that when an error occurs, Amigo.log is always called first.
+    # You do NOT need a callback that just logs and swallows the error.
+    # If all you want to do is log, and not propogate the error,
+    # you can use `Amigo.on_publish_error = proc {}`.
     attr_accessor :on_publish_error
 
     # Publish an event with the specified +eventname+ and +payload+
@@ -151,12 +162,18 @@ module Amigo
       self.subscribers.to_a.each do |hook|
         hook.call(ev)
       rescue StandardError => e
-        self.log(nil, :error, "amigo_subscriber_hook_error", error: e, hook: hook, event: ev)
-        self.on_publish_error.call(e)
+        self.log(nil, :error, "amigo_subscriber_hook_error", error: e, hook: hook, event: ev&.as_json)
+        raise e if self.on_publish_error.nil?
+        if self.on_publish_error.respond_to?(:arity) && self.on_publish_error.arity == 1
+          self.on_publish_error.call(e)
+        else
+          self.on_publish_error.call(e, ev, hook)
+        end
       end
     end
 
     # Register a hook to be called when an event is sent.
+    # If a subscriber errors, on_publish_error is called with the exception, event, and subscriber.
     def register_subscriber(&block)
       raise LocalJumpError, "no block given" unless block
       self.log nil, :info, "amigo_installed_subscriber", block: block
@@ -191,7 +208,15 @@ module Amigo
 
     def _subscriber(event)
       event_json = event.as_json
-      self.audit_logger_class.perform_async(event_json)
+      begin
+        self.audit_logger_class.perform_async(event_json)
+      rescue StandardError => e
+        # If the audit logger cannot perform, let's say because Redis is down,
+        # we can run the job manually. This is pretty important for anything used for auditing;
+        # it should be as resilient as possible.
+        self.log(nil, :error, "amigo_audit_log_subscriber_error", error: e, event: event_json)
+        self.audit_logger_class.new.perform(event_json)
+      end
       self.router_class.perform_async(event_json)
     end
 
@@ -272,7 +297,6 @@ Amigo.reset_logging
 Amigo.synchronous_mode = false
 Amigo.registered_jobs = []
 Amigo.subscribers = Set.new
-Amigo.on_publish_error = proc {}
 
 require "amigo/audit_logger"
 require "amigo/router"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-amigo
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Lithic Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq