evt-consumer 1.1.0.0 → 2.3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2077ef49032cd7e88e66307072188bd14f3f5eb60c3889d3eaa2d8e32d398a91
-  data.tar.gz: db192f1c6a7d6c7629200fdb71152d325ec05fcd27f1acf17d2f6f7a77088a77
+  metadata.gz: 93275cd1c618ed75c10cccc91aa7e5c8a6b0f3cca8afceef0d7d241d4820edef
+  data.tar.gz: 833c710b283472d05591f52f1c78abe8e19aca73dd519c141956294d3696757a
 SHA512:
-  metadata.gz: e80126fd3557847a29603838d917b11fbdc93b617cca9ac17ea2c68471d6c1cef76c9e15656a306bf4959ff6ea80f9615db120fb8c72d37ca8096b3c2ed5c187
-  data.tar.gz: 4c64c89911619b136db60fc135619c17573410083ce86cf0fc4438254133b8bd1724f0123536393f58b783830a60c46248ba2cf62f58b96b8d4dd0852d52dcfd
+  metadata.gz: 74baf13ab8a47615e7eb4d5de5e5c5064f53ce9b5506b171becbf145cc802b70ce3641e1dab38bbc8d25f5e17ad73271046e14f4f786441206717795900c42b5
+  data.tar.gz: 0752efbcb2193628bf5a0456c38ac8d3c4005e7e3fd904b76a147a80051b4f5300eaae27c4380663192334eb0b2854331ee5046754c45785ee3262938618d3e5

data/lib/consumer/consumer.rb

@@ -1,4 +1,6 @@
 module Consumer
+  Error = Class.new(RuntimeError)
+
   def self.included(cls)
     cls.class_exec do
       include Dependency
@@ -14,7 +16,7 @@ module Consumer
 
       prepend Configure
 
-      initializer :stream_name
+      initializer :category
 
       attr_writer :identifier
       def identifier
@@ -31,11 +33,11 @@ module Consumer
         @position_update_counter ||= 0
       end
 
-      attr_accessor :session
-
       attr_accessor :poll_interval_milliseconds
 
-      dependency :get
+      attr_accessor :session
+
+      dependency :get, MessageStore::Get
       dependency :position_store, PositionStore
       dependency :subscription, Subscription
 
@@ -47,29 +49,18 @@ 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
+    log_info
+    starting if respond_to?(:starting)
 
-  def start(&probe)
-    logger.info(tag: :*) { "Starting consumer: #{self.class.name} (Stream: #{stream_name}, Identifier: #{identifier || '(none)'}, Position: #{subscription.position})" }
-
-    starting() if respond_to?(:starting)
-
-    self.class.handler_registry.each do |handler|
-      logger.info(tag: :*) { "Handler: #{handler.name} (Stream Name: #{stream_name}, Consumer: #{self.class.name})" }
+    if not MessageStore::StreamName.category?(category)
+      raise Error, "Consumer's stream name must be a category (Stream Name: #{category})"
     end
 
     _, subscription_thread = ::Actor::Start.(subscription)
@@ -82,36 +73,88 @@ module Consumer
       probe.(self, [actor_thread, subscription_thread], [actor_address, subscription_address])
     end
 
-    logger.info(tag: :*) { "Started consumer: #{self.class.name} (Stream: #{stream_name}, 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)
+    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
 
   module LogText
     def self.message_data(message_data)
-      "Type: #{message_data.type}, Stream: #{message_data.stream_name}, Position: #{message_data.position}, GlobalPosition: #{message_data.global_position}"
+      "Type: #{message_data.type}, Stream Name: #{message_data.stream_name}, Position: #{message_data.position}, GlobalPosition: #{message_data.global_position}"
     end
   end
 
   module Configure
     def configure(**kwargs)
-      logger.trace { "Configuring (Stream Name: #{stream_name})" }
+      logger.trace(tag: :consumer) { "Configuring (Category: #{category})" }
 
       super(**kwargs)
 
@@ -124,13 +167,13 @@ module Consumer
         poll_interval_milliseconds: poll_interval_milliseconds
       )
 
-      logger.debug { "Done configuring (Stream Name: #{stream_name}, Starting Position: #{starting_position})" }
+      logger.debug(tag: :consumer) { "Done configuring (Category: #{category}, Starting Position: #{starting_position})" }
     end
   end
 
   module Build
-    def build(stream_name, position_update_interval: nil, poll_interval_milliseconds: nil, identifier: nil, **arguments)
-      instance = new(stream_name)
+    def build(category, position_update_interval: nil, poll_interval_milliseconds: nil, identifier: nil, **arguments)
+      instance = new(category)
 
       unless identifier.nil?
         instance.identifier = identifier
@@ -146,8 +189,8 @@ module Consumer
   end
 
   module Start
-    def start(stream_name, **arguments, &probe)
-      instance = build stream_name, **arguments
+    def start(category, **arguments, &probe)
+      instance = build category, **arguments
       instance.start(&probe)
     end
   end
@@ -180,4 +223,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/consumer.rb

