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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c60314d3c25079cbd39bca122dde8f505cf1060785420928b9e1cb2d105194
-  data.tar.gz: 9b772b1024ca85075794c744d56bc977cf912d72262406c1fb03f906045c22c4
+  metadata.gz: fac43306c988b19a28f9cb92449724b7cb326a787f54c7da78c9b134a61220aa
+  data.tar.gz: af91a86d088e4b863425a45faf97b2473cbca69cb17178d75d4bcce19d79384a
 SHA512:
-  metadata.gz: 4c97ddf2912e8eebe8ce02f3769b4de525154953d7c24297d384ed6313963e0ed85fc4462143359320799ad18da38c43ebcaa88100988e5bd21187d19fcb9e50
-  data.tar.gz: c300e50c84ba5ecd631ec9307214ba879b08e2444ca633b11122c85e62e9a02d4d4397867fadbd79a42698d7feef09f36f26c57a947a0b03b335b47cbde21c28
+  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

@@ -2,5 +2,4 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in surfliner_schema.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    surfliner-metadata_consumer (0.1.0.pre.alpha.1)
+    surfliner-metadata_consumer (0.1.0.pre.alpha.3)
       bunny (~> 2.23)
       opentelemetry-exporter-otlp (~> 0.26.3)
       opentelemetry-instrumentation-all (~> 0.60.0)
@@ -13,7 +13,7 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    amq-protocol (2.3.2)
+    amq-protocol (2.3.3)
     ast (2.4.2)
     bigdecimal (3.1.9)
     builder (3.3.0)
@@ -34,7 +34,7 @@ GEM
     debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.0)
     docile (1.4.1)
     dotenv (2.8.1)
     faraday (2.12.2)
@@ -55,11 +55,11 @@ GEM
     json (2.10.1)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    logger (1.6.5)
+    logger (1.6.6)
     net-http (0.6.0)
       uri
-    opentelemetry-api (1.4.0)
-    opentelemetry-common (0.21.0)
+    opentelemetry-api (1.5.0)
+    opentelemetry-common (0.22.0)
       opentelemetry-api (~> 1.0)
     opentelemetry-exporter-otlp (0.26.3)
       google-protobuf (~> 3.14)
@@ -245,14 +245,14 @@ GEM
       opentelemetry-helpers-sql-obfuscation
       opentelemetry-instrumentation-base (~> 0.22.1)
       opentelemetry-semantic_conventions (>= 1.8.0)
-    opentelemetry-registry (0.3.1)
+    opentelemetry-registry (0.4.0)
       opentelemetry-api (~> 1.1)
     opentelemetry-sdk (1.4.1)
       opentelemetry-api (~> 1.1)
       opentelemetry-common (~> 0.20)
       opentelemetry-registry (~> 0.2)
       opentelemetry-semantic_conventions
-    opentelemetry-semantic_conventions (1.10.1)
+    opentelemetry-semantic_conventions (1.11.0)
       opentelemetry-api (~> 1.0)
     parallel (1.26.3)
     parser (3.3.7.1)
@@ -274,7 +274,7 @@ GEM
     regexp_parser (2.10.0)
     reline (0.6.0)
       io-console (~> 0.5)
-    rexml (3.4.0)
+    rexml (3.4.1)
     rsolr (2.6.0)
       builder (>= 2.1.2)
       faraday (>= 0.9, < 3, != 2.0.0)
@@ -301,7 +301,7 @@ GEM
       rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
+    rubocop-ast (1.38.1)
       parser (>= 3.3.1.0)
     rubocop-performance (1.23.1)
       rubocop (>= 1.48.1, < 2.0)
@@ -332,11 +332,11 @@ GEM
     standard-performance (1.6.0)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.23.0)
-    stringio (3.1.2)
+    stringio (3.1.5)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
+    uri (1.0.3)
     webmock (3.25.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)

data/README.md

@@ -61,11 +61,11 @@ a configured `SOLR_URL`, e.g.:
 SOLR_URL=http://admin:admin@solr:8983/solr/daylight-dev
 ```
 
-The `bin/simulate-publish-event` script expects an `API_BASE_URI`, used to generate resource URLs
+The `bin/simulate-publish-event` script expects an `METADATA_API_URL_BASE`, used to generate resource URLs
 for provided IDs:
 
 ```sh
-API_BASE_URI=http://superskunk:3000
+METADATA_API_URL_BASE=http://superskunk:3000/resources
 ```
 
 ## Solr / Daylight handler implementation

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,9 +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
+$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:)
+handler  = Surfliner::MetadataConsumer::Solr::MessageHandler
+consumer = Surfliner::MetadataConsumer::Consumer.new(tracer:, logger:, handler:)
+consumer.run

data/bin/simulate-publish-event

@@ -1,31 +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("API_BASE_URI") { "http://example.com/api" }
-logger = Logger.new($stdout)
-logger.level = ENV.fetch("LOG_LEVEL") { Logger::INFO }
+module Surfliner
+  module MetadataConsumer
+    class Publisher
 
-connection = Surfliner::MetadataConsumer::MqConnection.new(logger: logger).connect
+      attr_reader :logger
+      attr_reader :topic_opts
+      attr_reader :queue_opts
 
+      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}/resources/#{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

@@ -20,28 +20,29 @@ module Surfliner
         @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
-      def self.run(tracer:, logger:, handler:)
-        new(tracer:, logger:, handler:).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

@@ -32,17 +32,19 @@ module Surfliner
       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}")
         @connection = Bunny.new(config.connection_url, logger: logger)
         connect_on(connection)
         @channel = connection.create_channel
-        @exchange = channel.topic(config.topic, auto_delete: true)
-        @queue = channel.queue(config.queue_name, durable: true)
+        @exchange = channel.topic(config.topic, topic_opts)
+        @queue = channel.queue(config.queue_name, queue_opts)
         queue.bind(exchange, routing_key: config.routing_key)
 
         self
@@ -58,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
@@ -68,8 +72,12 @@ module Surfliner
 
       # Closes the connection.
       def close
-        channel&.close
+        return unless channel
+        return if channel.closed?
+        logger.info("closing channel")
+        channel.close
       ensure
+        logger.info("closing connection")
         connection&.close
       end
 
@@ -93,6 +101,19 @@ module Surfliner
         config.port
       end
 
+      # @return [String] The routing key
+      def routing_key
+        config.routing_key
+      end
+
+      # 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 connect_on(connection, timeout = 120)

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.1"
+    VERSION = "0.1.0.pre.alpha.3"
   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.1
+  version: 0.1.0.pre.alpha.3
 platform: ruby
 authors:
 - Project Surfliner
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny