ears 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ff51eb26ddd79aebd5f99d8699b8351cdc96fc68485e9b0c99a8fe85502a96e
-  data.tar.gz: 91667d959259121b6e973897fb617cb0b92e60b720c6aee451c8ff5b472f6c58
+  metadata.gz: c78842e806da5fc1ccc47697cd55a94e3f038fae3e0dc3688a6fa0b55bb1f4e5
+  data.tar.gz: 3def90d115c5845bb4a0339465cf705447bf5398693913cc0e2080828ad86f93
 SHA512:
-  metadata.gz: fc487ab5e78bb55e43c6ccb89fb1d49543f1c3994b1bf3b01b1f4f6349ede74570ff6c6c67be5c1b1d979a4328124cf333db1594f3fde7cc2cdb54397ed3461c
-  data.tar.gz: 6f5e2efd6c25c8ff2801d3402064b20ec808b56530a7f65ad55323da549f0583ec5e4f06a66baec83b7b6ebf532bdab644095ac7880a544143ffcd2c73d5ee64
+  metadata.gz: ec53642022e0db616224c8beea49931d8be0ed5e89120e7e81729fd6c2dbe8713522db77e955c5b4231bb41f1f9de82bd613b64cc6d3760fbe1c0cbbfc15c550
+  data.tar.gz: 62f101c0c19bcc5ef27ef220783bd73132b79a9d413d9f45b1642556de091738a6cd3e4817d6e9d5914aa39fac575dd4e9f585c8cedfae68bbc7808faedf5ebd

data/.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
           bundler-cache: true
       - uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: '20'
       - name: Run prettier
         run: npm ci && npm run lint
       - name: Run Rubocop

data/.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: 'CodeQL'
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: ['main']
+  schedule:
+    - cron: '15 9 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['ruby']
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+      # - run: |
+      #     echo "Run, Build Application using script"
+      #     ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: '/language:${{matrix.language}}'

data/.github/workflows/dependency-review.yml

@@ -0,0 +1,20 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v2

data/.tool-versions

@@ -1,2 +1,2 @@
 ruby 3.2.2
-nodejs 20.0.0
+nodejs 20.2.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.11.0 (2023-05-30)
+
+- **[Breaking]**: Provide the Bunny connection option `recovery_attempts` in Ears configuration. It
+  comes with a default of 10 attempts. When the number of recovery attempts are exhausted, Ears will
+  raise a `MaxRecoveryAttemptsExhaustedError`.
+
+## 0.10.1 (2023-05-22)
+
+- Reset channel on Ears.stop!
+
 ## 0.10.0 (2023-05-16)
 
 - Add Ears.stop! method to be able to close the connection and remove consumers.

data/CODEOWNERS

@@ -1 +1 @@
-* @ivx/schedules
+* @johannesluedke @brerx

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ears (0.10.0)
-      bunny
+    ears (0.11.0)
+      bunny (~> 2.22.0)
       multi_json
 
 GEM
@@ -10,7 +10,7 @@ GEM
   specs:
     amq-protocol (2.3.2)
     ast (2.4.2)
-    bunny (2.20.3)
+    bunny (2.22.0)
       amq-protocol (~> 2.3, >= 2.3.1)
       sorted_set (~> 1, >= 1.0.2)
     diff-lcs (1.5.0)
@@ -21,16 +21,18 @@ GEM
     json (2.6.3)
     multi_json (1.15.0)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     prettier (3.2.2)
       syntax_tree (>= 2.7.1)
       syntax_tree-haml (>= 1.1.0)
       syntax_tree-rbs (>= 0.2.0)
     prettier_print (1.2.1)
+    racc (1.7.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbs (3.0.4)
+    rbs (3.1.0)
     rbtree (0.4.6)
     redcarpet (3.6.0)
     regexp_parser (2.8.0)
@@ -48,7 +50,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.52.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -58,15 +60,18 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.20.0)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     set (1.0.3)
     sorted_set (1.0.3)
@@ -82,9 +87,9 @@ GEM
       prettier_print
       rbs
       syntax_tree (>= 2.0.1)
-    temple (0.10.0)
-    thor (1.2.1)
-    tilt (2.1.0)
+    temple (0.10.2)
+    thor (1.2.2)
+    tilt (2.2.0)
     unicode-display_width (2.4.2)
     yard (0.9.34)
 
@@ -109,4 +114,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.4.12
+   2.4.13

