resque-change_queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7d127b9f55f4c625fe6c7f10a2811aac5ef6d0b
+  data.tar.gz: 58d019ef9c238d2e2584853a0aa0a6c995a12b03
+SHA512:
+  metadata.gz: 88e871ec894e8203ad4b1251bb54bf9307dd7af3827be524aec18d1d76f29c4f0ecdee86ff62e73d7bb90ca2b74d5c7626e0ec9dd75157eaa253eafa5daf9003
+  data.tar.gz: 576377b4f03a53ea5e71baca61ffd59edc89dbf387675d59518e2fa0ae3b4d5d1edc372c473db7585167d51bcb07be55adedad086c88dc24a27df5aab47e571a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.2
+services:
+  - redis-server

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at romain.pechayre@applidget.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-change_queue.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 rpechayr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Resque ChangeQueue
+[![Build Status](https://travis-ci.org/applidget/resque-change_queue.svg?branch=master)](https://travis-ci.org/applidget/resque-change_queue)
+
+Resque ChangeQueue is a [Resque](https://github.com/resque/resque) plugin allowing you to move jobs from one queue to another. This can be useful in some situation where some queue can be unexpectedly filled with thousands of slow jobs to isolate them in a low queue in order not to block normal jobs.
+
+Jobs can be queried based on their Class name and parameters.
+
+Requeuing is done in a smart way such that you are 100% sure not to loose any job:
+- The entire source queue is flushed (using `redis.pop`)
+- Matched jobs are queued to the target queue directly
+- Un matched jobs are queued to a temporay queue dedicated to the operation
+- Finally all jobs in the temporary queue are requeued in the source queue
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-change_queue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-change_queue
+
+## Usage from the UI
+
+This plugin is primarly built to enable manual jobs manipulation from resque web interface (native resque 1.x sinatra web interface). When including the gem into your Gemfile, you'll create a new tab in resque UI. You can filter the jobs from here, and then validate.
+![](https://s3-eu-west-1.amazonaws.com/assets.applidget.com/documentation/change-queue-home.png)
+
+You can add as many args in this step, and jobs will be matched based on strict equality of each parameter. If you specify less parameters than the number of parameters in the target jobs, additional parameters will be considered as matching. This allows you to filter jobs assuming that the first arguments are top level object ids (for example if your args are `[project_id, discussion_id, comment_id]`).
+
+The next screen show you the first 100 jobs matching your criteria. Just pick a target queue and validate, you're done!
+
+![](https://s3-eu-west-1.amazonaws.com/assets.applidget.com/documentation/change-queue-jobs.png)
+
+
+## Usage from code
+
+You can call Resque ChangeQueue from a console or from code :
+```ruby
+Resque::ChangeQueue.change_queue(source_q, target_q, "SomeJobClass", args)
+```
+
+*Note*: `args` is an optional parameter.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/applidget/resque-change_queue. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resque/change_queue"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/resque/change_queue.rb

@@ -0,0 +1,58 @@
+require "resque/change_queue/version"
+require "resque"
+require 'resque/server'
+
+module Resque
+  module ChangeQueue
+    module_function
+    def change_queue(from_queue, to_queue, klass, args = [])
+      tmp_queue = "operation:#{SecureRandom.uuid}"
+      moved_count = 0
+      while job = Resque.pop(from_queue)
+        target_queue = tmp_queue
+        if job["class"] == klass.to_s && match_args(job["args"], args)
+          target_queue = to_queue
+          moved_count += 1
+        end
+        Resque.push(target_queue, job)
+      end
+
+      while job = Resque.pop(tmp_queue)
+        Resque.push(from_queue, job)
+      end
+
+      # Finally ensure queue is removed
+      Resque.remove_queue(tmp_queue)
+      moved_count
+    end
+
+    def search_jobs(queue, klass, args = [], start = 0, count = 100)
+      matched_jobs = []
+      has_next = true
+      while has_next
+        page = Resque.peek(queue, start, 100)
+        page.each do |job|
+          next unless job["class"] == klass.to_s
+          matched_jobs << job if match_args(job["args"], args)
+          break if matched_jobs.count >= count
+        end
+        break if matched_jobs.count >= count
+        has_next = (page != nil &&  page.count == 100)
+        start += 100
+      end
+      matched_jobs
+    end
+
+    def match_args(job_args, criteria_args)
+      match = true
+      criteria_args.each_with_index do |item, index|
+        next if item.nil?
+        if job_args[index] != item
+          match = false
+          break
+        end
+      end
+    end
+  end
+end
+require 'resque/change_queue/server'

data/lib/resque/change_queue/server.rb

@@ -0,0 +1,63 @@
+require 'yaml'
+
+# Extends Resque Web Based UI.
+# Structure has been borrowed from ResqueCleaner.
+module Resque
+  module ChangeQueue
+    module Server
+
+      def self.erb_path(filename)
+        File.join(File.dirname(__FILE__), 'server', 'views', filename)
+      end
+
+      def self.public_path(filename)
+        File.join(File.dirname(__FILE__), 'server', 'public', filename)
+      end
+
+      def self.included(base)
+
+        base.class_eval do
+          get "/changequeue" do
+            erb File.read(Resque::ChangeQueue::Server.erb_path('search.html.erb'))
+          end
+
+          get "/changequeue/jobs" do
+            klassname = params[:classname]
+
+            #Process args to remove all tailing blank ones
+            args_hash = params[:args] || {}
+            args = args_hash.values.reverse
+            while args.count > 0 && args[0].try(:length) == 0
+              args.shift
+            end
+            args = args.reverse!
+            jobs = Resque::ChangeQueue.search_jobs(params[:queue], klassname, args)
+            tpl_params = {
+              jobs: jobs,
+              classname: klassname,
+              source_queue: params[:queue],
+              args: Base64.encode64(args.to_json)
+            }
+            erb File.read(Resque::ChangeQueue::Server.erb_path('jobs.html.erb')),{}, tpl_params
+          end
+
+          post "/changequeue/move_jobs" do
+            args = JSON.parse(Base64.decode64(params["b64_args"]))
+            results = Resque::ChangeQueue.change_queue(params[:source_queue], params[:queue], params[:classname], args)
+
+            #FIXME if resque mounted somewhere else the redirection won't work ..
+            #TODO: Display some kind of notice to next page 
+            redirect "/resque/changequeue", 302
+          end
+        end
+
+      end
+
+      Resque::Server.tabs << 'ChangeQueue'
+    end
+  end
+end
+
+Resque::Server.class_eval do
+  include Resque::ChangeQueue::Server
+end

data/lib/resque/change_queue/server/views/jobs.html.erb

@@ -0,0 +1,70 @@
+<style scoped>
+  #main .change-queue form {
+    /* resets */
+    float:none;
+    margin-top:20px;
+    margin-left: 0px;
+  }
+  #main .change-queue label {
+    float:none;
+    display: block;
+    max-width: 100%;
+    margin-bottom: 5px;
+    font-weight: 700;
+  }
+
+  #main .change-queue .form-group {
+    margin-bottom: 15px;
+  }
+
+  #main .change-queue .form-control {
+    display: block;
+  }
+
+  #main .change-queue .args .form-group {
+    margin-bottom:8px;
+  }
+
+</style>
+
+<table class='jobs'>
+  <p>
+    <%= jobs.count == 100 ? "100+" : jobs.count %> jobs with your criteria in this queue
+  </p>
+  <div class="change-queue">
+    <form method="POST" action="<%= url_path "/changequeue/move_jobs"%>" >
+      <div class="form-group">
+        <label for="queue">Move to queue</label>
+        <select class="form-control" name="queue">
+          <% Resque.queues.each do |q| %>
+            <option <%= q == source_queue ? "disabled": ""%>><%= q %></option>
+          <% end %>
+        </select>
+        <div style="display:none">
+          <input name="classname" value="<%= classname %>">
+          <input name="source_queue" value="<%= source_queue %>">
+          <input name="b64_args" value="<%= args %>">
+        </div>
+      </div>
+
+      <div class="form-group">
+        <input type="submit" value="Move jobs !">
+      </div>
+    </form>
+  </div>
+  <tr>
+    <th>Class</th>
+    <th>Args</th>
+  </tr>
+  <% for job in jobs %>
+  <tr>
+    <td class='class'><%= job['class'] %></td>
+    <td class='args'><%=h job['args'].inspect %></td>
+  </tr>
+  <% end %>
+  <% if jobs.empty? %>
+  <tr>
+    <td class='no-data' colspan='2'>There are no pending job with these criteria</td>
+  </tr>
+  <% end %>
+</table>

data/lib/resque/change_queue/server/views/search.html.erb

@@ -0,0 +1,77 @@
+<style scoped>
+  #main .change-queue form {
+    /* resets */
+    float:none;
+    margin-top:20px;
+    margin-left: 0px;
+  }
+  #main .change-queue label {
+    float:none;
+    display: block;
+    max-width: 100%;
+    margin-bottom: 5px;
+    font-weight: 700;
+  }
+
+  #main .change-queue .form-group {
+    margin-bottom: 15px;
+  }
+
+  #main .change-queue .form-control {
+    display: block;
+  }
+
+  #main .change-queue .args .form-group {
+    margin-bottom:8px;
+  }
+
+</style>
+<script type="text/javascript">
+  (function($) {
+    $(document).ready(function(){
+      $(".args input").live("keyup", function(e) {
+        var currentNumber = $(".args input").length;
+        var target = e.target;
+        var lastElementName = "args[" + (currentNumber - 1) + "]";
+        //Is is the last element ? Is there any content then ?
+        if (target.name == lastElementName && target.value.length > 0) {
+          var newEl = '<div class="form-group"><input autocomplete="off" type="input" class="form-control" name="args[' + currentNumber + ']" placeholder="argument ' + (currentNumber + 1) +'"></input></div>';
+          $(".args").append(newEl);
+        }
+      });
+    });
+  })(jQuery);
+
+</script>
+<div class="title clearfix">
+  <h1>Change queue</h1>
+</div>
+<p>
+  You can query jobs on a certain queue based on their class name and args in order to requeue them into another one.
+</p>
+<div class="change-queue">
+  <form method="GET" action="<%= url_path "/changequeue/jobs"%>" >
+    <div class="form-group">
+      <label for="queue">Queue</label>
+      <select class="form-control" name="queue">
+        <% Resque.queues.each do |q| %>
+          <option><%= q %></option>
+        <% end %>
+      </select>
+    </div>
+    <div class="form-group">
+      <label for="classname">Class name</label>
+      <input type="input" autocomplete="off" class="form-control" name="classname" value="">
+    </div>
+    <div class="args">
+      <div class="form-group">
+        <label for="args[0]">Arguments</label>
+        <input type="input" autocomplete="off" class="form-control" name="args[0]" placeholder="argument 1">
+      </div>
+    </div>
+
+    <div class="form-group">
+      <input type="submit" value="Show jobs and then requeue ...">
+    </div>
+  </form>
+</div>

data/lib/resque/change_queue/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module ChangeQueue
+    VERSION = "0.1.0"
+  end
+end

data/resque-change_queue.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/change_queue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-change_queue"
+  spec.version       = Resque::ChangeQueue::VERSION
+  spec.authors       = ["rpechayr"]
+  spec.email         = ["romain.pechayre@applidget.com"]
+  spec.homepage      = "https://github.com/applidget/resque-change_queue"
+  spec.summary = 'Reorganize queued jobs on the fly'
+  spec.description = <<-DESCRIPTION
+    Allows you to requeue jobs to another queue
+    This is useful in my situations :
+      - A large amount of jobs are queued in the critical queue, blocking the main queue for Several hours.
+      Select jobs based on criteria and requeue them to the low queue
+  DESCRIPTION
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9.0"
+
+  spec.add_runtime_dependency 'redis', '~> 3.0'
+  spec.add_runtime_dependency 'resque', '~> 1.25'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: resque-change_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rpechayr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+description: |2
+      Allows you to requeue jobs to another queue
+      This is useful in my situations :
+        - A large amount of jobs are queued in the critical queue, blocking the main queue for Several hours.
+        Select jobs based on criteria and requeue them to the low queue
+email:
+- romain.pechayre@applidget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resque/change_queue.rb
+- lib/resque/change_queue/server.rb
+- lib/resque/change_queue/server/views/jobs.html.erb
+- lib/resque/change_queue/server/views/search.html.erb
+- lib/resque/change_queue/version.rb
+- resque-change_queue.gemspec
+homepage: https://github.com/applidget/resque-change_queue
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Reorganize queued jobs on the fly
+test_files: []