sidekiq-ecs-scaler 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e788a43a1d4013b88babd60929d35dc465dca7dbe73daa633566929be57f501
-  data.tar.gz: 9a6c856115de94d05edb69662d2de03ea0ae536d40d3b36a1f74f1f2f2c9239b
+  metadata.gz: 61e35b0bdbfd171583e88d98453ff54f2715f4e8b59be4564a40f8f38e015b38
+  data.tar.gz: 9f36a75e28df3bb96a25f874d1d071853c9896732445ff5890129775855ebc32
 SHA512:
-  metadata.gz: 137a41c9d0c6fbc53bb16652b7d9c711347618e2c3ce37130ce1087ec774c09956c0746e345d6bbd7bca5395aaa36b02c1f1a6a08e9a4c65a3eb51dd347a0280
-  data.tar.gz: bdab45f712315863eb32d08e3aba9edb35db1d9d50f2966206baf6948ea1ce97cc9a6672402ffd09cd66ab27d5a222a02fa3fb8d902d9d7e9287bfb4045824e1
+  metadata.gz: 766e8fe9659709dea552de8cb0251f26cb14a0741b07e85fed48b6efd5cee3cced89cf018f76e96ddbe2f266f5c283f232e4cbeeab7b2832a9e530495b582f64
+  data.tar.gz: bfe755f5c853c03ba32e8e36af3ac9bc241dddcd2e5e636734c08a2560c00dc6926a9b7a494766c491009088d24ec387821e3a22bb5e7dbe65f3a49a81ae92df

data/.rubocop.yml

@@ -1,3 +1,9 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-thread_safety
+
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
@@ -18,4 +24,8 @@ Metrics/BlockLength:
     - spec/**/*_spec.rb
 
 Naming/FileName:
+  Exclude:
+    - lib/sidekiq-ecs-scaler.rb
+
+RSpec/MultipleMemoizedHelpers:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [0.3.0] - 2024-01-03
+
+- Abolish non-thread safe configuration.
+- Changed the mechanism to implement workers on the user side.
+
+## [0.2.0] - 2021-12-01
+
+- Add configuration items
+  - `enabled` is possible to enable / disable the scale.
+  - `logger` is possible to changing the logger that outputs the required number of changes.
+- UPDATE README.md
+
 ## [0.1.0] - 2021-11-29
 
 - initial release

data/Dockerfile

@@ -1,14 +1,9 @@
-FROM ruby:3.0.3-slim
+FROM ruby:3.2.2
 
