sidekiq-amigo 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dc6d4ac6f9e7a89afecc711780ceeeb3ab1204435a19be2683623256b2abc49
-  data.tar.gz: 725dc4719b949d5f93bd84125ed6d2bea713be872f7e8413e6509d90c9090544
+  metadata.gz: 56470f3e16978212a6e8a23d970c7709c0f24854b80c15d522989389e0cc829e
+  data.tar.gz: 2bed22f2a190e056aa715814f460ba009fd2c2d3884e6d34eb866084659af962
 SHA512:
-  metadata.gz: e1a5e2c7beab44fecabb7d7b7f9f610ce1138029eb247b46c04d90399550d976990f6db36717c73f225c195318ea303b1607984878167dfac4087024e809c735
-  data.tar.gz: 807e4c88665fd4ac7a6a4004e654de2a697b4ebd7c90546be7f965955ecd84690f2e0f5eebe913d31e2673f32f7bbd560e05695f79154284f3d7bd8a6ee77eb9
+  metadata.gz: 18ac44e7cffa487844980f937193ac4601585e380aa08c85599591181271e3ded429271be3407d120e0bf280c541c0f9c28ca23c2c5e9a528deda26c16ca8735
+  data.tar.gz: 243229bf9a1f661eb6ef4b9fe847a979634fa729df34e756016f6f2c403ae1e8f73d444e437e640b86d300e38169a391b72f1676a49e985aeac11d41684c4974

data/lib/amigo/spec_helpers.rb

@@ -16,18 +16,28 @@ module Amigo
     end
 
     module_function def snapshot_async_state(opts={})
-      old_hooks = Amigo.subscribers.to_a
+      old_subscribers = Amigo.subscribers.to_a
       old_jobs = Amigo.registered_jobs.to_a
       old_failure = Amigo.on_publish_error
 
+      new_subscribers = opts.fetch(:subscribers, [])
+      new_jobs = opts.fetch(:jobs, [])
+
+      @active_snapshots ||= 0
+      if @active_snapshots.positive?
+        new_subscribers = old_subscribers + new_subscribers
+        new_jobs = old_jobs = new_jobs
+      end
       begin
         Amigo.on_publish_error = opts[:on_error] if opts.key?(:on_error)
-        Amigo.subscribers.replace(opts[:subscribers]) if opts.key?(:subscribers)
-        Amigo.registered_jobs.replace(opts[:jobs]) if opts.key?(:jobs)
+        Amigo.subscribers.replace(new_subscribers) if opts.key?(:subscribers)
+        Amigo.registered_jobs.replace(new_jobs) if opts.key?(:jobs)
+        @active_snapshots += 1
         yield
       ensure
+        @active_snapshots -= 1
         Amigo.on_publish_error = old_failure
-        Amigo.subscribers.replace(old_hooks)
+        Amigo.subscribers.replace(old_subscribers)
         Amigo.registered_jobs.replace(old_jobs)
       end
     end

data/lib/amigo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Amigo
-  VERSION = "1.2.1"
+  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
 
@@ -217,6 +242,14 @@ module Amigo
   end
 
   class Event
+    # @param topic [String]
+    # @param payload [Array]
+    # @return [Webhookdb::Event]
+    def self.create(topic, payload)
+      return self.new(SecureRandom.uuid, topic, payload)
+    end
+
+    # @return [Webhookdb::Event]
     def self.from_json(o)
       return self.new(o["id"], o["name"], o["payload"])
     end
@@ -252,25 +285,11 @@ module Amigo
     end
 
     protected def safe_stringify(o)
-      return self.deep_stringify_keys(o) if o.is_a?(Hash)
+      return o.utc.strftime("%Y-%m-%dT%H:%M:%S.%LZ") if o.is_a?(Time)
+      return o.each_with_object({}) { |(k, v), m| m[k.to_s] = safe_stringify(v) } if o.is_a?(Hash)
+      return o.map { |x| safe_stringify(x) } if o.is_a?(Array)
       return o
     end
-
-    def deep_stringify_keys(hash)
-      stringified_hash = {}
-      hash.each do |k, v|
-        stringified_hash[k.to_s] =
-          case v
-            when Hash
-              self.deep_stringify_keys(v)
-            when Array
-              v.map { |i| i.is_a?(Hash) ? self.deep_stringify_keys(i) : i }
-          else
-              v
-          end
-      end
-      stringified_hash
-    end
   end
 end
 
@@ -278,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.1
+  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