surfliner-metadata_consumer 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ceb6aaafb75d24e2cf646c3ac55eaca9c0fc92183a448f3ad3a09e9920eaea
-  data.tar.gz: 52c43074990eade7d93c32fa471329e845d2776f9229246f57bec81e75fa558d
+  metadata.gz: fac43306c988b19a28f9cb92449724b7cb326a787f54c7da78c9b134a61220aa
+  data.tar.gz: af91a86d088e4b863425a45faf97b2473cbca69cb17178d75d4bcce19d79384a
 SHA512:
-  metadata.gz: f19622750625a84977122fa344b8635bac1d6f80de562237505be22f82aa3acbc532d53f768f0f3b9b7dbda84724d1979b9396e785dca25d30216b71b8746c65
-  data.tar.gz: 47621bc83433c05a36cd0d15a3b3a526eb981b0bd1085014c5179ea7c1dce0ad0a12722895873d629bfc1a510cb3648d1a5b2695d1b797d9960befcbb90e517e
+  metadata.gz: ea1dbf415bd4339f875562a7f629ea432915e3dc1b511ba1268765069db0227031dc5eb71e2acfcb7f4b5c434a3c82ba88b4cc266dec94b94479462ae3721781
+  data.tar.gz: d0840fc308daec6d1ed9f22038f62e2ed4974ea450054b3bec580e1a28f8aff52c5081cfd600e46137546785cc726a420190b0bdf82a0eb7f0c2db5fa447736b

data/CHANGES.md

@@ -1,3 +1,14 @@
+# 0.1.0.pre.alpha.3 (2025-03-07)
+
+- improve topic/queue option override API
+- clean up binscripts
+
+# 0.1.0.pre.alpha.2 (2025-03-07)
+
+- use METADATA_API_URL_BASE cf. surfliner apps
+- allow overriding topic and queue options
+- don't close channel if already closed
+
 # 0.1.0.pre.alpha.1 (2025-02-12)
 
 - CI pipeline gem release test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    surfliner-metadata_consumer (0.1.0.pre.alpha.2)
+    surfliner-metadata_consumer (0.1.0.pre.alpha.3)
       bunny (~> 2.23)
       opentelemetry-exporter-otlp (~> 0.26.3)
       opentelemetry-instrumentation-all (~> 0.60.0)

data/bin/daylight-index-listen

@@ -2,12 +2,8 @@
 require "bundler/setup"
 require "logger"
 require "opentelemetry/sdk"
-require "surfliner/metadata_consumer"
-
-$stdout.sync = true # don't buffer log output
 
-logger = Logger.new($stdout)
-logger.level = ENV.fetch("LOG_LEVEL") { Logger::INFO }
+require "surfliner/metadata_consumer"
 
 unless ENV["OTEL_SDK_DISABLED"] == "true"
   OpenTelemetry::SDK.configure do |c|
@@ -15,11 +11,13 @@ unless ENV["OTEL_SDK_DISABLED"] == "true"
     c.use_all # enables auto instrumentation for Bunny, Net::HTTP, etc...
   end
 end
+tracer   = OpenTelemetry.tracer_provider.tracer("DaylightConsumerTracer")
 
-tracer = OpenTelemetry.tracer_provider.tracer("DaylightConsumerTracer")
-
-handler = Surfliner::MetadataConsumer::Solr::MessageHandler
-
-opts = { queue: { durable: false } }
+$stdout.sync = true # don't buffer log output
+logger       = Logger.new($stdout).tap do |logger|
+  logger.level = ENV.fetch("LOG_LEVEL", Logger::INFO)
+end
 
-Surfliner::MetadataConsumer::Consumer.run(logger:, tracer:, handler:, opts:)
+handler  = Surfliner::MetadataConsumer::Solr::MessageHandler
+consumer = Surfliner::MetadataConsumer::Consumer.new(tracer:, logger:, handler:)
+consumer.run

data/bin/simulate-publish-event

@@ -1,33 +1,56 @@
 #!/usr/bin/env ruby
 require "bundler/setup"
-require "date"
 require "json"
 require "logger"
 
-require "surfliner/metadata_consumer/mq_connection"
+require "surfliner/metadata_consumer"
 
