amqp-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf775bb44cd9021dec5416472d52dec17a5e0ae847de7d56ea0d3acd1e27b11
-  data.tar.gz: 589416e377d8d3bcc448991664666aab664b7dd194fb8990e0294251439d0838
+  metadata.gz: 337f82d8ebaf862fd8fd1acd17f9b71be2aaee6de02f0c7c59786b222d5c5c0c
+  data.tar.gz: 040adffbda90616864a845517a1904efa5c1dbb25e30e63febe3f34b3cf4f752
 SHA512:
-  metadata.gz: c3c5672321ffadc0966a3dd549697699be445a58db1448ac2e2cb2f06ad4a9b456036b64bfd52a1c35a56dd88301b36dea4cd639ca2d90155ead57d40b9ca16b
-  data.tar.gz: b23676715032b2fb4e909a550e6674155e1ef2be9fae08e543db6811b7f8a456c35ac09d57b0a0fa0c356e9eea954614221c33c27898beb30acd36f5b2c8e41d
+  metadata.gz: 5700b885356d0c36060ffb4a9ad819bc26672a3d89fef6283cb5c4789ae3ddeafeaa57917f3001947fbdc38954eabfb138b8a98ed4a187a66912e5fb47bb3200
+  data.tar.gz: 034c2aa88d93bf45063d41b87e92cb20545deadf7c98930a7b6626e448a84036d234274c8c1066a85e6fd35a1274dfb392128a037f6fac7a330aee0af9907a74

data/.github/workflows/main.yml

