resque-pause 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa53cc76d2dea849b41cb3af8e9e3c855bbe64e9
-  data.tar.gz: 5988024024f1cbc5281d237993a709aab47668ca
+  metadata.gz: 556f2192f7d4152f2c36c6c9d025da63a284007b
+  data.tar.gz: 23889f55a4772fdae025deffb73f42f67f814526
 SHA512:
-  metadata.gz: d2dccaec7ed9e26b9f61a8c47732a9b82e3ed90e67814655d10241a14b856372b2856b5c24f5f8e26c947cf132618feff8e70217e7b87f7abd5039b60940790f
-  data.tar.gz: a9efbe8ed2763e602bd37c09241fd1721e396586fb473383587d2dabc7609f0f4aa39084807946ed3eddb78e34abbad8c6530533dd3be555ecd2f297c838b178
+  metadata.gz: e9a4cd7579bc9b8d502bdaa117c1b3194c8fb50c699b1d871a0f94ac9507bd607cecfd2c8894328d4dfc3d3e515ac34020e52ca5bb74f41cbcbbca4b3ac1386d
+  data.tar.gz: ff0095a087c12613175dfbf4edcf8201272192a466170a6f63f0eab54ea7b620d8cc51384b46bca30a631e7b5b2ee77420e33e996d14f99cecb73e9299bdc007

data/.gitignore

@@ -4,3 +4,6 @@ pkg/*
 coverage/*
 .rvmrc
 .project
+spec/dump.rdb
+spec/stdout
+vendor/*

data/Gemfile

@@ -6,11 +6,11 @@ gemspec
 gem "rake"
 
 group :test, :development do
-  platforms :mri_19, :mri_20 do
+  platforms :mri_19 do
     gem "debugger"
   end
 
-  platforms :mri_21 do
+  platforms :mri_20, :mri_21 do
     gem "byebug"
   end
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    resque-pause (0.1.0)
+    resque-pause (0.2.0)
       multi_json (~> 1.0)
       resque (>= 1.9.10)
 
@@ -12,12 +12,7 @@ GEM
       columnize (~> 0.8)
       debugger-linecache (~> 1.2)
     columnize (0.8.9)
-    debugger (1.6.8)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.3.5)
     debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.3.5)
     diff-lcs (1.2.5)
     docile (1.1.5)
     mono_logger (1.1.0)
@@ -28,10 +23,10 @@ GEM
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.3.2)
-    redis (3.1.0)
-    redis-namespace (1.5.1)
+    redis (3.3.0)
+    redis-namespace (1.5.2)
       redis (~> 3.0, >= 3.0.4)
-    resque (1.25.2)
+    resque (1.26.0)
       mono_logger (~> 1.0)
       multi_json (~> 1.0)
       redis-namespace (~> 1.3)
@@ -54,10 +49,10 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    sinatra (1.4.5)
-      rack (~> 1.4)
+    sinatra (1.4.7)
+      rack (~> 1.5)
       rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
+      tilt (>= 1.3, < 3)
     tilt (1.4.1)
     vegas (0.1.11)
       rack (>= 1.0.0)
@@ -73,3 +68,6 @@ DEPENDENCIES
   resque-pause!
   rspec (>= 2.3.0)
   simplecov (>= 0.4.2)
+
+BUNDLED WITH
+   1.12.4

data/README.md

@@ -18,20 +18,57 @@ Usage / Examples
 
 ### Single Job Instance
 
-    require 'resque-pause'
+```ruby
+require 'resque-pause'
+
+class UpdateNetworkGraph
+  extend Resque::Plugins::Pause
+  @queue = :network_graph
+
+  def self.perform(repo_id)
+    heavy_lifting
+  end
+end
+```
+
+### Pausing Individual Queues
+
+To pause the queue:
+
+```ruby
+ResquePauseHelper.pause(:network_graph)
+```
+
+Then, to unpause the queue:
+
+```ruby
+ResquePauseHelper.unpause(:network_graph)
+```
+
+Single-queue pause is achieved by storing a pause/queue key in Redis.
+
 
-    class UpdateNetworkGraph
-      extend Resque::Plugins::Pause
-      @queue = :network_graph
+### Global Pause
 
-      def self.perform(repo_id)
-        heavy_lifting
-      end
-    end
+You can also pause all the queues at once.
 
-Pause is achieved by storing a pause/queue key in Redis.
+To switch on a global pause:
 
-Default behaviour...
+```ruby
+ResquePauseHelper.global_pause()
+```
+
+Then, to remove a global pause:
+
+```ruby
+ResquePauseHelper.global_unpause()
+```
+
+This global pause doesn't interact with any pauses on individual queues. That means, switching the global pause on and off should preserve whatever pauses you might have in place before and even during the global pause period.
+
+An anology would be with light switches and circuit breakers. Positioning light switches is like pausing individual queues. Whatever their position before you flip the breaker (impose a global pause). They'll maintain that position after the global pause.
+
+### Default behaviour
 
 * When the job instance try to execute and the queue is paused, the job is paused for a slice of time.
 * If the queue still paused after this time the job will abort and will be enqueued again with the same arguments.
@@ -43,7 +80,7 @@ Resque-Web integration
 You have to load ResquePause to enable the Pause tab.
 
 ```ruby
-    require 'resque-pause/server'
+require 'resque-pause/server'
 ```
 
 Customise & Extend
@@ -58,23 +95,34 @@ By default the time is 10 seconds.
 
 You can define the attribute in your job class in seconds.
 
-    class UpdateNetworkGraph
-      extend Resque::Plugins::Pause
-      @queue = :network_graph
-      @pause_check_interval = 30
-
-      def self.perform(repo_id)
-        heavy_lifting
-      end
-    end
+```ruby
+class UpdateNetworkGraph
+  extend Resque::Plugins::Pause
+  @queue = :network_graph
+  @pause_check_interval = 30
+
+  def self.perform(repo_id)
+    heavy_lifting
+  end
+end
+```
 
 The above modification will ensure the job will wait for 30 seconds before abort.
 
+### Global pause Redis key
+
+To change the exact key that will be put into redis to signal a global pause, use the `global_pause_key` config
+
+````ruby
+ResquePauseHelper.global_pause_key = "my_custom_key"
+````
 
 Install
 =======
 
-    $ gem install resque-pause
+```bash
+$ gem install resque-pause
+```
 
 [rq]: http://github.com/defunkt/resque
 [resque-pause]: https://github.com/wandenberg/resque-pause

data/lib/resque-pause/server.rb

@@ -23,22 +23,46 @@ module ResquePause
           def paused?(queue)
             ResquePauseHelper.paused?(queue)
           end
+
+          def global_paused?
+            ResquePauseHelper.global_paused?
+          end
         end
 
         mime_type :json, 'application/json'
 
         get '/pause' do
-          erb File.read(ResquePause::Server.erb_path('pause.erb'))
+          case request.accept.first
+          when /json/
+            content_type :json
+            resque.queues.inject({"GLOBAL_PAUSE" => ResquePauseHelper.global_paused?}) do |pause_status, queue|
+              pause_status[queue] = ResquePauseHelper.paused?(queue)
+              pause_status
+            end.to_json
+          else
+            erb File.read(ResquePause::Server.erb_path('pause.erb'))
+          end
         end
 
         post '/pause' do
-          pause = params['pause'] == "true"
+          params.merge!(MultiJson.load(request.body.read.to_s)) if /json/ =~ request.content_type
+
+          pause = params['pause'].to_s == "true"
 
           unless params['queue_name'].empty?
-            if pause
-              ResquePauseHelper.pause(params['queue_name'])
+            case params['queue_name']
+            when "GLOBAL_PAUSE"
+              if pause
+                ResquePauseHelper.global_pause
+              else
+                ResquePauseHelper.global_unpause
+              end
             else
-              ResquePauseHelper.unpause(params['queue_name'])
+              if pause
+                ResquePauseHelper.pause(params['queue_name'])
+              else
+                ResquePauseHelper.unpause(params['queue_name'])
+              end
             end
           end
           content_type :json

data/lib/resque-pause/server/public/pause.js

@@ -8,7 +8,12 @@ jQuery(document).ready(function($) {
 		  data: data,
 		  async: false,
 		  cache: false,
-		  success: function() { return true; },
+		  success: function() {
+		    if (queue.val() === "GLOBAL_PAUSE") {
+		      location.reload();
+		    }
+		    return true;
+		  },
 		  error: function() { return false; },
 		  dataType: 'json'
 		});

data/lib/resque-pause/server/views/pause.erb

@@ -15,4 +15,10 @@
     <td class='size'><%= resque.size queue %></td>
   </tr>
   <% end %>
+  <tr><td class='queue'>&nbsp;</td><td class='status'></td><td class='size'></td></tr>
+  <tr>
+    <td class='queue'><b><i>GLOBAL PAUSE</i></b></td>
+    <td class='status'><input class="pause" type="checkbox" value="GLOBAL_PAUSE" <%= "checked" if global_paused? %>></input></td>
+    <td class='size'>-</td>
+  </tr>
 </table>

data/lib/resque_pause_helper.rb

@@ -10,8 +10,10 @@ end
 
 module ResquePauseHelper
   class << self
+    DEFAULT_GLOBAL_PAUSE_KEY = "pause:all"
+
     def paused?(queue)
-      !Resque.redis.get("pause:queue:#{queue}").nil?
+      !Resque.redis.mget("pause:queue:#{queue}", global_pause_key).all?(&:nil?)
     end
 
     def pause(queue)
@@ -22,6 +24,18 @@ module ResquePauseHelper
       Resque.redis.del "pause:queue:#{queue}"
     end
 
+    def global_pause()
+      Resque.redis.set global_pause_key, true
+    end
+
+    def global_unpause()
+      Resque.redis.del global_pause_key
+    end
+
+    def global_paused?()
+      !!Resque.redis.get(global_pause_key)
+    end
+
     def enqueue_job(args)
       Resque.redis.lpush("queue:#{args[:queue]}", ResquePauseHelper.encode(:class => args[:class].to_s, :args => args[:args]))
     end
@@ -41,5 +55,13 @@ module ResquePauseHelper
         MultiJson.encode object
       end
     end
+
+    def global_pause_key=(key)
+      @global_pause_key = key
+    end
+
+    def global_pause_key
+      @global_pause_key ||= DEFAULT_GLOBAL_PAUSE_KEY
+    end
   end
 end

data/lib/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module Pause
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/spec/resque-pause/plugins/pause_spec.rb

@@ -46,6 +46,83 @@ describe Resque::Plugins::Pause do
     expect(Resque.reserve('test')).to be_nil
   end
 
+  it "should execute the job when queue is unpaused after being paused" do
+    Resque.enqueue(PauseJob)
+    expect(Resque.size('test')).to eq(1)
+
+    job = Resque.reserve('test')
+    ResquePauseHelper.pause('test')
+    job.perform
+    expect(Resque.size('test')).to eq(1)
+
+    ResquePauseHelper.unpause('test')
+
+    expect(PauseJob).to receive(:perform)
+    Resque.reserve('test').perform
+    expect(Resque.size('test')).to eq(0)
+  end
+
+  it "should not reserve the job when global pause is on" do
+    Resque.enqueue(PauseJob)
+    ResquePauseHelper.global_pause()
+    expect(PauseJob).not_to receive(:perform)
+
+    expect(Resque.reserve('test')).to be_nil
+  end
+
+  it "should not execute the job when the global pause is on" do
+    Resque.enqueue(PauseJob)
+    expect(Resque.size('test')).to eq(1)
+
+    job = Resque.reserve('test')
+    ResquePauseHelper.global_pause()
+    job.perform
+
+    expect(Resque.size('test')).to eq(1)
+  end
+
+  it "should execute the job when the global pause was switched on and then off" do
+    Resque.enqueue(PauseJob)
+    expect(Resque.size('test')).to eq(1)
+
+    job = Resque.reserve('test')
+    ResquePauseHelper.global_pause()
+    job.perform
+    expect(Resque.size('test')).to eq(1)
+
+    ResquePauseHelper.global_unpause()
+
+    expect(PauseJob).to receive(:perform)
+    Resque.reserve('test').perform
+    expect(Resque.size('test')).to eq(0)
+  end
+
+  it "should not execute the job when the queue is paused, and then the global pause is switched on and then back off" do
+    Resque.enqueue(PauseJob)
+    expect(Resque.size('test')).to eq(1)
+
+    job = Resque.reserve('test')
+    ResquePauseHelper.pause('test')
+
+    ResquePauseHelper.global_pause()
+    ResquePauseHelper.global_unpause()
+
+    job.perform
+
+    expect(Resque.size('test')).to eq(1)
+  end
+
+  it "should not reserve the job when the queue is paused, and then the global pause is switched on and then back off" do
+    Resque.enqueue(PauseJob)
+    ResquePauseHelper.pause('test')
+    ResquePauseHelper.global_pause()
+    ResquePauseHelper.global_unpause()
+
+    expect(PauseJob).not_to receive(:perform)
+
+    expect(Resque.reserve('test')).to be_nil
+  end
+
   it "should not change queued jobs when queue is paused" do
     Resque.enqueue(PauseJob, 1)
     Resque.enqueue(PauseJob, 2)
@@ -73,4 +150,57 @@ describe Resque::Plugins::Pause do
     expect(Resque.size('test')).to eq(0)
   end
 
+  it "should allow the global pause key to be configurable" do
+    pause_key = "my_new_pause_key"
+
+    ResquePauseHelper.global_pause_key = pause_key
+
+    Resque.enqueue(PauseJob)
+    ResquePauseHelper.global_pause()
+
+    expect(Resque.redis.get(pause_key)).not_to be_nil
+  end
+
+  it "should still handle global pauses with a client-configured key" do
+    pause_key = "my_new_pause_key"
+
+    ResquePauseHelper.global_pause_key = pause_key
+
+    Resque.enqueue(PauseJob)
+    expect(Resque.size('test')).to eq(1)
+
+    job = Resque.reserve('test')
+    ResquePauseHelper.global_pause()
+    job.perform
+
+    expect(Resque.size('test')).to eq(1)
+  end
+
+  it "should still handle switching global pauses back off with a client-configured key" do
+    pause_key = "my_new_pause_key"
+
+    ResquePauseHelper.global_pause_key = pause_key
+
+    Resque.enqueue(PauseJob)
+    expect(Resque.size('test')).to eq(1)
+
+    job = Resque.reserve('test')
+    ResquePauseHelper.global_pause()
+    job.perform
+    expect(Resque.size('test')).to eq(1)
+
+    ResquePauseHelper.global_unpause()
+
+    expect(PauseJob).to receive(:perform)
+    Resque.reserve('test').perform
+    expect(Resque.size('test')).to eq(0)
+  end
+
+  it "should indicate whether the global pause is on" do
+    expect(ResquePauseHelper.global_paused?).to be false
+    ResquePauseHelper.global_pause()
+    expect(ResquePauseHelper.global_paused?).to be true
+    ResquePauseHelper.global_unpause()
+    expect(ResquePauseHelper.global_paused?).to be false
+  end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: resque-pause
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wandenberg Peixoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-23 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.10
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
 description: |-
@@ -93,8 +93,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Changelog.md
 - Gemfile
 - Gemfile.lock
@@ -124,17 +124,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: resque-pause
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Resque plugin to add functionality to pause resque jobs through the web