resque 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42bdd72240bcf206aa094dc525eca1747b51f4456ed28ae562ceccb10c4f313f
-  data.tar.gz: 44297a31bb61f835b6acbba5195f77826b1d476611169f47ebfa07fbae7df1f3
+  metadata.gz: 26c77950669242c68e75f64480a798486a84ac3aa2c4bd22c5ae212caa6bf57c
+  data.tar.gz: bea29587e61e5b2a41c675ff26afb69cca7891613212e0d052a41a43ce5404b4
 SHA512:
-  metadata.gz: 76d9e121e971b063d1ca1b6207c9a867cc3c97731197167fc2e4dacf8ff76d92857a5bf3a7d61f22f4d6a8eb2c216c519b5ba4ce7e0fbf728c386e0e96f073a3
-  data.tar.gz: b36861b666b72c962b12c35fb8214931a49e422886b03e29ee718dad831114a4ff475a36153997787c01c6d451ca202d34c1d8b563b9a657f5a2447e5e24b2b3
+  metadata.gz: 81f58c37a382d84e6f168ad9ada384ac160c223fa5cc1070c251ad01c8840389af78736af263aa3cd594dcd77970a2539a7f44082dca07a25f236c6d147625b4
+  data.tar.gz: f28ffa6efb6e8037cf3ec7d233f824b7190f97d91c4d3d6ba00399e6533f2958581e98422a31068a9145dd789f63d1caff58ca8744905a1cf747b02eaeed9d02

data/HISTORY.md

@@ -1,9 +1,17 @@
-## Unreleased
+## 2.3.0
 
 ### Fixed
 
+* Fix NoMethodError: undefined method 'application' for Rails:Module when Rails module is defined but not a full Rails app (#1799)
+* Fix deprecation warnings in Redis#pipelined for redis 4.6 (#1806)
+* Add Ruby syntax highlighting to remaining markdown docs (#1802)
+* Fix pagination section (#1809)
+* Fix `before_run` undefined local variable or method `runner` (#1811)
+
 ### Added
 
+* Added support for pausing all workers by setting the Redis key `pause-all-workers` to string value "true" (#1803)
+
 ## 2.2.1
 
 ### Fixed

data/README.markdown

@@ -4,47 +4,6 @@ Resque
 [![Gem Version](https://badge.fury.io/rb/resque.svg)](https://rubygems.org/gems/resque)
 [![Build Status](https://github.com/resque/resque/actions/workflows/ci.yml/badge.svg)](https://github.com/resque/resque/actions/workflows/ci.yml)
 
-Resque is a Redis-backed queueing system.
-
----------
-### Note on the future of this repo
-
-Would you like to be involved in Resque? Do you have thoughts about what 
-Resque should be and do going forward? There's currently an [open discussion here](https://github.com/resque/resque/issues/1759) 
-on just that topic, so please feel free to join in. We'd love to hear your thoughts
-and/or have people volunteer to be a part of the project!
-
----------
-
-Table of Contents
------------------
-
-* [Introduction](#introduction)
-* [Example](#example)
-* [Installation](#installation)
-* [Running Workers](#running-workers)
-* [The Front End](#the-front-end)
-* [Jobs](#jobs)
-* [Configuration](#configuration)
-* * [Redis](#redis)
-* * [Logging](#logging)
-* * [Namespaces](#namespaces)
-* * [Storing Statistics](#storing-statistics)
-* [Plugins and Hooks](#plugins-and-hooks)
-* [Additional Information](#additional-information)
-* * [Resque vs DelayedJob](#resque-vs-delayedjob)
-* * [Forking](#forking)
-* * [Signals](#signals)
-* * [Heroku](#heroku)
-* * [Monitoring](#monitoring)
-* * [Mysql::Error](#mysqlerror-mysql-server-has-gone-away)
-* [Development](#development)
-* * [Demo](#demo)
-* * [Contributing](#contributing)
-* [Questions](#questions)
-* [Meta](#meta)
-* [Author](#author)
-
 Introduction
 ------------
 
@@ -83,6 +42,13 @@ general usage stats, and helps you track failures.
 Resque now supports Ruby 2.3.0 and above.
 We will also only be supporting Redis 3.0 and above going forward.
 
+### Note on the future of Resque
+
+Would you like to be involved in Resque? Do you have thoughts about what
+Resque should be and do going forward? There's currently an [open discussion here](https://github.com/resque/resque/issues/1759)
+on just that topic, so please feel free to join in. We'd love to hear your thoughts
+and/or have people volunteer to be a part of the project!
+
 Example
 -------
 
@@ -750,7 +716,7 @@ If you want to kill a stale or stuck child and shutdown, use `TERM`
 
 If you want to stop processing jobs, but want to leave the worker running
 (for example, to temporarily alleviate load), use `USR2` to stop processing,
-then `CONT` to start it again.
+then `CONT` to start it again. It's also possible to [pause all workers](#pausing-all-workers).
 
 #### Heroku
 
@@ -774,6 +740,22 @@ time to complete before being forced to die.
 
 * `RESQUE_TERM_TIMEOUT` - By default you have a few seconds to handle `Resque::TermException` in your job. `RESQUE_TERM_TIMEOUT` and `RESQUE_PRE_SHUTDOWN_TIMEOUT` must be lower than the [heroku dyno timeout](https://devcenter.heroku.com/articles/limits#exit-timeout).
 
+#### Pausing all workers
+
+Workers will not process pending jobs if the Redis key `pause-all-workers` is set with the string value "true".
+
+``` ruby
+Resque.redis.set('pause-all-workers', 'true')
+```
+
+Nothing happens to jobs that are already being processed by workers.
+
+Unpause by removing the Redis key `pause-all-workers`.
+
+``` ruby
+Resque.redis.del('pause-all-workers')
+```
+
 #### Monitoring
 
 ##### god

data/lib/resque/data_store.rb

@@ -100,9 +100,9 @@ module Resque
         @redis = redis
       end
       def push_to_queue(queue,encoded_item)
-        @redis.pipelined do
-          watch_queue(queue)
-          @redis.rpush redis_key_for_queue(queue), encoded_item
+        @redis.pipelined do |piped|
+          watch_queue(queue, redis: piped)
+          piped.rpush redis_key_for_queue(queue), encoded_item
         end
       end
 
@@ -129,9 +129,9 @@ module Resque
       end
 
       def remove_queue(queue)
-        @redis.pipelined do
-          @redis.srem(:queues, queue.to_s)
-          @redis.del(redis_key_for_queue(queue))
+        @redis.pipelined do |piped|
+          piped.srem(:queues, queue.to_s)
+          piped.del(redis_key_for_queue(queue))
         end
       end
 
@@ -145,8 +145,8 @@ module Resque
       end
 
       # Private: do not call
-      def watch_queue(queue)
-        @redis.sadd(:queues, queue.to_s)
+      def watch_queue(queue, redis: @redis)
+        redis.sadd(:queues, queue.to_s)
       end
 
       # Private: do not call
@@ -237,24 +237,24 @@ module Resque
       end
 
       def register_worker(worker)
-        @redis.pipelined do
-          @redis.sadd(:workers, worker)
-          worker_started(worker)
+        @redis.pipelined do |piped|
+          piped.sadd(:workers, worker)
+          worker_started(worker, redis: piped)
         end
       end
 
-      def worker_started(worker)
-        @redis.set(redis_key_for_worker_start_time(worker), Time.now.to_s)
+      def worker_started(worker, redis: @redis)
+        redis.set(redis_key_for_worker_start_time(worker), Time.now.to_s)
       end
 
       def unregister_worker(worker, &block)
-        @redis.pipelined do
-          @redis.srem(:workers, worker)
-          @redis.del(redis_key_for_worker(worker))
-          @redis.del(redis_key_for_worker_start_time(worker))
-          @redis.hdel(HEARTBEAT_KEY, worker.to_s)
+        @redis.pipelined do |piped|
+          piped.srem(:workers, worker)
+          piped.del(redis_key_for_worker(worker))
+          piped.del(redis_key_for_worker_start_time(worker))
+          piped.hdel(HEARTBEAT_KEY, worker.to_s)
 
-          block.call
+          block.call redis: piped
         end
       end
 
@@ -288,9 +288,9 @@ module Resque
       end
 
       def worker_done_working(worker, &block)
-        @redis.pipelined do
-          @redis.del(redis_key_for_worker(worker))
-          block.call
+        @redis.pipelined do |piped|
+          piped.del(redis_key_for_worker(worker))
+          block.call redis: piped
         end
       end
 
@@ -317,16 +317,16 @@ module Resque
         @redis.get("stat:#{stat}").to_i
       end
 
-      def increment_stat(stat, by = 1)
-        @redis.incrby("stat:#{stat}", by)
+      def increment_stat(stat, by = 1, redis: @redis)
+        redis.incrby("stat:#{stat}", by)
       end
 
       def decremet_stat(stat, by = 1)
         @redis.decrby("stat:#{stat}", by)
       end
 
-      def clear_stat(stat)
-        @redis.del("stat:#{stat}")
+      def clear_stat(stat, redis: @redis)
+        redis.del("stat:#{stat}")
       end
     end
   end

data/lib/resque/server/views/next_more.erb

@@ -7,7 +7,7 @@
       <a href="<%= current_page %>?start=<%= start - per_page %>" class='less'>&laquo; Previous</a>
     <% end %>
 
-    <% (size / per_page.to_f - 1).ceil.times do |page_num| %>
+    <% (size / per_page.to_f).ceil.times do |page_num| %>
       <% if start == page_num * per_page %>
         <span><%= page_num + 1 %></span>
       <% else %>
@@ -15,7 +15,7 @@
       <% end %>
     <% end %>
 
-    <% if start + per_page <= size %>
+    <% if start + per_page < size %>
       <a href="<%= current_page %>?start=<%= start + per_page %>" class='more'>Next &raquo;</a>
     <% end %>
   </div>

data/lib/resque/stat.rb

@@ -35,8 +35,8 @@ module Resque
     #
     # Can optionally accept a second int parameter. The stat is then
     # incremented by that amount.
-    def incr(stat, by = 1)
-      data_store.increment_stat(stat,by)
+    def incr(stat, by = 1, **opts)
+      data_store.increment_stat(stat, by, **opts)
     end
 
     # Increments a stat by one.
@@ -58,8 +58,8 @@ module Resque
     end
 
     # Removes a stat from Redis, effectively setting it to 0.
-    def clear(stat)
-      data_store.clear_stat(stat)
+    def clear(stat, **opts)
+      data_store.clear_stat(stat, **opts)
     end
   end
 end

data/lib/resque/tasks.rb

@@ -39,7 +39,7 @@ namespace :resque do
 
   # Preload app files if this is Rails
   task :preload => :setup do
-    if defined?(Rails)
+    if defined?(Rails) && Rails.respond_to?(:application)
       if Rails.application.config.eager_load
         ActiveSupport.run_load_hooks(:before_eager_load, Rails.application)
         Rails.application.config.eager_load_namespaces.each(&:eager_load!)

data/lib/resque/version.rb

@@ -1,3 +1,3 @@
 module Resque
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/lib/resque/web_runner.rb

@@ -85,14 +85,14 @@ module Resque
     end
 
     def before_run
-      if (namespace = options[:redis_namespace])
-        runner.logger.info "Using Redis namespace '#{namespace}'"
-        Resque.redis.namespace = namespace
-      end
       if (redis_conf = options[:redis_conf])
         logger.info "Using Redis connection '#{redis_conf}'"
         Resque.redis = redis_conf
       end
+      if (namespace = options[:redis_namespace])
+        logger.info "Using Redis namespace '#{namespace}'"
+        Resque.redis.namespace = namespace
+      end
       if (url_prefix = options[:url_prefix])
         logger.info "Using URL Prefix '#{url_prefix}'"
         Resque::Server.url_prefix = url_prefix

data/lib/resque/worker.rb

@@ -579,7 +579,7 @@ module Resque
 
     # are we paused?
     def paused?
-      @paused
+      @paused || redis.get('pause-all-workers').to_s.strip.downcase == 'true'
     end
 
     # Stop processing jobs after the current one has completed (if we're
@@ -697,9 +697,9 @@ module Resque
 
       kill_background_threads
 
-      data_store.unregister_worker(self) do
-        Stat.clear("processed:#{self}")
-        Stat.clear("failed:#{self}")
+      data_store.unregister_worker(self) do |**opts|
+        Stat.clear("processed:#{self}", **opts)
+        Stat.clear("failed:#{self}",    **opts)
       end
     rescue Exception => exception_while_unregistering
       message = exception_while_unregistering.message
@@ -726,8 +726,8 @@ module Resque
     # Called when we are done working - clears our `working_on` state
     # and tells Redis we processed a job.
     def done_working
-      data_store.worker_done_working(self) do
-        processed!
+      data_store.worker_done_working(self) do |**opts|
+        processed!(**opts)
       end
     end
 
@@ -745,9 +745,9 @@ module Resque
     end
 
     # Tell Redis we've processed a job.
-    def processed!
-      Stat << "processed"
-      Stat << "processed:#{self}"
+    def processed!(**opts)
+      Stat.incr("processed",         1, **opts)
+      Stat.incr("processed:#{self}", 1, **opts)
     end
 
     # How many failed jobs has this worker seen? Returns an int.

data/lib/resque.rb

@@ -584,9 +584,9 @@ module Resque
   def queue_sizes
     queue_names = queues
 
-    sizes = redis.pipelined do
+    sizes = redis.pipelined do |piped|
       queue_names.each do |name|
-        redis.llen("queue:#{name}")
+        piped.llen("queue:#{name}")
       end
     end
 
@@ -597,11 +597,11 @@ module Resque
   def sample_queues(sample_size = 1000)
     queue_names = queues
 
-    samples = redis.pipelined do
+    samples = redis.pipelined do |piped|
       queue_names.each do |name|
         key = "queue:#{name}"
-        redis.llen(key)
-        redis.lrange(key, 0, sample_size - 1)
+        piped.llen(key)
+        piped.lrange(key, 0, sample_size - 1)
       end
     end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: resque
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Chris Wanstrath
 - Steve Klabnik
 - Terence Lee
 - Michael Bianco
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-27 00:00:00.000000000 Z
+date: 2022-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
@@ -186,7 +186,8 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/resque/resque/blob/master/HISTORY.md
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -202,8 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Resque is a Redis-backed queueing system.
 test_files: []