evt-consumer 2.2.0.0 → 2.3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d005131cba1d68a95028facee2e86fb2936e29ae0fe296a746f4e0e25abfc910
-  data.tar.gz: caf16c231eb6195749b4b2190843ab87aed7735f4fd3b3da72555bab45f8ea76
+  metadata.gz: cf9c47da47df09523d2007d47a2bd92aa8463924f327261c0e5a1215efb16a81
+  data.tar.gz: 3ce5caed62500286a552af1940b6892e45c2c60ac235acb11bea52ab0ccbd79e
 SHA512:
-  metadata.gz: 332338327a4a4fc99a3010e1e62b0dd840d64914efba85d3f90a22a001df3215c43f49933b213ac6ae7bef78dfe2018b3cb6dcf051c40b42eb278e5d547dd0a8
-  data.tar.gz: 76e5105a629fbd97447d2423139b08ecf1d33a1cdb513bc662cacf3e4ec969888ee2b3da677fdc009583490f313d9067effac3e1c9087ee074ff9760d2bca24a
+  metadata.gz: f3e8b9b68405943aec82c4d2ebc5d6de35419fd8715bee00fab9476e833ec2521e18f3f208c14f3d81dd4038faf255c66b21a1ed8f7f717dd9b0e5c0bc2cdd2d
+  data.tar.gz: cde3e28a744e3eefde6367eb7f4425d2faacff56b7b65ccd237d0144079a5b8de1c4b554a7e763e091a38dacb1f0e2c554735add6fa602b135ecefa76f793a90

data/lib/consumer/consumer.rb

@@ -33,9 +33,11 @@ module Consumer
         @position_update_counter ||= 0
       end
 
+      attr_accessor :poll_interval_milliseconds
+
       attr_accessor :session
 
-      attr_accessor :poll_interval_milliseconds
+      attr_accessor :supplemental_settings
 
       dependency :get, MessageStore::Get
       dependency :position_store, PositionStore
@@ -49,34 +51,20 @@ module Consumer
     end
   end
 
-  def dispatch(message_data)
-    logger.trace { "Dispatching message (#{LogText.message_data(message_data)})" }
+  def start(&probe)
+    logger.info(tags: [:consumer, :start]) { "Starting consumer: #{self.class.name} (Category: #{category}, Identifier: #{identifier || '(none)'}, Position: #{subscription.position})" }
 
-    self.class.handler_registry.each do |handler|
-      handler.(message_data, session: session)
+    if Defaults.startup_info?
+      print_info
     end
 
-    update_position(message_data.global_position)
-
-    logger.info { "Message dispatched (#{LogText.message_data(message_data)})" }
-  rescue => error
-    logger.error { "Error raised (Error Class: #{error.class}, Error Message: #{error.message}, #{LogText.message_data(message_data)})" }
-    error_raised(error, message_data)
-  end
-
-  def start(&probe)
-    logger.info(tag: :*) { "Starting consumer: #{self.class.name} (Category: #{category}, Identifier: #{identifier || '(none)'}, Position: #{subscription.position})" }
+    log_info
+    starting if respond_to?(:starting)
 
     if not MessageStore::StreamName.category?(category)
       raise Error, "Consumer's stream name must be a category (Stream Name: #{category})"
     end
 
-    starting() if respond_to?(:starting)
-
-    self.class.handler_registry.each do |handler|
-      logger.info(tag: :*) { "Handler: #{handler.name} (Category: #{category}, Consumer: #{self.class.name})" }
-    end
-
     _, subscription_thread = ::Actor::Start.(subscription)
 
     actor_address, actor_thread = Actor.start(self, subscription, include: :thread)
@@ -87,24 +75,76 @@ module Consumer
       probe.(self, [actor_thread, subscription_thread], [actor_address, subscription_address])
     end
 
-    logger.info(tag: :*) { "Started consumer: #{self.class.name} (Category: #{category}, Identifier: #{identifier || '(none)'}, Position: #{subscription.position})" }
+    logger.info(tags: [:consumer, :start]) { "Started consumer: #{self.class.name} (Category: #{category}, Identifier: #{identifier || '(none)'}, Position: #{subscription.position})" }
 
     AsyncInvocation::Incorrect
   end
 
+  def print_info
+    STDOUT.puts
+    STDOUT.puts "    Consumer: #{self.class.name}"
+    STDOUT.puts "      Category: #{category}"
+    STDOUT.puts "      Position: #{subscription.position}"
+    STDOUT.puts "      Identifier: #{identifier || '(none)'}"
+
+    print_startup_info if respond_to?(:print_startup_info)
+
+    STDOUT.puts "      Position Location: #{position_store.location || '(none)'}"
+
+    STDOUT.puts
+
+    STDOUT.puts "      Handlers:"
+    self.class.handler_registry.each do |handler|
+      STDOUT.puts "        Handler: #{handler.name}"
+      STDOUT.puts "          Messages: #{handler.message_registry.message_types.join(', ')}"
+    end
+  end
+
+  def log_info
+    logger.info(tags: [:consumer, :start]) { "Category: #{category} (Consumer: #{self.class.name})" }
+    logger.info(tags: [:consumer, :start]) { "Position: #{subscription.position} (Consumer: #{self.class.name})" }
+    logger.info(tags: [:consumer, :start]) { "Identifier: #{identifier || 'nil'} (Consumer: #{self.class.name})" }
+
+    log_startup_info if respond_to?(:log_startup_info)
+
+    logger.info(tags: [:consumer, :start]) { "Position Update Interval: #{position_update_interval.inspect} (Consumer: #{self.class.name})" }
+
+    logger.info(tags: [:consumer, :start]) { "Poll Interval Milliseconds: #{poll_interval_milliseconds.inspect} (Consumer: #{self.class.name})" }
+
+    self.class.handler_registry.each do |handler|
+      logger.info(tags: [:consumer, :start]) { "Handler: #{handler.name} (Consumer: #{self.class.name})" }
+      logger.info(tags: [:consumer, :start]) { "Messages: #{handler.message_registry.message_types.join(', ')} (Handler: #{handler.name}, Consumer: #{self.class.name})" }
+    end
+  end
+
+  def dispatch(message_data)
+    logger.trace(tags: [:consumer, :dispatch, :message]) { "Dispatching message (#{LogText.message_data(message_data)})" }
+
+    self.class.handler_registry.each do |handler|
+      handler.(message_data, session: session, settings: supplemental_settings)
+    end
+
+    update_position(message_data.global_position)
+
+    logger.debug(tags: [:consumer, :dispatch, :message]) { "Message dispatched (#{LogText.message_data(message_data)})" }
+  rescue => error
+    logger.error(tag: :*) { "Error raised (Error Class: #{error.class}, Error Message: #{error.message}, #{LogText.message_data(message_data)})" }
+    error_raised(error, message_data)
+  end
+
   def update_position(position)
-    logger.trace { "Updating position (Global Position: #{position}, Counter: #{position_update_counter}/#{position_update_interval})" }
+    logger.trace(tags: [:consumer, :position]) { "Updating position (Global Position: #{position}, Counter: #{position_update_counter}/#{position_update_interval})" }
 
     self.position_update_counter += 1
 
     if position_update_counter >= position_update_interval
       position_store.put(position)
 
-      logger.debug { "Updated position (Global Position: #{position}, Counter: #{position_update_counter}/#{position_update_interval})" }
+      logger.debug(tags: [:consumer, :position]) { "Updated position (Global Position: #{position}, Counter: #{position_update_counter}/#{position_update_interval})" }
 
       self.position_update_counter = 0
     else
-      logger.debug { "Interval not reached; position not updated (Global Position: #{position}, Counter: #{position_update_counter}/#{position_update_interval})" }
+      logger.debug(tags: [:consumer, :position]) { "Interval not reached; position not updated (Global Position: #{position}, Counter: #{position_update_counter}/#{position_update_interval})" }
     end
   end
 
@@ -116,7 +156,7 @@ module Consumer
 
   module Configure
     def configure(**kwargs)
-      logger.trace { "Configuring (Category: #{category})" }
+      logger.trace(tag: :consumer) { "Configuring (Category: #{category})" }
 
       super(**kwargs)
 
@@ -129,18 +169,26 @@ module Consumer
         poll_interval_milliseconds: poll_interval_milliseconds
       )
 
-      logger.debug { "Done configuring (Category: #{category}, Starting Position: #{starting_position})" }
+      logger.debug(tag: :consumer) { "Done configuring (Category: #{category}, Starting Position: #{starting_position})" }
     end
   end
 
   module Build
-    def build(category, position_update_interval: nil, poll_interval_milliseconds: nil, identifier: nil, **arguments)
+    def build(category, position_update_interval: nil, poll_interval_milliseconds: nil, identifier: nil, supplemental_settings: nil, **arguments)
       instance = new(category)
 
-      unless identifier.nil?
+      if not identifier.nil?
         instance.identifier = identifier
       end
 
+      if not supplemental_settings.nil?
+        if not supplemental_settings.is_a?(::Settings)
+          supplemental_settings = ::Settings.build(supplemental_settings)
+        end
+
+        instance.supplemental_settings = supplemental_settings
+      end
+
       instance.position_update_interval = position_update_interval
       instance.poll_interval_milliseconds = poll_interval_milliseconds
 
@@ -185,4 +233,24 @@ module Consumer
       end
     end
   end
+
+  module Defaults
+    def self.startup_info?
+      StartupInfo.get == 'on'
+    end
+
+    module StartupInfo
+      def self.get
+        ENV.fetch(env_var, default)
+      end
+
+      def self.env_var
+        'STARTUP_INFO'
+      end
+
+      def self.default
+        'on'
+      end
+    end
+  end
 end

data/lib/consumer/controls.rb

@@ -1,3 +1,4 @@
+require 'settings/controls'
 require 'messaging/controls'
 
 require 'consumer/controls/category'
@@ -11,7 +12,7 @@ require 'consumer/controls/id'
 require 'consumer/controls/identifier'
 require 'consumer/controls/position'
 require 'consumer/controls/session'
-require 'consumer/controls/stream_name'
+require 'consumer/controls/settings'
 
 require 'consumer/controls/position_store'
 require 'consumer/controls/position_store/file'
@@ -19,6 +20,7 @@ require 'consumer/controls/subscription'
 
 require 'consumer/controls/handle'
 require 'consumer/controls/handle/raise_error'
+require 'consumer/controls/handle/settings'
 
 require 'consumer/controls/actor'
 

data/lib/consumer/controls/consumer.rb

@@ -59,6 +59,14 @@ module Consumer
       end
 
       Example = self.example_class
+
+      module Settings
+        def self.example_class
+          Consumer.example_class(handlers: [Handle::Settings::Example])
+        end
+
+        Example = self.example_class
+      end
     end
   end
 end

data/lib/consumer/controls/consumer/error_handler.rb

@@ -15,7 +15,7 @@ module Consumer
           attr_accessor :failed_message
 
           handler Handle::Example
-          handler Handle::RaiseError
+          handler Handle::RaiseError::Example
 
           def error_raised(error, message)
             self.handled_error = error

data/lib/consumer/controls/get/incrementing.rb

@@ -22,6 +22,10 @@ module Consumer
           instance
         end
 
+        def category
+          Category.example
+        end
+
         def batch_size
           Defaults.batch_size
         end

data/lib/consumer/controls/handle/settings.rb

@@ -0,0 +1,7 @@
+module Consumer
+  module Controls
+    module Handle
+      Settings = ::Messaging::Controls::Handler::Settings
+    end
+  end
+end

data/lib/consumer/controls/position_store.rb

@@ -1,20 +1,35 @@
 module Consumer
   module Controls
     module PositionStore
-      def self.example
-        Example.build
+      def self.example(&block)
+        if block.nil?
+          cls = Example
+        else
+          cls = example_class(&block)
+        end
+
+        cls.build
       end
 
-      class Example
-        include ::Consumer::PositionStore
+      def self.example_class(&block)
+        Class.new do
+          include ::Consumer::PositionStore
 
-        attr_accessor :telemetry_sink
+          def self.build
+            instance = new
+            instance.configure
+            instance
+          end
 
-        def self.build
-          instance = new
-          instance.configure
-          instance
+          def configure
+          end
+
+          class_exec(&block) unless block.nil?
         end
+      end
+
+      Example = example_class do
+        attr_accessor :telemetry_sink
 
         def configure
           self.telemetry_sink = ::Consumer::PositionStore::Telemetry::Sink.new
@@ -29,6 +44,12 @@ module Consumer
         def put(_)
         end
       end
+
+      module Location
+        def self.example
+          'somePositionStream'
+        end
+      end
     end
   end
 end