@@ -5,14 +5,31 @@ on: [push,pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
+    services:
+      rabbitmq:
+        image: rabbitmq:latest
+        ports:
+        - 5672/tcp
+        # needed because the rabbitmq container does not provide a healthcheck
+        options: >-
+          --health-cmd "rabbitmqctl node_health_check"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: ${{ matrix.ruby }}
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.15
         bundle install
         bundle exec rake
+      env:
+        AMQP_PORT: ${{ job.services.rabbitmq.ports[5672] }}
+

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-04-29 10:30:28 UTC using RuboCop version 1.12.1.
+# on 2021-06-01 23:54:39 UTC using RuboCop version 1.15.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,64 +11,62 @@
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 129
+  Max: 123
 
-# Offense count: 2
-Lint/ShadowedException:
-  Exclude:
-    - 'lib/amqp/client.rb'
-    - 'lib/amqp/client/connection.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/amqp/client/channel.rb'
-
-# Offense count: 6
+# Offense count: 15
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 52
+  Max: 142
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 76
+  Max: 37
 
-# Offense count: 3
+# Offense count: 2
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 148
+  Max: 191
 
-# Offense count: 5
+# Offense count: 9
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 18
+  Max: 30
 
-# Offense count: 9
+# Offense count: 26
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 83
+  Max: 124
 
-# Offense count: 1
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 300
+
+# Offense count: 5
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 6
+  Max: 7
 
-# Offense count: 3
+# Offense count: 7
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 12
+  Max: 18
 
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
+# Configuration parameters: EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
   Exclude:
-    - 'bm_append_string.rb'
+    - 'spec/**/*'
+    - 'lib/amqp/client/channel.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -78,9 +76,17 @@ Style/RescueStandardError:
   Exclude:
     - 'lib/amqp/client.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: forbid_for_all_comparison_operators, forbid_for_equality_operators_only, require_for_all_comparison_operators, require_for_equality_operators_only
+Style/YodaCondition:
+  Exclude:
+    - 'lib/amqp/client/channel.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 129
+  Max: 123

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+
+## [0.2.0] - 2021-08-19
+
+- Much improved and with a high level client
+
 ## [0.1.0] - 2021-04-13
 
 - Initial release

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+Low level API
+
 ```ruby
 require "amqp-client"
 
@@ -32,6 +34,35 @@ msg = ch.basic_get q[:queue_name]
 puts msg.body
 ```
 
+High level API, is an easier and safer API, that only deal with durable queues and persisted messages. All methods are blocking in the case of connection loss etc. It's also fully thread-safe. Don't expect it to be extreme throughput, be expect 100% delivery guarantees (messages might be deliviered twice, in the unlikely event of a connection loss between message publish and message confirmed by the server).
+
+```ruby
+amqp = AMQP::Client.new("amqp://localhost")
+amqp.start
+
+# Declares a durable queue
+q = amqp.queue("myqueue")
+
+# Bind the queue to any exchange, with any binding key
+q.bind("amq.topic", "my.events.*")
+
+# The message will be reprocessed if the client lost connection to the server
+# between the message arrived and the message was supposed to be ack:ed.
+q.subscribe(prefetch: 20) do |msg|
+  process(JSON.parse(msg.body))
+  msg.ack
+rescue
+  msg.reject(requeue: false)
+end
+
+# Publish directly to the queue
+q.publish { foo: "bar" }.to_json, content_type: "application/json"
+
+# Publish to any exchange
+amqp.publish("my message", "amq.topic", "topic.foo", headers: { foo: 'bar' })
+amqp.publish(Zlib.gzip("an event"), "amq.topic", "my.event", content_encoding: 'gzip')
+```
+
 ## Development
 
 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.

data/lib/amqp/client.rb

@@ -1,101 +1,169 @@
 # frozen_string_literal: true
 
-require "socket"
-require "uri"
-require "openssl"
+require "set"
 require_relative "client/version"
-require_relative "client/errors"
-require_relative "client/frames"
 require_relative "client/connection"
-require_relative "client/channel"
 
 module AMQP
   # AMQP 0-9-1 Client
   class Client
-    def initialize(uri)
-      @uri = URI.parse(uri)
-      @tls = @uri.scheme == "amqps"
-      @port = @uri.port || @tls ? 5671 : 5672
-      @host = @uri.host || "localhost"
-      @user = @uri.user || "guest"
-      @password = @uri.password || "guest"
-      @vhost = URI.decode_www_form_component(@uri.path[1..-1] || "/")
-      @options = URI.decode_www_form(@uri.query || "").to_h
+    def initialize(uri, **options)
+      @uri = uri
+      @options = options
+
+      @queues = {}
+      @subscriptions = Set.new
+      @connq = SizedQueue.new(1)
     end
 
-    def connect
-      socket = Socket.tcp @host, @port, connect_timeout: 20, resolv_timeout: 5
-      enable_tcp_keepalive(socket)
-      if @tls
-        context = OpenSSL::SSL::SSLContext.new
-        context.verify_mode = OpenSSL::SSL::VERIFY_PEER unless @options["verify_peer"] == "none"
-        socket = OpenSSL::SSL::SSLSocket.new(socket, context)
-        socket.sync_close = true # closing the TLS socket also closes the TCP socket
-      end
-      channel_max, frame_max, heartbeat = establish(socket)
-      Connection.new(socket, channel_max, frame_max, heartbeat)
+    def connect(read_loop_thread: true)
+      Connection.connect(@uri, **@options.merge(read_loop_thread: read_loop_thread))
     end
 
-    private
+    def start
+      @stopped = false
+      Thread.new do
+        loop do
+          break if @stopped
 
-    def establish(socket)
-      channel_max, frame_max, heartbeat = nil
-      socket.write "AMQP\x00\x00\x09\x01"
-      buf = String.new(capacity: 4096)
-      loop do
-        begin
-          socket.readpartial(4096, buf)
-        rescue EOFError, IOError, OpenSSL::Error => e
-          raise Error, "Could not establish AMQP connection: #{e.message}"
+          conn = connect(read_loop_thread: false)
+          Thread.new do
+            # restore connection in another thread, read_loop have to run
+            conn.channel(1) # reserve channel 1 for publishes
+            @subscriptions.each { |args| subscribe(*args) }
+            @connq << conn
+          end
+          conn.read_loop # blocks until connection is closed, then reconnect
+        rescue => e
+          warn "AMQP-Client reconnect error: #{e.inspect}"
+          sleep @options[:reconnect_interval] || 1
         end
+      end
+      self
+    end
 
-        type, channel_id, frame_size = buf.unpack("C S> L>")
-        frame_end = buf.unpack1("@#{frame_size + 7} C")
-        raise UnexpectedFrameEndError, frame_end if frame_end != 206
-
-        case type
-        when 1 # method frame
-          class_id, method_id = buf.unpack("@7 S> S>")
-          case class_id
-          when 10 # connection
-            raise Error, "Unexpected channel id #{channel_id} for Connection frame" if channel_id != 0
-
-            case method_id
-            when 10 # connection#start
-              socket.write FrameBytes.connection_start_ok "\u0000#{@user}\u0000#{@password}"
-            when 30 # connection#tune
-              channel_max, frame_max, heartbeat = buf.unpack("@11 S> L> S>")
-              channel_max = [channel_max, 2048].min
-              frame_max = [frame_max, 4096].min
-              heartbeat = [heartbeat, 0].min
-              socket.write FrameBytes.connection_tune_ok(channel_max, frame_max, heartbeat)
-              socket.write FrameBytes.connection_open(@vhost)
-            when 41 # connection#open-ok
-              return [channel_max, frame_max, heartbeat]
-            when 50 # connection#close
-              code, text_len = buf.unpack("@11 S> C")
-              text, error_class_id, error_method_id = buf.unpack("@14 a#{text_len} S> S>")
-              socket.write FrameBytes.connection_close_ok
-              raise Error, "Could not establish AMQP connection: #{code} #{text} #{error_class_id} #{error_method_id}"
-            else raise Error, "Unexpected class/method: #{class_id} #{method_id}"
-            end
-          else raise Error, "Unexpected class/method: #{class_id} #{method_id}"
+    def stop
+      @stopped = true
+      conn = @connq.pop
+      conn.close
+      nil
+    end
+
+    def queue(name, arguments: {})
+      raise ArgumentError, "Currently only supports named, durable queues" if name.empty?
+
+      @queues.fetch(name) do
+        with_connection do |conn|
+          conn.with_channel do |ch| # use a temp channel in case the declaration fails
+            ch.queue_declare(name, arguments: arguments)
           end
-        else raise Error, "Unexpected frame type: #{type}"
         end
+        @queues[name] = Queue.new(self, name)
       end
-    rescue StandardError
-      socket.close
-      raise
     end
 
-    def enable_tcp_keepalive(socket)
-      socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
-      socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPIDLE, 60)
-      socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPINTVL, 10)
-      socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPCNT, 3)
+    def subscribe(queue_name, no_ack: false, prefetch: 1, worker_threads: 1, arguments: {}, &blk)
+      @subscriptions.add? [queue_name, no_ack, prefetch, arguments, blk]
+
+      with_connection do |conn|
+        ch = conn.channel
+        ch.basic_qos(prefetch)
+        ch.basic_consume(queue_name, no_ack: no_ack, worker_threads: worker_threads, arguments: arguments) do |msg|
+          blk.call(msg)
+        end
+      end
+    end
+
+    def publish(body, exchange, routing_key, **properties)
+      with_connection do |conn|
+        # Use channel 1 for publishes
+        conn.channel(1).basic_publish_confirm(body, exchange, routing_key, **properties)
+      rescue
+        conn.channel(1) # reopen channel 1 if it raised
+        raise
+      end
     rescue => e
