web47core 3.2.3.41 → 3.2.3.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5167f51146e44ae39a5cb3411634be0fcef03e696859bb7eabf9fe7222ad65a0
-  data.tar.gz: 4a7c22205a6b2033c41cccce824db4cf6be86e11fec06578165fab0c367aff20
+  metadata.gz: 1c38f0e545dfc8cb448c6f81d1797865f85b73a3ad8efe6e3e8912eaea1017db
+  data.tar.gz: 4fb1faf78c41405b5d0fab207b640d7b428c424bf53a361f59fbf3b4a83b7e64
 SHA512:
-  metadata.gz: fc25f298a11e9bb9d70feba03cdc92f4bf61918f740e7f40d6eb1fce5bb0d0613933c18e248877bf0fdc3b10cc58711fff64e501eba95c7435830906639e9a1e
-  data.tar.gz: 9602c563c2118543ab4cc6858ba668854f599f85342cbf08a08f639d7e2e95093203fafc6e57760c8e93e32e08043c340744e684dd89cfceede3f4a64c5e625f
+  metadata.gz: a3ae117203e66f4b9c2a02cadd2fa322b9e62be14fe68e9d7588fb37a566ef8121b58bff09a95f95668458100133f14b44fa8d976ec8c80d31a7c0209c2670cc
+  data.tar.gz: 9d7c26fe8b4d246dff55bcb1e4545ff57ed7de3ec84e9f4697fba8385be903761d2d3f5529cb9add05e608d93586b4cd162acfb4164b9a2e172fe4722bebc124

data/README.md

@@ -10,20 +10,21 @@ Core components used commonly among all web apps for both App47 and RedMonocle
 
 ## Requirements
 
