edgycircle_kommando 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2962518e6deb43c8cd51657f311ebbd96caf84d0e04cfb7505c7c427fddec0b
-  data.tar.gz: 8cdfe6722fb04875ee8fc3e0fd1240d8c6edbae8dbddb992cc3a9fa89c4c6166
+  metadata.gz: 2300c17942818f67efb101af6443bbe021cd8ef269df1e5ab7e073abde7f04c0
+  data.tar.gz: b884a42aa3a35334e2fe12dcc197329f3656ce565eaeb362ec2a865a641d9aa3
 SHA512:
-  metadata.gz: 895e1f7f17a43f5b9ec5d8fe05a71a09d3b024c55c639f4fcd4c0916597502f0ff23caf352f9001c6d3e45b6b959f134fa590576e83a24383dfc2cf53f9f6434
-  data.tar.gz: cdb250ff046a059b5aaf59f7fcc2384ff8174e9fbdde943826d09280403f41f4bbd9f5ec7127158b5dec014f1128dfd01c7e7e93afcd11ef4004bc4e602722f2
+  metadata.gz: d3ee07d9718e3d8dba262056152be6a952ec3eca8b66a9c49205b150e1b122c6a2f0301a96b01acba543a043dc5e98a2576aad9b4b5b458a126f30977f094334
+  data.tar.gz: fd0fb4a29d2376cbf751a8c94c995eb64f40851e7ec865a33a62df9bd64e81a67de6614504ff155ea93cfe5a2375c2e6b73caa04a9e895481238b0d8598f7c8a

data/lib/kommando/scheduled_command_adapters/active_record.rb

@@ -40,6 +40,22 @@ module Kommando
         end
       end
 
+      def self.metrics
+        executable = where('TIMEZONE(\'UTC\', NOW()) >= handle_at').
+          where.not("wait_for_command_ids && (SELECT array_agg(id) FROM #{table_name})").
+          count
+
+        scheduled = count
+
+        with_failures = where('array_length(failures, 1) > 0').count
+
+        {
+          kommando_executable_commands: executable,
+          kommando_scheduled_commands: scheduled,
+          kommando_scheduled_commands_with_failures: with_failures,
+        }
+      end
+
       def parameters
         @parameters ||= super.deep_symbolize_keys!
       end

data/lib/kommando/scheduled_command_adapters/memory.rb

@@ -0,0 +1,89 @@
+require 'ostruct'
+
+# stravid@2022-01-10: This implementation is currently not threadsafe.
+#                     Instead of two arrays we need to use a single one in
+#                     combination with a mutex.
+module Kommando
+  module ScheduledCommandAdapters
+    class Memory
+      @@scheduled = []
+      @@locked_ids = []
+
+      def self.schedule!(command, parameters, handle_at)
+        @@scheduled << {
+          id: parameters.fetch(:command_id),
+          name: command,
+          parameters: parameters,
+          handle_at: handle_at,
+          failures: [],
+          wait_for_command_ids: parameters.fetch(:wait_for_command_ids, []),
+        }
+      end
+
+      def self.fetch!(&block)
+        scheduled_ids = @@scheduled.map { |command| command[:id] }
+
+        record = @@scheduled.select do |command|
+          next if @@locked_ids.include?(command[:id])
+          next if Time.now < command[:handle_at]
+          next if command[:wait_for_command_ids].any? { |id| scheduled_ids.include?(id) }
+
+          true
+        end.sort do |a, b|
+          a[:handle_at] <=> b[:handle_at]
+        end.first
+
+        if record
+          @@locked_ids.push(record[:id])
+          result = block.call(record[:name], record[:parameters])
+
+          if result.success?
+            @@scheduled.delete(record)
+          else
+            record[:failures] = record[:failures].append(result.error)
+            record[:handle_at] = record[:handle_at] + 5 * 60
+          end
+
+          @@locked_ids.delete(record[:id])
+        end
+      end
+
+      def self.metrics
+        scheduled_ids = @@scheduled.map { |command| command[:id] }
+
+        executable = @@scheduled.select do |command|
+          next if @@locked_ids.include?(command[:id])
+          next if Time.now < command[:handle_at]
+          next if command[:wait_for_command_ids].any? { |id| scheduled_ids.include?(id) }
+
+          true
+        end.size
+
+        scheduled = count
+
+        with_failures = @@scheduled.select do |command|
+          command[:failures].size > 0
+        end.size
+
+        {
+          kommando_executable_commands: executable,
+          kommando_scheduled_commands: scheduled,
+          kommando_scheduled_commands_with_failures: with_failures,
+        }
+      end
+
+      def self.first
+        OpenStruct.new(@@scheduled.first)
+      end
+
+      def self.count
+        @@scheduled.size
+      end
+
+      def self.clear
+        @@scheduled = []
+        @@locked_ids = []
+      end
+    end
+  end
+end

