ears 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a4861d19cb40a286132903f840c44a2ca5c499a6548904e9b236adbb274a2b
-  data.tar.gz: 8dc749ba6583db68c5b69e24f4847b8bfbffe7844c40f9f97e485160569aaecd
+  metadata.gz: 1a270323620cabe6ab7cee7c3c9df9027e8ae7881391725ee8f2208c7f25daf1
+  data.tar.gz: 89b4c68b826969e361c57a1f10443cb2b7d9e05e7e7927ab41625b18cc2f9909
 SHA512:
-  metadata.gz: d6a040d48cf13b7fa5895ff6b36af6d28ebe51d87582dfad7358fb242c6d808cea7892b359df127e2e93764d8674b7a28bd35024e59fa3f61ea062fb20e379ac
-  data.tar.gz: cc5857eeb86f2092e23076a145cb153c45e51da4501c9ce4d7f219e0b71fce46b97e55340331b411bab9fa3eccfdef12c8d8dabefdbc09611611860f3ea6fd36
+  metadata.gz: 6ecbaea2a5bcbfab38dc08614a007aab1062b88b6a1245d8234039532ae7cab6085593aecade33f13e115952b2fb616a310d254ee7a5e2287f9b64704ad88136
+  data.tar.gz: 8bcfea156458b3e6c2c16bd319e181dca1c21edf8616b1015d7f7f11c7a7513865ee1a8f75f5e041a0f8875c3f2a8c216b0f6e45f0215e03750b3a1391a62367

data/.github/workflows/build.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0']
 
     steps:
       - uses: actions/checkout@v2

data/.rubocop.yml

@@ -11,7 +11,7 @@ AllCops:
     - Guardfile
     - bin/*
     - tmp/**/*
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   NewCops: enable
 
 Style:

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.8.1 (2022-04-08)
+
+- do not rescue errors outside the scope of the error handler in JSON middleware
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.7.1)
+    ears (0.8.1)
       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)
@@ -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/ears.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description = 'A gem for building RabbitMQ consumers.'
   spec.homepage = 'https://github.com/ivx/ears'
   spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 

data/lib/ears/middlewares/json.rb

@@ -6,20 +6,28 @@ 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)
+        begin
+          parsed_payload =
+            MultiJson.load(payload, symbolize_keys: symbolize_keys)
+        rescue => e
+          return on_error.call(e)
+        end
+
         app.call(delivery_info, metadata, parsed_payload)
       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.1'
+  VERSION = '0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ears
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Mario Mainz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -187,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="