-*   Ruby 3.2.3
+*   web47core 3.2.3.43
+*   Ruby 3.2.3 through 3.4. This repository develops on 3.4.10.
 
 ### Working with Bundler and RBENV
 
 This project manages [RBENV](https://github.com/rbenv/rbenv) and manages dependencies via [Bundler](http://gembundler.com/).
 
 You must first [install RBENV](https://github.com/rbenv/rbenv#installation).
-Then install Ruby 3.2.3 via RBENV
+Then install Ruby 3.4.10 via RBENV
 ``` shell script
-rbenv install 3.2.3
+rbenv install 3.4.10
 ```
-You'll now notice that this project (as well as other App47 ones) contains a .ruby-version file, which is executed upon opening the project's root directory in a terminal (and IDE's like RubyMine). The .ruby-version file simply states `2.7.0` which tells RBENV to ensure the Ruby version to use for this project is 2.7.0.
+You'll now notice that this project (as well as other App47 ones) contains a .ruby-version file, which is executed upon opening the project's root directory in a terminal (and IDE's like RubyMine). The .ruby-version file simply states `3.4.10` which tells RBENV to ensure the Ruby version to use for this project is 3.4.10.
 
-Please note, your Ruby `3.2.3` version might need bundler installed:
+Please note, your Ruby `3.4.10` version might need bundler installed:
 ``` shell script
 gem install bundler -v 2.5.4
 ``` 

data/app/controllers/status_controller.rb

@@ -118,15 +118,15 @@ class StatusController < ActionController::Base
   end
 
   #
-  # Desired and current worker status for servers
+  # Desired and current worker counts, last written by AutoScaler.
   #
   def workers_status
-    server = cron_job_server
-    raise 'No primary server' if server.blank? || server.dead?
-
-    report_success "Workers #{server.desired_server_count}/ #{server.current_server_count}",
-                   desired_count: server.desired_server_count,
-                   current_count: server.current_server_count
+    config = SystemConfiguration.configuration
+    desired = config.aws_desired_worker_count.to_i
+    current = config.aws_current_worker_count.to_i
+    report_success "Workers #{desired}/ #{current}",
+                   desired_count: desired,
+                   current_count: current
   rescue StandardError => error
     report_error(error, desired_count: 0, current_count: 0)
   end

data/lib/app/jobs/cron/server.rb

@@ -16,8 +16,6 @@ module Cron
     #
     # Fields
     #
-    field :desired_server_count, type: Integer, default: 0
-    field :current_server_count, type: Integer, default: 0
     field :state, type: String, default: STATE_SECONDARY
     #
     # Validations
@@ -52,7 +50,7 @@ module Cron
 
     def run_cron_jobs
       run_jobs
-      check_auto_scale
+      AutoScaler.check
     end
 
     # @abstract Run all cron tab and emitter jobs
@@ -85,15 +83,6 @@ module Cron
       Cron::Server.where(state: STATE_PRIMARY).first
     end
 
-    #
-    # Warm up a server on the next evaluation
-    #
-    def self.warm_up_server
-      return unless auto_scaling_configured?
-
-      primary_server.auto_scale([primary_server.desired_server_count + 1, 10].min)
-    end
-
     #
     # Become primary, making others secondary
     #
@@ -148,124 +137,6 @@ module Cron
       !alive?
     end
 
-    #
-    # Auto scale environment
-    #
-    def check_auto_scale
-      return unless auto_scaling_configured?
-
-      if delayed_jobs_count.zero?
-        handle_zero_job_count
-      else
-        handle_auto_scale_jobs
-      end
-    end
-
-    def sys_config
-      @sys_config ||= SystemConfiguration.configuration
-    end
-
-    #
-    # Test if autoscaling is configured, return false if there is an error
-    #
-    def auto_scaling_configured?
-      @auto_scaling_configured ||= sys_config.aws_auto_scaling_configured?
-    rescue StandardError
-      false
-    end
-
-    #
-    # Test if autoscaling is configured, return false if there is an error
-    #
-    def self.auto_scaling_configured?
-      SystemConfiguration.aws_auto_scaling_configured?
-    rescue StandardError
-      false
-    end
-
-    # @abstract Returns the AWS ECS service
-    # @return [Aws::ECS::Types::Service]
-    def ecs_service
-      filter = { cluster: sys_config.aws_ecs_cluster_worker_name, services: [sys_config.aws_ecs_service_worker_name] }
-      @ecs_service ||= ecs_client.describe_services(filter).services.first
-    end
-
-    # @abstract Returns a count of the Delayed Jobs in queue that have not failed
-    # @return [Integer]
-    def delayed_jobs_count
-      @delayed_jobs_count ||= Delayed::Backend::Mongoid::Job.where(failed_at: nil).read(mode: :primary).count
-    end
-
-    # @abstract Returns the current value of 'desired capacity' for the ECS Service
-    # @return [Integer]
-    def current_desired_capacity
-      current = ecs_service.desired_count
-      set current_server_count: current
-      current
-    rescue StandardError
-      puts 'error on desirect capacy'
-      0
-    end
-
-    #
-    # Calls the 'auto_scale' method with a 'desired_count' of 0 unless the capacity is already at 0
-    #
-    def handle_zero_job_count
-      return if current_desired_capacity.zero?
-
-      auto_scale
-    end
-
-    #
-    # Calls the 'auto_scale' method with a variable 'desired_count' based on how many jobs are running
-    # We don't need any more workers if the job count is less than 1,000
-    #
-    def handle_auto_scale_jobs
-      return if delayed_jobs_count < sys_config.aws_min_worker_job_count
-
-      case delayed_jobs_count
-      when 1..200
-        auto_scale(1)
-      when 201..500
-        auto_scale(2)
-      when 501..800
-        auto_scale(3)
-      when 801..1_200
-        auto_scale(4)
-      when 1_201..2_000
-        auto_scale(4)
-      when 2_001..3_000
-        auto_scale(5)
-      when 3_001..4_000
-        auto_scale(5)
-      when 4_001..6_000
-        auto_scale(6)
-      when 6_001..8_000
-        auto_scale(7)
-      when 8_001..10_000
-        auto_scale(8)
-      when 10_001..13_000
-        auto_scale(9)
-      else
-        auto_scale(10)
-      end
-    end
-
-    #
-    # Sets the desired and minimum number of EC2 instances to run
-    #
-    def auto_scale(desired_count = 0)
-      set desired_server_count: desired_count
-      # Make sure we don't remove any workers with assigned jobs by accident
-      return if desired_count.positive? && desired_count <= current_desired_capacity
-
-      ecs_client.update_service(cluster: sys_config.aws_ecs_cluster_worker_name,
-                                service: sys_config.aws_ecs_service_worker_name,
-                                desired_count: desired_count)
-    rescue StandardError => error
-      App47Logger.log_error "Unable to set ECS service auto scaler to #{desired_count}", error
-    end
-
     #
     # Look to make sure there is only one primary
     #
@@ -276,28 +147,8 @@ module Cron
       errors.add(:state, 'there can only be one primary') unless primary.blank? || primary.eql?(self)
     end
 
-    #
-    # Returns the count of active servers
-    #
-    def active_count
-      current_server_count
-    end
-
-    #
-    # Returns the count of inactive servers
-    #
-    def inactive_count
-      desired_server_count
-    end
-
     def ensure_last_check_in
       self.last_check_in_at ||= Time.now.utc
     end
-
-    # @abstract Returns the AWS ECS client
-    # @return [Aws::ECS::Client]
-    def ecs_client
-      @ecs_client ||= sys_config.aws_ecs_client
-    end
   end
 end

data/lib/app/models/concerns/aws_configuration.rb

@@ -13,9 +13,13 @@ module AwsConfiguration
       #
       field :aws_region, type: String
       field :aws_bucket_name, type: String
-      field :aws_min_worker_job_count, type: Integer, default: 1
+      # Worker fleet size asked for by AutoScaler. Not edited from the admin form.
+      field :aws_desired_worker_count, type: Integer, default: 0
+      # ECS service desired count from the last DescribeServices. Not the running task count.
+      field :aws_current_worker_count, type: Integer, default: 0
 
-      validates :aws_min_worker_job_count, numericality: { only_integer: true, greater_than: 0 }
+      validates :aws_desired_worker_count, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+      validates :aws_current_worker_count, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
     end
   end
 

data/lib/app/services/auto_scaler.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+#
+# Resize the ECS worker service from the current thread.
+#
+# check runs after the primary cron server has launched due jobs.
+# warm_up raises the fleet to a floor. bump_worker adds one worker.
+# Neither call lowers a fleet that is already larger, except check when the
+# ladder maps the queue to zero workers.
+#
+# A host project replaces the ladder at boot:
+#
+#   Web47core::Config.worker_ladder = [
+#     [0..49, 0],
+#     [50..500, 2],
+#     [501.., 6]
+#   ]
+#
+# Queue depth and the live ECS desired count are read on every call.
+# The singleton only keeps the ECS client.
+#
+class AutoScaler
+  include Singleton
+
+  unless defined? DEFAULT_WORKER_LADDER
+    DEFAULT_WORKER_LADDER = [
+      [0..0, 0],
+      [1..200, 1],
+      [201..500, 2],
+      [501..800, 3],
+      [801..2_000, 4],
+      [2_001..4_000, 5],
+      [4_001..6_000, 6],
+      [6_001..8_000, 7],
+      [8_001..10_000, 8],
+      [10_001..13_000, 9],
+      [13_001.., 10]
+    ].freeze
+  end
+
+  def self.check
+    instance.check
+  end
+
+  def self.warm_up(min: 1)
+    instance.warm_up(min: min)
+  end
+
+  def self.bump_worker
+    instance.bump_worker
+  end
+
+  def self.reset
+    instance.reset
+  end
+
+  def check
+    return unless configured?
+
+    apply_target(desired_for(delayed_jobs_count))
+  end
+
+  #
+  # Raise the ECS desired count to at least min. Never lowers the fleet.
+  #
+  def warm_up(min: 1)
+    return unless configured?
+
+    target = [[min.to_i, 1].max, max_worker_count].min
+    scale_to(target)
+  end
+
+  #
+  # Add one worker to the live ECS desired count, capped at the ladder maximum.
+  #
+  def bump_worker
+    return unless configured?
+
+    current = live_desired_count
+    return if current.nil?
+
+    scale_to([current + 1, max_worker_count].min, current: current)
+  end
+
+  def reset
+    @ecs_client = nil
+  end
+
+  private
+
+  def apply_target(target)
+    record_desired(target)
+    current = live_desired_count
+    return if current.nil?
+    return if target.positive? && target <= current
+    return if target.zero? && current.zero?
+
+    update_service(target)
+  end
+
+  def scale_to(target, current: nil)
+    current = live_desired_count if current.nil?
+    return if current.nil? || target <= current
+
+    record_desired(target)
+    update_service(target)
+  end
+
+  def desired_for(job_count)
+    worker_ladder.each do |range, workers|
+      return workers if range.cover?(job_count)
+    end
+    worker_ladder.last.last
+  end
+
+  def max_worker_count
+    worker_ladder.map(&:last).max
+  end
+
+  def worker_ladder
+    Web47core::Config.worker_ladder.presence || DEFAULT_WORKER_LADDER
+  end
+
+  #
+  # ECS service desired count. nil when the service cannot be read, so a
+  # failed describe does not look like a fleet of zero.
+  #
+  def live_desired_count
+    service = describe_service
+    return nil unless service
+
+    count = service.desired_count
+    configuration.set(aws_current_worker_count: count)
+    count
+  end
+
+  def describe_service
+    client = ecs_client
+    return nil unless client
+
+    filter = {
+      cluster: configuration.aws_ecs_cluster_worker_name,
+      services: [configuration.aws_ecs_service_worker_name]
+    }
+    client.describe_services(filter).services.first
+  rescue StandardError => error
+    App47Logger.log_error 'Unable to read ECS worker service', error
+    nil
+  end
+
+  def record_desired(count)
+    configuration.set(aws_desired_worker_count: count)
+  end
+
+  def update_service(desired_count)
+    ecs_client.update_service(cluster: configuration.aws_ecs_cluster_worker_name,
+                              service: configuration.aws_ecs_service_worker_name,
+                              desired_count: desired_count)
+  rescue StandardError => error
+    App47Logger.log_error "Unable to set ECS service auto scaler to #{desired_count}", error
+  end
+
+  def delayed_jobs_count
+    Delayed::Backend::Mongoid::Job.where(failed_at: nil).read(mode: :primary).count
+  end
+
+  def configured?
+    configuration.aws_auto_scaling_configured?
+  rescue StandardError
+    false
+  end
+
+  def configuration
+    SystemConfiguration.configuration
+  end
+
+  def ecs_client
+    @ecs_client ||= configuration.aws_ecs_client
+  rescue StandardError => error
+    App47Logger.log_error 'Unable to build ECS client', error
+    nil
+  end
+end

data/lib/web47core/config.rb

@@ -6,18 +6,20 @@ module Web47core
   #
   class Config
     include Singleton
-    attr_accessor :email_able_models, :switchboard_able_models, :audit_model
+    attr_accessor :email_able_models, :switchboard_able_models, :audit_model, :worker_ladder
 
     def initialize
       @email_able_models = []
       @switchboard_able_models = []
       @audit_model = :user
+      @worker_ladder = nil
     end
 
     def self.reset
       instance.email_able_models = []
       instance.switchboard_able_models = []
       instance.audit_model = :user
+      instance.worker_ladder = nil
     end
 
     def self.audit_model_log_class

data/lib/web47core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Web47core
-  VERSION = '3.2.3.41'
+  VERSION = '3.2.3.43'
 end

data/lib/web47core.rb

@@ -61,6 +61,7 @@ require 'app/jobs/cron/record_delayed_job_metrics'
 require 'app/jobs/cron/restart_orphaned_delayed_jobs'
 require 'app/jobs/cron/trim_delayed_job_metrics'
 require 'app/jobs/cron/trim_delayed_job_workers'
+require 'app/services/auto_scaler'
 require 'app/jobs/cron/server'
 require 'app/jobs/cron/switchboard_sync_configuration'
 require 'app/jobs/cron/switchboard_sync_models'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: web47core
 version: !ruby/object:Gem::Version
-  version: 3.2.3.41
+  version: 3.2.3.43
 platform: ruby
 authors:
 - Chris Schroeder
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -94,6 +93,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -6606,6 +6625,7 @@ files:
 - lib/app/models/user_action_audit_log.rb
 - lib/app/models/user_audit_log.rb
 - lib/app/models/user_model_audit_log.rb
+- lib/app/services/auto_scaler.rb
 - lib/app/validators/email_format_validator.rb
 - lib/app/validators/http_url_validator.rb
 - lib/merge_coverage.rb
@@ -6624,7 +6644,6 @@ homepage: https://app47.com
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -6639,8 +6658,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: App47 Web Core Library.
 test_files: []