surfliner-metadata_consumer 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fff0fe7a29854ecb3b75f91ed5aa1e5abdbf6fe7fc625b4b117a3e2c4e4805c
-  data.tar.gz: 534536637b909d309f90095aaba4e9cb51a75d4ca92a78531971d3550ea42bfc
+  metadata.gz: 25566009d8ccce03904d9020a0340511bbeb2fac08b5151c65705cd2d6117096
+  data.tar.gz: 24136a3ca25672bf7fcc8670ea61f11a34c547b515022f92e46b440fe1d315cc
 SHA512:
-  metadata.gz: 6e20f325aa14042b5ed7e950803d8a045834df543da1f5c4a8f30297645015d97add22a5de38e01d15a6ab74adb856777bba4fccfb609d50bd622c9fae1f51d5
-  data.tar.gz: a69109802f8c408f077b2fc2d1c748c02a900eda042d6e40a4423ee3257b39d2dde892eecf9c77c690df06aa53d367136a8246f3d8bc69114d0e1278326b4531
+  metadata.gz: fef5c2196922e8f5476422ffd83400bc17edc957b0822a323628dd9cd525440e231e1d7402b761c71894806282c2ad11c8c450eb6dc37a6a6e99dac7d3adc9c5
+  data.tar.gz: 5014bdadb04910ca9888d8fe445342641462e33f6ec445333c4502dd322e428df5c5ecd01710018d7f905e80a889ce84815f7ff59b1d3908c00b405d5f02c048

data/CHANGES.md

@@ -1,3 +1,15 @@
+# 0.1.0.pre.alpha.6 (2025-04-25)
+
+- Update to Bunny 2.24
+- Allow `Mq::Connection#connect` to take a block, in which case the method
+  yields the open connection, closing the connection and channel afterwards.
+- Add an option `await_response_on_close` to `Mq::ConnectionConfig`, defaulting
+  to true, to indicate whether the RabbitMQ client should wait for a response
+  when closing a session, along with a corresponding environment variable
+  `RABBITMQ_AWAIT_ON_CLOSE`
+- Allows passing additional options to `Mq:ConnectionConfig#initialize` and
+  `#from_env`, which will then be passed to `Bunny::Session#initialize`
+
 # 0.1.0.pre.alpha.5 (2025-03-25)
 
 In order to support using one connection (and one underlying `Bunny::Session`) 

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    surfliner-metadata_consumer (0.1.0.pre.alpha.5)
-      bunny (~> 2.23)
+    surfliner-metadata_consumer (0.1.0.pre.alpha.6)
+      bunny (~> 2.24)
       opentelemetry-exporter-otlp (~> 0.26.3)
       opentelemetry-instrumentation-all (~> 0.60.0)
       opentelemetry-sdk (~> 1.4.1)
@@ -37,26 +37,26 @@ GEM
     diff-lcs (1.6.1)
     docile (1.4.1)
     dotenv (2.8.1)
-    faraday (2.12.2)
+    faraday (2.13.1)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
     github-markup (5.0.1)
-    google-protobuf (3.25.6)
+    google-protobuf (3.25.7)
     googleapis-common-protos-types (1.19.0)
       google-protobuf (>= 3.18, < 5.a)
     hashdiff (1.1.2)
     io-console (0.8.0)
-    irb (1.15.1)
+    irb (1.15.2)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.10.2)
+    json (2.11.3)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    logger (1.6.6)
+    logger (1.7.0)
     net-http (0.6.0)
       uri
     opentelemetry-api (1.5.0)
@@ -255,8 +255,8 @@ GEM
       opentelemetry-semantic_conventions
     opentelemetry-semantic_conventions (1.11.0)
       opentelemetry-api (~> 1.0)
-    parallel (1.26.3)
-    parser (3.3.7.2)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
     pp (0.6.2)
@@ -271,11 +271,11 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     rbtree (0.4.6)
-    rdoc (6.13.0)
+    rdoc (6.13.1)
       psych (>= 4.0.0)
     redcarpet (3.6.1)
     regexp_parser (2.10.0)
-    reline (0.6.0)
+    reline (0.6.1)
       io-console (~> 0.5)
     rexml (3.4.1)
     rsolr (2.6.0)
@@ -294,7 +294,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.2)
-    rubocop (1.73.2)
+    rubocop (1.75.3)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -302,15 +302,15 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.43.0)
+    rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-performance (1.24.0)
+    rubocop-performance (1.25.0)
       lint_roller (~> 1.1)
-      rubocop (>= 1.72.1, < 2.0)
+      rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
     ruby-progressbar (1.13.0)
     set (1.1.1)
