ears 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d26c2fc5a7c55ba2a002cb8137232e06168e84d79a37b3d4f25f404304ce7cbe
-  data.tar.gz: 002ba87fc6d46b3ec4f0b9ed12626b1f3b13d2a41b44685416a329a65d1d20b8
+  metadata.gz: 03d47d36ce7244fbb253f4950fc280042f2ef3be7b6052d555ab2921fe930b9c
+  data.tar.gz: dddb56eb6b95f75b3689ee8f67e23834a6be29f984406264cdaea8c92ff177cb
 SHA512:
-  metadata.gz: 05cae7fcff052959abf699b26d02f5024f2ef00793d0424f98f899efc9ceb898b8188c08b63671239663a9bdd950b359a9abe5697318347b4c4f58b3ee9561d7
-  data.tar.gz: 84a75eafa821fba5550bc1a2cc020b49b460473fee2cf0de8bba7b5520e74dca7734505e44996e40515c89b33fe1e7a73dfa6849d48eb67feee31820eab5746a
+  metadata.gz: ae5847aa47d96b2985df45b19df83e647e574e9a80217f300256bbeff784b9b80e03f58e5f93c24855b99c7f3042d0e8e51be4dd0855367478f402608fcba474
+  data.tar.gz: e2ac184be4bdc3da18ca3c2deaf0d54ad68e711efb1bec609af77167a0266becad721ba69d37e4aa5f162f7b6c31deeb7a20f12a60eaa12fc108b794f3a70a34

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.8.0 (2022-04-08)
+
+- JSON middleware now requires an `on_error` callback in the options
+
+## 0.7.2 (2022-02-24)
+
+- change retry middleware to gracefully handle messages that do not have a header in their metadata
+
+## 0.7.1 (2021-12-21)
+
+- explicitly report Appsignal errors in middleware to make it more reliable
+
 ## 0.7.0 (2021-12-06)
 
 - add options to create retry and error queues

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.7.0)
+    ears (0.8.0)
       bunny
       multi_json
 
@@ -20,7 +20,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.6)
-    rbtree (0.4.4)
+    rbtree (0.4.5)
     redcarpet (3.5.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
@@ -54,7 +54,7 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    set (1.0.1)
+    set (1.0.2)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
@@ -63,6 +63,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-21
   x86_64-darwin-20
   x86_64-linux
 

data/README.md

@@ -92,7 +92,9 @@ require 'ears/middlewares/json'
 
 class MyConsumer < Ears::Consumer
   # register the JSON middleware and don't symbolize keys (this can be omitted, the default is true)
-  use Ears::Middlewares::JSON, symbolize_keys: false
+  use Ears::Middlewares::JSON,
+      on_error: Proc.new { :reject },
+      symbolize_keys: false
 
   def work(delivery_info, metadata, payload)
     return ack unless payload['data'].nil? # this now just works
@@ -165,7 +167,7 @@ my_queue =
   queue('my_queue', durable: true, retry_queue: true, retry_delay: 5000)
 ```
 
-This will automatically create a queue named `my_queue.retry` and use the arguments `x-dead-letter-exchange` and `x-dead-letter-routing-key` to route rejected messages to it. When routed to the retry queue, messages will wait there for the number of milliseconds specified in `retry_delay`, after which they will be redelivered to the original queue.
+This will automatically create a queue named `my_queue.retry` and use the arguments `x-dead-letter-exchange` and `x-dead-letter-routing-key` to route rejected messages to it. When routed to the retry queue, messages will wait there for the number of milliseconds specified in `retry_delay`, after which they will be redelivered to the original queue. **Note that this will not automatically catch unhandled errors. You still have to catch any errors yourself and reject your message manually for the retry mechanism to work.**
 
 This will happen indefinitely, so if you want to bail out of this cycle at some point, it is best to use the `error_queue` option to create an error queue and then use the `MaxRetries` middleware to route messages to this error queue after a certain amount of retries.
 

data/lib/ears/middlewares/appsignal.rb

@@ -14,17 +14,29 @@ module Ears
       end
 
       def call(delivery_info, metadata, payload, app)
+        start_transaction do
+          begin
+            app.call(delivery_info, metadata, payload)
+          rescue => e
+            ::Appsignal.set_error(e)
+            raise
+          end
+        end
+      end
+
+      private
+
+      attr_reader :transaction_name, :class_name
+
+      def start_transaction(&block)
         ::Appsignal.monitor_transaction(
           transaction_name,
           class: class_name,
           method: 'work',
           queue_start: Time.now.utc,
-        ) { app.call(delivery_info, metadata, payload) }
+          &block
+        )
       end
-
-      private
-
-      attr_reader :transaction_name, :class_name
     end
   end
 end

data/lib/ears/middlewares/json.rb

@@ -6,20 +6,24 @@ module Ears
     # A middleware that automatically parses your JSON payload.
     class JSON < Middleware
       # @param [Hash] opts The options for the middleware.
-      # @option opts [Boolean] :symbolize_keys Whether to symbolize the keys of your payload.
+      # @option opts [Proc] :on_error A Proc to be called when an error occurs during processing
+      # @option opts [Boolean] :symbolize_keys (true) Whether to symbolize the keys of your payload.
       def initialize(opts = {})
         super()
+        @on_error = opts.fetch(:on_error)
         @symbolize_keys = opts.fetch(:symbolize_keys, true)
       end
 
       def call(delivery_info, metadata, payload, app)
         parsed_payload = MultiJson.load(payload, symbolize_keys: symbolize_keys)
         app.call(delivery_info, metadata, parsed_payload)
+      rescue => e
+        on_error.call(e)
       end
 
       private
 
-      attr_reader :symbolize_keys
+      attr_reader :symbolize_keys, :on_error
     end
   end
 end

data/lib/ears/middlewares/max_retries.rb

@@ -30,6 +30,8 @@ module Ears
       end
 
       def retries_exceeded?(metadata)
+        return false if metadata.headers.nil?
+
         rejected_deaths =
           metadata
             .headers

data/lib/ears/version.rb

@@ -1,3 +1,3 @@
 module Ears
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ears
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mario Mainz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny