resque-cleaner 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDVkZjMyNjQ1NTM5ZDEyOWEzMTNmY2QyN2ZiOWFhZTZjYmQ2ZjIzYQ==
-  data.tar.gz: !binary |-
-    ZDk3M2IxN2M2YTU3NDA2ZmZiOTVhMTFlNTU3NmVjOWJmYzQzNzA0Nw==
+SHA256:
+  metadata.gz: 672f128faacd1d6be65bc4e7481b335252e0ef8cd1e09c5fef5399cc1d545ae0
+  data.tar.gz: d33de95d0ac35c3ef3ca116cdbf10a483b4a090356db1ad40674823436a613d4
 SHA512:
-  metadata.gz: !binary |-
-    NjEyZWM0MmQ1MDRhY2U2ZWQ3NzI3ODJjYTBhMTkwZDU5MGEzZjY4ZDg5ZmNk
-    NTgyMzZjMjJlZTJmZjU4OWM2MmZkNDkyY2QyMDVmOTQyMTBhYmExOTk3NWJj
-    ZTc2MWJkZWFjNjg3YjliMTc4YjVmNzMyNDliNjQ4YTU1NGYyMzc=
-  data.tar.gz: !binary |-
-    MDA5M2FkY2Q0ZmVjYmM2YTdkNjQ0YTE1MjhjMjhjMzZiOGI2YjY0NWRiN2Jh
-    MDRiMmU2NTdiMjA5NTgxNGEyOTQ3Mzc3OWVkYjg2NGYzZWUxN2U4YzgwOGU3
-    M2UyZDA5OWU0OTlhN2FlZjkzZGZhNDJjZTBlMThhNjEyM2IxZDU=
+  metadata.gz: 42d80da673a4318005cfd38262a2969d5ddb180ed187c2948c9c5f88a7a49ffcb4b77f9eebb803d98c175fa6be8f048df850bc6a4a3263b896e87454d786659d
+  data.tar.gz: 8857ad8aac4f722298428ed97f7c73c2893259848d3e8f6b1777b64d9d0db6fdafc0f9ba0c22cf60a2cf8bcbdd9e046fad5d45b0c78cb74fe24c7bcdc5735ac1

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.5.0 (2026-10-12)
+
+* Ruby 3+ support: fix rendering the Cleaner page (#53)
+* Display ActiveJob failures by their inner job class, without modifying the stored payload (#50, #59)
+* Remove failed jobs by list index, so byte-identical failures can't cause the wrong one to be removed (#60)
+* Security: escape filter params and failure metadata (job class, exception, worker, queue, `retried_at`) in the web UI (#48, #61)
+* Bound regex filter matching with a timeout and return 400 for invalid or runaway patterns (#63)
+* Require server dependencies at load time and drop the `yajl` fallback (#62)
+* Require Ruby 3.2+ and Resque 2.0+
+* Replace Travis with GitHub Actions; add a Docker dev environment (#58)
+
 ## 0.4.1 (2018-01-25)
 
 * Remove Requeue version lock (#46)

data/README.md

@@ -3,10 +3,13 @@ ResqueCleaner
 
 [github.com/ono/resque-cleaner](https://github.com/ono/resque-cleaner)
 
+This project is currently in maintenance mode.
+Please read [this](https://github.com/ono/resque-cleaner/issues/47) before you use the library.
+
 Description
 -----------
 
-ResqueCleaner is a [Resque](https://github.com/defunkt/resque) plugin which
+ResqueCleaner is a [Resque](https://github.com/resque/resque) plugin which
 aims to help you to clean up failed jobs on Resque by:
 
 * Showing stats of failed jobs
@@ -22,6 +25,8 @@ Install as a gem:
 
     $ gem install resque-cleaner
 
+Requires Ruby 3.2+ and Resque 2.0+.
+
 
 Resque-Web integration
 ----------------------
@@ -322,6 +327,13 @@ application; it should be quick even if there are huge number of failed jobs.
     => false
 ```
 
+Development
+-----------
+
+Run the test suite in Docker:
+
+    $ docker compose run --rm console bundle exec rake
+
 Many Thanks!
 ------------
 

data/lib/resque_cleaner/server/views/_stats.erb

@@ -10,8 +10,8 @@
   </tr>
   <% @stats[type.to_sym].each do |field,count| %>
     <tr>
-      <% filter = "#{q}=#{URI.encode(field)}" %>
-      <td><%= field %></td>
+      <% filter = "#{q}=#{CGI.escape(field)}" %>
+      <td><%=h field %></td>
       <td class="number">
         <a href="cleaner_list?<%=filter%>"><%= count[:total] %></a>
       </td>

data/lib/resque_cleaner/server/views/cleaner_list.erb

@@ -33,11 +33,11 @@
     <div class="clearfix">
       <div class="control_panel sub_header">
         <form method="post" id="exec" action="cleaner_exec">
-          <input type="hidden" name="c" value="<%=@klass%>" />
-          <input type="hidden" name="f" value="<%=@from%>" />
-          <input type="hidden" name="t" value="<%=@to%>" />
-          <input type="hidden" name="p" value="<%=@paginate.page%>" />
-          <input type="hidden" name="ex" value="<%=@exception%>" />
+          <input type="hidden" name="c" value="<%= h @klass %>" />
+          <input type="hidden" name="f" value="<%= h @from %>" />
+          <input type="hidden" name="t" value="<%= h @to %>" />
+          <input type="hidden" name="p" value="<%= h @paginate.page %>" />
+          <input type="hidden" name="ex" value="<%= h @exception %>" />
           <input type="hidden" name="regex" value="<%=Rack::Utils.escape_html(@regex)%>" />
           <select id="form_action" name="action">
             <option id="default_option" value="" selected="selected">-- Select Action --</option>
@@ -81,19 +81,19 @@
             <dd>&nbsp;</dd>
             <dt>Worker</dt>
             <dd>
-              <a href="<%= u(:workers, job['worker']) %>"><%= job['worker'].split(':')[0...2].join(':') %></a> on <b class='queue-tag'><%= job['queue'] %></b > at <b><span class="time"><%= Time.parse(job['failed_at']).strftime(date_format) %></span></b>
+              <a href="<%=h u(:workers, job['worker']) %>"><%=h job['worker'].split(':')[0...2].join(':') %></a> on <b class='queue-tag'><%=h job['queue'] %></b > at <b><span class="time"><%= Time.parse(job['failed_at']).strftime(date_format) %></span></b>
               <% if job['retried_at'] %>
                 <div class='retried'>
-                  Retried <b><span class="time"><%= job['retried_at'] %></span></b>
+                  Retried <b><span class="time"><%=h job['retried_at'] %></span></b>
                 </div>
               <% end %>
             </dd>
             <dt>Class</dt>
-            <dd><code><%= job['payload'] ? job['payload']['class'] : 'nil' %></code></dd>
+            <dd><code><%=h job['payload'] ? job.display_class : 'nil' %></code></dd>
             <dt>Arguments</dt>
-            <dd><pre><%=h job['payload'] ? show_job_args(job['payload']['args']) : 'nil' %></pre></dd>
+            <dd><pre><%=h job['payload'] ? show_job_args(job.display_args) : 'nil' %></pre></dd>
             <dt>Exception</dt>
-            <dd><code><%= job['exception'] %></code></dd>
+            <dd><code><%=h job['exception'] %></code></dd>
             <dt>Error</dt>
             <dd class='error'>
               <% if job['backtrace'] %>

data/lib/resque_cleaner/server.rb

@@ -1,4 +1,5 @@
-require 'yaml'
+require 'digest/sha1'
+require 'json'
 
 # Extends Resque Web Based UI.
 # Structure has been borrowed from ResqueScheduler.
@@ -82,7 +83,8 @@ module ResqueCleaner
             html += "<option value=\"\">-</option>"
             klasses.each do |k|
               selected = k == value ? 'selected="selected"' : ''
-              html += "<option #{selected} value=\"#{k}\">#{k}</option>"
+              escaped = Rack::Utils.escape_html(k.to_s)
+              html += "<option #{selected} value=\"#{escaped}\">#{escaped}</option>"
             end
             html += "</select>"
           end
@@ -92,7 +94,8 @@ module ResqueCleaner
             html += "<option value=\"\">-</option>"
             exceptions.each do |ex|
               selected = ex == value ? 'selected="selected"' : ''
-              html += "<option #{selected} value=\"#{ex}\">#{ex}</option>"
+              escaped = Rack::Utils.escape_html(ex.to_s)
+              html += "<option #{selected} value=\"#{escaped}\">#{escaped}</option>"
             end
             html += "</select>"
           end
@@ -110,15 +113,13 @@ module ResqueCleaner
         mime_type :json, 'application/json'
 
         get "/cleaner" do
-          load_library
           load_cleaner_filter
 
           @jobs = cleaner.select
           @stats = { :klass => {}, :exception => {} }
           @total = Hash.new(0)
           @jobs.each do |job|
-            payload = job["payload"] || {}
-            klass = payload["class"] || 'UNKNOWN'
+            klass = job.display_class || 'UNKNOWN'
             exception = job["exception"] || 'UNKNOWN'
             failed_at = Time.parse job["failed_at"]
             @stats[:klass][klass] ||= Hash.new(0)
@@ -142,7 +143,6 @@ module ResqueCleaner
         end
 
         get "/cleaner_list" do
-          load_library
           load_cleaner_filter
           build_urls
 
@@ -160,7 +160,6 @@ module ResqueCleaner
         end
 
         post "/cleaner_exec" do
-          load_library
           load_cleaner_filter
           build_urls
 
@@ -182,7 +181,6 @@ module ResqueCleaner
         end
 
         get "/cleaner_dump" do
-          load_library
           load_cleaner_filter
 
           block = filter_block
@@ -192,7 +190,6 @@ module ResqueCleaner
         end
 
         post "/cleaner_stale" do
-          load_library
           cleaner.clear_stale
           redirect url_path(:cleaner)
         end
@@ -206,21 +203,15 @@ module ResqueCleaner
       @cleaner
     end
 
-    def load_library
-      require 'digest/sha1'
-      begin
-        require 'yajl/json_gem' unless [].respond_to?(:to_json)
-      rescue Exception
-        require 'json'
-      end
-    end
-
     def load_cleaner_filter
       @from = params[:f]=="" ? nil : params[:f]
       @to = params[:t]=="" ? nil : params[:t]
       @klass = params[:c]=="" ? nil : params[:c]
       @exception = params[:ex]=="" ? nil : params[:ex]
       @regex = params[:regex]=="" ? nil : params[:regex]
+      @regexp = Regexp.new(@regex, timeout: 1) if @regex
+    rescue RegexpError
+      halt 400, "Invalid regex"
     end
 
     def build_urls
@@ -230,7 +221,7 @@ module ResqueCleaner
         f: @from,
         t: @to,
         regex: @regex
-      }.map {|key,value| "#{key}=#{URI.encode(value.to_s)}"}.join("&")
+      }.map {|key,value| "#{key}=#{CGI.escape(value.to_s)}"}.join("&")
 
       @list_url = "cleaner_list?#{params}"
       @dump_url = "cleaner_dump?#{params}"
@@ -243,10 +234,16 @@ module ResqueCleaner
         (!@klass || j.klass?(@klass)) &&
         (!@exception || j.exception?(@exception)) &&
         (!@sha1 || @sha1[Digest::SHA1.hexdigest(j.to_json)]) &&
-        (!@regex || j.to_s =~ /#{@regex}/)
+        (!@regexp || regex_match?(j))
       }
     end
 
+    def regex_match?(job)
+      @regexp.match?(job.to_s)
+    rescue Regexp::TimeoutError
+      halt 400, "Regex took too long"
+    end
+
     def hours_ago(h)
       Time.now - h.to_i*60*60
     end

data/lib/resque_cleaner.rb

@@ -1,4 +1,5 @@
 require 'time'
+require 'securerandom'
 require 'resque'
 require 'resque/server'
 
@@ -52,7 +53,7 @@ module Resque
       def stats_by_class(&block)
         jobs, stats = select(&block), {}
         jobs.each do |job|
-          klass = job["payload"] && job["payload"]["class"] ? job["payload"]["class"] : "UNKNOWN"
+          klass = job.display_class || "UNKNOWN"
           stats[klass] ||= 0
           stats[klass] += 1
         end
@@ -103,10 +104,7 @@ module Resque
           @limiter.jobs.each_with_index do |job,i|
             if !block_given? || block.call(job)
               index = @limiter.start_index + i - cleared
-              # fetches again since you can't ensure that it is always true:
-              # a == endode(decode(a))
-              value = redis.lindex(:failed, index)
-              redis.lrem(:failed, 1, value)
+              remove_failure_at(index)
               cleared += 1
             end
           end
@@ -123,19 +121,13 @@ module Resque
             if !block_given? || block.call(job)
               index = @limiter.start_index + i - requeued
 
-              value = redis.lindex(:failed, index)
-              redis.multi do
-                Job.create(queue||job['queue'], job['payload']['class'], *job['payload']['args'])
-
-                if clear_after_requeue
-                  # remove job
-                  # TODO: should use ltrim. not sure why i used lrem here...
-                  redis.lrem(:failed, 1, value)
-                else
-                  # mark retried
-                  job['retried_at'] = Time.now.strftime("%Y/%m/%d %H:%M:%S")
-                  redis.lset(:failed, @limiter.start_index+i, Resque.encode(job))
-                end
+              Job.create(queue||job['queue'], job['payload']['class'], *job['payload']['args'])
+
+              if clear_after_requeue
+                remove_failure_at(index)
+              else
+                job['retried_at'] = Time.now.strftime("%Y/%m/%d %H:%M:%S")
+                redis.lset(:failed, @limiter.start_index+i, Resque.encode(job))
               end
 
               requeued += 1
@@ -155,6 +147,33 @@ module Resque
 
       # Exntends job(Hash instance) with some helper methods.
       module FailedJobEx
+        ACTIVE_JOB_WRAPPER = "ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper"
+
+        def display_class
+          payload = self["payload"]
+          return unless payload.is_a?(Hash)
+
+          if payload["class"] == ACTIVE_JOB_WRAPPER
+            wrapper = active_job_wrapper_payload
+            job_class = wrapper && wrapper["job_class"]
+            job_class.is_a?(String) && !job_class.empty? ? job_class : payload["class"]
+          else
+            payload["class"]
+          end
+        end
+
+        def display_args
+          payload = self["payload"]
+          return unless payload.is_a?(Hash)
+
+          if payload["class"] == ACTIVE_JOB_WRAPPER
+            wrapper = active_job_wrapper_payload
+            wrapper && wrapper.key?("arguments") ? wrapper["arguments"] : payload["args"]
+          else
+            payload["args"]
+          end
+        end
+
         # Returns true if the job has been already retried. Otherwise returns
         # false.
         def retried?
@@ -180,8 +199,8 @@ module Resque
 
         # Returns true if the class of the job matches. Otherwise returns false.
         def klass?(klass_or_name)
-          if self["payload"] && self["payload"]["class"]
-            self["payload"]["class"] == klass_or_name.to_s
+          if display_class
+            display_class == klass_or_name.to_s
           else
             klass_or_name=="UNKNOWN"
           end
@@ -196,6 +215,13 @@ module Resque
         def queue?(queue)
           self["queue"] == queue.to_s
         end
+
+        private
+
+        def active_job_wrapper_payload
+          args = self.dig("payload", "args")
+          args[0] if args.is_a?(Array) && args[0].is_a?(Hash)
+        end
       end
 
       # Through the Limiter class, you accesses only the last x(default 1000)
@@ -299,6 +325,16 @@ module Resque
       def too_many_message
         "There are too many failed jobs(count=#{@failure.count}). This only looks at last #{@limiter.maximum} jobs."
       end
+
+      private
+
+      def remove_failure_at(index)
+        sentinel = SecureRandom.uuid
+        redis.multi do |transaction|
+          transaction.lset(:failed, index, sentinel)
+          transaction.lrem(:failed, 1, sentinel)
+        end
+      end
     end
   end
 end

metadata

@@ -1,73 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: resque-cleaner
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Tatsuya Ono
-autorequire: 
+- Patrick Tulskie
 bindir: bin
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-description: ! '    resque-cleaner maintains the cleanliness of failed jobs on Resque.
-
-'
+        version: '2.0'
+description: "    resque-cleaner maintains the cleanliness of failed jobs on Resque.\n"
 email: ononoma@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE
 - README.md
-- CHANGELOG.md
 files:
-- README.md
 - CHANGELOG.md
-- Rakefile
 - LICENSE
+- README.md
 - lib/resque-cleaner.rb
+- lib/resque_cleaner.rb
+- lib/resque_cleaner/server.rb
 - lib/resque_cleaner/server/views/_cleaner_styles.erb
 - lib/resque_cleaner/server/views/_limiter.erb
 - lib/resque_cleaner/server/views/_paginate.erb
@@ -75,37 +46,29 @@ files:
 - lib/resque_cleaner/server/views/cleaner.erb
 - lib/resque_cleaner/server/views/cleaner_exec.erb
 - lib/resque_cleaner/server/views/cleaner_list.erb
-- lib/resque_cleaner/server.rb
-- lib/resque_cleaner.rb
-- test/dump.rdb
-- test/redis-test.conf
-- test/resque_cleaner_test.rb
-- test/resque_web_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ono/resque-cleaner
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/ono/resque-cleaner/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/ono/resque-cleaner
+  rubygems_mfa_required: 'true'
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.11
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Resque plugin cleaning up failed jobs.
 test_files: []
-has_rdoc: 

data/Rakefile

@@ -1,38 +0,0 @@
-#
-# Setup
-#
-
-# load 'tasks/redis.rake'
-#require 'rake/testtask'
-
-$LOAD_PATH.unshift 'lib'
-#require 'resque/tasks'
-
-def command?(command)
-  system("type #{command} > /dev/null 2>&1")
-end
-
-
-#
-# Tests
-#
-
-task :default => :test
-
-desc "Run the test suite"
-task :test do
-  rg = command?(:rg)
-  Dir['test/**/*_test.rb'].each do |f|
-    rg ? sh("rg #{f}") : ruby(f)
-  end
-end
-
-if command? :kicker
-  desc "Launch Kicker (like autotest)"
-  task :kicker do
-    puts "Kicking... (ctrl+c to cancel)"
-    exec "kicker -e rake test lib examples"
-  end
-end
-
-

data/test/redis-test.conf

@@ -1,115 +0,0 @@
-# Redis configuration file example
-
-# By default Redis does not run as a daemon. Use 'yes' if you need it.
-# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
-daemonize yes
-
-# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
-# You can specify a custom pid file location here.
-pidfile ./test/redis-test.pid
-
-# Accept connections on the specified port, default is 6379
-port 9736
-
-# If you want you can bind a single interface, if the bind option is not
-# specified all the interfaces will listen for connections.
-#
-# bind 127.0.0.1
-
-# Close the connection after a client is idle for N seconds (0 to disable)
-timeout 300
-
-# Save the DB on disk:
-#
-#   save <seconds> <changes>
-#
-#   Will save the DB if both the given number of seconds and the given
-#   number of write operations against the DB occurred.
-#
-#   In the example below the behaviour will be to save:
-#   after 900 sec (15 min) if at least 1 key changed
-#   after 300 sec (5 min) if at least 10 keys changed
-#   after 60 sec if at least 10000 keys changed
-save 900 1
-save 300 10
-save 60 10000
-
-# The filename where to dump the DB
-dbfilename dump.rdb
-
-# For default save/load DB in/from the working directory
-# Note that you must specify a directory not a file name.
-dir ./test/
-
-# Set server verbosity to 'debug'
-# it can be one of:
-# debug (a lot of information, useful for development/testing)
-# notice (moderately verbose, what you want in production probably)
-# warning (only very important / critical messages are logged)
-loglevel debug
-
-# Specify the log file name. Also 'stdout' can be used to force
-# the demon to log on the standard output. Note that if you use standard
-# output for logging but daemonize, logs will be sent to /dev/null
-logfile stdout
-
-# Set the number of databases. The default database is DB 0, you can select
-# a different one on a per-connection basis using SELECT <dbid> where
-# dbid is a number between 0 and 'databases'-1
-databases 16
-
-################################# REPLICATION #################################
-
-# Master-Slave replication. Use slaveof to make a Redis instance a copy of
-# another Redis server. Note that the configuration is local to the slave
-# so for example it is possible to configure the slave to save the DB with a
-# different interval, or to listen to another port, and so on.
-
-# slaveof <masterip> <masterport>
-
-################################## SECURITY ###################################
-
-# Require clients to issue AUTH <PASSWORD> before processing any other
-# commands.  This might be useful in environments in which you do not trust
-# others with access to the host running redis-server.
-#
-# This should stay commented out for backward compatibility and because most
-# people do not need auth (e.g. they run their own servers).
-
-# requirepass foobared
-
-################################### LIMITS ####################################
-
-# Set the max number of connected clients at the same time. By default there
-# is no limit, and it's up to the number of file descriptors the Redis process
-# is able to open. The special value '0' means no limts.
-# Once the limit is reached Redis will close all the new connections sending
-# an error 'max number of clients reached'.
-
-# maxclients 128
-
-# Don't use more memory than the specified amount of bytes.
-# When the memory limit is reached Redis will try to remove keys with an
-# EXPIRE set. It will try to start freeing keys that are going to expire
-# in little time and preserve keys with a longer time to live.
-# Redis will also try to remove objects from free lists if possible.
-#
-# If all this fails, Redis will start to reply with errors to commands
-# that will use more memory, like SET, LPUSH, and so on, and will continue
-# to reply to most read-only commands like GET.
-#
-# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
-# 'state' server or cache, not as a real DB. When Redis is used as a real
-# database the memory usage will grow over the weeks, it will be obvious if
-# it is going to use too much memory in the long run, and you'll have the time
-# to upgrade. With maxmemory after the limit is reached you'll start to get
-# errors for write operations, and this may even lead to DB inconsistency.
-
-# maxmemory <bytes>
-
-############################### ADVANCED CONFIG ###############################
-
-# Glue small output buffers together in order to send small replies in a
-# single TCP packet. Uses a bit more CPU but most of the times it is a win
-# in terms of number of queries per second. Use 'yes' if unsure.
-#glueoutputbuf yes

data/test/resque_cleaner_test.rb

@@ -1,206 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/test_helper')
-require 'time'
-describe "ResqueCleaner" do
-  before do
-    Resque.redis.flushall
-
-    @worker = Resque::Worker.new(:jobs,:jobs2)
-
-    # 3 BadJob at 2009-03-13
-    create_and_process_jobs :jobs, @worker, 3, Time.parse('2009-03-13'), BadJob
-    # 2 BadJob by Jason at 2009-03-13
-    create_and_process_jobs :jobs2, @worker, 2, Time.parse('2009-03-13'), BadJob, "Jason"
-
-    # 1 BadJob by Johnson at 2009-03-13
-    create_and_process_jobs :jobs, @worker, 1, Time.parse('2009-03-13'), BadJob, "Johnson"
-
-    # 7 BadJob at 2009-11-13
-    create_and_process_jobs :jobs, @worker, 7, Time.parse('2009-11-13'), BadJobWithSyntaxError
-    # 7 BadJob by Freddy at 2009-11-13
-    create_and_process_jobs :jobs2, @worker, 7, Time.parse('2009-11-13'), BadJob, "Freddy"
-
-    # 11 BadJob at 2010-08-13
-    create_and_process_jobs :jobs, @worker, 11, Time.parse('2010-08-13'), BadJob
-    # 11 BadJob by Jason at 2010-08-13
-    create_and_process_jobs :jobs2, @worker, 11, Time.parse('2010-08-13'), BadJob, "Jason"
-
-    @cleaner = Resque::Plugins::ResqueCleaner.new
-    @cleaner.print_message = false
-  end
-
-  it "#select_by_regex returns only Jason jobs" do
-    ret = @cleaner.select_by_regex(/Jason/)
-    assert_equal 13, ret.size
-  end
-
-  it "#select_by_regex returns an empty array if passed a non-regex" do
-    ['string', nil, 13, Class.new].each do |non_regex|
-      ret = @cleaner.select_by_regex(nil)
-      assert_equal 0, ret.size
-    end
-  end
-
-  it "#select returns failure jobs" do
-    ret = @cleaner.select
-    assert_equal 42, ret.size
-  end
-
-  it "#select works with a limit" do
-    @cleaner.limiter.maximum = 10
-    ret = @cleaner.select
-
-    # only maximum number
-    assert_equal 10, ret.size
-
-    # lait one
-    assert_equal Time.parse(ret[0]['failed_at']), Time.parse('2010-08-13')
-  end
-
-  it "#select with a block returns failure jobs which the block evaluates true" do
-    ret = @cleaner.select {|job| job["payload"]["args"][0]=="Jason"}
-    assert_equal 13, ret.size
-  end
-
-  it "#clear deletes failure jobs" do
-    cleared = @cleaner.clear
-    assert_equal 42, cleared
-    assert_equal 0, @cleaner.select.size
-  end
-
-  it "#clear with a block deletes failure jobs which the block evaluates true" do
-    cleared = @cleaner.clear{|job| job["payload"]["args"][0]=="Jason"}
-    assert_equal 13, cleared
-    assert_equal 42-13, @cleaner.select.size
-    assert_equal 0, @cleaner.select{|job| job["payload"]["args"][0]=="Jason"}.size
-  end
-
-  it "#requeue retries failure jobs" do
-    assert_equal 0, queue_size(:jobs,:jobs2)
-    requeued = @cleaner.requeue
-    assert_equal 42, requeued
-    assert_equal 42, @cleaner.select.size # it doesn't clear jobs
-    assert_equal 42, queue_size(:jobs,:jobs2)
-  end
-
-  it "#requeue with a block retries failure jobs which the block evaluates true" do
-    requeued = @cleaner.requeue{|job| job["payload"]["args"][0]=="Jason"}
-    assert_equal 13, requeued
-    assert_equal 13, queue_size(:jobs,:jobs2)
-  end
-
-  it "#requeue with clear option requeues and deletes failure jobs" do
-    assert_equal 0, queue_size(:jobs,:jobs2)
-    requeued = @cleaner.requeue(true)
-    assert_equal 42, requeued
-    assert_equal 42, queue_size(:jobs,:jobs2)
-    assert_equal 0, @cleaner.select.size
-  end
-
-  it "#requeue with :queue option requeues the jobs to the queue" do
-    assert_equal 0, queue_size(:jobs,:jobs2,:retry)
-    requeued = @cleaner.requeue false, :queue => :retry
-    assert_equal 42, requeued
-    assert_equal 42, @cleaner.select.size # it doesn't clear jobs
-    assert_equal 0, queue_size(:jobs,:jobs2)
-    assert_equal 42, queue_size(:retry)
-  end
-
-  it "#clear_stale deletes failure jobs which is queued before the last x enqueued" do
-    @cleaner.limiter.maximum = 10
-    @cleaner.clear_stale
-    assert_equal 10, @cleaner.failure.count
-    assert_equal Time.parse(@cleaner.failure_jobs[0]['failed_at']), Time.parse('2010-08-13')
-  end
-
-  it "FailedJobEx module extends job and provides some useful methods" do
-    # before 2009-04-01
-    ret = @cleaner.select {|j| j.before?('2009-04-01')}
-    assert_equal 6, ret.size
-
-    # after 2010-01-01
-    ret = @cleaner.select {|j| j.after?('2010-01-01')}
-    assert_equal 22, ret.size
-
-    # filter by class
-    ret = @cleaner.select {|j| j.klass?(BadJobWithSyntaxError)}
-    assert_equal 7, ret.size
-
-    # filter by exception
-    ret = @cleaner.select {|j| j.exception?(SyntaxError)}
-    assert_equal 7, ret.size
-
-    # filter by queue
-    ret = @cleaner.select {|j| j.queue?(:jobs2)}
-    assert_equal 20, ret.size
-
-    # combination
-    ret = @cleaner.select {|j| j.queue?(:jobs2) && j.before?('2009-12-01')}
-    assert_equal 9, ret.size
-
-    # combination 2
-    ret = @cleaner.select {|j| j['payload']['args']==['Jason'] && j.queue?(:jobs2)}
-    assert_equal 13, ret.size
-
-    # retried?
-    requeued = @cleaner.requeue{|j| j["payload"]["args"][0]=="Johnson"}
-    ret = @cleaner.select {|j| j.retried?}
-    assert_equal 1, ret.size
-  end
-
-  it "#stats_by_date returns stats grouped by date" do
-    ret = @cleaner.stats_by_date
-    assert_equal 6, ret['2009/03/13']
-    assert_equal 14, ret['2009/11/13']
-
-    # with block
-    ret = @cleaner.stats_by_date{|j| j['payload']['args']==['Jason']}
-    assert_equal 2, ret['2009/03/13']
-    assert_equal nil, ret['2009/11/13']
-    assert_equal 11, ret['2010/08/13']
-  end
-
-  it "#stats_by_class returns stats grouped by class" do
-    ret = @cleaner.stats_by_class
-    assert_equal 35, ret['BadJob']
-    assert_equal 7, ret['BadJobWithSyntaxError']
-  end
-
-  it "#stats_by_class works with broken log" do
-    add_empty_payload_failure
-    ret = @cleaner.stats_by_class
-    assert_equal 1, ret['UNKNOWN']
-  end
-
-  it "#stats_by_exception returns stats grouped by exception" do
-    ret = @cleaner.stats_by_exception
-    assert_equal 35, ret['RuntimeError']
-    assert_equal 7, ret['SyntaxError']
-  end
-
-  it "#lock ensures that a new failure job doesn't affect in a limit mode" do
-    @cleaner.limiter.maximum = 23
-    @cleaner.limiter.lock do
-      first = @cleaner.select[0]
-      assert_equal "Freddy", first["payload"]["args"][0]
-
-      create_and_process_jobs :jobs, @worker, 30, Time.parse('2010-10-10'), BadJob, "Jack"
-
-      first = @cleaner.select[0]
-      assert_equal "Freddy", first["payload"]["args"][0]
-    end
-    first = @cleaner.select[0]
-    assert_equal "Jack", first["payload"]["args"][0]
-  end
-
-  it "allows you to configure limiter" do
-    c = Resque::Plugins::ResqueCleaner.new
-    refute_equal c.limiter.maximum, 10_000
-
-    module Resque::Plugins
-      ResqueCleaner::Limiter.default_maximum = 10_000
-    end
-
-    c = Resque::Plugins::ResqueCleaner.new
-    assert_equal c.limiter.maximum, 10_000
-  end
-end

data/test/resque_web_test.rb

@@ -1,66 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/test_helper')
-
-require 'digest/sha1'
-require 'json'
-require 'rack/test'
-
-class Minitest::Spec
-  include Rack::Test::Methods
-  def app
-    Resque::Server.new
-  end
-end
-
-def setup_some_failed_jobs
-  Resque.redis.flushall
-
-  @worker = Resque::Worker.new(:jobs,:jobs2)
-
-  create_and_process_jobs :jobs, @worker, 1, Time.now, BadJobWithSyntaxError, "great_args"
-
-  10.times {|i|
-    create_and_process_jobs :jobs, @worker, 1, Time.now, BadJob, "test_#{i}"
-  }
-
-  @cleaner = Resque::Plugins::ResqueCleaner.new
-  @cleaner.print_message = false
-end
-
-describe "resque-web" do
-  before do
-    setup_some_failed_jobs
-  end
-
-  it "#cleaner should respond with success" do
-    get "/cleaner"
-    assert last_response.body.include?('BadJob')
-    assert last_response.body =~ /\bException\b/
-  end
-
-  it "#cleaner_list should respond with success" do
-    get "/cleaner_list"
-    assert last_response.ok?, last_response.errors
-  end
-
-  it '#cleaner_list shows the failed jobs' do
-    get "/cleaner_list"
-    assert last_response.body.include?('BadJob')
-  end
-
-  it "#cleaner_list shows the failed jobs when we use a select_by_regex" do
-    get "/cleaner_list", :regex => "BadJob*"
-    assert last_response.body.include?('"BadJobWithSyntaxError"')
-    assert last_response.body.include?('"BadJob"')
-  end
-
-
-  it '#cleaner_exec clears job' do
-    post "/cleaner_exec", :action => "clear", :sha1 => Digest::SHA1.hexdigest(@cleaner.select[0].to_json)
-    assert_equal 10, @cleaner.select.size
-  end
-  it "#cleaner_dump should respond with success" do
-    get "/cleaner_dump"
-    assert last_response.ok?, last_response.errors
-  end
-end
-

data/test/test_helper.rb

@@ -1,131 +0,0 @@
-# Mostly copied from Resque in order to have similar test environment.
-# https://github.com/defunkt/resque/blob/master/test/test_helper.rb
-
-dir = File.dirname(File.expand_path(__FILE__))
-$LOAD_PATH.unshift dir + '/../lib'
-$TESTING = true
-require 'rubygems'
-require 'minitest'
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'resque'
-require 'timecop'
-
-begin
-  require 'leftright'
-rescue LoadError
-end
-require 'resque'
-require 'resque_cleaner'
-
-$TEST_PID = Process.pid
-
-#
-# make sure we can run redis
-#
-
-if !system("which redis-server")
-  puts '', "** can't find `redis-server` in your path"
-  puts "** try running `sudo rake install`"
-  abort ''
-end
-
-
-#
-# start our own redis when the tests start,
-# kill it when they end
-#
-MiniTest.after_run {
-  if Process.pid == $TEST_PID
-    processes = `ps -A -o pid,command | grep [r]edis-test`.split($/)
-    pids = processes.map { |process| process.split(" ")[0] }
-    puts "Killing test redis server..."
-    pids.each { |pid| Process.kill("TERM", pid.to_i) }
-    dump = "test/dump.rdb"
-    File.delete(dump) if File.exist?(dump)
-  end
-}
-
-puts "Starting redis for testing at localhost:9736..."
-`redis-server #{dir}/redis-test.conf`
-Resque.redis = 'localhost:9736'
-
-
-##
-# Helper to perform job classes
-#
-module PerformJob
-  def perform_job(klass, *args)
-    resque_job = Resque::Job.new(:testqueue, 'class' => klass, 'args' => args)
-    resque_job.perform
-  end
-end
-
-#
-# fixture classes
-#
-
-class SomeJob
-  def self.perform(repo_id, path)
-  end
-end
-
-class SomeIvarJob < SomeJob
-  @queue = :ivar
-end
-
-class SomeMethodJob < SomeJob
-  def self.queue
-    :method
-  end
-end
-
-class BadJob
-  def self.perform(name=nil)
-    msg = name ? "Bad job, #{name}" : "Bad job!"
-    raise msg
-  end
-end
-
-class GoodJob
-  def self.perform(name)
-    "Good job, #{name}"
-  end
-end
-
-class BadJobWithSyntaxError
-  def self.perform
-    raise SyntaxError, "Extra Bad job!"
-  end
-end
-
-#
-# helper methods
-#
-
-def create_and_process_jobs(queue,worker,num,date,job,*args)
-  Timecop.freeze(date) do
-    num.times do
-      Resque::Job.create(queue, job, *args)
-    end
-    worker.work(0)
-  end
-end
-
-def queue_size(*queues)
-  queues.inject(0){|sum,queue| sum + Resque.size(queue).to_i}
-end
-
-def add_empty_payload_failure
-  data = {
-    :failed_at => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
-    :payload   => nil,
-    :exception => "Resque::DirtyExit",
-    :error     => "Resque::DirtyExit",
-    :backtrace => [],
-    :worker    => "worker",
-    :queue     => "queue"
-  }
-  data = Resque.encode(data)
-  Resque.redis.rpush(:failed, data)
-end