amqp-client 1.1.5 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a9c50ecceb8a9d86bfea50d67957c1b063c47d35d85291b29e79b2631de262
-  data.tar.gz: 055da4bc7ab51bac9f6839bf225c4f737b8aa766320609031ed68fa6b709cb88
+  metadata.gz: 7b2125fb98c3f0172a05bce1cbf8aa0b6530df76685522c4d25772fa1edd2dc4
+  data.tar.gz: 204891c1da627b813f37b160029ab55ecf58c91481949b02dc5bf3b163288d0c
 SHA512:
-  metadata.gz: 52e1eabb4edbadae0d7998946024b8f82b5bd0d3feb2f079cc96643c7dc4774aec3eed6f00563c8b689fc07546a9b1443605fca0f573e2f23fe42b3ff128fd7d
-  data.tar.gz: 46b81356c5bcbb4931f76f676e2416fddfcc1d396624fff35f61d117dfcb77d3ec63c16878253bc4a0810526adfd2267d93a43466217901fa21886112710845d
+  metadata.gz: 290ce1a3d301e1119056e39eeb309b55d7fa0752e7bc4b012777ccab7c506f62eef255bffc7b62258bf8a56a22ea46e19f42c00ad91f4b8441b7ecf414c29c8d
+  data.tar.gz: 22070957cc3c58d77f7d6c15476943a9f23ab34496dfc473618c4625c4f8531eddcfc8fb92086bf566aaf548d650045c65617ac68d73a49ec07c4ad4f971030a

data/.github/workflows/main.yml

@@ -1,6 +1,12 @@
 name: Ruby
 
