sidekiq 6.2.2 → 8.1.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 +726 -11
- data/LICENSE.txt +9 -0
- data/README.md +70 -39
- data/bin/kiq +17 -0
- data/bin/lint-herb +13 -0
- data/bin/multi_queue_bench +271 -0
- data/bin/sidekiq +4 -9
- data/bin/sidekiqload +214 -115
- data/bin/sidekiqmon +4 -1
- data/bin/webload +69 -0
- data/lib/active_job/queue_adapters/sidekiq_adapter.rb +124 -0
- data/lib/generators/sidekiq/job_generator.rb +71 -0
- data/lib/generators/sidekiq/templates/{worker.rb.erb → job.rb.erb} +3 -3
- 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 +729 -264
- data/lib/sidekiq/capsule.rb +135 -0
- data/lib/sidekiq/cli.rb +124 -100
- data/lib/sidekiq/client.rb +153 -106
- data/lib/sidekiq/component.rb +132 -0
- data/lib/sidekiq/config.rb +320 -0
- data/lib/sidekiq/deploy.rb +64 -0
- data/lib/sidekiq/embedded.rb +64 -0
- data/lib/sidekiq/fetch.rb +27 -26
- 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 +322 -0
- data/lib/sidekiq/job.rb +397 -5
- data/lib/sidekiq/job_logger.rb +23 -32
- data/lib/sidekiq/job_retry.rb +141 -68
- data/lib/sidekiq/job_util.rb +113 -0
- data/lib/sidekiq/launcher.rb +122 -98
- data/lib/sidekiq/loader.rb +57 -0
- data/lib/sidekiq/logger.rb +27 -106
- data/lib/sidekiq/manager.rb +41 -43
- data/lib/sidekiq/metrics/query.rb +184 -0
- data/lib/sidekiq/metrics/shared.rb +109 -0
- data/lib/sidekiq/metrics/tracking.rb +153 -0
- data/lib/sidekiq/middleware/chain.rb +96 -51
- data/lib/sidekiq/middleware/current_attributes.rb +120 -0
- data/lib/sidekiq/middleware/i18n.rb +8 -4
- data/lib/sidekiq/middleware/modules.rb +23 -0
- data/lib/sidekiq/monitor.rb +16 -6
- data/lib/sidekiq/paginator.rb +37 -10
- data/lib/sidekiq/processor.rb +105 -87
- data/lib/sidekiq/profiler.rb +73 -0
- data/lib/sidekiq/rails.rb +49 -36
- data/lib/sidekiq/redis_client_adapter.rb +117 -0
- data/lib/sidekiq/redis_connection.rb +55 -86
- data/lib/sidekiq/ring_buffer.rb +32 -0
- data/lib/sidekiq/scheduled.rb +106 -50
- data/lib/sidekiq/systemd.rb +2 -0
- data/lib/sidekiq/test_api.rb +331 -0
- data/lib/sidekiq/testing/inline.rb +2 -30
- data/lib/sidekiq/testing.rb +2 -342
- data/lib/sidekiq/transaction_aware_client.rb +59 -0
- data/lib/sidekiq/tui/controls.rb +53 -0
- data/lib/sidekiq/tui/filtering.rb +53 -0
- data/lib/sidekiq/tui/tabs/base_tab.rb +204 -0
- data/lib/sidekiq/tui/tabs/busy.rb +118 -0
- data/lib/sidekiq/tui/tabs/dead.rb +19 -0
- data/lib/sidekiq/tui/tabs/home.rb +144 -0
- data/lib/sidekiq/tui/tabs/metrics.rb +131 -0
- data/lib/sidekiq/tui/tabs/queues.rb +95 -0
- data/lib/sidekiq/tui/tabs/retries.rb +19 -0
- data/lib/sidekiq/tui/tabs/scheduled.rb +19 -0
- data/lib/sidekiq/tui/tabs/set_tab.rb +96 -0
- data/lib/sidekiq/tui/tabs.rb +15 -0
- data/lib/sidekiq/tui.rb +382 -0
- data/lib/sidekiq/version.rb +6 -1
- data/lib/sidekiq/web/action.rb +149 -64
- data/lib/sidekiq/web/application.rb +376 -268
- data/lib/sidekiq/web/config.rb +117 -0
- data/lib/sidekiq/web/helpers.rb +213 -87
- data/lib/sidekiq/web/router.rb +61 -74
- data/lib/sidekiq/web.rb +71 -100
- data/lib/sidekiq/worker_compatibility_alias.rb +13 -0
- data/lib/sidekiq.rb +95 -196
- data/sidekiq.gemspec +14 -11
- data/web/assets/images/logo.png +0 -0
- data/web/assets/images/status.png +0 -0
- data/web/assets/javascripts/application.js +171 -57
- 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 -274
- data/web/assets/javascripts/metrics.js +280 -0
- data/web/assets/stylesheets/style.css +776 -0
- data/web/locales/ar.yml +72 -70
- data/web/locales/cs.yml +64 -62
- data/web/locales/da.yml +62 -53
- data/web/locales/de.yml +67 -65
- data/web/locales/el.yml +45 -24
- data/web/locales/en.yml +93 -69
- data/web/locales/es.yml +91 -68
- data/web/locales/fa.yml +67 -65
- data/web/locales/fr.yml +82 -67
- data/web/locales/gd.yml +110 -0
- data/web/locales/he.yml +67 -64
- data/web/locales/hi.yml +61 -59
- data/web/locales/it.yml +94 -54
- data/web/locales/ja.yml +74 -68
- data/web/locales/ko.yml +54 -52
- data/web/locales/lt.yml +68 -66
- data/web/locales/nb.yml +63 -61
- data/web/locales/nl.yml +54 -52
- data/web/locales/pl.yml +47 -45
- data/web/locales/{pt-br.yml → pt-BR.yml} +85 -56
- data/web/locales/pt.yml +53 -51
- data/web/locales/ru.yml +69 -66
- data/web/locales/sv.yml +55 -53
- data/web/locales/ta.yml +62 -60
- data/web/locales/tr.yml +102 -0
- data/web/locales/uk.yml +87 -61
- data/web/locales/ur.yml +66 -64
- data/web/locales/vi.yml +69 -67
- data/web/locales/zh-CN.yml +107 -0
- data/web/locales/{zh-tw.yml → zh-TW.yml} +44 -9
- data/web/views/_footer.html.erb +32 -0
- data/web/views/_job_info.html.erb +115 -0
- data/web/views/_metrics_period_select.html.erb +15 -0
- data/web/views/_nav.html.erb +45 -0
- data/web/views/_paging.html.erb +26 -0
- data/web/views/_poll_link.html.erb +4 -0
- data/web/views/_summary.html.erb +40 -0
- data/web/views/busy.html.erb +151 -0
- data/web/views/dashboard.html.erb +104 -0
- data/web/views/dead.html.erb +38 -0
- data/web/views/filtering.html.erb +6 -0
- data/web/views/layout.html.erb +26 -0
- data/web/views/metrics.html.erb +85 -0
- data/web/views/metrics_for_job.html.erb +58 -0
- data/web/views/morgue.html.erb +69 -0
- data/web/views/profiles.html.erb +43 -0
- data/web/views/queue.html.erb +57 -0
- data/web/views/queues.html.erb +46 -0
- data/web/views/retries.html.erb +77 -0
- data/web/views/retry.html.erb +39 -0
- data/web/views/scheduled.html.erb +64 -0
- data/web/views/{scheduled_job_info.erb → scheduled_job_info.html.erb} +3 -3
- metadata +130 -61
- data/LICENSE +0 -9
- 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 -48
- data/lib/sidekiq/extensions/active_record.rb +0 -43
- data/lib/sidekiq/extensions/class_methods.rb +0 -43
- data/lib/sidekiq/extensions/generic_proxy.rb +0 -33
- data/lib/sidekiq/util.rb +0 -95
- data/lib/sidekiq/web/csrf_protection.rb +0 -180
- data/lib/sidekiq/worker.rb +0 -244
- data/web/assets/stylesheets/application-dark.css +0 -147
- data/web/assets/stylesheets/application-rtl.css +0 -246
- data/web/assets/stylesheets/application.css +0 -1053
- 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/_footer.erb +0 -20
- data/web/views/_job_info.erb +0 -89
- data/web/views/_nav.erb +0 -52
- data/web/views/_paging.erb +0 -23
- data/web/views/_poll_link.erb +0 -7
- data/web/views/_status.erb +0 -4
- data/web/views/_summary.erb +0 -40
- data/web/views/busy.erb +0 -132
- data/web/views/dashboard.erb +0 -83
- data/web/views/dead.erb +0 -34
- data/web/views/layout.erb +0 -42
- data/web/views/morgue.erb +0 -78
- data/web/views/queue.erb +0 -55
- data/web/views/queues.erb +0 -38
- data/web/views/retries.erb +0 -83
- data/web/views/retry.erb +0 -34
- data/web/views/scheduled.erb +0 -57
data/Changes.md
CHANGED
|
@@ -1,6 +1,714 @@
|
|
|
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.1.5
|
|
6
|
+
----------
|
|
7
|
+
|
|
8
|
+
- Identify Sidekiq connnections in Redis with `CLIENT SETINFO` [#6986]
|
|
9
|
+
- Fix edge case where Web UI could show an empty Batch set [#6987]
|
|
10
|
+
|
|
11
|
+
8.1.4
|
|
12
|
+
----------
|
|
13
|
+
|
|
14
|
+
- The TTIN signal is undeprecated as the INFO signal is not supported on Linux
|
|
15
|
+
- Show iteration job state on Busy page [#6978]
|
|
16
|
+
|
|
17
|
+
8.1.3
|
|
18
|
+
----------
|
|
19
|
+
|
|
20
|
+
- Fix edge case leading to duplicate, concurrent execution [#6379]
|
|
21
|
+
If 2 Capsules process jobs from the same queue, long-running
|
|
22
|
+
jobs could run in parallel during process shutdown.
|
|
23
|
+
- [SECURITY] Remove as much YAML usage as possible. [#6950]
|
|
24
|
+
Localization files in `web/locales` are now manually parsed.
|
|
25
|
+
Sidekiq::CLI will now only require YAML if you use a `-C` .yml file.
|
|
26
|
+
|
|
27
|
+
8.1.2
|
|
28
|
+
----------
|
|
29
|
+
|
|
30
|
+
- Initial release for `kiq`, Sidekiq's official terminal UI:
|
|
31
|
+
```
|
|
32
|
+
bundle exec kiq
|
|
33
|
+
```
|
|
34
|
+
Use REDIS_URL or REDIS_PROVIDER to point `kiq` to Redis.
|
|
35
|
+
- Mutation during iteration in `SortedSet#each` caused it to miss half of the jobs [#6936]
|
|
36
|
+
- Fix edge case resulting in nil crash on /busy page [#6954]
|
|
37
|
+
|
|
38
|
+
8.1.1
|
|
39
|
+
----------
|
|
40
|
+
|
|
41
|
+
- **DEPRECATION** `require 'sidekiq/testing'` and
|
|
42
|
+
`require 'sidekiq/testing/inline'`.
|
|
43
|
+
Add new `Sidekiq.testing!(mode)` API [#6931]
|
|
44
|
+
Requiring code should not enable process-wide changes.
|
|
45
|
+
```ruby
|
|
46
|
+
# Old, implicit
|
|
47
|
+
require "sidekiq/testing"
|
|
48
|
+
require "sidekiq/testing/inline"
|
|
49
|
+
# New, more explicit
|
|
50
|
+
Sidekiq.testing!(:fake)
|
|
51
|
+
Sidekiq.testing!(:inline)
|
|
52
|
+
```
|
|
53
|
+
- Fix race condition with Stop button in UI [#6935]
|
|
54
|
+
- Fix javascript error handler [#6893]
|
|
55
|
+
|
|
56
|
+
8.1.0
|
|
57
|
+
----------
|
|
58
|
+
|
|
59
|
+
- `retry_for` and `retry` are now mutually exclusive [#6878, Saidbek]
|
|
60
|
+
- `perform_inline` now enforces `strict_args!` [#6718, Saidbek]
|
|
61
|
+
- Integrate Herb linting for ERB templates [#6760, Saidbek]
|
|
62
|
+
- Remove CSRF code, use `Sec-Fetch-Site` header [#6874, deve1212]
|
|
63
|
+
- Allow custom Web UI `assets_path` for CDN purposes [#6865, stanhu]
|
|
64
|
+
- Upgrade to connection_pool 3.0
|
|
65
|
+
- Allow idle connection reaping after N seconds.
|
|
66
|
+
You can activate this **beta** feature like below.
|
|
67
|
+
Feedback requested: is this feature stable and useful for you in production?
|
|
68
|
+
This feature may or may not be enabled by default in Sidekiq 9.0.
|
|
69
|
+
```ruby
|
|
70
|
+
Sidekiq.configure_server do |cfg|
|
|
71
|
+
cfg.reap_idle_redis_connections(60)
|
|
72
|
+
end
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
8.0.10
|
|
76
|
+
----------
|
|
77
|
+
|
|
78
|
+
- Add confirm dialog for Delete All buttons in Web UI [#6853]
|
|
79
|
+
- Adjust scheduler to run closer to poll average [#6866]
|
|
80
|
+
- Forward compatibility changes for connection_pool 3.0.0
|
|
81
|
+
- Backwards compatibility fix for <8.0.9 process data in Redis [#6870]
|
|
82
|
+
- Backtrace dump can now be triggered with the INFO signal, since Puma uses the
|
|
83
|
+
same signal [#6857]
|
|
84
|
+
|
|
85
|
+
8.0.9
|
|
86
|
+
----------
|
|
87
|
+
|
|
88
|
+
- Implement idle Redis connection reaping, will be activated in 8.1 [#6663]
|
|
89
|
+
- Updated `Sidekiq::Process` API to provide capsule data. The `queues` and `weights`
|
|
90
|
+
data will be removed from Redis in Sidekiq 8.1, as this data can now be found in the
|
|
91
|
+
`capsules` element. [#6295]
|
|
92
|
+
- Restore bulk action buttons on Scheduled, Retry and Dead tabs [#6833, deve1212]
|
|
93
|
+
- Support logging additional job attributes [#6846, bschrag620]
|
|
94
|
+
- Fix display of long job args [#6836]
|
|
95
|
+
- Create development lifecycle (`docs/sdlc.md`) and security (`docs/SECURITY.md`) policy
|
|
96
|
+
documentation for Sidekiq's current workflows
|
|
97
|
+
|
|
98
|
+
8.0.8
|
|
99
|
+
----------
|
|
100
|
+
|
|
101
|
+
- Allow an optional global iteration max runtime. After executing for this length of time,
|
|
102
|
+
Sidekiq will re-queue the job to continue execution at a later time [#6819, fatkodima]
|
|
103
|
+
```ruby
|
|
104
|
+
Sidekiq.configure_server do |cfg|
|
|
105
|
+
cfg[:max_iteration_runtime] = 600 # ten minutes
|
|
106
|
+
end
|
|
107
|
+
```
|
|
108
|
+
- Add `discarded_at` attribute when discarding a job so death handlers can distinguish between
|
|
109
|
+
a job which was killed and one that was discarded. [#6820, gstokkink]
|
|
110
|
+
- `perform_bulk` now accepts an `:at` array of times to schedule each job at the corresponding time.
|
|
111
|
+
`perform_bulk(args: [[1], [2]], at: [Time.now, Time.now + 1])` [#6790, fatkodima]
|
|
112
|
+
- `perform_bulk` now accepts a `:spread_interval` value to schedule jobs over
|
|
113
|
+
the next N seconds. `perform_bulk(..., spread_interval: 60)` [#6792, fatkodima]
|
|
114
|
+
- Fix unintended display of flash messages in the Web UI due to session key collision
|
|
115
|
+
- Add support for lazy load hooks [#6825]
|
|
116
|
+
|
|
117
|
+
8.0.7
|
|
118
|
+
----------
|
|
119
|
+
|
|
120
|
+
- The `:discard` option for `sidekiq_retries_exhausted` and `sidekiq_retry_in`
|
|
121
|
+
now calls death handlers, otherwise it could break other Sidekiq
|
|
122
|
+
functionality. [#6741]
|
|
123
|
+
- Provide a Plain log formatter which does not colorize output [#6778]
|
|
124
|
+
- Job iteration now exposes `current_object` for easy access within the `around_iteration` callback [#6774]
|
|
125
|
+
- Fix JS race condition which could skip confirmation dialogs when Live Polling [#6768]
|
|
126
|
+
- Fix edge case which could lose CurrentAttributes [#6767]
|
|
127
|
+
- Update UK locale [#6776]
|
|
128
|
+
|
|
129
|
+
8.0.6
|
|
130
|
+
----------
|
|
131
|
+
|
|
132
|
+
- Adjust transactional client to use ActiveRecord 7.2's support for
|
|
133
|
+
`after_all_transactions_commit` when available. [#6765, rewritten]
|
|
134
|
+
- Fix Rails 7.0 and 7.1 compatibility [#6746, mlarraz]
|
|
135
|
+
- Flush metrics at `:exit` [#6764]
|
|
136
|
+
|
|
137
|
+
8.0.5
|
|
138
|
+
----------
|
|
139
|
+
|
|
140
|
+
- Add `stopping?` method to AJ adapter for compatibility with the new AJ::Continuations feature [#6732]
|
|
141
|
+
- Further improvements to Rails boot compatibility [#6710]
|
|
142
|
+
- Add ability to disable CSRF middleware. SameSite cookies prevent
|
|
143
|
+
CSRF in a cleaner manner and are default in most browsers now.
|
|
144
|
+
CSRF code will be removed in Sidekiq 9.0. [#6739]
|
|
145
|
+
|
|
146
|
+
8.0.4
|
|
147
|
+
----------
|
|
148
|
+
|
|
149
|
+
- Adjust Rails integration for various edge cases [6713]
|
|
150
|
+
- Flush job iteration state when an error is raised [#6704]
|
|
151
|
+
- Update Accept-Language parsing in Web UI [#6721]
|
|
152
|
+
- Remove fixed-width in Web UI [#6686]
|
|
153
|
+
- Adjust CSRF middleware ordering [#6688]
|
|
154
|
+
- Support proxies when POSTing profiles to profiler.firefox.com [#6687]
|
|
155
|
+
- Dont swallow NoMethodErrors in CurrentAttributes [#6685]
|
|
156
|
+
|
|
157
|
+
8.0.3
|
|
158
|
+
----------
|
|
159
|
+
|
|
160
|
+
- Configure Vernier output directory [#6674]
|
|
161
|
+
- Rework Rails integration [#6669]
|
|
162
|
+
- Implement flash messages for the Web UI [#6675]
|
|
163
|
+
|
|
164
|
+
8.0.2
|
|
165
|
+
----------
|
|
166
|
+
|
|
167
|
+
- Add `on(:exit)` event to run code right before the Sidekiq process exits [#6637]
|
|
168
|
+
- Metrics page crashes with Rack 3.1+ [#6646]
|
|
169
|
+
|
|
170
|
+
8.0.1
|
|
171
|
+
----------
|
|
172
|
+
|
|
173
|
+
- Relax Redis requirement to 7.0 for compatibility with AWS and Ubuntu 24.04 LTS. [#6630]
|
|
174
|
+
|
|
175
|
+
8.0.0
|
|
176
|
+
----------
|
|
177
|
+
|
|
178
|
+
- **WARNING** The underlying class name for Active Jobs has changed from `ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper` to `Sidekiq::ActiveJob::Wrapper`.
|
|
179
|
+
The old name will still work in 8.x.
|
|
180
|
+
- **WARNING** The `created_at`, `enqueued_at`, `failed_at` and `retried_at` attributes are now stored as epoch milliseconds, rather than epoch floats.
|
|
181
|
+
This is meant to avoid precision issues with JSON and JavaScript's 53-bit Floats.
|
|
182
|
+
Example: `"created_at" => 1234567890.123456` -> `"created_at" => 1234567890123`.
|
|
183
|
+
- **NEW FEATURE** Job Profiling is now supported with [Vernier](https://vernier.prof)
|
|
184
|
+
which makes it really easy to performance tune your slow jobs.
|
|
185
|
+
The Web UI contains a new **Profiles** tab to view any collected profile data.
|
|
186
|
+
Please read the new [Profiling](https://github.com/sidekiq/sidekiq/wiki/Profiling) wiki page for details.
|
|
187
|
+
- **NEW FEATURE** Job Metrics now store up to 72 hours of data and the Web UI allows display of 24/48/72 hours. [#6614]
|
|
188
|
+
- CurrentAttribute support now uses `ActiveJob::Arguments` to serialize the context object, supporting Symbols and GlobalID.
|
|
189
|
+
The change should be backwards compatible. [#6510]
|
|
190
|
+
- Freshen up `Sidekiq::Web` to simplify the code and improve security [#6532]
|
|
191
|
+
The CSS has been rewritten from scratch to remove the Bootstrap framework.
|
|
192
|
+
- Add `on_cancel` callback for iterable jobs [#6607]
|
|
193
|
+
- Add `cursor` reader to get the current cursor inside iterable jobs [#6606]
|
|
194
|
+
- Default error logging has been modified to use Ruby's `Exception#detailed_message` and `#full_message` APIs.
|
|
195
|
+
- CI now runs against Redis, Dragonfly and Valkey.
|
|
196
|
+
- Job tags now allow custom CSS display [#6595]
|
|
197
|
+
- The Web UI's language picker now shows options in the native language
|
|
198
|
+
- Remove global variable usage within the codebase
|
|
199
|
+
- Colorize and adjust logging for easier reading
|
|
200
|
+
- Adjust Sidekiq's default thread priority to -1 for a 50ms timeslice.
|
|
201
|
+
This can help avoid TimeoutErrors when Sidekiq is overloaded. [#6543]
|
|
202
|
+
- Use `Logger#with_level`, remove Sidekiq's custom impl
|
|
203
|
+
- Remove `base64` gem dependency
|
|
204
|
+
- Support: (Dragonfly 1.27+, Valkey 7.2+, Redis 7.2+), Ruby 3.2+, Rails 7.0+
|
|
205
|
+
|
|
206
|
+
7.3.10
|
|
207
|
+
----------
|
|
208
|
+
|
|
209
|
+
- Deprecate Redis :password as a String to avoid log disclosure. [#6625]
|
|
210
|
+
Use a Proc instead: `config.redis = { password: ->(username) { "password" } }`
|
|
211
|
+
|
|
212
|
+
7.3.9
|
|
213
|
+
----------
|
|
214
|
+
|
|
215
|
+
- Only require activejob if necessary [#6584]
|
|
216
|
+
You might get `uninitialized constant Sidekiq::ActiveJob` if you
|
|
217
|
+
`require 'sidekiq'` before `require 'rails'`.
|
|
218
|
+
- Fix iterable job cancellation [#6589]
|
|
219
|
+
- Web UI accessibility improvements [#6604]
|
|
220
|
+
|
|
221
|
+
7.3.8
|
|
222
|
+
----------
|
|
223
|
+
|
|
224
|
+
- Fix dead tag links [#6554]
|
|
225
|
+
- Massive Web UI performance improvement, some pages up to 15x faster [#6555]
|
|
226
|
+
|
|
227
|
+
7.3.7
|
|
228
|
+
----------
|
|
229
|
+
|
|
230
|
+
- Backport `Sidekiq::Web.configure` for compatibility with 8.0 [#6532]
|
|
231
|
+
- Backport `url_params(key)` and `route_params(key)` for compatibility with 8.0 [#6532]
|
|
232
|
+
- Various fixes for UI filtering [#6508]
|
|
233
|
+
- Tune `inspect` for internal S::Components to keep size managable [#6553]
|
|
234
|
+
|
|
235
|
+
7.3.6
|
|
236
|
+
----------
|
|
237
|
+
|
|
238
|
+
- Forward compatibility fixes for Ruby 3.4
|
|
239
|
+
- Filtering in the Web UI now works via GET so you can bookmark a filtered view. [#6497]
|
|
240
|
+
|
|
241
|
+
7.3.5
|
|
242
|
+
----------
|
|
243
|
+
|
|
244
|
+
- Reimplement `retry_all` and `kill_all` API methods to use ZPOPMIN,
|
|
245
|
+
approximately 30-60% faster. [#6481]
|
|
246
|
+
- Add preload testing binary at `examples/testing/sidekiq_boot` to verify your Rails app boots correctly with Sidekiq Enterprise's app preloading.
|
|
247
|
+
- Fix circular require with ActiveJob adapter [#6477]
|
|
248
|
+
- Fix potential race condition leading to incorrect serialized values for CurrentAttributes [#6475]
|
|
249
|
+
- Restore missing elapsed time when default job logging is disabled
|
|
250
|
+
|
|
251
|
+
7.3.4
|
|
252
|
+
----------
|
|
253
|
+
|
|
254
|
+
- Fix FrozenError when starting Sidekiq [#6470]
|
|
255
|
+
|
|
256
|
+
7.3.3
|
|
257
|
+
----------
|
|
258
|
+
|
|
259
|
+
- Freeze global configuration once boot is complete, to avoid configuration race conditions [#6466, #6465]
|
|
260
|
+
- Sidekiq now warns if a job iteration takes longer than the `-t` timeout setting (defaults to 25 seconds)
|
|
261
|
+
- Iteration callbacks now have easy access to job arguments via the `arguments` method:
|
|
262
|
+
```ruby
|
|
263
|
+
def on_stop
|
|
264
|
+
p arguments # => `[123, "string", {"key" => "value"}]`
|
|
265
|
+
id, str, hash = arguments
|
|
266
|
+
end
|
|
267
|
+
```
|
|
268
|
+
- Iterable jobs can be cancelled via `Sidekiq::Client#cancel!`:
|
|
269
|
+
```ruby
|
|
270
|
+
c = Sidekiq::Client.new
|
|
271
|
+
jid = c.push("class" => SomeJob, "args" => [123])
|
|
272
|
+
c.cancel!(jid) # => true
|
|
273
|
+
```
|
|
274
|
+
- Take over support for ActiveJob's `:sidekiq` adapter [#6430, fatkodima]
|
|
275
|
+
- Ensure CurrentAttributes are in scope when creating batch callbacks [#6455]
|
|
276
|
+
- Add `Sidekiq.gem_version` API.
|
|
277
|
+
- Update Ukranian translations
|
|
278
|
+
|
|
279
|
+
7.3.2
|
|
280
|
+
----------
|
|
281
|
+
|
|
282
|
+
- Adjust ActiveRecord batch iteration to restart an interrupted batch from the beginning.
|
|
283
|
+
Each batch should be processed as a single transaction in order to be idempotent. [#6405]
|
|
284
|
+
- Fix typo in Sidekiq::DeadSet#kill [#6397]
|
|
285
|
+
- Fix CSS issue with bottom bar in Web UI [#6414]
|
|
286
|
+
|
|
287
|
+
7.3.1
|
|
288
|
+
----------
|
|
289
|
+
|
|
290
|
+
- Don't count job interruptions as failures in metrics [#6386]
|
|
291
|
+
- Add frozen string literal to a number of .rb files.
|
|
292
|
+
- Fix frozen string error with style_tag and script_tag [#6371]
|
|
293
|
+
- Fix an error on Ruby 2.7 because of usage of `Hash#except` [#6376]
|
|
294
|
+
|
|
295
|
+
7.3.0
|
|
296
|
+
----------
|
|
297
|
+
|
|
298
|
+
- **NEW FEATURE** Add `Sidekiq::IterableJob`, iteration support for long-running jobs. [#6286, fatkodima]
|
|
299
|
+
Iterable jobs are interruptible and can restart quickly if
|
|
300
|
+
running during a deploy. You must ensure that `each_iteration`
|
|
301
|
+
doesn't take more than Sidekiq's `-t` timeout (default: 25 seconds). Iterable jobs must not implement `perform`.
|
|
302
|
+
```ruby
|
|
303
|
+
class ProcessArrayJob
|
|
304
|
+
include Sidekiq::IterableJob
|
|
305
|
+
def build_enumerator(*args, **kwargs)
|
|
306
|
+
array_enumerator(args, **kwargs)
|
|
307
|
+
end
|
|
308
|
+
def each_iteration(arg)
|
|
309
|
+
puts arg
|
|
310
|
+
end
|
|
311
|
+
end
|
|
312
|
+
ProcessArrayJob.perform_async(1, 2, 3)
|
|
313
|
+
```
|
|
314
|
+
See the [Iteration](//github.com/sidekiq/sidekiq/wiki/Iteration) wiki page and the RDoc in `Sidekiq::IterableJob`.
|
|
315
|
+
This feature should be considered BETA until the next minor release.
|
|
316
|
+
- **SECURITY** The Web UI no longer allows extensions to use `<script>`.
|
|
317
|
+
Adjust CSP to disallow inline scripts within the Web UI. Please see
|
|
318
|
+
`examples/webui-ext` for how to register Web UI extensions and use
|
|
319
|
+
dynamic CSS and JS. This will make Sidekiq immune to XSS attacks. [#6270]
|
|
320
|
+
- Add config option, `:skip_default_job_logging` to disable Sidekiq's default
|
|
321
|
+
start/finish job logging. [#6200]
|
|
322
|
+
- Allow `Sidekiq::Limiter.redis` to use Redis Cluster [#6288]
|
|
323
|
+
- Retain CurrentAttributeѕ after inline execution [#6307]
|
|
324
|
+
- Ignore non-existent CurrentAttributes attributes when restoring [#6341]
|
|
325
|
+
- Raise default Redis {read,write,connect} timeouts from 1 to 3 seconds
|
|
326
|
+
to minimize ReadTimeoutErrors [#6162]
|
|
327
|
+
- Add `logger` as a dependency since it will become bundled in Ruby 3.5 [#6320]
|
|
328
|
+
- Ignore unsupported locales in the Web UI [#6313]
|
|
329
|
+
|
|
330
|
+
7.2.4
|
|
331
|
+
----------
|
|
332
|
+
|
|
333
|
+
- Fix XSS in metrics filtering introduced in 7.2.0, CVE-2024-32887
|
|
334
|
+
Thanks to @UmerAdeemCheema for the security report.
|
|
335
|
+
|
|
336
|
+
7.2.3
|
|
337
|
+
----------
|
|
338
|
+
|
|
339
|
+
- [Support Dragonfly.io](https://www.mikeperham.com/2024/02/01/supporting-dragonfly/) as an alternative Redis implementation
|
|
340
|
+
- Fix error unpacking some compressed error backtraces [#6241]
|
|
341
|
+
- Fix potential heartbeat data leak [#6227]
|
|
342
|
+
- Add ability to find a currently running work by jid [#6212, fatkodima]
|
|
343
|
+
|
|
344
|
+
7.2.2
|
|
345
|
+
----------
|
|
346
|
+
|
|
347
|
+
- Add `Process.warmup` call in Ruby 3.3+
|
|
348
|
+
- Batch jobs now skip transactional push [#6160]
|
|
349
|
+
|
|
350
|
+
7.2.1
|
|
351
|
+
----------
|
|
352
|
+
|
|
353
|
+
- Add `Sidekiq::Work` type which replaces the raw Hash as the third parameter in
|
|
354
|
+
`Sidekiq::WorkSet#each { |pid, tid, hash| ... }` [#6145]
|
|
355
|
+
- **DEPRECATED**: direct access to the attributes within the `hash` block parameter above.
|
|
356
|
+
The `Sidekiq::Work` instance contains accessor methods to get at the same data, e.g.
|
|
357
|
+
```ruby
|
|
358
|
+
work["queue"] # Old
|
|
359
|
+
work.queue # New
|
|
360
|
+
```
|
|
361
|
+
- Fix Ruby 3.3 warnings around `base64` gem [#6151, earlopain]
|
|
362
|
+
|
|
363
|
+
7.2.0
|
|
364
|
+
----------
|
|
365
|
+
|
|
366
|
+
- `sidekiq_retries_exhausted` can return `:discard` to avoid the deadset
|
|
367
|
+
and all death handlers [#6091]
|
|
368
|
+
- Metrics filtering by job class in Web UI [#5974]
|
|
369
|
+
- Better readability and formatting for numbers within the Web UI [#6080]
|
|
370
|
+
- Add explicit error if user code tries to nest test modes [#6078]
|
|
371
|
+
```ruby
|
|
372
|
+
Sidekiq::Testing.inline! # global setting
|
|
373
|
+
Sidekiq::Testing.fake! do # override within block
|
|
374
|
+
# ok
|
|
375
|
+
Sidekiq::Testing.inline! do # can't override the override
|
|
376
|
+
# not ok, nested
|
|
377
|
+
end
|
|
378
|
+
end
|
|
379
|
+
```
|
|
380
|
+
- **SECURITY** Forbid inline JavaScript execution in Web UI [#6074]
|
|
381
|
+
- Adjust redis-client adapter to avoid `method_missing` [#6083]
|
|
382
|
+
This can result in app code breaking if your app's Redis API usage was
|
|
383
|
+
depending on Sidekiq's adapter to correct invalid redis-client API usage.
|
|
384
|
+
One example:
|
|
385
|
+
```ruby
|
|
386
|
+
# bad, not redis-client native
|
|
387
|
+
# Unsupported command argument type: TrueClass (TypeError)
|
|
388
|
+
Sidekiq.redis { |c| c.set("key", "value", nx: true, ex: 15) }
|
|
389
|
+
# good
|
|
390
|
+
Sidekiq.redis { |c| c.set("key", "value", "nx", "ex", 15) }
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
7.1.6
|
|
394
|
+
----------
|
|
395
|
+
|
|
396
|
+
- The block forms of testing modes (inline, fake) are now thread-safe so you can have
|
|
397
|
+
a multithreaded test suite which uses different modes for different tests. [#6069]
|
|
398
|
+
- Fix breakage with non-Proc error handlers [#6065]
|
|
399
|
+
|
|
400
|
+
7.1.5
|
|
401
|
+
----------
|
|
402
|
+
|
|
403
|
+
- **FEATURE**: Job filtering within the Web UI. This feature has been open
|
|
404
|
+
sourced from Sidekiq Pro. [#6052]
|
|
405
|
+
- **API CHANGE** Error handlers now take three arguments `->(ex, context, config)`.
|
|
406
|
+
The previous calling convention will work until Sidekiq 8.0 but will print
|
|
407
|
+
out a deprecation warning. [#6051]
|
|
408
|
+
- Fix issue with the `batch_size` and `at` options in `S::Client.push_bulk` [#6040]
|
|
409
|
+
- Fix inline testing firing batch callbacks early [#6057]
|
|
410
|
+
- Use new log broadcast API in Rails 7.1 [#6054]
|
|
411
|
+
- Crash if user tries to use RESP2 `protocol: 2` [#6061]
|
|
412
|
+
|
|
413
|
+
7.1.4
|
|
414
|
+
----------
|
|
415
|
+
|
|
416
|
+
- Fix empty `retry_for` logic [#6035]
|
|
417
|
+
|
|
418
|
+
7.1.3
|
|
419
|
+
----------
|
|
420
|
+
|
|
421
|
+
- Add `sidekiq_options retry_for: 48.hours` to allow time-based retry windows [#6029]
|
|
422
|
+
- Support sidekiq_retry_in and sidekiq_retries_exhausted_block in ActiveJobs (#5994)
|
|
423
|
+
- Lowercase all Rack headers for Rack 3.0 [#5951]
|
|
424
|
+
- Validate Sidekiq::Web page refresh delay to avoid potential DoS,
|
|
425
|
+
CVE-2023-26141, thanks for reporting Keegan!
|
|
426
|
+
|
|
427
|
+
7.1.2
|
|
428
|
+
----------
|
|
429
|
+
|
|
430
|
+
- Mark Web UI assets as private so CDNs won't cache them [#5936]
|
|
431
|
+
- Fix stackoverflow when using Oj and the JSON log formatter [#5920]
|
|
432
|
+
- Remove spurious `enqueued_at` from scheduled ActiveJobs [#5937]
|
|
433
|
+
|
|
434
|
+
7.1.1
|
|
435
|
+
----------
|
|
436
|
+
|
|
437
|
+
- Support multiple CurrentAttributes [#5904]
|
|
438
|
+
- Speed up latency fetch with large queues on Redis <7 [#5910]
|
|
439
|
+
- Allow a larger default client pool [#5886]
|
|
440
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
|
441
|
+
|
|
442
|
+
7.1.0
|
|
443
|
+
----------
|
|
444
|
+
|
|
445
|
+
- Improve display of ActiveJob arguments in Web UI [#5825, cover]
|
|
446
|
+
- Update `push_bulk` to push `batch_size` jobs at a time and allow laziness [#5827, fatkodima]
|
|
447
|
+
This allows Sidekiq::Client to push unlimited jobs as long as it has enough memory for the batch_size.
|
|
448
|
+
- Update `perform_bulk` to use `push_bulk` internally.
|
|
449
|
+
- Change return value of `push_bulk` to map 1-to-1 with arguments.
|
|
450
|
+
If you call `push_bulk(args: [[1], [2], [3]])`, you will now always get
|
|
451
|
+
an array of 3 values as the result: `["jid1", nil, "jid3"]` where nil means
|
|
452
|
+
that particular job did not push successfully (possibly due to middleware
|
|
453
|
+
stopping it). Previously nil values were removed so it was impossible to tell
|
|
454
|
+
which jobs pushed successfully and which did not.
|
|
455
|
+
- Migrate away from all deprecated Redis commands [#5788]
|
|
456
|
+
Sidekiq will now print a warning if you use one of those deprecated commands.
|
|
457
|
+
- Prefix all Sidekiq thread names [#5872]
|
|
458
|
+
|
|
459
|
+
7.0.9
|
|
460
|
+
----------
|
|
461
|
+
|
|
462
|
+
- Restore confirmation dialogs in Web UI [#5881, shevaun]
|
|
463
|
+
- Increase fetch timeout to minimize ReadTimeoutError [#5874]
|
|
464
|
+
- Reverse histogram tooltip ordering [#5868]
|
|
465
|
+
- Add Scottish Gaelic (gd) locale [#5867, GunChleoc]
|
|
466
|
+
|
|
467
|
+
7.0.8
|
|
468
|
+
----------
|
|
469
|
+
|
|
470
|
+
- **SECURITY** Sanitize `period` input parameter on Metrics pages.
|
|
471
|
+
Specially crafted values can lead to XSS. This functionality
|
|
472
|
+
was introduced in 7.0.4. Thank you to spercex @ huntr.dev [#5694]
|
|
473
|
+
- Add job hash as 3rd parameter to the `sidekiq_retry_in` block.
|
|
474
|
+
|
|
475
|
+
7.0.7
|
|
476
|
+
----------
|
|
477
|
+
|
|
478
|
+
- Fix redis-client API usage which could result in stuck Redis
|
|
479
|
+
connections [#5823]
|
|
480
|
+
- Fix AS::Duration with `sidekiq_retry_in` [#5806]
|
|
481
|
+
- Restore dumping config options on startup with `-v` [#5822]
|
|
482
|
+
|
|
483
|
+
7.0.5,7.0.6
|
|
484
|
+
----------
|
|
485
|
+
|
|
486
|
+
- More context for debugging json unsafe errors [#5787]
|
|
487
|
+
|
|
488
|
+
7.0.4
|
|
489
|
+
----------
|
|
490
|
+
|
|
491
|
+
- Performance and memory optimizations [#5768, fatkodima]
|
|
492
|
+
- Add 1-8 hour period selector to Metrics pages [#5694]
|
|
493
|
+
- Fix process display with `sidekiqmon` [#5733]
|
|
494
|
+
|
|
495
|
+
7.0.3
|
|
496
|
+
----------
|
|
497
|
+
|
|
498
|
+
- Don't warn about memory policy on Redis Enterprise [#5712]
|
|
499
|
+
- Don't allow Quiet/Stop on embedded Sidekiq instances [#5716]
|
|
500
|
+
- Fix `size: X` for configuring the default Redis pool size [#5702]
|
|
501
|
+
- Improve the display of queue weights on Busy page [#5642]
|
|
502
|
+
- Freeze CurrentAttributes on a job once initially set [#5692]
|
|
503
|
+
|
|
504
|
+
7.0.2
|
|
505
|
+
----------
|
|
506
|
+
|
|
507
|
+
- Improve compatibility with custom loggers [#5673]
|
|
508
|
+
- Add queue weights on Busy page [#5640]
|
|
509
|
+
- Add BID link on job_info page if job is part of a Batch [#5623]
|
|
510
|
+
- Allow custom extensions to add rows/links within Job detail pages [#5624]
|
|
511
|
+
```ruby
|
|
512
|
+
Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
|
|
513
|
+
|
|
514
|
+
class AddAccountLink
|
|
515
|
+
include CGI::Util
|
|
516
|
+
def add_pair(job)
|
|
517
|
+
# yield a (name, value) pair
|
|
518
|
+
# You can include HTML tags and CSS, Sidekiq does not do any
|
|
519
|
+
# escaping so beware user data injection! Note how we use CGI's
|
|
520
|
+
# `h` escape helper.
|
|
521
|
+
aid = job["account_id"]
|
|
522
|
+
yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
|
|
523
|
+
end
|
|
524
|
+
end
|
|
525
|
+
```
|
|
526
|
+
|
|
527
|
+
7.0.1
|
|
528
|
+
----------
|
|
529
|
+
|
|
530
|
+
- Allow an embedding process to reuse its own heartbeat thread
|
|
531
|
+
- Update zh-cn localization
|
|
532
|
+
|
|
533
|
+
7.0.0
|
|
534
|
+
----------
|
|
535
|
+
|
|
536
|
+
- Embedded mode!
|
|
537
|
+
- Capsules!!
|
|
538
|
+
- Job Execution metrics!!!
|
|
539
|
+
- See `docs/7.0-Upgrade.md` for release notes
|
|
540
|
+
|
|
541
|
+
6.5.{10,11,12}
|
|
542
|
+
----------
|
|
543
|
+
|
|
544
|
+
- Fixes for Rails 7.1 [#6067, #6070]
|
|
545
|
+
|
|
546
|
+
6.5.9
|
|
547
|
+
----------
|
|
548
|
+
|
|
549
|
+
- Ensure Sidekiq.options[:environment] == RAILS_ENV [#5932]
|
|
550
|
+
|
|
551
|
+
6.5.8
|
|
552
|
+
----------
|
|
553
|
+
|
|
554
|
+
- Fail if using a bad version of scout_apm [#5616]
|
|
555
|
+
- Add pagination to Busy page [#5556]
|
|
556
|
+
- Speed up WorkSet#each [#5559]
|
|
557
|
+
- Adjust CurrentAttributes to work with the String class name so we aren't referencing the Class within a Rails initializer [#5536]
|
|
558
|
+
|
|
559
|
+
6.5.7
|
|
560
|
+
----------
|
|
561
|
+
|
|
562
|
+
- Updates for JA and ZH locales
|
|
563
|
+
- Further optimizations for scheduled polling [#5513]
|
|
564
|
+
|
|
565
|
+
6.5.6
|
|
566
|
+
----------
|
|
567
|
+
|
|
568
|
+
- Fix deprecation warnings with redis-rb 4.8.0 [#5484]
|
|
569
|
+
- Lock redis-rb to < 5.0 as we are moving to redis-client in Sidekiq 7.0
|
|
570
|
+
|
|
571
|
+
6.5.5
|
|
572
|
+
----------
|
|
573
|
+
|
|
574
|
+
- Fix require issue with job_retry.rb [#5462]
|
|
575
|
+
- Improve Sidekiq::Web compatibility with Rack 3.x
|
|
576
|
+
|
|
577
|
+
6.5.4
|
|
578
|
+
----------
|
|
579
|
+
|
|
580
|
+
- Fix invalid code on Ruby 2.5 [#5460]
|
|
581
|
+
- Fix further metrics dependency issues [#5457]
|
|
582
|
+
|
|
583
|
+
6.5.3
|
|
584
|
+
----------
|
|
585
|
+
|
|
586
|
+
- Don't require metrics code without explicit opt-in [#5456]
|
|
587
|
+
|
|
588
|
+
6.5.2
|
|
589
|
+
----------
|
|
590
|
+
|
|
591
|
+
- [Job Metrics are under active development, help wanted!](https://github.com/sidekiq/sidekiq/wiki/Metrics#contributing) **BETA**
|
|
592
|
+
- Add `Context` column on queue page which shows any CurrentAttributes [#5450]
|
|
593
|
+
- `sidekiq_retry_in` may now return `:discard` or `:kill` to dynamically stop job retries [#5406]
|
|
594
|
+
- Smarter sorting of processes in /busy Web UI [#5398]
|
|
595
|
+
- Fix broken hamburger menu in mobile UI [#5428]
|
|
596
|
+
- Require redis-rb 4.5.0. Note that Sidekiq will break if you use the
|
|
597
|
+
[`Redis.exists_returns_integer = false`](https://github.com/redis/redis-rb/blob/master/CHANGELOG.md#450) flag. [#5394]
|
|
598
|
+
|
|
599
|
+
6.5.1
|
|
600
|
+
----------
|
|
601
|
+
|
|
602
|
+
- Fix `push_bulk` breakage [#5387]
|
|
603
|
+
|
|
604
|
+
6.5.0
|
|
605
|
+
---------
|
|
606
|
+
|
|
607
|
+
- Substantial refactoring of Sidekiq server internals, part of a larger effort
|
|
608
|
+
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).
|
|
609
|
+
- **Add beta support for the `redis-client` gem**. This will become the default Redis driver in Sidekiq 7.0. [#5298]
|
|
610
|
+
Read more: https://github.com/sidekiq/sidekiq/wiki/Using-redis-client
|
|
611
|
+
- **Add beta support for DB transaction-aware client** [#5291]
|
|
612
|
+
Add this line to your initializer and any jobs created during a transaction
|
|
613
|
+
will only be pushed to Redis **after the transaction commits**. You will need to add the
|
|
614
|
+
`after_commit_everywhere` gem to your Gemfile.
|
|
615
|
+
```ruby
|
|
616
|
+
Sidekiq.transactional_push!
|
|
617
|
+
```
|
|
618
|
+
This feature does not have a lot of production usage yet; please try it out and let us
|
|
619
|
+
know if you have any issues. It will be fully supported in Sidekiq 7.0 or removed if it
|
|
620
|
+
proves problematic.
|
|
621
|
+
- Fix regression with middleware arguments [#5312]
|
|
622
|
+
|
|
623
|
+
6.4.2
|
|
624
|
+
---------
|
|
625
|
+
|
|
626
|
+
- Strict argument checking now runs after client-side middleware [#5246]
|
|
627
|
+
- Fix page events with live polling [#5184]
|
|
628
|
+
- Many under-the-hood changes to remove all usage of the term "worker"
|
|
629
|
+
from the Sidekiq codebase and APIs. This mostly involved RDoc and local
|
|
630
|
+
variable names but a few constants and public APIs were changed. The old
|
|
631
|
+
APIs will be removed in Sidekiq 7.0.
|
|
632
|
+
```
|
|
633
|
+
Sidekiq::DEFAULT_WORKER_OPTIONS -> Sidekiq.default_job_options
|
|
634
|
+
Sidekiq.default_worker_options -> Sidekiq.default_job_options
|
|
635
|
+
Sidekiq::Queues["default"].jobs_by_worker(HardJob) -> Sidekiq::Queues["default"].jobs_by_class(HardJob)
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
6.4.1
|
|
639
|
+
---------
|
|
640
|
+
|
|
641
|
+
- Fix pipeline/multi deprecations in redis-rb 4.6
|
|
642
|
+
- Fix sidekiq.yml YAML load errors on Ruby 3.1 [#5141]
|
|
643
|
+
- Sharding support for `perform_bulk` [#5129]
|
|
644
|
+
- Refactor job logger for SPEEEEEEED
|
|
645
|
+
|
|
646
|
+
6.4.0
|
|
647
|
+
---------
|
|
648
|
+
|
|
649
|
+
- **SECURITY**: Validate input to avoid possible DoS in Web UI.
|
|
650
|
+
- Add **strict argument checking** [#5071]
|
|
651
|
+
Sidekiq will now log a warning if JSON-unsafe arguments are passed to `perform_async`.
|
|
652
|
+
Add `Sidekiq.strict_args!(false)` to your initializer to disable this warning.
|
|
653
|
+
This warning will switch to an exception in Sidekiq 7.0.
|
|
654
|
+
- Note that Delayed Extensions will be removed in Sidekiq 7.0 [#5076]
|
|
655
|
+
- Add `perform_{inline,sync}` in Sidekiq::Job to run a job synchronously [#5061, hasan-ally]
|
|
656
|
+
```ruby
|
|
657
|
+
SomeJob.perform_async(args...)
|
|
658
|
+
SomeJob.perform_sync(args...)
|
|
659
|
+
SomeJob.perform_inline(args...)
|
|
660
|
+
```
|
|
661
|
+
You can also dynamically redirect a job to run synchronously:
|
|
662
|
+
```ruby
|
|
663
|
+
SomeJob.set("sync": true).perform_async(args...) # will run via perform_inline
|
|
664
|
+
```
|
|
665
|
+
- Replace Sidekiq::Worker `app/workers` generator with Sidekiq::Job `app/sidekiq` generator [#5055]
|
|
666
|
+
```
|
|
667
|
+
bin/rails generate sidekiq:job ProcessOrderJob
|
|
668
|
+
```
|
|
669
|
+
- Fix job retries losing CurrentAttributes [#5090]
|
|
670
|
+
- Tweak shutdown to give long-running threads time to cleanup [#5095]
|
|
671
|
+
|
|
672
|
+
6.3.1
|
|
673
|
+
---------
|
|
674
|
+
|
|
675
|
+
- Fix keyword arguments error with CurrentAttributes on Ruby 3.0 [#5048]
|
|
676
|
+
|
|
677
|
+
6.3.0
|
|
678
|
+
---------
|
|
679
|
+
|
|
680
|
+
- **BREAK**: The Web UI has been refactored to remove jQuery. Any UI extensions
|
|
681
|
+
which use jQuery will break.
|
|
682
|
+
- **FEATURE**: Sidekiq.logger has been enhanced so any `Rails.logger`
|
|
683
|
+
output in jobs now shows up in the Sidekiq console. Remove any logger
|
|
684
|
+
hacks in your initializer and see if it Just Works™ now. [#5021]
|
|
685
|
+
- **FEATURE**: Add `Sidekiq::Job` alias for `Sidekiq::Worker`, to better
|
|
686
|
+
reflect industry standard terminology. You can now do this:
|
|
687
|
+
```ruby
|
|
688
|
+
class MyJob
|
|
689
|
+
include Sidekiq::Job
|
|
690
|
+
sidekiq_options ...
|
|
691
|
+
def perform(args)
|
|
692
|
+
end
|
|
693
|
+
end
|
|
694
|
+
```
|
|
695
|
+
- **FEATURE**: Support for serializing ActiveSupport::CurrentAttributes into each job. [#4982]
|
|
696
|
+
```ruby
|
|
697
|
+
# config/initializers/sidekiq.rb
|
|
698
|
+
require "sidekiq/middleware/current_attributes"
|
|
699
|
+
Sidekiq::CurrentAttributes.persist(Myapp::Current) # Your AS::CurrentAttributes singleton
|
|
700
|
+
```
|
|
701
|
+
- **FEATURE**: Add `Sidekiq::Worker.perform_bulk` for enqueuing jobs in bulk,
|
|
702
|
+
similar to `Sidekiq::Client.push_bulk` [#5042]
|
|
703
|
+
```ruby
|
|
704
|
+
MyJob.perform_bulk([[1], [2], [3]])
|
|
705
|
+
```
|
|
706
|
+
- Implement `queue_as`, `wait` and `wait_until` for ActiveJob compatibility [#5003]
|
|
707
|
+
- Scheduler now uses Lua to reduce Redis load and network roundtrips [#5044]
|
|
708
|
+
- Retry Redis operation if we get an `UNBLOCKED` Redis error [#4985]
|
|
709
|
+
- Run existing signal traps, if any, before running Sidekiq's trap [#4991]
|
|
710
|
+
- Fix fetch bug when using weighted queues which caused Sidekiq to stop
|
|
711
|
+
processing queues randomly [#5031]
|
|
4
712
|
|
|
5
713
|
6.2.2
|
|
6
714
|
---------
|
|
@@ -99,7 +807,7 @@ If this is a Rails app in API mode, you need to enable sessions.
|
|
|
99
807
|
---------
|
|
100
808
|
|
|
101
809
|
- **Integrate with systemd's watchdog and notification features** [#4488]
|
|
102
|
-
Set `Type=notify` in [sidekiq.service](https://github.com/
|
|
810
|
+
Set `Type=notify` in [sidekiq.service](https://github.com/sidekiq/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
|
|
103
811
|
- Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
|
|
104
812
|
- Fix edge case where a job can be pushed without a queue.
|
|
105
813
|
- Flush job stats at exit [#4498]
|
|
@@ -112,7 +820,7 @@ If this is a Rails app in API mode, you need to enable sessions.
|
|
|
112
820
|
- Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
|
|
113
821
|
- Update APIs to use `UNLINK`, not `DEL`. [#4449]
|
|
114
822
|
- Fix Ruby 2.7 warnings [#4412]
|
|
115
|
-
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/
|
|
823
|
+
- Add support for `APP_ENV` [[95fa5d9]](https://github.com/sidekiq/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
|
|
116
824
|
|
|
117
825
|
6.0.4
|
|
118
826
|
---------
|
|
@@ -224,7 +932,7 @@ Sidekiq.configure_server do |config|
|
|
|
224
932
|
config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
|
|
225
933
|
end
|
|
226
934
|
```
|
|
227
|
-
See the [Logging wiki page](https://github.com/
|
|
935
|
+
See the [Logging wiki page](https://github.com/sidekiq/sidekiq/wiki/Logging) for more details.
|
|
228
936
|
- **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
|
|
229
937
|
variable. This variable is meant to hold the name of the environment
|
|
230
938
|
variable which contains your Redis URL, so that you can switch Redis
|
|
@@ -244,6 +952,13 @@ See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for
|
|
|
244
952
|
- Integrate the StandardRB code formatter to ensure consistent code
|
|
245
953
|
styling. [#4114, gearnode]
|
|
246
954
|
|
|
955
|
+
5.2.10
|
|
956
|
+
---------
|
|
957
|
+
|
|
958
|
+
- Backport fix for CVE-2022-23837.
|
|
959
|
+
- Migrate to `exists?` for redis-rb.
|
|
960
|
+
- Lock redis-rb to <4.6 to avoid deprecations.
|
|
961
|
+
|
|
247
962
|
5.2.9
|
|
248
963
|
---------
|
|
249
964
|
|
|
@@ -409,7 +1124,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
|
|
|
409
1124
|
- The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
|
|
410
1125
|
- Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
|
|
411
1126
|
of random hex bytes.
|
|
412
|
-
- Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
|
|
1127
|
+
- Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail.
|
|
413
1128
|
|
|
414
1129
|
4.2.10
|
|
415
1130
|
-----------
|
|
@@ -627,7 +1342,7 @@ Sidekiq::Queues.clear_all
|
|
|
627
1342
|
- Sidekiq's internals have been completely overhauled for performance
|
|
628
1343
|
and to remove dependencies. This has resulted in major speedups, as
|
|
629
1344
|
[detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
|
|
630
|
-
- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail.
|
|
1345
|
+
- See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail.
|
|
631
1346
|
|
|
632
1347
|
3.5.4
|
|
633
1348
|
-----------
|
|
@@ -664,7 +1379,7 @@ Sidekiq::Queues.clear_all
|
|
|
664
1379
|
- **FIX MEMORY LEAK** Under rare conditions, threads may leak [#2598, gazay]
|
|
665
1380
|
- Add Ukrainian locale [#2561, elrakita]
|
|
666
1381
|
- Disconnect and retry Redis operations if we see a READONLY error [#2550]
|
|
667
|
-
- Add server middleware testing harness; see [wiki](https://github.com/
|
|
1382
|
+
- Add server middleware testing harness; see [wiki](https://github.com/sidekiq/sidekiq/wiki/Testing#testing-server-middleware) [#2534, ryansch]
|
|
668
1383
|
|
|
669
1384
|
3.5.0
|
|
670
1385
|
-----------
|
|
@@ -682,7 +1397,7 @@ Sidekiq::Queues.clear_all
|
|
|
682
1397
|
- Fix CSRF vulnerability in Web UI, thanks to Egor Homakov for
|
|
683
1398
|
reporting. [#2422] If you are running the Web UI as a standalone Rack app,
|
|
684
1399
|
ensure you have a [session middleware
|
|
685
|
-
configured](https://github.com/
|
|
1400
|
+
configured](https://github.com/sidekiq/sidekiq/wiki/Monitoring#standalone):
|
|
686
1401
|
```ruby
|
|
687
1402
|
use Rack::Session::Cookie, :secret => "some unique secret string here"
|
|
688
1403
|
```
|
|
@@ -894,7 +1609,7 @@ sidekiq_options :dead => false, :retry => 5
|
|
|
894
1609
|
3.0.0
|
|
895
1610
|
-----------
|
|
896
1611
|
|
|
897
|
-
Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
|
|
1612
|
+
Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes.
|
|
898
1613
|
|
|
899
1614
|
- **Dead Job Queue** - jobs which run out of retries are now moved to a dead
|
|
900
1615
|
job queue. These jobs must be retried manually or they will expire
|
|
@@ -938,7 +1653,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do
|
|
|
938
1653
|
end
|
|
939
1654
|
```
|
|
940
1655
|
**Sharding support does require a breaking change to client-side
|
|
941
|
-
middleware, see 3.0-Upgrade.md.**
|
|
1656
|
+
middleware, see docs/3.0-Upgrade.md.**
|
|
942
1657
|
- New Chinese, Greek, Swedish and Czech translations for the Web UI.
|
|
943
1658
|
- Updated most languages translations for the new UI features.
|
|
944
1659
|
- **Remove official Capistrano integration** - this integration has been
|
|
@@ -1066,7 +1781,7 @@ middleware, see 3.0-Upgrade.md.**
|
|
|
1066
1781
|
appear to be doing any work. [#1194]
|
|
1067
1782
|
- Sidekiq's testing behavior is now dynamic. You can choose between
|
|
1068
1783
|
`inline` and `fake` behavior in your tests. See
|
|
1069
|
-
[Testing](https://github.com/
|
|
1784
|
+
[Testing](https://github.com/sidekiq/sidekiq/wiki/Testing) for detail. [#1193]
|
|
1070
1785
|
- The Retries table has a new column for the error message.
|
|
1071
1786
|
- The Web UI topbar now contains the status and live poll button.
|
|
1072
1787
|
- Orphaned worker records are now auto-vacuumed when you visit the
|