data/README.md

@@ -2,6 +2,8 @@
 
 `Ears` is a small, simple library for writing RabbitMQ consumers.
 
+[![CodeQL](https://github.com/ivx/ears/actions/workflows/codeql.yml/badge.svg)](https://github.com/ivx/ears/actions/workflows/codeql.yml)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,7 +32,8 @@ require 'ears'
 Ears.configure do |config|
   config.rabbitmq_url = 'amqp://user:password@myrmq:5672'
   config.connection_name = 'My Consumer'
-  config.recover_from_connection_close = false, # optional configuration, defaults to true if not set
+  config.recover_from_connection_close = false # optional configuration, defaults to true if not set
+  config.recovery_attempts = 3 # optional configuration, defaults to 10, Bunny::Session would have been nil
 end
 ```
 
@@ -212,7 +215,7 @@ For this use case, there is a stop! method:
 Ears.stop!
 ```
 
-It will close and reset the current Bunny connection, leading to all consumers being shut down.
+It will close and reset the current Bunny connection, leading to all consumers being shut down. Also, it will reset the channel.
 
 ## Documentation
 

data/ears.gemspec

@@ -38,6 +38,6 @@ You may want to have a look into the CHANGELOG!
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'bunny'
+  spec.add_dependency 'bunny', '~> 2.22.0'
   spec.add_dependency 'multi_json'
 end

data/lib/ears/configuration.rb

@@ -1,3 +1,5 @@
+require 'ears/errors'
+
 module Ears
   # The class representing the global {Ears} configuration.
   class Configuration
@@ -5,6 +7,7 @@ module Ears
     end
 
     DEFAULT_RABBITMQ_URL = 'amqp://guest:guest@localhost:5672'
+    DEFAULT_RECOVERY_ATTEMPTS = 10
 
     # @return [String] the connection string for RabbitMQ.
     attr_accessor :rabbitmq_url
@@ -15,8 +18,25 @@ module Ears
     # @return [Boolean] if the recover_from_connection_close value is set for the RabbitMQ connection.
     attr_accessor :recover_from_connection_close
 
+    # @return [Integer] max number of recovery attempts, nil means forever
+    attr_accessor :recovery_attempts
+
     def initialize
       @rabbitmq_url = DEFAULT_RABBITMQ_URL
+      @recovery_attempts = DEFAULT_RECOVERY_ATTEMPTS
+    end
+
+    # @return [Proc] that is passed to Bunny’s recovery_attempts_exhausted block. Nil if recovery_attempts is nil.
+    def recovery_attempts_exhausted
+      return nil unless recovery_attempts
+
+      Proc.new do
+        # We need to have this since Bunny’s multi-threading is cumbersome here.
+        # Session reconnection seems not to be done in the main thread. If we want to
+        # achieve a restart of the app we need to modify the thread behaviour.
+        Thread.current.abort_on_exception = true
+        raise MaxRecoveryAttemptsExhaustedError
+      end
     end
 
     def validate!

data/lib/ears/errors.rb

@@ -0,0 +1,5 @@
+module Ears
+  # Error that is raised when the Bunny recovery attempts are exhausted.
+  class MaxRecoveryAttemptsExhaustedError < StandardError
+  end
+end

data/lib/ears/version.rb

@@ -1,3 +1,3 @@
 module Ears
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

data/lib/ears.rb

@@ -62,6 +62,7 @@ module Ears
     def stop!
       connection.close
       @connection = nil
+      Thread.current[:ears_channel] = nil
     end
 
     # Signals that an uncaught error has occurred and the process should be stopped.
@@ -86,6 +87,8 @@ module Ears
         connection_name: configuration.connection_name,
         recover_from_connection_close:
           configuration.recover_from_connection_close,
+        recovery_attempts: configuration.recovery_attempts,
+        recovery_attempts_exhausted: configuration.recovery_attempts_exhausted,
       }.compact
     end
   end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ears
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - InVision AG
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.22.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
+- ".github/workflows/codeql.yml"
+- ".github/workflows/dependency-review.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -63,6 +65,7 @@ files:
 - lib/ears/configuration.rb
 - lib/ears/consumer.rb
 - lib/ears/consumer_wrapper.rb
+- lib/ears/errors.rb
 - lib/ears/middleware.rb
 - lib/ears/middlewares/appsignal.rb
 - lib/ears/middlewares/json.rb