-on: [push,pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   tests:

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [1.1.7] - 2024-05-12
+
+- Support for Connection.update-secret
+- Allow sub-second connect_timeout
+- Fixed: undefinied variable if message was returned and no on_return block was set
+
+## [1.1.6] - 2024-03-26
+
+- Fixed: Channel#wait_for_confirms now waits for all confirms, in a thread safe way
+- Changed: When server sends Connection.blocked the client isn't write blocked anymore, and can continue consume for instance. However, the on_blocked/unblocked callbacks should be used and manually stop publishing as the server otherwise will stop reading from the client socket.
+
 ## [1.1.5] - 2024-03-15
 
 - Fixed: Correctly reference the `UnexpectedFrameEnd` exception

data/CODEOWNERS

@@ -0,0 +1 @@
+* @84codes/customer

data/Gemfile

@@ -11,6 +11,8 @@ gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.7"
 
+gem "rubocop-minitest", require: false
+
 gem "yard", require: false
 
-gem "rubocop-minitest", require: false
+gem "redcarpet", require: false, platforms: :ruby

data/README.md

@@ -123,7 +123,7 @@ Or install it yourself as:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the changelog and version number in `version.rb`, make a commit, and then run `bundle exec rake release:source_control_push`, which will create a git tag for the version, push git commits and the created tag. GitHub Actions will then push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the changelog and version number in `version.rb`, make a commit, and then run `bundle exec rake release:source_control_push`, which will create a git tag for the version, push git commits and the created tag. GitHub Actions will then push the `.gem` file to [rubygems.org](https://rubygems.org/gems/amqp-client).
 
 ## Contributing
 

data/Rakefile

@@ -22,4 +22,8 @@ RuboCop::RakeTask.new do |task|
   task.requires << "rubocop-minitest"
 end
 
+require "yard"
+
+YARD::Rake::YardocTask.new
+
 task default: [:test, *(:rubocop if RUBY_ENGINE == "ruby")]

data/lib/amqp/client/channel.rb

@@ -22,8 +22,9 @@ module AMQP
           @open = false
           @on_return = nil
           @confirm = nil
-          @unconfirmed = ::Queue.new
-          @unconfirmed_empty = ::Queue.new
+          @unconfirmed = []
+          @unconfirmed_lock = Mutex.new
+          @unconfirmed_empty = ConditionVariable.new
           @basic_gets = ::Queue.new
         end
 
@@ -60,7 +61,7 @@ module AMQP
           expect :channel_close_ok
           @replies.close
           @basic_gets.close
-          @unconfirmed_empty.close
+          @unconfirmed_lock.synchronize { @unconfirmed_empty.broadcast }
           @consumers.each_value(&:close)
           nil
         end
@@ -73,7 +74,7 @@ module AMQP
           @closed = [level, code, reason, classid, methodid]
           @replies.close
           @basic_gets.close
-          @unconfirmed_empty.close
+          @unconfirmed_lock.synchronize { @unconfirmed_empty.broadcast }
           @consumers.each_value(&:close)
           @consumers.each_value(&:clear) # empty the queues too, messages can't be acked anymore
           nil
@@ -267,12 +268,15 @@ module AMQP
           when true then properties[:delivery_mode] = 2
           when false then properties[:delivery_mode] = 1
           end
-
+          if @confirm
+            @unconfirmed_lock.synchronize do
+              @unconfirmed.push @confirm += 1
+            end
+          end
           if body.bytesize.between?(1, body_max)
             write_bytes FrameBytes.basic_publish(id, exchange, routing_key, mandatory),
                         FrameBytes.header(id, body.bytesize, properties),
                         FrameBytes.body(id, body)
-            @unconfirmed.push @confirm += 1 if @confirm
             return
           end
 
@@ -285,7 +289,6 @@ module AMQP
             write_bytes FrameBytes.body(id, body_part)
             pos += len
           end
-          @unconfirmed.push @confirm += 1 if @confirm
           nil
         end
 
@@ -396,42 +399,44 @@ module AMQP
         # @param no_wait [Boolean] If false the method will block until the broker has confirmed the request
         # @return [nil]
         def confirm_select(no_wait: false)
-          return if @confirm
+          return if @confirm # fast path
 
-          write_bytes FrameBytes.confirm_select(@id, no_wait)
-          expect :confirm_select_ok unless no_wait
-          @confirm = 0
+          @unconfirmed_lock.synchronize do
+            # check again in case another thread already did this while we waited for the lock
+            return if @confirm
+
+            write_bytes FrameBytes.confirm_select(@id, no_wait)
+            expect :confirm_select_ok unless no_wait
+            @confirm = 0
+          end
           nil
         end
 
         # Block until all publishes messages are confirmed
-        # @return [Boolean] True if all message where positivly acknowledged, false if not
+        # @return nil
         def wait_for_confirms
-          return true if @unconfirmed.empty?
-
-          ok = @unconfirmed_empty.pop
-          raise Error::Closed.new(@id, *@closed) if ok.nil?
-
-          ok
+          @unconfirmed_lock.synchronize do
+            until @unconfirmed.empty?
+              @unconfirmed_empty.wait(@unconfirmed_lock)
+              raise Error::Closed.new(@id, *@closed) if @closed
+            end
+          end
         end
 
         # Called by Connection when received ack/nack from broker
         # @api private
         def confirm(args)
-          ack_or_nack, delivery_tag, multiple = *args
-          loop do
-            tag = @unconfirmed.pop(true)
-            break if tag == delivery_tag
-            next if multiple && tag < delivery_tag
-
-            @unconfirmed << tag # requeue
-          rescue ThreadError
-            break
+          _ack_or_nack, delivery_tag, multiple = *args
+          @unconfirmed_lock.synchronize do
+            case multiple
+            when true
+              idx = @unconfirmed.index(delivery_tag) || raise("Delivery tag not found")
+              @unconfirmed.shift(idx + 1)
+            when false
+              @unconfirmed.delete(delivery_tag) || raise("Delivery tag not found")
+            end
+            @unconfirmed_empty.broadcast if @unconfirmed.empty?
           end
-          return unless @unconfirmed.empty?
-
-          ok = ack_or_nack == :ack
-          @unconfirmed_empty.push(ok) until @unconfirmed_empty.num_waiting.zero?
         end
 
         # @!endgroup
@@ -517,7 +522,7 @@ module AMQP
             if @on_return
               Thread.new { @on_return.call(next_msg) }
             else
-              warn "AMQP-Client message returned: #{msg.inspect}"
+              warn "AMQP-Client message returned: #{next_msg.inspect}"
             end
           elsif next_msg.consumer_tag.nil?
             @basic_gets.push next_msg

data/lib/amqp/client/connection.rb

@@ -18,7 +18,7 @@ module AMQP
       # @option options [Boolean] connection_name (PROGRAM_NAME) Set a name for the connection to be able to identify
       #   the client from the broker
       # @option options [Boolean] verify_peer (true) Verify broker's TLS certificate, set to false for self-signed certs
-      # @option options [Integer] connect_timeout (30) TCP connection timeout
+      # @option options [Float] connect_timeout (30) TCP connection timeout
       # @option options [Integer] heartbeat (0) Heartbeat timeout, defaults to 0 and relies on TCP keepalive instead
       # @option options [Integer] frame_max (131_072) Maximum frame size,
       #    the smallest of the client's and the broker's values will be used
@@ -54,6 +54,16 @@ module AMQP
         Thread.new { read_loop } if read_loop_thread
       end
 
+      # Indicates that the server is blocking publishes.
+      # If the client keeps publishing the server will stop reading from the socket.
+      # Use the #on_blocked callback to get notified when the server is resource constrained.
+      # @see #on_blocked
+      # @see #on_unblocked
+      # @return [Bool]
+      def blocked?
+        !@blocked.nil?
+      end
+
       # Alias for {#initialize}
       # @see #initialize
       # @deprecated
@@ -122,6 +132,16 @@ module AMQP
         nil
       end
 
+      # Update authentication secret, for example when an OAuth backend is used
+      # @param secret [String] The new secret
+      # @param reason [String] A reason to update it
+      # @return [nil]
+      def update_secret(secret, reason)
+        write_bytes FrameBytes.update_secret(secret, reason)
+        expect(:update_secret_ok)
+        nil
+      end
+
       # True if the connection is closed
       # @return [Boolean]
       def closed?
@@ -241,12 +261,12 @@ module AMQP
               reason_len = buf.getbyte(4)
               reason = buf.byteslice(5, reason_len).force_encoding("utf-8")
               @blocked = reason
-              @write_lock.lock
               @on_blocked.call(reason)
             when 61 # connection#unblocked
-              @write_lock.unlock
               @blocked = nil
               @on_unblocked.call
+            when 71 # connection#update_secret_ok
+              @replies.push [:update_secret_ok]
             else raise Error::UnsupportedMethodFrame, class_id, method_id
             end
           when 20 # channel
@@ -406,7 +426,7 @@ module AMQP
       # @return [Socket]
       # @return [OpenSSL::SSL::SSLSocket]
       def open_socket(host, port, tls, options)
-        connect_timeout = options.fetch(:connect_timeout, 30).to_i
+        connect_timeout = options.fetch(:connect_timeout, 30).to_f
         socket = Socket.tcp host, port, connect_timeout: connect_timeout
         keepalive = options.fetch(:keepalive, "").split(":", 3).map!(&:to_i)
         enable_tcp_keepalive(socket, *keepalive)

data/lib/amqp/client/frame_bytes.rb

@@ -81,6 +81,20 @@ module AMQP
         ].pack("C S> L> S> S> C")
       end
 
+      def self.update_secret(secret, reason)
+        frame_size = 4 + 4 + secret.bytesize + 1 + reason.bytesize
+        [
+          1, # type: method
+          0, # channel id
+          frame_size, # frame size
+          10, # class: connection
+          70, # method: close-ok
+          secret.bytesize, secret,
+          reason.bytesize, reason,
+          206 # frame end
+        ].pack("C S> L> S> S> L>a* Ca* C")
+      end
+
       def self.channel_open(id)
         [
           1, # type: method

data/lib/amqp/client/version.rb

@@ -3,6 +3,6 @@
 module AMQP
   class Client
     # Version of the client library
-    VERSION = "1.1.5"
+    VERSION = "1.1.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amqp-client
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.7
 platform: ruby
 authors:
 - Carl Hörberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-05-12 00:00:00.000000000 Z
 dependencies: []
 description: Modern AMQP 0-9-1 Ruby client
 email:
@@ -26,6 +26,7 @@ files:
 - ".rubocop_todo.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CODEOWNERS
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: AMQP 0-9-1 client