data/lib/kommando/scheduled_command_adapters/sequel.rb

@@ -0,0 +1,96 @@
+require 'sequel'
+
+module Kommando
+  module ScheduledCommandAdapters
+    Sequel::Model.db.extension :pg_array
+    Sequel::Model.db.extension :pg_json
+
+    class Sequel < ::Sequel::Model(:kommando_scheduled_commands)
+      unrestrict_primary_key
+
+      def self.schedule!(command, parameters, handle_at)
+        create({
+          id: parameters.fetch(:command_id),
+          name: command,
+          parameters: JSON.generate(parameters),
+          handle_at: handle_at,
+          failures: ::Sequel.pg_array([], :json),
+          wait_for_command_ids: ::Sequel.pg_array(parameters.fetch(:wait_for_command_ids, []), :uuid),
+        })
+      end
+
+      def self.fetch!(&block)
+        db.transaction do
+          record = lock_style("FOR UPDATE OF #{table_name} SKIP LOCKED").
+            where(::Sequel.lit('TIMEZONE(\'UTC\', NOW()) >= handle_at')).
+            exclude(::Sequel.lit("wait_for_command_ids && (SELECT array_agg(id) FROM #{table_name})")).
+            order(::Sequel.asc(:handle_at)).
+            limit(1).
+            first
+
+          if record
+            result = block.call(record.name, record.parameters)
+
+            if result.success?
+              record.destroy
+            else
+              failures = record.failures.append(result.error).map do |failure|
+                JSON.generate(failure)
+              end
+
+              record.update({
+                failures: ::Sequel.pg_array(failures, :json),
+                handle_at: (record.handle_at + 5 * 60).getutc,
+              })
+            end
+          end
+        end
+      end
+
+      def self.metrics
+        executable = where(::Sequel.lit('TIMEZONE(\'UTC\', NOW()) >= handle_at')).
+          exclude(::Sequel.lit("wait_for_command_ids && (SELECT array_agg(id) FROM #{table_name})")).
+          count
+
+        scheduled = count
+
+        with_failures = where(::Sequel.lit('array_length(failures, 1) > 0')).count
+
+        {
+          kommando_executable_commands: executable,
+          kommando_scheduled_commands: scheduled,
+          kommando_scheduled_commands_with_failures: with_failures,
+        }
+      end
+
+      def parameters
+        @parameters ||= deep_symbolize(super)
+      end
+
+      def failures
+        @failures ||= deep_symbolize(super)
+      end
+
+      def handle_at
+        offset = super.gmt_offset
+        super.dup.gmtime + offset
+      end
+
+      private
+      def deep_symbolize(original)
+        case original
+        when ::Sequel::Postgres::PGArray, Array
+          original.map do |item|
+            deep_symbolize(item)
+          end
+        when ::Sequel::Postgres::JSONHash, Hash
+          original.map do |key, value|
+            [key.to_sym, deep_symbolize(value)]
+          end.to_h
+        else
+          original
+        end
+      end
+    end
+  end
+end

data/lib/kommando/scheduled_command_runner.rb

@@ -1,25 +1,66 @@
 module Kommando
   class ScheduledCommandRunner
-    def initialize(coordinator, adapter, dependencies)
-      @coordinator = coordinator
+    JITTER = 0.5
+    PAUSE = 5.0
+
+    def initialize(number, adapter, dependencies)
+      @number = number
       @adapter = adapter
       @dependencies = dependencies
+      @thread = nil
+      @stop_before_next_fetch = false
+      @stopped = false
+    end
+
+    def start
+      @thread ||= start_thread("runner-#{@number}", &method(:run))
+    end
+
+    def stop_before_next_fetch
+      @stop_before_next_fetch = true
+    end
+
+    def stopped?
+      @stopped
+    end
+
+    def kill
+      @thread.kill
+    end
+
+    private
+    def start_thread(name, &block)
+      Thread.new do
+        yield
+      end
     end
 
-    def call
-      fetched_command = false
+    def run
+      fetch until @stop_before_next_fetch
+      @stopped = true
+    rescue StandardError => exception
+      @stopped = true
+      raise exception
+    end
+
+    def fetch
+      immediately_fetch_again = false
 
       @adapter.fetch! do |command_name, parameters|
         unless self.class.const_defined?(command_name)
           raise Command::UnknownCommandError, "Unknown command `#{command_name}`"
         end
 
-        fetched_command = true
+        immediately_fetch_again = true
 
         self.class.const_get(command_name).execute(@dependencies, parameters)
       end
 
-      @coordinator.schedule_next_run(fetched_command ? 0 : 5)
+      sleep sleep_duration_after_empty_fetch unless immediately_fetch_again
+    end
+
+    def sleep_duration_after_empty_fetch
+      rand((PAUSE - JITTER)..(PAUSE + JITTER))
     end
   end
 end

data/lib/kommando/scheduled_command_worker.rb

@@ -1,23 +1,37 @@
 module Kommando
   class ScheduledCommandWorker
-    def initialize(adapter, dependencies, number_of_threads)
-      @adapter = adapter
-      @dependencies = dependencies
-      @number_of_threads = number_of_threads
+    WAIT_STEP_SIZE = 0.25
+    WAIT_LIMIT = 20.0
+
+    def initialize(adapter, dependencies, number_of_runners)
+      @number_of_runners = number_of_runners
+      @runners = []
+
+      @runners << ScheduledCommandRunner.new(@runners.size + 1, adapter, dependencies) while @runners.size < @number_of_runners
+
+      @self_read, @self_write = IO.pipe
     end
 
     def start
-      @pool = Concurrent::FixedThreadPool.new(@number_of_threads)
-      @number_of_threads.times { schedule_next_run(0) }
-      @pool.wait_for_termination
+      @runners.each(&:start)
+      IO.select([@self_read])
     end
 
     def stop
-      @pool.shutdown
+      @runners.each(&:stop_before_next_fetch)
+
+      deadline = now + WAIT_LIMIT
+
+      sleep WAIT_STEP_SIZE until @runners.all?(&:stopped?) || now > deadline
+
+      @runners.reject(&:stopped?).each(&:kill)
+
+      @self_write.puts(:stop)
     end
 
-    def schedule_next_run(delay)
-      Concurrent::ScheduledTask.execute(delay, { executor: @pool }, &ScheduledCommandRunner.new(self, @adapter, @dependencies).method(:call))
+    private
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
   end
 end

data/lib/kommando/sequel.rb

@@ -0,0 +1,2 @@
+require_relative '../kommando'
+require_relative './scheduled_command_adapters/sequel'

data/lib/kommando/version.rb

@@ -1,3 +1,3 @@
 module Kommando
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/kommando.rb

@@ -7,6 +7,7 @@ require_relative './kommando/command_plugins/execute'
 require_relative './kommando/command_plugins/schedule'
 require_relative './kommando/command_plugins/validate'
 require_relative './kommando/command_plugins/auto_schedule'
+require_relative './kommando/scheduled_command_adapters/memory'
 
 module Kommando
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edgycircle_kommando
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - David Strauß
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Command architecture building blocks.
 email:
 - david.strauss@edgycircle.com
@@ -113,8 +127,11 @@ files:
 - lib/kommando/command_plugins/validate.rb
 - lib/kommando/command_result.rb
 - lib/kommando/scheduled_command_adapters/active_record.rb
+- lib/kommando/scheduled_command_adapters/memory.rb
+- lib/kommando/scheduled_command_adapters/sequel.rb
 - lib/kommando/scheduled_command_runner.rb
 - lib/kommando/scheduled_command_worker.rb
+- lib/kommando/sequel.rb
 - lib/kommando/version.rb
 homepage: https://github.com/edgycircle/kommando
 licenses:
@@ -128,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="