sidekiq 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of sidekiq might be problematic. Click here for more details.
- data/Changes.md +27 -0
- data/LICENSE +2 -2
- data/examples/clockwork.rb +44 -0
- data/examples/config.yml +2 -1
- data/lib/sidekiq/client.rb +2 -4
- data/lib/sidekiq/processor.rb +0 -2
- data/lib/sidekiq/version.rb +1 -1
- data/test/test_client.rb +14 -1
- metadata +25 -24
data/Changes.md
CHANGED
@@ -1,3 +1,30 @@
|
|
1
|
+
HEAD
|
2
|
+
-----------
|
3
|
+
|
4
|
+
- The Sidekiq license has switched from GPLv3 to LGPLv3!
|
5
|
+
- Sidekiq::Client.push now returns whether the actual Redis
|
6
|
+
operation succeeded or not. [#123]
|
7
|
+
- Remove UniqueJobs from the default middleware chain. Its
|
8
|
+
functionality, while useful, is unexpected for new Sidekiq
|
9
|
+
users. You can re-enable it with the following config.
|
10
|
+
Read #119 for more discussion.
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
Sidekiq.configure_client do |config|
|
14
|
+
require 'sidekiq/middleware/client/unique_jobs'
|
15
|
+
cnfig.client_middleware do |chain|
|
16
|
+
chain.add Sidekiq::Middleware::Client::UniqueJobs
|
17
|
+
end
|
18
|
+
end
|
19
|
+
Sidekiq.configure_server do |config|
|
20
|
+
require 'sidekiq/middleware/server/unique_jobs'
|
21
|
+
config.server_middleware do |chain|
|
22
|
+
chain.add Sidekiq::Middleware::Server::UniqueJobs
|
23
|
+
end
|
24
|
+
end
|
25
|
+
```
|
26
|
+
|
27
|
+
|
1
28
|
1.0.0
|
2
29
|
-----------
|
3
30
|
|
data/LICENSE
CHANGED
@@ -2,9 +2,9 @@ Copyright (c) Mike Perham
|
|
2
2
|
|
3
3
|
You may choose to license Sidekiq in one of two ways:
|
4
4
|
|
5
|
-
- Open Source under the
|
5
|
+
- Open Source under the LGPLv3
|
6
6
|
|
7
|
-
Please see <http://www.gnu.org/licenses/
|
7
|
+
Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.
|
8
8
|
|
9
9
|
- Commercial License
|
10
10
|
|
@@ -0,0 +1,44 @@
|
|
1
|
+
# Sidekiq defers scheduling to other, better suited gems.
|
2
|
+
# If you want to run a job regularly, here's an example
|
3
|
+
# of using the 'clockwork' gem to push jobs to Sidekiq
|
4
|
+
# regularly.
|
5
|
+
|
6
|
+
# require boot & environment for a Rails app
|
7
|
+
# require_relative "../config/boot"
|
8
|
+
# require_relative "../config/environment"
|
9
|
+
require "clockwork"
|
10
|
+
|
11
|
+
class MyWorker
|
12
|
+
include Sidekiq::Worker
|
13
|
+
|
14
|
+
def perform(count)
|
15
|
+
puts "Job ##{count}: Late night, so tired..."
|
16
|
+
end
|
17
|
+
|
18
|
+
def self.late_night_work
|
19
|
+
10.times do |x|
|
20
|
+
perform_async(x)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
class HourlyWorker
|
26
|
+
include Sidekiq::Worker
|
27
|
+
|
28
|
+
def perform
|
29
|
+
cleanup_database
|
30
|
+
format_hard_drive
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
module Clockwork
|
35
|
+
# Kick off a bunch of jobs early in the morning
|
36
|
+
every 1.day, 'my_worker.late_night_work', :at => '4:30 am' do
|
37
|
+
MyWorker.late_night_work
|
38
|
+
end
|
39
|
+
|
40
|
+
every 1.hour do
|
41
|
+
HourlyWorker.perform_async
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
data/examples/config.yml
CHANGED
data/lib/sidekiq/client.rb
CHANGED
@@ -8,7 +8,6 @@ module Sidekiq
|
|
8
8
|
|
9
9
|
def self.default_middleware
|
10
10
|
Middleware::Chain.new do |m|
|
11
|
-
m.add Middleware::Client::UniqueJobs
|
12
11
|
end
|
13
12
|
end
|
14
13
|
|
@@ -41,14 +40,13 @@ module Sidekiq
|
|
41
40
|
Sidekiq.client_middleware.invoke(worker_class, item, queue) do
|
42
41
|
payload = MultiJson.encode(item)
|
43
42
|
Sidekiq.redis do |conn|
|
44
|
-
conn.multi do
|
43
|
+
_, pushed = conn.multi do
|
45
44
|
conn.sadd('queues', queue)
|
46
45
|
conn.rpush("queue:#{queue}", payload)
|
47
46
|
end
|
48
47
|
end
|
49
|
-
pushed = true
|
50
48
|
end
|
51
|
-
pushed
|
49
|
+
!! pushed
|
52
50
|
end
|
53
51
|
|
54
52
|
# Redis compatibility helper. Example usage:
|
data/lib/sidekiq/processor.rb
CHANGED
@@ -3,7 +3,6 @@ require 'sidekiq/util'
|
|
3
3
|
|
4
4
|
require 'sidekiq/middleware/server/active_record'
|
5
5
|
require 'sidekiq/middleware/server/exception_handler'
|
6
|
-
require 'sidekiq/middleware/server/unique_jobs'
|
7
6
|
require 'sidekiq/middleware/server/retry_jobs'
|
8
7
|
require 'sidekiq/middleware/server/logging'
|
9
8
|
|
@@ -16,7 +15,6 @@ module Sidekiq
|
|
16
15
|
Middleware::Chain.new do |m|
|
17
16
|
m.add Middleware::Server::ExceptionHandler
|
18
17
|
m.add Middleware::Server::Logging
|
19
|
-
m.add Middleware::Server::UniqueJobs
|
20
18
|
m.add Middleware::Server::RetryJobs
|
21
19
|
m.add Middleware::Server::ActiveRecord
|
22
20
|
end
|
data/lib/sidekiq/version.rb
CHANGED
data/test/test_client.rb
CHANGED
@@ -15,12 +15,18 @@ class TestClient < MiniTest::Unit::TestCase
|
|
15
15
|
end
|
16
16
|
|
17
17
|
it 'does not push duplicate messages when configured for unique only' do
|
18
|
+
Sidekiq.client_middleware do |chain|
|
19
|
+
chain.add Sidekiq::Middleware::Client::UniqueJobs
|
20
|
+
end
|
18
21
|
QueueWorker.sidekiq_options :unique => true
|
19
22
|
10.times { Sidekiq::Client.push('class' => QueueWorker, 'args' => [1, 2]) }
|
20
23
|
assert_equal 1, Sidekiq.redis {|c| c.llen("queue:customqueue") }
|
21
24
|
end
|
22
25
|
|
23
26
|
it 'does push duplicate messages when not configured for unique only' do
|
27
|
+
Sidekiq.client_middleware do |chain|
|
28
|
+
chain.add Sidekiq::Middleware::Client::UniqueJobs
|
29
|
+
end
|
24
30
|
QueueWorker.sidekiq_options :unique => false
|
25
31
|
10.times { Sidekiq::Client.push('class' => QueueWorker, 'args' => [1, 2]) }
|
26
32
|
assert_equal 10, Sidekiq.redis {|c| c.llen("queue:customqueue") }
|
@@ -30,7 +36,7 @@ class TestClient < MiniTest::Unit::TestCase
|
|
30
36
|
describe 'with mock redis' do
|
31
37
|
before do
|
32
38
|
@redis = MiniTest::Mock.new
|
33
|
-
def @redis.multi; yield if block_given?; end
|
39
|
+
def @redis.multi; [yield] * 2 if block_given?; end
|
34
40
|
def @redis.set(*); true; end
|
35
41
|
def @redis.sadd(*); true; end
|
36
42
|
def @redis.srem(*); true; end
|
@@ -74,6 +80,13 @@ class TestClient < MiniTest::Unit::TestCase
|
|
74
80
|
@redis.verify
|
75
81
|
end
|
76
82
|
|
83
|
+
it 'handles perform_async on failure' do
|
84
|
+
@redis.expect :rpush, nil, ['queue:default', String]
|
85
|
+
pushed = MyWorker.perform_async(1, 2)
|
86
|
+
refute pushed
|
87
|
+
@redis.verify
|
88
|
+
end
|
89
|
+
|
77
90
|
it 'enqueues messages to redis' do
|
78
91
|
@redis.expect :rpush, 1, ['queue:default', String]
|
79
92
|
pushed = Sidekiq::Client.enqueue(MyWorker, 1, 2)
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sidekiq
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,11 +9,11 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-04-
|
12
|
+
date: 2012-04-12 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: redis
|
16
|
-
requirement: &
|
16
|
+
requirement: &70154555190180 !ruby/object:Gem::Requirement
|
17
17
|
none: false
|
18
18
|
requirements:
|
19
19
|
- - ! '>='
|
@@ -21,10 +21,10 @@ dependencies:
|
|
21
21
|
version: '0'
|
22
22
|
type: :runtime
|
23
23
|
prerelease: false
|
24
|
-
version_requirements: *
|
24
|
+
version_requirements: *70154555190180
|
25
25
|
- !ruby/object:Gem::Dependency
|
26
26
|
name: redis-namespace
|
27
|
-
requirement: &
|
27
|
+
requirement: &70154555189740 !ruby/object:Gem::Requirement
|
28
28
|
none: false
|
29
29
|
requirements:
|
30
30
|
- - ! '>='
|
@@ -32,10 +32,10 @@ dependencies:
|
|
32
32
|
version: '0'
|
33
33
|
type: :runtime
|
34
34
|
prerelease: false
|
35
|
-
version_requirements: *
|
35
|
+
version_requirements: *70154555189740
|
36
36
|
- !ruby/object:Gem::Dependency
|
37
37
|
name: connection_pool
|
38
|
-
requirement: &
|
38
|
+
requirement: &70154555189240 !ruby/object:Gem::Requirement
|
39
39
|
none: false
|
40
40
|
requirements:
|
41
41
|
- - ~>
|
@@ -43,10 +43,10 @@ dependencies:
|
|
43
43
|
version: 0.9.0
|
44
44
|
type: :runtime
|
45
45
|
prerelease: false
|
46
|
-
version_requirements: *
|
46
|
+
version_requirements: *70154555189240
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
48
|
name: celluloid
|
49
|
-
requirement: &
|
49
|
+
requirement: &70154555188740 !ruby/object:Gem::Requirement
|
50
50
|
none: false
|
51
51
|
requirements:
|
52
52
|
- - ~>
|
@@ -54,10 +54,10 @@ dependencies:
|
|
54
54
|
version: 0.10.0
|
55
55
|
type: :runtime
|
56
56
|
prerelease: false
|
57
|
-
version_requirements: *
|
57
|
+
version_requirements: *70154555188740
|
58
58
|
- !ruby/object:Gem::Dependency
|
59
59
|
name: multi_json
|
60
|
-
requirement: &
|
60
|
+
requirement: &70154555188360 !ruby/object:Gem::Requirement
|
61
61
|
none: false
|
62
62
|
requirements:
|
63
63
|
- - ! '>='
|
@@ -65,10 +65,10 @@ dependencies:
|
|
65
65
|
version: '0'
|
66
66
|
type: :runtime
|
67
67
|
prerelease: false
|
68
|
-
version_requirements: *
|
68
|
+
version_requirements: *70154555188360
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: minitest
|
71
|
-
requirement: &
|
71
|
+
requirement: &70154555204260 !ruby/object:Gem::Requirement
|
72
72
|
none: false
|
73
73
|
requirements:
|
74
74
|
- - ! '>='
|
@@ -76,10 +76,10 @@ dependencies:
|
|
76
76
|
version: '0'
|
77
77
|
type: :development
|
78
78
|
prerelease: false
|
79
|
-
version_requirements: *
|
79
|
+
version_requirements: *70154555204260
|
80
80
|
- !ruby/object:Gem::Dependency
|
81
81
|
name: sinatra
|
82
|
-
requirement: &
|
82
|
+
requirement: &70154555203840 !ruby/object:Gem::Requirement
|
83
83
|
none: false
|
84
84
|
requirements:
|
85
85
|
- - ! '>='
|
@@ -87,10 +87,10 @@ dependencies:
|
|
87
87
|
version: '0'
|
88
88
|
type: :development
|
89
89
|
prerelease: false
|
90
|
-
version_requirements: *
|
90
|
+
version_requirements: *70154555203840
|
91
91
|
- !ruby/object:Gem::Dependency
|
92
92
|
name: slim
|
93
|
-
requirement: &
|
93
|
+
requirement: &70154555203420 !ruby/object:Gem::Requirement
|
94
94
|
none: false
|
95
95
|
requirements:
|
96
96
|
- - ! '>='
|
@@ -98,10 +98,10 @@ dependencies:
|
|
98
98
|
version: '0'
|
99
99
|
type: :development
|
100
100
|
prerelease: false
|
101
|
-
version_requirements: *
|
101
|
+
version_requirements: *70154555203420
|
102
102
|
- !ruby/object:Gem::Dependency
|
103
103
|
name: rake
|
104
|
-
requirement: &
|
104
|
+
requirement: &70154555203000 !ruby/object:Gem::Requirement
|
105
105
|
none: false
|
106
106
|
requirements:
|
107
107
|
- - ! '>='
|
@@ -109,10 +109,10 @@ dependencies:
|
|
109
109
|
version: '0'
|
110
110
|
type: :development
|
111
111
|
prerelease: false
|
112
|
-
version_requirements: *
|
112
|
+
version_requirements: *70154555203000
|
113
113
|
- !ruby/object:Gem::Dependency
|
114
114
|
name: actionmailer
|
115
|
-
requirement: &
|
115
|
+
requirement: &70154555202500 !ruby/object:Gem::Requirement
|
116
116
|
none: false
|
117
117
|
requirements:
|
118
118
|
- - ~>
|
@@ -120,10 +120,10 @@ dependencies:
|
|
120
120
|
version: '3'
|
121
121
|
type: :development
|
122
122
|
prerelease: false
|
123
|
-
version_requirements: *
|
123
|
+
version_requirements: *70154555202500
|
124
124
|
- !ruby/object:Gem::Dependency
|
125
125
|
name: activerecord
|
126
|
-
requirement: &
|
126
|
+
requirement: &70154555202000 !ruby/object:Gem::Requirement
|
127
127
|
none: false
|
128
128
|
requirements:
|
129
129
|
- - ~>
|
@@ -131,7 +131,7 @@ dependencies:
|
|
131
131
|
version: '3'
|
132
132
|
type: :development
|
133
133
|
prerelease: false
|
134
|
-
version_requirements: *
|
134
|
+
version_requirements: *70154555202000
|
135
135
|
description: Simple, efficient message processing for Ruby
|
136
136
|
email:
|
137
137
|
- mperham@gmail.com
|
@@ -158,6 +158,7 @@ files:
|
|
158
158
|
- examples/chef/cookbooks/sidekiq/templates/default/monitrc.conf.erb
|
159
159
|
- examples/chef/cookbooks/sidekiq/templates/default/sidekiq.erb
|
160
160
|
- examples/chef/cookbooks/sidekiq/templates/default/sidekiq.yml.erb
|
161
|
+
- examples/clockwork.rb
|
161
162
|
- examples/config.yml
|
162
163
|
- examples/monitrc.conf
|
163
164
|
- examples/por.rb
|