sidekiq-dynamic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24a7afa0adb95b136305ed6637204e42d21d6dca
+  data.tar.gz: dce54e09f38333dc656699267c27919625d899e9
+SHA512:
+  metadata.gz: da57581a769c873e3471b7637a9488bbab323ef1ae16c2b5aa37220ce2a7c595a87a1f435b1d472837b523b2ca050d42d1458e7ab7eb851cd507b3a5739bcc4f
+  data.tar.gz: 2daf27243b3d0cebfd61831d9a4a2e94bd450e1e5e159f039b5c2cee4129f28647b01a6c0fc1cac2049816ccbdb20a1d88ff5b434ed2cef59e58cda55c4572c3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 2.1
+- jruby-19mode
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andre Arko & Jo Pu
+
+MIT License
+
+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,70 @@
+# Sidekiq::Dynamic
+
+Sidekiq::Dynamic allows Sidekiq jobs to choose their queue or shard/pool based on the job's arguments.
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'sidekiq-dynamic'
+```
+
+## Usage
+
+If you have a lot of Sidekiq queues and/or jobs, chances are good that you will eventually overrun the ability of a single Redis instance. When that happens, you need to be able to shard your jobs across multiple Redis instances easily. Let's say you have two Redis instances, and you want to send Sidekiq jobs to both of them.
+
+```
+# List shards somewhere (you could even use Sidekiq.config)
+shards = {
+  :cache => "127.0.0.1:5901",
+  :images => "127.0.0.1:5902"
+}
+```
+
+Using a regular Sidekiq::Worker, it's pretty easy to assign particular jobs to a particular queue or shard.
+
+```
+# Assign a worker a static queue, and/or a static shard
+require "sidekiq/worker"
+
+class StaticSidekiqWorker
+  include Sidekiq::Worker
+  sidekiq_options queue: "cache_regenerator", pool: shards[:cache]
+end
+```
+
+In contrast to vanilla Sidekiq workers, Sidekiq::Dynamic workers allow you to examine the job arguments and choose a queue or shard for the job to be sent to when the job is queued.
+
+```
+# Dynamic jobs use the job arguments to determine queue or shard
+require "sidekiq/dynamic/worker"
+
+class DynamicShardAndQueueWorker
+  include Sidekiq::Dynamic::Worker
+
+  # In this example, every shard will have both queues.
+  dynamic_queue do |args|
+    rand(1).zero? ? "cache_sweeper" : "image_generator"
+  end
+
+  dynamic_shard do |args|
+    case args.first
+    when "hard_work", "other_hard_work"
+      shards[:cache]
+    else
+      shards[:images]
+    end
+  end
+
+end
+```
+
+Keep in mind that neither this gem nor Sidekiq itself helps with running Sidekiq workers on each shard and queue. You'll need to start separate Sidekiq processes that are configured to talk to each Redis shard, and you'll need to list the queues those processes should work from.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sidekiq-dynamic/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sidekiq/dynamic.rb

@@ -0,0 +1,2 @@
+require "sidekiq/dynamic/version"
+require "sidekiq/dynamic/worker"

data/lib/sidekiq/dynamic/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Dynamic
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/dynamic/worker.rb

@@ -0,0 +1,35 @@
+require "sidekiq/worker"
+
+module Sidekiq
+  module Dynamic
+    module Worker
+
+      def self.included(base)
+        base.send(:include, Sidekiq::Worker)
+        base.class_attribute :dynamic_shard_proc
+        base.class_attribute :dynamic_queue_proc
+        base.extend(ClassMethods)
+      end
+  
+      module ClassMethods
+        def dynamic_shard(&block)
+          self.dynamic_shard_proc = block
+        end
+  
+        def dynamic_queue(&block)
+          self.dynamic_queue_proc = block
+        end
+
+        def client_push(item) # :nodoc:
+          old_pool = Thread.current[:sidekiq_via_pool]
+          item['queue'] = dynamic_queue_proc.call(item['args']) if dynamic_queue_proc
+          Thread.current[:sidekiq_via_pool] ||= dynamic_shard_proc.call(item['args']) if dynamic_shard_proc
+          super(item)
+        ensure
+          Thread.current[:sidekiq_via_pool] = old_pool
+        end
+      end
+  
+    end
+  end
+end

data/sidekiq-dynamic.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/dynamic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-dynamic"
+  spec.version       = Sidekiq::Dynamic::VERSION
+  spec.authors       = ["André Arko & Jo Pu"]
+  spec.email         = ["andre+jo@wanelo.com"]
+  spec.summary       = %q{Extends Sidekiq workers to allow dynamic queue and shard choice.}
+  spec.description   = %q{Sidekiq-dynamic creates a subclass of Sidekiq::Worker, named Sidekiq::Dynamic::Worker, that allows each worker class to run code that determines which queue and Redis shard a job will be sent to.}
+  spec.homepage      = "http://www.github.com/wanelo/sidekiq-dynamic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/spec/sidekiq/dynamic/worker_spec.rb

@@ -0,0 +1,82 @@
+require "sidekiq/dynamic/worker"
+# hay guise sidekiq/worker depends on Sidekiq but doesn't require it
+require "sidekiq"
+
+RSpec.describe Sidekiq::Dynamic::Worker do
+  let(:worker) {
+    Class.new do
+      include Sidekiq::Dynamic::Worker
+      class_attribute :class_redis_pool
+    end
+  }
+
+  let(:redis) { double("redis", sadd: true).tap { |redis|
+    allow(redis).to receive(:with).and_yield(redis)
+    allow(redis).to receive(:multi).and_yield.and_return([])
+  }}
+
+  let(:other_redis) { double("other_redis", sadd: true).tap { |redis|
+    allow(redis).to receive(:with).and_yield(redis)
+    allow(redis).to receive(:multi).and_yield.and_return([])
+  }}
+
+  before do
+    Sidekiq.instance_variable_set(:@redis, redis)
+  end
+  
+  it "can instantiate a Sidekiq::Dynamic::Worker" do
+    expect(worker.new).to be_kind_of(Sidekiq::Dynamic::Worker)
+  end
+  
+  it "can still enqueue a job" do
+    expect(redis).to receive(:lpush).once.with('queue:default', instance_of(Array))
+    worker.perform_async("omg")
+  end
+  
+  it "can still enqueue a job to a static queue" do
+    worker.class_eval { sidekiq_options queue: 'amazing' }
+    
+    expect(redis).to receive(:lpush).once.with('queue:amazing', instance_of(Array))
+    worker.perform_async("omg")
+  end
+  
+  it "can enqueue a job to a dynamic queue" do
+    worker.class_eval do
+      dynamic_queue { |args| args.first }
+    end
+    
+    expect(redis).to receive(:lpush).once.with('queue:omg', instance_of(Array))
+    worker.perform_async("omg")
+  end
+  
+  it "can still enqueue a job to a static shard" do
+    worker.class_redis_pool = other_redis
+    worker.class_eval { sidekiq_options pool: class_redis_pool }
+
+    expect(other_redis).to receive(:lpush).once.with('queue:default', instance_of(Array))
+    worker.perform_async("omg")
+  end
+  
+  it "can enqueue a job to a dynamic shard" do
+    worker.class_redis_pool = other_redis
+    worker.class_eval do
+      dynamic_shard { |args| class_redis_pool }
+    end
+    
+    expect(other_redis).to receive(:lpush).once.with('queue:default', instance_of(Array))
+    worker.perform_async("omg")
+  end
+
+  it "can ignores the dynamic shard during `Sidekiq::Client.via`" do
+    worker.class_redis_pool = other_redis
+    worker.class_eval do
+      dynamic_shard { |args| class_redis_pool }
+    end
+    
+    expect(redis).to receive(:lpush).once.with('queue:default', instance_of(Array))
+    Sidekiq::Client.via(redis) do
+      worker.perform_async("omg")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-dynamic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- André Arko & Jo Pu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Sidekiq-dynamic creates a subclass of Sidekiq::Worker, named Sidekiq::Dynamic::Worker,
+  that allows each worker class to run code that determines which queue and Redis
+  shard a job will be sent to.
+email:
+- andre+jo@wanelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/dynamic.rb
+- lib/sidekiq/dynamic/version.rb
+- lib/sidekiq/dynamic/worker.rb
+- sidekiq-dynamic.gemspec
+- spec/sidekiq/dynamic/worker_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/wanelo/sidekiq-dynamic
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Extends Sidekiq workers to allow dynamic queue and shard choice.
+test_files:
+- spec/sidekiq/dynamic/worker_spec.rb
+- spec/spec_helper.rb