data/lib/consumer/controls/settings.rb

@@ -0,0 +1,13 @@
+module Consumer
+  module Controls
+    module Settings
+      def self.example
+        ::Settings.build(data)
+      end
+
+      def self.data
+        ::Settings::Controls::Data::Flat::Single.example
+      end
+    end
+  end
+end

data/lib/consumer/position_store.rb

@@ -3,6 +3,7 @@ module Consumer
     def self.included(cls)
       cls.class_exec do
         include Dependency
+        include Virtual
         include Log::Dependency
 
         extend Build
@@ -13,6 +14,8 @@ module Consumer
         prepend Put
 
         dependency :telemetry, ::Telemetry
+
+        virtual :location
       end
     end
 
@@ -60,7 +63,7 @@ module Consumer
 
         position = super
 
-        logger.info(tags: [:position_store, :get]) { "Get position done (Position: #{position || '(none)'})" }
+        logger.debug(tags: [:position_store, :get]) { "Get position done (Position: #{position || '(none)'})" }
 
         telemetry.record(:get, Telemetry::Get.new(position))
 

data/lib/consumer/position_store/substitute.rb

@@ -6,6 +6,8 @@ module Consumer
       end
 
       class PositionStore
+        include Consumer::PositionStore
+
         attr_accessor :get_position
         attr_accessor :put_position
 

data/lib/consumer/postgres

@@ -0,0 +1 @@
+lib/consumer/Users/sbellware/projects/eventide/consumer-postgres/lib/consumer/postgres

data/lib/consumer/postgres.rb

@@ -0,0 +1 @@
+lib/consumer/Users/sbellware/projects/eventide/consumer-postgres/lib/consumer/postgres.rb

data/lib/consumer/subscription.rb

@@ -53,7 +53,7 @@ module Consumer
       end
 
       if batch.nil? || batch.empty?
-        logger.debug { "Did not resupply; no events available (Category: #{get.category}, Position: #{position})" }
+        logger.debug { "Did not resupply; no events available (Stream: #{get.stream_name}, Position: #{position})" }
 
         :resupply
       else

data/lib/consumer/subscription/defaults.rb

@@ -2,6 +2,9 @@ module Consumer
   class Subscription
     module Defaults
       def self.poll_interval_milliseconds
+        env_interval = ENV['POLL_INTERVAL_MILLISECONDS']
+        return env_interval.to_i if !env_interval.nil?
+
         100
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt-consumer
 version: !ruby/object:Gem::Version
-  version: 2.2.0.0
+  version: 2.3.1.0
 platform: ruby
 authors:
 - The Eventide Project
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ntl-actor
@@ -114,6 +114,7 @@ files:
 - lib/consumer/controls/get/incrementing.rb
 - lib/consumer/controls/handle.rb
 - lib/consumer/controls/handle/raise_error.rb
+- lib/consumer/controls/handle/settings.rb
 - lib/consumer/controls/id.rb
 - lib/consumer/controls/identifier.rb
 - lib/consumer/controls/message_data.rb
@@ -123,7 +124,7 @@ files:
 - lib/consumer/controls/position_store.rb
 - lib/consumer/controls/position_store/file.rb
 - lib/consumer/controls/session.rb
-- lib/consumer/controls/stream_name.rb
+- lib/consumer/controls/settings.rb
 - lib/consumer/controls/subscription.rb
 - lib/consumer/defaults.rb
 - lib/consumer/handler_registry.rb
@@ -132,6 +133,8 @@ files:
 - lib/consumer/position_store.rb
 - lib/consumer/position_store/substitute.rb
 - lib/consumer/position_store/telemetry.rb
+- lib/consumer/postgres
+- lib/consumer/postgres.rb
 - lib/consumer/subscription.rb
 - lib/consumer/subscription/defaults.rb
 - lib/consumer/subscription/get_batch.rb
@@ -140,7 +143,7 @@ homepage: https://github.com/eventide-project/consumer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,8 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Continuous subscription to a category and message dispatching to handlers
 test_files: []

data/lib/consumer/controls/stream_name.rb

@@ -1,6 +0,0 @@
-## Consider whether this is still needed after category rename
-module Consumer
-  module Controls
-    StreamName = Messaging::Controls::StreamName
-  end
-end