-      warn "amqp-client: Could not enable TCP keepalive on socket. #{e.inspect}"
+      warn "AMQP-Client error publishing, retrying (#{e.inspect})"
+      retry
+    end
+
+    def bind(queue, exchange, routing_key, **headers)
+      with_connection do |conn|
+        conn.channel(1).queue_bind(queue, exchange, routing_key, **headers)
+      end
+    end
+
+    def unbind(queue, exchange, routing_key, **headers)
+      with_connection do |conn|
+        conn.channel(1).queue_unbind(queue, exchange, routing_key, **headers)
+      end
+    end
+
+    def purge(queue)
+      with_connection do |conn|
+        conn.channel(1).queue_purge(queue)
+      end
+    end
+
+    def delete_queue(queue)
+      with_connection do |conn|
+        conn.channel(1).queue_delete(queue)
+      end
+    end
+
+    # Queue abstraction
+    class Queue
+      def initialize(client, name)
+        @client = client
+        @name = name
+      end
+
+      def publish(body, **properties)
+        @client.publish(body, "", @name, **properties)
+        self
+      end
+
+      def subscribe(prefetch: 1, arguments: {}, &blk)
+        @client.subscribe(@name, prefetch: prefetch, arguments: arguments, &blk)
+        self
+      end
+
+      def bind(exchange, routing_key, **headers)
+        @client.bind(@name, exchange, routing_key, **headers)
+        self
+      end
+
+      def unbind(exchange, routing_key, **headers)
+        @client.unbind(@name, exchange, routing_key, **headers)
+        self
+      end
+
+      def purge
+        @client.purge(@name)
+        self
+      end
+
+      def delete
+        @client.delete_queue(@name)
+        nil
+      end
+    end
+
+    private
+
+    def with_connection
+      conn = nil
+      loop do
+        conn = @connq.pop
+        next if conn.closed?
+
+        break
+      end
+      begin
+        yield conn
+      ensure
+        @connq << conn unless conn.closed?
+      end
     end
   end
 end