ears 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f0fa1b69a334f5ec5d649478a46d0c78298621a2c879c3b62457b8dd41723fe
-  data.tar.gz: e34d3bee6f15435ca5c9847b384aad75e6acd3ccd06dbb9a751a798f63f3a077
+  metadata.gz: b1bc62c3b6367b99bdd80d44f670f79bd38709587df8e0bbcb72201772b99a74
+  data.tar.gz: b2fd12a20e5b0879fc1a69efe3729e6a422f8cc20f57007098a4da21d0198b4c
 SHA512:
-  metadata.gz: 4d914d9a7e5ce22b6595899952626bbbec3b1885a6ff0b4fbf768560d4382dadb64578a9c305d0573afba36918e0eccd8c704ccfb681a76f606a09cf8b23b2c6
-  data.tar.gz: f6f95145e4c70a565cd95755602116755e79000ca530883aadcf8d9461aacdf3d6828bf67533ed7f7458471473972839ef5745b1e44c933705678be119260f63
+  metadata.gz: 21299077971e38f928ef72d047726ad99218fc6d4b3c0d73cdd9a179f0cf87d8d5fab6f129a7d4c5dd20d97190d3d1d73daf81f229f3bd79cb21d60a73c9af95
+  data.tar.gz: 8e92b3f7bba6f494fd563f210dd43f03a95e4df0bf1f722dd1a6a3052fee9c82038679d8e7568a0de5e1e6581cdb343caa6092cc151f63890c2105a0da3b8134

data/.tool-versions

@@ -1,2 +1,2 @@
-ruby 3.0.0
-nodejs 15.11.0
+ruby 3.0.2
+nodejs 16.9.0

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.6.0 (2021-11-18)
+
+- add `connection_name` to configuration and make it a mandatory setting
+- validate configuration after calling `configure`
+
+## 0.5.0 (2021-11-03)
+
+- fix the fact that the configuration was never used and bunny silently fell back to the `RABBITMQ_URL` env var
+
+## 0.4.3 (2021-07-26)
+
+### Changes
+
+- Ears will not exit gracefully on unhandled errors anymore. You have to take care of proper flushing and cleanup yourself (see README for example).
+
+## 0.3.3 (2021-06-07)
+
+### Changes
+
+- Ears will now exit gracefully on unhandled errors to give the application a chance to do flushing and cleanup work
+
 ## 0.3.2 (2021-05-21)
 
 ### Changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ears (0.3.2)
+    ears (0.6.0)
       bunny
       multi_json
 
@@ -10,18 +10,20 @@ GEM
   specs:
     amq-protocol (2.3.2)
     ast (2.4.2)
-    bunny (2.17.0)
+    bunny (2.19.0)
       amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
     diff-lcs (1.4.4)
     multi_json (1.15.0)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
+    rbtree (0.4.4)
     redcarpet (3.5.1)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -35,27 +37,32 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.12.0)
