resque 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5993f1eacb5b40caa0c88229f31a68b92065e85a5c06c75aa90efece81578cd
-  data.tar.gz: e69e5e519f05e01ab93769bc74904b86bea2365c9299f9420c9cc233e34b0867
+  metadata.gz: f8cf648f1eb756bfe114e702e712d3b9a6748288d25194bf982c29b94b7ea7b5
+  data.tar.gz: e878e1cbe5a8bcf2a915a35c0038b24056f52bd845782934536968da71d90719
 SHA512:
-  metadata.gz: f25f2bf8b605425708f1b3c3815d3073adcdd4decf16a2914af761017d6a02a5a2c231caae7647abd7820be033040845d68a9a24e7993609fb6516c55bbdf58e
-  data.tar.gz: 0c7003a64a94af3293d2cc271420534b35b9bf31738eb3110fb3d777c424e51ef5ce2300bb932d4263875aa1e79c7e13ce0d758815aebe09b421cb7e1f954b3e
+  metadata.gz: 28094061441be3776fd2541ea43e678ad8270b1c620aa1bf11a2368f8c913e0c0069b481ecc1d17d336f432f7032b61b20d2a80e646231a7f86dacbd68e789b8
+  data.tar.gz: 3f3b8f2edc6f8b006ab650e2431db26e4fac0230adddc9f9fb748601bf9d6f16581208d20283b4a44e5303ae8a54993e8a324821492996d61a05b2e6f72adb7d

data/HISTORY.md

@@ -1,3 +1,31 @@
+## 2.6.0
+
+### Fixed
+
+* resque-web: Fix reflected XSS in queues endpoint (#1865)
+* resque-web: Format args in YAML (#1875)
+* Fix MiniTest undefined errors (#1879)
+* Fix failing reconnect tests (#1880)
+
+### Added
+
+* Documents how to make the worker shutdown when the queue is empty (#1873)
+
+## 2.5.0
+
+### Fixed
+
+* Replace `File.exists?` with `File.exist?` (#1846)
+* Escape `Resque.redis_id` for stats page (#1834)
+* Escape resque info values (#1832)
+* Correctly show the values of hash and none type on stats tab (#1838)
+* Fix logging the worker name when starting the task (#1837)
+
+### Added
+
+* Raise an error when no available Rack server was found (#1836)
+* Move code in `Resque::Server.helpers` block into a module to make it testable (#1851)
+
 ## 2.4.0
 
 ### Fixed

data/README.markdown

@@ -258,6 +258,9 @@ The default is 5 seconds, but for a semi-active app you may want to use a smalle
 
     $ INTERVAL=0.1 QUEUE=file_serve rake resque:work
 
+When INTERVAL is set to 0 it will run until the queue is empty and then
+shutdown the worker, instead of waiting for new jobs.
+
 The Front End
 -------------
 

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

@@ -38,7 +38,7 @@
 
 <div id="footer">
   <p>Powered by <a href="http://github.com/resque/resque">Resque</a> v<%=Resque::VERSION%></p>
-  <p>Connected to Redis namespace <%= Resque.redis.namespace %> on <%=Resque.redis_id%></p>
+  <p>Connected to Redis namespace <%= Resque.redis.namespace %> on <%= h Resque.redis_id %></p>
 </div>
 
 </body>

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

@@ -3,7 +3,7 @@
 <% if current_queue = params[:id] %>
 
   <h1>Pending jobs on <span class='hl'><%= h escape_html(current_queue) %></span></h1>
-  <form method="POST" action="<%=u "/queues/#{current_queue}/remove" %>" class='remove-queue'>
+  <form method="POST" action="<%=u "/queues/#{escape_html(current_queue)}/remove" %>" class='remove-queue'>
     <input type='submit' name='' value='Remove Queue' class="confirmSubmission" />
   </form>
   <p class='sub'><%= page_entries_info start = params[:start].to_i, start + 19, size = resque.size(current_queue), 'job' %></p>

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

@@ -6,7 +6,7 @@
 
 <% elsif params[:id] == "resque" %>
 
-  <h1><%= resque %></h1>
+  <h1><%= h resque %></h1>
   <table class='stats'>
   <% for key, value in resque.info.to_a.sort_by { |i| i[0].to_s } %>
     <tr>
@@ -14,7 +14,7 @@
         <%= key %>
       </th>
       <td>
-        <%= value %>
+        <%= h value %>
       </td>
     </tr>
   <% end %>
@@ -22,7 +22,7 @@
 
 <% elsif params[:id] == 'redis' %>
 
-  <h1><%= resque.redis_id %></h1>
+  <h1><%= h resque.redis_id %></h1>
   <table class='stats'>
   <% for key, value in resque.redis.redis.info.to_a.sort_by { |i| i[0].to_s } %>
     <tr>
@@ -38,7 +38,7 @@
 
 <% elsif params[:id] == 'keys' %>
 
-  <h1>Keys owned by <%= resque %></h1>
+  <h1>Keys owned by <%= h resque.redis_id %></h1>
   <p class='sub'>(All keys are actually prefixed with "<%= Resque.redis.namespace %>:")</p>
   <table class='stats'>
     <tr>

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

@@ -21,7 +21,7 @@
         <td>
           <code><%= payload.key?('class') ? payload['class'] : "—" %></code>
         </td>
-        <td><%=h payload.key?('args') ? payload['args'].inspect : "—" %></td>
+        <td><pre><%=h payload.key?('args') ? show_args(payload['args']) : "—" %></pre></td>
       </tr>
   </table>
 

data/lib/resque/server.rb

@@ -1,6 +1,7 @@
 require 'sinatra/base'
 require 'tilt/erb'
 require 'resque'
+require 'resque/server_helper'
 require 'resque/version'
 require 'time'
 require 'yaml'
@@ -11,8 +12,6 @@ end
 
 module Resque
   class Server < Sinatra::Base
-    require 'resque/server/helpers'
-
     dir = File.dirname(File.expand_path(__FILE__))
 
     set :views,  "#{dir}/server/views"
@@ -26,117 +25,7 @@ module Resque
     set :static, true
 
     helpers do
-      include Rack::Utils
-      alias_method :h, :escape_html
-
-      def current_section
-        url_path request.path_info.sub('/','').split('/')[0].downcase
-      end
-
-      def current_page
-        url_path request.path_info.sub('/','')
-      end
-
-      def url_path(*path_parts)
-        [ url_prefix, path_prefix, path_parts ].join("/").squeeze('/')
-      end
-      alias_method :u, :url_path
-
-      def path_prefix
-        request.env['SCRIPT_NAME']
-      end
-
-      def class_if_current(path = '')
-        'class="current"' if current_page[0, path.size] == path
-      end
-
-      def tab(name)
-        dname = name.to_s.downcase
-        path = url_path(dname)
-        "<li #{class_if_current(path)}><a href='#{path.gsub(" ", "_")}'>#{name}</a></li>"
-      end
-
-      def tabs
-        Resque::Server.tabs
-      end
-
-      def url_prefix
-        Resque::Server.url_prefix
-      end
-
-      def redis_get_size(key)
-        case Resque.redis.type(key)
-        when 'none'
-          []
-        when 'list'
-          Resque.redis.llen(key)
-        when 'set'
-          Resque.redis.scard(key)
-        when 'string'
-          Resque.redis.get(key).length
-        when 'zset'
-          Resque.redis.zcard(key)
-        end
-      end
-
-      def redis_get_value_as_array(key, start=0)
-        case Resque.redis.type(key)
-        when 'none'
-          []
-        when 'list'
-          Resque.redis.lrange(key, start, start + 20)
-        when 'set'
-          Resque.redis.smembers(key)[start..(start + 20)]
-        when 'string'
-          [Resque.redis.get(key)]
-        when 'zset'
-          Resque.redis.zrange(key, start, start + 20)
-        end
-      end
-
-      def show_args(args)
-        Array(args).map do |a|
-          a.to_yaml
-        end.join("\n")
-      rescue
-        args.to_s
-      end
-
-      def worker_hosts
-        @worker_hosts ||= worker_hosts!
-      end
-
-      def worker_hosts!
-        hosts = Hash.new { [] }
-
-        Resque.workers.each do |worker|
-          host, _ = worker.to_s.split(':')
-          hosts[host] += [worker.to_s]
-        end
-
-        hosts
-      end
-
-      def partial?
-        @partial
-      end
-
-      def partial(template, local_vars = {})
-        @partial = true
-        erb(template.to_sym, {:layout => false}, local_vars)
-      ensure
-        @partial = false
-      end
-
-      def poll
-        if defined?(@polling) && @polling
-          text = "Last Updated: #{Time.now.strftime("%H:%M:%S")}"
-        else
-          text = "<a href='#{u(request.path_info)}.poll' rel='poll'>Live Poll</a>"
-        end
-        "<p class='poll'>#{text}</p>"
-      end
-
+      include Resque::ServerHelper
     end
 
     def show(page, layout = true)

data/lib/resque/server_helper.rb

@@ -0,0 +1,185 @@
+require 'rack/utils'
+
+module Resque
+  module ServerHelper
+    include Rack::Utils
+    alias_method :h, :escape_html
+
+    def current_section
+      url_path request.path_info.sub('/','').split('/')[0].downcase
+    end
+
+    def current_page
+      url_path request.path_info.sub('/','')
+    end
+
+    def url_path(*path_parts)
+      [ url_prefix, path_prefix, path_parts ].join("/").squeeze('/')
+    end
+    alias_method :u, :url_path
+
+    def path_prefix
+      request.env['SCRIPT_NAME']
+    end
+
+    def class_if_current(path = '')
+      'class="current"' if current_page[0, path.size] == path
+    end
+
+    def tab(name)
+      dname = name.to_s.downcase
+      path = url_path(dname)
+      "<li #{class_if_current(path)}><a href='#{path.gsub(" ", "_")}'>#{name}</a></li>"
+    end
+
+    def tabs
+      Resque::Server.tabs
+    end
+
+    def url_prefix
+      Resque::Server.url_prefix
+    end
+
+    def redis_get_size(key)
+      case Resque.redis.type(key)
+      when 'none'
+        0
+      when 'hash'
+        Resque.redis.hlen(key)
+      when 'list'
+        Resque.redis.llen(key)
+      when 'set'
+        Resque.redis.scard(key)
+      when 'string'
+        Resque.redis.get(key).length
+      when 'zset'
+        Resque.redis.zcard(key)
+      end
+    end
+
+    def redis_get_value_as_array(key, start=0)
+      case Resque.redis.type(key)
+      when 'none'
+        []
+      when 'hash'
+        Resque.redis.hgetall(key).to_a[start..(start + 20)]
+      when 'list'
+        Resque.redis.lrange(key, start, start + 20)
+      when 'set'
+        Resque.redis.smembers(key)[start..(start + 20)]
+      when 'string'
+        [Resque.redis.get(key)]
+      when 'zset'
+        Resque.redis.zrange(key, start, start + 20)
+      end
+    end
+
+    def show_args(args)
+      Array(args).map do |a|
+        a.to_yaml
+      end.join("\n")
+    rescue
+      args.to_s
+    end
+
+    def worker_hosts
+      @worker_hosts ||= worker_hosts!
+    end
+
+    def worker_hosts!
+      hosts = Hash.new { [] }
+
+      Resque.workers.each do |worker|
+        host, _ = worker.to_s.split(':')
+        hosts[host] += [worker.to_s]
+      end
+
+      hosts
+    end
+
+    def partial?
+      @partial
+    end
+
+    def partial(template, local_vars = {})
+      @partial = true
+      erb(template.to_sym, {:layout => false}, local_vars)
+    ensure
+      @partial = false
+    end
+
+    def poll
+      if defined?(@polling) && @polling
+        text = "Last Updated: #{Time.now.strftime("%H:%M:%S")}"
+      else
+        text = "<a href='#{u(request.path_info)}.poll' rel='poll'>Live Poll!!</a>"
+      end
+      "<p class='poll'>#{text}</p>"
+    end
+
+    ####################
+    #failed.erb helpers#
+    ####################
+
+    def failed_date_format
+      "%Y/%m/%d %T %z"
+    end
+
+    def failed_multiple_queues?
+      return @multiple_failed_queues if defined?(@multiple_failed_queues)
+
+      @multiple_failed_queues = Resque::Failure.queues.size > 1 ||
+        (defined?(Resque::Failure::RedisMultiQueue) && Resque::Failure.backend == Resque::Failure::RedisMultiQueue)
+    end
+
+    def failed_size
+      @failed_size ||= Resque::Failure.count(params[:queue], params[:class])
+    end
+
+    def failed_per_page
+      @failed_per_page = if params[:class]
+        failed_size
+      else
+        20
+      end
+    end
+
+    def failed_start_at
+      params[:start].to_i
+    end
+
+    def failed_end_at
+      if failed_start_at + failed_per_page > failed_size
+        failed_size
+      else
+        failed_start_at  + failed_per_page - 1
+      end
+    end
+
+    def failed_order
+      params[:order] || 'desc'
+    end
+
+    def failed_class_counts(queue = params[:queue])
+      classes = Hash.new(0)
+      Resque::Failure.each(0, Resque::Failure.count(queue), queue) do |_, item|
+        class_name = item['payload']['class'] if item['payload']
+        class_name ||= "nil"
+        classes[class_name] += 1
+      end
+      classes
+    end
+
+    def page_entries_info(start, stop, size, name = nil)
+      if size == 0
+        name ? "No #{name}s" : '<b>0</b>'
+      elsif size == 1
+        'Showing <b>1</b>' + (name ? " #{name}" : '')
+      elsif size > failed_per_page
+        "Showing #{start}-#{stop} of <b>#{size}</b>" + (name ? " #{name}s" : '')
+      else
+        "Showing #{start} to <b>#{size - 1}</b>" + (name ? " #{name}s" : '')
+      end
+    end
+  end
+end

data/lib/resque/tasks.rb

@@ -16,7 +16,7 @@ namespace :resque do
     end
 
     worker.prepare
-    worker.log "Starting worker #{self}"
+    worker.log "Starting worker #{worker}"
     worker.work(ENV['INTERVAL'] || 5) # interval, will block
   end
 

data/lib/resque/version.rb

@@ -1,3 +1,3 @@
 module Resque
-  VERSION = '2.4.0'
+  VERSION = '2.6.0'
 end

data/lib/resque/web_runner.rb

@@ -234,10 +234,10 @@ module Resque
     end
 
     def status
-      if File.exists?(pid_file)
+      if File.exist?(pid_file)
         logger.info "'#{app_name}' running"
         logger.info "PID #{File.read(pid_file)}"
-        logger.info "URL #{File.read(url_file)}" if File.exists?(url_file)
+        logger.info "URL #{File.read(url_file)}" if File.exist?(url_file)
       else
         logger.info "'#{app_name}' not running!"
       end
@@ -290,6 +290,8 @@ module Resque
               next
             end
           end
+          raise 'No available Rack handler (e.g. WEBrick, Thin, Puma, etc.) was found.' if handler.nil?
+
           handler
 
         # :server might be set explicitly to a single option like "mongrel"

data/lib/tasks/redis.rake

@@ -17,7 +17,7 @@ class RedisRunner
   end
 
   def self.config
-    @config ||= if File.exists?(redis_dir + 'etc/redis.conf')
+    @config ||= if File.exist?(redis_dir + 'etc/redis.conf')
                   redis_dir + 'etc/redis.conf'
                 else
                   redis_dir + '../etc/redis.conf'
@@ -30,7 +30,7 @@ class RedisRunner
 
   # Just check for existance of dtach socket
   def self.running?
-    File.exists? dtach_socket
+    File.exist? dtach_socket
   end
 
   def self.start
@@ -90,10 +90,10 @@ namespace :redis do
 
     if ENV['PREFIX']
       bin_dir = "#{ENV['PREFIX']}/bin"
-      sh "mkdir -p #{bin_dir}" unless File.exists?("#{bin_dir}")
+      sh "mkdir -p #{bin_dir}" unless File.exist?("#{bin_dir}")
 
       conf_dir = "#{ENV['PREFIX']}/etc"
-      sh "mkdir -p #{conf_dir}" unless File.exists?("#{conf_dir}")
+      sh "mkdir -p #{conf_dir}" unless File.exist?("#{conf_dir}")
     end
 
     %w(redis-benchmark redis-cli redis-server).each do |bin|
@@ -102,7 +102,7 @@ namespace :redis do
 
     puts "Installed redis-benchmark, redis-cli and redis-server to #{bin_dir}"
 
-    unless File.exists?("#{conf_dir}/redis.conf")
+    unless File.exist?("#{conf_dir}/redis.conf")
       sh "cp #{INSTALL_DIR}/redis.conf #{conf_dir}/redis.conf"
       puts "Installed redis.conf to #{conf_dir} \n You should look at this file!"
     end
@@ -115,9 +115,9 @@ namespace :redis do
 
   desc "Download package"
   task :download do
-    sh "rm -rf #{INSTALL_DIR}/" if File.exists?("#{INSTALL_DIR}/.svn")
-    sh "git clone git://github.com/antirez/redis.git #{INSTALL_DIR}" unless File.exists?(INSTALL_DIR)
-    sh "cd #{INSTALL_DIR} && git pull" if File.exists?("#{INSTALL_DIR}/.git")
+    sh "rm -rf #{INSTALL_DIR}/" if File.exist?("#{INSTALL_DIR}/.svn")
+    sh "git clone git://github.com/antirez/redis.git #{INSTALL_DIR}" unless File.exist?(INSTALL_DIR)
+    sh "cd #{INSTALL_DIR} && git pull" if File.exist?("#{INSTALL_DIR}/.git")
   end
 end
 
@@ -135,7 +135,7 @@ namespace :dtach do
 
     if ENV['PREFIX']
       bin_dir = "#{ENV['PREFIX']}/bin"
-      sh "mkdir -p #{bin_dir}" unless File.exists?("#{bin_dir}")
+      sh "mkdir -p #{bin_dir}" unless File.exist?("#{bin_dir}")
     end
 
     sh "cp #{INSTALL_DIR}/dtach-0.8/dtach #{bin_dir}"
@@ -147,7 +147,7 @@ namespace :dtach do
 
   desc "Download package"
   task :download do
-    unless File.exists?("#{INSTALL_DIR}/dtach-0.8.tar.gz")
+    unless File.exist?("#{INSTALL_DIR}/dtach-0.8.tar.gz")
       require 'net/http'
 
       url = 'http://downloads.sourceforge.net/project/dtach/dtach/0.8/dtach-0.8.tar.gz'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Chris Wanstrath
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
@@ -145,7 +145,6 @@ files:
 - lib/resque/plugin.rb
 - lib/resque/railtie.rb
 - lib/resque/server.rb
-- lib/resque/server/helpers.rb
 - lib/resque/server/public/favicon.ico
 - lib/resque/server/public/idle.png
 - lib/resque/server/public/jquery-3.6.0.min.js
@@ -156,7 +155,6 @@ files:
 - lib/resque/server/public/reset.css
 - lib/resque/server/public/style.css
 - lib/resque/server/public/working.png
-- lib/resque/server/test_helper.rb
 - lib/resque/server/views/error.erb
 - lib/resque/server/views/failed.erb
 - lib/resque/server/views/failed_job.erb
@@ -172,6 +170,7 @@ files:
 - lib/resque/server/views/stats.erb
 - lib/resque/server/views/workers.erb
 - lib/resque/server/views/working.erb
+- lib/resque/server_helper.rb
 - lib/resque/stat.rb
 - lib/resque/tasks.rb
 - lib/resque/thread_signal.rb
@@ -203,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Resque is a Redis-backed queueing system.

data/lib/resque/server/helpers.rb

@@ -1,66 +0,0 @@
-Resque::Server.helpers do
-  ####################
-  #failed.erb helpers#
-  ####################
-
-  def failed_date_format
-    "%Y/%m/%d %T %z"
-  end
-
-  def failed_multiple_queues?
-    return @multiple_failed_queues if defined?(@multiple_failed_queues)
-
-    @multiple_failed_queues = Resque::Failure.queues.size > 1 ||
-      (defined?(Resque::Failure::RedisMultiQueue) && Resque::Failure.backend == Resque::Failure::RedisMultiQueue)
-  end
-
-  def failed_size
-    @failed_size ||= Resque::Failure.count(params[:queue], params[:class])
-  end
-
-  def failed_per_page
-    @failed_per_page = if params[:class]
-      failed_size
-    else
-      20
-    end
-  end
-
-  def failed_start_at
-    params[:start].to_i
-  end
-
-  def failed_end_at
-    if failed_start_at + failed_per_page > failed_size
-      failed_size
-    else
-      failed_start_at  + failed_per_page - 1
-    end
-  end
-
-  def failed_order
-    params[:order] || 'desc'
-  end
-
-  def failed_class_counts(queue = params[:queue])
-    classes = Hash.new(0)
-    Resque::Failure.each(0, Resque::Failure.count(queue), queue) do |_, item|
-      class_name = item['payload']['class'] if item['payload']
-      class_name ||= "nil"
-      classes[class_name] += 1
-    end
-    classes
-  end
-
-  def page_entries_info(start, stop, size, name = nil)
-    if size == 0
-      name ? "No #{name}s" : '<b>0</b>'
-    elsif size == 1
-      'Showing <b>1</b>' + (name ? " #{name}" : '')
-    elsif size > failed_per_page
-      "Showing #{start}-#{stop} of <b>#{size}</b>" + (name ? " #{name}s" : '')
-    else
-      "Showing #{start} to <b>#{size - 1}</b>" + (name ? " #{name}s" : '')
-    end
-  end
-end

data/lib/resque/server/test_helper.rb

@@ -1,19 +0,0 @@
-require 'rack/test'
-require 'resque/server'
-
-module Resque
-  module TestHelper
-    class Test::Unit::TestCase
-      include Rack::Test::Methods
-      def app
-        Resque::Server.new
-      end
-
-      def self.should_respond_with_success
-        test "should respond with success" do
-          assert last_response.ok?, last_response.errors
-        end
-      end
-    end
-  end
-end