sidekiq 4.2.4 → 6.4.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.

Files changed (143) hide show
  1. checksums.yaml +5 -5
  2. data/Changes.md +523 -0
  3. data/LICENSE +3 -3
  4. data/README.md +23 -36
  5. data/bin/sidekiq +26 -2
  6. data/bin/sidekiqload +28 -38
  7. data/bin/sidekiqmon +8 -0
  8. data/lib/generators/sidekiq/job_generator.rb +57 -0
  9. data/lib/generators/sidekiq/templates/{worker.rb.erb → job.rb.erb} +2 -2
  10. data/lib/generators/sidekiq/templates/job_spec.rb.erb +6 -0
  11. data/lib/generators/sidekiq/templates/job_test.rb.erb +8 -0
  12. data/lib/sidekiq/api.rb +403 -243
  13. data/lib/sidekiq/cli.rb +230 -211
  14. data/lib/sidekiq/client.rb +53 -64
  15. data/lib/sidekiq/delay.rb +43 -0
  16. data/lib/sidekiq/exception_handler.rb +12 -16
  17. data/lib/sidekiq/extensions/action_mailer.rb +15 -24
  18. data/lib/sidekiq/extensions/active_record.rb +15 -12
  19. data/lib/sidekiq/extensions/class_methods.rb +16 -13
  20. data/lib/sidekiq/extensions/generic_proxy.rb +14 -6
  21. data/lib/sidekiq/fetch.rb +39 -31
  22. data/lib/sidekiq/job.rb +13 -0
  23. data/lib/sidekiq/job_logger.rb +63 -0
  24. data/lib/sidekiq/job_retry.rb +261 -0
  25. data/lib/sidekiq/job_util.rb +65 -0
  26. data/lib/sidekiq/launcher.rb +170 -71
  27. data/lib/sidekiq/logger.rb +166 -0
  28. data/lib/sidekiq/manager.rb +21 -26
  29. data/lib/sidekiq/middleware/chain.rb +20 -8
  30. data/lib/sidekiq/middleware/current_attributes.rb +57 -0
  31. data/lib/sidekiq/middleware/i18n.rb +5 -7
  32. data/lib/sidekiq/monitor.rb +133 -0
  33. data/lib/sidekiq/paginator.rb +18 -14
  34. data/lib/sidekiq/processor.rb +161 -70
  35. data/lib/sidekiq/rails.rb +41 -73
  36. data/lib/sidekiq/redis_connection.rb +65 -20
  37. data/lib/sidekiq/scheduled.rb +95 -34
  38. data/lib/sidekiq/sd_notify.rb +149 -0
  39. data/lib/sidekiq/systemd.rb +24 -0
  40. data/lib/sidekiq/testing/inline.rb +2 -1
  41. data/lib/sidekiq/testing.rb +52 -26
  42. data/lib/sidekiq/util.rb +60 -14
  43. data/lib/sidekiq/version.rb +2 -1
  44. data/lib/sidekiq/web/action.rb +15 -15
  45. data/lib/sidekiq/web/application.rb +115 -89
  46. data/lib/sidekiq/web/csrf_protection.rb +180 -0
  47. data/lib/sidekiq/web/helpers.rb +151 -83
  48. data/lib/sidekiq/web/router.rb +27 -19
  49. data/lib/sidekiq/web.rb +65 -109
  50. data/lib/sidekiq/worker.rb +284 -41
  51. data/lib/sidekiq.rb +93 -60
  52. data/sidekiq.gemspec +24 -22
  53. data/web/assets/images/apple-touch-icon.png +0 -0
  54. data/web/assets/javascripts/application.js +83 -64
  55. data/web/assets/javascripts/dashboard.js +81 -85
  56. data/web/assets/stylesheets/application-dark.css +143 -0
  57. data/web/assets/stylesheets/application-rtl.css +242 -0
  58. data/web/assets/stylesheets/application.css +319 -143
  59. data/web/assets/stylesheets/bootstrap-rtl.min.css +9 -0
  60. data/web/assets/stylesheets/bootstrap.css +2 -2
  61. data/web/locales/ar.yml +87 -0
  62. data/web/locales/de.yml +14 -2
  63. data/web/locales/en.yml +8 -1
  64. data/web/locales/es.yml +22 -5
  65. data/web/locales/fa.yml +80 -0
  66. data/web/locales/fr.yml +10 -3
  67. data/web/locales/he.yml +79 -0
  68. data/web/locales/ja.yml +12 -4
  69. data/web/locales/lt.yml +83 -0
  70. data/web/locales/pl.yml +4 -4
  71. data/web/locales/ru.yml +4 -0
  72. data/web/locales/ur.yml +80 -0
  73. data/web/locales/vi.yml +83 -0
  74. data/web/views/_footer.erb +5 -2
  75. data/web/views/_job_info.erb +4 -3
  76. data/web/views/_nav.erb +4 -18
  77. data/web/views/_paging.erb +1 -1
  78. data/web/views/_poll_link.erb +2 -5
  79. data/web/views/_summary.erb +7 -7
  80. data/web/views/busy.erb +60 -22
  81. data/web/views/dashboard.erb +23 -15
  82. data/web/views/dead.erb +3 -3
  83. data/web/views/layout.erb +14 -3
  84. data/web/views/morgue.erb +19 -12
  85. data/web/views/queue.erb +24 -14
  86. data/web/views/queues.erb +14 -4
  87. data/web/views/retries.erb +22 -13
  88. data/web/views/retry.erb +4 -4
  89. data/web/views/scheduled.erb +7 -4
  90. metadata +49 -198
  91. data/.github/contributing.md +0 -32
  92. data/.github/issue_template.md +0 -4
  93. data/.gitignore +0 -12
  94. data/.travis.yml +0 -12
  95. data/3.0-Upgrade.md +0 -70
  96. data/4.0-Upgrade.md +0 -53
  97. data/COMM-LICENSE +0 -95
  98. data/Ent-Changes.md +0 -146
  99. data/Gemfile +0 -29
  100. data/Pro-2.0-Upgrade.md +0 -138
  101. data/Pro-3.0-Upgrade.md +0 -44
  102. data/Pro-Changes.md +0 -585
  103. data/Rakefile +0 -9
  104. data/bin/sidekiqctl +0 -99
  105. data/code_of_conduct.md +0 -50
  106. data/lib/generators/sidekiq/templates/worker_spec.rb.erb +0 -6
  107. data/lib/generators/sidekiq/templates/worker_test.rb.erb +0 -8
  108. data/lib/generators/sidekiq/worker_generator.rb +0 -49
  109. data/lib/sidekiq/core_ext.rb +0 -106
  110. data/lib/sidekiq/logging.rb +0 -106
  111. data/lib/sidekiq/middleware/server/active_record.rb +0 -13
  112. data/lib/sidekiq/middleware/server/logging.rb +0 -40
  113. data/lib/sidekiq/middleware/server/retry_jobs.rb +0 -205
  114. data/test/config.yml +0 -9
  115. data/test/env_based_config.yml +0 -11
  116. data/test/fake_env.rb +0 -1
  117. data/test/fixtures/en.yml +0 -2
  118. data/test/helper.rb +0 -75
  119. data/test/test_actors.rb +0 -138
  120. data/test/test_api.rb +0 -528
  121. data/test/test_cli.rb +0 -418
  122. data/test/test_client.rb +0 -266
  123. data/test/test_exception_handler.rb +0 -56
  124. data/test/test_extensions.rb +0 -127
  125. data/test/test_fetch.rb +0 -50
  126. data/test/test_launcher.rb +0 -95
  127. data/test/test_logging.rb +0 -35
  128. data/test/test_manager.rb +0 -50
  129. data/test/test_middleware.rb +0 -158
  130. data/test/test_processor.rb +0 -235
  131. data/test/test_rails.rb +0 -22
  132. data/test/test_redis_connection.rb +0 -132
  133. data/test/test_retry.rb +0 -326
  134. data/test/test_retry_exhausted.rb +0 -149
  135. data/test/test_scheduled.rb +0 -115
  136. data/test/test_scheduling.rb +0 -58
  137. data/test/test_sidekiq.rb +0 -107
  138. data/test/test_testing.rb +0 -143
  139. data/test/test_testing_fake.rb +0 -357
  140. data/test/test_testing_inline.rb +0 -94
  141. data/test/test_util.rb +0 -13
  142. data/test/test_web.rb +0 -726
  143. data/test/test_web_helpers.rb +0 -54
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 581035f739e6ecf4fdd07d42b7ff78b1012f3ad2
4
- data.tar.gz: 26c02597dab733a1fdf7d948a7a274029033ae21
2
+ SHA256:
3
+ metadata.gz: 9622b2851203b0c5a80695ab7801ca77e15dc63a641ae79132cda9a2fcbe0cc6
4
+ data.tar.gz: dd943a02d2cf910f51866d02254f3a7845cb159735bd54d223dd7127a1fbd2fa
5
5
  SHA512:
6
- metadata.gz: ace3433e3bc81e986d56177f392a54f24e9a6f5cd1a050107d5273271cc61df5b022dfae32f99fb0cd74b71d5c9470daebca8073a5106bbe605f71d788196500
7
- data.tar.gz: abca98c2d32c438dfc4f60e8dabcea79cc0f28c616d62942a02f768bb0353199abd139aacdc12db546ee19e66b95fb0a36644104dd47c663f034f02882bffd24
6
+ metadata.gz: 65bcd542866d8699ecf5958d81a15fd322cd1c51dfc1dbc6a8b15402b70862510c134e2b0ed9f9dbcdbb4dea3a59c1d12878ff926145e503079a59896f279ff3
7
+ data.tar.gz: 36143e85dc7fd4611f8a43fe39788dc590725ac63a827fbc174916da2d59fdadb3fb64fa0d819c4ef90694f6f292ea15f7fb58fb29f368c0a06c5b90f1b4bca7
data/Changes.md CHANGED
@@ -1,5 +1,527 @@
1
1
  # Sidekiq Changes
2
2
 
3
+ [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/main/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/main/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/main/Ent-Changes.md)
4
+
5
+ 6.4.0
6
+ ---------
7
+
8
+ - **SECURITY**: Validate input to avoid possible DoS in Web UI.
9
+ - Add **strict argument checking** [#5071]
10
+ Sidekiq will now log a warning if JSON-unsafe arguments are passed to `perform_async`.
11
+ Add `Sidekiq.strict_args!(false)` to your initializer to disable this warning.
12
+ This warning will switch to an exception in Sidekiq 7.0.
13
+ - Note that Delayed Extensions will be removed in Sidekiq 7.0 [#5076]
14
+ - Add `perform_{inline,sync}` in Sidekiq::Job to run a job synchronously [#5061, hasan-ally]
15
+ ```ruby
16
+ SomeJob.perform_async(args...)
17
+ SomeJob.perform_sync(args...)
18
+ SomeJob.perform_inline(args...)
19
+ ```
20
+ You can also dynamically redirect a job to run synchronously:
21
+ ```ruby
22
+ SomeJob.set("sync": true).perform_async(args...) # will run via perform_inline
23
+ ```
24
+ - Replace Sidekiq::Worker `app/workers` generator with Sidekiq::Job `app/sidekiq` generator [#5055]
25
+ ```
26
+ bin/rails generate sidekiq:job ProcessOrderJob
27
+ ```
28
+ - Fix job retries losing CurrentAttributes [#5090]
29
+ - Tweak shutdown to give long-running threads time to cleanup [#5095]
30
+ - Add keyword arguments support in extensions
31
+
32
+ 6.3.1
33
+ ---------
34
+
35
+ - Fix keyword arguments error with CurrentAttributes on Ruby 3.0 [#5048]
36
+
37
+ 6.3.0
38
+ ---------
39
+
40
+ - **BREAK**: The Web UI has been refactored to remove jQuery. Any UI extensions
41
+ which use jQuery will break.
42
+ - **FEATURE**: Sidekiq.logger has been enhanced so any `Rails.logger`
43
+ output in jobs now shows up in the Sidekiq console. Remove any logger
44
+ hacks in your initializer and see if it Just Works™ now. [#5021]
45
+ - **FEATURE**: Add `Sidekiq::Job` alias for `Sidekiq::Worker`, to better
46
+ reflect industry standard terminology. You can now do this:
47
+ ```ruby
48
+ class MyJob
49
+ include Sidekiq::Job
50
+ sidekiq_options ...
51
+ def perform(args)
52
+ end
53
+ end
54
+ ```
55
+ - **FEATURE**: Support for serializing ActiveSupport::CurrentAttributes into each job. [#4982]
56
+ ```ruby
57
+ # config/initializers/sidekiq.rb
58
+ require "sidekiq/middleware/current_attributes"
59
+ Sidekiq::CurrentAttributes.persist(Myapp::Current) # Your AS::CurrentAttributes singleton
60
+ ```
61
+ - **FEATURE**: Add `Sidekiq::Worker.perform_bulk` for enqueuing jobs in bulk,
62
+ similar to `Sidekiq::Client.push_bulk` [#5042]
63
+ ```ruby
64
+ MyJob.perform_bulk([[1], [2], [3]])
65
+ ```
66
+ - Implement `queue_as`, `wait` and `wait_until` for ActiveJob compatibility [#5003]
67
+ - Scheduler now uses Lua to reduce Redis load and network roundtrips [#5044]
68
+ - Retry Redis operation if we get an `UNBLOCKED` Redis error [#4985]
69
+ - Run existing signal traps, if any, before running Sidekiq's trap [#4991]
70
+ - Fix fetch bug when using weighted queues which caused Sidekiq to stop
71
+ processing queues randomly [#5031]
72
+
73
+ 6.2.2
74
+ ---------
75
+
76
+ - Reduce retry jitter, add jitter to `sidekiq_retry_in` values [#4957]
77
+ - Minimize scheduler load on Redis at scale [#4882]
78
+ - Improve logging of delay jobs [#4904, BuonOno]
79
+ - Minor CSS improvements for buttons and tables, design PRs always welcome!
80
+ - Tweak Web UI `Cache-Control` header [#4966]
81
+ - Rename internal API class `Sidekiq::Job` to `Sidekiq::JobRecord` [#4955]
82
+
83
+ 6.2.1
84
+ ---------
85
+
86
+ - Update RTT warning logic to handle transient RTT spikes [#4851]
87
+ - Fix very low priority CVE on unescaped queue name [#4852]
88
+ - Add note about sessions and Rails apps in API mode
89
+
90
+ 6.2.0
91
+ ---------
92
+
93
+ - Store Redis RTT and log if poor [#4824]
94
+ - Add process/thread stats to Busy page [#4806]
95
+ - Improve Web UI on mobile devices [#4840]
96
+ - **Refactor Web UI session usage** [#4804]
97
+ Numerous people have hit "Forbidden" errors and struggled with Sidekiq's
98
+ Web UI session requirement. If you have code in your initializer for
99
+ Web sessions, it's quite possible it will need to be removed. Here's
100
+ an overview:
101
+ ```
102
+ Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
103
+ make sure you mount Sidekiq::Web *inside* your routes in `config/routes.rb` so
104
+ Sidekiq can reuse the Rails session:
105
+
106
+ Rails.application.routes.draw do
107
+ mount Sidekiq::Web => "/sidekiq"
108
+ ....
109
+ end
110
+
111
+ If this is a bare Rack app, use a session middleware before Sidekiq::Web:
112
+
113
+ # first, use IRB to create a shared secret key for sessions and commit it
114
+ require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
115
+
116
+ # now, update your Rack app to include the secret with a session cookie middleware
117
+ use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
118
+ run Sidekiq::Web
119
+
120
+ If this is a Rails app in API mode, you need to enable sessions.
121
+
122
+ https://guides.rubyonrails.org/api_app.html#using-session-middlewares
123
+ ```
124
+
125
+ 6.1.3
126
+ ---------
127
+
128
+ - Warn if Redis is configured to evict data under memory pressure [#4752]
129
+ - Add process RSS on the Busy page [#4717]
130
+
131
+ 6.1.2
132
+ ---------
133
+
134
+ - Improve readability in dark mode Web UI [#4674]
135
+ - Fix Web UI crash with corrupt session [#4672]
136
+ - Allow middleware to yield arguments [#4673, @eugeneius]
137
+ - Migrate CI from CircleCI to GitHub Actions [#4677]
138
+
139
+ 6.1.1
140
+ ---------
141
+
142
+ - Jobs are now sorted by age in the Busy Workers table. [#4641]
143
+ - Fix "check all" JS logic in Web UI [#4619]
144
+
145
+ 6.1.0
146
+ ---------
147
+
148
+ - Web UI - Dark Mode fixes [#4543, natematykiewicz]
149
+ - Ensure `Rack::ContentLength` is loaded as middleware for correct Web UI responses [#4541]
150
+ - Avoid exception dumping SSL store in Redis connection logging [#4532]
151
+ - Better error messages in Sidekiq::Client [#4549]
152
+ - Remove rack-protection, reimplement CSRF protection [#4588]
153
+ - Require redis-rb 4.2 [#4591]
154
+ - Update to jquery 1.12.4 [#4593]
155
+ - Refactor internal fetch logic and API [#4602]
156
+
157
+ 6.0.7
158
+ ---------
159
+
160
+ - Refactor systemd integration to work better with custom binaries [#4511]
161
+ - Don't connect to Redis at process exit if not needed [#4502]
162
+ - Remove Redis connection naming [#4479]
163
+ - Fix Redis Sentinel password redaction [#4499]
164
+ - Add Vietnamese locale (vi) [#4528]
165
+
166
+ 6.0.6
167
+ ---------
168
+
169
+ - **Integrate with systemd's watchdog and notification features** [#4488]
170
+ Set `Type=notify` in [sidekiq.service](https://github.com/mperham/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
171
+ - Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
172
+ - Fix edge case where a job can be pushed without a queue.
173
+ - Flush job stats at exit [#4498]
174
+ - Check RAILS_ENV before RACK_ENV [#4493]
175
+ - Add Lithuanian locale [#4476]
176
+
177
+ 6.0.5
178
+ ---------
179
+
180
+ - Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
181
+ - Update APIs to use `UNLINK`, not `DEL`. [#4449]
182
+ - Fix Ruby 2.7 warnings [#4412]
183
+ - Add support for `APP_ENV` [[95fa5d9]](https://github.com/mperham/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
184
+
185
+ 6.0.4
186
+ ---------
187
+
188
+ - Fix ActiveJob's `sidekiq_options` integration [#4404]
189
+ - Sidekiq Pro users will now see a Pause button next to each queue in
190
+ the Web UI, allowing them to pause queues manually [#4374, shayonj]
191
+ - Fix Sidekiq::Workers API unintentional change in 6.0.2 [#4387]
192
+
193
+
194
+ 6.0.3
195
+ ---------
196
+
197
+ - Fix `Sidekiq::Client.push_bulk` API which was erroneously putting
198
+ invalid `at` values in the job payloads [#4321]
199
+
200
+ 6.0.2
201
+ ---------
202
+
203
+ - Fix Sidekiq Enterprise's rolling restart functionality, broken by refactoring in 6.0.0. [#4334]
204
+ - More internal refactoring and performance tuning [fatkodima]
205
+
206
+ 6.0.1
207
+ ---------
208
+
209
+ - **Performance tuning**, Sidekiq should be 10-15% faster now [#4303, 4299,
210
+ 4269, fatkodima]
211
+ - **Dark Mode support in Web UI** (further design polish welcome!) [#4227, mperham,
212
+ fatkodima, silent-e]
213
+ - **Job-specific log levels**, allowing you to turn on debugging for
214
+ problematic workers. [fatkodima, #4287]
215
+ ```ruby
216
+ MyWorker.set(log_level: :debug).perform_async(...)
217
+ ```
218
+ - **Ad-hoc job tags**. You can tag your jobs with, e.g, subdomain, tenant, country,
219
+ locale, application, version, user/client, "alpha/beta/pro/ent", types of jobs,
220
+ teams/people responsible for jobs, additional metadata, etc.
221
+ Tags are shown on different pages with job listings. Sidekiq Pro users
222
+ can filter based on them [fatkodima, #4280]
223
+ ```ruby
224
+ class MyWorker
225
+ include Sidekiq::Worker
226
+ sidekiq_options tags: ['bank-ops', 'alpha']
227
+ ...
228
+ end
229
+ ```
230
+ - Fetch scheduled jobs in batches before pushing into specific queues.
231
+ This will decrease enqueueing time of scheduled jobs by a third. [fatkodima, #4273]
232
+ ```
233
+ ScheduledSet with 10,000 jobs
234
+ Before: 56.6 seconds
235
+ After: 39.2 seconds
236
+ ```
237
+ - Compress error backtraces before pushing into Redis, if you are
238
+ storing error backtraces, this will halve the size of your RetrySet
239
+ in Redis [fatkodima, #4272]
240
+ ```
241
+ RetrySet with 100,000 jobs
242
+ Before: 261 MB
243
+ After: 129 MB
244
+ ```
245
+ - Support display of ActiveJob 6.0 payloads in the Web UI [#4263]
246
+ - Add `SortedSet#scan` for pattern based scanning. For large sets this API will be **MUCH** faster
247
+ than standard iteration using each. [fatkodima, #4262]
248
+ ```ruby
249
+ Sidekiq::DeadSet.new.scan("UnreliableApi") do |job|
250
+ job.retry
251
+ end
252
+ ```
253
+ - Dramatically speed up SortedSet#find\_job(jid) by using Redis's ZSCAN
254
+ support, approx 10x faster. [fatkodima, #4259]
255
+ ```
256
+ zscan 0.179366 0.047727 0.227093 ( 1.161376)
257
+ enum 8.522311 0.419826 8.942137 ( 9.785079)
258
+ ```
259
+ - Respect rails' generators `test_framework` option and gracefully handle extra `worker` suffix on generator [fatkodima, #4256]
260
+ - Add ability to sort 'Enqueued' page on Web UI by position in the queue [fatkodima, #4248]
261
+ - Support `Client.push_bulk` with different delays [fatkodima, #4243]
262
+ ```ruby
263
+ Sidekiq::Client.push_bulk("class" => FooJob, "args" => [[1], [2]], "at" => [1.minute.from_now.to_f, 5.minutes.from_now.to_f])
264
+ ```
265
+ - Easier way to test enqueuing specific ActionMailer and ActiveRecord delayed jobs. Instead of manually
266
+ parsing embedded class, you can now test by fetching jobs for specific classes. [fatkodima, #4292]
267
+ ```ruby
268
+ assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs_for(FooMailer).size
269
+ ```
270
+ - Add `sidekiqmon` to gemspec executables [#4242]
271
+ - Gracefully handle `Sidekiq.logger = nil` [#4240]
272
+ - Inject Sidekiq::LogContext module if user-supplied logger does not include it [#4239]
273
+
274
+ 6.0
275
+ ---------
276
+
277
+ This release has major breaking changes. Read and test carefully in production.
278
+
279
+ - With Rails 6.0.2+, ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
280
+ features/internals like the retry subsystem. [#4213, pirj]
281
+ ```ruby
282
+ class MyJob < ActiveJob::Base
283
+ queue_as :myqueue
284
+ sidekiq_options retry: 10, backtrace: 20
285
+ def perform(...)
286
+ end
287
+ end
288
+ ```
289
+ - Logging has been redesigned to allow for pluggable log formatters:
290
+ ```ruby
291
+ Sidekiq.configure_server do |config|
292
+ config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
293
+ end
294
+ ```
295
+ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for more details.
296
+ - **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
297
+ variable. This variable is meant to hold the name of the environment
298
+ variable which contains your Redis URL, so that you can switch Redis
299
+ providers quickly and easily with a single variable change. It is not
300
+ meant to hold the actual Redis URL itself. If you want to manually set
301
+ the Redis URL (not recommended as it implies you have no failover),
302
+ then you may set `REDIS_URL` directly. [#3969]
303
+ - **BREAKING CHANGE** Increase default shutdown timeout from 8 seconds
304
+ to 25 seconds. Both Heroku and ECS now use 30 second shutdown timeout
305
+ by default and we want Sidekiq to take advantage of this time. If you
306
+ have deployment scripts which depend on the old default timeout, use `-t 8` to
307
+ get the old behavior. [#3968]
308
+ - **BREAKING CHANGE** Remove the daemonization, logfile and pidfile
309
+ arguments to Sidekiq. Use a proper process supervisor (e.g. systemd or
310
+ foreman) to manage Sidekiq. See the Deployment wiki page for links to
311
+ more resources.
312
+ - Integrate the StandardRB code formatter to ensure consistent code
313
+ styling. [#4114, gearnode]
314
+
315
+ 5.2.9
316
+ ---------
317
+
318
+ - Release Rack lock due to a cascade of CVEs. [#4566]
319
+ Pro-tip: don't lock Rack.
320
+
321
+ 5.2.8
322
+ ---------
323
+
324
+ - Lock to Rack 2.0.x to prevent future incompatibilities
325
+ - Fix invalid reference in `sidekiqctl`
326
+
327
+ 5.2.7
328
+ ---------
329
+
330
+ - Fix stale `enqueued_at` when retrying [#4149]
331
+ - Move build to [Circle CI](https://circleci.com/gh/mperham/sidekiq) [#4120]
332
+
333
+ 5.2.6
334
+ ---------
335
+
336
+ - Fix edge case where a job failure during Redis outage could result in a lost job [#4141]
337
+ - Better handling of malformed job arguments in payload [#4095]
338
+ - Restore bootstap's dropdown css component [#4099, urkle]
339
+ - Display human-friendly time diff for longer queue latencies [#4111, interlinked]
340
+ - Allow `Sidekiq::Worker#set` to be chained
341
+
342
+ 5.2.5
343
+ ---------
344
+
345
+ - Fix default usage of `config/sidekiq.yml` [#4077, Tensho]
346
+
347
+ 5.2.4
348
+ ---------
349
+
350
+ - Add warnings for various deprecations and changes coming in Sidekiq 6.0.
351
+ See the 6-0 branch. [#4056]
352
+ - Various improvements to the Sidekiq test suite and coverage [#4026, #4039, Tensho]
353
+
354
+ 5.2.3
355
+ ---------
356
+
357
+ - Warning message on invalid REDIS\_PROVIDER [#3970]
358
+ - Add `sidekiqctl status` command [#4003, dzunk]
359
+ - Update elapsed time calculatons to use monotonic clock [#3999]
360
+ - Fix a few issues with mobile Web UI styling [#3973, navied]
361
+ - Jobs with `retry: false` now go through the global `death_handlers`,
362
+ meaning you can take action on failed ephemeral jobs. [#3980, Benjamin-Dobell]
363
+ - Fix race condition in defining Workers. [#3997, mattbooks]
364
+
365
+ 5.2.2
366
+ ---------
367
+
368
+ - Raise error for duplicate queue names in config to avoid unexpected fetch algorithm change [#3911]
369
+ - Fix concurrency bug on JRuby [#3958, mattbooks]
370
+ - Add "Kill All" button to the retries page [#3938]
371
+
372
+ 5.2.1
373
+ -----------
374
+
375
+ - Fix concurrent modification error during heartbeat [#3921]
376
+
377
+ 5.2.0
378
+ -----------
379
+
380
+ - **Decrease default concurrency from 25 to 10** [#3892]
381
+ - Verify connection pool sizing upon startup [#3917]
382
+ - Smoother scheduling for large Sidekiq clusters [#3889]
383
+ - Switch Sidekiq::Testing impl from alias\_method to Module#prepend, for resiliency [#3852]
384
+ - Update Sidekiq APIs to use SCAN for scalability [#3848, ffiller]
385
+ - Remove concurrent-ruby gem dependency [#3830]
386
+ - Optimize Web UI's bootstrap.css [#3914]
387
+
388
+ 5.1.3
389
+ -----------
390
+
391
+ - Fix version comparison so Ruby 2.2.10 works. [#3808, nateberkopec]
392
+
393
+ 5.1.2
394
+ -----------
395
+
396
+ - Add link to docs in Web UI footer
397
+ - Fix crash on Ctrl-C in Windows [#3775, Bernica]
398
+ - Remove `freeze` calls on String constants. This is superfluous with Ruby
399
+ 2.3+ and `frozen_string_literal: true`. [#3759]
400
+ - Fix use of AR middleware outside of Rails [#3787]
401
+ - Sidekiq::Worker `sidekiq_retry_in` block can now return nil or 0 to use
402
+ the default backoff delay [#3796, dsalahutdinov]
403
+
404
+ 5.1.1
405
+ -----------
406
+
407
+ - Fix Web UI incompatibility with Redis 3.x gem [#3749]
408
+
409
+ 5.1.0
410
+ -----------
411
+
412
+ - **NEW** Global death handlers - called when your job exhausts all
413
+ retries and dies. Now you can take action when a job fails permanently. [#3721]
414
+ - **NEW** Enable ActiveRecord query cache within jobs by default [#3718, sobrinho]
415
+ This will prevent duplicate SELECTS; cache is cleared upon any UPDATE/INSERT/DELETE.
416
+ See the issue for how to bypass the cache or disable it completely.
417
+ - Scheduler timing is now more accurate, 15 -> 5 seconds [#3734]
418
+ - Exceptions during the :startup event will now kill the process [#3717]
419
+ - Make `Sidekiq::Client.via` reentrant [#3715]
420
+ - Fix use of Sidekiq logger outside of the server process [#3714]
421
+ - Tweak `constantize` to better match Rails class lookup. [#3701, caffeinated-tech]
422
+
423
+ 5.0.5
424
+ -----------
425
+
426
+ - Update gemspec to allow newer versions of the Redis gem [#3617]
427
+ - Refactor Worker.set so it can be memoized [#3602]
428
+ - Fix display of Redis URL in web footer, broken in 5.0.3 [#3560]
429
+ - Update `Sidekiq::Job#display_args` to avoid mutation [#3621]
430
+
431
+ 5.0.4
432
+ -----------
433
+
434
+ - Fix "slow startup" performance regression from 5.0.2. [#3525]
435
+ - Allow users to disable ID generation since some redis providers disable the CLIENT command. [#3521]
436
+
437
+ 5.0.3
438
+ -----------
439
+
440
+ - Fix overriding `class_attribute` core extension from ActiveSupport with Sidekiq one [PikachuEXE, #3499]
441
+ - Allow job logger to be overridden [AlfonsoUceda, #3502]
442
+ - Set a default Redis client identifier for debugging [#3516]
443
+ - Fix "Uninitialized constant" errors on startup with the delayed extensions [#3509]
444
+
445
+ 5.0.2
446
+ -----------
447
+
448
+ - fix broken release, thanks @nateberkopec
449
+
450
+ 5.0.1
451
+ -----------
452
+
453
+ - Fix incorrect server identity when daemonizing [jwilm, #3496]
454
+ - Work around error running Web UI against Redis Cluster [#3492]
455
+ - Remove core extensions, Sidekiq is now monkeypatch-free! [#3474]
456
+ - Reimplement Web UI's HTTP\_ACCEPT\_LANGUAGE parsing because the spec is utterly
457
+ incomprehensible for various edge cases. [johanlunds, natematykiewicz, #3449]
458
+ - Update `class_attribute` core extension to avoid warnings
459
+ - Expose `job_hash_context` from `Sidekiq::Logging` to support log customization
460
+
461
+ 5.0.0
462
+ -----------
463
+
464
+ - **BREAKING CHANGE** Job dispatch was refactored for safer integration with
465
+ Rails 5. The **Logging** and **RetryJobs** server middleware were removed and
466
+ functionality integrated directly into Sidekiq::Processor. These aren't
467
+ commonly used public APIs so this shouldn't impact most users.
468
+ ```
469
+ Sidekiq::Middleware::Server::RetryJobs -> Sidekiq::JobRetry
470
+ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
471
+ ```
472
+ - Quieting Sidekiq is now done via the TSTP signal, the USR1 signal is deprecated.
473
+ - The `delay` extension APIs are no longer available by default, you
474
+ must opt into them.
475
+ - The Web UI is now BiDi and can render RTL languages like Arabic, Farsi and Hebrew.
476
+ - Rails 3.2 and Ruby 2.0 and 2.1 are no longer supported.
477
+ - The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
478
+ - Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
479
+ of random hex bytes.
480
+ - Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
481
+
482
+ 4.2.10
483
+ -----------
484
+
485
+ - Scheduled jobs can now be moved directly to the Dead queue via API [#3390]
486
+ - Fix edge case leading to job duplication when using Sidekiq Pro's
487
+ reliability feature [#3388]
488
+ - Fix error class name display on retry page [#3348]
489
+ - More robust latency calculation [#3340]
490
+
491
+ 4.2.9
492
+ -----------
493
+
494
+ - Rollback [#3303] which broke Heroku Redis users [#3311]
495
+ - Add support for TSTP signal, for Sidekiq 5.0 forward compatibility. [#3302]
496
+
497
+ 4.2.8
498
+ -----------
499
+
500
+ - Fix rare edge case with Redis driver that can create duplicate jobs [#3303]
501
+ - Fix Rails 5 loading issue [#3275]
502
+ - Restore missing tooltips to timestamps in Web UI [#3310]
503
+ - Work on **Sidekiq 5.0** is now active! [#3301]
504
+
505
+ 4.2.7
506
+ -----------
507
+
508
+ - Add new integration testing to verify code loading and job execution
509
+ in development and production modes with Rails 4 and 5 [#3241]
510
+ - Fix delayed extensions in development mode [#3227, DarthSim]
511
+ - Use Worker's `retry` default if job payload does not have a retry
512
+ attribute [#3234, mlarraz]
513
+
514
+ 4.2.6
515
+ -----------
516
+
517
+ - Run Rails Executor when in production [#3221, eugeneius]
518
+
519
+ 4.2.5
520
+ -----------
521
+
522
+ - Re-enable eager loading of all code when running non-development Rails 5. [#3203]
523
+ - Better root URL handling for zany web servers [#3207]
524
+
3
525
  4.2.4
4
526
  -----------
5
527
 
@@ -19,6 +541,7 @@ Sidekiq::Web.set :sessions, false
19
541
  - Fix Web UI sharding support broken in 4.2.2. [#3169]
20
542
  - Fix timestamps not updating during UI polling [#3193, shaneog]
21
543
  - Relax rack-protection version to >= 1.5.0
544
+ - Provide consistent interface to exception handlers, changing the structure of the context hash. [#3161]
22
545
 
23
546
  4.2.2
24
547
  -----------
data/LICENSE CHANGED
@@ -4,6 +4,6 @@ Sidekiq is an Open Source project licensed under the terms of
4
4
  the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
5
5
  for license text.
6
6
 
7
- Sidekiq Pro has a commercial-friendly license allowing private forks
8
- and modifications of Sidekiq. Please see http://sidekiq.org/pro/ for
9
- more detail. You can find the commercial license terms in COMM-LICENSE.
7
+ Sidekiq Pro and Sidekiq Enterprise have a commercial-friendly license.
8
+ You can find the commercial license in COMM-LICENSE.txt.
9
+ Please see https://sidekiq.org for purchasing options.
data/README.md CHANGED
@@ -2,10 +2,7 @@ Sidekiq
2
2
  ==============
3
3
 
4
4
  [![Gem Version](https://badge.fury.io/rb/sidekiq.svg)](https://rubygems.org/gems/sidekiq)
5
- [![Code Climate](https://codeclimate.com/github/mperham/sidekiq.svg)](https://codeclimate.com/github/mperham/sidekiq)
6
- [![Build Status](https://travis-ci.org/mperham/sidekiq.svg)](https://travis-ci.org/mperham/sidekiq)
7
- [![Gitter Chat](https://badges.gitter.im/mperham/sidekiq.svg)](https://gitter.im/mperham/sidekiq)
8
-
5
+ ![Build](https://github.com/mperham/sidekiq/workflows/CI/badge.svg)
9
6
 
10
7
  Simple, efficient background processing for Ruby.
11
8
 
@@ -13,31 +10,27 @@ Sidekiq uses threads to handle many jobs at the same time in the
13
10
  same process. It does not require Rails but will integrate tightly with
14
11
  Rails to make background processing dead simple.
15
12
 
16
- Sidekiq is compatible with Resque. It uses the exact same
17
- message format as Resque so it can integrate into an existing Resque processing farm.
18
- You can have Sidekiq and Resque run side-by-side at the same time and
19
- use the Resque client to enqueue jobs in Redis to be processed by Sidekiq.
20
-
21
13
  Performance
22
14
  ---------------
23
15
 
24
- Version | Latency | Garbage created for 10,000 jobs | Time to process 100,000 jobs | Throughput
25
- -----------------|------|---------|---------|------------------------
26
- Sidekiq 4.0.0 | 10ms | 151 MB | 22 sec | **4500 jobs/sec**
27
- Sidekiq 3.5.1 | 22ms | 1257 MB | 125 sec | 800 jobs/sec
28
- Resque 1.25.2 | - | - | 420 sec | 240 jobs/sec
29
- DelayedJob 4.1.1 | - | - | 465 sec | 215 jobs/sec
16
+ Version | Latency | Garbage created for 10k jobs | Time to process 100k jobs | Throughput | Ruby
17
+ -----------------|------|---------|---------|------------------------|-----
18
+ Sidekiq 6.0.2 | 3 ms | 156 MB | 14.0 sec| **7100 jobs/sec** | MRI 2.6.3
19
+ Sidekiq 6.0.0 | 3 ms | 156 MB | 19 sec | 5200 jobs/sec | MRI 2.6.3
20
+ Sidekiq 4.0.0 | 10 ms | 151 MB | 22 sec | 4500 jobs/sec |
21
+ Sidekiq 3.5.1 | 22 ms | 1257 MB | 125 sec | 800 jobs/sec |
22
+ Resque 1.25.2 | - | - | 420 sec | 240 jobs/sec |
23
+ DelayedJob 4.1.1 | - | - | 465 sec | 215 jobs/sec |
30
24
 
25
+ This benchmark can be found in `bin/sidekiqload` and assumes a Redis network latency of 1ms.
31
26
 
32
27
  Requirements
33
28
  -----------------
34
29
 
35
- Sidekiq supports CRuby 2.0+ and JRuby 9k.
30
+ - Redis: 4.0+
31
+ - Ruby: MRI 2.5+ or JRuby 9.2+.
36
32
 
37
- All Rails releases >= 3.2 are officially supported.
38
-
39
- Redis 2.8 or greater is required. 3.0.3+ is recommended for large
40
- installations with thousands of worker threads.
33
+ Sidekiq 6.0 supports Rails 5.0+ but does not require it.
41
34
 
42
35
 
43
36
  Installation
@@ -50,9 +43,10 @@ Getting Started
50
43
  -----------------
51
44
 
52
45
  See the [Getting Started wiki page](https://github.com/mperham/sidekiq/wiki/Getting-Started) and follow the simple setup process.
53
- You can watch [Railscast #366](http://railscasts.com/episodes/366-sidekiq) to see Sidekiq in action. If you do everything right, you should see this:
46
+ You can watch [this YouTube playlist](https://www.youtube.com/playlist?list=PLjeHh2LSCFrWGT5uVjUuFKAcrcj5kSai1) to learn all about
47
+ Sidekiq and see its features in action. Here's the Web UI:
54
48
 
55
- ![Web UI](https://github.com/mperham/sidekiq/raw/master/examples/web-ui.png)
49
+ ![Web UI](https://github.com/mperham/sidekiq/raw/main/examples/web-ui.png)
56
50
 
57
51
 
58
52
  Want to Upgrade?
@@ -61,7 +55,7 @@ Want to Upgrade?
61
55
  I also sell Sidekiq Pro and Sidekiq Enterprise, extensions to Sidekiq which provide more
62
56
  features, a commercial-friendly license and allow you to support high
63
57
  quality open source development all at the same time. Please see the
64
- [Sidekiq](http://sidekiq.org/) homepage for more detail.
58
+ [Sidekiq](https://sidekiq.org/) homepage for more detail.
65
59
 
66
60
  Subscribe to the **[quarterly newsletter](https://tinyletter.com/sidekiq)** to stay informed about the latest
67
61
  features and changes to Sidekiq and its bigger siblings.
@@ -75,32 +69,25 @@ Problems?
75
69
  If you have a problem, please review the [FAQ](https://github.com/mperham/sidekiq/wiki/FAQ) and [Troubleshooting](https://github.com/mperham/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages.
76
70
  Searching the [issues](https://github.com/mperham/sidekiq/issues) for your problem is also a good idea.
77
71
 
72
+ Sidekiq Pro and Sidekiq Enterprise customers get private email support. You can purchase at https://sidekiq.org; email support@contribsys.com for help.
73
+
78
74
  Useful resources:
79
75
 
80
76
  * Product documentation is in the [wiki](https://github.com/mperham/sidekiq/wiki).
81
- * Release announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
82
- * Here's a [Reddit forum](https://reddit.com/r/sidekiq) dedicated to Sidekiq discussion
77
+ * Occasional announcements are made to the [@sidekiq](https://twitter.com/sidekiq) Twitter account.
83
78
  * The [Sidekiq tag](https://stackoverflow.com/questions/tagged/sidekiq) on Stack Overflow has lots of useful Q &amp; A.
84
79
 
85
- **No support via Twitter, 140 characters is not enough.**
86
-
87
80
  Every Friday morning is Sidekiq happy hour: I video chat and answer questions.
88
- See the [Sidekiq support page](http://sidekiq.org/support) for details.
89
-
90
- Thanks
91
- -----------------
92
-
93
- Sidekiq stays fast by using the [JProfiler java profiler](http://www.ej-technologies.com/products/jprofiler/overview.html) to find and fix
94
- performance problems on JRuby. Unfortunately MRI does not have good multithreaded profiling tools.
81
+ See the [Sidekiq support page](https://sidekiq.org/support.html) for details.
95
82
 
96
83
 
97
84
  License
98
85
  -----------------
99
86
 
100
- Please see [LICENSE](https://github.com/mperham/sidekiq/blob/master/LICENSE) for licensing details.
87
+ Please see [LICENSE](https://github.com/mperham/sidekiq/blob/main/LICENSE) for licensing details.
101
88
 
102
89
 
103
90
  Author
104
91
  -----------------
105
92
 
106
- Mike Perham, [@mperham](https://twitter.com/mperham) / [@sidekiq](https://twitter.com/sidekiq), [http://www.mikeperham.com](http://www.mikeperham.com) / [http://www.contribsys.com](http://www.contribsys.com)
93
+ Mike Perham, [@getajobmike](https://twitter.com/getajobmike) / [@sidekiq](https://twitter.com/sidekiq), [https://www.mikeperham.com](https://www.mikeperham.com) / [https://www.contribsys.com](https://www.contribsys.com)