logstash-integration-rabbitmq 7.4.0-java → 7.4.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b1b48521b0094de4590f515bf7a0e5b100c31437dfcfd6441054e663a862c3
-  data.tar.gz: cface3e3fa3835787b3f9ca5d9e5447e65d8c2a0473445a41a7984beab07ac56
+  metadata.gz: 6307e3495481416481bb5e9caa66e1b6cfcae0c4b03dc4389f16c82820cc4043
+  data.tar.gz: d1bad3275ba3698ee2233449bd18eae7e9ce2973234a682e759d6e533a2201f8
 SHA512:
-  metadata.gz: f94cf03c38e5a6668898cf90cb76f94a56b97c49a150c54a1ed058bd1e8ebd0c6df1061bf4629bb6c93347698a373285d3c28a5ec6acfa263656e44920ecd7ac
-  data.tar.gz: e63a13e0164a381817198b8adf84b149fc278ce7b57b00ba7ed0dc7388b6dbff1a0b9fc5151e1cc488af19eb4ad3e2eb0593ee051157edc175678148f2027521
+  metadata.gz: 7410e75bc589079185f944952fdeecb10ad16bf2f7c68e4bd5071bf89715d22e65cb1d99d09b56677459e5837fdacc672e63040a5a953402a5baba20bb142c14
+  data.tar.gz: 2e02696d7c21c9ac2acdb834c462bc34833fc62af33f4babaf8031b10c6cf879cb8f5edaa97b4f133bd534d4d389f21e11c80bbb5f04d447429563326f15feff

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 7.4.1
+  - Improve thread safety to avoid race conditions during shutdown and integration tests. [#67](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/66)
+
 ## 7.4.0
   - Removed obsolete `verify_ssl` and `debug` options [#60](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/60)
 

data/lib/logstash/inputs/rabbitmq.rb

@@ -59,6 +59,7 @@ module LogStash
     class RabbitMQ < LogStash::Inputs::Threadable
 
       java_import java.util.concurrent.TimeUnit
+      java_import java.util.concurrent.CountDownLatch
 
       include ::LogStash::PluginMixins::RabbitMQConnection
 
@@ -189,6 +190,7 @@ module LogStash
         connect!
         declare_queue!
         bind_exchange!
+        @poison_latch = CountDownLatch.new(1)
         @hare_info.channel.prefetch = @prefetch_count
       rescue => e
         # when encountering an exception during shut-down,
@@ -268,7 +270,11 @@ module LogStash
             next
           end
 
-          break if payload == INTERNAL_QUEUE_POISON
+          if payload == INTERNAL_QUEUE_POISON
+            @logger.info("RabbitMQ consumer thread received shutdown signal, exiting")
+            @poison_latch.countDown
+            break
+          end
 
           metadata, data = payload
           @codec.decode(data) do |event|
@@ -302,11 +308,22 @@ module LogStash
       end
 
       def stop
-        @internal_queue.put(INTERNAL_QUEUE_POISON)
+        stop_consumer_thread
         shutdown_consumer
         close_connection
       end
 
+      def stop_consumer_thread
+        # After sending the poison pill, we need to wait for the consumer thread to actually exit.
+        # Closing channel right away may lead to messages not being acked properly or a race condition
+        # where the consumer thread tries to ack a message on a closed channel.
+        @internal_queue.put(INTERNAL_QUEUE_POISON)
+        timed_out = !@poison_latch.await(2, TimeUnit::SECONDS)
+        if timed_out
+          @logger.warn("Timeout waiting for RabbitMQ consumer thread to terminate")
+        end
+      end
+
       def shutdown_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

data/logstash-integration-rabbitmq.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-integration-rabbitmq'
-  s.version         = '7.4.0'
+  s.version         = '7.4.1'
   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

@@ -33,7 +33,6 @@ describe LogStash::Inputs::RabbitMQ do
     let(:connection) { double("MarchHare Connection") }
     let(:channel) { double("Channel") }
     let(:exchange) { double("Exchange") }
-    let(:channel) { double("Channel") }
     let(:queue) { double("queue") }
 
     # Doing this in a before block doesn't give us enough control over scope
@@ -76,6 +75,12 @@ describe LogStash::Inputs::RabbitMQ do
         allow(consumer).to receive(:consumer_tag).and_return(consumer_tag)
       end
 
+      after do
+        # This unit tests don't initialize consumer thread, so sync signal should be manually sent.
+        instance.instance_variable_get(:@poison_latch).countDown
+        instance.stop
+      end
+
       context "with a cancelled consumer" do
         before do
           allow(consumer).to receive(:cancelled?).and_return(true)
@@ -84,7 +89,6 @@ describe LogStash::Inputs::RabbitMQ do
 
         it "should not call basic_cancel" do
           expect(channel).to_not receive(:basic_cancel)
-          instance.stop
         end
       end
 
@@ -96,7 +100,6 @@ describe LogStash::Inputs::RabbitMQ do
 
         it "should not call basic_cancel" do
           expect(channel).to_not receive(:basic_cancel)
-          instance.stop
         end
       end
 
@@ -108,13 +111,11 @@ describe LogStash::Inputs::RabbitMQ do
 
         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
@@ -384,24 +385,30 @@ describe "LogStash::Inputs::RabbitMQ with a live server", :integration => true d
   let(:hare_info) { instance.instance_variable_get(:@hare_info) }
   let(:output_queue) { Queue.new }
 
-  # Spawn a connection in the bg and wait up (n) seconds
+  # Spawn a connection and waits for it to be ready.
   def spawn_and_wait(instance)
     instance.register
 
     output_queue # materialize in this thread
 
-    Thread.new {
+    @consumer_thread = Thread.new {
       instance.run(output_queue)
     }
 
-    20.times do
-      instance.send(:connection_open?) ? break : sleep(0.1)
+    # Ensure that the connection and channel are fully started.
+    Timeout.timeout(2, Timeout::Error, "Timeout waiting for connection to open and channel to be available") do
+      until instance.send(:connection_open?) && instance.instance_variable_get(:@hare_info)&.channel
+        sleep 0.05
+      end
     end
 
-    # Extra time to make sure the consumer can attach
-    # Without this there's a chance the shutdown code will execute
-    # before consumption begins. This is tricky to do more elegantly
-    sleep 4
+    # Ensure that the consumer is fully started.
+    hare_info = instance.instance_variable_get(:@hare_info)
+    Timeout.timeout(10, Timeout::Error, "Timeout waiting for channel to have consumers.") do
+      until hare_info.channel.consumers && !hare_info.channel.consumers.empty?
+        sleep 0.05
+      end
+    end
   end
 
   let(:test_connection) { MarchHare.connect(instance.send(:rabbitmq_settings)) }
@@ -418,6 +425,11 @@ describe "LogStash::Inputs::RabbitMQ with a live server", :integration => true d
 
   after do
     instance.stop()
+    # Stop the thread gracefully before tearing down connections.
+    @consumer_thread.join
+    # Exchange deletion needs to be placed after thread is finished,
+    # as the exchange may be dynamically created during the test context initialization.
+    exchange&.delete if defined?(exchange)
     test_channel.close
     test_connection.close
   end
@@ -440,10 +452,6 @@ describe "LogStash::Inputs::RabbitMQ with a live server", :integration => true d
     #let(:queue) { test_channel.queue(queue_name, :auto_delete => true) }
     let(:queue_name) { "logstash-input-rabbitmq-#{rand(0xFFFFFFFF)}" }
 
-    after do
-      exchange.delete
-    end
-
     context "when the message has a payload but no message headers" do
       before do
         exchange.publish(message)

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-rabbitmq
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 7.4.1
 platform: java
 authors:
 - Elastic
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2025-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -19,7 +19,6 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
-  name: logstash-core-plugin-api
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,12 +30,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
 - !ruby/object:Gem::Dependency
+  name: logstash-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.5.0
-  name: logstash-core
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -45,12 +44,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.5.0
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-json
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,12 +58,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: march_hare
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-  name: march_hare
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -73,12 +72,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
+  name: stud
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.22
-  name: stud
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -87,12 +86,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.22
 - !ruby/object:Gem::Dependency
+  name: back_pressure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-  name: back_pressure
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -101,12 +100,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
+  name: logstash-devutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  name: logstash-devutils
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -115,12 +114,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
+  name: logstash-input-generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-input-generator
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -129,12 +128,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-plain
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -202,7 +201,6 @@ metadata:
   logstash_plugin: 'true'
   logstash_group: integration
   integration_plugins: logstash-input-rabbitmq,logstash-output-rabbitmq
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,8 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Integration with RabbitMQ - input and output plugins
 test_files: