makandra_sidekiq 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cdf2b37120431a87cfb6a7033e7cd8b011ceec8f
-  data.tar.gz: a5b3dd8b2a3c7255304bfd0354334026d6d97ac6
+SHA256:
+  metadata.gz: 4b7815d7db44b5727181001de66b8d0dafef348e0df56076cf28794175354de1
+  data.tar.gz: d69af72a41fa909214a98b5bafeee7268a8bd0925a852baba677028c79ca238b
 SHA512:
-  metadata.gz: b814fd76bcb8ad021a9c401dbeeb60fc3cef1260a70bcf7460f64dcd6596745128f8a25e655381179fb0b5b2a805b271aa5e6ee4894a25256d1591dc9ac10640
-  data.tar.gz: e2ba1646f82d892a275c708f29224d749cce5382b909691154469d3c078535ec496f377d57cf1e1795550c84fa9829858cc27ca4e279350be8931bb898dfc954
+  metadata.gz: 3fc415dc5f85d4ea97bfec1c5a0093afeb6f51988902e47de17026a56ab942ad5d077a9a8e1ac37de83676515f988e1c09a3e66f8e04e01542c8e72abdf0ec49
+  data.tar.gz: 8d6b37d81fecaed42de082c477f259232acef7e0378647f366c373e3040b3e426b703ebba71b47efc1742ea466b1c4bda38e4c807574f03d7a6748ad58df4352

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.6.6

data/.travis.yml

@@ -1,12 +1,10 @@
 sudo: false
 language: ruby
+dist: trusty
 rvm:
-  - 2.3.1
+  - 2.3.3
 script: bundle exec rspec spec
 cache: bundler
-notifications:
-  email:
-    - fail@makandra.de
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -1,16 +1,46 @@
-# makandra_sidekiq change log
-
+# Changelog
 All notable changes to this project will be documented in this file.
 