-api_base     = ENV.fetch("METADATA_API_URL_BASE") { "http://metadata.test/resources" }
-logger       = Logger.new($stdout)
-logger.level = ENV.fetch("LOG_LEVEL") { Logger::INFO }
+module Surfliner
+  module MetadataConsumer
+    class Publisher
 
-opts = { queue: { durable: false } }
+      attr_reader :logger
+      attr_reader :topic_opts
+      attr_reader :queue_opts
 
-connection = Surfliner::MetadataConsumer::MqConnection.new(logger:, opts:).connect
+      def initialize(logger:, topic_opts: {}, queue_opts: {})
+        @logger = logger
+        @topic_opts = topic_opts
+        @queue_opts = queue_opts
+      end
 
+      def publish(resource_id)
+        payload = payload_for(resource_id)
+        connection.publish(payload)
+      end
+
+      def payload_for(id)
+        { resourceUrl: "#{api_base}/#{id}",
+          status:      :published,
+          time_stamp:  DateTime.now }.to_json
+      end
+
+      def connection
+        @connection ||= MqConnection.new(logger:).connect(topic_opts:, queue_opts:)
+      end
+
+      def api_base
+        @api_base ||= ENV.fetch("METADATA_API_URL_BASE", "http://metadata.test/resources")
+      end
+    end
+  end
+end
+
+$stdout.sync = true # don't buffer log output
+logger = Logger.new($stdout).tap do |logger|
+  logger.level = ENV.fetch("LOG_LEVEL", Logger::INFO)
+end
+
+publisher = Surfliner::MetadataConsumer::Publisher.new(logger:)
 begin
-  ARGV.each do |id|
-    payload =
-      { resourceUrl: "#{api_base}/#{id}",
-        status:      :published,
-        time_stamp:  DateTime.now }.to_json
-
-    logger.info "Publishing to #{connection.routing_key} with #{payload}"
-    connection.exchange.publish(payload, routing_key: connection.routing_key)
+  ARGV.each do |resource_id|
+    publisher.publish(resource_id)
   end
 ensure
-  begin
-    connection&.channel
-  ensure
-    connection&.close
-  end
+  publisher.connection.close
 end

data/lib/surfliner/metadata_consumer/consumer.rb

@@ -13,37 +13,36 @@ module Surfliner
       # @param tracer [OpenTelemetry::Trace::Tracer] OpenTelemetry tracer
       # @param logger [Logger] log message destination
       # @param handler #handle an object accepting a JSON string
-      # @param opts [Hash] (see MqConnection#new)
-      def initialize(tracer:, logger:, handler:, opts: nil)
-        @connection = MqConnection.new(logger:, opts:)
+      def initialize(tracer:, logger:, handler:)
+        @connection = MqConnection.new(logger:)
         @logger = logger
         @tracer = tracer
         @handler = handler
       end
 
-      # Initializes and starts a new `Consumer`
-      # @param tracer [OpenTelemetry::Trace::Tracer] OpenTelemetry tracer
-      # @param logger [Logger] log message destination
-      # @param handler #handle an object accepting a JSON string payload
-      # @param opts [Hash] (see MqConnection#new)
-      def self.run(tracer:, logger:, handler:, opts: nil)
-        new(tracer:, logger:, handler:, opts:).run
-      end
-
       # Starts listening to the message queue and passing messages to the handler.
-      def run
-        connection.open do |queue|
+      # @param queue_opts [Hash] RabbitMQ queue options. (See Bunny::Channel#queue)
+      # @param topic_opts [Hash] RabbitMQ topic options. (See Bunny::Channel#topic)
+      def run(queue_opts: {}, topic_opts: {})
+        connection.open(queue_opts:, topic_opts:) do |queue|
           queue.subscribe(block: true) do |_delivery_info, _properties, payload_json|
             tracer.in_span("surfliner metadata consumer message") do |_span|
-              logger.info(" [  ] message received with payload: #{payload_json}")
-
-              handler.handle(payload_json)
+              handle(payload_json)
             end
-          rescue => err
-            logger.error(" [❌] failed to handle message: #{err}\n#{err.backtrace}")
           end
         end
       end
