1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00

Revert "Merge pull request #2659 from mperham/queue-testing-api"

This reverts commit df739ca968, reversing
changes made to dbd8bed17c.
This commit is contained in:
Brandon Hilkert 2015-11-17 12:44:56 -05:00
parent 3cc996aaef
commit 56ebcfd161
4 changed files with 15 additions and 168 deletions

View file

@ -25,16 +25,6 @@ gem 'redis-namespace'
`concurrency + 2` connections in your pool or Sidekiq will exit. `concurrency + 2` connections in your pool or Sidekiq will exit.
When in doubt, let Sidekiq size the connection pool for you. When in doubt, let Sidekiq size the connection pool for you.
* There's a new testing API based off the `Sidekiq::Queues` namespace. All
assertions made against the Worker class still work as expected.
```ruby
assert_equal 0, Sidekiq::Queues["default"].size
HardWorker.perform_async("log")
assert_equal 1, Sidekiq::Queues["default"].size
assert_equal "log", Sidekiq::Queues["default"].first['args'][0]
Sidekiq::Queues.clear_all
```
## Upgrade ## Upgrade
First, make sure you are using Redis 2.8 or greater. Next: First, make sure you are using Redis 2.8 or greater. Next:

View file

@ -7,16 +7,6 @@
and to remove dependencies. This has resulted in major speedups, as and to remove dependencies. This has resulted in major speedups, as
[detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/). [detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail. - See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
- There's a new testing API based off the `Sidekiq::Queues` namespace. All
assertions made against the Worker class still work as expected.
[#2659, brandonhilkert]
```ruby
assert_equal 0, Sidekiq::Queues["default"].size
HardWorker.perform_async("log")
assert_equal 1, Sidekiq::Queues["default"].size
assert_equal "log", Sidekiq::Queues["default"].first['args'][0]
Sidekiq::Queues.clear_all
```
3.5.3 3.5.3
----------- -----------

View file

@ -68,15 +68,15 @@ module Sidekiq
def raw_push(payloads) def raw_push(payloads)
if Sidekiq::Testing.fake? if Sidekiq::Testing.fake?
payloads.each do |job| payloads.each do |job|
Queues.jobs[job['queue']] << Sidekiq.load_json(Sidekiq.dump_json(job)) job['class'].constantize.jobs << Sidekiq.load_json(Sidekiq.dump_json(job))
end end
true true
elsif Sidekiq::Testing.inline? elsif Sidekiq::Testing.inline?
payloads.each do |job| payloads.each do |job|
job['jid'] ||= SecureRandom.hex(12)
klass = job['class'].constantize klass = job['class'].constantize
job['id'] ||= SecureRandom.hex(12) klass.jobs.unshift Sidekiq.load_json(Sidekiq.dump_json(job))
job_hash = Sidekiq.load_json(Sidekiq.dump_json(job)) klass.perform_one
klass.process_job(job_hash)
end end
true true
else else
@ -85,64 +85,6 @@ module Sidekiq
end end
end end
module Queues
##
# The Queues class is only for testing the fake queue implementation.
# The data is structured as a hash with queue name as hash key and array
# of job data as the value.
#
# {
# "default"=>[
# {
# "class"=>"TestTesting::QueueWorker",
# "args"=>[1, 2],
# "retry"=>true,
# "queue"=>"default",
# "jid"=>"abc5b065c5c4b27fc1102833",
# "created_at"=>1447445554.419934
# }
# ]
# }
#
# Example:
#
# require 'sidekiq/testing'
#
# assert_equal 0, Sidekiq::Queues["default"].size
# HardWorker.perform_async(:something)
# assert_equal 1, Sidekiq::Queues["default"].size
# assert_equal :something, Sidekiq::Queues["default"].first['args'][0]
#
# You can also clear all workers' jobs:
#
# assert_equal 0, Sidekiq::Queues["default"].size
# HardWorker.perform_async(:something)
# Sidekiq::Queues.clear_all
# assert_equal 0, Sidekiq::Queues["default"].size
#
# This can be useful to make sure jobs don't linger between tests:
#
# RSpec.configure do |config|
# config.before(:each) do
# Sidekiq::Queues.clear_all
# end
# end
#
class << self
def [](queue)
jobs[queue]
end
def jobs
@jobs ||= Hash.new { |hash, key| hash[key] = [] }
end
def clear_all
jobs.clear
end
end
end
module Worker module Worker
## ##
# The Sidekiq testing infrastructure overrides perform_async # The Sidekiq testing infrastructure overrides perform_async
@ -201,36 +143,28 @@ module Sidekiq
# #
module ClassMethods module ClassMethods
# Queue for this worker
def queue
self.sidekiq_options["queue"]
end
# Jobs queued for this worker # Jobs queued for this worker
def jobs def jobs
Queues.jobs[queue].select { |job| job["class"] == self.to_s } Worker.jobs[self]
end end
# Clear all jobs for this worker # Clear all jobs for this worker
def clear def clear
Queues.jobs[queue].clear jobs.clear
end end
# Drain and run all jobs for this worker # Drain and run all jobs for this worker
def drain def drain
while jobs.any? while job = jobs.shift do
next_job = jobs.first process_job(job)
Queues.jobs[queue].delete_if { |job| job["jid"] == next_job["jid"] }
process_job(next_job)
end end
end end
# Pop out a single job and perform it # Pop out a single job and perform it
def perform_one def perform_one
raise(EmptyQueueError, "perform_one called with empty job queue") if jobs.empty? raise(EmptyQueueError, "perform_one called with empty job queue") if jobs.empty?
next_job = jobs.first job = jobs.shift
Queues.jobs[queue].delete_if { |job| job["jid"] == next_job["jid"] } process_job(job)
process_job(next_job)
end end
def process_job(job) def process_job(job)
@ -249,22 +183,18 @@ module Sidekiq
class << self class << self
def jobs # :nodoc: def jobs # :nodoc:
Queues.jobs.values.flatten @jobs ||= Hash.new { |hash, key| hash[key] = [] }
end end
# Clear all queued jobs across all workers # Clear all queued jobs across all workers
def clear_all def clear_all
Queues.clear_all jobs.clear
end end
# Drain all queued jobs across all workers # Drain all queued jobs across all workers
def drain_all def drain_all
while jobs.any? until jobs.values.all?(&:empty?) do
worker_classes = jobs.map { |job| job["class"] }.uniq jobs.keys.each(&:drain)
worker_classes.each do |worker_class|
worker_class.constantize.drain
end
end end
end end
end end

View file

@ -54,7 +54,6 @@ class TestTesting < Sidekiq::Test
after do after do
Sidekiq::Testing.disable! Sidekiq::Testing.disable!
Sidekiq::Queues.clear_all
end end
it 'stubs the async call' do it 'stubs the async call' do
@ -94,7 +93,7 @@ class TestTesting < Sidekiq::Test
it 'stubs the enqueue_to call' do it 'stubs the enqueue_to call' do
assert_equal 0, EnqueuedWorker.jobs.size assert_equal 0, EnqueuedWorker.jobs.size
assert Sidekiq::Client.enqueue_to('someq', EnqueuedWorker, 1, 2) assert Sidekiq::Client.enqueue_to('someq', EnqueuedWorker, 1, 2)
assert_equal 1, Sidekiq::Queues['someq'].size assert_equal 1, EnqueuedWorker.jobs.size
end end
it 'executes all stored jobs' do it 'executes all stored jobs' do
@ -264,68 +263,6 @@ class TestTesting < Sidekiq::Test
it 'can execute a job' do it 'can execute a job' do
DirectWorker.execute_job(DirectWorker.new, [2, 3]) DirectWorker.execute_job(DirectWorker.new, [2, 3])
end end
end
describe 'queue testing' do
before do
require 'sidekiq/testing'
Sidekiq::Testing.fake!
end
after do
Sidekiq::Testing.disable!
Sidekiq::Queues.clear_all
end
class QueueWorker
include Sidekiq::Worker
def perform(a, b)
a + b
end
end
class AltQueueWorker
include Sidekiq::Worker
sidekiq_options queue: :alt
def perform(a, b)
a + b
end
end
it 'finds enqueued jobs' do
assert_equal 0, Sidekiq::Queues["default"].size
QueueWorker.perform_async(1, 2)
QueueWorker.perform_async(1, 2)
AltQueueWorker.perform_async(1, 2)
assert_equal 2, Sidekiq::Queues["default"].size
assert_equal [1, 2], Sidekiq::Queues["default"].first["args"]
assert_equal 1, Sidekiq::Queues["alt"].size
end
it 'clears out all queues' do
assert_equal 0, Sidekiq::Queues["default"].size
QueueWorker.perform_async(1, 2)
QueueWorker.perform_async(1, 2)
AltQueueWorker.perform_async(1, 2)
Sidekiq::Queues.clear_all
assert_equal 0, Sidekiq::Queues["default"].size
assert_equal 0, Sidekiq::Queues["alt"].size
end
it 'finds jobs enqueued by client' do
Sidekiq::Client.push(
'class' => 'NonExistentWorker',
'queue' => 'missing',
'args' => [1]
)
assert_equal 1, Sidekiq::Queues["missing"].size
end
end end
end end