resque-cleaner 0.2.12 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTcwYzM2YTgyOGI5ZDI2OWM0MzM2YjM5ODU2NGI4N2NiN2ZiZDFhYg==
+    MWNmOTljMTBiYjM2YzA4NmZjOTU2ZTY5NDYwODdhYTQwYmNkNjIzMQ==
   data.tar.gz: !binary |-
-    NDc1YjU5MWYwNDk4MzJjOGZmZjFjOGQ2MzJkMmEyMzY5NDk0Y2JmZQ==
+    NjIzNzI2MGQ2YjMxNTYyZDZhZTE0NWI4NDViNTZiNTdiNDU1NmJmZg==
 SHA512:
   metadata.gz: !binary |-
-    MzIzMTNjNmE5ZjMwZmE2YmM2YzJhYzJlNjQyMWRhMDU2NTUyM2JhYzc0MGUy
-    NWRhZGI5ZTUyMWY5ZTVjMjBmNWJjNjdkYmEzNDIzODA2MzBjNzViZmRmYmMy
-    ZjI2NWViZjJjMjFkYmQ4MGRkOGQ2MzdjNjdmODNhYjlkNTFmNzM=
+    Y2Q0NTQ3NWYwNzk2MDc5NjQ0MDVkOGMwZjZkYmUzZTY1MjlmZjRiMDcyNWQ3
+    ZTBlMzEyMWIxM2RmNzBkODBmNGFmOWQ2M2ZjZGJlYTRhNDIzZTYwMTVlMzQx
+    ZWU4ODViOGNhNjMxN2RkZGQwZmE2YzliNDA4YjcxOGUxM2I1ODA=
   data.tar.gz: !binary |-
-    MDZlMTQyNzQ0Y2MyZWQyZDMzNjNjYzVlOGVhNjM4NWFjMDQ2MTEyNDE5NDY2
-    NDdhM2U5MDk3YWYzNjY4M2E3MjU2MGMyZmRkY2Y4ZDA0MzdjMWQ5MGM3YmI1
-    MGM2NGE1YzZkOGIwMjViZjAwMDY4NmNmNWMyZGM4ZDIzYjVlMjk=
+    YzkzNjI4NmExNTE3MmZkNzE2ZjNjZTVmNzRmZDRiYWQwY2VjZmEwN2MxZjUw
+    NjMxZmJjNzViZmM2ZDExMThlNjNmOTYyYjRjMzZhNDgzMDlmZmYyNWZmNzIx
+    YTE1N2Q5MzE0YWQ0Y2QxMjA1NmZlYTQyY2MyMGRlNWRiOWJlYTQ=

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.3.0 (2014-05-27)
+
+* Search by regex (#27)
+* Show stats by exception (#29)
+* Stop supporting ruby 1.8.x and 1.9.2
+* Escape query parameters (#30)
+
 ## 0.2.12 (2013-12-03)
 
 * Remove Resque::Helpers include (#23)

data/README.md

@@ -27,7 +27,7 @@ Resque-Web integration
 ----------------------
 
 ![Screen 1](https://github.com/ono/resque-cleaner/raw/master/misc/resque-cleaner-main.png)
-![Screen 2](https://github.com/ono/resque-cleaner/raw/master/misc/resque-cleaner-list.png)
+![Screen 2](misc/resque-cleaner-list-with-regex.png)
 
 
 Configuration
@@ -117,6 +117,13 @@ e.g. Show stats only of jobs entered with some arguments:
     => {'2009/03/10' => 3, ...}
 ```
 
+A convenience helper for searching for failed jobs which satisfy a
+regular expression:
+
+```ruby
+cleaner.select_by_regex(/Jason/) # => all failed jobs that have "Jason" in them
+```
+
 **Retry(Requeue) Jobs**
 
 You can retry all failed jobs with this method.

data/lib/resque_cleaner.rb

@@ -90,6 +90,12 @@ module Resque
       end
       alias :failure_jobs :select
 
+      def select_by_regex(regex)
+        select do |job|
+          job.to_s =~ regex
+        end
+      end
+
       # Clears every jobs for which block evaluates to true.
       def clear(&block)
         cleared = 0

data/lib/resque_cleaner/server.rb

@@ -103,6 +103,11 @@ module ResqueCleaner
           def show_job_args(args)
             Array(args).map { |a| a.inspect }.join("\n")
           end
+
+          def text_filter(id, name, value)
+            html = "<input id=\"#{id}\"  type=\"text\" name=\"#{name}\" value=\"#{value}\">"
+            html += "</input>"
+          end
         end
 
         mime_type :json, 'application/json'
@@ -112,24 +117,27 @@ module ResqueCleaner
           load_cleaner_filter
 
           @jobs = cleaner.select
-          @stats, @total = {}, {"total" => 0, "1h" => 0, "3h" => 0, "1d" => 0, "3d" => 0, "7d" => 0}
+          @stats = { :klass => {}, :exception => {} }
+          @total = Hash.new(0)
           @jobs.each do |job|
-            klass = if job["payload"] && job["payload"]["class"]
-              job["payload"]["class"]
-            else
-              "UNKNOWN"
-            end
+            klass = job["payload"]["class"] || 'UNKNOWN'
+            exception = job["exception"] || 'UNKNOWN'
             failed_at = Time.parse job["failed_at"]
-
-            @stats[klass] ||= {"total" => 0, "1h" => 0, "3h" => 0, "1d" => 0, "3d" => 0, "7d" => 0}
-            items = [@stats[klass],@total]
-
-            items.each{|a| a["total"] += 1}
-            items.each{|a| a["1h"] += 1} if failed_at >= hours_ago(1)
-            items.each{|a| a["3h"] += 1} if failed_at >= hours_ago(3)
-            items.each{|a| a["1d"] += 1} if failed_at >= hours_ago(24)
-            items.each{|a| a["3d"] += 1} if failed_at >= hours_ago(24*3)
-            items.each{|a| a["7d"] += 1} if failed_at >= hours_ago(24*7)
+            @stats[:klass][klass] ||= Hash.new(0)
+            @stats[:exception][exception] ||= Hash.new(0)
+
+            [
+              @stats[:klass][klass],
+              @stats[:exception][exception],
+              @total
+            ].each do |stat|
+              stat[:total] += 1
+              stat[:h1] += 1 if failed_at >= hours_ago(1)
+              stat[:h3] += 1 if failed_at >= hours_ago(3)
+              stat[:d1] += 1 if failed_at >= hours_ago(24)
+              stat[:d3] += 1 if failed_at >= hours_ago(24*3)
+              stat[:d7] += 1 if failed_at >= hours_ago(24*7)
+            end
           end
 
           erb File.read(ResqueCleaner::Server.erb_path('cleaner.erb'))
@@ -138,14 +146,13 @@ module ResqueCleaner
         get "/cleaner_list" do
           load_library
           load_cleaner_filter
+          build_urls
 
           block = filter_block
 
           @failed = cleaner.select(&block).reverse
 
-          url = "cleaner_list?c=#{@klass}&ex=#{@exception}&f=#{@from}&t=#{@to}"
-          @dump_url = "cleaner_dump?c=#{@klass}&ex=#{@exception}&f=#{@from}&t=#{@to}"
-          @paginate = Paginate.new(@failed, url, params[:p].to_i)
+          @paginate = Paginate.new(@failed, @list_url, params[:p].to_i)
 
           @klasses = cleaner.stats_by_class.keys
           @exceptions = cleaner.stats_by_exception.keys
@@ -157,6 +164,7 @@ module ResqueCleaner
         post "/cleaner_exec" do
           load_library
           load_cleaner_filter
+          build_urls
 
           if params[:select_all_pages]!="1"
             @sha1 = {}
@@ -172,7 +180,6 @@ module ResqueCleaner
             when "retry" then cleaner.requeue(false,{},&block)
             end
 
-          @url = "cleaner_list?c=#{@klass}&ex=#{@exception}&f=#{@from}&t=#{@to}"
           erb File.read(ResqueCleaner::Server.erb_path('cleaner_exec.erb'))
         end
 
@@ -219,6 +226,20 @@ module ResqueCleaner
       @to = params[:t]=="" ? nil : params[:t]
       @klass = params[:c]=="" ? nil : params[:c]
       @exception = params[:ex]=="" ? nil : params[:ex]
+      @regex = params[:regex]=="" ? nil : params[:regex]
+    end
+
+    def build_urls
+      params = {
+        c: @klass,
+        ex: @exception,
+        f: @from,
+        t: @to,
+        regex: @regex
+      }.map {|key,value| "#{key}=#{URI.encode(value.to_s)}"}.join("&")
+
+      @list_url = "cleaner_list?#{params}"
+      @dump_url = "cleaner_dump?#{params}"
     end
 
     def filter_block
@@ -227,7 +248,8 @@ module ResqueCleaner
         (!@to || j.before?(hours_ago(@to))) &&
         (!@klass || j.klass?(@klass)) &&
         (!@exception || j.exception?(@exception)) &&
-        (!@sha1 || @sha1[Digest::SHA1.hexdigest(j.to_json)])
+        (!@sha1 || @sha1[Digest::SHA1.hexdigest(j.to_json)]) &&
+        (!@regex || j.to_s =~ /#{@regex}/)
       }
     end
 

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

@@ -0,0 +1,44 @@
+<table class="class_list">
+  <tr>
+    <th><%= type.gsub('klass','class').capitalize %></th>
+    <th>Failed</th>
+    <th>In last 1 hour</th>
+    <th>In last 3 hours</th>
+    <th>In last 24 hours</th>
+    <th>In last 3 days</th>
+    <th>In last 7 days</th>
+  </tr>
+  <% @stats[type.to_sym].each do |field,count| %>
+    <tr>
+      <% filter = "#{q}=#{URI.encode(field)}" %>
+      <td><%= field %></td>
+      <td class="number">
+        <a href="cleaner_list?<%=filter%>"><%= count[:total] %></a>
+      </td>
+      <td class="number">
+        <a href="cleaner_list?<%=filter%>&f=1"><%= count[:h1] %></a>
+      </td>
+      <td class="number">
+        <a href="cleaner_list?<%=filter%>&f=3"><%= count[:h3] %></a>
+      </td>
+      <td class="number">
+        <a href="cleaner_list?<%=filter%>&f=24"><%= count[:d1] %></a>
+      </td>
+      <td class="number">
+        <a href="cleaner_list?<%=filter%>&f=72"><%= count[:d3] %></a>
+      </td>
+      <td class="number">
+        <a href="cleaner_list?<%=filter%>&f=168"><%= count[:d7] %></a>
+      </td>
+    </tr>
+  <% end %>
+  <tr class="total">
+    <td>Total</td>
+    <td class="number"><a href="cleaner_list"><%= @total[:total] %></a></td>
+    <td class="number"><a href="cleaner_list?f=1"><%= @total[:h1] %></a></td>
+    <td class="number"><a href="cleaner_list?f=3"><%= @total[:h3] %></a></td>
+    <td class="number"><a href="cleaner_list?f=24"><%= @total[:d1] %></a></td>
+    <td class="number"><a href="cleaner_list?f=72"><%= @total[:d3] %></a></td>
+    <td class="number"><a href="cleaner_list?f=168"><%= @total[:d7] %></a></td>
+  </tr>
+</table>

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

@@ -2,40 +2,22 @@
 
 <div class="cleaner">
   <div class="title clearfix">
-    <h1>Job Classes Failed</h1>
+    <h1>Group by class</h1>
   </div>
 
-  <table class="class_list">
-    <tr>
-      <th>Class</th>
-      <th>Failed</th>
-      <th>In last 1 hour</th>
-      <th>In last 3 hours</th>
-      <th>In last 24 hours</th>
-      <th>In last 3 days</th>
-      <th>In last 7 days</th>
-    </tr>
-    <% @stats.each do |klass,count| %>
-      <tr>
-        <td><%= klass %></td>
-        <td class="number"><a href="cleaner_list?c=<%=klass%>"><%= count["total"] %></a></td>
-        <td class="number"><a href="cleaner_list?c=<%=klass%>&f=1"><%= count["1h"] %></a></td>
-        <td class="number"><a href="cleaner_list?c=<%=klass%>&f=3"><%= count["3h"] %></a></td>
-        <td class="number"><a href="cleaner_list?c=<%=klass%>&f=24"><%= count["1d"] %></a></td>
-        <td class="number"><a href="cleaner_list?c=<%=klass%>&f=72"><%= count["3d"] %></a></td>
-        <td class="number"><a href="cleaner_list?c=<%=klass%>&f=168"><%= count["7d"] %></a></td>
-      </tr>
-    <% end %>
-    <tr class="total">
-      <td>Total</td>
-      <td class="number"><a href="cleaner_list"><%= @total["total"] %></a></td>
-      <td class="number"><a href="cleaner_list?f=1"><%= @total["1h"] %></a></td>
-      <td class="number"><a href="cleaner_list?f=3"><%= @total["3h"] %></a></td>
-      <td class="number"><a href="cleaner_list?f=24"><%= @total["1d"] %></a></td>
-      <td class="number"><a href="cleaner_list?f=72"><%= @total["3d"] %></a></td>
-      <td class="number"><a href="cleaner_list?f=168"><%= @total["7d"] %></a></td>
-    </tr>
-  </table>
+  <%= erb(
+        File.read(ResqueCleaner::Server.erb_path("_stats.erb")),
+        locals: {q: 'c', type: 'klass'}
+      ) %>
+
+  <div class="title clearfix">
+    <h1>Group by exception</h1>
+  </div>
+
+  <%= erb(
+        File.read(ResqueCleaner::Server.erb_path("_stats.erb")),
+        locals: {q: 'ex', type: 'exception'}
+      ) %>
 
   <% if @cleaner.limiter.on? %>
     <%= erb File.read(ResqueCleaner::Server.erb_path("_limiter.erb")) %>

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

@@ -3,6 +3,6 @@
 <div class="cleaner">
   <p class="message">Processed <%= @count %> jobs.</p>
   <p class="back_to_list">
-  <a href="<%=@url%>">Back to List</a>
+  <a href="<%=@list_url%>">Back to List</a>
   </p>
 </div>

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

@@ -21,6 +21,9 @@
         <span class="time_filter">
           To: <%= time_filter("filter_to","t",@to)%>
         </span>
+        <span class="regex_filter">
+          Regex: <%= text_filter("filter_regex", "regex", Rack::Utils.escape_html(@regex))%>
+        </span>
         <input type="submit" value="Filter" />
       </form>
     </div>

data/test/resque_cleaner_test.rb

@@ -28,6 +28,18 @@ context "ResqueCleaner" do
     @cleaner.print_message = false
   end
 
+  test "#select_by_regex returns only Jason jobs" do
+    ret = @cleaner.select_by_regex(/Jason/)
+    assert_equal 13, ret.size
+  end
+
+  test "#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
+
   test "#select returns failure jobs" do
     ret = @cleaner.select
     assert_equal 42, ret.size

data/test/resque_web_test.rb

@@ -10,6 +10,8 @@ def setup_some_failed_jobs
 
   @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}"
   }
@@ -24,8 +26,9 @@ context "resque-web" do
   end
 
   test "#cleaner should respond with success" do
-    get "/cleaner_list"
-    assert last_response.ok?, last_response.errors
+    get "/cleaner"
+    assert last_response.body.include?('BadJob')
+    assert last_response.body =~ /\bException\b/
   end
 
   test "#cleaner_list should respond with success" do
@@ -38,9 +41,16 @@ context "resque-web" do
     assert last_response.body.include?('BadJob')
   end
 
+  test "#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
+
+
   test '#cleaner_exec clears job' do
     post "/cleaner_exec", :action => "clear", :sha1 => Digest::SHA1.hexdigest(@cleaner.select[0].to_json)
-    assert_equal 9, @cleaner.select.size
+    assert_equal 10, @cleaner.select.size
   end
   test "#cleaner_dump should respond with success" do
     get "/cleaner_dump"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-cleaner
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.3.0
 platform: ruby
 authors:
 - Tatsuya Ono
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -43,6 +43,7 @@ files:
 - lib/resque_cleaner/server/public/cleaner.css
 - lib/resque_cleaner/server/views/_limiter.erb
 - lib/resque_cleaner/server/views/_paginate.erb
+- lib/resque_cleaner/server/views/_stats.erb
 - lib/resque_cleaner/server/views/cleaner.erb
 - lib/resque_cleaner/server/views/cleaner_exec.erb
 - lib/resque_cleaner/server/views/cleaner_list.erb
@@ -65,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='