+
+      # Dispatches the specified payload to the handler.
+      # @param payload_json [String] JSON message payload
+      def handle(payload_json)
+        logger.info(" [→] message received with payload: #{payload_json}")
+
+        handler.handle(payload_json)
+        logger.info(" [✓] message handled")
+      rescue => err
+        logger.error(" [!] failed to handle message: #{err.full_message}")
+      end
     end
   end
 end

data/lib/surfliner/metadata_consumer/mq_connection.rb

@@ -4,15 +4,6 @@ module Surfliner
   module MetadataConsumer
     # An object encapsulating a RabbitMQ connection.
     class MqConnection
-      # Default RabbitMQ topic options
-      DEFAULT_TOPIC_OPTS = {auto_delete: true}.freeze
-
-      # Default RabbitMQ queue options
-      DEFAULT_QUEUE_OPTS = {durable: true}.freeze
-
-      # Default RabbitMQ topic and queue options
-      DEFAULT_OPTS = {topic: DEFAULT_TOPIC_OPTS, queue: DEFAULT_QUEUE_OPTS}.freeze
-
       # @return [Logger]  The logger
       attr_reader :logger
 
@@ -31,24 +22,21 @@ module Surfliner
       # @return [MqConfig]  The configuration
       attr_reader :config
 
-      # @return [Hash<Symbol, Hash>]  Options to pass when connecting to RabbitMQ topic and queue. Overrides DEFAULT_OPTS.
-      attr_reader :opts
-
       # Initializes a new `MqConnection`.
       #
       # @param logger [Logger] the logger
       # @param config [MqConfig] the configuration
-      # @param opts [Hash<Symbol, Hash>]  Options to pass when connecting to RabbitMQ topic and queue. Overrides DEFAULT_OPTS.
-      def initialize(logger:, config: MqConfig.from_env, opts: nil)
+      def initialize(logger:, config: MqConfig.from_env)
         @logger = logger
         @config = config
-        @opts = merge_opts(opts)
       end
 
       # Opens a connection.
+      # @param topic_opts [Hash] RabbitMQ topic options. (See Bunny::Channel#topic)
+      # @param queue_opts [Hash] RabbitMQ queue options. (See Bunny::Channel#queue)
       # @return [self]
       # @raise RuntimeError if already connected
-      def connect
+      def connect(topic_opts: {}, queue_opts: {})
         raise "RabbitMQ connection #{connection} already open." if open?
 
         logger.info("Rabbitmq message broker connection url: #{config.redacted_url}")
@@ -72,9 +60,11 @@ module Surfliner
 
       # Opens a connection, yields the queue, and closes the connection after
       # the provided block completes.
+      # @param topic_opts [Hash] RabbitMQ topic options. (See Bunny::Channel#topic)
+      # @param queue_opts [Hash] RabbitMQ queue options. (See Bunny::Channel#queue)
       # @yield [Bunny::Queue]  the queue
-      def open
-        connect
+      def open(topic_opts: {}, queue_opts: {})
+        connect(topic_opts:, queue_opts:)
         yield queue
       ensure
         close
@@ -111,28 +101,21 @@ module Surfliner
         config.port
       end
 
-      # @return [Hash]  Options passed when connecting to RabbitMQ topic
-      def topic_opts
-        opts[:topic]
+      # @return [String] The routing key
+      def routing_key
+        config.routing_key
       end
 
-      # @return [Hash]  Options passed when connecting to RabbitMQ queue
-      def queue_opts
-        opts[:queue]
+      # Publishes the specified payload
+      # @param payload [String] the payload to publish
+      # @return [Bunny::Exchange] see #exchange
+      def publish(payload)
+        logger.info "Publishing to #{routing_key} with payload: #{payload}"
+        exchange.publish(payload, routing_key:)
       end
 
       private
 
-      def merge_opts(opts)
-        DEFAULT_OPTS.to_h do |opt_type, opts_default|
-          opts_actual = opts_default.dup
-          if opts && (opts_provided = opts[opt_type])
-            opts_actual.merge!(opts_provided)
-          end
-          [opt_type, opts_actual]
-        end
-      end
-
       def connect_on(connection, timeout = 120)
         timer = 0
         logger.info "Trying to open queue connection with timeout=#{timeout}"

data/lib/surfliner/metadata_consumer/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surfliner-metadata_consumer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.2
+  version: 0.1.0.pre.alpha.3
 platform: ruby
 authors:
 - Project Surfliner