sidekiq-redeploy 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 622ce6da0eb4f0f2507ff8b5ba81cb24909118469e552d856139e25b0b5bb328
-  data.tar.gz: c968b066fa65f1c4ab70345af149774cd8a2483abc0970103a3c50eb99893b47
+  metadata.gz: de3104469105eed517e7e6994858454b80e102d10a7dc793b1517552ff7d6a53
+  data.tar.gz: c5264950908153ce688ba6700270163a1ac21a7e91fc88d1e8443a5098704b88
 SHA512:
-  metadata.gz: dd933b670a81709895c6e2fe057421f8aa354297b54b303d7364aaaf618f1f7673074769d561794b6f9e24bde1a765e081940e14c9cc8f88488c57b5ce04169d
-  data.tar.gz: 80aa2eac63fe6baca128a5eb0eab93c3833e2df0f529ec6b9078eedd8e23277484d4bd51dcb5fa25e79e73077cd5066e714b3249908a8da2fdef1cfea3e45f79
+  metadata.gz: a6f6ade2223e07932aef74b35ea262cd19635dabb34cf8ab4ad27dc3cf8e49b59184d7196bd087636d4ecb758496a2aaccbcdf85f11700185c1be09e5f6a8fe1
+  data.tar.gz: 05b1f9e28ae95f7e532367a7bf79a314487bc40fd1b70576ae552ce7e5240235cb7fa541a7bc940d8b412e849eeeab7085d261b365b74144dc10617f08a995a6

data/.rubocop.yml

@@ -19,7 +19,10 @@ Metrics/MethodLength:
   Max: 30
 
 Metrics/ClassLength:
-  Max: 120
+  Max: 140
+
+Metrics/AbcSize:
+  Max: 30
 
 RSpec/NestedGroups:
   Max: 4

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v0.1.10
+
+**Fixes and enhancements:**
+
+- Add support to run commands prior to redeploy using a yaml watch file. This is useful for running a migration or bundle gems.
+
+## v0.1.9
+
+**Fixes and enhancements:**
+
+- Allow users to specify number of sidekiq worker processes with -n flag
+
 ## v0.1.8
 
 **Fixes and enhancements:**

data/README.md

@@ -40,11 +40,34 @@ Usage: sidekiq-loader [options]
     -y, --watch-delay INTEGER        [Optional] Specify the number of seconds between checking watch file. Defaults to 30.
     -d, --[no-]deploy  [FLAG]        [Optional] Deploy archive on app startup. Defaults to true.
     -s, --sidekiq-app [PATH|DIR]     [Optional] Location of application to pass to sidekiq.
+    -n, --num-procs INTEGER          [Optional] Specify the number of sidekiq processes to create. Defaults to 1.
 ```
 
-For example this will start the launcher using a S3 watch file.
+The watch file can contain an optional list of commands to run and the required archive_location. The archive_location can be a file path or S3 URL
+For example when using a file:
+```yaml
+---
+commands:
+  - bundle 
+archive_location: /app/pkg/test_app_0.0.3.zip
+```
+
+For example when using S3:
+```yaml
+---
+commands:
+  - bundle 
+archive_location: s3://puma-test-app-archives/test_app_0.0.3.zip
+```
+
+For example this will start the launcher using a S3 yaml watch file.
+```shell
+bundle exec sidekiq-loader -a /app -w s3://puma-test-app-archives/watch.yml
+```
+
+For example this will start the launcher using a local yaml watch file.
 ```shell
