evt-consumer 2.3.1.5 → 2.4.0.0.dev.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e29553138798ba95289cf828a829e0e896a32eee0cce2f8472aefaf42a31c9ce
-  data.tar.gz: 0c4224924aa28a4ac399261f0798fcea52a8d89208d2c22b3cca6ee4ae44554b
+  metadata.gz: 50a848468126bd23736a624d0746d224389adc1ec14f19d8b61657c59b907595
+  data.tar.gz: c45ab4bcaaaa9e065e39c9fa95a713c2a0b65d5598d0c8abb6d9f38c0f9b4326
 SHA512:
-  metadata.gz: bb8806c27379b594d45685ecb0e7a8247f0be73f1d6b37efd746bcbb06907d6de35f559239a5508f074e5295bd9785673fc0b1384283cfc156d6243c40f668ca
-  data.tar.gz: 8b7014058b97994de853451068a54544f0228667c8637d48ce7618d9ab172ce0b3518b12f336a0ce9a127be179926312db506389a7509a4eed53a9f1ec794d0d
+  metadata.gz: a40e03f7c32d10b668644ad66a5107baded5b9fb5f1e6b52bcdb021c147a569a9345dd468c51c0222c0969afa59bd7b6950959c3baf6eec1b51bc3fe5f0a2e00
+  data.tar.gz: 85cf95b31370ca71fcbf71759686b4577a7445f821e685e29828b038dac3cc041f433005a0fd6707a2340800faf96ade571865600704398e8e30a4bb98c69908

data/lib/consumer/consumer.rb

@@ -5,7 +5,7 @@ module Consumer
     cls.class_exec do
       include Dependency
       include Initializer
-      include TemplateMethod
+      include Virtual
       include Log::Dependency
 
       extend Build
@@ -23,6 +23,11 @@ module Consumer
         @identifier ||= self.class.identifier
       end
 
+      def starting_position
+        @starting_position ||= position_store.get
+      end
+      attr_writer :starting_position
+
       attr_writer :position_update_interval
       def position_update_interval
         @position_update_interval ||= Defaults.position_update_interval
@@ -43,7 +48,7 @@ module Consumer
       dependency :position_store, PositionStore
       dependency :subscription, Subscription
 
-      template_method :error_raised do |error, message_data|
+      virtual :error_raised do |error, message_data|
         raise error
       end
 
@@ -52,7 +57,7 @@ module Consumer
   end
 
   def start(&probe)
-    logger.info(tags: [:consumer, :start]) { "Starting consumer: #{self.class.name} (Category: #{category}, Identifier: #{identifier || '(none)'}, Position: #{subscription.position})" }
+    logger.info(tags: [:consumer, :start]) { "Starting consumer: #{self.class.name} (Category: #{category}, Identifier: #{identifier || '(none)'}, Position: #{starting_position})" }
 
     if Defaults.startup_info?
       print_info
@@ -67,15 +72,12 @@ module Consumer
 
     _, subscription_thread = ::Actor::Start.(subscription)
 
-    actor_address, actor_thread = Actor.start(self, subscription, include: :thread)
-
     if probe
       subscription_address = subscription.address
-
-      probe.(self, [actor_thread, subscription_thread], [actor_address, subscription_address])
+      probe.(self, subscription_address, subscription_thread)
     end
 
-    logger.info(tags: [:consumer, :start]) { "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: #{starting_position})" }
 
     AsyncInvocation::Incorrect
   end
@@ -84,7 +86,7 @@ module Consumer
     STDOUT.puts
     STDOUT.puts "    Consumer: #{self.class.name}"
     STDOUT.puts "      Category: #{category}"
-    STDOUT.puts "      Position: #{subscription.position}"
+    STDOUT.puts "      Position: #{starting_position}"
     STDOUT.puts "      Identifier: #{identifier || '(none)'}"
 
     print_startup_info if respond_to?(:print_startup_info)
@@ -102,7 +104,7 @@ module Consumer
 
   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]) { "Position: #{starting_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)
@@ -160,14 +162,9 @@ module Consumer
 
       super(**kwargs)
 
-      starting_position = self.position_store.get
-
-      Subscription.configure(
-        self,
-        get,
-        position: starting_position,
-        poll_interval_milliseconds: poll_interval_milliseconds
-      )
+      get = self.get
+      position = self.starting_position
+      Subscription.configure(self, get, position: position, poll_interval_milliseconds: poll_interval_milliseconds)
 
       logger.debug(tag: :consumer) { "Done configuring (Category: #{category}, Starting Position: #{starting_position})" }
     end

data/lib/consumer/controls/get.rb

@@ -1,5 +1,19 @@
 module Consumer
   module Controls
-    Get = MessageStore::Controls::Get
+    module Get
+      def self.example(batch_size: nil)
+        batch_size ||= self.batch_size
+
+        MessageStore::Controls::Get.example(stream_name: stream_name, batch_size: batch_size)
+      end
+
+      def self.stream_name
+        Category.example
+      end
+
+      def self.batch_size
+        MessageData::Batch.size
+      end
+    end
   end
 end

data/lib/consumer/controls/position.rb

@@ -1,6 +1,10 @@
 module Consumer
   module Controls
     module Position
+      def self.example
+        Global.example
+      end
+
       module Stream
         def self.example
           MessageStore::Controls::MessageData.position

data/lib/consumer/controls/subscription.rb

@@ -1,18 +1,18 @@
 module Consumer
   module Controls
     module Subscription
-      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)
+      def self.example(get: nil, batch_size: nil)
+        get ||= Get.example(batch_size: batch_size)
 
-        subscription = ::Consumer::Subscription.new(get)
-
-        subscription.position = position if position
+        ::Consumer::Subscription.new(get, position)
+      end
 
-        unless next_batch.nil?
-          subscription.next_batch = next_batch
-        end
+      def self.get
+        Get.example
+      end
 
-        subscription
+      def self.position
+        Position::Global.example
       end
     end
   end

data/lib/consumer/controls.rb

@@ -16,13 +16,12 @@ require 'consumer/controls/settings'
 
 require 'consumer/controls/position_store'
 require 'consumer/controls/position_store/file'
-require 'consumer/controls/subscription'
 
 require 'consumer/controls/handle'
 require 'consumer/controls/handle/raise_error'
 require 'consumer/controls/handle/settings'
 
-require 'consumer/controls/actor'
+require 'consumer/controls/subscription'
 
 require 'consumer/controls/consumer'
 require 'consumer/controls/consumer/incrementing'

data/lib/consumer/position_store.rb

@@ -3,8 +3,7 @@ module Consumer
     def self.included(cls)
       cls.class_exec do
         include Dependency
-        include TemplateMethod
-
+        include Virtual
         include Log::Dependency
 
         extend Build
@@ -16,17 +15,16 @@ module Consumer
 
         dependency :telemetry, ::Telemetry
 
-        template_method :configure
-        template_method :location
+        virtual :location
       end
     end
 
+    Virtual::VirtualMethod.define(self, :configure)
+
     module Build
       def self.extended(cls)
         cls.singleton_class.class_exec do
-          include TemplateMethod
-
-          template_method! :build
+          Virtual::PureMethod.define(self, :build)
         end
       end
     end
@@ -57,9 +55,7 @@ module Consumer
 
     module Get
       def self.prepended(cls)
-        cls.class_exec do
-          template_method! :get
-        end
+        Virtual::PureMethod.define(cls, :get)
       end
 
       def get
@@ -77,9 +73,7 @@ module Consumer
 
     module Put
       def self.prepended(cls)
-        cls.class_exec do
-          template_method :put
-        end
+        Virtual::VirtualMethod.define(cls, :put)
       end
 
       def put(position)

data/lib/consumer/subscription.rb

@@ -1,35 +1,39 @@
 module Consumer
   class Subscription
     include ::Actor
-    include ::Configure
     include Dependency
     include Initializer
     include Log::Dependency
 
-    configure :subscription
+    initializer :get, a(:position)
 
-    initializer :get
-
-    attr_accessor :next_batch
+    dependency :consumer, Consumer
+    dependency :poll, Poll
 
-    attr_writer :position
-    def position
-      @position ||= 0
+    attr_writer :prefetch_queue
+    def prefetch_queue
+      @prefetch_queue ||= []
     end
 
     def batch_size
       get.batch_size
     end
 
-    dependency :poll, Poll
+    def category
+      get.category
+    end
 
