sidekiq 5.2.7 → 8.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Changes.md +845 -8
- data/LICENSE.txt +9 -0
- data/README.md +54 -54
- data/bin/multi_queue_bench +271 -0
- data/bin/sidekiq +22 -3
- data/bin/sidekiqload +219 -112
- data/bin/sidekiqmon +11 -0
- data/bin/webload +69 -0
- data/lib/active_job/queue_adapters/sidekiq_adapter.rb +120 -0
- data/lib/generators/sidekiq/job_generator.rb +59 -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 +757 -373
- data/lib/sidekiq/capsule.rb +132 -0
- data/lib/sidekiq/cli.rb +210 -233
- data/lib/sidekiq/client.rb +145 -103
- data/lib/sidekiq/component.rb +128 -0
- data/lib/sidekiq/config.rb +315 -0
- data/lib/sidekiq/deploy.rb +64 -0
- data/lib/sidekiq/embedded.rb +64 -0
- data/lib/sidekiq/fetch.rb +49 -42
- data/lib/sidekiq/iterable_job.rb +56 -0
- data/lib/sidekiq/job/interrupt_handler.rb +24 -0
- data/lib/sidekiq/job/iterable/active_record_enumerator.rb +53 -0
- data/lib/sidekiq/job/iterable/csv_enumerator.rb +47 -0
- data/lib/sidekiq/job/iterable/enumerators.rb +135 -0
- data/lib/sidekiq/job/iterable.rb +306 -0
- data/lib/sidekiq/job.rb +385 -0
- data/lib/sidekiq/job_logger.rb +34 -7
- data/lib/sidekiq/job_retry.rb +164 -109
- data/lib/sidekiq/job_util.rb +113 -0
- data/lib/sidekiq/launcher.rb +208 -107
- data/lib/sidekiq/logger.rb +80 -0
- data/lib/sidekiq/manager.rb +42 -46
- data/lib/sidekiq/metrics/query.rb +184 -0
- data/lib/sidekiq/metrics/shared.rb +109 -0
- data/lib/sidekiq/metrics/tracking.rb +150 -0
- data/lib/sidekiq/middleware/chain.rb +113 -56
- data/lib/sidekiq/middleware/current_attributes.rb +119 -0
- data/lib/sidekiq/middleware/i18n.rb +7 -7
- data/lib/sidekiq/middleware/modules.rb +23 -0
- data/lib/sidekiq/monitor.rb +147 -0
- data/lib/sidekiq/paginator.rb +41 -16
- data/lib/sidekiq/processor.rb +146 -127
- data/lib/sidekiq/profiler.rb +72 -0
- data/lib/sidekiq/rails.rb +46 -43
- data/lib/sidekiq/redis_client_adapter.rb +113 -0
- data/lib/sidekiq/redis_connection.rb +79 -108
- data/lib/sidekiq/ring_buffer.rb +31 -0
- data/lib/sidekiq/scheduled.rb +112 -50
- data/lib/sidekiq/sd_notify.rb +149 -0
- data/lib/sidekiq/systemd.rb +26 -0
- data/lib/sidekiq/testing/inline.rb +6 -5
- data/lib/sidekiq/testing.rb +91 -90
- data/lib/sidekiq/transaction_aware_client.rb +51 -0
- data/lib/sidekiq/version.rb +7 -1
- data/lib/sidekiq/web/action.rb +125 -60
- data/lib/sidekiq/web/application.rb +363 -259
- data/lib/sidekiq/web/config.rb +120 -0
- data/lib/sidekiq/web/csrf_protection.rb +183 -0
- data/lib/sidekiq/web/helpers.rb +241 -120
- data/lib/sidekiq/web/router.rb +62 -71
- data/lib/sidekiq/web.rb +69 -161
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +94 -182
- data/sidekiq.gemspec +26 -16
- data/web/assets/images/apple-touch-icon.png +0 -0
- data/web/assets/javascripts/application.js +150 -61
- data/web/assets/javascripts/base-charts.js +120 -0
- data/web/assets/javascripts/chart.min.js +13 -0
- data/web/assets/javascripts/chartjs-adapter-date-fns.min.js +7 -0
- data/web/assets/javascripts/chartjs-plugin-annotation.min.js +7 -0
- data/web/assets/javascripts/dashboard-charts.js +194 -0
- data/web/assets/javascripts/dashboard.js +41 -293
- data/web/assets/javascripts/metrics.js +280 -0
- data/web/assets/stylesheets/style.css +766 -0
- data/web/locales/ar.yml +72 -65
- data/web/locales/cs.yml +63 -62
- data/web/locales/da.yml +61 -53
- data/web/locales/de.yml +66 -53
- data/web/locales/el.yml +44 -24
- data/web/locales/en.yml +94 -66
- data/web/locales/es.yml +92 -54
- data/web/locales/fa.yml +66 -65
- data/web/locales/fr.yml +83 -62
- data/web/locales/gd.yml +99 -0
- data/web/locales/he.yml +66 -64
- data/web/locales/hi.yml +60 -59
- data/web/locales/it.yml +93 -54
- data/web/locales/ja.yml +75 -64
- data/web/locales/ko.yml +53 -52
- data/web/locales/lt.yml +84 -0
- data/web/locales/nb.yml +62 -61
- data/web/locales/nl.yml +53 -52
- data/web/locales/pl.yml +46 -45
- data/web/locales/{pt-br.yml → pt-BR.yml} +84 -56
- data/web/locales/pt.yml +52 -51
- data/web/locales/ru.yml +69 -63
- data/web/locales/sv.yml +54 -53
- data/web/locales/ta.yml +61 -60
- data/web/locales/tr.yml +101 -0
- data/web/locales/uk.yml +86 -61
- data/web/locales/ur.yml +65 -64
- data/web/locales/vi.yml +84 -0
- data/web/locales/zh-CN.yml +106 -0
- data/web/locales/{zh-tw.yml → zh-TW.yml} +43 -9
- data/web/views/_footer.erb +31 -19
- data/web/views/_job_info.erb +94 -75
- data/web/views/_metrics_period_select.erb +15 -0
- data/web/views/_nav.erb +14 -21
- data/web/views/_paging.erb +23 -19
- data/web/views/_poll_link.erb +3 -6
- data/web/views/_summary.erb +23 -23
- data/web/views/busy.erb +139 -87
- data/web/views/dashboard.erb +82 -53
- data/web/views/dead.erb +31 -27
- data/web/views/filtering.erb +6 -0
- data/web/views/layout.erb +15 -29
- data/web/views/metrics.erb +84 -0
- data/web/views/metrics_for_job.erb +58 -0
- data/web/views/morgue.erb +60 -70
- data/web/views/profiles.erb +43 -0
- data/web/views/queue.erb +50 -39
- data/web/views/queues.erb +45 -29
- data/web/views/retries.erb +65 -75
- data/web/views/retry.erb +32 -27
- data/web/views/scheduled.erb +58 -52
- data/web/views/scheduled_job_info.erb +1 -1
- metadata +96 -76
- data/.circleci/config.yml +0 -61
- data/.github/contributing.md +0 -32
- data/.github/issue_template.md +0 -11
- data/.gitignore +0 -15
- data/.travis.yml +0 -11
- data/3.0-Upgrade.md +0 -70
- data/4.0-Upgrade.md +0 -53
- data/5.0-Upgrade.md +0 -56
- data/COMM-LICENSE +0 -97
- data/Ent-Changes.md +0 -238
- data/Gemfile +0 -23
- 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-Changes.md +0 -759
- data/Rakefile +0 -9
- data/bin/sidekiqctl +0 -20
- data/code_of_conduct.md +0 -50
- data/lib/generators/sidekiq/worker_generator.rb +0 -49
- data/lib/sidekiq/core_ext.rb +0 -1
- data/lib/sidekiq/ctl.rb +0 -221
- data/lib/sidekiq/delay.rb +0 -42
- data/lib/sidekiq/exception_handler.rb +0 -29
- data/lib/sidekiq/extensions/action_mailer.rb +0 -57
- data/lib/sidekiq/extensions/active_record.rb +0 -40
- data/lib/sidekiq/extensions/class_methods.rb +0 -40
- data/lib/sidekiq/extensions/generic_proxy.rb +0 -31
- data/lib/sidekiq/logging.rb +0 -122
- data/lib/sidekiq/middleware/server/active_record.rb +0 -23
- data/lib/sidekiq/util.rb +0 -66
- data/lib/sidekiq/worker.rb +0 -220
- data/web/assets/stylesheets/application-rtl.css +0 -246
- data/web/assets/stylesheets/application.css +0 -1144
- data/web/assets/stylesheets/bootstrap-rtl.min.css +0 -9
- data/web/assets/stylesheets/bootstrap.css +0 -5
- data/web/locales/zh-cn.yml +0 -68
- data/web/views/_status.erb +0 -4
data/Changes.md
CHANGED
@@ -1,6 +1,843 @@
|
|
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
|
+
8.0.5
|
6
|
+
----------
|
7
|
+
|
8
|
+
- Add `stopping?` method to AJ adapter for compatibility with the new AJ::Continuations feature [#6732]
|
9
|
+
- Further improvements to Rails boot compatibility [#6710]
|
10
|
+
- Add ability to disable CSRF middleware. SameSite cookies prevent
|
11
|
+
CSRF in a cleaner manner and are default in most browsers now.
|
12
|
+
CSRF code will be removed in Sidekiq 9.0. [#6739]
|
13
|
+
|
14
|
+
8.0.4
|
15
|
+
----------
|
16
|
+
|
17
|
+
- Adjust Rails integration for various edge cases [6713]
|
18
|
+
- Flush job iteration state when an error is raised [#6704]
|
19
|
+
- Update Accept-Language parsing in Web UI [#6721]
|
20
|
+
- Remove fixed-width in Web UI [#6686]
|
21
|
+
- Adjust CSRF middleware ordering [#6688]
|
22
|
+
- Support proxies when POSTing profiles to profiler.firefox.com [#6687]
|
23
|
+
- Dont swallow NoMethodErrors in CurrentAttributes [#6685]
|
24
|
+
|
25
|
+
8.0.3
|
26
|
+
----------
|
27
|
+
|
28
|
+
- Configure Vernier output directory [#6674]
|
29
|
+
- Rework Rails integration [#6669]
|
30
|
+
- Implement flash messages for the Web UI [#6675]
|
31
|
+
|
32
|
+
8.0.2
|
33
|
+
----------
|
34
|
+
|
35
|
+
- Add `on(:exit)` event to run code right before the Sidekiq process exits [#6637]
|
36
|
+
- Metrics page crashes with Rack 3.1+ [#6646]
|
37
|
+
|
38
|
+
8.0.1
|
39
|
+
----------
|
40
|
+
|
41
|
+
- Relax Redis requirement to 7.0 for compatibility with AWS and Ubuntu 24.04 LTS. [#6630]
|
42
|
+
|
43
|
+
8.0.0
|
44
|
+
----------
|
45
|
+
|
46
|
+
- **WARNING** The underlying class name for Active Jobs has changed from `ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper` to `Sidekiq::ActiveJob::Wrapper`.
|
47
|
+
The old name will still work in 8.x.
|
48
|
+
- **WARNING** The `created_at`, `enqueued_at`, `failed_at` and `retried_at` attributes are now stored as epoch milliseconds, rather than epoch floats.
|
49
|
+
This is meant to avoid precision issues with JSON and JavaScript's 53-bit Floats.
|
50
|
+
Example: `"created_at" => 1234567890.123456` -> `"created_at" => 1234567890123`.
|
51
|
+
- **NEW FEATURE** Job Profiling is now supported with [Vernier](https://vernier.prof)
|
52
|
+
which makes it really easy to performance tune your slow jobs.
|
53
|
+
The Web UI contains a new **Profiles** tab to view any collected profile data.
|
54
|
+
Please read the new [Profiling](https://github.com/sidekiq/sidekiq/wiki/Profiling) wiki page for details.
|
55
|
+
- **NEW FEATURE** Job Metrics now store up to 72 hours of data and the Web UI allows display of 24/48/72 hours. [#6614]
|
56
|
+
- CurrentAttribute support now uses `ActiveJob::Arguments` to serialize the context object, supporting Symbols and GlobalID.
|
57
|
+
The change should be backwards compatible. [#6510]
|
58
|
+
- Freshen up `Sidekiq::Web` to simplify the code and improve security [#6532]
|
59
|
+
The CSS has been rewritten from scratch to remove the Bootstrap framework.
|
60
|
+
- Add `on_cancel` callback for iterable jobs [#6607]
|
61
|
+
- Add `cursor` reader to get the current cursor inside iterable jobs [#6606]
|
62
|
+
- Default error logging has been modified to use Ruby's `Exception#detailed_message` and `#full_message` APIs.
|
63
|
+
- CI now runs against Redis, Dragonfly and Valkey.
|
64
|
+
- Job tags now allow custom CSS display [#6595]
|
65
|
+
- The Web UI's language picker now shows options in the native language
|
66
|
+
- Remove global variable usage within the codebase
|
67
|
+
- Colorize and adjust logging for easier reading
|
68
|
+
- Adjust Sidekiq's default thread priority to -1 for a 50ms timeslice.
|
69
|
+
This can help avoid TimeoutErrors when Sidekiq is overloaded. [#6543]
|
70
|
+
- Use `Logger#with_level`, remove Sidekiq's custom impl
|
71
|
+
- Remove `base64` gem dependency
|
72
|
+
- Support: (Dragonfly 1.27+, Valkey 7.2+, Redis 7.2+), Ruby 3.2+, Rails 7.0+
|
73
|
+
|
74
|
+
7.3.10
|
75
|
+
----------
|
76
|
+
|
77
|
+
- Deprecate Redis :password as a String to avoid log disclosure. [#6625]
|
78
|
+
Use a Proc instead: `config.redis = { password: ->(username) { "password" } }`
|
79
|
+
|
80
|
+
7.3.9
|
81
|
+
----------
|
82
|
+
|
83
|
+
- Only require activejob if necessary [#6584]
|
84
|
+
You might get `uninitialized constant Sidekiq::ActiveJob` if you
|
85
|
+
`require 'sidekiq'` before `require 'rails'`.
|
86
|
+
- Fix iterable job cancellation [#6589]
|
87
|
+
- Web UI accessibility improvements [#6604]
|
88
|
+
|
89
|
+
7.3.8
|
90
|
+
----------
|
91
|
+
|
92
|
+
- Fix dead tag links [#6554]
|
93
|
+
- Massive Web UI performance improvement, some pages up to 15x faster [#6555]
|
94
|
+
|
95
|
+
7.3.7
|
96
|
+
----------
|
97
|
+
|
98
|
+
- Backport `Sidekiq::Web.configure` for compatibility with 8.0 [#6532]
|
99
|
+
- Backport `url_params(key)` and `route_params(key)` for compatibility with 8.0 [#6532]
|
100
|
+
- Various fixes for UI filtering [#6508]
|
101
|
+
- Tune `inspect` for internal S::Components to keep size managable [#6553]
|
102
|
+
|
103
|
+
7.3.6
|
104
|
+
----------
|
105
|
+
|
106
|
+
- Forward compatibility fixes for Ruby 3.4
|
107
|
+
- Filtering in the Web UI now works via GET so you can bookmark a filtered view. [#6497]
|
108
|
+
|
109
|
+
7.3.5
|
110
|
+
----------
|
111
|
+
|
112
|
+
- Reimplement `retry_all` and `kill_all` API methods to use ZPOPMIN,
|
113
|
+
approximately 30-60% faster. [#6481]
|
114
|
+
- Add preload testing binary at `examples/testing/sidekiq_boot` to verify your Rails app boots correctly with Sidekiq Enterprise's app preloading.
|
115
|
+
- Fix circular require with ActiveJob adapter [#6477]
|
116
|
+
- Fix potential race condition leading to incorrect serialized values for CurrentAttributes [#6475]
|
117
|
+
- Restore missing elapsed time when default job logging is disabled
|
118
|
+
|
119
|
+
7.3.4
|
120
|
+
----------
|
121
|
+
|
122
|
+
- Fix FrozenError when starting Sidekiq [#6470]
|
123
|
+
|
124
|
+
7.3.3
|
125
|
+
----------
|
126
|
+
|
127
|
+
- Freeze global configuration once boot is complete, to avoid configuration race conditions [#6466, #6465]
|
128
|
+
- Sidekiq now warns if a job iteration takes longer than the `-t` timeout setting (defaults to 25 seconds)
|
129
|
+
- Iteration callbacks now have easy access to job arguments via the `arguments` method:
|
130
|
+
```ruby
|
131
|
+
def on_stop
|
132
|
+
p arguments # => `[123, "string", {"key" => "value"}]`
|
133
|
+
id, str, hash = arguments
|
134
|
+
end
|
135
|
+
```
|
136
|
+
- Iterable jobs can be cancelled via `Sidekiq::Client#cancel!`:
|
137
|
+
```ruby
|
138
|
+
c = Sidekiq::Client.new
|
139
|
+
jid = c.push("class" => SomeJob, "args" => [123])
|
140
|
+
c.cancel!(jid) # => true
|
141
|
+
```
|
142
|
+
- Take over support for ActiveJob's `:sidekiq` adapter [#6430, fatkodima]
|
143
|
+
- Ensure CurrentAttributes are in scope when creating batch callbacks [#6455]
|
144
|
+
- Add `Sidekiq.gem_version` API.
|
145
|
+
- Update Ukranian translations
|
146
|
+
|
147
|
+
7.3.2
|
148
|
+
----------
|
149
|
+
|
150
|
+
- Adjust ActiveRecord batch iteration to restart an interrupted batch from the beginning.
|
151
|
+
Each batch should be processed as a single transaction in order to be idempotent. [#6405]
|
152
|
+
- Fix typo in Sidekiq::DeadSet#kill [#6397]
|
153
|
+
- Fix CSS issue with bottom bar in Web UI [#6414]
|
154
|
+
|
155
|
+
7.3.1
|
156
|
+
----------
|
157
|
+
|
158
|
+
- Don't count job interruptions as failures in metrics [#6386]
|
159
|
+
- Add frozen string literal to a number of .rb files.
|
160
|
+
- Fix frozen string error with style_tag and script_tag [#6371]
|
161
|
+
- Fix an error on Ruby 2.7 because of usage of `Hash#except` [#6376]
|
162
|
+
|
163
|
+
7.3.0
|
164
|
+
----------
|
165
|
+
|
166
|
+
- **NEW FEATURE** Add `Sidekiq::IterableJob`, iteration support for long-running jobs. [#6286, fatkodima]
|
167
|
+
Iterable jobs are interruptible and can restart quickly if
|
168
|
+
running during a deploy. You must ensure that `each_iteration`
|
169
|
+
doesn't take more than Sidekiq's `-t` timeout (default: 25 seconds). Iterable jobs must not implement `perform`.
|
170
|
+
```ruby
|
171
|
+
class ProcessArrayJob
|
172
|
+
include Sidekiq::IterableJob
|
173
|
+
def build_enumerator(*args, **kwargs)
|
174
|
+
array_enumerator(args, **kwargs)
|
175
|
+
end
|
176
|
+
def each_iteration(arg)
|
177
|
+
puts arg
|
178
|
+
end
|
179
|
+
end
|
180
|
+
ProcessArrayJob.perform_async(1, 2, 3)
|
181
|
+
```
|
182
|
+
See the [Iteration](//github.com/sidekiq/sidekiq/wiki/Iteration) wiki page and the RDoc in `Sidekiq::IterableJob`.
|
183
|
+
This feature should be considered BETA until the next minor release.
|
184
|
+
- **SECURITY** The Web UI no longer allows extensions to use `<script>`.
|
185
|
+
Adjust CSP to disallow inline scripts within the Web UI. Please see
|
186
|
+
`examples/webui-ext` for how to register Web UI extensions and use
|
187
|
+
dynamic CSS and JS. This will make Sidekiq immune to XSS attacks. [#6270]
|
188
|
+
- Add config option, `:skip_default_job_logging` to disable Sidekiq's default
|
189
|
+
start/finish job logging. [#6200]
|
190
|
+
- Allow `Sidekiq::Limiter.redis` to use Redis Cluster [#6288]
|
191
|
+
- Retain CurrentAttributeѕ after inline execution [#6307]
|
192
|
+
- Ignore non-existent CurrentAttributes attributes when restoring [#6341]
|
193
|
+
- Raise default Redis {read,write,connect} timeouts from 1 to 3 seconds
|
194
|
+
to minimize ReadTimeoutErrors [#6162]
|
195
|
+
- Add `logger` as a dependency since it will become bundled in Ruby 3.5 [#6320]
|
196
|
+
- Ignore unsupported locales in the Web UI [#6313]
|
197
|
+
|
198
|
+
7.2.4
|
199
|
+
----------
|
200
|
+
|
201
|
+
- Fix XSS in metrics filtering introduced in 7.2.0, CVE-2024-32887
|
202
|
+
Thanks to @UmerAdeemCheema for the security report.
|
203
|
+
|
204
|
+
7.2.3
|
205
|
+
----------
|
206
|
+
|
207
|
+
- [Support Dragonfly.io](https://www.mikeperham.com/2024/02/01/supporting-dragonfly/) as an alternative Redis implementation
|
208
|
+
- Fix error unpacking some compressed error backtraces [#6241]
|
209
|
+
- Fix potential heartbeat data leak [#6227]
|
210
|
+
- Add ability to find a currently running work by jid [#6212, fatkodima]
|
211
|
+
|
212
|
+
7.2.2
|
213
|
+
----------
|
214
|
+
|
215
|
+
- Add `Process.warmup` call in Ruby 3.3+
|
216
|
+
- Batch jobs now skip transactional push [#6160]
|
217
|
+
|
218
|
+
7.2.1
|
219
|
+
----------
|
220
|
+
|
221
|
+
- Add `Sidekiq::Work` type which replaces the raw Hash as the third parameter in
|
222
|
+
`Sidekiq::WorkSet#each { |pid, tid, hash| ... }` [#6145]
|
223
|
+
- **DEPRECATED**: direct access to the attributes within the `hash` block parameter above.
|
224
|
+
The `Sidekiq::Work` instance contains accessor methods to get at the same data, e.g.
|
225
|
+
```ruby
|
226
|
+
work["queue"] # Old
|
227
|
+
work.queue # New
|
228
|
+
```
|
229
|
+
- Fix Ruby 3.3 warnings around `base64` gem [#6151, earlopain]
|
230
|
+
|
231
|
+
7.2.0
|
232
|
+
----------
|
233
|
+
|
234
|
+
- `sidekiq_retries_exhausted` can return `:discard` to avoid the deadset
|
235
|
+
and all death handlers [#6091]
|
236
|
+
- Metrics filtering by job class in Web UI [#5974]
|
237
|
+
- Better readability and formatting for numbers within the Web UI [#6080]
|
238
|
+
- Add explicit error if user code tries to nest test modes [#6078]
|
239
|
+
```ruby
|
240
|
+
Sidekiq::Testing.inline! # global setting
|
241
|
+
Sidekiq::Testing.fake! do # override within block
|
242
|
+
# ok
|
243
|
+
Sidekiq::Testing.inline! do # can't override the override
|
244
|
+
# not ok, nested
|
245
|
+
end
|
246
|
+
end
|
247
|
+
```
|
248
|
+
- **SECURITY** Forbid inline JavaScript execution in Web UI [#6074]
|
249
|
+
- Adjust redis-client adapter to avoid `method_missing` [#6083]
|
250
|
+
This can result in app code breaking if your app's Redis API usage was
|
251
|
+
depending on Sidekiq's adapter to correct invalid redis-client API usage.
|
252
|
+
One example:
|
253
|
+
```ruby
|
254
|
+
# bad, not redis-client native
|
255
|
+
# Unsupported command argument type: TrueClass (TypeError)
|
256
|
+
Sidekiq.redis { |c| c.set("key", "value", nx: true, ex: 15) }
|
257
|
+
# good
|
258
|
+
Sidekiq.redis { |c| c.set("key", "value", "nx", "ex", 15) }
|
259
|
+
```
|
260
|
+
|
261
|
+
7.1.6
|
262
|
+
----------
|
263
|
+
|
264
|
+
- The block forms of testing modes (inline, fake) are now thread-safe so you can have
|
265
|
+
a multithreaded test suite which uses different modes for different tests. [#6069]
|
266
|
+
- Fix breakage with non-Proc error handlers [#6065]
|
267
|
+
|
268
|
+
7.1.5
|
269
|
+
----------
|
270
|
+
|
271
|
+
- **FEATURE**: Job filtering within the Web UI. This feature has been open
|
272
|
+
sourced from Sidekiq Pro. [#6052]
|
273
|
+
- **API CHANGE** Error handlers now take three arguments `->(ex, context, config)`.
|
274
|
+
The previous calling convention will work until Sidekiq 8.0 but will print
|
275
|
+
out a deprecation warning. [#6051]
|
276
|
+
- Fix issue with the `batch_size` and `at` options in `S::Client.push_bulk` [#6040]
|
277
|
+
- Fix inline testing firing batch callbacks early [#6057]
|
278
|
+
- Use new log broadcast API in Rails 7.1 [#6054]
|
279
|
+
- Crash if user tries to use RESP2 `protocol: 2` [#6061]
|
280
|
+
|
281
|
+
7.1.4
|
282
|
+
----------
|
283
|
+
|
284
|
+
- Fix empty `retry_for` logic [#6035]
|
285
|
+
|
286
|
+
7.1.3
|
287
|
+
----------
|
288
|
+
|
289
|
+
- Add `sidekiq_options retry_for: 48.hours` to allow time-based retry windows [#6029]
|
290
|
+
- Support sidekiq_retry_in and sidekiq_retries_exhausted_block in ActiveJobs (#5994)
|
291
|
+
- Lowercase all Rack headers for Rack 3.0 [#5951]
|
292
|
+
- Validate Sidekiq::Web page refresh delay to avoid potential DoS,
|
293
|
+
CVE-2023-26141, thanks for reporting Keegan!
|
294
|
+
|
295
|
+
7.1.2
|
296
|
+
----------
|
297
|
+
|
298
|
+
- Mark Web UI assets as private so CDNs won't cache them [#5936]
|
299
|
+
- Fix stackoverflow when using Oj and the JSON log formatter [#5920]
|
300
|
+
- Remove spurious `enqueued_at` from scheduled ActiveJobs [#5937]
|
301
|
+
|
302
|
+
7.1.1
|
303
|
+
----------
|
304
|
+
|
305
|
+
- Support multiple CurrentAttributes [#5904]
|
306
|
+
- Speed up latency fetch with large queues on Redis <7 [#5910]
|
307
|
+
- Allow a larger default client pool [#5886]
|
308
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
309
|
+
|
310
|
+
7.1.0
|
311
|
+
----------
|
312
|
+
|
313
|
+
- Improve display of ActiveJob arguments in Web UI [#5825, cover]
|
314
|
+
- Update `push_bulk` to push `batch_size` jobs at a time and allow laziness [#5827, fatkodima]
|
315
|
+
This allows Sidekiq::Client to push unlimited jobs as long as it has enough memory for the batch_size.
|
316
|
+
- Update `perform_bulk` to use `push_bulk` internally.
|
317
|
+
- Change return value of `push_bulk` to map 1-to-1 with arguments.
|
318
|
+
If you call `push_bulk(args: [[1], [2], [3]])`, you will now always get
|
319
|
+
an array of 3 values as the result: `["jid1", nil, "jid3"]` where nil means
|
320
|
+
that particular job did not push successfully (possibly due to middleware
|
321
|
+
stopping it). Previously nil values were removed so it was impossible to tell
|
322
|
+
which jobs pushed successfully and which did not.
|
323
|
+
- Migrate away from all deprecated Redis commands [#5788]
|
324
|
+
Sidekiq will now print a warning if you use one of those deprecated commands.
|
325
|
+
- Prefix all Sidekiq thread names [#5872]
|
326
|
+
|
327
|
+
7.0.9
|
328
|
+
----------
|
329
|
+
|
330
|
+
- Restore confirmation dialogs in Web UI [#5881, shevaun]
|
331
|
+
- Increase fetch timeout to minimize ReadTimeoutError [#5874]
|
332
|
+
- Reverse histogram tooltip ordering [#5868]
|
333
|
+
- Add Scottish Gaelic (gd) locale [#5867, GunChleoc]
|
334
|
+
|
335
|
+
7.0.8
|
336
|
+
----------
|
337
|
+
|
338
|
+
- **SECURITY** Sanitize `period` input parameter on Metrics pages.
|
339
|
+
Specially crafted values can lead to XSS. This functionality
|
340
|
+
was introduced in 7.0.4. Thank you to spercex @ huntr.dev [#5694]
|
341
|
+
- Add job hash as 3rd parameter to the `sidekiq_retry_in` block.
|
342
|
+
|
343
|
+
7.0.7
|
344
|
+
----------
|
345
|
+
|
346
|
+
- Fix redis-client API usage which could result in stuck Redis
|
347
|
+
connections [#5823]
|
348
|
+
- Fix AS::Duration with `sidekiq_retry_in` [#5806]
|
349
|
+
- Restore dumping config options on startup with `-v` [#5822]
|
350
|
+
|
351
|
+
7.0.5,7.0.6
|
352
|
+
----------
|
353
|
+
|
354
|
+
- More context for debugging json unsafe errors [#5787]
|
355
|
+
|
356
|
+
7.0.4
|
357
|
+
----------
|
358
|
+
|
359
|
+
- Performance and memory optimizations [#5768, fatkodima]
|
360
|
+
- Add 1-8 hour period selector to Metrics pages [#5694]
|
361
|
+
- Fix process display with `sidekiqmon` [#5733]
|
362
|
+
|
363
|
+
7.0.3
|
364
|
+
----------
|
365
|
+
|
366
|
+
- Don't warn about memory policy on Redis Enterprise [#5712]
|
367
|
+
- Don't allow Quiet/Stop on embedded Sidekiq instances [#5716]
|
368
|
+
- Fix `size: X` for configuring the default Redis pool size [#5702]
|
369
|
+
- Improve the display of queue weights on Busy page [#5642]
|
370
|
+
- Freeze CurrentAttributes on a job once initially set [#5692]
|
371
|
+
|
372
|
+
7.0.2
|
373
|
+
----------
|
374
|
+
|
375
|
+
- Improve compatibility with custom loggers [#5673]
|
376
|
+
- Add queue weights on Busy page [#5640]
|
377
|
+
- Add BID link on job_info page if job is part of a Batch [#5623]
|
378
|
+
- Allow custom extensions to add rows/links within Job detail pages [#5624]
|
379
|
+
```ruby
|
380
|
+
Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
|
381
|
+
|
382
|
+
class AddAccountLink
|
383
|
+
include CGI::Util
|
384
|
+
def add_pair(job)
|
385
|
+
# yield a (name, value) pair
|
386
|
+
# You can include HTML tags and CSS, Sidekiq does not do any
|
387
|
+
# escaping so beware user data injection! Note how we use CGI's
|
388
|
+
# `h` escape helper.
|
389
|
+
aid = job["account_id"]
|
390
|
+
yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
|
391
|
+
end
|
392
|
+
end
|
393
|
+
```
|
394
|
+
|
395
|
+
7.0.1
|
396
|
+
----------
|
397
|
+
|
398
|
+
- Allow an embedding process to reuse its own heartbeat thread
|
399
|
+
- Update zh-cn localization
|
400
|
+
|
401
|
+
7.0.0
|
402
|
+
----------
|
403
|
+
|
404
|
+
- Embedded mode!
|
405
|
+
- Capsules!!
|
406
|
+
- Job Execution metrics!!!
|
407
|
+
- See `docs/7.0-Upgrade.md` for release notes
|
408
|
+
|
409
|
+
6.5.{10,11,12}
|
410
|
+
----------
|
411
|
+
|
412
|
+
- Fixes for Rails 7.1 [#6067, #6070]
|
413
|
+
|
414
|
+
6.5.9
|
415
|
+
----------
|
416
|
+
|
417
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
418
|
+
|
419
|
+
6.5.8
|
420
|
+
----------
|
421
|
+
|
422
|
+
- Fail if using a bad version of scout_apm [#5616]
|
423
|
+
- Add pagination to Busy page [#5556]
|
424
|
+
- Speed up WorkSet#each [#5559]
|
425
|
+
- Adjust CurrentAttributes to work with the String class name so we aren't referencing the Class within a Rails initializer [#5536]
|
426
|
+
|
427
|
+
6.5.7
|
428
|
+
----------
|
429
|
+
|
430
|
+
- Updates for JA and ZH locales
|
431
|
+
- Further optimizations for scheduled polling [#5513]
|
432
|
+
|
433
|
+
6.5.6
|
434
|
+
----------
|
435
|
+
|
436
|
+
- Fix deprecation warnings with redis-rb 4.8.0 [#5484]
|
437
|
+
- Lock redis-rb to < 5.0 as we are moving to redis-client in Sidekiq 7.0
|
438
|
+
|
439
|
+
6.5.5
|
440
|
+
----------
|
441
|
+
|
442
|
+
- Fix require issue with job_retry.rb [#5462]
|
443
|
+
- Improve Sidekiq::Web compatibility with Rack 3.x
|
444
|
+
|
445
|
+
6.5.4
|
446
|
+
----------
|
447
|
+
|
448
|
+
- Fix invalid code on Ruby 2.5 [#5460]
|
449
|
+
- Fix further metrics dependency issues [#5457]
|
450
|
+
|
451
|
+
6.5.3
|
452
|
+
----------
|
453
|
+
|
454
|
+
- Don't require metrics code without explicit opt-in [#5456]
|
455
|
+
|
456
|
+
6.5.2
|
457
|
+
----------
|
458
|
+
|
459
|
+
- [Job Metrics are under active development, help wanted!](https://github.com/sidekiq/sidekiq/wiki/Metrics#contributing) **BETA**
|
460
|
+
- Add `Context` column on queue page which shows any CurrentAttributes [#5450]
|
461
|
+
- `sidekiq_retry_in` may now return `:discard` or `:kill` to dynamically stop job retries [#5406]
|
462
|
+
- Smarter sorting of processes in /busy Web UI [#5398]
|
463
|
+
- Fix broken hamburger menu in mobile UI [#5428]
|
464
|
+
- Require redis-rb 4.5.0. Note that Sidekiq will break if you use the
|
465
|
+
[`Redis.exists_returns_integer = false`](https://github.com/redis/redis-rb/blob/master/CHANGELOG.md#450) flag. [#5394]
|
466
|
+
|
467
|
+
6.5.1
|
468
|
+
----------
|
469
|
+
|
470
|
+
- Fix `push_bulk` breakage [#5387]
|
471
|
+
|
472
|
+
6.5.0
|
473
|
+
---------
|
474
|
+
|
475
|
+
- Substantial refactoring of Sidekiq server internals, part of a larger effort
|
476
|
+
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).
|
477
|
+
- **Add beta support for the `redis-client` gem**. This will become the default Redis driver in Sidekiq 7.0. [#5298]
|
478
|
+
Read more: https://github.com/sidekiq/sidekiq/wiki/Using-redis-client
|
479
|
+
- **Add beta support for DB transaction-aware client** [#5291]
|
480
|
+
Add this line to your initializer and any jobs created during a transaction
|
481
|
+
will only be pushed to Redis **after the transaction commits**. You will need to add the
|
482
|
+
`after_commit_everywhere` gem to your Gemfile.
|
483
|
+
```ruby
|
484
|
+
Sidekiq.transactional_push!
|
485
|
+
```
|
486
|
+
This feature does not have a lot of production usage yet; please try it out and let us
|
487
|
+
know if you have any issues. It will be fully supported in Sidekiq 7.0 or removed if it
|
488
|
+
proves problematic.
|
489
|
+
- Fix regression with middleware arguments [#5312]
|
490
|
+
|
491
|
+
6.4.2
|
492
|
+
---------
|
493
|
+
|
494
|
+
- Strict argument checking now runs after client-side middleware [#5246]
|
495
|
+
- Fix page events with live polling [#5184]
|
496
|
+
- Many under-the-hood changes to remove all usage of the term "worker"
|
497
|
+
from the Sidekiq codebase and APIs. This mostly involved RDoc and local
|
498
|
+
variable names but a few constants and public APIs were changed. The old
|
499
|
+
APIs will be removed in Sidekiq 7.0.
|
500
|
+
```
|
501
|
+
Sidekiq::DEFAULT_WORKER_OPTIONS -> Sidekiq.default_job_options
|
502
|
+
Sidekiq.default_worker_options -> Sidekiq.default_job_options
|
503
|
+
Sidekiq::Queues["default"].jobs_by_worker(HardJob) -> Sidekiq::Queues["default"].jobs_by_class(HardJob)
|
504
|
+
```
|
505
|
+
|
506
|
+
6.4.1
|
507
|
+
---------
|
508
|
+
|
509
|
+
- Fix pipeline/multi deprecations in redis-rb 4.6
|
510
|
+
- Fix sidekiq.yml YAML load errors on Ruby 3.1 [#5141]
|
511
|
+
- Sharding support for `perform_bulk` [#5129]
|
512
|
+
- Refactor job logger for SPEEEEEEED
|
513
|
+
|
514
|
+
6.4.0
|
515
|
+
---------
|
516
|
+
|
517
|
+
- **SECURITY**: Validate input to avoid possible DoS in Web UI.
|
518
|
+
- Add **strict argument checking** [#5071]
|
519
|
+
Sidekiq will now log a warning if JSON-unsafe arguments are passed to `perform_async`.
|
520
|
+
Add `Sidekiq.strict_args!(false)` to your initializer to disable this warning.
|
521
|
+
This warning will switch to an exception in Sidekiq 7.0.
|
522
|
+
- Note that Delayed Extensions will be removed in Sidekiq 7.0 [#5076]
|
523
|
+
- Add `perform_{inline,sync}` in Sidekiq::Job to run a job synchronously [#5061, hasan-ally]
|
524
|
+
```ruby
|
525
|
+
SomeJob.perform_async(args...)
|
526
|
+
SomeJob.perform_sync(args...)
|
527
|
+
SomeJob.perform_inline(args...)
|
528
|
+
```
|
529
|
+
You can also dynamically redirect a job to run synchronously:
|
530
|
+
```ruby
|
531
|
+
SomeJob.set("sync": true).perform_async(args...) # will run via perform_inline
|
532
|
+
```
|
533
|
+
- Replace Sidekiq::Worker `app/workers` generator with Sidekiq::Job `app/sidekiq` generator [#5055]
|
534
|
+
```
|
535
|
+
bin/rails generate sidekiq:job ProcessOrderJob
|
536
|
+
```
|
537
|
+
- Fix job retries losing CurrentAttributes [#5090]
|
538
|
+
- Tweak shutdown to give long-running threads time to cleanup [#5095]
|
539
|
+
|
540
|
+
6.3.1
|
541
|
+
---------
|
542
|
+
|
543
|
+
- Fix keyword arguments error with CurrentAttributes on Ruby 3.0 [#5048]
|
544
|
+
|
545
|
+
6.3.0
|
546
|
+
---------
|
547
|
+
|
548
|
+
- **BREAK**: The Web UI has been refactored to remove jQuery. Any UI extensions
|
549
|
+
which use jQuery will break.
|
550
|
+
- **FEATURE**: Sidekiq.logger has been enhanced so any `Rails.logger`
|
551
|
+
output in jobs now shows up in the Sidekiq console. Remove any logger
|
552
|
+
hacks in your initializer and see if it Just Works™ now. [#5021]
|
553
|
+
- **FEATURE**: Add `Sidekiq::Job` alias for `Sidekiq::Worker`, to better
|
554
|
+
reflect industry standard terminology. You can now do this:
|
555
|
+
```ruby
|
556
|
+
class MyJob
|
557
|
+
include Sidekiq::Job
|
558
|
+
sidekiq_options ...
|
559
|
+
def perform(args)
|
560
|
+
end
|
561
|
+
end
|
562
|
+
```
|
563
|
+
- **FEATURE**: Support for serializing ActiveSupport::CurrentAttributes into each job. [#4982]
|
564
|
+
```ruby
|
565
|
+
# config/initializers/sidekiq.rb
|
566
|
+
require "sidekiq/middleware/current_attributes"
|
567
|
+
Sidekiq::CurrentAttributes.persist(Myapp::Current) # Your AS::CurrentAttributes singleton
|
568
|
+
```
|
569
|
+
- **FEATURE**: Add `Sidekiq::Worker.perform_bulk` for enqueuing jobs in bulk,
|
570
|
+
similar to `Sidekiq::Client.push_bulk` [#5042]
|
571
|
+
```ruby
|
572
|
+
MyJob.perform_bulk([[1], [2], [3]])
|
573
|
+
```
|
574
|
+
- Implement `queue_as`, `wait` and `wait_until` for ActiveJob compatibility [#5003]
|
575
|
+
- Scheduler now uses Lua to reduce Redis load and network roundtrips [#5044]
|
576
|
+
- Retry Redis operation if we get an `UNBLOCKED` Redis error [#4985]
|
577
|
+
- Run existing signal traps, if any, before running Sidekiq's trap [#4991]
|
578
|
+
- Fix fetch bug when using weighted queues which caused Sidekiq to stop
|
579
|
+
processing queues randomly [#5031]
|
580
|
+
|
581
|
+
6.2.2
|
582
|
+
---------
|
583
|
+
|
584
|
+
- Reduce retry jitter, add jitter to `sidekiq_retry_in` values [#4957]
|
585
|
+
- Minimize scheduler load on Redis at scale [#4882]
|
586
|
+
- Improve logging of delay jobs [#4904, BuonOno]
|
587
|
+
- Minor CSS improvements for buttons and tables, design PRs always welcome!
|
588
|
+
- Tweak Web UI `Cache-Control` header [#4966]
|
589
|
+
- Rename internal API class `Sidekiq::Job` to `Sidekiq::JobRecord` [#4955]
|
590
|
+
|
591
|
+
6.2.1
|
592
|
+
---------
|
593
|
+
|
594
|
+
- Update RTT warning logic to handle transient RTT spikes [#4851]
|
595
|
+
- Fix very low priority CVE on unescaped queue name [#4852]
|
596
|
+
- Add note about sessions and Rails apps in API mode
|
597
|
+
|
598
|
+
6.2.0
|
599
|
+
---------
|
600
|
+
|
601
|
+
- Store Redis RTT and log if poor [#4824]
|
602
|
+
- Add process/thread stats to Busy page [#4806]
|
603
|
+
- Improve Web UI on mobile devices [#4840]
|
604
|
+
- **Refactor Web UI session usage** [#4804]
|
605
|
+
Numerous people have hit "Forbidden" errors and struggled with Sidekiq's
|
606
|
+
Web UI session requirement. If you have code in your initializer for
|
607
|
+
Web sessions, it's quite possible it will need to be removed. Here's
|
608
|
+
an overview:
|
609
|
+
```
|
610
|
+
Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
|
611
|
+
make sure you mount Sidekiq::Web *inside* your routes in `config/routes.rb` so
|
612
|
+
Sidekiq can reuse the Rails session:
|
613
|
+
|
614
|
+
Rails.application.routes.draw do
|
615
|
+
mount Sidekiq::Web => "/sidekiq"
|
616
|
+
....
|
617
|
+
end
|
618
|
+
|
619
|
+
If this is a bare Rack app, use a session middleware before Sidekiq::Web:
|
620
|
+
|
621
|
+
# first, use IRB to create a shared secret key for sessions and commit it
|
622
|
+
require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
|
623
|
+
|
624
|
+
# now, update your Rack app to include the secret with a session cookie middleware
|
625
|
+
use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
|
626
|
+
run Sidekiq::Web
|
627
|
+
|
628
|
+
If this is a Rails app in API mode, you need to enable sessions.
|
629
|
+
|
630
|
+
https://guides.rubyonrails.org/api_app.html#using-session-middlewares
|
631
|
+
```
|
632
|
+
|
633
|
+
6.1.3
|
634
|
+
---------
|
635
|
+
|
636
|
+
- Warn if Redis is configured to evict data under memory pressure [#4752]
|
637
|
+
- Add process RSS on the Busy page [#4717]
|
638
|
+
|
639
|
+
6.1.2
|
640
|
+
---------
|
641
|
+
|
642
|
+
- Improve readability in dark mode Web UI [#4674]
|
643
|
+
- Fix Web UI crash with corrupt session [#4672]
|
644
|
+
- Allow middleware to yield arguments [#4673, @eugeneius]
|
645
|
+
- Migrate CI from CircleCI to GitHub Actions [#4677]
|
646
|
+
|
647
|
+
6.1.1
|
648
|
+
---------
|
649
|
+
|
650
|
+
- Jobs are now sorted by age in the Busy Workers table. [#4641]
|
651
|
+
- Fix "check all" JS logic in Web UI [#4619]
|
652
|
+
|
653
|
+
6.1.0
|
654
|
+
---------
|
655
|
+
|
656
|
+
- Web UI - Dark Mode fixes [#4543, natematykiewicz]
|
657
|
+
- Ensure `Rack::ContentLength` is loaded as middleware for correct Web UI responses [#4541]
|
658
|
+
- Avoid exception dumping SSL store in Redis connection logging [#4532]
|
659
|
+
- Better error messages in Sidekiq::Client [#4549]
|
660
|
+
- Remove rack-protection, reimplement CSRF protection [#4588]
|
661
|
+
- Require redis-rb 4.2 [#4591]
|
662
|
+
- Update to jquery 1.12.4 [#4593]
|
663
|
+
- Refactor internal fetch logic and API [#4602]
|
664
|
+
|
665
|
+
6.0.7
|
666
|
+
---------
|
667
|
+
|
668
|
+
- Refactor systemd integration to work better with custom binaries [#4511]
|
669
|
+
- Don't connect to Redis at process exit if not needed [#4502]
|
670
|
+
- Remove Redis connection naming [#4479]
|
671
|
+
- Fix Redis Sentinel password redaction [#4499]
|
672
|
+
- Add Vietnamese locale (vi) [#4528]
|
673
|
+
|
674
|
+
6.0.6
|
675
|
+
---------
|
676
|
+
|
677
|
+
- **Integrate with systemd's watchdog and notification features** [#4488]
|
678
|
+
Set `Type=notify` in [sidekiq.service](https://github.com/sidekiq/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
|
679
|
+
- Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
|
680
|
+
- Fix edge case where a job can be pushed without a queue.
|
681
|
+
- Flush job stats at exit [#4498]
|
682
|
+
- Check RAILS_ENV before RACK_ENV [#4493]
|
683
|
+
- Add Lithuanian locale [#4476]
|
684
|
+
|
685
|
+
6.0.5
|
686
|
+
---------
|
687
|
+
|
688
|
+
- Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
|
689
|
+
- Update APIs to use `UNLINK`, not `DEL`. [#4449]
|
690
|
+
- Fix Ruby 2.7 warnings [#4412]
|
691
|
+
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/sidekiq/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
|
692
|
+
|
693
|
+
6.0.4
|
694
|
+
---------
|
695
|
+
|
696
|
+
- Fix ActiveJob's `sidekiq_options` integration [#4404]
|
697
|
+
- Sidekiq Pro users will now see a Pause button next to each queue in
|
698
|
+
the Web UI, allowing them to pause queues manually [#4374, shayonj]
|
699
|
+
- Fix Sidekiq::Workers API unintentional change in 6.0.2 [#4387]
|
700
|
+
|
701
|
+
|
702
|
+
6.0.3
|
703
|
+
---------
|
704
|
+
|
705
|
+
- Fix `Sidekiq::Client.push_bulk` API which was erroneously putting
|
706
|
+
invalid `at` values in the job payloads [#4321]
|
707
|
+
|
708
|
+
6.0.2
|
709
|
+
---------
|
710
|
+
|
711
|
+
- Fix Sidekiq Enterprise's rolling restart functionality, broken by refactoring in 6.0.0. [#4334]
|
712
|
+
- More internal refactoring and performance tuning [fatkodima]
|
713
|
+
|
714
|
+
6.0.1
|
715
|
+
---------
|
716
|
+
|
717
|
+
- **Performance tuning**, Sidekiq should be 10-15% faster now [#4303, 4299,
|
718
|
+
4269, fatkodima]
|
719
|
+
- **Dark Mode support in Web UI** (further design polish welcome!) [#4227, mperham,
|
720
|
+
fatkodima, silent-e]
|
721
|
+
- **Job-specific log levels**, allowing you to turn on debugging for
|
722
|
+
problematic workers. [fatkodima, #4287]
|
723
|
+
```ruby
|
724
|
+
MyWorker.set(log_level: :debug).perform_async(...)
|
725
|
+
```
|
726
|
+
- **Ad-hoc job tags**. You can tag your jobs with, e.g, subdomain, tenant, country,
|
727
|
+
locale, application, version, user/client, "alpha/beta/pro/ent", types of jobs,
|
728
|
+
teams/people responsible for jobs, additional metadata, etc.
|
729
|
+
Tags are shown on different pages with job listings. Sidekiq Pro users
|
730
|
+
can filter based on them [fatkodima, #4280]
|
731
|
+
```ruby
|
732
|
+
class MyWorker
|
733
|
+
include Sidekiq::Worker
|
734
|
+
sidekiq_options tags: ['bank-ops', 'alpha']
|
735
|
+
...
|
736
|
+
end
|
737
|
+
```
|
738
|
+
- Fetch scheduled jobs in batches before pushing into specific queues.
|
739
|
+
This will decrease enqueueing time of scheduled jobs by a third. [fatkodima, #4273]
|
740
|
+
```
|
741
|
+
ScheduledSet with 10,000 jobs
|
742
|
+
Before: 56.6 seconds
|
743
|
+
After: 39.2 seconds
|
744
|
+
```
|
745
|
+
- Compress error backtraces before pushing into Redis, if you are
|
746
|
+
storing error backtraces, this will halve the size of your RetrySet
|
747
|
+
in Redis [fatkodima, #4272]
|
748
|
+
```
|
749
|
+
RetrySet with 100,000 jobs
|
750
|
+
Before: 261 MB
|
751
|
+
After: 129 MB
|
752
|
+
```
|
753
|
+
- Support display of ActiveJob 6.0 payloads in the Web UI [#4263]
|
754
|
+
- Add `SortedSet#scan` for pattern based scanning. For large sets this API will be **MUCH** faster
|
755
|
+
than standard iteration using each. [fatkodima, #4262]
|
756
|
+
```ruby
|
757
|
+
Sidekiq::DeadSet.new.scan("UnreliableApi") do |job|
|
758
|
+
job.retry
|
759
|
+
end
|
760
|
+
```
|
761
|
+
- Dramatically speed up SortedSet#find\_job(jid) by using Redis's ZSCAN
|
762
|
+
support, approx 10x faster. [fatkodima, #4259]
|
763
|
+
```
|
764
|
+
zscan 0.179366 0.047727 0.227093 ( 1.161376)
|
765
|
+
enum 8.522311 0.419826 8.942137 ( 9.785079)
|
766
|
+
```
|
767
|
+
- Respect rails' generators `test_framework` option and gracefully handle extra `worker` suffix on generator [fatkodima, #4256]
|
768
|
+
- Add ability to sort 'Enqueued' page on Web UI by position in the queue [fatkodima, #4248]
|
769
|
+
- Support `Client.push_bulk` with different delays [fatkodima, #4243]
|
770
|
+
```ruby
|
771
|
+
Sidekiq::Client.push_bulk("class" => FooJob, "args" => [[1], [2]], "at" => [1.minute.from_now.to_f, 5.minutes.from_now.to_f])
|
772
|
+
```
|
773
|
+
- Easier way to test enqueuing specific ActionMailer and ActiveRecord delayed jobs. Instead of manually
|
774
|
+
parsing embedded class, you can now test by fetching jobs for specific classes. [fatkodima, #4292]
|
775
|
+
```ruby
|
776
|
+
assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs_for(FooMailer).size
|
777
|
+
```
|
778
|
+
- Add `sidekiqmon` to gemspec executables [#4242]
|
779
|
+
- Gracefully handle `Sidekiq.logger = nil` [#4240]
|
780
|
+
- Inject Sidekiq::LogContext module if user-supplied logger does not include it [#4239]
|
781
|
+
|
782
|
+
6.0
|
783
|
+
---------
|
784
|
+
|
785
|
+
This release has major breaking changes. Read and test carefully in production.
|
786
|
+
|
787
|
+
- With Rails 6.0.2+, ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
|
788
|
+
features/internals like the retry subsystem. [#4213, pirj]
|
789
|
+
```ruby
|
790
|
+
class MyJob < ActiveJob::Base
|
791
|
+
queue_as :myqueue
|
792
|
+
sidekiq_options retry: 10, backtrace: 20
|
793
|
+
def perform(...)
|
794
|
+
end
|
795
|
+
end
|
796
|
+
```
|
797
|
+
- Logging has been redesigned to allow for pluggable log formatters:
|
798
|
+
```ruby
|
799
|
+
Sidekiq.configure_server do |config|
|
800
|
+
config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
|
801
|
+
end
|
802
|
+
```
|
803
|
+
See the [Logging wiki page](https://github.com/sidekiq/sidekiq/wiki/Logging) for more details.
|
804
|
+
- **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
|
805
|
+
variable. This variable is meant to hold the name of the environment
|
806
|
+
variable which contains your Redis URL, so that you can switch Redis
|
807
|
+
providers quickly and easily with a single variable change. It is not
|
808
|
+
meant to hold the actual Redis URL itself. If you want to manually set
|
809
|
+
the Redis URL (not recommended as it implies you have no failover),
|
810
|
+
then you may set `REDIS_URL` directly. [#3969]
|
811
|
+
- **BREAKING CHANGE** Increase default shutdown timeout from 8 seconds
|
812
|
+
to 25 seconds. Both Heroku and ECS now use 30 second shutdown timeout
|
813
|
+
by default and we want Sidekiq to take advantage of this time. If you
|
814
|
+
have deployment scripts which depend on the old default timeout, use `-t 8` to
|
815
|
+
get the old behavior. [#3968]
|
816
|
+
- **BREAKING CHANGE** Remove the daemonization, logfile and pidfile
|
817
|
+
arguments to Sidekiq. Use a proper process supervisor (e.g. systemd or
|
818
|
+
foreman) to manage Sidekiq. See the Deployment wiki page for links to
|
819
|
+
more resources.
|
820
|
+
- Integrate the StandardRB code formatter to ensure consistent code
|
821
|
+
styling. [#4114, gearnode]
|
822
|
+
|
823
|
+
5.2.10
|
824
|
+
---------
|
825
|
+
|
826
|
+
- Backport fix for CVE-2022-23837.
|
827
|
+
- Migrate to `exists?` for redis-rb.
|
828
|
+
- Lock redis-rb to <4.6 to avoid deprecations.
|
829
|
+
|
830
|
+
5.2.9
|
831
|
+
---------
|
832
|
+
|
833
|
+
- Release Rack lock due to a cascade of CVEs. [#4566]
|
834
|
+
Pro-tip: don't lock Rack.
|
835
|
+
|
836
|
+
5.2.8
|
837
|
+
---------
|
838
|
+
|
839
|
+
- Lock to Rack 2.0.x to prevent future incompatibilities
|
840
|
+
- Fix invalid reference in `sidekiqctl`
|
4
841
|
|
5
842
|
5.2.7
|
6
843
|
---------
|
@@ -155,7 +992,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
|
|
155
992
|
- The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
|
156
993
|
- Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
|
157
994
|
of random hex bytes.
|
158
|
-
- Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
|
995
|
+
- Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail.
|
159
996
|
|
160
997
|
4.2.10
|
161
998
|
-----------
|
@@ -373,7 +1210,7 @@ Sidekiq::Queues.clear_all
|
|
373
1210
|
- Sidekiq's internals have been completely overhauled for performance
|
374
1211
|
and to remove dependencies. This has resulted in major speedups, as
|
375
1212
|
[detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
|
376
|
-
- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
|
1213
|
+
- See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail.
|
377
1214
|
|
378
1215
|
3.5.4
|
379
1216
|
-----------
|
@@ -410,7 +1247,7 @@ Sidekiq::Queues.clear_all
|
|
410
1247
|
- **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
|
411
1248
|
- Add Ukrainian locale [#2561, elrakita]
|
412
1249
|
- Disconnect and retry Redis operations if we see a READONLY error [#2550]
|
413
|
-
- Add server middleware testing harness; see [wiki](https://github.com/
|
1250
|
+
- Add server middleware testing harness; see [wiki](https://github.com/sidekiq/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
|
414
1251
|
|
415
1252
|
3.5.0
|
416
1253
|
-----------
|
@@ -428,7 +1265,7 @@ Sidekiq::Queues.clear_all
|
|
428
1265
|
- Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
|
429
1266
|
reporting. [#2422] If you are running the Web UI as a standalone Rack app,
|
430
1267
|
ensure you have a [session middleware
|
431
|
-
configured](https://github.com/
|
1268
|
+
configured](https://github.com/sidekiq/sidekiq/wiki/Monitoring#standalone):
|
432
1269
|
```ruby
|
433
1270
|
use Rack::Session::Cookie, :secret => "some unique secret string here"
|
434
1271
|
```
|
@@ -640,7 +1477,7 @@ sidekiq_options :dead => false, :retry => 5
|
|
640
1477
|
3.0.0
|
641
1478
|
-----------
|
642
1479
|
|
643
|
-
Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
|
1480
|
+
Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes.
|
644
1481
|
|
645
1482
|
- **Dead Job Queue** - jobs which run out of retries are now moved to a dead
|
646
1483
|
job queue. These jobs must be retried manually or they will expire
|
@@ -684,7 +1521,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
|
|
684
1521
|
end
|
685
1522
|
```
|
686
1523
|
**Sharding support does require a breaking change to client-side
|
687
|
-
middleware, see 3.0-Upgrade.md.**
|
1524
|
+
middleware, see docs/3.0-Upgrade.md.**
|
688
1525
|
- New Chinese, Greek, Swedish and Czech translations for the Web UI.
|
689
1526
|
- Updated most languages translations for the new UI features.
|
690
1527
|
- **Remove official Capistrano integration** - this integration has been
|
@@ -812,7 +1649,7 @@ middleware, see 3.0-Upgrade.md.**
|
|
812
1649
|
appear to be doing any work. [#1194]
|
813
1650
|
- Sidekiq's testing behavior is now dynamic. You can choose between
|
814
1651
|
`inline` and `fake` behavior in your tests. See
|
815
|
-
[Testing](https://github.com/
|
1652
|
+
[Testing](https://github.com/sidekiq/sidekiq/wiki/Testing) for detail. [#1193]
|
816
1653
|
- The Retries table has a new column for the error message.
|
817
1654
|
- The Web UI topbar now contains the status and live poll button.
|
818
1655
|
- Orphaned worker records are now auto-vacuumed when you visit the
|