-bundle exec sidekiq-loader -a /app -w s3://puma-test-app-archives/watch.me
+bundle exec sidekiq-loader -a ./ -s ./lib/sidekiq_server.rb -w build/pkg/watch.yml
 ```
 
 In the example above the `watch.me` contents would look like the following. In this case the `test_app_0.0.3.zip` must exist in the `puma-test-app-archives` S3 bucket.

data/bin/sidekiq-loader

@@ -9,11 +9,16 @@ require 'optparse'
 def run_sidekiq(ops, logger)
   deployer = Puma::Redeploy::DeployerFactory.create(target: ops[:app_dir], watch_file: ops[:watch], logger:)
 
+  watch_file_data = deployer.watch_file_data
+
+  archive_file = deployer.archive_file(watch_file_data[:archive_location])
+
   # Load app archive on launch
-  deployer.deploy(source: deployer.archive_file) if ops[:deploy]
+  deployer.deploy(source: archive_file) if ops[:deploy]
   config = { watch_delay: ops[:watch_delay] }
 
-  Sidekiq::Redeploy::Loader.new(deployer:, logger:, sidekiq_app: ops[:sidekiq_app], config:).run
+  Sidekiq::Redeploy::Loader.new(deployer:, logger:, sidekiq_app: ops[:sidekiq_app], config:,
+                                num_processes: ops[:num_processes]).run
 end
 
 def option_parser(opts)
@@ -39,6 +44,11 @@ def option_parser(opts)
     o.on '-s', '--sidekiq-app [PATH|DIR]', '[Optional] Location of application to pass to sidekiq.' do |arg|
       opts[:sidekiq_app] = arg
     end
+
+    o.on '-n', '--num-procs INTEGER', Integer,
+         '[Optional] Specify the number of sidekiq processes to create. Defaults to 1.' do |arg|
+      opts[:num_processes] = arg
+    end
   end
 end
 

data/lib/sidekiq/redeploy/loader.rb

@@ -15,9 +15,8 @@ module Sidekiq
 
       SIGNALS = [INT, TERM, USR2, TTIN].freeze
 
-      def initialize(deployer:, sidekiq_app: nil, logger: Logger.new($stdout), config: {})
+      def initialize(deployer:, sidekiq_app: nil, logger: Logger.new($stdout), config: {}, num_processes: 1)
         require 'sidekiq/cli'
-
         @reload_sidekiq = false
         @exit_loader = false
         @loader_pid = ::Process.pid
@@ -28,6 +27,8 @@ module Sidekiq
         @loop_delay = config[:loop_delay] || 0.5
         @deployer = deployer
         @sidekiq_app = sidekiq_app
+        @num_processes = num_processes || 1
+        @sidekiq_pids = []
       end
 
       def run
@@ -46,7 +47,7 @@ module Sidekiq
       rescue StandardError => e
         log "Error in sidekiq loader: #{e.message}"
         log e.backtrace.join("\n")
-        stop_sidekiq(@sidekiq_pid)
+        stop_sidekiq(@sidekiq_pids)
         ::Process.waitall
         exit 1
       end
@@ -59,15 +60,25 @@ module Sidekiq
         loop do
           sleep(loop_delay)
           if needs_redeploy?
-            reload_app { deployer.deploy(source: deployer.archive_file) }
+            reload_app do
+              watch_file_data = deployer.watch_file_data
+
+              archive_file = deployer.archive_file(watch_file_data[:archive_location])
+
+              logger.info "Sidekiq restart begin file=#{deployer.watch_file} archive=#{archive_file}"
+
+              Puma::Redeploy::CommandRunner.new(commands: watch_file_data[:commands], logger:).run
+
+              deployer.deploy(source: archive_file)
+            end
           elsif reload_sidekiq
             reload_app
-          elsif process_died?(@sidekiq_pid)
-            fork_sidekiq
           end
+          @sidekiq_pids = running_pids(@sidekiq_pids)
+          fork_sidekiq(@num_processes - @sidekiq_pids.length) if @sidekiq_pids.length < @num_processes
           next unless exit_loader
 
-          stop_sidekiq(@sidekiq_pid)
+          stop_sidekiq(@sidekiq_pids)
           break
         end
       end
@@ -80,30 +91,32 @@ module Sidekiq
       end
 
       def reload_app
-        quiet_sidekiq(@sidekiq_pid)
+        quiet_sidekiq(@sidekiq_pids)
 
         yield if block_given?
 
-        stop_sidekiq(@sidekiq_pid)
+        stop_sidekiq(@sidekiq_pids)
 
         # wait for sidekiq to stop
         ::Process.waitall
-
         fork_sidekiq
         @reload_sidekiq = false
       end
 
-      def fork_sidekiq
-        @sidekiq_pid = ::Process.fork do
-          cli = Sidekiq::CLI.instance
-          args = @sidekiq_app ? ['-r', @sidekiq_app] : []
-          cli.parse(args)
-          cli.run
-        rescue StandardError => e
-          message = "Error loading sidekiq process: #{e.message}"
-          log message
-          log e.backtrace.join("\n")
-          raise message
+      def fork_sidekiq(num_children = @num_processes)
+        num_children.times do
+          pid = ::Process.fork do
+            cli = Sidekiq::CLI.instance
+            args = @sidekiq_app ? ['-r', @sidekiq_app] : []
+            cli.parse(args)
+            cli.run
+          rescue StandardError => e
+            message = "Error loading sidekiq process: #{e.message}"
+            log message
+            log e.backtrace.join("\n")
+            raise message
+          end
+          @sidekiq_pids << pid
         end
       end
 
@@ -126,32 +139,41 @@ module Sidekiq
         when USR2
           @reload_sidekiq = true
         when TTIN
-          ::Process.kill(signal, @sidekiq_pid)
+          @sidekiq_pids.each do |pid|
+            ::Process.kill(signal, pid)
+          end
         when TERM, INT
           @exit_loader = true
         end
       end
 
       def debug_handler(signal)
-        log_data = { signal:, current_pid: ::Process.pid, loader_pid: @loader_pid, sidekiq_pid: @sidekiq_pid,
+        log_data = { signal:, current_pid: ::Process.pid, loader_pid: @loader_pid, sidekiq_pids: @sidekiq_pids,
                      reload_sidekiq: @reload_sidekiq, exit_loader: @exit_loader }
         puts "handle_signal called with #{log_data}"
       end
 
-      def stop_sidekiq(pid)
-        ::Process.kill(TERM, pid) if pid
+      def stop_sidekiq(pids)
+        pids.each do |pid|
+          ::Process.kill(TERM, pid)
+        end
+        @sidekiq_pids = []
       end
 
-      def quiet_sidekiq(pid)
-        ::Process.kill(TSTP, pid) if pid
+      def quiet_sidekiq(pids)
+        pids.each do |pid|
+          ::Process.kill(TSTP, pid)
+        end
       end
 
-      def process_died?(pid)
-        return false if @exit_loader
-
-        !::Process.getpgid(pid)
-      rescue StandardError
-        true
+      def running_pids(pids)
+        new_pids = []
+        pids.each do |pid|
+          new_pids << pid unless ::Process.waitpid(pid, ::Process::WNOHANG)
+        rescue Errno::ECHILD
+          log "PID #{pid} does not exist."
+        end
+        new_pids
       end
 
       def log(message)

data/lib/sidekiq/redeploy/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Redeploy
-    VERSION = '0.1.8'
+    VERSION = '0.1.10'
   end
 end

data/sidekiq-redeploy.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'puma-redeploy', '~> 0.3.3'
+  spec.add_dependency 'puma-redeploy', '~> 0.3.4'
   spec.add_dependency 'sidekiq', '>= 6', '< 8'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-redeploy
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - tbeauvais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma-redeploy
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement