resque-heroku-signals 1.27.4.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5132b492fff85cf94f3eb40020be2db975ec429
-  data.tar.gz: ca1220cdbd9711c5330d34e41fa50ad54f69609f
+SHA256:
+  metadata.gz: 06d283931f3e67ef19cc510880cee4bffa7461d7430c65f7545a78123d0f990e
+  data.tar.gz: 7f096f1604e85e978c2aedbaf509149c623f5e3934a4cb5bb0a7f3deb055a3fc
 SHA512:
-  metadata.gz: a62bda832166979be5ec4ef9a7e62b6581b0f1992eae9b2444ec35f723738690dcf2d2c3f40fa49da45f396304fa1ed9271d946f3de82c73e0a2b2af3b69d1ba
-  data.tar.gz: da0e78106868f5794a423092a7979d2cf58a167ec0fa0b50b50be4a2d995c4ca6a5faf7f5c4603320fdfc21e5cf14d562bfbb88b55eea8e51f33a8fc8b13915f
+  metadata.gz: 2e4234285eb296c8e3b8e922f6d3facc458d8d5606fea240374d60ff5551ef752233e0b3e069f9d552ec35148e2d96582609c7355994af22865f9465fc1a8629
+  data.tar.gz: '0824cbbf9bda2c4676144cd700adc6b179cb28bbcf8ff9523ff512b7d3cda19440dbe6da1b8e6b01c8ddb3ae9e4fe90aa820eb1cf46d8486c82a96f981da8b5a'

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+    strategy:
+      matrix:
+        ruby-version: ['3.0', 2.7, 2.6, 2.5, 2.4]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/Gemfile

@@ -1,2 +1,5 @@
 source 'https://rubygems.org'
 gemspec
+
+gem 'pry'
+gem 'pry-byebug'

data/README.md

@@ -15,7 +15,15 @@ Add this line to your application's Gemfile:
 gem 'resque-heroku-signals'
 ```
 
-Since this gem monkeypatches the Heroku worker the `gemspec` is locked to a `x.x.x` version of Resque. Issue a PR if this is not compatible with the version of resque you are using. 
+Since this gem monkeypatches the Heroku worker the `gemspec` is locked to a `x.x.x` version of Resque to ensure the monkeypatched logic is compatible with any changes in the original Resque logic. Issue a PR if this is not compatible with the version of resque you are using.
+
+## Determining When a Process Will Shutdown
+
+Heroku sends a `TERM` signal to a process before hard killing it. If your job communicates with slow external APIs, you may want to make sure you have enough time to receive and handle the response from the external system before executing the API requests.
+
+Ideally, using an idempotency key with each external API request is the best way to ensure that a given API request only runs. However, depending on your application logic this may not be practical and knowing if a process will be terminated in less than 30s by Heroku is a useful tool.
+
+Use `Resque.heroku_will_terminate?` to determine if Heroku will terminate your process within 30s. 
 
 ## Example Procfile
 
@@ -28,7 +36,7 @@ worker: env QUEUE=* TERM_CHILD=1 INTERVAL=0.1 RESQUE_PRE_SHUTDOWN_TIMEOUT=20 RES
 * Total shutdown time should be less than 30s. This is the time [Heroku gives you to cleanup before a `SIGKILL` is issued](https://devcenter.heroku.com/articles/dynos#shutdown)
 * `INTERVAL` seconds to wait between jobs
 
-Also, make you don't buffer logs: import log messages could fail to push to stdout during the worker shutdown process:
+Also, make you don't buffer logs: important log messages could fail to push to stdout during the worker shutdown process:
 
 ```ruby
 $stdout.sync = true

data/lib/{resque/heroku-signals.rb → resque-heroku-signals.rb}

@@ -1,10 +1,21 @@
 require 'resque'
-require "resque/heroku/version"
 
+$HEROKU_WILL_TERMINATE_RESQUE = false
+
+Resque.class_eval do
+  def self.heroku_will_terminate?
+    !!$HEROKU_WILL_TERMINATE_RESQUE
+  end
+end
+
+# before bumping resque dependency, check to ensure implementation has not changed
+#   https://github.com/resque/resque/blame/v2.0.0/lib/resque/worker.rb#L406
 # https://github.com/resque/resque/issues/1559#issuecomment-310908574
 Resque::Worker.class_eval do
   def unregister_signal_handlers
     trap('TERM') do
+      $HEROKU_WILL_TERMINATE_RESQUE = true
+
       trap('TERM') do
         log_with_severity :info, "[resque-heroku] received second term signal, throwing term exception"
 
@@ -16,7 +27,6 @@ Resque::Worker.class_eval do
       end
 
       log_with_severity :info, "[resque-heroku] received first term signal from heroku, ignoring"
-
     end
 
     trap('INT', 'DEFAULT')

data/resque-heroku-signals.gemspec

@@ -1,16 +1,14 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'resque/heroku/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "resque-heroku-signals"
-  spec.version       = Resque::HerokuSignals::VERSION
+  spec.version       = '2.1.0'
   spec.authors       = ["Michael Bianco"]
-  spec.email         = ["mike@suitesync.io"]
+  spec.email         = ["mike@mikebian.co"]
 
   spec.summary       = "Patch resque to be compatible with the Heroku platform"
-  # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/iloveitaly/resque-heroku-signals"
   spec.license       = "MIT"
 
@@ -21,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "resque", "1.27.4"
+  # strict resque dependency is intentional
+  spec.add_dependency "resque", "2.1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-heroku-signals
 version: !ruby/object:Gem::Version
-  version: 1.27.4.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Michael Bianco
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -16,79 +16,80 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.27.4
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.27.4
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+        version: '3.10'
+description:
 email:
-- mike@suitesync.io
+- mike@mikebian.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- lib/resque/heroku-signals.rb
-- lib/resque/heroku/version.rb
+- lib/resque-heroku-signals.rb
 - resque-heroku-signals.gemspec
 homepage: https://github.com/iloveitaly/resque-heroku-signals
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,9 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Patch resque to be compatible with the Heroku platform
 test_files: []

data/lib/resque/heroku/version.rb

@@ -1,5 +0,0 @@
-module Resque
-  module HerokuSignals
-    VERSION = "1.27.4.1"
-  end
-end