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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25566009d8ccce03904d9020a0340511bbeb2fac08b5151c65705cd2d6117096
-  data.tar.gz: 24136a3ca25672bf7fcc8670ea61f11a34c547b515022f92e46b440fe1d315cc
+  metadata.gz: f209e4cf680ce23da67c4caa19fd9448fed117ec03e38d54b50a382b1b6b72a0
+  data.tar.gz: 07a901ae1f7edda577c3cbd272aac1d68e7a31876ee536661b8586c55a0623d4
 SHA512:
-  metadata.gz: fef5c2196922e8f5476422ffd83400bc17edc957b0822a323628dd9cd525440e231e1d7402b761c71894806282c2ad11c8c450eb6dc37a6a6e99dac7d3adc9c5
-  data.tar.gz: 5014bdadb04910ca9888d8fe445342641462e33f6ec445333c4502dd322e428df5c5ecd01710018d7f905e80a889ce84815f7ff59b1d3908c00b405d5f02c048
+  metadata.gz: 5531263f0ddcac33d04d8ba55d9008b2e1562eda7288f49273631661038d1f61c858030bad5d6ec5dc8f51bd24f7e7ad34be5430eceba021ccfa21013771cece
+  data.tar.gz: 0f9d4c233b2b4be9410509772715c742e76717dbd5f124ca1b693965548d169f033734d262b67dfaa117246e6101a238f0b4894e20b5cfdfbc787c5865e18147

data/CHANGES.md

@@ -1,3 +1,17 @@
+# 0.1.0.pre.alpha.8 (2025-04-29)
+
+- Support comparing configuration objects by value equality, so they can
+  be used as hash keys.
+
+# 0.1.0.pre.alpha.7 (2025-04-28)
+
+- Fix issue where `RABBITMQ_AWAIT_ON_CLOSE` environment variable could
+  not be omitted.
+- Remove `:routing_key` from `Mq::QueueConfig`, to allow using multiple
+  routing keys with the same queue.
+- Add `Mq::Router` for routing messages from a single queue to multiple
+  handlers by routing key.
+
 # 0.1.0.pre.alpha.6 (2025-04-25)
 
 - Update to Bunny 2.24

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    surfliner-metadata_consumer (0.1.0.pre.alpha.6)
+    surfliner-metadata_consumer (0.1.0.pre.alpha.8)
       bunny (~> 2.24)
       opentelemetry-exporter-otlp (~> 0.26.3)
       opentelemetry-instrumentation-all (~> 0.60.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.75.3)
+    rubocop (1.75.4)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)

data/README.md

@@ -71,6 +71,13 @@ connection.with_topic(topic_config) do |topic|
 end
 ```
 
+`TopicConfig#publish` can either accept an explicit routing key, or read a default value
+from the environment:
+
+| Variable                        | Sample value                  | Description          | 
+|---------------------------------|-------------------------------|----------------------|
+| `RABBITMQ_PLATFORM_ROUTING_KEY` | `surfliner.metadata.daylight` | RabbitMQ routing key |
+
 Similarly, `Mq::Topic#bind_queue` can either take an explicit `QueueConfig`, or implicitly
 read a default with `QueConfig#from_env`. `QueueConfig#from_env` expects the following environment
 variables:
@@ -78,14 +85,13 @@ variables:
 | Variable                        | Sample value                  | Description          | 
 |---------------------------------|-------------------------------|----------------------|
 | `RABBITMQ_QUEUE`                | `surfliner.metadata`          | RabbitMQ queue name  |