-    def self.build(get, position: nil, poll_interval_milliseconds: nil)
+    def position
+      @position ||= 0
+    end
+
+    def self.build(consumer, get, position: nil, poll_interval_milliseconds: nil)
       poll_interval_milliseconds ||= Defaults.poll_interval_milliseconds
       poll_timeout_milliseconds = Defaults.poll_timeout_milliseconds
 
-      instance = new(get)
+      instance = new(get, position)
 
-      instance.position = position
+      instance.consumer = consumer
 
       Poll.configure(
         instance,
@@ -41,56 +45,48 @@ module Consumer
       instance
     end
 
+    def self.configure(receiver, get, consumer: nil, position: nil, poll_interval_milliseconds: nil, attr_name: nil)
+      attr_name ||= :subscription
+
+      consumer ||= receiver
+
+      instance = build(consumer, get, position: position, poll_interval_milliseconds: poll_interval_milliseconds)
+      receiver.public_send(:"#{attr_name}=", instance)
+      instance
+    end
+
     handle :start do
-      :resupply
+      :next_batch
     end
 
-    handle :resupply do
-      logger.trace { "Resupplying (Category: #{get.category}, Position: #{position})" }
+    handle :next_batch do
+      logger.trace(tag: :actor) { "Getting batch (Position: #{position}, Category: #{category}, Batch Size: #{batch_size})" }
 
       batch = poll.() do
         get.(position)
       end
 
       if batch.nil? || batch.empty?
-        logger.debug { "Did not resupply; no events available (Stream: #{get.stream_name}, Position: #{position})" }
-
-        :resupply
+        logger.debug { "No batch retrieved (Position: #{position}, Category: #{category}, Batch Size: #{batch_size})" }
       else
-        self.next_batch = batch
-
-        logger.debug { "Resupplied (Category: #{get.category}, Position: #{position}, Batch Size: #{batch.count})" }
-      end
-    end
+        logger.debug(tag: :actor) { "Batch retrieved (Position: #{position}, Category: #{category}, Batch Size: #{batch_size})" }
 
-    handle :get_batch do |get_batch|
-      logger.trace { "Batch request received" }
-
-      if next_batch.nil?
-        logger.debug { "Could not fulfill batch request; deferring" }
-
-        return get_batch
+        batch.each do |message|
+          dispatch(message)
+        end
       end
 
-      batch = reset_next_batch
-
-      reply_message = get_batch.reply_message(batch)
-
-      send.(reply_message, get_batch.reply_address)
-
-      logger.debug { "Batch request fulfilled; resupplying (Batch Size: #{batch.count})" }
-
-      :resupply
+      :next_batch
     end
 
-    def reset_next_batch
-      batch = next_batch
+    def dispatch(message)
+      logger.trace(tag: :actor) { "Dispatching message (Position: #{position}, Category: #{category})" }
 
-      self.next_batch = nil
+      consumer.dispatch(message)
 
-      self.position = batch.last.global_position + 1
+      self.position = message.global_position + 1
 
-      batch
+      logger.debug(tag: :actor) { "Dispatched message (Position: #{position}, Category: #{category})" }
     end
   end
 end

data/lib/consumer.rb

@@ -17,11 +17,8 @@ require 'consumer/position_store'
 require 'consumer/position_store/substitute'
 require 'consumer/position_store/telemetry'
 
-require 'consumer/subscription'
-require 'consumer/subscription/defaults'
-require 'consumer/subscription/get_batch'
-
 require 'consumer/consumer'
 require 'consumer/substitute'
 
-require 'consumer/actor'
+require 'consumer/subscription'
+require 'consumer/subscription/defaults'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt-consumer
 version: !ruby/object:Gem::Version
-  version: 2.3.1.5
+  version: 2.4.0.0.dev.1
 platform: ruby
 authors:
 - The Eventide Project
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ntl-actor
@@ -101,10 +101,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/consumer.rb
-- lib/consumer/actor.rb
 - lib/consumer/consumer.rb
 - lib/consumer/controls.rb
-- lib/consumer/controls/actor.rb
 - lib/consumer/controls/category.rb
 - lib/consumer/controls/consumer.rb
 - lib/consumer/controls/consumer/error_handler.rb
@@ -135,7 +133,6 @@ files:
 - lib/consumer/position_store/telemetry.rb
 - lib/consumer/subscription.rb
 - lib/consumer/subscription/defaults.rb
-- lib/consumer/subscription/get_batch.rb
 - lib/consumer/substitute.rb
 homepage: https://github.com/eventide-project/consumer
 licenses:
@@ -152,9 +149,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key:

data/lib/consumer/actor.rb

@@ -1,86 +0,0 @@
-module Consumer
-  class Actor
-    include ::Actor
-    include Dependency
-    include Initializer
-    include Log::Dependency
-
-    initializer :subscription_address, a(:delay_threshold)
-
-    dependency :consumer, Consumer
-
-    attr_writer :prefetch_queue
-    def prefetch_queue
-      @prefetch_queue ||= []
-    end
-
-    def self.build(consumer, subscription)
-      subscription_address = subscription.address
-
-      delay_threshold = subscription.batch_size
-
-      instance = new(subscription_address, delay_threshold)
-      instance.consumer = consumer
-      instance.configure
-      instance
-    end
-
-    handle :start do
-      request_batch
-    end
-
-    handle Subscription::GetBatch::Reply do |get_batch_reply|
-      received_batch = get_batch_reply.batch
-
-      logger.trace(tag: :actor) { "Received batch (Received Batch Size: #{received_batch.size}, Prefetch Queue Depth: #{prefetch_queue.size}, Delay Threshold: #{delay_threshold})" }
-
-      prefetch_queue_empty = prefetch_queue.empty?
-
-      self.prefetch_queue += received_batch
-
-      unless prefetch_queue.size > delay_threshold
-        request_batch
-      end
-
-      if prefetch_queue_empty
-        next_message = :dispatch
-      end
-
-      logger.debug(tag: :actor) { "Batch received (Received Batch Size: #{received_batch.size}, Prefetch Queue Depth: #{prefetch_queue.size}, Delay Threshold: #{delay_threshold}, Next Actor Message: #{next_message || '(none)'})" }
-
-      next_message
-    end
-
-    handle :dispatch do
-      logger.trace(tag: :actor) { "Dispatching Message (Prefetch Queue Depth: #{prefetch_queue.size}, Delay Threshold: #{delay_threshold})" }
-
-      dispatch_message = prefetch_queue.shift
-
-      if prefetch_queue.size == delay_threshold
-        request_batch
-      end
-
-      consumer.dispatch(dispatch_message)
-
-      unless prefetch_queue.empty?
-        next_message = :dispatch
-      end
-
-      logger.debug(tag: :actor) { "Dispatched Message (Prefetch Queue Depth: #{prefetch_queue.size}, Delay Threshold: #{delay_threshold}, Global Position: #{dispatch_message.global_position}, Next Actor Message: #{next_message || '(none)'})" }
-
-      next_message
-    end
-
-    def request_batch
-      logger.trace(tag: :actor) { "Requesting batch (Prefetch Queue Depth: #{prefetch_queue.size}, Delay Threshold: #{delay_threshold})" }
-
-      get_batch = Subscription::GetBatch.new(address)
-
-      send.(get_batch, subscription_address)
-
-      logger.debug(tag: :actor) { "Sent batch request (Prefetch Queue Depth: #{prefetch_queue.size}, Delay Threshold: #{delay_threshold})" }
-
-      nil
-    end
-  end
-end

data/lib/consumer/controls/actor.rb

@@ -1,24 +0,0 @@
-module Consumer
-  module Controls
-    module Actor
-      def self.example(subscription_address: nil, delay_threshold: nil)
-        delay_threshold ||= DelayThreshold.example
-        subscription_address ||= Address.example
-
-        ::Consumer::Actor.new(subscription_address, delay_threshold)
-      end
-
-      module DelayThreshold
-        def self.example
-          11
-        end
-      end
-
-      module Address
-        def self.example
-          ::Actor::Messaging::Address.build
-        end
-      end
-    end
-  end
-end

data/lib/consumer/subscription/get_batch.rb

@@ -1,17 +0,0 @@
-module Consumer
-  class Subscription
-    GetBatch = Struct.new(:reply_address)
-
-    class GetBatch
-      include ::Actor::Messaging::Message
-
-      def reply_message(batch)
-        Reply.new batch
-      end
-
-      Reply = Struct.new :batch do
-        include ::Actor::Messaging::Message
-      end
-    end
-  end
-end