@@ -326,19 +326,19 @@ GEM
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
-    standard (1.47.0)
+    standard (1.49.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.73.0)
+      rubocop (~> 1.75.2)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.7)
+      standard-performance (~> 1.8)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.7.0)
+    standard-performance (1.8.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.24.0)
-    stringio (3.1.6)
+      rubocop-performance (~> 1.25.0)
+    stringio (3.1.7)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
@@ -370,4 +370,4 @@ DEPENDENCIES
   yard (~> 0.9.37)
 
 BUNDLED WITH
-   2.6.2
+   2.6.7

data/README.md

@@ -44,12 +44,13 @@ explicitly with a `ConnectionConfig` object, or implicitly, reading a default
 configuration with `ConnectionConfig#from_env`. `ConnectionConfig#from_env` expects
 the following environment variables:
 
-| Variable                    | Sample value | Description                  |
-|-----------------------------|--------------|------------------------------|
-| `RABBITMQ_HOST`             | `rabbitmq`   | Hostname of RabbitMQ server  |
-| `RABBITMQ_NODE_PORT_NUMBER` | `5672`       | Port name of RabbitMQ server |
-| `RABBITMQ_USERNAME`         | `user`       | RabbitMQ username            |
-| `RABBITMQ_PASSWORD`         | `bitnami`    | RabbitMQ password            |
+| Variable                    | Sample value | Description                                               |
+|-----------------------------|--------------|-----------------------------------------------------------|
+| `RABBITMQ_HOST`             | `rabbitmq`   | Hostname of RabbitMQ server                               |
+| `RABBITMQ_NODE_PORT_NUMBER` | `5672`       | Port name of RabbitMQ server                              |
+| `RABBITMQ_USERNAME`         | `user`       | RabbitMQ username                                         |
+| `RABBITMQ_PASSWORD`         | `bitnami`    | RabbitMQ password                                         |
+| `RABBITMQ_AWAIT_ON_CLOSE`   | `false`      | Whether to wait on response when closing (default = true) |
 
 The `Mq::Connection#with_topic` and `Mq::Connection#topic_from` can either take an
 explicit `TopicConfig` object, or implicitly read a default configuration with

data/lib/surfliner/metadata_consumer/version.rb

@@ -2,6 +2,6 @@
 module Surfliner
   module MetadataConsumer
     # The gem version
-    VERSION = "0.1.0.pre.alpha.5"
+    VERSION = "0.1.0.pre.alpha.6"
   end
 end

data/lib/surfliner/mq/connection.rb

@@ -28,26 +28,22 @@ module Surfliner
         @config = not_nil!(config)
       end
 
-      # Opens a connection.
-      # @return [self]
+      # Opens this connection and creates a channel. If a block is
+      # given, yields the open connection, closing the connection and
+      # channel afterwards; otherwise, returns the open connection.
+      # @return [self] an open connection
+      # @yieldparam connection [self] an open connection
       # @raise [IOError] if already connected
       def connect
-        raise IOError, "RabbitMQ session #{session} already open." if open?
+        init_connection
 
-        logger.info("Rabbitmq message broker session url: #{config.redacted_url}")
-        @session = Bunny.new(config.session_url, logger: logger)
-        connect_on(session)
-        @channel = session.create_channel
+        return self unless block_given?
 
-        self
-      rescue Bunny::TCPConnectionFailed => err
-        # TODO: realistically, this only happens in session.start, where we're eating it
-        logger.error("Connection to #{config.redacted_url} failed")
-        raise err
-      rescue Bunny::PossibleAuthenticationFailureError => err
-        # TODO: realistically, this only happens in session.start, where we're eating it
-        logger.error("Failed to authenticate to #{config.redacted_url}")
-        raise err
+        begin
+          yield self
+        ensure
+          close
+        end
       end
 
       # Opens a session, yields a client for the specified topic, and closes the
@@ -55,11 +51,9 @@ module Surfliner
       # @param config [TopicConfig] topic configuration
       # @yield [MqTopic] A client for the topic
       def with_topic(config = TopicConfig.from_env)
-        connect
-
-        yield topic_from(config)
-      ensure
-        close
+        connect do |cxn|
+          yield cxn.topic_from(config)
+        end
       end
 
       # Returns a client for the specified topic. Note that this does _not_ open
@@ -76,13 +70,9 @@ module Surfliner
 
       # Closes the session.
       def close
-        return unless channel
-        return if channel.closed?
-        logger.info("closing channel")
-        channel.close
-      ensure
         logger.info("closing session")
-        session&.close
+        # Note: This will also close any open channels
+        session&.close(config.await_response_on_close)
       end
 
       # @return [true, false] True if the session is open, false otherwise
@@ -107,6 +97,24 @@ module Surfliner
 
       private
 