-| `RABBITMQ_PLATFORM_ROUTING_KEY` | `surfliner.metadata.daylight` | RabbitMQ routing key |
 
 And `QueueConfig#from_env` similarly accepts keyword options, which are forwarded to
 [`Bunny::Channel#queue`](https://api.rubybunny.info/Bunny/Channel.html#queue-instance_method):
 
 ```ruby
 connection.with_topic(topic_config) do |topic|
-  queue_config = QueueConfig.from_env(exclusive: true, durable: true)
+  queue_config = QueueConfig.from_env(exclusive: true, durable: false)
   queue = topic.bind_queue(queue_config)
   # ...
 end

data/lib/surfliner/metadata_consumer/version.rb

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

data/lib/surfliner/mq/connection_config.rb

@@ -2,6 +2,7 @@ module Surfliner
   module Mq
     # An object encapsulating RabbitMQ configuration.
     class ConnectionConfig
+      # @return [Array<String>] values of RABBITMQ_AWAIT_ON_CLOSE interpreted as false
       FALSE_VALUES = ([""] + %w[0 off Off OFF f false False FALSE F n no No NO N]).freeze
 
       # @return [String]  The RabbitMQ hostname
@@ -27,7 +28,7 @@ module Surfliner
       # @param port [String] RabbitMQ AMQP port
       # @param username [String] RabbitMQ username
       # @param password [String] RabbitMQ passsword
-      # @param await_response_on_close [Boolean] whether the RabbitMQ client should wait for a response when closing the connection
+      # @param await_response_on_close [Boolean, String] 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
@@ -57,7 +58,7 @@ module Surfliner
             port: ENV.fetch("RABBITMQ_NODE_PORT_NUMBER"),
             username: ENV.fetch("RABBITMQ_USERNAME"),
             password: ENV.fetch("RABBITMQ_PASSWORD"),
-            await_response_on_close: ENV.fetch("RABBITMQ_AWAIT_ON_CLOSE") || true,
+            await_response_on_close: ENV["RABBITMQ_AWAIT_ON_CLOSE"] || true,
             **opts
           )
         end
@@ -73,7 +74,34 @@ module Surfliner
         @redacted_url ||= session_url.sub(password, "REDACTED")
       end
 
-      private
+      # Whether `other` represents the same configuration as this object.
+      # Note that if any attributes or connection options are modified, equality becomes unstable.
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def eql?(other)
+        self == other
+      end
+
+      # Whether `other` represents the same configuration as this object.
+      # Note that if any attributes or connection options are modified, equality becomes unstable.
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def ==(other)
+        return unless other.class == self.class
+        other.options == options
+      end
+
+      # The hash value of this object. Equal configurations will have equal hash values.
+      # Note that if any attributes or connection options are modified, the hash value becomes unstable.
+      # @return [Integer] a hash value suitable for using equal configs as hash keys
+      def hash
+        options.hash
+      end
+
+      protected
+
+      # @return [Hash] all keyword arguments and connection options, for purposes of equality checking
+      def options
+        {host:, port:, username:, password:, await_response_on_close:, opts:}
+      end
 
       def parse_boolean(v)
         !FALSE_VALUES.include?(v.to_s)

data/lib/surfliner/mq/queue_config.rb

@@ -5,21 +5,40 @@ module Surfliner
       # @return [String]  The queue to listen to
       attr_reader :name
 
-      # @return [String] platform routing key to listen to
-      attr_reader :routing_key
-
       # @return [Hash] RabbitMQ queue options. (See Bunny::Channel#queue)
       attr_reader :options
 
       # @param name [String] queue exchange to listen to
-      # @param routing_key [String] platform routing key to listen to
       # @param options [Hash] RabbitMQ queue options. (See Bunny::Channel#queue)
-      def initialize(name:, routing_key:, options: {})
+      def initialize(name:, options: {})
         @name = name
-        @routing_key = routing_key
         @options = options
       end
 
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def eql?(other)
+        self == other
+      end
+
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def ==(other)
+        return unless other.class == self.class
+        other.name == name && other.options == options
+      end
+
+      # The hash value of this object. Equal configurations will have equal hash values.
+      # Note that if `name` or `options` are modified, the hash value becomes unstable.
+      # @return [Integer] a hash value suitable for using equal configs as hash keys
+      def hash
+        [name, options].hash
+      end
+
       class << self
         # Returns a default (environment-variable-based) configuration with the
         # specified options.
@@ -27,22 +46,15 @@ module Surfliner
         # | Variable                        | Sample value                  | Description          |
         # |---------------------------------|-------------------------------|----------------------|
         # | `RABBITMQ_QUEUE`                | `surfliner.metadata`          | RabbitMQ queue name  |
-        # | `RABBITMQ_PLATFORM_ROUTING_KEY` | `surfliner.metadata.daylight` | RabbitMQ routing key |
         #
         # @param options [Hash] RabbitMQ queue options. (See Bunny::Channel#queue)
         # @return [QueueConfig] The configuration.
         def from_env(**options)
           QueueConfig.new(
             name: ENV.fetch("RABBITMQ_QUEUE"),
-            routing_key: default_routing_key,
             options:
           )
         end
-
-        # @return [String] The default routing key from `ENV["RABBITMQ_PLATFORM_ROUTING_KEY"]`
-        def default_routing_key
-          ENV.fetch("RABBITMQ_PLATFORM_ROUTING_KEY")
-        end
       end
     end
   end

data/lib/surfliner/mq/router.rb

@@ -0,0 +1,78 @@
+module Surfliner
+  module Mq
+    # Queue subscriber that routes messages by routing key to multiple handlers
+    class Router
+      # @return [Topic] the topic
+      attr_reader :topic
+
+      # @return [Bunny::Queue] the queue
+      attr_reader :queue
+
+      # @return [Bunny::Consumer] the consumer (used to unsubscribe)
+      attr_reader :consumer
+
+      # Initializes a new Router and subscribes it to the specified queue
+      # on the specified topic.
+      #
+      # @param topic [Mq::Topic] The topic to listen on
+      # @param queue_config [Mq::QueueConfig] The queue to subscribe to
+      def initialize(topic, queue_config: QueueConfig.from_env)
+        @topic = topic
+        @queue = topic.queue(queue_config)
+        @consumer = queue.subscribe(&method(:on_delivery))
+      end
+
+      # Adds a handler for the specified routing key.
+      # Handlers will receive only messages with the specified routing key.
+      # Multiple handler blocks can be added to the same queue and/or routing key.
+      #
+      # @param routing_key [String] the routing key to filter messages by
+      # @yieldparam payload_json [String] each payload
+      def add_handler(routing_key, &block)
+        raise "Can't add handlers after router shutdown" if consumer.nil?
+
+        log("adding handler #{block}")
+        handlers = handlers_for(routing_key)
+        queue.bind(topic.exchange, routing_key:) if handlers.empty?
+        handlers << block
+      end
+
+      # Removes all handlers and unsubscribes from the queue.
+      def shutdown
+        log("shutting down")
+        handlers_by_routing_key.clear
+        consumer.cancel
+        @consumer = nil
+      end
+
+      private
+
+      # Receives messages and routes them to the appropriate handler
+      #
+      # @param delivery_info [Bunny::DeliveryInfo] the delivery info
+      # @param _metadata [Bunny::MessageProperties] the message properties
+      # @param payload_json [String] the payload as a string
+      def on_delivery(delivery_info, _metadata, payload_json)
+        routing_key = delivery_info.routing_key
+        handlers_for(routing_key).each do |handler|
+          log("delivering #{payload_json} to handler #{handler} for #{routing_key}")
+          handler.call(payload_json)
+        end
+      end
+
+      # @return [Hash{String => Array<Proc>}] all handlers by routing key
+      def handlers_by_routing_key
+        @handlers_by_routing_key ||= {}
+      end
+
+      # @return [Array<Proc>] the handlers for the specified key, if any
+      def handlers_for(routing_key)
+        (handlers_by_routing_key[routing_key] ||= [])
+      end
+
+      def log(msg)
+        topic.logger.debug("#{self.class}(#{topic.name}, #{queue.name}): #{msg}")
+      end
+    end
+  end
+end

data/lib/surfliner/mq/topic.rb

@@ -38,17 +38,36 @@ module Surfliner
       # @param payload [String] the payload to publish
       # @param routing_key [String] platform routing key to publish to
       # @return [Bunny::Exchange] see #exchange
-      def publish(payload, routing_key: QueueConfig.default_routing_key)
+      def publish(payload, routing_key: default_routing_key)
         logger.info "Publishing to #{routing_key} with payload: #{payload}"
         exchange.publish(payload, routing_key:)
       end
 
+      # Creates or looks up the specified queue and binds it to receive
+      # messages with the specified routing key.
       # @param config [QueueConfig] queue configuration
-      # @return  [Bunny::Queue]  the queue
-      def bind_queue(config = QueueConfig.from_env)
-        channel.queue(config.name, config.options).tap do |q|
-          q.bind(exchange, routing_key: config.routing_key)
-        end
+      # @param routing_key [String] platform routing key to bind on
+      # @return  [Bunny::Queue] the queue
+      def bind_queue(config = QueueConfig.from_env, routing_key: default_routing_key)
+        queue(config).tap { |q| q.bind(exchange, routing_key:) }
+      end
+
+      # Creates or looks up the specified queue.
+      # @param config [QueueConfig] queue configuration
+      # @return [Bunny::Queue] the queue
+      def queue(config)
+        channel.queue(config.name, config.options)
+      end
+
+      # Returns the default (environment-variable-based) routing key
+      #
+      # | Variable                        | Sample value                  | Description          |
+      # |---------------------------------|-------------------------------|----------------------|
+      # | `RABBITMQ_PLATFORM_ROUTING_KEY` | `surfliner.metadata.daylight` | RabbitMQ routing key |
+      #
+      # @return [String, nil] the configured default routing key
+      def default_routing_key
+        ENV.fetch("RABBITMQ_PLATFORM_ROUTING_KEY")
       end
 
       class << self

data/lib/surfliner/mq/topic_config.rb

@@ -15,6 +15,30 @@ module Surfliner
         @options = options
       end
 
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def eql?(other)
+        self == other
+      end
+
+      # Whether `other` represents the same configuration as this object.
+      # Note that if `name` or `options` are modified, equality becomes unstable.
+      # @param other [Object, nil] the object to compare
+      # @return [Boolean] true if `other` represents the same configuration as this object, false otherwise
+      def ==(other)
+        return unless other.class == self.class
+        other.name == name && other.options == options
+      end
+
+      # The hash value of this object. Equal configurations will have equal hash values.
+      # Note that if `name` or `options` are modified, the hash value becomes unstable.
+      # @return [Integer] a hash value suitable for using equal configs as hash keys
+      def hash
+        [name, options].hash
+      end
+
       class << self
         # Returns a default (environment-variable-based) configuration with the
         # specified options.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surfliner-metadata_consumer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.6
+  version: 0.1.0.pre.alpha.8
 platform: ruby
 authors:
 - Project Surfliner
@@ -295,6 +295,7 @@ files:
 - lib/surfliner/mq/connection.rb
 - lib/surfliner/mq/connection_config.rb
 - lib/surfliner/mq/queue_config.rb
+- lib/surfliner/mq/router.rb
 - lib/surfliner/mq/topic.rb
 - lib/surfliner/mq/topic_config.rb
 - lib/surfliner/util.rb