-## [0.1.2][] (2017-01-12)
+This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## Unreleased
+
+
+## 0.2.1 2020-05-18
+
+### Compatible changes
+- Fixed deprecation warnings on modern Bundlers. We are now using `Bundler.with_original_env`.
+
+
+## 0.2.0 2019-11-08
+
+### Compatible changes
+- Added CHANGELOG to satisfy [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+- Fix: now considering the configured Sidekiq timeout when running
+  `sidekiqctl stop` through `sidekiq:stop`. Previously, long-running jobs would
+  get lost!
+
+
+## 0.1.3 2017-02-13
+
+### Changed
+- Gem no longer depends on `capistrano`, since using its Capistrano recipes is optional.
+
+
+## 0.1.2 2017-01-12
+
+### Added
+- `sidekiq:start` checks that sidekiq really comes up and will retry a few times.
 
-`sidekiq:start` checks that sidekiq really comes up and will retry a few times.
 
-## [0.1.1][] (2016-09-29)
+## 0.1.1 2016-09-29
 
-Do not fail on first deploy.
+### Fixed
+- Do not fail on first deploy.
 
 
-## [0.1.0][] (2016-09-29)
+## 0.1.0 2016-09-29
 
-Initial release.
+### Added
+- Initial release.

data/Gemfile.lock

@@ -1,27 +1,19 @@
 PATH
   remote: .
   specs:
-    makandra_sidekiq (0.1.2)
-      capistrano (>= 3)
+    makandra_sidekiq (0.2.1)
+      sidekiq (< 6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    airbrussh (1.1.1)
-      sshkit (>= 1.6.1, != 1.7.0)
-    capistrano (3.6.1)
-      airbrussh (>= 1.0.0)
-      capistrano-harrow
-      i18n
-      rake (>= 10.0.0)
-      sshkit (>= 1.9.0)
-    capistrano-harrow (0.5.3)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    net-scp (1.2.1)
-      net-ssh (>= 2.6.5)
-    net-ssh (3.2.0)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    rack (2.0.9)
+    rack-protection (2.0.8.1)
+      rack
     rake (10.5.0)
+    redis (4.1.4)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -35,9 +27,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    sshkit (1.11.3)
-      net-scp (>= 1.1.2)
-      net-ssh (>= 2.8.0)
+    sidekiq (5.2.8)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack (< 2.1.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
 
 PLATFORMS
   ruby
@@ -49,4 +43,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.13.1
+   1.17.2

data/README.md

@@ -1,8 +1,8 @@
 # makandra_sidekiq [![Build Status](https://travis-ci.org/makandra/makandra_sidekiq.svg?branch=master)](https://travis-ci.org/makandra/makandra_sidekiq)
 
-Support code for our default sidekiq setup.
+Support code for our default Sidekiq setup.
 
-Includes rake tasks to start and stop sidekiq, capistrano recipes for deployment, and a way to restart sidekiq on reboot.
+Includes rake tasks to start and stop Sidekiq, Capistrano recipes for deployment, and a way to restart Sidekiq on reboot.
 
 
 ## Installation
@@ -27,9 +27,22 @@ Make sure you include at least `:pidfile` and `:logfile`. Sane values are
 :logfile: ./log/sidekiq.log
 ```
 
+
+### Passing additional options to sidekiq
+
+Sometimes you will have to pass additional options to the sidekiq binary. You can do this by adding
+
+```
+:sidekiq_command_line_args: '--some --options'
+```
+to your `config/sidekiq.yml`.
+
+
 ### Capistrano
 
-makandra_sidekiq requires [capistrano](https://github.com/capistrano/capistrano) >= 3.
+makandra_sidekiq comes with [Capistrano](https://github.com/capistrano/capistrano) recipes to call its rake tasks for (re)starting Sidekiq during deployment.
+
+Note that those recipes require Capistrano 3+.
 
 - Add the following line to your Capfile:
 
@@ -44,19 +57,19 @@ makandra_sidekiq requires [capistrano](https://github.com/capistrano/capistrano)
 
 ### Restart sidekiq on reboot
 
-Simply add `rake sidekiq:start` as a @reboot task to your crontab.
+Simply add `rake sidekiq:start` as a `@reboot` task to your crontab.
 
 When using [whenever](https://github.com/javan/whenever), add this to your schedule.rb:
 
 ```
 every :reboot do
-  rake 'sidekiq:start'
+  rake 'sidekiq:start', output: { standard: nil }
 end
 ```
 
 In case you don't use whenever, this crontab entry will work:
 ```
-@reboot /bin/bash -l -c 'cd /path/to/rails/root && RAILS_ENV=environment bundle exec rake sidekiq:start --silent'
+@reboot /bin/bash -l -c 'cd /path/to/rails/root && RAILS_ENV=environment bundle exec rake sidekiq:start --silent > /dev/null'
 ```
 
 

data/lib/makandra_sidekiq/sidekiq_control.rb

@@ -1,3 +1,5 @@
+require 'bundler'
+require 'sidekiq'
 require 'pathname'
 require 'yaml'
 require 'open3'
@@ -16,7 +18,7 @@ module MakandraSidekiq
     def quiet
       if running?
         puts 'Preventing Sidekiq from accepting new jobs...'
-        run_sidekiqctl('quiet')
+        sidekiqctl_quiet
       else
         puts 'Sidekiq is not running.'
       end
@@ -25,7 +27,7 @@ module MakandraSidekiq
     def stop
       if running?
         puts 'Stopping Sidekiq...'
-        run_sidekiqctl('stop')
+        sidekiqctl_stop
       else
         puts 'Sidekiq is not running.'
       end
@@ -55,6 +57,11 @@ module MakandraSidekiq
       @pid_file ||= @root.join(@config[:pidfile])
     end
 
+    # The shutdown timeout for Sidekiq
+    def timeout
+      @timeout ||= @config[:timeout] || Sidekiq::DEFAULTS[:timeout]
+    end
+
     def read_pid
       if pid_file.file?
         pid_file.read.to_i
@@ -63,9 +70,12 @@ module MakandraSidekiq
 
     def running?
       pid = read_pid
-      Process.kill(0, pid) if pid
+      Process.kill(0, pid) if pid # kill(0, pid) checks pid validity
     rescue Errno::ESRCH
-      # not running
+      false # Not running
+    rescue Errno::EPERM
+      # The process from Sidekiq's pidfile does not belong to us. This can occur
+      # when Sidekiq for some reason stopped but left behind its pidfile.
       false
     end
 
@@ -93,8 +103,16 @@ module MakandraSidekiq
       config
     end
 
-    def run_sidekiqctl(command)
-      bundle_exec('sidekiqctl', command, pid_file.to_s)
+    def sidekiqctl_quiet
+      bundle_exec 'sidekiqctl', 'quiet', pid_file
+    end
+
+    def sidekiqctl_stop
+      # The "hard kill after" timeout for sidekiqctl. Adding a few seconds to be
+      # sure that jobs running at shutdown are requeued by Sidekiq.
+      safe_timeout = timeout + 2 # seconds
+
+      bundle_exec 'sidekiqctl', 'stop', pid_file, safe_timeout
     end
 
     def patiently_start_sidekiq
@@ -131,22 +149,41 @@ module MakandraSidekiq
         '--index', sidekiq_index.to_s,
         '--environment', rails_env,
         '--config', config_path.to_s,
-        '--daemon'
+        '--daemon',
+        *additional_command_line_args,
       ]
       bundle_exec('sidekiq', *arguments)
     end
 
+    def additional_command_line_args
+      if (raw_args = @config[:sidekiq_command_line_args])
+        raw_args.split(' ')
+      else
+        []
+      end
+    end
+
     def sidekiq_index
       ENV['SIDEKIQ_INDEX'] || 0
     end
 
     def bundle_exec(*command)
-      stdout_str, stderr_str, status = Open3.capture3('bundle', 'exec', *command, chdir: @root.to_s)
+      string_command = command.map(&:to_s)
+      root = @root.to_s
+      stdout_str, stderr_str, status = with_original_env { capture3('bundle', 'exec', *string_command, chdir: root) }
       puts stdout_str
       unless status.success?
         fail "#{command} failed with message: #{stderr_str}"
       end
     end
 
+    def capture3(*command)
+      Open3.capture3(*command)
+    end
+
+    def with_original_env(&block)
+      Bundler.with_original_env(&block)
+    end
+
   end
 end

data/lib/makandra_sidekiq/version.rb

@@ -1,3 +1,3 @@
 module MakandraSidekiq
-  VERSION = "0.1.2"
+  VERSION = '0.2.2'
 end

data/makandra_sidekiq.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'capistrano', '>= 3'
+  spec.add_dependency "sidekiq", "< 6"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: makandra_sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: capistrano
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,10 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Support code for sidekiq, including rake tasks and capistrano recipes.
 test_files: []
-has_rdoc: