sidekiq 6.0.4 → 7.2.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.
- checksums.yaml +4 -4
- data/Changes.md +491 -10
- data/LICENSE.txt +9 -0
- data/README.md +47 -38
- data/bin/sidekiq +22 -3
- data/bin/sidekiqload +207 -117
- data/bin/sidekiqmon +4 -1
- data/lib/generators/sidekiq/job_generator.rb +57 -0
- data/lib/generators/sidekiq/templates/{worker.rb.erb → job.rb.erb} +2 -2
- data/lib/generators/sidekiq/templates/{worker_spec.rb.erb → job_spec.rb.erb} +1 -1
- data/lib/generators/sidekiq/templates/{worker_test.rb.erb → job_test.rb.erb} +1 -1
- data/lib/sidekiq/api.rb +418 -233
- data/lib/sidekiq/capsule.rb +127 -0
- data/lib/sidekiq/cli.rb +122 -86
- data/lib/sidekiq/client.rb +109 -97
- data/lib/sidekiq/{util.rb → component.rb} +14 -13
- data/lib/sidekiq/config.rb +287 -0
- data/lib/sidekiq/deploy.rb +62 -0
- data/lib/sidekiq/embedded.rb +61 -0
- data/lib/sidekiq/fetch.rb +43 -35
- data/lib/sidekiq/{worker.rb → job.rb} +161 -34
- data/lib/sidekiq/job_logger.rb +18 -30
- data/lib/sidekiq/job_retry.rb +102 -63
- data/lib/sidekiq/job_util.rb +107 -0
- data/lib/sidekiq/launcher.rb +180 -88
- data/lib/sidekiq/logger.rb +13 -47
- data/lib/sidekiq/manager.rb +40 -41
- data/lib/sidekiq/metrics/query.rb +155 -0
- data/lib/sidekiq/metrics/shared.rb +95 -0
- data/lib/sidekiq/metrics/tracking.rb +136 -0
- data/lib/sidekiq/middleware/chain.rb +99 -52
- data/lib/sidekiq/middleware/current_attributes.rb +95 -0
- data/lib/sidekiq/middleware/i18n.rb +6 -4
- data/lib/sidekiq/middleware/modules.rb +21 -0
- data/lib/sidekiq/monitor.rb +18 -5
- data/lib/sidekiq/paginator.rb +17 -9
- data/lib/sidekiq/processor.rb +81 -80
- data/lib/sidekiq/rails.rb +37 -21
- data/lib/sidekiq/redis_client_adapter.rb +111 -0
- data/lib/sidekiq/redis_connection.rb +22 -87
- data/lib/sidekiq/ring_buffer.rb +29 -0
- data/lib/sidekiq/scheduled.rb +102 -39
- data/lib/sidekiq/sd_notify.rb +149 -0
- data/lib/sidekiq/systemd.rb +24 -0
- data/lib/sidekiq/testing/inline.rb +4 -4
- data/lib/sidekiq/testing.rb +68 -78
- data/lib/sidekiq/transaction_aware_client.rb +44 -0
- data/lib/sidekiq/version.rb +2 -1
- data/lib/sidekiq/web/action.rb +3 -3
- data/lib/sidekiq/web/application.rb +132 -28
- data/lib/sidekiq/web/csrf_protection.rb +180 -0
- data/lib/sidekiq/web/helpers.rb +93 -65
- data/lib/sidekiq/web/router.rb +6 -5
- data/lib/sidekiq/web.rb +43 -74
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +86 -199
- data/sidekiq.gemspec +17 -8
- data/web/assets/images/apple-touch-icon.png +0 -0
- data/web/assets/javascripts/application.js +146 -61
- data/web/assets/javascripts/base-charts.js +106 -0
- data/web/assets/javascripts/chart.min.js +13 -0
- data/web/assets/javascripts/chartjs-plugin-annotation.min.js +7 -0
- data/web/assets/javascripts/dashboard-charts.js +182 -0
- data/web/assets/javascripts/dashboard.js +35 -274
- data/web/assets/javascripts/metrics.js +298 -0
- data/web/assets/stylesheets/application-dark.css +146 -124
- data/web/assets/stylesheets/application-rtl.css +2 -95
- data/web/assets/stylesheets/application.css +109 -529
- data/web/locales/ar.yml +71 -65
- data/web/locales/cs.yml +62 -62
- data/web/locales/da.yml +60 -53
- data/web/locales/de.yml +65 -65
- data/web/locales/el.yml +43 -24
- data/web/locales/en.yml +85 -67
- data/web/locales/es.yml +70 -54
- data/web/locales/fa.yml +65 -65
- data/web/locales/fr.yml +83 -62
- data/web/locales/gd.yml +99 -0
- data/web/locales/he.yml +65 -64
- data/web/locales/hi.yml +59 -59
- data/web/locales/it.yml +53 -53
- data/web/locales/ja.yml +75 -65
- data/web/locales/ko.yml +52 -52
- data/web/locales/lt.yml +83 -0
- data/web/locales/nb.yml +61 -61
- data/web/locales/nl.yml +52 -52
- data/web/locales/pl.yml +45 -45
- data/web/locales/pt-br.yml +83 -55
- data/web/locales/pt.yml +51 -51
- data/web/locales/ru.yml +68 -63
- data/web/locales/sv.yml +53 -53
- data/web/locales/ta.yml +60 -60
- data/web/locales/uk.yml +62 -61
- data/web/locales/ur.yml +64 -64
- data/web/locales/vi.yml +83 -0
- data/web/locales/zh-cn.yml +43 -16
- data/web/locales/zh-tw.yml +42 -8
- data/web/views/_footer.erb +6 -3
- data/web/views/_job_info.erb +19 -3
- data/web/views/_metrics_period_select.erb +12 -0
- data/web/views/_nav.erb +1 -1
- data/web/views/_paging.erb +2 -0
- data/web/views/_poll_link.erb +3 -6
- data/web/views/_summary.erb +7 -7
- data/web/views/busy.erb +73 -26
- data/web/views/dashboard.erb +48 -18
- data/web/views/dead.erb +1 -1
- data/web/views/filtering.erb +7 -0
- data/web/views/layout.erb +3 -2
- data/web/views/metrics.erb +91 -0
- data/web/views/metrics_for_job.erb +59 -0
- data/web/views/morgue.erb +11 -15
- data/web/views/queue.erb +25 -25
- data/web/views/queues.erb +13 -7
- data/web/views/retries.erb +12 -16
- data/web/views/retry.erb +1 -1
- data/web/views/scheduled.erb +13 -14
- metadata +65 -56
- data/.circleci/config.yml +0 -82
- data/.github/contributing.md +0 -32
- data/.github/issue_template.md +0 -11
- data/.gitignore +0 -13
- data/.standard.yml +0 -20
- data/3.0-Upgrade.md +0 -70
- data/4.0-Upgrade.md +0 -53
- data/5.0-Upgrade.md +0 -56
- data/6.0-Upgrade.md +0 -72
- data/COMM-LICENSE +0 -97
- data/Ent-2.0-Upgrade.md +0 -37
- data/Ent-Changes.md +0 -256
- data/Gemfile +0 -24
- data/Gemfile.lock +0 -199
- data/LICENSE +0 -9
- data/Pro-2.0-Upgrade.md +0 -138
- data/Pro-3.0-Upgrade.md +0 -44
- data/Pro-4.0-Upgrade.md +0 -35
- data/Pro-5.0-Upgrade.md +0 -25
- data/Pro-Changes.md +0 -776
- data/Rakefile +0 -10
- data/code_of_conduct.md +0 -50
- data/lib/generators/sidekiq/worker_generator.rb +0 -57
- data/lib/sidekiq/delay.rb +0 -41
- data/lib/sidekiq/exception_handler.rb +0 -27
- data/lib/sidekiq/extensions/action_mailer.rb +0 -47
- data/lib/sidekiq/extensions/active_record.rb +0 -42
- data/lib/sidekiq/extensions/class_methods.rb +0 -42
- data/lib/sidekiq/extensions/generic_proxy.rb +0 -31
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 30f824346db9b0ebf8ee13c6ac0101494e5fd6d05b4ed2ef3ad97c5b17ccbc10
|
4
|
+
data.tar.gz: bed22f02925116256550bbc34ef9decd70bdbca356d5d61abedd4d14a7dcac45
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 347e82cf6f215a1e4bd09c3f12d382be79d96bb83ccd1d09f928db19b936c2dd72c0f2e3a8988160086da7928a7911d84eddd005428c7b6a337763c4b60a3492
|
7
|
+
data.tar.gz: ef0a03f45d4d35e832f36b7a09ae0694838cd0cf3582dc20d53956bb5a61ba07811d410600b43a9bdf777e68dd2549910a125d23885afca8388b8513bb7ac8d1
|
data/Changes.md
CHANGED
@@ -1,6 +1,468 @@
|
|
1
1
|
# Sidekiq Changes
|
2
2
|
|
3
|
-
[Sidekiq Changes](https://github.com/
|
3
|
+
[Sidekiq Changes](https://github.com/sidekiq/sidekiq/blob/main/Changes.md) | [Sidekiq Pro Changes](https://github.com/sidekiq/sidekiq/blob/main/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/sidekiq/sidekiq/blob/main/Ent-Changes.md)
|
4
|
+
|
5
|
+
7.2.0
|
6
|
+
----------
|
7
|
+
|
8
|
+
- `sidekiq_retries_exhausted` can return `:discard` to avoid the deadset
|
9
|
+
and all death handlers [#6091]
|
10
|
+
- Metrics filtering by job class in Web UI [#5974]
|
11
|
+
- Better readability and formatting for numbers within the Web UI [#6080]
|
12
|
+
- Add explicit error if user code tries to nest test modes [#6078]
|
13
|
+
```ruby
|
14
|
+
Sidekiq::Testing.inline! # global setting
|
15
|
+
Sidekiq::Testing.fake! do # override within block
|
16
|
+
# ok
|
17
|
+
Sidekiq::Testing.inline! do # can't override the override
|
18
|
+
# not ok, nested
|
19
|
+
end
|
20
|
+
end
|
21
|
+
```
|
22
|
+
- **SECURITY** Forbid inline JavaScript execution in Web UI [#6074]
|
23
|
+
- Adjust redis-client adapter to avoid `method_missing` [#6083]
|
24
|
+
This can result in app code breaking if your app's Redis API usage was
|
25
|
+
depending on Sidekiq's adapter to correct invalid redis-client API usage.
|
26
|
+
One example:
|
27
|
+
```ruby
|
28
|
+
# bad, not redis-client native
|
29
|
+
# Unsupported command argument type: TrueClass (TypeError)
|
30
|
+
Sidekiq.redis { |c| c.set("key", "value", nx: true, ex: 15) }
|
31
|
+
# good
|
32
|
+
Sidekiq.redis { |c| c.set("key", "value", "nx", "ex", 15) }
|
33
|
+
```
|
34
|
+
|
35
|
+
7.1.6
|
36
|
+
----------
|
37
|
+
|
38
|
+
- The block forms of testing modes (inline, fake) are now thread-safe so you can have
|
39
|
+
a multithreaded test suite which uses different modes for different tests. [#6069]
|
40
|
+
- Fix breakage with non-Proc error handlers [#6065]
|
41
|
+
|
42
|
+
7.1.5
|
43
|
+
----------
|
44
|
+
|
45
|
+
- **FEATURE**: Job filtering within the Web UI. This feature has been open
|
46
|
+
sourced from Sidekiq Pro. [#6052]
|
47
|
+
- **API CHANGE** Error handlers now take three arguments `->(ex, context, config)`.
|
48
|
+
The previous calling convention will work until Sidekiq 8.0 but will print
|
49
|
+
out a deprecation warning. [#6051]
|
50
|
+
- Fix issue with the `batch_size` and `at` options in `S::Client.push_bulk` [#6040]
|
51
|
+
- Fix inline testing firing batch callbacks early [#6057]
|
52
|
+
- Use new log broadcast API in Rails 7.1 [#6054]
|
53
|
+
- Crash if user tries to use RESP2 `protocol: 2` [#6061]
|
54
|
+
|
55
|
+
7.1.4
|
56
|
+
----------
|
57
|
+
|
58
|
+
- Fix empty `retry_for` logic [#6035]
|
59
|
+
|
60
|
+
7.1.3
|
61
|
+
----------
|
62
|
+
|
63
|
+
- Add `sidekiq_options retry_for: 48.hours` to allow time-based retry windows [#6029]
|
64
|
+
- Support sidekiq_retry_in and sidekiq_retries_exhausted_block in ActiveJobs (#5994)
|
65
|
+
- Lowercase all Rack headers for Rack 3.0 [#5951]
|
66
|
+
- Validate Sidekiq::Web page refresh delay to avoid potential DoS,
|
67
|
+
CVE-2023-26141, thanks for reporting Keegan!
|
68
|
+
|
69
|
+
7.1.2
|
70
|
+
----------
|
71
|
+
|
72
|
+
- Mark Web UI assets as private so CDNs won't cache them [#5936]
|
73
|
+
- Fix stackoverflow when using Oj and the JSON log formatter [#5920]
|
74
|
+
- Remove spurious `enqueued_at` from scheduled ActiveJobs [#5937]
|
75
|
+
|
76
|
+
7.1.1
|
77
|
+
----------
|
78
|
+
|
79
|
+
- Support multiple CurrentAttributes [#5904]
|
80
|
+
- Speed up latency fetch with large queues on Redis <7 [#5910]
|
81
|
+
- Allow a larger default client pool [#5886]
|
82
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
83
|
+
|
84
|
+
7.1.0
|
85
|
+
----------
|
86
|
+
|
87
|
+
- Improve display of ActiveJob arguments in Web UI [#5825, cover]
|
88
|
+
- Update `push_bulk` to push `batch_size` jobs at a time and allow laziness [#5827, fatkodima]
|
89
|
+
This allows Sidekiq::Client to push unlimited jobs as long as it has enough memory for the batch_size.
|
90
|
+
- Update `perform_bulk` to use `push_bulk` internally.
|
91
|
+
- Change return value of `push_bulk` to map 1-to-1 with arguments.
|
92
|
+
If you call `push_bulk(args: [[1], [2], [3]])`, you will now always get
|
93
|
+
an array of 3 values as the result: `["jid1", nil, "jid3"]` where nil means
|
94
|
+
that particular job did not push successfully (possibly due to middleware
|
95
|
+
stopping it). Previously nil values were removed so it was impossible to tell
|
96
|
+
which jobs pushed successfully and which did not.
|
97
|
+
- Migrate away from all deprecated Redis commands [#5788]
|
98
|
+
Sidekiq will now print a warning if you use one of those deprecated commands.
|
99
|
+
- Prefix all Sidekiq thread names [#5872]
|
100
|
+
|
101
|
+
7.0.9
|
102
|
+
----------
|
103
|
+
|
104
|
+
- Restore confirmation dialogs in Web UI [#5881, shevaun]
|
105
|
+
- Increase fetch timeout to minimize ReadTimeoutError [#5874]
|
106
|
+
- Reverse histogram tooltip ordering [#5868]
|
107
|
+
- Add Scottish Gaelic (gd) locale [#5867, GunChleoc]
|
108
|
+
|
109
|
+
7.0.8
|
110
|
+
----------
|
111
|
+
|
112
|
+
- **SECURITY** Sanitize `period` input parameter on Metrics pages.
|
113
|
+
Specially crafted values can lead to XSS. This functionality
|
114
|
+
was introduced in 7.0.4. Thank you to spercex @ huntr.dev [#5694]
|
115
|
+
- Add job hash as 3rd parameter to the `sidekiq_retry_in` block.
|
116
|
+
|
117
|
+
7.0.7
|
118
|
+
----------
|
119
|
+
|
120
|
+
- Fix redis-client API usage which could result in stuck Redis
|
121
|
+
connections [#5823]
|
122
|
+
- Fix AS::Duration with `sidekiq_retry_in` [#5806]
|
123
|
+
- Restore dumping config options on startup with `-v` [#5822]
|
124
|
+
|
125
|
+
7.0.5,7.0.6
|
126
|
+
----------
|
127
|
+
|
128
|
+
- More context for debugging json unsafe errors [#5787]
|
129
|
+
|
130
|
+
7.0.4
|
131
|
+
----------
|
132
|
+
|
133
|
+
- Performance and memory optimizations [#5768, fatkodima]
|
134
|
+
- Add 1-8 hour period selector to Metrics pages [#5694]
|
135
|
+
- Fix process display with `sidekiqmon` [#5733]
|
136
|
+
|
137
|
+
7.0.3
|
138
|
+
----------
|
139
|
+
|
140
|
+
- Don't warn about memory policy on Redis Enterprise [#5712]
|
141
|
+
- Don't allow Quiet/Stop on embedded Sidekiq instances [#5716]
|
142
|
+
- Fix `size: X` for configuring the default Redis pool size [#5702]
|
143
|
+
- Improve the display of queue weights on Busy page [#5642]
|
144
|
+
- Freeze CurrentAttributes on a job once initially set [#5692]
|
145
|
+
|
146
|
+
7.0.2
|
147
|
+
----------
|
148
|
+
|
149
|
+
- Improve compatibility with custom loggers [#5673]
|
150
|
+
- Add queue weights on Busy page [#5640]
|
151
|
+
- Add BID link on job_info page if job is part of a Batch [#5623]
|
152
|
+
- Allow custom extensions to add rows/links within Job detail pages [#5624]
|
153
|
+
```ruby
|
154
|
+
Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
|
155
|
+
|
156
|
+
class AddAccountLink
|
157
|
+
include CGI::Util
|
158
|
+
def add_pair(job)
|
159
|
+
# yield a (name, value) pair
|
160
|
+
# You can include HTML tags and CSS, Sidekiq does not do any
|
161
|
+
# escaping so beware user data injection! Note how we use CGI's
|
162
|
+
# `h` escape helper.
|
163
|
+
aid = job["account_id"]
|
164
|
+
yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
|
165
|
+
end
|
166
|
+
end
|
167
|
+
```
|
168
|
+
|
169
|
+
7.0.1
|
170
|
+
----------
|
171
|
+
|
172
|
+
- Allow an embedding process to reuse its own heartbeat thread
|
173
|
+
- Update zh-cn localization
|
174
|
+
|
175
|
+
7.0.0
|
176
|
+
----------
|
177
|
+
|
178
|
+
- Embedded mode!
|
179
|
+
- Capsules!!
|
180
|
+
- Job Execution metrics!!!
|
181
|
+
- See `docs/7.0-Upgrade.md` for release notes
|
182
|
+
|
183
|
+
6.5.{10,11,12}
|
184
|
+
----------
|
185
|
+
|
186
|
+
- Fixes for Rails 7.1 [#6067, #6070]
|
187
|
+
|
188
|
+
6.5.9
|
189
|
+
----------
|
190
|
+
|
191
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
192
|
+
|
193
|
+
6.5.8
|
194
|
+
----------
|
195
|
+
|
196
|
+
- Fail if using a bad version of scout_apm [#5616]
|
197
|
+
- Add pagination to Busy page [#5556]
|
198
|
+
- Speed up WorkSet#each [#5559]
|
199
|
+
- Adjust CurrentAttributes to work with the String class name so we aren't referencing the Class within a Rails initializer [#5536]
|
200
|
+
|
201
|
+
6.5.7
|
202
|
+
----------
|
203
|
+
|
204
|
+
- Updates for JA and ZH locales
|
205
|
+
- Further optimizations for scheduled polling [#5513]
|
206
|
+
|
207
|
+
6.5.6
|
208
|
+
----------
|
209
|
+
|
210
|
+
- Fix deprecation warnings with redis-rb 4.8.0 [#5484]
|
211
|
+
- Lock redis-rb to < 5.0 as we are moving to redis-client in Sidekiq 7.0
|
212
|
+
|
213
|
+
6.5.5
|
214
|
+
----------
|
215
|
+
|
216
|
+
- Fix require issue with job_retry.rb [#5462]
|
217
|
+
- Improve Sidekiq::Web compatibility with Rack 3.x
|
218
|
+
|
219
|
+
6.5.4
|
220
|
+
----------
|
221
|
+
|
222
|
+
- Fix invalid code on Ruby 2.5 [#5460]
|
223
|
+
- Fix further metrics dependency issues [#5457]
|
224
|
+
|
225
|
+
6.5.3
|
226
|
+
----------
|
227
|
+
|
228
|
+
- Don't require metrics code without explicit opt-in [#5456]
|
229
|
+
|
230
|
+
6.5.2
|
231
|
+
----------
|
232
|
+
|
233
|
+
- [Job Metrics are under active development, help wanted!](https://github.com/sidekiq/sidekiq/wiki/Metrics#contributing) **BETA**
|
234
|
+
- Add `Context` column on queue page which shows any CurrentAttributes [#5450]
|
235
|
+
- `sidekiq_retry_in` may now return `:discard` or `:kill` to dynamically stop job retries [#5406]
|
236
|
+
- Smarter sorting of processes in /busy Web UI [#5398]
|
237
|
+
- Fix broken hamburger menu in mobile UI [#5428]
|
238
|
+
- Require redis-rb 4.5.0. Note that Sidekiq will break if you use the
|
239
|
+
[`Redis.exists_returns_integer = false`](https://github.com/redis/redis-rb/blob/master/CHANGELOG.md#450) flag. [#5394]
|
240
|
+
|
241
|
+
6.5.1
|
242
|
+
----------
|
243
|
+
|
244
|
+
- Fix `push_bulk` breakage [#5387]
|
245
|
+
|
246
|
+
6.5.0
|
247
|
+
---------
|
248
|
+
|
249
|
+
- Substantial refactoring of Sidekiq server internals, part of a larger effort
|
250
|
+
to reduce Sidekiq's internal usage of global methods and data, see [docs/global_to_local.md](docs/global_to_local.md) and [docs/middleware.md](docs/middleware.md).
|
251
|
+
- **Add beta support for the `redis-client` gem**. This will become the default Redis driver in Sidekiq 7.0. [#5298]
|
252
|
+
Read more: https://github.com/sidekiq/sidekiq/wiki/Using-redis-client
|
253
|
+
- **Add beta support for DB transaction-aware client** [#5291]
|
254
|
+
Add this line to your initializer and any jobs created during a transaction
|
255
|
+
will only be pushed to Redis **after the transaction commits**. You will need to add the
|
256
|
+
`after_commit_everywhere` gem to your Gemfile.
|
257
|
+
```ruby
|
258
|
+
Sidekiq.transactional_push!
|
259
|
+
```
|
260
|
+
This feature does not have a lot of production usage yet; please try it out and let us
|
261
|
+
know if you have any issues. It will be fully supported in Sidekiq 7.0 or removed if it
|
262
|
+
proves problematic.
|
263
|
+
- Fix regression with middleware arguments [#5312]
|
264
|
+
|
265
|
+
6.4.2
|
266
|
+
---------
|
267
|
+
|
268
|
+
- Strict argument checking now runs after client-side middleware [#5246]
|
269
|
+
- Fix page events with live polling [#5184]
|
270
|
+
- Many under-the-hood changes to remove all usage of the term "worker"
|
271
|
+
from the Sidekiq codebase and APIs. This mostly involved RDoc and local
|
272
|
+
variable names but a few constants and public APIs were changed. The old
|
273
|
+
APIs will be removed in Sidekiq 7.0.
|
274
|
+
```
|
275
|
+
Sidekiq::DEFAULT_WORKER_OPTIONS -> Sidekiq.default_job_options
|
276
|
+
Sidekiq.default_worker_options -> Sidekiq.default_job_options
|
277
|
+
Sidekiq::Queues["default"].jobs_by_worker(HardJob) -> Sidekiq::Queues["default"].jobs_by_class(HardJob)
|
278
|
+
```
|
279
|
+
|
280
|
+
6.4.1
|
281
|
+
---------
|
282
|
+
|
283
|
+
- Fix pipeline/multi deprecations in redis-rb 4.6
|
284
|
+
- Fix sidekiq.yml YAML load errors on Ruby 3.1 [#5141]
|
285
|
+
- Sharding support for `perform_bulk` [#5129]
|
286
|
+
- Refactor job logger for SPEEEEEEED
|
287
|
+
|
288
|
+
6.4.0
|
289
|
+
---------
|
290
|
+
|
291
|
+
- **SECURITY**: Validate input to avoid possible DoS in Web UI.
|
292
|
+
- Add **strict argument checking** [#5071]
|
293
|
+
Sidekiq will now log a warning if JSON-unsafe arguments are passed to `perform_async`.
|
294
|
+
Add `Sidekiq.strict_args!(false)` to your initializer to disable this warning.
|
295
|
+
This warning will switch to an exception in Sidekiq 7.0.
|
296
|
+
- Note that Delayed Extensions will be removed in Sidekiq 7.0 [#5076]
|
297
|
+
- Add `perform_{inline,sync}` in Sidekiq::Job to run a job synchronously [#5061, hasan-ally]
|
298
|
+
```ruby
|
299
|
+
SomeJob.perform_async(args...)
|
300
|
+
SomeJob.perform_sync(args...)
|
301
|
+
SomeJob.perform_inline(args...)
|
302
|
+
```
|
303
|
+
You can also dynamically redirect a job to run synchronously:
|
304
|
+
```ruby
|
305
|
+
SomeJob.set("sync": true).perform_async(args...) # will run via perform_inline
|
306
|
+
```
|
307
|
+
- Replace Sidekiq::Worker `app/workers` generator with Sidekiq::Job `app/sidekiq` generator [#5055]
|
308
|
+
```
|
309
|
+
bin/rails generate sidekiq:job ProcessOrderJob
|
310
|
+
```
|
311
|
+
- Fix job retries losing CurrentAttributes [#5090]
|
312
|
+
- Tweak shutdown to give long-running threads time to cleanup [#5095]
|
313
|
+
|
314
|
+
6.3.1
|
315
|
+
---------
|
316
|
+
|
317
|
+
- Fix keyword arguments error with CurrentAttributes on Ruby 3.0 [#5048]
|
318
|
+
|
319
|
+
6.3.0
|
320
|
+
---------
|
321
|
+
|
322
|
+
- **BREAK**: The Web UI has been refactored to remove jQuery. Any UI extensions
|
323
|
+
which use jQuery will break.
|
324
|
+
- **FEATURE**: Sidekiq.logger has been enhanced so any `Rails.logger`
|
325
|
+
output in jobs now shows up in the Sidekiq console. Remove any logger
|
326
|
+
hacks in your initializer and see if it Just Works™ now. [#5021]
|
327
|
+
- **FEATURE**: Add `Sidekiq::Job` alias for `Sidekiq::Worker`, to better
|
328
|
+
reflect industry standard terminology. You can now do this:
|
329
|
+
```ruby
|
330
|
+
class MyJob
|
331
|
+
include Sidekiq::Job
|
332
|
+
sidekiq_options ...
|
333
|
+
def perform(args)
|
334
|
+
end
|
335
|
+
end
|
336
|
+
```
|
337
|
+
- **FEATURE**: Support for serializing ActiveSupport::CurrentAttributes into each job. [#4982]
|
338
|
+
```ruby
|
339
|
+
# config/initializers/sidekiq.rb
|
340
|
+
require "sidekiq/middleware/current_attributes"
|
341
|
+
Sidekiq::CurrentAttributes.persist(Myapp::Current) # Your AS::CurrentAttributes singleton
|
342
|
+
```
|
343
|
+
- **FEATURE**: Add `Sidekiq::Worker.perform_bulk` for enqueuing jobs in bulk,
|
344
|
+
similar to `Sidekiq::Client.push_bulk` [#5042]
|
345
|
+
```ruby
|
346
|
+
MyJob.perform_bulk([[1], [2], [3]])
|
347
|
+
```
|
348
|
+
- Implement `queue_as`, `wait` and `wait_until` for ActiveJob compatibility [#5003]
|
349
|
+
- Scheduler now uses Lua to reduce Redis load and network roundtrips [#5044]
|
350
|
+
- Retry Redis operation if we get an `UNBLOCKED` Redis error [#4985]
|
351
|
+
- Run existing signal traps, if any, before running Sidekiq's trap [#4991]
|
352
|
+
- Fix fetch bug when using weighted queues which caused Sidekiq to stop
|
353
|
+
processing queues randomly [#5031]
|
354
|
+
|
355
|
+
6.2.2
|
356
|
+
---------
|
357
|
+
|
358
|
+
- Reduce retry jitter, add jitter to `sidekiq_retry_in` values [#4957]
|
359
|
+
- Minimize scheduler load on Redis at scale [#4882]
|
360
|
+
- Improve logging of delay jobs [#4904, BuonOno]
|
361
|
+
- Minor CSS improvements for buttons and tables, design PRs always welcome!
|
362
|
+
- Tweak Web UI `Cache-Control` header [#4966]
|
363
|
+
- Rename internal API class `Sidekiq::Job` to `Sidekiq::JobRecord` [#4955]
|
364
|
+
|
365
|
+
6.2.1
|
366
|
+
---------
|
367
|
+
|
368
|
+
- Update RTT warning logic to handle transient RTT spikes [#4851]
|
369
|
+
- Fix very low priority CVE on unescaped queue name [#4852]
|
370
|
+
- Add note about sessions and Rails apps in API mode
|
371
|
+
|
372
|
+
6.2.0
|
373
|
+
---------
|
374
|
+
|
375
|
+
- Store Redis RTT and log if poor [#4824]
|
376
|
+
- Add process/thread stats to Busy page [#4806]
|
377
|
+
- Improve Web UI on mobile devices [#4840]
|
378
|
+
- **Refactor Web UI session usage** [#4804]
|
379
|
+
Numerous people have hit "Forbidden" errors and struggled with Sidekiq's
|
380
|
+
Web UI session requirement. If you have code in your initializer for
|
381
|
+
Web sessions, it's quite possible it will need to be removed. Here's
|
382
|
+
an overview:
|
383
|
+
```
|
384
|
+
Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
|
385
|
+
make sure you mount Sidekiq::Web *inside* your routes in `config/routes.rb` so
|
386
|
+
Sidekiq can reuse the Rails session:
|
387
|
+
|
388
|
+
Rails.application.routes.draw do
|
389
|
+
mount Sidekiq::Web => "/sidekiq"
|
390
|
+
....
|
391
|
+
end
|
392
|
+
|
393
|
+
If this is a bare Rack app, use a session middleware before Sidekiq::Web:
|
394
|
+
|
395
|
+
# first, use IRB to create a shared secret key for sessions and commit it
|
396
|
+
require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
|
397
|
+
|
398
|
+
# now, update your Rack app to include the secret with a session cookie middleware
|
399
|
+
use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
|
400
|
+
run Sidekiq::Web
|
401
|
+
|
402
|
+
If this is a Rails app in API mode, you need to enable sessions.
|
403
|
+
|
404
|
+
https://guides.rubyonrails.org/api_app.html#using-session-middlewares
|
405
|
+
```
|
406
|
+
|
407
|
+
6.1.3
|
408
|
+
---------
|
409
|
+
|
410
|
+
- Warn if Redis is configured to evict data under memory pressure [#4752]
|
411
|
+
- Add process RSS on the Busy page [#4717]
|
412
|
+
|
413
|
+
6.1.2
|
414
|
+
---------
|
415
|
+
|
416
|
+
- Improve readability in dark mode Web UI [#4674]
|
417
|
+
- Fix Web UI crash with corrupt session [#4672]
|
418
|
+
- Allow middleware to yield arguments [#4673, @eugeneius]
|
419
|
+
- Migrate CI from CircleCI to GitHub Actions [#4677]
|
420
|
+
|
421
|
+
6.1.1
|
422
|
+
---------
|
423
|
+
|
424
|
+
- Jobs are now sorted by age in the Busy Workers table. [#4641]
|
425
|
+
- Fix "check all" JS logic in Web UI [#4619]
|
426
|
+
|
427
|
+
6.1.0
|
428
|
+
---------
|
429
|
+
|
430
|
+
- Web UI - Dark Mode fixes [#4543, natematykiewicz]
|
431
|
+
- Ensure `Rack::ContentLength` is loaded as middleware for correct Web UI responses [#4541]
|
432
|
+
- Avoid exception dumping SSL store in Redis connection logging [#4532]
|
433
|
+
- Better error messages in Sidekiq::Client [#4549]
|
434
|
+
- Remove rack-protection, reimplement CSRF protection [#4588]
|
435
|
+
- Require redis-rb 4.2 [#4591]
|
436
|
+
- Update to jquery 1.12.4 [#4593]
|
437
|
+
- Refactor internal fetch logic and API [#4602]
|
438
|
+
|
439
|
+
6.0.7
|
440
|
+
---------
|
441
|
+
|
442
|
+
- Refactor systemd integration to work better with custom binaries [#4511]
|
443
|
+
- Don't connect to Redis at process exit if not needed [#4502]
|
444
|
+
- Remove Redis connection naming [#4479]
|
445
|
+
- Fix Redis Sentinel password redaction [#4499]
|
446
|
+
- Add Vietnamese locale (vi) [#4528]
|
447
|
+
|
448
|
+
6.0.6
|
449
|
+
---------
|
450
|
+
|
451
|
+
- **Integrate with systemd's watchdog and notification features** [#4488]
|
452
|
+
Set `Type=notify` in [sidekiq.service](https://github.com/sidekiq/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
|
453
|
+
- Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
|
454
|
+
- Fix edge case where a job can be pushed without a queue.
|
455
|
+
- Flush job stats at exit [#4498]
|
456
|
+
- Check RAILS_ENV before RACK_ENV [#4493]
|
457
|
+
- Add Lithuanian locale [#4476]
|
458
|
+
|
459
|
+
6.0.5
|
460
|
+
---------
|
461
|
+
|
462
|
+
- Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
|
463
|
+
- Update APIs to use `UNLINK`, not `DEL`. [#4449]
|
464
|
+
- Fix Ruby 2.7 warnings [#4412]
|
465
|
+
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/sidekiq/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
|
4
466
|
|
5
467
|
6.0.4
|
6
468
|
---------
|
@@ -96,7 +558,7 @@ assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs_for(FooMailer).size
|
|
96
558
|
|
97
559
|
This release has major breaking changes. Read and test carefully in production.
|
98
560
|
|
99
|
-
- With Rails 6.0.
|
561
|
+
- With Rails 6.0.2+, ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
|
100
562
|
features/internals like the retry subsystem. [#4213, pirj]
|
101
563
|
```ruby
|
102
564
|
class MyJob < ActiveJob::Base
|
@@ -112,7 +574,7 @@ Sidekiq.configure_server do |config|
|
|
112
574
|
config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
|
113
575
|
end
|
114
576
|
```
|
115
|
-
See the [Logging wiki page](https://github.com/
|
577
|
+
See the [Logging wiki page](https://github.com/sidekiq/sidekiq/wiki/Logging) for more details.
|
116
578
|
- **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
|
117
579
|
variable. This variable is meant to hold the name of the environment
|
118
580
|
variable which contains your Redis URL, so that you can switch Redis
|
@@ -132,6 +594,25 @@ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for
|
|
132
594
|
- Integrate the StandardRB code formatter to ensure consistent code
|
133
595
|
styling. [#4114, gearnode]
|
134
596
|
|
597
|
+
5.2.10
|
598
|
+
---------
|
599
|
+
|
600
|
+
- Backport fix for CVE-2022-23837.
|
601
|
+
- Migrate to `exists?` for redis-rb.
|
602
|
+
- Lock redis-rb to <4.6 to avoid deprecations.
|
603
|
+
|
604
|
+
5.2.9
|
605
|
+
---------
|
606
|
+
|
607
|
+
- Release Rack lock due to a cascade of CVEs. [#4566]
|
608
|
+
Pro-tip: don't lock Rack.
|
609
|
+
|
610
|
+
5.2.8
|
611
|
+
---------
|
612
|
+
|
613
|
+
- Lock to Rack 2.0.x to prevent future incompatibilities
|
614
|
+
- Fix invalid reference in `sidekiqctl`
|
615
|
+
|
135
616
|
5.2.7
|
136
617
|
---------
|
137
618
|
|
@@ -285,7 +766,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
|
|
285
766
|
- The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
|
286
767
|
- Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
|
287
768
|
of random hex bytes.
|
288
|
-
- Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
|
769
|
+
- Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail.
|
289
770
|
|
290
771
|
4.2.10
|
291
772
|
-----------
|
@@ -503,7 +984,7 @@ Sidekiq::Queues.clear_all
|
|
503
984
|
- Sidekiq's internals have been completely overhauled for performance
|
504
985
|
and to remove dependencies. This has resulted in major speedups, as
|
505
986
|
[detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
|
506
|
-
- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
|
987
|
+
- See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail.
|
507
988
|
|
508
989
|
3.5.4
|
509
990
|
-----------
|
@@ -540,7 +1021,7 @@ Sidekiq::Queues.clear_all
|
|
540
1021
|
- **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
|
541
1022
|
- Add Ukrainian locale [#2561, elrakita]
|
542
1023
|
- Disconnect and retry Redis operations if we see a READONLY error [#2550]
|
543
|
-
- Add server middleware testing harness; see [wiki](https://github.com/
|
1024
|
+
- Add server middleware testing harness; see [wiki](https://github.com/sidekiq/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
|
544
1025
|
|
545
1026
|
3.5.0
|
546
1027
|
-----------
|
@@ -558,7 +1039,7 @@ Sidekiq::Queues.clear_all
|
|
558
1039
|
- Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
|
559
1040
|
reporting. [#2422] If you are running the Web UI as a standalone Rack app,
|
560
1041
|
ensure you have a [session middleware
|
561
|
-
configured](https://github.com/
|
1042
|
+
configured](https://github.com/sidekiq/sidekiq/wiki/Monitoring#standalone):
|
562
1043
|
```ruby
|
563
1044
|
use Rack::Session::Cookie, :secret => "some unique secret string here"
|
564
1045
|
```
|
@@ -770,7 +1251,7 @@ sidekiq_options :dead => false, :retry => 5
|
|
770
1251
|
3.0.0
|
771
1252
|
-----------
|
772
1253
|
|
773
|
-
Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
|
1254
|
+
Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes.
|
774
1255
|
|
775
1256
|
- **Dead Job Queue** - jobs which run out of retries are now moved to a dead
|
776
1257
|
job queue. These jobs must be retried manually or they will expire
|
@@ -814,7 +1295,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
|
|
814
1295
|
end
|
815
1296
|
```
|
816
1297
|
**Sharding support does require a breaking change to client-side
|
817
|
-
middleware, see 3.0-Upgrade.md.**
|
1298
|
+
middleware, see docs/3.0-Upgrade.md.**
|
818
1299
|
- New Chinese, Greek, Swedish and Czech translations for the Web UI.
|
819
1300
|
- Updated most languages translations for the new UI features.
|
820
1301
|
- **Remove official Capistrano integration** - this integration has been
|
@@ -942,7 +1423,7 @@ middleware, see 3.0-Upgrade.md.**
|
|
942
1423
|
appear to be doing any work. [#1194]
|
943
1424
|
- Sidekiq's testing behavior is now dynamic. You can choose between
|
944
1425
|
`inline` and `fake` behavior in your tests. See
|
945
|
-
[Testing](https://github.com/
|
1426
|
+
[Testing](https://github.com/sidekiq/sidekiq/wiki/Testing) for detail. [#1193]
|
946
1427
|
- The Retries table has a new column for the error message.
|
947
1428
|
- The Web UI topbar now contains the status and live poll button.
|
948
1429
|
- Orphaned worker records are now auto-vacuumed when you visit the
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
Copyright (c) Contributed Systems LLC
|
2
|
+
|
3
|
+
Sidekiq is an Open Source project licensed under the terms of
|
4
|
+
the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
|
5
|
+
for license text.
|
6
|
+
|
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.
|