+    rubocop (1.20.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
+    set (1.0.1)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
     unicode-display_width (2.0.0)
     yard (0.9.26)
 
 PLATFORMS
+  arm64-darwin-20
   x86_64-darwin-20
   x86_64-linux
 
@@ -70,4 +77,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.3
+   2.2.22

data/README.md

@@ -22,16 +22,19 @@ Or install it yourself as:
 
 ### Basic usage
 
-First, you should configure where `Ears` should connect to.
+First, you should configure `Ears`.
 
 ```ruby
 require 'ears'
 
 Ears.configure do |config|
   config.rabbitmq_url = 'amqp://user:password@myrmq:5672'
+  config.connection_name = 'My Consumer'
 end
 ```
 
+_Note_: `connection_name` is a mandatory setting!
+
 Next, define your exchanges, queues, and consumers by calling `Ears.setup`.
 
 ```ruby
@@ -63,6 +66,16 @@ class MyConsumer < Ears::Consumer
 end
 ```
 
+And, do not forget to run it. Be prepared that unhandled errors will be reraised. So, take care of cleanup work.
+
+```ruby
+begin
+  Ears.run!
+ensure
+  # all your cleanup work goes here...
+end
+```
+
 At the end of the `#work` method, you must always return `ack`, `reject`, or `requeue` to signal what should be done with the message.
 
 ### Middlewares

data/ears.gemspec

@@ -19,6 +19,12 @@ Gem::Specification.new do |spec|
   spec.metadata['changelog_uri'] =
     'https://github.com/ivx/ears/blob/master/CHANGELOG.md'
 
+  spec.post_install_message =
+    '
+Ears: the new version changed the exit behaviour in case of uncaught exceptions.
+You may want to have a look into the CHANGELOG!
+'
+
   spec.files =
     Dir.chdir(File.expand_path('..', __FILE__)) do
       `git ls-files -z`.split("\x0").reject do |f|

data/lib/ears/configuration.rb

@@ -1,13 +1,23 @@
 module Ears
   # The class representing the global {Ears} configuration.
   class Configuration
+    class ConnectionNameMissing < StandardError
+    end
+
     DEFAULT_RABBITMQ_URL = 'amqp://guest:guest@localhost:5672'
 
     # @return [String] the connection string for RabbitMQ.
     attr_accessor :rabbitmq_url
 
+    # @return [String] the name for the RabbitMQ connection.
+    attr_accessor :connection_name
+
     def initialize
       @rabbitmq_url = DEFAULT_RABBITMQ_URL
     end
+
+    def validate!
+      raise ConnectionNameMissing unless connection_name
+    end
   end
 end

data/lib/ears/consumer.rb

@@ -46,11 +46,14 @@ module Ears
     # @param [String] payload The payload of the received message.
     # @raise [InvalidReturnError] if you return something other than +:ack+, +:reject+ or +:requeue+ from {#work}.
     def process_delivery(delivery_info, metadata, payload)
-      self.class.middlewares.reverse.reduce(
-        work_proc,
-      ) do |next_middleware, middleware|
-        nest_middleware(middleware, next_middleware)
-      end.call(delivery_info, metadata, payload)
+      self
+        .class
+        .middlewares
+        .reverse
+        .reduce(work_proc) do |next_middleware, middleware|
+          nest_middleware(middleware, next_middleware)
+        end
+        .call(delivery_info, metadata, payload)
     end
 
     protected

data/lib/ears/middlewares/max_retries.rb

@@ -0,0 +1,46 @@
+require 'ears/middleware'
+
+module Ears
+  module Middlewares
+    # A middleware that automatically puts messages on an error queue when the specified number of retries are exceeded.
+    class MaxRetries < Middleware
+      # @param [Hash] opts The options for the middleware.
+      # @option opts [Integer] :retries The number of retries before the message is sent to the error queue.
+      # @option opts [String] :error_queue The name of the queue where messages should be sent to when the max retries are reached.
+      def initialize(opts)
+        super()
+        @retries = opts.fetch(:retries)
+        @error_queue = opts.fetch(:error_queue)
+      end
+
+      def call(delivery_info, metadata, payload, app)
+        return handle_exceeded(payload) if retries_exceeded?(metadata)
+        app.call(delivery_info, metadata, payload)
+      end
+
+      private
+
+      attr_reader :retries, :error_queue
+
+      def handle_exceeded(payload)
+        Bunny::Exchange
+          .default(Ears.channel)
+          .publish(payload, routing_key: error_queue)
+        :ack
+      end
+
+      def retries_exceeded?(metadata)
+        rejected_deaths =
+          metadata
+            .headers
+            .fetch('x-death', [])
+            .select { |death| death['reason'] == 'rejected' }
+
+        return false unless rejected_deaths.any?
+
+        retry_count = rejected_deaths.map { |death| death['count'] }.max
+        retry_count > @retries
+      end
+    end
+  end
+end

data/lib/ears/setup.rb

@@ -62,7 +62,7 @@ module Ears
         .create_channel(nil, 1, true)
         .tap do |channel|
           channel.prefetch(args.fetch(:prefetch, 1))
-          channel.on_uncaught_exception { |error| Thread.main.raise(error) }
+          channel.on_uncaught_exception { |error| Ears.error!(error) }
         end
     end
 

data/lib/ears/version.rb

@@ -1,3 +1,3 @@
 module Ears
-  VERSION = '0.3.2'
+  VERSION = '0.6.0'
 end

data/lib/ears.rb

@@ -18,13 +18,20 @@ module Ears
     # @yieldparam configuration [Ears::Configuration] The global configuration instance.
     def configure
       yield(configuration)
+      configuration.validate!
     end
 
     # The global RabbitMQ connection used by Ears.
     #
     # @return [Bunny::Session]
     def connection
-      @connection ||= Bunny.new.tap { |conn| conn.start }
+      @connection ||=
+        Bunny
+          .new(
+            configuration.rabbitmq_url,
+            connection_name: configuration.connection_name,
+          )
+          .tap { |conn| conn.start }
     end
 
     # The channel for the current thread.
@@ -36,7 +43,7 @@ module Ears
           .create_channel(nil, 1, true)
           .tap do |channel|
             channel.prefetch(1)
-            channel.on_uncaught_exception { |error| Thread.main.raise(error) }
+            channel.on_uncaught_exception { |error| Ears.error!(error) }
           end
     end
 
@@ -51,12 +58,22 @@ module Ears
       running = true
       Signal.trap('INT') { running = false }
       Signal.trap('TERM') { running = false }
-      sleep 1 while running
+      sleep 1 while running && @error.nil?
+      raise @error if @error
+    end
+
+    # Signals that an uncaught error has occurred and the process should be stopped.
+    #
+    # @param [Exception] error The unhandled error that occurred.
+    def error!(error)
+      puts(error.full_message)
+      @error = error
     end
 
     # Used internally for testing.
     def reset!
       @connection = nil
+      @configuration = nil
       Thread.current[:ears_channel] = nil
     end
   end

data/package-lock.json

@@ -0,0 +1,69 @@
+{
+  "name": "ears",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "ears",
+      "devDependencies": {
+        "@invisionag/prettier-config-ivx": "^3.0.1",
+        "@prettier/plugin-ruby": "^2.0.0",
+        "prettier": "^2.4.1"
+      }
+    },
+    "node_modules/@invisionag/prettier-config-ivx": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/@invisionag/prettier-config-ivx/-/prettier-config-ivx-3.0.1.tgz",
+      "integrity": "sha512-l9oq6oWH/5f55StS8btmB4LfebfziO9tOY62ItJBwF4nKeMgI/iKBJ97r9Sqkxbq3qOKERuG1u4rAStX9m9GTg==",
+      "dev": true,
+      "peerDependencies": {
+        "prettier": ">=2.0.0"
+      }
+    },
+    "node_modules/@prettier/plugin-ruby": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/@prettier/plugin-ruby/-/plugin-ruby-2.0.0.tgz",
+      "integrity": "sha512-pA0rjTi5J7cT86XPNhXp7CpdV2Tlyj5oqDIsnQRxMu2P7LY2KJI/pyOSM8pzTH8BgRyQfe1P1NPCcTwxUnUWtQ==",
+      "dev": true,
+      "dependencies": {
+        "prettier": ">=2.3.0"
+      }
+    },
+    "node_modules/prettier": {
+      "version": "2.4.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.4.1.tgz",
+      "integrity": "sha512-9fbDAXSBcc6Bs1mZrDYb3XKzDLm4EXXL9sC1LqKP5rZkT6KRr/rf9amVUcODVXgguK/isJz0d0hP72WeaKWsvA==",
+      "dev": true,
+      "bin": {
+        "prettier": "bin-prettier.js"
+      },
+      "engines": {
+        "node": ">=10.13.0"
+      }
+    }
+  },
+  "dependencies": {
+    "@invisionag/prettier-config-ivx": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/@invisionag/prettier-config-ivx/-/prettier-config-ivx-3.0.1.tgz",
+      "integrity": "sha512-l9oq6oWH/5f55StS8btmB4LfebfziO9tOY62ItJBwF4nKeMgI/iKBJ97r9Sqkxbq3qOKERuG1u4rAStX9m9GTg==",
+      "dev": true,
+      "requires": {}
+    },
+    "@prettier/plugin-ruby": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/@prettier/plugin-ruby/-/plugin-ruby-2.0.0.tgz",
+      "integrity": "sha512-pA0rjTi5J7cT86XPNhXp7CpdV2Tlyj5oqDIsnQRxMu2P7LY2KJI/pyOSM8pzTH8BgRyQfe1P1NPCcTwxUnUWtQ==",
+      "dev": true,
+      "requires": {
+        "prettier": ">=2.3.0"
+      }
+    },
+    "prettier": {
+      "version": "2.4.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.4.1.tgz",
+      "integrity": "sha512-9fbDAXSBcc6Bs1mZrDYb3XKzDLm4EXXL9sC1LqKP5rZkT6KRr/rf9amVUcODVXgguK/isJz0d0hP72WeaKWsvA==",
+      "dev": true
+    }
+  }
+}

data/package.json

@@ -1,15 +1,15 @@
 {
-  "name": "on-prem-importer",
+  "name": "ears",
   "private": true,
   "scripts": {
     "prettify": "prettier \"**/*.{ru,rb,yml,yaml,md,gemspec,json}\" --ignore-path=\".gitignore\"",
-    "lint": "yarn prettify --check",
-    "format": "yarn prettify --write"
+    "lint": "npm run prettify -- --check",
+    "format": "npm run prettify -- --write"
   },
   "devDependencies": {
-    "@invisionag/prettier-config-ivx": "^2.1.1",
-    "@prettier/plugin-ruby": "^1.5.2",
-    "prettier": "^2.2.0"
+    "@invisionag/prettier-config-ivx": "^3.0.1",
+    "@prettier/plugin-ruby": "^2.0.0",
+    "prettier": "^2.4.1"
   },
   "prettier": "@invisionag/prettier-config-ivx"
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ears
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Mario Mainz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -163,10 +163,11 @@ files:
 - lib/ears/middleware.rb
 - lib/ears/middlewares/appsignal.rb
 - lib/ears/middlewares/json.rb
+- lib/ears/middlewares/max_retries.rb
 - lib/ears/setup.rb
 - lib/ears/version.rb
+- package-lock.json
 - package.json
-- yarn.lock
 homepage: https://github.com/ivx/ears
 licenses:
 - MIT
@@ -175,7 +176,10 @@ metadata:
   homepage_uri: https://github.com/ivx/ears
   source_code_uri: https://github.com/ivx/ears
   changelog_uri: https://github.com/ivx/ears/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: |2
+
+  Ears: the new version changed the exit behaviour in case of uncaught exceptions.
+  You may want to have a look into the CHANGELOG!
 rdoc_options: []
 require_paths:
 - lib
@@ -190,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A gem for building RabbitMQ consumers.

data/yarn.lock

@@ -1,20 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-
-
-"@invisionag/prettier-config-ivx@^2.1.1":
-  version "2.1.1"
-  resolved "https://registry.yarnpkg.com/@invisionag/prettier-config-ivx/-/prettier-config-ivx-2.1.1.tgz#8899ec027cfde823ff497f2d67326bc14fbdf4bd"
-  integrity sha512-vujtO8XVSwoWU6k1lRZzvOeMCNvX2injJsEfG5rAfQGBjcN0J4a0zwXYBb6GI4gNZsYj6C6iD1Nk2HsMXKFByg==
-
-"@prettier/plugin-ruby@^1.5.2":
-  version "1.5.3"
-  resolved "https://registry.yarnpkg.com/@prettier/plugin-ruby/-/plugin-ruby-1.5.3.tgz#04c1058fce59651c38c02ace39faa7a0daa4264b"
-  integrity sha512-YXXf0PGsUOMk40UlfnjDeF3NuRmKE4ddN4L2drFaskhqcB/P9jNGabz5FsGJdJt+ibPxfRsqx05gfxGLZo1wHg==
-  dependencies:
-    prettier ">=1.10"
-
-prettier@>=1.10, prettier@^2.2.0:
-  version "2.2.1"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.2.1.tgz#795a1a78dd52f073da0cd42b21f9c91381923ff5"
-  integrity sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==