logstash-integration-rabbitmq 7.3.2-java → 7.3.3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87b910943f6be19026320fcad93686f4583361f394f4ce5415415bc99faaac3
-  data.tar.gz: f6dce144b898f2a818f8e9bc0751adc1e467f98ddf002abb6eedbf64f24242bd
+  metadata.gz: 78f0b7f1bca3933bd03700f0fbce3865f4b9d53cfb7f17af4c25c28a23000a57
+  data.tar.gz: aa2f3ad215acf1ea2f62b5fdfc880d9bcb6b4f0bcd94fe22c3cd214e07353ee7
 SHA512:
-  metadata.gz: 2de6023c6ae0ab82548a8933ed89771ebc839a24320e13065e177a12d488f29e329e0ef9983854600c03f28c67f49fcf627ecf92556a8839abbdae9255195d62
-  data.tar.gz: f0071bfa48a4b2f2c3727bef2543f06c9e88ef92d7a662606f782fccb508028d25f3bd3a7c6107a43334ae86d75ebf0ff6526d27ff400d5035dababf83189977
+  metadata.gz: 7650cc2460674b63af00cb41bb6f0460338a9afa76d9df46c4a7e67b7f6e9c128f5a22b6708b66257fce639af2217574ea88d00546d14519260d1fa2f0b52599
+  data.tar.gz: f9843e44ced717e51ea13fad2fab1f321f9ce829b6a4b4886b60e466ca02b4232112d6d3f0531500df402e6e8fa4b36c216b0f3a62fb745f5946223c6f077412

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 7.3.3
+  - Fixed the cancellation flow to avoid multiple invocations of basic.cancel [#55](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/55)
+
 ## 7.3.2
   - Change `tls_certificate_password` type to `password` to protect from leaks in the logs [#54](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/54)
 

data/lib/logstash/inputs/rabbitmq.rb

@@ -308,7 +308,14 @@ module LogStash
       end
 
       def shutdown_consumer
-        return unless @consumer
+        # There are two possible flows to shutdown consumers. When the plugin is the one shutting down, it should send a channel
+        # cancellation message by invoking channel.basic_cancel(consumer_tag) and waiting for the consumer to terminate
+        # (broker replies with an basic.cancel-ok). This back and forth is handled by MarchHare. On the other hand, when the broker
+        # requests the client to shutdown (eg. due to queue deletion). It sends to the client a basic.cancel message, which is handled
+        # internally by the client, unregistering the consumer and then invoking the :on_cancellation callback. In that case, the plugin
+        # should not do anything as the consumer is already cancelled/unregistered.
+        return if !@consumer || @consumer.cancelled? || @consumer.terminated?
+
         @hare_info.channel.basic_cancel(@consumer.consumer_tag)
         connection = @hare_info.connection
         until @consumer.terminated?

data/logstash-integration-rabbitmq.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-integration-rabbitmq'
-  s.version         = '7.3.2'
+  s.version         = '7.3.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Integration with RabbitMQ - input and output plugins"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline "+

data/spec/inputs/rabbitmq_spec.rb

@@ -63,6 +63,62 @@ describe LogStash::Inputs::RabbitMQ do
       expect(instance.codec.config_name).to eq "json"
     end
 
+    describe "and #stop is called" do
+      let(:consumer_tag) { "foo-bar-queue" }
+      let(:consumer) { double("consumer") }
+
+      before do
+        instance.register
+        instance.setup!
+        instance.instance_variable_set(:@consumer, consumer)
+
+        allow(instance).to receive(:close_connection)
+        allow(consumer).to receive(:consumer_tag).and_return(consumer_tag)
+      end
+
+      context "with a cancelled consumer" do
+        before do
+          allow(consumer).to receive(:cancelled?).and_return(true)
+          allow(consumer).to receive(:terminated?).and_return(false)
+        end
+
+        it "should not call basic_cancel" do
+          expect(channel).to_not receive(:basic_cancel)
+          instance.stop
+        end
+      end
+
+      context "with a terminated consumer" do
+        before do
+          allow(consumer).to receive(:cancelled?).and_return(false)
+          allow(consumer).to receive(:terminated?).and_return(true)
+        end
+
+        it "should not call basic_cancel" do
+          expect(channel).to_not receive(:basic_cancel)
+          instance.stop
+        end
+      end
+
+      context "with a running consumer" do
+        before do
+          allow(consumer).to receive(:cancelled?).and_return(false)
+          allow(consumer).to receive(:terminated?).and_return(false, false, true)
+        end
+
+        it "should call basic_cancel" do
+          expect(channel).to receive(:basic_cancel).with(consumer_tag)
+          instance.stop
+        end
+
+        it "should log terminating info" do
+          allow(channel).to receive(:basic_cancel).with(consumer_tag)
+          expect(instance.logger).to receive(:info).with(/Waiting for RabbitMQ consumer to terminate before stopping/, anything)
+          instance.stop
+        end
+      end
+    end
+
     describe "#connect!" do
       subject { hare_info }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-rabbitmq
 version: !ruby/object:Gem::Version
-  version: 7.3.2
+  version: 7.3.3
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement