freddy 2.11.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a6c79059c1c1c188d1a77c6bc37ddc8f89e072c4d92a3197c8852b38253e781
-  data.tar.gz: fcd02b33005200bf4bde9959186a694f4751f6cb39698ae7a3b1ef40cec21d51
+  metadata.gz: 2fee629805345ae363989fe96424d8ba0bcffd08ddd33f4e19327338ff5d0325
+  data.tar.gz: 4c1c4d92499a10b5e4cfd19adb390c8457a2ec873297a678fd755f70addd93e7
 SHA512:
-  metadata.gz: 034cdcce2a26c9f2ff8a8e3d02656520bb298e5a4c07f655253648ee0846f0b57f7cf883f31c2ec3cdf54f17d91f9394589e2440f7b686a2e4850926ab7001d1
-  data.tar.gz: fc13af3594a708c59d17cc2769bccf45f89ed0744e7107484d32f734385bc28ee1f2681d289694be30970aa67689a1892033c31562084f2b82b91d3ed7c115fe
+  metadata.gz: ad6991648e494845fde59d859068b42463959a81e2a846fdc5026556ac5ce7505bfa53370b78c6e9d30b101ad45b71faa67f83488d48a69a98aa5e5d6a104e90
+  data.tar.gz: 2786a37b993927f816e330846cc16a5aaaf07aff8d4c4c3f658c1088991f6ed9457d0931b1e6e253ee13e6ce85618e172747b801408100038f6b53f9d7ab57ee

data/.github/workflows/ci.yml

@@ -19,11 +19,11 @@ jobs:
           - 5672:5672
         options: --health-cmd "rabbitmqctl node_health_check" --health-interval 10s --health-timeout 5s --health-retries 5
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@0717577d45739eb3c851188b29f50ed6c0b2194e # v2.8.0
       with:
         submodules: true
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@762794c140bbeda0f1224786aa33b4b46783a6c1 # v1.326.0
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true

data/.github/workflows/publish.yml

@@ -6,16 +6,18 @@ on:
       - master
 jobs:
   build:
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@0717577d45739eb3c851188b29f50ed6c0b2194e # v2.8.0
         with:
           fetch-depth: 2
 
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@4bd305c65315cb691bad1e8de97a87aaf29a0a85
+        uses: discourse/publish-rubygems-action@4bd305c65315cb691bad1e8de97a87aaf29a0a85 # v3
         env:
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
           RELEASE_COMMAND: rake release

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    freddy (2.11.2)
-      bunny (~> 2.24)
+    freddy (3.0.0)
+      bunny (~> 3.5)
       concurrent-ruby (~> 1.0, >= 1.3.7)
       oj (~> 3.6, >= 3.17.3)
       opentelemetry-api (~> 1.0)
@@ -12,23 +12,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    amq-protocol (2.5.1)
+    amq-protocol (2.9.0)
     ast (2.4.3)
     bigdecimal (4.1.2)
-    bunny (2.24.0)
-      amq-protocol (~> 2.3)
+    bunny (3.5.0)
+      amq-protocol (~> 2.9)
+      logger (~> 1, >= 1.7)
+      openssl (>= 3.3)
       sorted_set (~> 1, >= 1.0.2)
     coderay (1.1.3)
     concurrent-ruby (1.3.7)
     diff-lcs (1.4.4)
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
-    json (2.9.1)
+    json (2.21.2)
     language_server-protocol (3.17.0.3)
+    logger (1.7.0)
     method_source (1.0.0)
     oj (3.17.3)
       bigdecimal (>= 3.0)
       ostruct (>= 0.2)
+    openssl (4.0.2)
     opentelemetry-api (1.5.0)
     opentelemetry-common (0.19.6)
       opentelemetry-api (~> 1.0)

data/README.md

@@ -15,6 +15,15 @@ freddy = Freddy.build(logger, host: 'localhost', port: 5672, user: 'guest', pass
 
 A new version is created when a change is merged into the master branch that changes the version number in `freddy.gemspec`. A Github Action will create a tag for the version and push the `.gem` file to [rubygems.org](https://rubygems.org)
 
+## Upgrading from 2.x to 3.0
+
+Freddy 3.0 runs on Bunny 3.5 instead of 2.24, which fixes RPC channels left closed after a connection recovery.
+
+* Change the Gemfile constraint to `gem 'freddy', '~> 3.0'`; Ruby 3.2 or later is required.
+* Bunny 3.5 also installs the `openssl` and `logger` gems: check TLS connections in a deployed environment before production.
+* Code that calls Bunny directly must follow the "Breaking Changes" of 3.0.0 in the [Bunny changelog](https://github.com/ruby-amqp/bunny/blob/main/ChangeLog.md), e.g. delivery tags are now plain integers.
+* Code that reaches into Freddy internals must follow their new signatures: `Freddy::Delivery.new` takes the recovery count, and the adapter channel's `acknowledge`/`reject` take the delivery instead of its tag.
+
 ## Supported message queues
 
 These message queues have been tested and are working with Freddy. Other queues can be added easily:

data/freddy.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'bunny', '~> 2.24'
+  spec.add_dependency 'bunny', '~> 3.5'
   spec.add_dependency 'concurrent-ruby', '~> 1.0', '>= 1.3.7'
   spec.add_dependency 'oj', '~> 3.6', '>= 3.17.3'
   spec.add_dependency 'opentelemetry-api', '~> 1.0'

data/lib/freddy/adapters/bunny_adapter.rb

@@ -20,12 +20,14 @@ class Freddy
 
       def initialize(bunny)
         @bunny = bunny
+        @recovery_count = Concurrent::AtomicFixnum.new
+        @bunny.before_recovery_attempt_starts { @recovery_count.increment }
       end
 
       def create_channel(prefetch: nil)
         bunny_channel = @bunny.create_channel
         bunny_channel.prefetch(prefetch) if prefetch
-        Channel.new(bunny_channel)
+        Channel.new(bunny_channel, @recovery_count)
       end
 
       def close
@@ -37,14 +39,24 @@ class Freddy
 
         NO_ROUTE = 312
 
-        def initialize(channel)
+        def initialize(channel, recovery_count)
           @channel = channel
+          @recovery_count = recovery_count
         end
 
-        def_delegators :@channel, :topic, :default_exchange, :consumers, :acknowledge, :reject
+        def_delegators :@channel, :topic, :default_exchange, :consumers
 
         def queue(*)
-          Queue.new(@channel.queue(*))
+          Queue.new(@channel.queue(*), @recovery_count)
+        end
+
+        # The server requeues deliveries from before a recovery; their stale tag would close this channel.
+        def acknowledge(delivery)
+          @channel.acknowledge(delivery.tag) if current?(delivery)
+        end
+
+        def reject(delivery, requeue: false)
+          @channel.reject(delivery.tag, requeue) if current?(delivery)
         end
 
         def on_no_route
@@ -52,11 +64,18 @@ class Freddy
             yield(properties[:correlation_id]) if return_info[:reply_code] == NO_ROUTE
           end
         end
+
+        private
+
+        def current?(delivery)
+          delivery.recovery_count == @recovery_count.value && @channel.open?
+        end
       end
 
       class Queue
-        def initialize(queue)
+        def initialize(queue, recovery_count)
           @queue = queue
+          @recovery_count = recovery_count
         end
 
         def bind(*)
@@ -76,7 +95,8 @@ class Freddy
           @queue.subscribe(manual_ack: manual_ack) do |info, properties, payload|
             parsed_payload = Payload.parse(payload, properties[:content_encoding])
             delivery = Delivery.new(
-              parsed_payload, properties, info.routing_key, info.delivery_tag, info.exchange
+              parsed_payload, properties, info.routing_key, info.delivery_tag, info.exchange,
+              @recovery_count.value
             )
             yield(delivery)
           end

data/lib/freddy/consumers/respond_to_consumer.rb

@@ -42,7 +42,7 @@ class Freddy
             yield(delivery)
           end
         ensure
-          @channel.acknowledge(delivery.tag, false)
+          @channel.acknowledge(delivery)
         end
       end
 

data/lib/freddy/consumers/tap_into_consumer.rb

@@ -47,16 +47,16 @@ class Freddy
         @consume_thread_pool.post do
           delivery.in_span do
             yield delivery.payload, delivery.routing_key, delivery.timestamp
-            @channel.acknowledge(delivery.tag)
+            @channel.acknowledge(delivery)
           end
         rescue StandardError
           case on_exception
           when :reject
-            @channel.reject(delivery.tag)
+            @channel.reject(delivery)
           when :requeue
-            @channel.reject(delivery.tag, true)
+            @channel.reject(delivery, requeue: true)
           else
-            @channel.acknowledge(delivery.tag)
+            @channel.acknowledge(delivery)
           end
 
           raise

data/lib/freddy/delivery.rb

@@ -2,14 +2,15 @@
 
 class Freddy
   class Delivery
-    attr_reader :routing_key, :payload, :tag
+    attr_reader :routing_key, :payload, :tag, :recovery_count
 
-    def initialize(payload, metadata, routing_key, tag, exchange)
+    def initialize(payload, metadata, routing_key, tag, exchange, recovery_count) # rubocop:disable Metrics/ParameterLists
       @payload = payload
       @metadata = metadata
       @routing_key = routing_key
       @tag = tag
       @exchange = exchange
+      @recovery_count = recovery_count
     end
 
     def correlation_id

data/lib/freddy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Freddy
-  VERSION = '2.11.2'
+  VERSION = '3.0.0'
 end

data/spec/freddy/adapters/bunny_adapter/channel_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Freddy::Adapters::BunnyAdapter::Channel do
+  let(:channel) { described_class.new(bunny_channel, recovery_count) }
+  let(:bunny_channel) { double(open?: channel_open, acknowledge: nil, reject: nil) }
+  let(:channel_open) { true }
+  let(:recovery_count) { Concurrent::AtomicFixnum.new }
+  let(:delivery) { Freddy::Delivery.new({}, {}, 'routing.key', 7, '', recovery_count.value) }
+
+  context 'when the delivery is from the current connection' do
+    it 'acknowledges it' do
+      channel.acknowledge(delivery)
+
+      expect(bunny_channel).to have_received(:acknowledge).with(7)
+    end
+
+    it 'rejects it' do
+      channel.reject(delivery, requeue: true)
+
+      expect(bunny_channel).to have_received(:reject).with(7, true)
+    end
+  end
+
+  context 'when the connection was recovered after the delivery' do
+    before do
+      delivery
+      recovery_count.increment
+    end
+
+    it 'does not acknowledge it' do
+      channel.acknowledge(delivery)
+
+      expect(bunny_channel).not_to have_received(:acknowledge)
+    end
+
+    it 'does not reject it' do
+      channel.reject(delivery)
+
+      expect(bunny_channel).not_to have_received(:reject)
+    end
+  end
+
+  context 'when the channel is closed' do
+    let(:channel_open) { false }
+
+    it 'does not acknowledge the delivery' do
+      channel.acknowledge(delivery)
+
+      expect(bunny_channel).not_to have_received(:acknowledge)
+    end
+
+    it 'does not reject the delivery' do
+      channel.reject(delivery)
+
+      expect(bunny_channel).not_to have_received(:reject)
+    end
+  end
+end

data/spec/integration/connection_recovery_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'Connection recovery' do
+  let(:freddy) { Freddy.build(logger, **config, network_recovery_interval: 0.5) }
+  let(:requester) { Freddy.build(logger, **config) }
+  let(:destination) { random_destination }
+  let(:bunny) { freddy.instance_variable_get(:@connection).instance_variable_get(:@bunny) }
+
+  after { [freddy, requester].each(&:close) }
+
+  it 'keeps responding when a message is processed across a recovery' do
+    processing = Queue.new
+    release = Queue.new
+    deliveries = Concurrent::AtomicFixnum.new
+
+    freddy.respond_to destination do |payload, msg_handler|
+      if deliveries.increment == 1
+        processing << true
+        release.pop
+      end
+      msg_handler.success(payload)
+    end
+
+    first_request = Thread.new { requester.deliver_with_response(destination, { id: 1 }, timeout: 10) }
+    processing.pop
+
+    bunny.transport.socket.shutdown(Socket::SHUT_RDWR)
+    wait_for_recovery
+    release << true
+
+    expect(first_request.value).to eq(id: 1)
+    expect(requester.deliver_with_response(destination, { id: 2 })).to eq(id: 2)
+    expect(requester.deliver_with_response(destination, { id: 3 })).to eq(id: 3)
+  end
+
+  def wait_for_recovery
+    sleep 0.1 while bunny.open?
+    sleep 0.1 until bunny.open?
+    sleep 0.5
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: freddy
 version: !ruby/object:Gem::Version
-  version: 2.11.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Glia TechMovers
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,7 @@ files:
 - lib/freddy/tracing.rb
 - lib/freddy/version.rb
 - spec/.rubocop.yml
+- spec/freddy/adapters/bunny_adapter/channel_spec.rb
 - spec/freddy/consumers/respond_to_consumer_spec.rb
 - spec/freddy/error_response_spec.rb
 - spec/freddy/freddy_spec.rb
@@ -161,6 +162,7 @@ files:
 - spec/freddy/responder_handler_spec.rb
 - spec/freddy/sync_response_container_spec.rb
 - spec/integration/concurrency_spec.rb
+- spec/integration/connection_recovery_spec.rb
 - spec/integration/reply_spec.rb
 - spec/integration/tap_into_with_exchange_spec.rb
 - spec/integration/tap_into_with_group_spec.rb