+      def init_connection
+        raise IOError, "RabbitMQ session #{session} already open." if open?
+
+        logger.info("Rabbitmq message broker session url: #{config.redacted_url}")
+        opts = {logger:}.merge(config.opts)
+        @session = Bunny.new(config.session_url, **opts)
+        connect_on(session)
+        @channel = session.create_channel
+      rescue Bunny::TCPConnectionFailed => err
+        # TODO: realistically, this only happens in session.start, where we're eating it
+        logger.error("Connection to #{config.redacted_url} failed")
+        raise err
+      rescue Bunny::PossibleAuthenticationFailureError => err
+        # TODO: realistically, this only happens in session.start, where we're eating it
+        logger.error("Failed to authenticate to #{config.redacted_url}")
+        raise err
+      end
+
       def connect_on(session, timeout = 120)
         timer = 0
         logger.info "Trying to open queue session with timeout=#{timeout}"

data/lib/surfliner/mq/connection_config.rb

@@ -2,6 +2,8 @@ module Surfliner
   module Mq
     # An object encapsulating RabbitMQ configuration.
     class ConnectionConfig
+      FALSE_VALUES = ([""] + %w[0 off Off OFF f false False FALSE F n no No NO N]).freeze
+
       # @return [String]  The RabbitMQ hostname
       attr_reader :host
 
@@ -14,36 +16,49 @@ module Surfliner
       # @return [String]  The RabbitMQ passsword
       attr_reader :password
 
+      # @return [Boolean] whether the RabbitMQ client should wait for a response when closing the connection
+      attr_reader :await_response_on_close
+
+      # @return [Hash] Additional RabbitMQ connection options (see Bunny::Session#initialize)
+      attr_reader :opts
+
       # Initializes a new `MqConfig` object.
       # @param host [String] RabbitMQ hostname
       # @param port [String] RabbitMQ AMQP port
       # @param username [String] RabbitMQ username
       # @param password [String] RabbitMQ passsword
-      def initialize(host:, port:, username:, password:)
+      # @param await_response_on_close [Boolean] whether the RabbitMQ client should wait for a response when closing the connection
+      # @param opts [Hash] additional RabbitMQ conection options (see Bunny::Session#initialize)
+      def initialize(host:, port:, username:, password:, await_response_on_close: true, **opts)
         @host = host
         @port = port
         @username = username
         @password = password
+        @await_response_on_close = parse_boolean(await_response_on_close)
+        @opts = opts
       end
 
       class << self
         # Reads RabbitMQ configuration from environment variables and
         # returns it as a new `ConnectionConfig` object.
         #
-        # | Variable                    | Sample value | Description                  |
-        # |-----------------------------|--------------|------------------------------|
-        # | `RABBITMQ_HOST`             | `rabbitmq`   | Hostname of RabbitMQ server  |
-        # | `RABBITMQ_NODE_PORT_NUMBER` | `5672`       | Port name of RabbitMQ server |
-        # | `RABBITMQ_USERNAME`         | `user`       | RabbitMQ username            |
-        # | `RABBITMQ_PASSWORD`         | `bitnami`    | RabbitMQ password            |
+        # | Variable                    | Sample value | Description                                               |
+        # |-----------------------------|--------------|-----------------------------------------------------------|
+        # | `RABBITMQ_HOST`             | `rabbitmq`   | Hostname of RabbitMQ server                               |
+        # | `RABBITMQ_NODE_PORT_NUMBER` | `5672`       | Port name of RabbitMQ server                              |
+        # | `RABBITMQ_USERNAME`         | `user`       | RabbitMQ username                                         |
+        # | `RABBITMQ_PASSWORD`         | `bitnami`    | RabbitMQ password                                         |
+        # | `RABBITMQ_AWAIT_ON_CLOSE`   | `false`      | Whether to wait on response when closing (default = true) |
         #
         # @return [ConnectionConfig] The configuration.
-        def from_env
+        def from_env(**opts)
           ConnectionConfig.new(
             host: ENV.fetch("RABBITMQ_HOST"),
             port: ENV.fetch("RABBITMQ_NODE_PORT_NUMBER"),
             username: ENV.fetch("RABBITMQ_USERNAME"),
-            password: ENV.fetch("RABBITMQ_PASSWORD")
+            password: ENV.fetch("RABBITMQ_PASSWORD"),
+            await_response_on_close: ENV.fetch("RABBITMQ_AWAIT_ON_CLOSE") || true,
+            **opts
           )
         end
       end
@@ -57,6 +72,12 @@ module Surfliner
       def redacted_url
         @redacted_url ||= session_url.sub(password, "REDACTED")
       end
+
+      private
+
+      def parse_boolean(v)
+        !FALSE_VALUES.include?(v.to_s)
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: surfliner-metadata_consumer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.5
+  version: 0.1.0.pre.alpha.6
 platform: ruby
 authors:
 - Project Surfliner
 bindir: bin
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.24'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Surfliner metadata consumer
 test_files: []