@@ -1,12 +1,12 @@
 module Consumer
   module Controls
     module Consumer
-      def self.example(stream_name=nil, identifier: nil, handlers: nil)
-        stream_name ||= StreamName.example
+      def self.example(category=nil, identifier: nil, handlers: nil)
+        category ||= Category.example
 
         cls = example_class(identifier: identifier, handlers: handlers)
 
-        cls.new(stream_name)
+        cls.new(category)
       end
 
       def self.example_class(identifier: nil, handlers: nil)

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

@@ -2,10 +2,10 @@ module Consumer
   module Controls
     module Consumer
       module ErrorHandler
-        def self.example(stream_name=nil)
-          stream_name ||= StreamName.example
+        def self.example(category=nil)
+          category ||= Category.example
 
-          Example.new(stream_name)
+          Example.new(category)
         end
 
         class Example
@@ -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/consumer/incrementing.rb

@@ -32,7 +32,7 @@ module Consumer
           sleep_duration = ENV['SLEEP_DURATION'] || 100
           sleep_duration = sleep_duration.to_i
 
-          Get::Incrementing.configure(self, stream_name, sleep_duration)
+          Get::Incrementing.configure(self, sleep_duration)
 
           PositionStore::File.configure(self, identifier: identifier)
         end

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

@@ -7,16 +7,23 @@ module Consumer
 
         configure :get
 
-        initializer :stream_name, :frequency_milliseconds
+        def frequency_milliseconds
+          @frequency_milliseconds ||= Defaults.frequency_milliseconds
+        end
+        attr_writer :frequency_milliseconds
 
         def frequency_seconds
           frequency_milliseconds.to_f / 1000
         end
 
-        def self.build(stream_name, frequency_milliseconds=nil)
-          frequency_milliseconds ||= Defaults.frequency_milliseconds
+        def self.build(frequency_milliseconds=nil)
+          instance = new
+          instance.frequency_milliseconds = frequency_milliseconds
+          instance
+        end
 
-          new(stream_name, frequency_milliseconds)
+        def category
+          Category.example
         end
 
         def batch_size
@@ -30,7 +37,6 @@ module Consumer
 
           batch_size.times.map do |offset|
             MessageData.example(
-              stream_name,
               position + offset,
               offset
             )
@@ -48,14 +54,13 @@ module Consumer
         end
 
         class MessageData
-          def self.example(stream_name, global_position, position)
+          def self.example(global_position, position)
             data = {
               :position => position,
               :global_position => global_position
             }
 
             Controls::MessageData.example(
-              stream_name: stream_name,
               data: data,
               global_position: global_position,
               position: position

data/lib/consumer/controls/message_data.rb

@@ -1,13 +1,11 @@
 module Consumer
   module Controls
     module MessageData
-      def self.example(stream_name: nil, data: nil, position: nil, global_position: nil)
+      def self.example(data: nil, position: nil, global_position: nil)
         global_position ||= position
 
         message_data = MessageStore::Controls::MessageData::Read.example(data: data)
 
-        message_data.stream_name = stream_name unless stream_name.nil?
-
         message_data.position = position unless position.nil?
         message_data.global_position = global_position unless global_position.nil?
 

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/stream_name.rb

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

data/lib/consumer/controls/subscription.rb

@@ -1,8 +1,8 @@
 module Consumer
   module Controls
     module Subscription
-      def self.example(stream_name: nil, next_batch: nil, position: nil, batch_size: nil, count: nil)
-        get = Get.example(stream_name: stream_name, batch_size: batch_size, count: count)
+      def self.example(category: nil, next_batch: nil, position: nil, batch_size: nil, count: nil)
+        get = Get.example(stream_name: category, batch_size: batch_size, count: count)
 
         subscription = ::Consumer::Subscription.new(get)
 

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/subscription.rb

@@ -46,20 +46,20 @@ module Consumer
     end
 
     handle :resupply do
-      logger.trace { "Resupplying (Stream Name: #{get.stream_name}, Position: #{position})" }
+      logger.trace { "Resupplying (Category: #{get.category}, Position: #{position})" }
 
       batch = poll.() do
         get.(position)
       end
 
       if batch.nil? || batch.empty?
-        logger.debug { "Did not resupply; no events available (Stream Name: #{get.stream_name}, Position: #{position})" }
+        logger.debug { "Did not resupply; no events available (Stream: #{get.stream_name}, Position: #{position})" }
 
         :resupply
       else
         self.next_batch = batch
 
-        logger.debug { "Resupplied (Stream Name: #{get.stream_name}, Position: #{position}, Batch Size: #{batch.count})" }
+        logger.debug { "Resupplied (Category: #{get.category}, Position: #{position}, Batch Size: #{batch.count})" }
       end
     end
 

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: 1.1.0.0
+  version: 2.3.0.0
 platform: ruby
 authors:
 - The Eventide Project
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ntl-actor
@@ -155,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Continuous subscription to a stream and message dispatching to handlers
+summary: Continuous subscription to a category and message dispatching to handlers
 test_files: []