-RUN apt-get update \
-    && apt-get install -y build-essential git \
-    && apt-get clean \
-    && rm -rf /var/lib/apt/lists/*
+WORKDIR /usr/src/gem
 
-WORKDIR /usr/src/sidekiq-ecs-scaler
-
-RUN mkdir -p lib/sidekiq-ecs-scaler \
-    && echo "module SidekiqEcsScaler\n  VERSION = \"0.1.0\"\nend\n" > lib/sidekiq-ecs-scaler/version.rb
+RUN mkdir -p lib/sidekiq_ecs_scaler \
+    && echo "module SidekiqEcsScaler\n  VERSION = \"0.1.0\"\nend\n" > lib/sidekiq_ecs_scaler/version.rb
 
 COPY bin/setup ./bin/
 COPY Gemfile Gemfile.lock sidekiq-ecs-scaler.gemspec .

data/Gemfile

@@ -5,11 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in sidekiq-ecs-scaler.gemspec
 gemspec
 
-gem "rake"
-gem "rspec"
-gem "rubocop"
-gem "rubocop-rake"
-gem "rubocop-rspec"
-gem "simplecov"
-gem "steep"
-gem "yard"
+gem "rake", require: false
+gem "rspec", require: false
+gem "rubocop", require: false
+gem "rubocop-performance", require: false
+gem "rubocop-rake", require: false
+gem "rubocop-rspec", require: false
+gem "rubocop-thread_safety", require: false
+gem "simplecov", require: false
+gem "steep", require: false
+gem "yard", require: false

data/Gemfile.lock

@@ -1,115 +1,157 @@
 PATH
   remote: .
   specs:
-    sidekiq-ecs-scaler (0.1.0)
+    sidekiq-ecs-scaler (0.3.0)
       aws-sdk-ecs (> 1, < 2)
-      sidekiq (> 5, < 7)
+      sidekiq (> 5, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    abbrev (0.1.2)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
-    aws-eventstream (1.2.0)
-    aws-partitions (1.535.0)
-    aws-sdk-core (3.123.0)
-      aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.525.0)
-      aws-sigv4 (~> 1.1)
-      jmespath (~> 1.0)
-    aws-sdk-ecs (1.91.0)
-      aws-sdk-core (~> 3, >= 3.122.0)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.876.0)
+    aws-sdk-core (3.190.1)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.8)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-ecs (1.135.0)
+      aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.4.0)
+    aws-sigv4 (1.8.0)
       aws-eventstream (~> 1, >= 1.0.2)
-    concurrent-ruby (1.1.9)
-    connection_pool (2.2.5)
-    diff-lcs (1.4.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    csv (3.2.8)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    ffi (1.15.4)
-    i18n (1.8.11)
+    drb (2.2.0)
+      ruby2_keywords
+    ffi (1.16.3)
+    fileutils (1.7.2)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jmespath (1.4.0)
-    language_server-protocol (3.16.0.3)
-    listen (3.7.0)
+    jmespath (1.6.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.14.4)
-    parallel (1.21.0)
-    parser (3.0.3.0)
+    logger (1.6.0)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    rb-fsevent (0.11.0)
+      racc
+    racc (1.7.3)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (1.7.1)
-    redis (4.5.1)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rbs (3.4.1)
+      abbrev
+    redis-client (0.19.1)
+      connection_pool
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.23.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
-      parser (>= 3.0.1.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.20.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.6.0)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    sidekiq (6.3.1)
-      connection_pool (>= 2.2.2)
-      rack (~> 2.0)
-      redis (>= 4.2.0)
-    simplecov (0.21.2)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    rubocop-thread_safety (0.5.1)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    securerandom (0.3.1)
+    sidekiq (7.2.0)
+      concurrent-ruby (< 2)
+      connection_pool (>= 2.3.0)
+      rack (>= 2.2.4)
+      redis-client (>= 0.14.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    steep (0.46.0)
+    simplecov_json_formatter (0.1.4)
+    steep (1.6.0)
       activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
-      parallel (>= 1.0.0)
-      parser (>= 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 1.2.0)
+      rbs (>= 3.1.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
+    strscan (3.0.7)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    yard (0.9.26)
-    zeitwerk (2.5.1)
+    unicode-display_width (2.5.0)
+    yard (0.9.34)
 
 PLATFORMS
+  aarch64-linux
+  arm64-darwin-21
   x86_64-darwin-19
   x86_64-linux
 
@@ -117,12 +159,14 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-performance
   rubocop-rake
   rubocop-rspec
+  rubocop-thread_safety
   sidekiq-ecs-scaler!
   simplecov
   steep
   yard
 
 BUNDLED WITH
-   2.2.32
+   2.4.10

data/README.md

@@ -18,28 +18,33 @@ And then execute:
 
 ## Usage
 
-### Configuration
+### Create Worker Class
 
 ```ruby
-SidekiqEcsScaler.configure do |config|
-  # queue to monitor latency, default is "default"
-  config.queue_name = "default"
+# frozen_string_literal: true
 
-  # minimum number of tasks, default is 1
-  config.min_count = 1
+class SidekiqEcsScaleWorker
+  include Sidekiq::Worker
 
-  # maximum number of tasks, default is 1
-  config.max_count = 3
-
-  # maximum latency(seconds), default is 3600
-  config.max_latency = 3600
+  # @return [void]
+  def perform
+    SidekiqEcsScaler::Client.update_desired_count(
+      max_count: 3
+    )
+  end
+end
+```
 
-  # custom ECS Client
-  config.ecs_client = Aws::ECS::Client.new
+Options
 
-  # Set worker options for scaling
-  config.sidekiq_options = { "retry" => true, "queue" => "scheduler" }
-end
+```yaml
+logger: logger, default is Sidekiq.logger
+queue_name: queue to monitor latency, default is "default"
+min_count: minimum number of tasks, default is 1
+max_count: maximum number of tasks, default is 1
+step_count: steps number in the desired count range, default is 1
+max_latency: maximum latency(seconds), default is 3600
+ecs_client: custom ECS Client, default is Aws::ECS::Client.new
 ```
 
 ### With Sidekiq Scheduler
@@ -51,12 +56,20 @@ When using [sidekiq-scheduler](https://github.com/moove-it/sidekiq-scheduler), s
 # example
 
 :schedule:
-  SidekiqEcsScaler::Worker:
+  SidekiqEcsScaleWorker:
     cron: "0 */15 * * * *"
     # It is safe to set this queue to have a higher priority than the monitored queue.
     queue: scheduler
 ```
 
+### About AWS IAM Policy
+
+The task role of ECS task that runs Sidekiq workers requires the following permissions:
+
+- `ecs:DescribeTasks`
+- `ecs:DescribeServices`
+- `ecs:UpdateService`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -12,8 +12,11 @@ RuboCop::RakeTask.new(:lint) do |t|
   t.options = %w[--parallel]
 end
 namespace :lint do
-  desc "Lint fix (Rubocop)"
-  task fix: :auto_correct
+  desc "Lint with fix (Rubocop)"
+  task fix: :autocorrect
+
+  desc "Lint with unsafe fix (Rubocop)"
+  task fixall: :autocorrect_all
 end
 
 # steep
@@ -32,8 +35,12 @@ end
 require "yard"
 desc "document"
 task :doc do
-  YARD::CLI::CommandParser.run
-  `yard`.lines(chomp: true).last.match(/\d+/)[0].to_i == 100 || exit(1)
+  io = StringIO.new
+  YARD::Logger.instance(io)
+  YARD::CLI::CommandParser.run(*%w[stats --list-undoc])
+  result = io.tap(&:rewind).read
+  $stdout.puts(result)
+  result.lines(chomp: true).last.strip == "100.00% documented" || exit(1)
 end
 
 task default: %i[lint typecheck spec doc]

data/Steepfile

@@ -6,4 +6,6 @@ target :lib do
   check "lib"
 
   library "json"
+  library "logger"
+  library "monitor"
 end

data/docker-compose.yml

@@ -1,9 +1,9 @@
 version: "3"
 
 services:
-  sidekiq-ecs-scaler:
+  gem:
     build:
       context: .
     volumes:
-      - .:/usr/src/sidekiq-ecs-scaler
+      - .:/usr/src/gem
     command: /bin/bash

data/lib/sidekiq-ecs-scaler.rb

@@ -1,40 +1,3 @@
 # frozen_string_literal: true
 
-require "uri"
-require "net/http"
-require "json"
-require "sidekiq"
-require "sidekiq/api"
-require "aws-sdk-ecs"
-require_relative "sidekiq-ecs-scaler/version"
-require_relative "sidekiq-ecs-scaler/task_meta_v4"
-require_relative "sidekiq-ecs-scaler/configuration"
-require_relative "sidekiq-ecs-scaler/client"
-require_relative "sidekiq-ecs-scaler/worker"
-
-# SidekiqEcsScaler
-module SidekiqEcsScaler
-  # SidekiqEcsScaler::Error
-  class Error < StandardError; end
-
-  class << self
-    # @return [SidekiqEcsScaler::Configuration]
-    def config
-      @config ||= Configuration.new
-    end
-
-    # @yieldparam config [SidekiqEcsScaler::Configuration]
-    # @yieldreturn [void]
-    # @return [void]
-    def configure
-      raise Error, "No block is given!" unless block_given?
-
-      yield config
-    end
-
-    # @return [SidekiqEcsScaler::Client]
-    def client
-      Client.new(config)
-    end
-  end
-end
+require "sidekiq_ecs_scaler"

data/lib/sidekiq_ecs_scaler/client.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module SidekiqEcsScaler
+  # SidekiqEcsScaler::Client
+  class Client
+    class << self
+      # @param keywords [Hash]
+      # @return [Integer]
+      def update_desired_count(**keywords)
+        new(SidekiqEcsScaler::Configuration.new(**keywords)).update_desired_count
+      end
+    end
+
+    # @param config [SidekiqEcsScaler::Configuration]
+    # @return [void]
+    def initialize(config)
+      @config = config
+    end
+
+    # @return [Integer]
+    def update_desired_count
+      desired_count = desired_count_by_latency
+      service = describe_service
+
+      if service.desired_count == desired_count
+        not_change_log(desired_count)
+      else
+        update_service(service: service, desired_count: desired_count)
+        change_log(service.desired_count, desired_count)
+      end
+
+      desired_count
+    end
+
+    private
+
+    # @!attribute [r] config
+    # @return [SidekiqEcsScaler::Configuration]
+    attr_reader :config
+
+    # @return [Float]
+    def queue_latency
+      Sidekiq::Queue.new(config.queue_name).latency
+    end
+
+    # @return [Integer]
+    def desired_count_by_latency
+      desired_count_list.at((queue_latency.to_f / config.latency_per_step_count).floor.to_i) || config.max_count
+    end
+
+    # @return [Array<Integer>]
+    def desired_count_list
+      config.min_count.step(config.max_count, config.step_count).to_a
+    end
+
+    # @return [String]
+    def describe_service_name
+      task_meta = config.task_meta
+      task = config.ecs_client.describe_tasks({ cluster: task_meta.cluster, tasks: [task_meta.task_arn] }).tasks.first
+      raise Error, "Task(#{task_meta.task_arn}) does not exist in cluster!" if task.nil?
+
+      task.group.delete_prefix("service:")
+    end
+
+    # @return [Aws::ECS::Types::Service]
+    def describe_service
+      service_name = describe_service_name
+      config.ecs_client.describe_services(
+        { cluster: config.task_meta.cluster, services: [service_name] }
+      ).services.first || (raise Error, "Service(#{service_name}) does not exist in cluster!")
+    end
+
+    # @param service [Aws::ECS::Types::Service]
+    # @param desired_count [Integer]
+    # @return [Aws::ECS::Types::UpdateServiceResponse]
+    def update_service(service:, desired_count:)
+      config.ecs_client.update_service(
+        { cluster: service.cluster_arn, service: service.service_name, desired_count: desired_count }
+      )
+    end
+
+    # @param count [Integer]
+    # @return [void]
+    def not_change_log(count)
+      config.logger.info("SidekiqEcsScaler doesn't have updated the desired count of tasks from #{count}.")
+    end
+
+    # @param before_count [Integer]
+    # @param after_count [Integer]
+    # @return [void]
+    def change_log(before_count, after_count)
+      config.logger.info(
+        "SidekiqEcsScaler has updated the desired count of tasks from #{before_count} to #{after_count}."
+      )
+    end
+  end
+end

data/lib/sidekiq_ecs_scaler/configuration.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module SidekiqEcsScaler
+  # SidekiqEcsScaler::Configuration
+  class Configuration
+    # @!attribute [r] queue_name
+    # @return [String]
+    attr_reader :queue_name
+    # @!attribute [r] min_count
+    # @return [Integer]
+    attr_reader :min_count
+    # @!attribute [r] max_count
+    # @return [Integer]
+    attr_reader :max_count
+    # @!attribute [r] step_count
+    # @return [Integer]
+    attr_reader :step_count
+    # @!attribute [r] max_latency
+    # @return [Integer]
+    attr_reader :max_latency
+    # @!attribute [r] task_meta
+    # @return [SidekiqEcsScaler::TaskMetaV4]
+    attr_reader :task_meta
+    # @!attribute [r] ecs_client
+    # @return [Aws::Ecs::Client]
+    attr_reader :ecs_client
+    # @!attribute [r] logger
+    # @return [Logger]
+    attr_reader :logger
+
+    # @param queue_name [String]
+    # @param min_count [Integer]
+    # @param max_count [Integer]
+    # @param step_count [Integer]
+    # @param max_latency [Integer]
+    # @param task_meta [SidekiqEcsScaler::TaskMetaV4]
+    # @param ecs_client [Aws::ECS::Client]
+    # @param logger [Logger]
+    # @return [void]
+    def initialize( # rubocop:disable Metrics/ParameterLists
+      queue_name: "default",
+      min_count: 1,
+      max_count: 1,
+      step_count: 1,
+      max_latency: 3_600,
+      task_meta: TaskMetaV4.build_or_null,
+      ecs_client: Aws::ECS::Client.new,
+      logger: Sidekiq.logger
+    )
+      self.queue_name = queue_name
+      self.min_count = min_count
+      self.max_count = max_count
+      self.step_count = step_count
+      self.max_latency = max_latency
+      self.task_meta = task_meta
+      self.ecs_client = ecs_client
+      self.logger = logger
+    end
+
+    # @return [Integer]
+    def latency_per_step_count
+      (max_latency / ((1 + max_count - min_count).to_f / step_count).ceil).tap do |value|
+        value.positive? || (raise Error, "latency per count isn't positive!")
+      end
+    end
+
+    private
+
+    # @param logger [Logger]
+    # @return [void]
+    def logger=(logger)
+      raise ArgumentError unless logger.is_a?(Logger)
+
+      @logger = logger
+    end
+
+    # @param queue_name [String]
+    # @return [void]
+    def queue_name=(queue_name)
+      raise ArgumentError unless queue_name.instance_of?(String)
+
+      @queue_name = queue_name
+    end
+
+    # @param min_count [Integer]
+    # @return [void]
+    # @raise [ArgumentError]
+    def min_count=(min_count)
+      assert_positive_number!(min_count)
+
+      @min_count = min_count
+    end
+
+    # @param max_count [Integer]
+    # @return [void]
+    # @raise [ArgumentError]
+    def max_count=(max_count)
+      assert_positive_number!(max_count)
+
+      @max_count = max_count
+      @min_count = max_count if max_count < min_count
+    end
+
+    # @param step_count [Integer]
+    # @return [void]
+    # @raise [ArgumentError]
+    def step_count=(step_count)
+      assert_positive_number!(step_count)
+
+      @step_count = step_count
+    end
+
+    # @param max_latency [Integer]
+    # @return [void]
+    # @raise [ArgumentError]
+    def max_latency=(max_latency)
+      raise ArgumentError if max_count > max_latency
+
+      @max_latency = max_latency
+    end
+
+    # @param ecs_client [Aws::ECS::Client]
+    # @return [void]
+    # @raise [ArgumentError]
+    def ecs_client=(ecs_client)
+      raise ArgumentError unless ecs_client.is_a?(Aws::ECS::Client)
+
+      @ecs_client = ecs_client
+    end
+
+    # @param task_meta [SidekiqEcsScaler::TaskMetaV4]
+    # @return [void]
+    # @raise [ArgumentError]
+    def task_meta=(task_meta)
+      raise ArgumentError unless task_meta.is_a?(SidekiqEcsScaler::TaskMetaV4)
+
+      @task_meta = task_meta
+    end
+
+    # @param number [Integer]
+    # @return [void]
+    # @raise [ArgumentError]
+    def assert_positive_number!(number)
+      raise ArgumentError unless number.positive?
+    end
+  end
+end

data/lib/{sidekiq-ecs-scaler → sidekiq_ecs_scaler}/task_meta_v4.rb

@@ -11,7 +11,8 @@ module SidekiqEcsScaler
       # @return [SidekiqEcsScaler::TaskMetaV4, nil]
       def build_or_null
         ENV.fetch("ECS_CONTAINER_METADATA_URI_V4", nil)&.then do |uri|
-          new(JSON.parse(Net::HTTP.get(URI.parse("#{uri}/task"))))
+          resp = JSON.parse(Net::HTTP.get(URI.parse("#{uri}/task")))
+          new(cluster: resp.fetch("Cluster"), task_arn: resp.fetch("TaskARN"))
         end
       rescue StandardError
         nil
@@ -25,11 +26,12 @@ module SidekiqEcsScaler
     # @return [String]
     attr_reader :task_arn
 
-    # @param resp [Hash]
+    # @param cluster [String]
+    # @param task_arn [String]
     # @return [void]
-    def initialize(resp)
-      @cluster = resp.fetch("Cluster")
-      @task_arn = resp.fetch("TaskARN")
+    def initialize(cluster:, task_arn:)
+      @cluster = cluster
+      @task_arn = task_arn
     end
   end
 end

data/lib/{sidekiq-ecs-scaler → sidekiq_ecs_scaler}/version.rb

@@ -2,5 +2,5 @@
 
 module SidekiqEcsScaler
   # @return [String]
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/sidekiq_ecs_scaler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "logger"
+require "uri"
+require "net/http"
+require "json"
+require "sidekiq"
+require "sidekiq/api"
+require "aws-sdk-ecs"
+require_relative "sidekiq_ecs_scaler/version"
+require_relative "sidekiq_ecs_scaler/task_meta_v4"
+require_relative "sidekiq_ecs_scaler/configuration"
+require_relative "sidekiq_ecs_scaler/client"
+
+# SidekiqEcsScaler
+module SidekiqEcsScaler
+  # SidekiqEcsScaler::Error
+  class Error < StandardError; end
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,76 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: aws-sdk-core
+  version: '3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 13ae8cd19056d62358a9d4836106b8b31219fc1e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: cgi
+  version: '0'
+  source:
+    type: stdlib
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 13ae8cd19056d62358a9d4836106b8b31219fc1e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 13ae8cd19056d62358a9d4836106b8b31219fc1e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: rack
+  version: '2.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 13ae8cd19056d62358a9d4836106b8b31219fc1e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: redis
+  version: '4.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 13ae8cd19056d62358a9d4836106b8b31219fc1e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: sidekiq
+  version: '6.3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 13ae8cd19056d62358a9d4836106b8b31219fc1e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,17 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: redis

data/sidekiq-ecs-scaler.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/sidekiq-ecs-scaler/version"
+require_relative "lib/sidekiq_ecs_scaler/version"
 
 Gem::Specification.new do |spec|
   spec.name = "sidekiq-ecs-scaler"
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "aws-sdk-ecs", "> 1", "< 2"
-  spec.add_dependency "sidekiq", "> 5", "< 7"
+  spec.add_dependency "sidekiq", "> 5", "< 8"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/sig/sidekiq-ecs-scaler.rbs

@@ -4,16 +4,12 @@ module SidekiqEcsScaler
   class Error < StandardError
   end
 
-  def self.config: () -> ::SidekiqEcsScaler::Configuration
-
-  def self.configure: () { (::SidekiqEcsScaler::Configuration) -> void } -> void
-
-  def self.client: () -> ::SidekiqEcsScaler::Client
-
   class Client
+    def self.update_desired_count: (**untyped) -> ::Integer
+
     def initialize: (::SidekiqEcsScaler::Configuration) -> void
 
-    def update_desired_count: () -> ::Integer?
+    def update_desired_count: () -> ::Integer
 
     private
 
@@ -23,43 +19,68 @@ module SidekiqEcsScaler
 
     def desired_count_by_latency: () -> ::Integer
 
-    def service_name: () -> ::String
+    def desired_count_list: () -> ::Array[::Integer]
+
+    def describe_service_name: () -> ::String
 
     def describe_service: () -> ::Aws::ECS::Types::Service
 
     def update_service: (service: ::Aws::ECS::Types::Service, desired_count: ::Integer) -> ::Aws::ECS::Types::UpdateServiceResponse
+
+    def not_change_log: (::Integer) -> void
+
+    def change_log: (::Integer, ::Integer) -> void
   end
 
   class Configuration
-    attr_accessor queue_name: ::String
+    attr_reader queue_name: ::String
 
     attr_reader min_count: ::Integer
 
     attr_reader max_count: ::Integer
 
+    attr_reader step_count: ::Integer
+
     attr_reader max_latency: ::Integer
 
-    attr_reader task_meta: ::SidekiqEcsScaler::TaskMetaV4?
+    attr_reader task_meta: ::SidekiqEcsScaler::TaskMetaV4
+
+    attr_reader logger: ::Logger
 
     attr_reader ecs_client: ::Aws::ECS::Client
 
-    def initialize: () -> void
+    def initialize: (
+      ?queue_name: ::String,
+      ?min_count: ::Integer,
+      ?max_count: ::Integer,
+      ?step_count: ::Integer,
+      ?max_latency: ::Integer,
+      ?task_meta: ::SidekiqEcsScaler::TaskMetaV4,
+      ?ecs_client: ::Aws::ECS::Client,
+      ?logger: ::Logger
+    ) -> void
 
-    def min_count=: (::Integer) -> void
+    def latency_per_step_count: () -> ::Integer
 
-    def max_count=: (::Integer) -> void
+    private
 
-    def max_latency=: (::Integer) -> void
+    def assert_positive_number!: (::Integer) -> void
 
-    def ecs_client=: (::Aws::ECS::Client) -> void
+    def logger=: (::Logger) -> void
+
+    def queue_name=: (::String) -> void
+
+    def min_count=: (::Integer) -> void
+
+    def max_count=: (::Integer) -> void
 
-    def latency_per_count: () -> ::Integer
+    def step_count=: (::Integer) -> void
 
-    def task_meta!: () -> ::SidekiqEcsScaler::TaskMetaV4
+    def max_latency=: (::Integer) -> void
 
-    def sidekiq_options: () -> ::Hash[untyped, untyped]
+    def task_meta=: (::SidekiqEcsScaler::TaskMetaV4) -> void
 
-    def sidekiq_options=: (::Hash[untyped, untyped]) -> void
+    def ecs_client=: (::Aws::ECS::Client) -> void
   end
 
   class TaskMetaV4
@@ -69,14 +90,6 @@ module SidekiqEcsScaler
 
     attr_reader task_arn: ::String
 
-    def initialize: (::Hash[untyped, untyped]) -> void
-  end
-
-  class Worker
-    include ::Sidekiq::Worker
-
-    def self.sidekiq_options: (?::Hash[untyped, untyped]) -> ::Hash[untyped, untyped]
-
-    def perform: () -> ::Integer?
+    def initialize: (cluster: ::String, task_arn: ::String) -> void
   end
 end

data/sig-private/uri.rbs

@@ -1,5 +1,6 @@
 module ::URI
   def self.parse: (String) -> ::URI::HTTP
+                  | ...
 
   class ::URI::HTTP
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-ecs-scaler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - shoma07
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ecs
@@ -39,7 +39,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 description: auto scaler of sidekiq worker deploymented to aws ecs
 email:
 - 23730734+shoma07@users.noreply.github.com
@@ -74,15 +74,16 @@ files:
 - docker-compose.yml
 - exe/sidekiq-ecs-scaler
 - lib/sidekiq-ecs-scaler.rb
-- lib/sidekiq-ecs-scaler/client.rb
-- lib/sidekiq-ecs-scaler/configuration.rb
-- lib/sidekiq-ecs-scaler/task_meta_v4.rb
-- lib/sidekiq-ecs-scaler/version.rb
-- lib/sidekiq-ecs-scaler/worker.rb
+- lib/sidekiq_ecs_scaler.rb
+- lib/sidekiq_ecs_scaler/client.rb
+- lib/sidekiq_ecs_scaler/configuration.rb
+- lib/sidekiq_ecs_scaler/task_meta_v4.rb
+- lib/sidekiq_ecs_scaler/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - sidekiq-ecs-scaler.gemspec
 - sig-private/aws-sdk-ecs.rbs
 - sig-private/net/http.rbs
-- sig-private/sidekiq.rbs
 - sig-private/uri.rbs
 - sig/sidekiq-ecs-scaler.rbs
 homepage: https://github.com/shoma07/sidekiq-ecs-scaler
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: auto scaler of sidekiq worker deploymented to aws ecs

data/lib/sidekiq-ecs-scaler/client.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module SidekiqEcsScaler
-  # SidekiqEcsScaler::Client
-  class Client
-    # @param config [SidekiqEcsScaler::Configuration]
-    # @return [void]
-    def initialize(config)
-      @config = config
-    end
-
-    # @return [Integer, nil]
-    def update_desired_count
-      return unless config.task_meta
-
-      desired_count_by_latency.then do |desired_count|
-        describe_service.then do |service|
-          update_service(service: service, desired_count: desired_count) if service.desired_count != desired_count
-
-          desired_count
-        end
-      end
-    end
-
-    private
-
-    # @!attribute [r] config
-    # @return [SidekiqEcsScaler::Configuration]
-    attr_reader :config
-
-    # @return [Float]
-    def queue_latency
-      Sidekiq::Queue.new(config.queue_name).latency
-    end
-
-    # @return [Integer]
-    def desired_count_by_latency
-      (config.min_count..config.max_count).to_a.at(
-        (queue_latency.to_f / config.latency_per_count).floor.to_i
-      ) || config.max_count
-    end
-
-    # @return [String]
-    def service_name
-      config.task_meta!.then do |task_meta|
-        config.ecs_client.describe_tasks(
-          { cluster: task_meta.cluster, tasks: [task_meta.task_arn] }
-        ).tasks.first&.then { |task| task.group.delete_prefix("service:") } || (
-          raise Error, "Task(#{task_meta.task_arn}) does not exist in cluster!"
-        )
-      end
-    end
-
-    # @return [Aws::ECS::Types::Service]
-    def describe_service
-      config.ecs_client.describe_services(
-        { cluster: config.task_meta!.cluster, services: [service_name] }
-      ).services.first || (raise Error, "Service(#{service_name}) does not exist in cluster!")
-    end
-
-    # @param service [Aws::ECS::Types::Service]
-    # @param desired_count [Integer]
-    # @return [Aws::ECS::Types::UpdateServiceResponse]
-    def update_service(service:, desired_count:)
-      config.ecs_client.update_service(
-        {
-          cluster: service.cluster_arn,
-          service: service.service_name,
-          desired_count: desired_count
-        }
-      )
-    end
-  end
-end

data/lib/sidekiq-ecs-scaler/configuration.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-module SidekiqEcsScaler
-  # SidekiqEcsScaler::Configuration
-  class Configuration
-    # @!attribute [r] queue_name
-    # @return [String]
-    attr_reader :queue_name
-    # @!attribute [r] min_count
-    # @return [Integer]
-    attr_reader :min_count
-    # @!attribute [r] max_count
-    # @return [Integer]
-    attr_reader :max_count
-    # @!attribute [r] max_latency
-    # @return [Integer]
-    attr_reader :max_latency
-    # @!attribute [r] task_meta
-    # @return [SidekiqEcsScaler::TaskMetaV4, nil]
-    attr_reader :task_meta
-    # @!attribute [r] ecs_client
-    # @return [Aws::ECS::Client]
-    attr_reader :ecs_client
-
-    # @return [void]
-    def initialize
-      @queue_name = "default"
-      @min_count = 1
-      @max_count = 1
-      @max_latency = 3600
-      @ecs_client = Aws::ECS::Client.new
-      @task_meta = TaskMetaV4.build_or_null
-    end
-
-    # @param queue_name [String]
-    # @return [void]
-    def queue_name=(queue_name)
-      raise ArgumentError unless queue_name.instance_of?(String)
-
-      @queue_name = queue_name
-    end
-
-    # @param min_count [Integer]
-    # @return [void]
-    # @raise [ArgumentError]
-    def min_count=(min_count)
-      raise ArgumentError unless min_count.positive?
-
-      @min_count = min_count
-      @max_count = min_count if min_count > max_count
-    end
-
-    # @param max_count [Integer]
-    # @return [void]
-    # @raise [ArgumentError]
-    def max_count=(max_count)
-      raise ArgumentError unless max_count.positive?
-
-      @max_count = max_count
-      @min_count = max_count if max_count < min_count
-    end
-
-    # @param max_latency [Integer]
-    # @return [void]
-    # @raise [ArgumentError]
-    def max_latency=(max_latency)
-      raise ArgumentError if max_count > max_latency
-
-      @max_latency = max_latency
-    end
-
-    # @param ecs_client [Aws::ECS::Client]
-    # @return [void]
-    # @raise [ArgumentError]
-    def ecs_client=(ecs_client)
-      raise ArgumentError unless ecs_client.is_a?(Aws::ECS::Client)
-
-      @ecs_client = ecs_client
-    end
-
-    # @return [Integer]
-    def latency_per_count
-      (max_latency / (1 + max_count - min_count)).tap do |value|
-        value.positive? || (raise Error, "latency per count isn't positive!")
-      end
-    end
-
-    # @return [SidekiqEcsScaler::TaskMetaV4]
-    def task_meta!
-      task_meta || (raise Error, "task metadata is null!")
-    end
-
-    # @return [Hash]
-    def sidekiq_options
-      ::SidekiqEcsScaler::Worker.sidekiq_options
-    end
-
-    # @param sidekiq_options [Hash]
-    # @return [void]
-    def sidekiq_options=(sidekiq_options)
-      raise ArgumentError unless sidekiq_options.is_a?(Hash)
-
-      ::SidekiqEcsScaler::Worker.sidekiq_options(sidekiq_options)
-    end
-  end
-end

data/lib/sidekiq-ecs-scaler/worker.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module SidekiqEcsScaler
-  # SidekiqEcsScaler::Worker
-  class Worker
-    include Sidekiq::Worker
-
-    # @return [Integer, nil]
-    def perform
-      SidekiqEcsScaler.client.update_desired_count
-    end
-  end
-end

data/sig-private/sidekiq.rbs

@@ -1,11 +0,0 @@
-module Sidekiq
-  module Worker
-    def self.sidekiq_options: (?::Hash[untyped, untyped]) -> ::Hash[untyped, untyped]
-  end
-
-  class Queue
-    def initialize: (::String) -> void
-
-    def latency: () -> ::Float
-  end
-end