dlss-capistrano 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b7211b899ad56e248f23fc755708985d824d75c5f5be60f9df209e7aa530889
-  data.tar.gz: de4c047a15d8388a9b03a291db95923384f6a3e63468302af117b3a96013ffd8
+  metadata.gz: e70dce4334fb19dd733691feeb6767a15ad60ec0b23cdd798db3b95eac0cbb3c
+  data.tar.gz: 2ec578117cf92d26845b752285b7f4f469978873584d8f2abfbc18dd66c49aaf
 SHA512:
-  metadata.gz: 75f59b62a79644b31a359530daabae1cf65b8d5d87542c7612081f8866f01df16c3ec67751dac1e8bcd8484f871c921a8a0c4f8845d355dbb934896e61701e23
-  data.tar.gz: '05957df37d899b68b350a776bf2fc70baf1a70492d35145577857e67fd0c02769b938b8a91773dc2d0846f8e30c6d01526e6b3372c1b4d52939b6238922700dc'
+  metadata.gz: 5aaf6ce12fd37b5586d8302116e2db5d94fb83076c8860ca203573ae93b414fc304892e45a4e5b2368bf68be260dc5c01b61d02319b63c7127c313cdb07821e6
+  data.tar.gz: c5f48c6365a083f290814c3063d3c65cd7ae49a48d3b303c4615758cd7df69dd7a6acc858ba6e47922f7a3caf8d81d046e2a6be7ecd09dfcff97b2eb97fa44a2

data/README.md

@@ -43,6 +43,21 @@ Set this in `config/deploy.rb` to automate the symlink creation, and then use `X
 
 `cap ENV deployed_branch` displays the currently deployed revision (commit ID) and any branches containing the revision for each server in `ENV`.
 
+### Resque-Pool hot swap (OPTIONAL)
+
+The `dlss-capistrano` gem provides a set of tasks for managing `resque-pool` workers when deployed in `hot_swap` mode. (If you are using `resque-pool` without `hot_swap`, we recommend continuing to use the `capistrano-resque-pool` gem instead of what `dlss-capistrano` provides.) The tasks are:
+
+```shell
+$ cap ENV resque:pool:hot_swap # this gracefully replaces the current pool with a new pool
+$ cap ENV resque:pool:stop     # this gracefully stops the current pool
+```
+
+By default, these tasks are not provided; instead, they must be explicitly enabled via adding a new `require` statement to the application's `Capfile`:
+
+```ruby
+require 'dlss/capistrano/resque_pool'
+```
+
 ### Sidekiq via systemd
 
 `cap ENV sidekiq_systemd:{quiet,stop,start,restart}`: quiets, stops, starts, restarts Sidekiq via systemd.

data/dlss-capistrano.gemspec

@@ -4,7 +4,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "dlss-capistrano"
-  s.version     = "3.9.0"
+  s.version     = "3.10.0"
 
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Beer", 'Mike Giarlo']

data/lib/dlss/capistrano/resque_pool.rb

@@ -0,0 +1 @@
+import "#{__dir__}/resque_pool/tasks/resque_pool.rake"

data/lib/dlss/capistrano/resque_pool/tasks/resque_pool.rake

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# These tasks are a drop-in replacement for capistrano-resque-pool when using
+# hot-swappable pools. We replace these tasks because the upstream ones assume a
+# pidfile is present, which is not the case with hot-swappable pools.
+
+namespace :load do
+  task :defaults do
+    # Same capistrano variable used by capistrano-resque-pool for compatibility
+    set :resque_server_roles, fetch(:resque_server_roles, [:app])
+  end
+end
+
+# Integrate hook into Capistrano
+namespace :deploy do
+  before :starting, :add_resque_pool_hotswap_hook do
+    invoke 'resque:pool:add_hook'
+  end
+end
+
+namespace :resque do
+  namespace :pool do
+    # Lifted from capistrano-resque-pool
+    def rails_env
+      fetch(:resque_rails_env) ||
+        fetch(:rails_env) ||       # capistrano-rails doesn't automatically set this (yet),
+        fetch(:stage)              # so we need to fall back to the stage.
+    end
+
+    # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+    task :add_hook do
+      after 'deploy:restart', 'resque:pool:hot_swap'
+    end
+
+    desc 'Swap in a new pool, then shut down the old pool'
+    task :hot_swap do
+      on roles(fetch(:resque_server_roles)) do
+        within current_path do
+          execute :bundle, :exec, 'resque-pool', "--daemon --hot-swap --environment #{rails_env}"
+        end
+      end
+    end
+
+    desc 'Gracefully shut down current pool'
+    task :stop do
+      on roles(fetch(:resque_server_roles)) do
+        # This will usually return a single pid, but if you do multiple quick
+        # deployments, you may pick up multiple pids here, in which case we only
+        # kill the oldest one
+        pid = capture(:pgrep, '-f resque-pool-master').split.first
+
+        if test "kill -0 #{pid} > /dev/null 2>&1"
+          execute :kill, "-s QUIT #{pid}"
+        else
+          warn "Process #{pid} is not running"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -85,6 +85,8 @@ files:
 - dlss-capistrano.gemspec
 - lib/dlss.rb
 - lib/dlss/capistrano.rb
+- lib/dlss/capistrano/resque_pool.rb
+- lib/dlss/capistrano/resque_pool/tasks/resque_pool.rake
 - lib/dlss/capistrano/tasks/bundle_config.rake
 - lib/dlss/capistrano/tasks/bundled_sidekiq.rake
 - lib/dlss/capistrano/tasks/deployed_branch.rake
@@ -111,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects