sidekiq 4.2.4 → 6.2.1

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 (134) hide show
  1. checksums.yaml +5 -5
  2. data/Changes.md +445 -0
  3. data/LICENSE +1 -1
  4. data/README.md +21 -34
  5. data/bin/sidekiq +26 -2
  6. data/bin/sidekiqload +28 -38
  7. data/bin/sidekiqmon +8 -0
  8. data/lib/generators/sidekiq/templates/worker_spec.rb.erb +1 -1
  9. data/lib/generators/sidekiq/templates/worker_test.rb.erb +2 -2
  10. data/lib/generators/sidekiq/worker_generator.rb +21 -13
  11. data/lib/sidekiq/api.rb +347 -213
  12. data/lib/sidekiq/cli.rb +221 -212
  13. data/lib/sidekiq/client.rb +75 -52
  14. data/lib/sidekiq/delay.rb +41 -0
  15. data/lib/sidekiq/exception_handler.rb +12 -16
  16. data/lib/sidekiq/extensions/action_mailer.rb +13 -22
  17. data/lib/sidekiq/extensions/active_record.rb +13 -10
  18. data/lib/sidekiq/extensions/class_methods.rb +14 -11
  19. data/lib/sidekiq/extensions/generic_proxy.rb +10 -4
  20. data/lib/sidekiq/fetch.rb +38 -31
  21. data/lib/sidekiq/job_logger.rb +63 -0
  22. data/lib/sidekiq/job_retry.rb +263 -0
  23. data/lib/sidekiq/launcher.rb +169 -70
  24. data/lib/sidekiq/logger.rb +166 -0
  25. data/lib/sidekiq/manager.rb +17 -20
  26. data/lib/sidekiq/middleware/chain.rb +15 -5
  27. data/lib/sidekiq/middleware/i18n.rb +5 -7
  28. data/lib/sidekiq/monitor.rb +133 -0
  29. data/lib/sidekiq/paginator.rb +18 -14
  30. data/lib/sidekiq/processor.rb +161 -70
  31. data/lib/sidekiq/rails.rb +30 -73
  32. data/lib/sidekiq/redis_connection.rb +67 -20
  33. data/lib/sidekiq/scheduled.rb +61 -35
  34. data/lib/sidekiq/sd_notify.rb +149 -0
  35. data/lib/sidekiq/systemd.rb +24 -0
  36. data/lib/sidekiq/testing/inline.rb +2 -1
  37. data/lib/sidekiq/testing.rb +54 -26
  38. data/lib/sidekiq/util.rb +48 -15
  39. data/lib/sidekiq/version.rb +2 -1
  40. data/lib/sidekiq/web/action.rb +15 -15
  41. data/lib/sidekiq/web/application.rb +112 -89
  42. data/lib/sidekiq/web/csrf_protection.rb +180 -0
  43. data/lib/sidekiq/web/helpers.rb +153 -73
  44. data/lib/sidekiq/web/router.rb +27 -19
  45. data/lib/sidekiq/web.rb +64 -109
  46. data/lib/sidekiq/worker.rb +164 -41
  47. data/lib/sidekiq.rb +86 -60
  48. data/sidekiq.gemspec +24 -22
  49. data/web/assets/images/apple-touch-icon.png +0 -0
  50. data/web/assets/javascripts/application.js +25 -27
  51. data/web/assets/javascripts/dashboard.js +34 -38
  52. data/web/assets/stylesheets/application-dark.css +160 -0
  53. data/web/assets/stylesheets/application-rtl.css +246 -0
  54. data/web/assets/stylesheets/application.css +402 -12
  55. data/web/assets/stylesheets/bootstrap-rtl.min.css +9 -0
  56. data/web/assets/stylesheets/bootstrap.css +2 -2
  57. data/web/locales/ar.yml +81 -0
  58. data/web/locales/de.yml +14 -2
  59. data/web/locales/en.yml +4 -0
  60. data/web/locales/es.yml +4 -3
  61. data/web/locales/fa.yml +80 -0
  62. data/web/locales/fr.yml +3 -3
  63. data/web/locales/he.yml +79 -0
  64. data/web/locales/ja.yml +9 -4
  65. data/web/locales/lt.yml +83 -0
  66. data/web/locales/pl.yml +4 -4
  67. data/web/locales/ru.yml +4 -0
  68. data/web/locales/ur.yml +80 -0
  69. data/web/locales/vi.yml +83 -0
  70. data/web/views/_footer.erb +5 -2
  71. data/web/views/_job_info.erb +3 -2
  72. data/web/views/_nav.erb +4 -18
  73. data/web/views/_paging.erb +1 -1
  74. data/web/views/busy.erb +57 -19
  75. data/web/views/dashboard.erb +3 -3
  76. data/web/views/dead.erb +2 -2
  77. data/web/views/layout.erb +13 -2
  78. data/web/views/morgue.erb +19 -12
  79. data/web/views/queue.erb +22 -12
  80. data/web/views/queues.erb +13 -3
  81. data/web/views/retries.erb +22 -13
  82. data/web/views/retry.erb +3 -3
  83. data/web/views/scheduled.erb +7 -4
  84. metadata +42 -194
  85. data/.github/contributing.md +0 -32
  86. data/.github/issue_template.md +0 -4
  87. data/.gitignore +0 -12
  88. data/.travis.yml +0 -12
  89. data/3.0-Upgrade.md +0 -70
  90. data/4.0-Upgrade.md +0 -53
  91. data/COMM-LICENSE +0 -95
  92. data/Ent-Changes.md +0 -146
  93. data/Gemfile +0 -29
  94. data/Pro-2.0-Upgrade.md +0 -138
  95. data/Pro-3.0-Upgrade.md +0 -44
  96. data/Pro-Changes.md +0 -585
  97. data/Rakefile +0 -9
  98. data/bin/sidekiqctl +0 -99
  99. data/code_of_conduct.md +0 -50
  100. data/lib/sidekiq/core_ext.rb +0 -106
  101. data/lib/sidekiq/logging.rb +0 -106
  102. data/lib/sidekiq/middleware/server/active_record.rb +0 -13
  103. data/lib/sidekiq/middleware/server/logging.rb +0 -40
  104. data/lib/sidekiq/middleware/server/retry_jobs.rb +0 -205
  105. data/test/config.yml +0 -9
  106. data/test/env_based_config.yml +0 -11
  107. data/test/fake_env.rb +0 -1
  108. data/test/fixtures/en.yml +0 -2
  109. data/test/helper.rb +0 -75
  110. data/test/test_actors.rb +0 -138
  111. data/test/test_api.rb +0 -528
  112. data/test/test_cli.rb +0 -418
  113. data/test/test_client.rb +0 -266
  114. data/test/test_exception_handler.rb +0 -56
  115. data/test/test_extensions.rb +0 -127
  116. data/test/test_fetch.rb +0 -50
  117. data/test/test_launcher.rb +0 -95
  118. data/test/test_logging.rb +0 -35
  119. data/test/test_manager.rb +0 -50
  120. data/test/test_middleware.rb +0 -158
  121. data/test/test_processor.rb +0 -235
  122. data/test/test_rails.rb +0 -22
  123. data/test/test_redis_connection.rb +0 -132
  124. data/test/test_retry.rb +0 -326
  125. data/test/test_retry_exhausted.rb +0 -149
  126. data/test/test_scheduled.rb +0 -115
  127. data/test/test_scheduling.rb +0 -58
  128. data/test/test_sidekiq.rb +0 -107
  129. data/test/test_testing.rb +0 -143
  130. data/test/test_testing_fake.rb +0 -357
  131. data/test/test_testing_inline.rb +0 -94
  132. data/test/test_util.rb +0 -13
  133. data/test/test_web.rb +0 -726
  134. 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: 298711914bcb8534a9599c47b00b7410467ce324619ee70e7050d15c42f4c329
4
+ data.tar.gz: '007900de7a1558633520c61870a58eff341e9c11009441dbabe0fbc177e4ed99'
5
5
  SHA512:
6
- metadata.gz: ace3433e3bc81e986d56177f392a54f24e9a6f5cd1a050107d5273271cc61df5b022dfae32f99fb0cd74b71d5c9470daebca8073a5106bbe605f71d788196500
7
- data.tar.gz: abca98c2d32c438dfc4f60e8dabcea79cc0f28c616d62942a02f768bb0353199abd139aacdc12db546ee19e66b95fb0a36644104dd47c663f034f02882bffd24
6
+ metadata.gz: 592ecc114de13f0e43bba9193e1ffd3a973c89a43fac3ed1b750b6a70e29b5bf128a05657baf3fc2ccb77134f092efac055651907f01c0ed6d3c00d45a5ebdc9
7
+ data.tar.gz: a7baed1f1df451e8bd5183fec4631e49c0761e700c4c95fc070389894894a5fb90103d0adce29da797bc1cae72f8a1f21e71da0279e8c18cb62e3b3b5ae05f0a
data/Changes.md CHANGED
@@ -1,5 +1,449 @@
1
1
  # Sidekiq Changes
2
2
 
3
+ [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/master/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/master/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/master/Ent-Changes.md)
4
+
5
+ 6.2.1
6
+ ---------
7
+
8
+ - Update RTT warning logic to handle transient RTT spikes [#4851]
9
+ - Fix very low priority CVE on unescaped queue name [#4852]
10
+ - Add note about sessions and Rails apps in API mode
11
+
12
+ 6.2.0
13
+ ---------
14
+
15
+ - Store Redis RTT and log if poor [#4824]
16
+ - Add process/thread stats to Busy page [#4806]
17
+ - Improve Web UI on mobile devices [#4840]
18
+ - **Refactor Web UI session usage** [#4804]
19
+ Numerous people have hit "Forbidden" errors and struggled with Sidekiq's
20
+ Web UI session requirement. If you have code in your initializer for
21
+ Web sessions, it's quite possible it will need to be removed. Here's
22
+ an overview:
23
+ ```
24
+ Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
25
+ make sure you mount Sidekiq::Web *inside* your routes in `config/routes.rb` so
26
+ Sidekiq can reuse the Rails session:
27
+
28
+ Rails.application.routes.draw do
29
+ mount Sidekiq::Web => "/sidekiq"
30
+ ....
31
+ end
32
+
33
+ If this is a bare Rack app, use a session middleware before Sidekiq::Web:
34
+
35
+ # first, use IRB to create a shared secret key for sessions and commit it
36
+ require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
37
+
38
+ # now, update your Rack app to include the secret with a session cookie middleware
39
+ use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
40
+ run Sidekiq::Web
41
+
42
+ If this is a Rails app in API mode, you need to enable sessions.
43
+
44
+ https://guides.rubyonrails.org/api_app.html#using-session-middlewares
45
+ ```
46
+
47
+ 6.1.3
48
+ ---------
49
+
50
+ - Warn if Redis is configured to evict data under memory pressure [#4752]
51
+ - Add process RSS on the Busy page [#4717]
52
+
53
+ 6.1.2
54
+ ---------
55
+
56
+ - Improve readability in dark mode Web UI [#4674]
57
+ - Fix Web UI crash with corrupt session [#4672]
58
+ - Allow middleware to yield arguments [#4673, @eugeneius]
59
+ - Migrate CI from CircleCI to GitHub Actions [#4677]
60
+
61
+ 6.1.1
62
+ ---------
63
+
64
+ - Jobs are now sorted by age in the Busy Workers table. [#4641]
65
+ - Fix "check all" JS logic in Web UI [#4619]
66
+
67
+ 6.1.0
68
+ ---------
69
+
70
+ - Web UI - Dark Mode fixes [#4543, natematykiewicz]
71
+ - Ensure `Rack::ContentLength` is loaded as middleware for correct Web UI responses [#4541]
72
+ - Avoid exception dumping SSL store in Redis connection logging [#4532]
73
+ - Better error messages in Sidekiq::Client [#4549]
74
+ - Remove rack-protection, reimplement CSRF protection [#4588]
75
+ - Require redis-rb 4.2 [#4591]
76
+ - Update to jquery 1.12.4 [#4593]
77
+ - Refactor internal fetch logic and API [#4602]
78
+
79
+ 6.0.7
80
+ ---------
81
+
82
+ - Refactor systemd integration to work better with custom binaries [#4511]
83
+ - Don't connect to Redis at process exit if not needed [#4502]
84
+ - Remove Redis connection naming [#4479]
85
+ - Fix Redis Sentinel password redaction [#4499]
86
+ - Add Vietnamese locale (vi) [#4528]
87
+
88
+ 6.0.6
89
+ ---------
90
+
91
+ - **Integrate with systemd's watchdog and notification features** [#4488]
92
+ Set `Type=notify` in [sidekiq.service](https://github.com/mperham/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
93
+ - Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
94
+ - Fix edge case where a job can be pushed without a queue.
95
+ - Flush job stats at exit [#4498]
96
+ - Check RAILS_ENV before RACK_ENV [#4493]
97
+ - Add Lithuanian locale [#4476]
98
+
99
+ 6.0.5
100
+ ---------
101
+
102
+ - Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
103
+ - Update APIs to use `UNLINK`, not `DEL`. [#4449]
104
+ - Fix Ruby 2.7 warnings [#4412]
105
+ - Add support for `APP_ENV` [[95fa5d9]](https://github.com/mperham/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
106
+
107
+ 6.0.4
108
+ ---------
109
+
110
+ - Fix ActiveJob's `sidekiq_options` integration [#4404]
111
+ - Sidekiq Pro users will now see a Pause button next to each queue in
112
+ the Web UI, allowing them to pause queues manually [#4374, shayonj]
113
+ - Fix Sidekiq::Workers API unintentional change in 6.0.2 [#4387]
114
+
115
+
116
+ 6.0.3
117
+ ---------
118
+
119
+ - Fix `Sidekiq::Client.push_bulk` API which was erroneously putting
120
+ invalid `at` values in the job payloads [#4321]
121
+
122
+ 6.0.2
123
+ ---------
124
+
125
+ - Fix Sidekiq Enterprise's rolling restart functionality, broken by refactoring in 6.0.0. [#4334]
126
+ - More internal refactoring and performance tuning [fatkodima]
127
+
128
+ 6.0.1
129
+ ---------
130
+
131
+ - **Performance tuning**, Sidekiq should be 10-15% faster now [#4303, 4299,
132
+ 4269, fatkodima]
133
+ - **Dark Mode support in Web UI** (further design polish welcome!) [#4227, mperham,
134
+ fatkodima, silent-e]
135
+ - **Job-specific log levels**, allowing you to turn on debugging for
136
+ problematic workers. [fatkodima, #4287]
137
+ ```ruby
138
+ MyWorker.set(log_level: :debug).perform_async(...)
139
+ ```
140
+ - **Ad-hoc job tags**. You can tag your jobs with, e.g, subdomain, tenant, country,
141
+ locale, application, version, user/client, "alpha/beta/pro/ent", types of jobs,
142
+ teams/people responsible for jobs, additional metadata, etc.
143
+ Tags are shown on different pages with job listings. Sidekiq Pro users
144
+ can filter based on them [fatkodima, #4280]
145
+ ```ruby
146
+ class MyWorker
147
+ include Sidekiq::Worker
148
+ sidekiq_options tags: ['bank-ops', 'alpha']
149
+ ...
150
+ end
151
+ ```
152
+ - Fetch scheduled jobs in batches before pushing into specific queues.
153
+ This will decrease enqueueing time of scheduled jobs by a third. [fatkodima, #4273]
154
+ ```
155
+ ScheduledSet with 10,000 jobs
156
+ Before: 56.6 seconds
157
+ After: 39.2 seconds
158
+ ```
159
+ - Compress error backtraces before pushing into Redis, if you are
160
+ storing error backtraces, this will halve the size of your RetrySet
161
+ in Redis [fatkodima, #4272]
162
+ ```
163
+ RetrySet with 100,000 jobs
164
+ Before: 261 MB
165
+ After: 129 MB
166
+ ```
167
+ - Support display of ActiveJob 6.0 payloads in the Web UI [#4263]
168
+ - Add `SortedSet#scan` for pattern based scanning. For large sets this API will be **MUCH** faster
169
+ than standard iteration using each. [fatkodima, #4262]
170
+ ```ruby
171
+ Sidekiq::DeadSet.new.scan("UnreliableApi") do |job|
172
+ job.retry
173
+ end
174
+ ```
175
+ - Dramatically speed up SortedSet#find\_job(jid) by using Redis's ZSCAN
176
+ support, approx 10x faster. [fatkodima, #4259]
177
+ ```
178
+ zscan 0.179366 0.047727 0.227093 ( 1.161376)
179
+ enum 8.522311 0.419826 8.942137 ( 9.785079)
180
+ ```
181
+ - Respect rails' generators `test_framework` option and gracefully handle extra `worker` suffix on generator [fatkodima, #4256]
182
+ - Add ability to sort 'Enqueued' page on Web UI by position in the queue [fatkodima, #4248]
183
+ - Support `Client.push_bulk` with different delays [fatkodima, #4243]
184
+ ```ruby
185
+ Sidekiq::Client.push_bulk("class" => FooJob, "args" => [[1], [2]], "at" => [1.minute.from_now.to_f, 5.minutes.from_now.to_f])
186
+ ```
187
+ - Easier way to test enqueuing specific ActionMailer and ActiveRecord delayed jobs. Instead of manually
188
+ parsing embedded class, you can now test by fetching jobs for specific classes. [fatkodima, #4292]
189
+ ```ruby
190
+ assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs_for(FooMailer).size
191
+ ```
192
+ - Add `sidekiqmon` to gemspec executables [#4242]
193
+ - Gracefully handle `Sidekiq.logger = nil` [#4240]
194
+ - Inject Sidekiq::LogContext module if user-supplied logger does not include it [#4239]
195
+
196
+ 6.0
197
+ ---------
198
+
199
+ This release has major breaking changes. Read and test carefully in production.
200
+
201
+ - With Rails 6.0.2+, ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
202
+ features/internals like the retry subsystem. [#4213, pirj]
203
+ ```ruby
204
+ class MyJob < ActiveJob::Base
205
+ queue_as :myqueue
206
+ sidekiq_options retry: 10, backtrace: 20
207
+ def perform(...)
208
+ end
209
+ end
210
+ ```
211
+ - Logging has been redesigned to allow for pluggable log formatters:
212
+ ```ruby
213
+ Sidekiq.configure_server do |config|
214
+ config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
215
+ end
216
+ ```
217
+ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for more details.
218
+ - **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
219
+ variable. This variable is meant to hold the name of the environment
220
+ variable which contains your Redis URL, so that you can switch Redis
221
+ providers quickly and easily with a single variable change. It is not
222
+ meant to hold the actual Redis URL itself. If you want to manually set
223
+ the Redis URL (not recommended as it implies you have no failover),
224
+ then you may set `REDIS_URL` directly. [#3969]
225
+ - **BREAKING CHANGE** Increase default shutdown timeout from 8 seconds
226
+ to 25 seconds. Both Heroku and ECS now use 30 second shutdown timeout
227
+ by default and we want Sidekiq to take advantage of this time. If you
228
+ have deployment scripts which depend on the old default timeout, use `-t 8` to
229
+ get the old behavior. [#3968]
230
+ - **BREAKING CHANGE** Remove the daemonization, logfile and pidfile
231
+ arguments to Sidekiq. Use a proper process supervisor (e.g. systemd or
232
+ foreman) to manage Sidekiq. See the Deployment wiki page for links to
233
+ more resources.
234
+ - Integrate the StandardRB code formatter to ensure consistent code
235
+ styling. [#4114, gearnode]
236
+
237
+ 5.2.9
238
+ ---------
239
+
240
+ - Release Rack lock due to a cascade of CVEs. [#4566]
241
+ Pro-tip: don't lock Rack.
242
+
243
+ 5.2.8
244
+ ---------
245
+
246
+ - Lock to Rack 2.0.x to prevent future incompatibilities
247
+ - Fix invalid reference in `sidekiqctl`
248
+
249
+ 5.2.7
250
+ ---------
251
+
252
+ - Fix stale `enqueued_at` when retrying [#4149]
253
+ - Move build to [Circle CI](https://circleci.com/gh/mperham/sidekiq) [#4120]
254
+
255
+ 5.2.6
256
+ ---------
257
+
258
+ - Fix edge case where a job failure during Redis outage could result in a lost job [#4141]
259
+ - Better handling of malformed job arguments in payload [#4095]
260
+ - Restore bootstap's dropdown css component [#4099, urkle]
261
+ - Display human-friendly time diff for longer queue latencies [#4111, interlinked]
262
+ - Allow `Sidekiq::Worker#set` to be chained
263
+
264
+ 5.2.5
265
+ ---------
266
+
267
+ - Fix default usage of `config/sidekiq.yml` [#4077, Tensho]
268
+
269
+ 5.2.4
270
+ ---------
271
+
272
+ - Add warnings for various deprecations and changes coming in Sidekiq 6.0.
273
+ See the 6-0 branch. [#4056]
274
+ - Various improvements to the Sidekiq test suite and coverage [#4026, #4039, Tensho]
275
+
276
+ 5.2.3
277
+ ---------
278
+
279
+ - Warning message on invalid REDIS\_PROVIDER [#3970]
280
+ - Add `sidekiqctl status` command [#4003, dzunk]
281
+ - Update elapsed time calculatons to use monotonic clock [#3999]
282
+ - Fix a few issues with mobile Web UI styling [#3973, navied]
283
+ - Jobs with `retry: false` now go through the global `death_handlers`,
284
+ meaning you can take action on failed ephemeral jobs. [#3980, Benjamin-Dobell]
285
+ - Fix race condition in defining Workers. [#3997, mattbooks]
286
+
287
+ 5.2.2
288
+ ---------
289
+
290
+ - Raise error for duplicate queue names in config to avoid unexpected fetch algorithm change [#3911]
291
+ - Fix concurrency bug on JRuby [#3958, mattbooks]
292
+ - Add "Kill All" button to the retries page [#3938]
293
+
294
+ 5.2.1
295
+ -----------
296
+
297
+ - Fix concurrent modification error during heartbeat [#3921]
298
+
299
+ 5.2.0
300
+ -----------
301
+
302
+ - **Decrease default concurrency from 25 to 10** [#3892]
303
+ - Verify connection pool sizing upon startup [#3917]
304
+ - Smoother scheduling for large Sidekiq clusters [#3889]
305
+ - Switch Sidekiq::Testing impl from alias\_method to Module#prepend, for resiliency [#3852]
306
+ - Update Sidekiq APIs to use SCAN for scalability [#3848, ffiller]
307
+ - Remove concurrent-ruby gem dependency [#3830]
308
+ - Optimize Web UI's bootstrap.css [#3914]
309
+
310
+ 5.1.3
311
+ -----------
312
+
313
+ - Fix version comparison so Ruby 2.2.10 works. [#3808, nateberkopec]
314
+
315
+ 5.1.2
316
+ -----------
317
+
318
+ - Add link to docs in Web UI footer
319
+ - Fix crash on Ctrl-C in Windows [#3775, Bernica]
320
+ - Remove `freeze` calls on String constants. This is superfluous with Ruby
321
+ 2.3+ and `frozen_string_literal: true`. [#3759]
322
+ - Fix use of AR middleware outside of Rails [#3787]
323
+ - Sidekiq::Worker `sidekiq_retry_in` block can now return nil or 0 to use
324
+ the default backoff delay [#3796, dsalahutdinov]
325
+
326
+ 5.1.1
327
+ -----------
328
+
329
+ - Fix Web UI incompatibility with Redis 3.x gem [#3749]
330
+
331
+ 5.1.0
332
+ -----------
333
+
334
+ - **NEW** Global death handlers - called when your job exhausts all
335
+ retries and dies. Now you can take action when a job fails permanently. [#3721]
336
+ - **NEW** Enable ActiveRecord query cache within jobs by default [#3718, sobrinho]
337
+ This will prevent duplicate SELECTS; cache is cleared upon any UPDATE/INSERT/DELETE.
338
+ See the issue for how to bypass the cache or disable it completely.
339
+ - Scheduler timing is now more accurate, 15 -> 5 seconds [#3734]
340
+ - Exceptions during the :startup event will now kill the process [#3717]
341
+ - Make `Sidekiq::Client.via` reentrant [#3715]
342
+ - Fix use of Sidekiq logger outside of the server process [#3714]
343
+ - Tweak `constantize` to better match Rails class lookup. [#3701, caffeinated-tech]
344
+
345
+ 5.0.5
346
+ -----------
347
+
348
+ - Update gemspec to allow newer versions of the Redis gem [#3617]
349
+ - Refactor Worker.set so it can be memoized [#3602]
350
+ - Fix display of Redis URL in web footer, broken in 5.0.3 [#3560]
351
+ - Update `Sidekiq::Job#display_args` to avoid mutation [#3621]
352
+
353
+ 5.0.4
354
+ -----------
355
+
356
+ - Fix "slow startup" performance regression from 5.0.2. [#3525]
357
+ - Allow users to disable ID generation since some redis providers disable the CLIENT command. [#3521]
358
+
359
+ 5.0.3
360
+ -----------
361
+
362
+ - Fix overriding `class_attribute` core extension from ActiveSupport with Sidekiq one [PikachuEXE, #3499]
363
+ - Allow job logger to be overridden [AlfonsoUceda, #3502]
364
+ - Set a default Redis client identifier for debugging [#3516]
365
+ - Fix "Uninitialized constant" errors on startup with the delayed extensions [#3509]
366
+
367
+ 5.0.2
368
+ -----------
369
+
370
+ - fix broken release, thanks @nateberkopec
371
+
372
+ 5.0.1
373
+ -----------
374
+
375
+ - Fix incorrect server identity when daemonizing [jwilm, #3496]
376
+ - Work around error running Web UI against Redis Cluster [#3492]
377
+ - Remove core extensions, Sidekiq is now monkeypatch-free! [#3474]
378
+ - Reimplement Web UI's HTTP\_ACCEPT\_LANGUAGE parsing because the spec is utterly
379
+ incomprehensible for various edge cases. [johanlunds, natematykiewicz, #3449]
380
+ - Update `class_attribute` core extension to avoid warnings
381
+ - Expose `job_hash_context` from `Sidekiq::Logging` to support log customization
382
+
383
+ 5.0.0
384
+ -----------
385
+
386
+ - **BREAKING CHANGE** Job dispatch was refactored for safer integration with
387
+ Rails 5. The **Logging** and **RetryJobs** server middleware were removed and
388
+ functionality integrated directly into Sidekiq::Processor. These aren't
389
+ commonly used public APIs so this shouldn't impact most users.
390
+ ```
391
+ Sidekiq::Middleware::Server::RetryJobs -> Sidekiq::JobRetry
392
+ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
393
+ ```
394
+ - Quieting Sidekiq is now done via the TSTP signal, the USR1 signal is deprecated.
395
+ - The `delay` extension APIs are no longer available by default, you
396
+ must opt into them.
397
+ - The Web UI is now BiDi and can render RTL languages like Arabic, Farsi and Hebrew.
398
+ - Rails 3.2 and Ruby 2.0 and 2.1 are no longer supported.
399
+ - The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
400
+ - Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
401
+ of random hex bytes.
402
+ - Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
403
+
404
+ 4.2.10
405
+ -----------
406
+
407
+ - Scheduled jobs can now be moved directly to the Dead queue via API [#3390]
408
+ - Fix edge case leading to job duplication when using Sidekiq Pro's
409
+ reliability feature [#3388]
410
+ - Fix error class name display on retry page [#3348]
411
+ - More robust latency calculation [#3340]
412
+
413
+ 4.2.9
414
+ -----------
415
+
416
+ - Rollback [#3303] which broke Heroku Redis users [#3311]
417
+ - Add support for TSTP signal, for Sidekiq 5.0 forward compatibility. [#3302]
418
+
419
+ 4.2.8
420
+ -----------
421
+
422
+ - Fix rare edge case with Redis driver that can create duplicate jobs [#3303]
423
+ - Fix Rails 5 loading issue [#3275]
424
+ - Restore missing tooltips to timestamps in Web UI [#3310]
425
+ - Work on **Sidekiq 5.0** is now active! [#3301]
426
+
427
+ 4.2.7
428
+ -----------
429
+
430
+ - Add new integration testing to verify code loading and job execution
431
+ in development and production modes with Rails 4 and 5 [#3241]
432
+ - Fix delayed extensions in development mode [#3227, DarthSim]
433
+ - Use Worker's `retry` default if job payload does not have a retry
434
+ attribute [#3234, mlarraz]
435
+
436
+ 4.2.6
437
+ -----------
438
+
439
+ - Run Rails Executor when in production [#3221, eugeneius]
440
+
441
+ 4.2.5
442
+ -----------
443
+
444
+ - Re-enable eager loading of all code when running non-development Rails 5. [#3203]
445
+ - Better root URL handling for zany web servers [#3207]
446
+
3
447
  4.2.4
4
448
  -----------
5
449
 
@@ -19,6 +463,7 @@ Sidekiq::Web.set :sessions, false
19
463
  - Fix Web UI sharding support broken in 4.2.2. [#3169]
20
464
  - Fix timestamps not updating during UI polling [#3193, shaneog]
21
465
  - Relax rack-protection version to >= 1.5.0
466
+ - Provide consistent interface to exception handlers, changing the structure of the context hash. [#3161]
22
467
 
23
468
  4.2.2
24
469
  -----------
data/LICENSE CHANGED
@@ -5,5 +5,5 @@ the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
5
5
  for license text.
6
6
 
7
7
  Sidekiq Pro has a commercial-friendly license allowing private forks
8
- and modifications of Sidekiq. Please see http://sidekiq.org/pro/ for
8
+ and modifications of Sidekiq. Please see https://sidekiq.org/products/pro.html for
9
9
  more detail. You can find the commercial license terms in COMM-LICENSE.
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,7 +43,8 @@ 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
49
  ![Web UI](https://github.com/mperham/sidekiq/raw/master/examples/web-ui.png)
56
50
 
@@ -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,23 +69,16 @@ 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
@@ -103,4 +90,4 @@ Please see [LICENSE](https://github.com/mperham/sidekiq/blob/master/LICENSE) for
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)
data/bin/sidekiq CHANGED
@@ -6,13 +6,37 @@ $TESTING = false
6
6
 
7
7
  require_relative '../lib/sidekiq/cli'
8
8
 
9
+ def integrate_with_systemd
10
+ return unless ENV["NOTIFY_SOCKET"]
11
+
12
+ Sidekiq.configure_server do |config|
13
+ Sidekiq.logger.info "Enabling systemd notification integration"
14
+ require "sidekiq/sd_notify"
15
+ config.on(:startup) do
16
+ Sidekiq::SdNotify.ready
17
+ end
18
+ config.on(:shutdown) do
19
+ Sidekiq::SdNotify.stopping
20
+ end
21
+ Sidekiq.start_watchdog if Sidekiq::SdNotify.watchdog?
22
+ end
23
+ end
24
+
9
25
  begin
10
26
  cli = Sidekiq::CLI.instance
11
27
  cli.parse
28
+
29
+ integrate_with_systemd
30
+
12
31
  cli.run
13
32
  rescue => e
14
33
  raise e if $DEBUG
15
- STDERR.puts e.message
16
- STDERR.puts e.backtrace.join("\n")
34
+ if Sidekiq.error_handlers.length == 0
35
+ STDERR.puts e.message
36
+ STDERR.puts e.backtrace.join("\n")
37
+ else
38
+ cli.handle_exception e
39
+ end
40
+
17
41
  exit 1
18
42
  end