wurk 1.12.0 → 1.14.0
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/README.md +2 -2
- data/app/controllers/concerns/wurk/sse_streaming.rb +36 -1
- data/app/controllers/wurk/api/pagination.rb +9 -7
- data/app/controllers/wurk/api/serializers.rb +8 -2
- data/app/controllers/wurk/api_controller.rb +57 -24
- data/app/controllers/wurk/application_controller.rb +0 -2
- data/app/controllers/wurk/dashboard_controller.rb +0 -1
- data/config/routes.rb +13 -1
- data/exe/sidekiq +8 -0
- data/exe/wurk +1 -1
- data/lib/generators/wurk/install/install_generator.rb +56 -0
- data/lib/sidekiq/cli.rb +4 -3
- data/lib/sidekiq/deploy.rb +2 -1
- data/lib/sidekiq/embedded.rb +2 -1
- data/lib/sidekiq/iterable_job.rb +2 -1
- data/lib/sidekiq/job/iterable/active_record_enumerator.rb +2 -1
- data/lib/sidekiq/job/iterable/csv_enumerator.rb +2 -1
- data/lib/sidekiq/job/iterable.rb +2 -1
- data/lib/sidekiq/launcher.rb +2 -1
- data/lib/sidekiq/manager.rb +2 -1
- data/lib/sidekiq/metrics/query.rb +2 -1
- data/lib/sidekiq/pro/web.rb +2 -1
- data/lib/sidekiq/scheduled.rb +2 -1
- data/lib/sidekiq/web.rb +2 -1
- data/lib/sidekiq.rb +3 -2
- data/lib/wurk/api/fast.rb +4 -18
- data/lib/wurk/api/queues.rb +12 -10
- data/lib/wurk/api/serializers.rb +6 -7
- data/lib/wurk/api/swarm.rb +0 -1
- data/lib/wurk/batch/server_middleware.rb +4 -0
- data/lib/wurk/batch/status.rb +45 -22
- data/lib/wurk/batch_set.rb +34 -0
- data/lib/wurk/boot_checks.rb +80 -0
- data/lib/wurk/cli.rb +72 -36
- data/lib/wurk/client/buffered.rb +97 -26
- data/lib/wurk/client.rb +21 -1
- data/lib/wurk/compat/deploy.rb +7 -0
- data/lib/wurk/compat/encryption.rb +7 -0
- data/lib/wurk/compat/flow.rb +8 -0
- data/lib/wurk/compat/iterable_job.rb +8 -0
- data/lib/wurk/compat/profile_set.rb +8 -0
- data/lib/wurk/compat/server.rb +15 -0
- data/lib/wurk/compat/web.rb +20 -0
- data/lib/wurk/compat.rb +34 -40
- data/lib/wurk/configuration.rb +73 -15
- data/lib/wurk/cron.rb +146 -47
- data/lib/wurk/dead_set.rb +10 -6
- data/lib/wurk/embedded.rb +0 -2
- data/lib/wurk/engine.rb +46 -4
- data/lib/wurk/error_coalescer.rb +21 -1
- data/lib/wurk/fetcher/many_queues.rb +8 -6
- data/lib/wurk/fetcher/orphan_reclaim.rb +48 -11
- data/lib/wurk/{middleware → fetcher}/poison_pill.rb +4 -2
- data/lib/wurk/fetcher/reaper.rb +28 -14
- data/lib/wurk/fetcher/reliable.rb +50 -32
- data/lib/wurk/fetcher/self_reconcile.rb +0 -1
- data/lib/wurk/fetcher/unit_of_work.rb +17 -2
- data/lib/wurk/flow/status.rb +10 -4
- data/lib/wurk/flow_set.rb +24 -2
- data/lib/wurk/health.rb +0 -1
- data/lib/wurk/heartbeat.rb +13 -7
- data/lib/wurk/import/sidekiq_cron.rb +0 -1
- data/lib/wurk/job_logger.rb +4 -2
- data/lib/wurk/job_record.rb +2 -1
- data/lib/wurk/job_retry.rb +1 -1
- data/lib/wurk/job_set.rb +132 -6
- data/lib/wurk/job_util.rb +14 -0
- data/lib/wurk/launcher.rb +30 -15
- data/lib/wurk/lazy_loader.rb +60 -0
- data/lib/wurk/leader.rb +1 -8
- data/lib/wurk/limiter/bucket.rb +0 -2
- data/lib/wurk/limiter/concurrent.rb +19 -36
- data/lib/wurk/limiter/leaky.rb +0 -2
- data/lib/wurk/limiter/points.rb +0 -2
- data/lib/wurk/limiter/server_middleware.rb +4 -1
- data/lib/wurk/limiter/unlimited.rb +0 -2
- data/lib/wurk/limiter/window.rb +0 -2
- data/lib/wurk/limiter.rb +0 -7
- data/lib/wurk/logger.rb +44 -5
- data/lib/wurk/lua/fast_delete.rb +58 -0
- data/lib/wurk/lua/fast_delete_window.lua +46 -0
- data/lib/wurk/lua/limiter_concurrent_acquire.lua +10 -3
- data/lib/wurk/lua/limiter_concurrent_release.lua +13 -4
- data/lib/wurk/lua.rb +1 -41
- data/lib/wurk/manager.rb +27 -1
- data/lib/wurk/metrics/dashboard_series.rb +38 -18
- data/lib/wurk/metrics/history.rb +24 -11
- data/lib/wurk/metrics/prometheus.rb +0 -1
- data/lib/wurk/metrics/query.rb +0 -2
- data/lib/wurk/metrics/queue_rollup.rb +33 -11
- data/lib/wurk/metrics/statsd.rb +4 -0
- data/lib/wurk/middleware/chain.rb +25 -3
- data/lib/wurk/middleware/expiry.rb +4 -0
- data/lib/wurk/middleware/interrupt_handler.rb +4 -1
- data/lib/wurk/middleware/status.rb +4 -0
- data/lib/wurk/middleware/timeout.rb +10 -6
- data/lib/wurk/preflight/app_scan.rb +182 -0
- data/lib/wurk/preflight/command.rb +21 -5
- data/lib/wurk/preflight/owners.rb +0 -1
- data/lib/wurk/preflight/payload_sample.rb +0 -1
- data/lib/wurk/preflight/redis_guard.rb +98 -0
- data/lib/wurk/preflight/verify.rb +0 -2
- data/lib/wurk/preflight.rb +9 -5
- data/lib/wurk/process_set.rb +6 -1
- data/lib/wurk/profiler.rb +2 -1
- data/lib/wurk/queue.rb +33 -6
- data/lib/wurk/queue_consumers.rb +10 -1
- data/lib/wurk/rails_boot.rb +9 -4
- data/lib/wurk/railtie.rb +3 -4
- data/lib/wurk/redis_options.rb +5 -0
- data/lib/wurk/redis_pool.rb +24 -1
- data/lib/wurk/sentry/error_handler.rb +5 -0
- data/lib/wurk/sentry/middleware.rb +4 -0
- data/lib/wurk/sentry.rb +11 -0
- data/lib/wurk/sorted_entry.rb +16 -12
- data/lib/wurk/stats.rb +85 -1
- data/lib/wurk/swarm/child_boot.rb +0 -2
- data/lib/wurk/swarm/liveness.rb +0 -2
- data/lib/wurk/swarm/memory_watch.rb +116 -0
- data/lib/wurk/swarm/prefork.rb +54 -0
- data/lib/wurk/swarm.rb +95 -55
- data/lib/wurk/version.rb +1 -1
- data/lib/wurk/web/enterprise.rb +63 -7
- data/lib/wurk/web/rack_app.rb +8 -6
- data/lib/wurk/web/stats_routes.rb +93 -0
- data/lib/wurk.rb +34 -30
- data/vendor/assets/dashboard/assets/ArgsValue-BSTICTw4.js +1 -0
- data/vendor/assets/dashboard/assets/ArgsValue-BSTICTw4.js.br +0 -0
- data/vendor/assets/dashboard/assets/ArgsValue-BSTICTw4.js.gz +0 -0
- data/vendor/assets/dashboard/assets/BatchDetail-BBMiNTok.js +1 -0
- data/vendor/assets/dashboard/assets/BatchDetail-BBMiNTok.js.br +0 -0
- data/vendor/assets/dashboard/assets/BatchDetail-BBMiNTok.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Batches-D8I3hCXy.js +1 -0
- data/vendor/assets/dashboard/assets/Batches-D8I3hCXy.js.br +0 -0
- data/vendor/assets/dashboard/assets/Batches-D8I3hCXy.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Busy-CcSvIQFY.js +1 -0
- data/vendor/assets/dashboard/assets/Busy-CcSvIQFY.js.br +0 -0
- data/vendor/assets/dashboard/assets/Busy-CcSvIQFY.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Cron-ByRxtItH.js +1 -0
- data/vendor/assets/dashboard/assets/Cron-ByRxtItH.js.br +0 -0
- data/vendor/assets/dashboard/assets/Cron-ByRxtItH.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Dashboard-CO7_6OUM.js +1 -0
- data/vendor/assets/dashboard/assets/Dashboard-CO7_6OUM.js.br +0 -0
- data/vendor/assets/dashboard/assets/Dashboard-CO7_6OUM.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Dead-C8mDGQAF.js +1 -0
- data/vendor/assets/dashboard/assets/Dead-C8mDGQAF.js.br +0 -0
- data/vendor/assets/dashboard/assets/Dead-C8mDGQAF.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Extension--fRIfdcW.js +1 -0
- data/vendor/assets/dashboard/assets/Extension--fRIfdcW.js.br +0 -0
- data/vendor/assets/dashboard/assets/Extension--fRIfdcW.js.gz +0 -0
- data/vendor/assets/dashboard/assets/FilterBox-BS1_G5S5.js +2 -0
- data/vendor/assets/dashboard/assets/FilterBox-BS1_G5S5.js.br +0 -0
- data/vendor/assets/dashboard/assets/FilterBox-BS1_G5S5.js.gz +0 -0
- data/vendor/assets/dashboard/assets/FlowDetail-CxmWxNpF.js +1 -0
- data/vendor/assets/dashboard/assets/FlowDetail-CxmWxNpF.js.br +0 -0
- data/vendor/assets/dashboard/assets/FlowDetail-CxmWxNpF.js.gz +0 -0
- data/vendor/assets/dashboard/assets/{FlowState-yb7virqR.js → FlowState-ClzInw0-.js} +1 -1
- data/vendor/assets/dashboard/assets/FlowState-ClzInw0-.js.br +0 -0
- data/vendor/assets/dashboard/assets/FlowState-ClzInw0-.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Flows-CCnTVfkN.js +1 -0
- data/vendor/assets/dashboard/assets/Flows-CCnTVfkN.js.br +0 -0
- data/vendor/assets/dashboard/assets/Flows-CCnTVfkN.js.gz +0 -0
- data/vendor/assets/dashboard/assets/JobDetailModal-Btzt9HOQ.js +2 -0
- data/vendor/assets/dashboard/assets/JobDetailModal-Btzt9HOQ.js.br +0 -0
- data/vendor/assets/dashboard/assets/JobDetailModal-Btzt9HOQ.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Limiters-DYxSN0sy.js +1 -0
- data/vendor/assets/dashboard/assets/Limiters-DYxSN0sy.js.br +0 -0
- data/vendor/assets/dashboard/assets/Limiters-DYxSN0sy.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Metrics-BfSRkQ2U.js +1 -0
- data/vendor/assets/dashboard/assets/Metrics-BfSRkQ2U.js.br +0 -0
- data/vendor/assets/dashboard/assets/Metrics-BfSRkQ2U.js.gz +0 -0
- data/vendor/assets/dashboard/assets/NotFound-DrAE8U92.js +1 -0
- data/vendor/assets/dashboard/assets/NotFound-DrAE8U92.js.br +0 -0
- data/vendor/assets/dashboard/assets/NotFound-DrAE8U92.js.gz +0 -0
- data/vendor/assets/dashboard/assets/PageHeader-w3hA_hMm.js +1 -0
- data/vendor/assets/dashboard/assets/PageHeader-w3hA_hMm.js.br +0 -0
- data/vendor/assets/dashboard/assets/PageHeader-w3hA_hMm.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Profiles-191Gq7P-.js +1 -0
- data/vendor/assets/dashboard/assets/Profiles-191Gq7P-.js.br +0 -0
- data/vendor/assets/dashboard/assets/Profiles-191Gq7P-.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Queues-CIvl1fjf.js +1 -0
- data/vendor/assets/dashboard/assets/Queues-CIvl1fjf.js.br +0 -0
- data/vendor/assets/dashboard/assets/Queues-CIvl1fjf.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Retries-sdaiHACO.js +1 -0
- data/vendor/assets/dashboard/assets/Retries-sdaiHACO.js.br +0 -0
- data/vendor/assets/dashboard/assets/Retries-sdaiHACO.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Scheduled-CcildKBh.js +1 -0
- data/vendor/assets/dashboard/assets/Scheduled-CcildKBh.js.br +0 -0
- data/vendor/assets/dashboard/assets/Scheduled-CcildKBh.js.gz +0 -0
- data/vendor/assets/dashboard/assets/Search-D42Va7lB.js +1 -0
- data/vendor/assets/dashboard/assets/Search-D42Va7lB.js.br +0 -0
- data/vendor/assets/dashboard/assets/Search-D42Va7lB.js.gz +0 -0
- data/vendor/assets/dashboard/assets/ar-Br6DtdyK.js +1 -0
- data/vendor/assets/dashboard/assets/ar-Br6DtdyK.js.br +0 -0
- data/vendor/assets/dashboard/assets/ar-Br6DtdyK.js.gz +0 -0
- data/vendor/assets/dashboard/assets/charts-C1xMUYFp.js +1 -0
- data/vendor/assets/dashboard/assets/charts-C1xMUYFp.js.br +0 -0
- data/vendor/assets/dashboard/assets/charts-C1xMUYFp.js.gz +0 -0
- data/vendor/assets/dashboard/assets/de-B2NCIuzo.js +1 -0
- data/vendor/assets/dashboard/assets/de-B2NCIuzo.js.br +0 -0
- data/vendor/assets/dashboard/assets/de-B2NCIuzo.js.gz +0 -0
- data/vendor/assets/dashboard/assets/es-BGeu_JNB.js +1 -0
- data/vendor/assets/dashboard/assets/es-BGeu_JNB.js.br +0 -0
- data/vendor/assets/dashboard/assets/es-BGeu_JNB.js.gz +0 -0
- data/vendor/assets/dashboard/assets/fr-DQVBWFId.js +1 -0
- data/vendor/assets/dashboard/assets/fr-DQVBWFId.js.br +0 -0
- data/vendor/assets/dashboard/assets/fr-DQVBWFId.js.gz +0 -0
- data/vendor/assets/dashboard/assets/i18n-BXp3XejR.js +1 -0
- data/vendor/assets/dashboard/assets/i18n-BXp3XejR.js.br +0 -0
- data/vendor/assets/dashboard/assets/i18n-BXp3XejR.js.gz +0 -0
- data/vendor/assets/dashboard/assets/index-CiLU1zz8.js +141 -0
- data/vendor/assets/dashboard/assets/index-CiLU1zz8.js.br +0 -0
- data/vendor/assets/dashboard/assets/index-CiLU1zz8.js.gz +0 -0
- data/vendor/assets/dashboard/assets/index-r3T9Ugl4.css +1 -0
- data/vendor/assets/dashboard/assets/index-r3T9Ugl4.css.br +0 -0
- data/vendor/assets/dashboard/assets/index-r3T9Ugl4.css.gz +0 -0
- data/vendor/assets/dashboard/assets/ja-D06IBqzL.js +1 -0
- data/vendor/assets/dashboard/assets/ja-D06IBqzL.js.br +0 -0
- data/vendor/assets/dashboard/assets/ja-D06IBqzL.js.gz +0 -0
- data/vendor/assets/dashboard/assets/pt-BR-Dn_okdxf.js +1 -0
- data/vendor/assets/dashboard/assets/pt-BR-Dn_okdxf.js.br +0 -0
- data/vendor/assets/dashboard/assets/pt-BR-Dn_okdxf.js.gz +0 -0
- data/vendor/assets/dashboard/assets/useResetPageOnEmpty-Cuv4BHkC.js +1 -0
- data/vendor/assets/dashboard/assets/useResetPageOnEmpty-Cuv4BHkC.js.br +0 -0
- data/vendor/assets/dashboard/assets/useResetPageOnEmpty-Cuv4BHkC.js.gz +0 -0
- data/vendor/assets/dashboard/assets/useSort-V9yUrByY.js +1 -0
- data/vendor/assets/dashboard/assets/useSort-V9yUrByY.js.br +0 -0
- data/vendor/assets/dashboard/assets/useSort-V9yUrByY.js.gz +0 -0
- data/vendor/assets/dashboard/assets/{utils-CnWZzW2L.js → utils-69XSoGbQ.js} +1 -1
- data/vendor/assets/dashboard/assets/utils-69XSoGbQ.js.br +0 -0
- data/vendor/assets/dashboard/assets/utils-69XSoGbQ.js.gz +0 -0
- data/vendor/assets/dashboard/assets/wurk-logo-ydeSB9B8.png +0 -0
- data/vendor/assets/dashboard/assets/zh-CN-B1ObO-uZ.js +1 -0
- data/vendor/assets/dashboard/assets/zh-CN-B1ObO-uZ.js.br +0 -0
- data/vendor/assets/dashboard/assets/zh-CN-B1ObO-uZ.js.gz +0 -0
- data/vendor/assets/dashboard/index.html +3 -23
- data/vendor/assets/dashboard/wurk-manifest.json +2 -2
- metadata +132 -38
- data/vendor/assets/dashboard/assets/ArgsValue-BJol9S0s.js +0 -1
- data/vendor/assets/dashboard/assets/BatchDetail-D_zGQ9Sd.js +0 -1
- data/vendor/assets/dashboard/assets/Batches-Dt_xC660.js +0 -1
- data/vendor/assets/dashboard/assets/Busy-CWRthsmc.js +0 -1
- data/vendor/assets/dashboard/assets/Cron-qeGr2YAm.js +0 -1
- data/vendor/assets/dashboard/assets/Dashboard-DQWaAwPA.js +0 -1
- data/vendor/assets/dashboard/assets/Dead-D9gOPHtK.js +0 -1
- data/vendor/assets/dashboard/assets/Extension-DONXVLdA.js +0 -1
- data/vendor/assets/dashboard/assets/FilterBox-BbB6gXHp.js +0 -2
- data/vendor/assets/dashboard/assets/FlowDetail-CrmnVRp0.js +0 -1
- data/vendor/assets/dashboard/assets/Flows-g4GC8KmE.js +0 -1
- data/vendor/assets/dashboard/assets/JobDetailModal-C86k_1wj.js +0 -2
- data/vendor/assets/dashboard/assets/Limiters-zyO-iMlK.js +0 -1
- data/vendor/assets/dashboard/assets/Metrics-Ckq5fNBv.js +0 -1
- data/vendor/assets/dashboard/assets/NotFound-C8NnyjlY.js +0 -1
- data/vendor/assets/dashboard/assets/PageHeader-vWeBbSPF.js +0 -1
- data/vendor/assets/dashboard/assets/Profiles-DRl-FXPA.js +0 -1
- data/vendor/assets/dashboard/assets/Queues-DkXWrihA.js +0 -1
- data/vendor/assets/dashboard/assets/Retries-CmlojYIy.js +0 -1
- data/vendor/assets/dashboard/assets/Scheduled-Cbbpp3xw.js +0 -1
- data/vendor/assets/dashboard/assets/Search-LaEpj2fM.js +0 -1
- data/vendor/assets/dashboard/assets/charts-D_PQLoyc.js +0 -1
- data/vendor/assets/dashboard/assets/fa-brands-400-Bs6tcqqs.woff2 +0 -0
- data/vendor/assets/dashboard/assets/fa-regular-400-DRN8N0d1.woff2 +0 -0
- data/vendor/assets/dashboard/assets/fa-solid-900-IAB4Droh.woff2 +0 -0
- data/vendor/assets/dashboard/assets/fa-v4compatibility-CErXDOsT.woff2 +0 -0
- data/vendor/assets/dashboard/assets/i18n-CBewVzQ_.js +0 -1
- data/vendor/assets/dashboard/assets/index--xvvNlYx.css +0 -1
- data/vendor/assets/dashboard/assets/index-FBKGtysy.js +0 -141
- data/vendor/assets/dashboard/assets/useResetPageOnEmpty-BiwhHqgh.js +0 -1
- data/vendor/assets/dashboard/assets/useSort-jBYVwXvg.js +0 -1
- data/vendor/assets/dashboard/assets/wurk-logo-Vy3xW4K0.png +0 -0
- data/vendor/assets/dashboard/og-image.png +0 -0
- data/vendor/assets/dashboard/wurk-logo.webp +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d7d139e1779564e4d49dcc71ddc85c4ce8e25e20b3420743fc29298a484b18f0
|
|
4
|
+
data.tar.gz: df27c0bb967bbe3e2a4098c5d50c3e7b20b5bc5c475f38e01b23dab82e4aa2a4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d03b162bcdeddaf1405432950e1793343dfeccec299c9ad8acf99e80da2f6f984cb736916d29b97f68eb0de45cd587c1bbf862bd5778b840b73cba01064b34fe
|
|
7
|
+
data.tar.gz: 7717cd43bb4c01567daaef09d471b8793edb7c5e0be7460428d6be15208dbffe880acb929ad52b180dafe118a0df42dc5009965d47cbb47d4d372a94f860909f
|
data/README.md
CHANGED
|
@@ -303,9 +303,9 @@ Wurk is MIT and stays that way. If what you need is a commercial support contrac
|
|
|
303
303
|
+ gem "wurk"
|
|
304
304
|
```
|
|
305
305
|
|
|
306
|
-
`bundle install && restart`. Wurk reads and writes the same Redis schema, so there is no data migration: Wurk picks up the queues, schedules, retries, batches and periodic loops Sidekiq left behind. Running Sidekiq and Wurk workers against one Redis *at the same time* is not tested yet, so a live production move is a **drain cutover** (stop Sidekiq's workers, confirm nothing is in flight, start Wurk), with a matching rollback; the [production cutover](https://github.com/developerz-ai/wurk/blob/main/docs/migrate-from-sidekiq.md#9-production-cutover) section has every step and command. The upstream suites of sidekiq-cron, sidekiq-unique-jobs, sidekiq-failures and sentry-sidekiq run against Wurk in the [`ecosystem` CI job](https://github.com/developerz-ai/wurk/blob/main/.github/workflows/ecosystem.yml) (see [`test/ecosystem/`](https://github.com/developerz-ai/wurk/tree/main/test/ecosystem)). sidekiq-scheduler, sidekiq-status and sidekiq-throttled are target additions tracked in [docs/idea/14-ecosystem-compat.md](https://github.com/developerz-ai/wurk/blob/main/docs/idea/14-ecosystem-compat.md).
|
|
306
|
+
`bundle install && restart`. The worker command stays as it was: Wurk ships `sidekiq` and `sidekiqswarm` executables, so `bundle exec sidekiq -C config/sidekiq.yml` in a Procfile or manifest keeps working. Wurk reads and writes the same Redis schema, so there is no data migration: Wurk picks up the queues, schedules, retries, batches and periodic loops Sidekiq left behind. Running Sidekiq and Wurk workers against one Redis *at the same time* is not tested yet, so a live production move is a **drain cutover** (stop Sidekiq's workers, confirm nothing is in flight, start Wurk), with a matching rollback; the [production cutover](https://github.com/developerz-ai/wurk/blob/main/docs/migrate-from-sidekiq.md#9-production-cutover) section has every step and command. The upstream suites of sidekiq-cron, sidekiq-unique-jobs, sidekiq-failures and sentry-sidekiq run against Wurk in the [`ecosystem` CI job](https://github.com/developerz-ai/wurk/blob/main/.github/workflows/ecosystem.yml) (see [`test/ecosystem/`](https://github.com/developerz-ai/wurk/tree/main/test/ecosystem)). sidekiq-scheduler, sidekiq-status and sidekiq-throttled are target additions tracked in [docs/idea/14-ecosystem-compat.md](https://github.com/developerz-ai/wurk/blob/main/docs/idea/14-ecosystem-compat.md).
|
|
307
307
|
|
|
308
|
-
**Keeping a `sidekiq-*` add-on gem?** Those gems declare `add_dependency "sidekiq"`, which would reinstall real Sidekiq next to Wurk. Satisfy it with Wurk's git-only [`sidekiq` shim gem](https://github.com/developerz-ai/wurk/tree/main/ecosystem/sidekiq-shim) instead: `gem "sidekiq", github: "developerz-ai/wurk", glob: "ecosystem/sidekiq-shim/*.gemspec"`. Only sidekiq-cron, sidekiq-unique-jobs, sidekiq-failures and sentry-sidekiq are exercised that way, by the `ecosystem` workflow; treat the others as untested.
|
|
308
|
+
**Keeping a `sidekiq-*` add-on gem?** Those gems declare `add_dependency "sidekiq"`, which would reinstall real Sidekiq next to Wurk. Satisfy it with Wurk's git-only [`sidekiq` shim gem](https://github.com/developerz-ai/wurk/tree/main/ecosystem/sidekiq-shim) instead, pinned to the tag of the Wurk release you run: `gem "sidekiq", github: "developerz-ai/wurk", tag: "v1.14.0", glob: "ecosystem/sidekiq-shim/*.gemspec"`. Only sidekiq-cron, sidekiq-unique-jobs, sidekiq-failures and sentry-sidekiq are exercised that way, by the `ecosystem` workflow; treat the others as untested.
|
|
309
309
|
|
|
310
310
|
Full walkthrough — config side-by-side, the Redis key/`sidekiq_options` mapping, known incompatibilities, moving sidekiq-cron schedules over (`rake wurk:import:cron`), and the production cutover and rollback playbook: **[docs/migrate-from-sidekiq.md](https://github.com/developerz-ai/wurk/blob/main/docs/migrate-from-sidekiq.md)**. On the night, keep the **[incident runbook](https://github.com/developerz-ai/wurk/blob/main/docs/runbook.md)** open.
|
|
311
311
|
|
|
@@ -8,6 +8,40 @@ module Wurk
|
|
|
8
8
|
module SseStreaming
|
|
9
9
|
extend ActiveSupport::Concern
|
|
10
10
|
|
|
11
|
+
# One stats payload per process per TTL, shared by every open stream: ten
|
|
12
|
+
# dashboard tabs ticking every 2s cost one Redis read, not ten. Streams
|
|
13
|
+
# that tick together wait on the lock and take the payload the first one
|
|
14
|
+
# read. Keyed on the pool so a payload read from one Redis never answers
|
|
15
|
+
# for another; a raising read caches nothing.
|
|
16
|
+
class SharedTick
|
|
17
|
+
def initialize(ttl)
|
|
18
|
+
@ttl = ttl
|
|
19
|
+
@lock = ::Mutex.new
|
|
20
|
+
clear!
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
def fetch
|
|
24
|
+
pool = ::Wurk.redis_pool
|
|
25
|
+
@lock.synchronize do
|
|
26
|
+
now = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
|
|
27
|
+
return @payload if @payload && @pool.equal?(pool) && now - @read_at < @ttl
|
|
28
|
+
|
|
29
|
+
payload = yield.freeze
|
|
30
|
+
@payload = payload
|
|
31
|
+
@pool = pool
|
|
32
|
+
@read_at = now
|
|
33
|
+
payload
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def clear!
|
|
38
|
+
@lock.synchronize { @payload = @pool = @read_at = nil }
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# Under the 2s tick, so one stream never reads its own previous payload.
|
|
43
|
+
SHARED_TICK = SharedTick.new(1.0)
|
|
44
|
+
|
|
11
45
|
private
|
|
12
46
|
|
|
13
47
|
def stream_headers!
|
|
@@ -43,7 +77,8 @@ module Wurk
|
|
|
43
77
|
end
|
|
44
78
|
|
|
45
79
|
def stream_tick_payload
|
|
46
|
-
::Wurk::Api::Serializers.stats_payload(::Wurk::Stats.new)
|
|
80
|
+
SHARED_TICK.fetch { ::Wurk::Api::Serializers.stats_payload(::Wurk::Stats::Snapshot.new) }
|
|
81
|
+
.merge(at: ::Time.now.to_f)
|
|
47
82
|
end
|
|
48
83
|
end
|
|
49
84
|
end
|
|
@@ -13,10 +13,10 @@ module Wurk
|
|
|
13
13
|
module Pagination
|
|
14
14
|
DEFAULT_PAGE_SIZE = 25
|
|
15
15
|
MAX_PAGE_SIZE = 200
|
|
16
|
-
#
|
|
17
|
-
#
|
|
18
|
-
#
|
|
19
|
-
# depth while bounding
|
|
16
|
+
# An unfiltered listing reads its page at the offset (the set's
|
|
17
|
+
# #snapshot), whatever the depth; the walks that remain (#slice on a set
|
|
18
|
+
# without one, the Limits names) still pay per skipped row, and 1000
|
|
19
|
+
# pages is far beyond any real UI depth while bounding them.
|
|
20
20
|
MAX_PAGE = 1_000
|
|
21
21
|
# A substr that matches nothing would otherwise stream the whole backing
|
|
22
22
|
# set through Ruby (same DoS shape Web::Search bounds with SCAN_BUDGET).
|
|
@@ -46,6 +46,9 @@ module Wurk
|
|
|
46
46
|
fields.merge(filtered_total: page[:matched], filtered_total_exact: page[:exhausted])
|
|
47
47
|
end
|
|
48
48
|
|
|
49
|
+
# Rows before the requested page: where an unfiltered listing reads from.
|
|
50
|
+
def offset(page) = page[:page] * page[:count]
|
|
51
|
+
|
|
49
52
|
def clamp_int(value, min, max, default)
|
|
50
53
|
Integer(value, 10).clamp(min, max)
|
|
51
54
|
rescue ::ArgumentError, ::TypeError
|
|
@@ -68,11 +71,10 @@ module Wurk
|
|
|
68
71
|
# filter we keep the fast path that skips serialization before the
|
|
69
72
|
# offset.
|
|
70
73
|
def slice(enumerable, page, &)
|
|
71
|
-
offset = page[:page] * page[:count]
|
|
72
74
|
if page[:substr].empty?
|
|
73
|
-
slice_raw(enumerable, offset, page[:count], &)
|
|
75
|
+
slice_raw(enumerable, offset(page), page[:count], &)
|
|
74
76
|
else
|
|
75
|
-
slice_filtered(enumerable, offset, page, &)
|
|
77
|
+
slice_filtered(enumerable, offset(page), page, &)
|
|
76
78
|
end
|
|
77
79
|
end
|
|
78
80
|
|
|
@@ -52,17 +52,23 @@ module Wurk
|
|
|
52
52
|
rows.empty? ? base : base.merge(custom_rows: rows)
|
|
53
53
|
end
|
|
54
54
|
|
|
55
|
+
# A listing row. No `error_backtrace`: it is stored compressed, and
|
|
56
|
+
# inflating it for every row of a page served a field only the detail
|
|
57
|
+
# view (#sorted_entry_detail) shows.
|
|
55
58
|
def sorted_entry(entry)
|
|
56
59
|
job_record(entry).merge(
|
|
57
60
|
score: entry.score,
|
|
58
61
|
at: entry.at.to_f,
|
|
59
62
|
error_class: entry['error_class'].to_s,
|
|
60
63
|
error_message: entry['error_message'].to_s,
|
|
61
|
-
retry_count: entry['retry_count']
|
|
62
|
-
error_backtrace: entry.error_backtrace
|
|
64
|
+
retry_count: entry['retry_count']
|
|
63
65
|
)
|
|
64
66
|
end
|
|
65
67
|
|
|
68
|
+
def sorted_entry_detail(entry)
|
|
69
|
+
sorted_entry(entry).merge(error_backtrace: entry.error_backtrace)
|
|
70
|
+
end
|
|
71
|
+
|
|
66
72
|
# `leader_identity` is the cluster's `dear-leader` value (ProcessSet#leader,
|
|
67
73
|
# memoized to one Redis GET per request) — comparing here avoids the N+1
|
|
68
74
|
# `Process#leader?` GET-per-row that a per-process lookup would cost.
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
require_relative 'api/serializers'
|
|
4
4
|
require_relative 'api/pagination'
|
|
5
|
-
require 'wurk/web'
|
|
6
5
|
|
|
7
6
|
module Wurk
|
|
8
7
|
# JSON APIs consumed by the SolidJS SPA. Action methods stay thin; mapping to
|
|
@@ -58,22 +57,22 @@ module Wurk
|
|
|
58
57
|
end
|
|
59
58
|
|
|
60
59
|
def stats
|
|
61
|
-
render json: ::Wurk::Api::Serializers.stats_payload(::Wurk::Stats.new)
|
|
60
|
+
render json: ::Wurk::Api::Serializers.stats_payload(::Wurk::Stats::Snapshot.new)
|
|
62
61
|
end
|
|
63
62
|
|
|
64
63
|
def queues
|
|
65
|
-
|
|
66
|
-
render json:
|
|
67
|
-
::Wurk::Api::Serializers.queue_summary(q).merge(consumers: consumers.fetch(q.name, 0))
|
|
64
|
+
snapshot = ::Wurk::Stats::Snapshot.new(consumers: true)
|
|
65
|
+
render json: snapshot.queue_summaries.map { |q|
|
|
66
|
+
::Wurk::Api::Serializers.queue_summary(q).merge(consumers: snapshot.consumers.fetch(q.name, 0))
|
|
68
67
|
}
|
|
69
68
|
end
|
|
70
69
|
|
|
71
70
|
def queue
|
|
72
71
|
q = ::Wurk::Queue.new(params[:name].to_s)
|
|
73
72
|
page = ::Wurk::Api::Pagination.window(params)
|
|
74
|
-
jobs =
|
|
73
|
+
gauges, jobs = queue_page(q, page)
|
|
75
74
|
render json: {
|
|
76
|
-
name: q.name, size:
|
|
75
|
+
name: q.name, size: gauges.size, latency: gauges.latency, paused: gauges.paused?,
|
|
77
76
|
**::Wurk::Api::Pagination.meta(page), jobs: jobs
|
|
78
77
|
}
|
|
79
78
|
end
|
|
@@ -109,6 +108,13 @@ module Wurk
|
|
|
109
108
|
def scheduled = render_sorted_set(::Wurk::ScheduledSet.new)
|
|
110
109
|
def dead = render_sorted_set(::Wurk::DeadSet.new)
|
|
111
110
|
|
|
111
|
+
# One entry with its backtrace, which listing rows leave out: inflating
|
|
112
|
+
# it costs a base64 decode, an inflate and a JSON parse per row, for a
|
|
113
|
+
# field only the detail view shows. `:key` is "<score>|<jid>".
|
|
114
|
+
def retry_entry = render_sorted_entry(::Wurk::RetrySet.new)
|
|
115
|
+
def scheduled_entry = render_sorted_entry(::Wurk::ScheduledSet.new)
|
|
116
|
+
def dead_entry = render_sorted_entry(::Wurk::DeadSet.new)
|
|
117
|
+
|
|
112
118
|
# --- Retry set mutations -------------------------------------------------
|
|
113
119
|
def retry_job = single_entry_action(::Wurk::RetrySet.new, RETRY_ACTIONS, params[:cmd])
|
|
114
120
|
def retries_bulk = bulk_entry_action(::Wurk::RetrySet.new, RETRY_ACTIONS)
|
|
@@ -153,8 +159,9 @@ module Wurk
|
|
|
153
159
|
|
|
154
160
|
def processes
|
|
155
161
|
set = ::Wurk::ProcessSet.new
|
|
162
|
+
live = set.to_a # before #leader: the walk reads `dear-leader` in its pipeline
|
|
156
163
|
leader_identity = set.leader
|
|
157
|
-
render json:
|
|
164
|
+
render json: live.map { |p| ::Wurk::Api::Serializers.process_row(p, leader_identity: leader_identity) }
|
|
158
165
|
end
|
|
159
166
|
|
|
160
167
|
# Currently-executing jobs across the cluster (WorkSet), oldest first.
|
|
@@ -170,11 +177,14 @@ module Wurk
|
|
|
170
177
|
def quiet_process = signal_processes(:quiet!)
|
|
171
178
|
def stop_process = signal_processes(:stop!)
|
|
172
179
|
|
|
180
|
+
# Rows are Batch::Status#summary: #data with the failed and dead jid sets
|
|
181
|
+
# counted rather than listed. GET /api/batches/:bid carries the jids.
|
|
173
182
|
def batches
|
|
174
|
-
set = ::Wurk::BatchSet.new
|
|
175
183
|
page = ::Wurk::Api::Pagination.window(params)
|
|
176
|
-
rows = ::Wurk::
|
|
177
|
-
|
|
184
|
+
total, rows = page_rows(::Wurk::BatchSet.new, page, :summary.to_proc) do |summary|
|
|
185
|
+
summary.transform_keys(&:to_sym)
|
|
186
|
+
end
|
|
187
|
+
render json: { total: total, **::Wurk::Api::Pagination.meta(page), batches: rows }
|
|
178
188
|
end
|
|
179
189
|
|
|
180
190
|
def batch
|
|
@@ -187,10 +197,9 @@ module Wurk
|
|
|
187
197
|
end
|
|
188
198
|
|
|
189
199
|
def flows
|
|
190
|
-
set = ::Wurk::FlowSet.new
|
|
191
200
|
page = ::Wurk::Api::Pagination.window(params)
|
|
192
|
-
rows = ::Wurk::
|
|
193
|
-
render json: { total:
|
|
201
|
+
total, rows = page_rows(::Wurk::FlowSet.new, page) { |status| ::Wurk::Api::Serializers.flow_row(status) }
|
|
202
|
+
render json: { total: total, **::Wurk::Api::Pagination.meta(page), flows: rows }
|
|
194
203
|
end
|
|
195
204
|
|
|
196
205
|
def flow
|
|
@@ -212,9 +221,12 @@ module Wurk
|
|
|
212
221
|
end
|
|
213
222
|
|
|
214
223
|
def limiters
|
|
215
|
-
names = ::Wurk::Web::Enterprise::Limits.list(filter: params[:substr])
|
|
216
224
|
page = ::Wurk::Api::Pagination.window(params)
|
|
217
|
-
|
|
225
|
+
total, rows = ::Wurk::Web::Enterprise::Limits.page(
|
|
226
|
+
filter: params[:substr], offset: ::Wurk::Api::Pagination.offset(page), count: page[:count]
|
|
227
|
+
)
|
|
228
|
+
render json: { total: total, **::Wurk::Api::Pagination.meta(page),
|
|
229
|
+
limiters: rows.map { |name, meta| ::Wurk::Api::Serializers.limiter_row(name, meta) } }
|
|
218
230
|
end
|
|
219
231
|
|
|
220
232
|
def reset_limiter
|
|
@@ -489,18 +501,39 @@ module Wurk
|
|
|
489
501
|
|
|
490
502
|
def render_sorted_set(set)
|
|
491
503
|
page = ::Wurk::Api::Pagination.window(params)
|
|
492
|
-
total = set.
|
|
493
|
-
entries = ::Wurk::Api::Pagination.slice(set, page) { |entry| ::Wurk::Api::Serializers.sorted_entry(entry) }
|
|
504
|
+
total, entries = page_rows(set, page) { |entry| ::Wurk::Api::Serializers.sorted_entry(entry) }
|
|
494
505
|
render json: { total: total, **::Wurk::Api::Pagination.meta(page), entries: entries }
|
|
495
506
|
end
|
|
496
507
|
|
|
497
|
-
#
|
|
498
|
-
#
|
|
499
|
-
#
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
508
|
+
# [total, rows] of one listing page. Unfiltered, the page is read straight
|
|
509
|
+
# off Redis at its offset (the set's #snapshot), so page 999 costs what
|
|
510
|
+
# page 0 does; a filter counts matching rows, so it still walks, bounded by
|
|
511
|
+
# FILTER_SCAN_LIMIT. `walk` maps a walked member to what #snapshot yields
|
|
512
|
+
# (a Batch::Status to its summary); the block serializes either.
|
|
513
|
+
def page_rows(set, page, walk = nil, &serialize)
|
|
514
|
+
if page[:substr].empty?
|
|
515
|
+
total, members = set.snapshot(::Wurk::Api::Pagination.offset(page), page[:count])
|
|
516
|
+
return [total, members.map(&serialize)]
|
|
503
517
|
end
|
|
518
|
+
|
|
519
|
+
rows = ::Wurk::Api::Pagination.slice(set, page) { |member| serialize.call(walk ? walk.call(member) : member) }
|
|
520
|
+
[set.size, rows]
|
|
521
|
+
end
|
|
522
|
+
|
|
523
|
+
# The gauges (anything answering size/latency/paused?) and the page's rows.
|
|
524
|
+
def queue_page(queue, page)
|
|
525
|
+
serialize = ->(rec) { ::Wurk::Api::Serializers.job_record(rec) }
|
|
526
|
+
return [queue, ::Wurk::Api::Pagination.slice(queue, page, &serialize)] unless page[:substr].empty?
|
|
527
|
+
|
|
528
|
+
snapshot = queue.snapshot(::Wurk::Api::Pagination.offset(page), page[:count])
|
|
529
|
+
[snapshot, snapshot.records.map(&serialize)]
|
|
530
|
+
end
|
|
531
|
+
|
|
532
|
+
def render_sorted_entry(set)
|
|
533
|
+
entry = entries_for(set, [params[:key]]).first
|
|
534
|
+
return render(json: { error: 'unknown job' }, status: :not_found) unless entry
|
|
535
|
+
|
|
536
|
+
render json: ::Wurk::Api::Serializers.sorted_entry_detail(entry)
|
|
504
537
|
end
|
|
505
538
|
|
|
506
539
|
def render_cron_action(success)
|
data/config/routes.rb
CHANGED
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
Wurk::Engine.routes.draw do
|
|
4
|
+
# Sidekiq Web's machine-readable routes (free §25.4), upstream's shapes, for
|
|
5
|
+
# uptime checks and scripts. `HEAD /` is declared before `root`, which would
|
|
6
|
+
# otherwise answer it with the SPA shell and never touch Redis.
|
|
7
|
+
match '/', to: Wurk::Web::StatsRoutes, via: :head
|
|
8
|
+
get 'stats', to: Wurk::Web::StatsRoutes, format: false
|
|
9
|
+
get 'stats/queues', to: Wurk::Web::StatsRoutes, format: false
|
|
10
|
+
get 'dashboard/stats', to: Wurk::Web::StatsRoutes, format: false
|
|
11
|
+
|
|
4
12
|
root to: 'dashboard#index'
|
|
5
13
|
|
|
6
14
|
# JSON APIs consumed by the SPA. Nested under whatever mount the host chose.
|
|
@@ -35,19 +43,23 @@ Wurk::Engine.routes.draw do
|
|
|
35
43
|
# Listings answer `{ total, page, count, max_page, entries }`; `page` is
|
|
36
44
|
# the page actually served (clamped to `max_page`), and a `?substr=`
|
|
37
45
|
# listing adds `filtered_total` + `filtered_total_exact` (false: lower
|
|
38
|
-
# bound).
|
|
46
|
+
# bound). Listing rows leave out `error_backtrace`; `GET <set>/:key`
|
|
47
|
+
# answers one entry with it, or 404 `{ error: 'unknown job' }`.
|
|
39
48
|
get 'retries', to: 'api#retries'
|
|
40
49
|
post 'retries', to: 'api#retries_bulk', as: :api_retries_bulk
|
|
41
50
|
post 'retries/all/:cmd', to: 'api#retries_all', as: :api_retries_all
|
|
42
51
|
post 'retries/:key', to: 'api#retry_job', as: :api_retry_job, constraints: { key: %r{[^/]+} }
|
|
52
|
+
get 'retries/:key', to: 'api#retry_entry', as: :api_retry_entry, constraints: { key: %r{[^/]+} }
|
|
43
53
|
get 'scheduled', to: 'api#scheduled'
|
|
44
54
|
post 'scheduled', to: 'api#scheduled_bulk', as: :api_scheduled_bulk
|
|
45
55
|
post 'scheduled/all/:cmd', to: 'api#scheduled_all', as: :api_scheduled_all
|
|
46
56
|
post 'scheduled/:key', to: 'api#scheduled_job', as: :api_scheduled_job, constraints: { key: %r{[^/]+} }
|
|
57
|
+
get 'scheduled/:key', to: 'api#scheduled_entry', as: :api_scheduled_entry, constraints: { key: %r{[^/]+} }
|
|
47
58
|
get 'dead', to: 'api#dead'
|
|
48
59
|
post 'dead', to: 'api#dead_bulk', as: :api_dead_bulk
|
|
49
60
|
post 'dead/all/:cmd', to: 'api#dead_all', as: :api_dead_all
|
|
50
61
|
post 'dead/:key', to: 'api#dead_job', as: :api_dead_job, constraints: { key: %r{[^/]+} }
|
|
62
|
+
get 'dead/:key', to: 'api#dead_entry', as: :api_dead_entry, constraints: { key: %r{[^/]+} }
|
|
51
63
|
get 'processes', to: 'api#processes'
|
|
52
64
|
get 'workers', to: 'api#workers'
|
|
53
65
|
# Wurk uses split POST /api/busy/quiet and /api/busy/stop requests, not free
|
data/exe/sidekiq
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
# Drop-in alias for `wurk`. Sidekiq apps start workers with `bundle exec sidekiq
|
|
5
|
+
# -C config/sidekiq.yml` in a Procfile, systemd unit or k8s manifest; this keeps
|
|
6
|
+
# that exact command working after a one-line gem swap. Spec:
|
|
7
|
+
# docs/target/sidekiq-free.md §21.
|
|
8
|
+
load File.expand_path('wurk', __dir__)
|
data/exe/wurk
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
# Usage: `exe/wurk -C config/wurk.yml` — worker: one process, thread pool
|
|
6
6
|
# `exe/wurk api --port 7433` — machine HTTP API, runs no jobs
|
|
7
7
|
# `exe/wurk preflight` / `verify` — read-only cutover checks, run no jobs
|
|
8
|
-
# `exe/wurk boot-check -r .` — boot the app as wurkswarm would, then exit (CI)
|
|
8
|
+
# `exe/wurk boot-check -r .` — boot the app as wurkswarm (or `--runner wurk`) would, then exit (CI)
|
|
9
9
|
|
|
10
10
|
$stdout.sync = true
|
|
11
11
|
$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
|
|
@@ -1,15 +1,23 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require 'rails/generators'
|
|
4
|
+
require 'bundler'
|
|
5
|
+
require 'wurk/version'
|
|
4
6
|
|
|
5
7
|
module Wurk
|
|
6
8
|
module Generators
|
|
7
9
|
# `bin/rails g wurk:install`
|
|
8
10
|
# Writes a config initializer and adds a commented-out mount line to routes.
|
|
9
11
|
# The host app picks the mount path; the generator suggests /wurk.
|
|
12
|
+
# Reads Gemfile.lock and Procfile to print what a Sidekiq app must change;
|
|
13
|
+
# it edits neither.
|
|
10
14
|
class InstallGenerator < ::Rails::Generators::Base
|
|
11
15
|
source_root File.expand_path('templates', __dir__)
|
|
12
16
|
|
|
17
|
+
# Sidekiq's own tiers depend on `sidekiq` too, but the swap removes them.
|
|
18
|
+
SIDEKIQ_TIERS = %w[sidekiq sidekiq-pro sidekiq-ent].freeze
|
|
19
|
+
SIDEKIQ_COMMAND = /\bsidekiq(?:swarm)?\b/
|
|
20
|
+
|
|
13
21
|
def copy_initializer
|
|
14
22
|
template 'wurk.rb', 'config/initializers/wurk.rb'
|
|
15
23
|
end
|
|
@@ -18,6 +26,27 @@ module Wurk
|
|
|
18
26
|
route(%(# mount Wurk::Engine => "/wurk" # uncomment to expose the Wurk dashboard))
|
|
19
27
|
end
|
|
20
28
|
|
|
29
|
+
def show_shim_line
|
|
30
|
+
dependents = sidekiq_dependents
|
|
31
|
+
return if dependents.empty?
|
|
32
|
+
|
|
33
|
+
say <<~SHIM
|
|
34
|
+
|
|
35
|
+
#{dependents.join(', ')} #{dependents.size == 1 ? 'depends' : 'depend'} on the sidekiq gem, which would load real Sidekiq next to Wurk.
|
|
36
|
+
Keep #{dependents.size == 1 ? 'it' : 'them'} by adding the shim to the Gemfile, in place of gem "sidekiq":
|
|
37
|
+
gem "sidekiq", github: "developerz-ai/wurk", tag: "v#{Wurk::VERSION}", glob: "ecosystem/sidekiq-shim/*.gemspec"
|
|
38
|
+
SHIM
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def show_procfile_runner
|
|
42
|
+
lines = procfile_sidekiq_lines
|
|
43
|
+
return if lines.empty?
|
|
44
|
+
|
|
45
|
+
say "\nProcfile worker lines keep working: wurk ships the sidekiq and sidekiqswarm commands."
|
|
46
|
+
lines.each { |line| say " #{line}" }
|
|
47
|
+
say 'For one process per core, run `bundle exec wurkswarm` with the same flags.'
|
|
48
|
+
end
|
|
49
|
+
|
|
21
50
|
def show_next_steps
|
|
22
51
|
say <<~STEPS
|
|
23
52
|
|
|
@@ -29,6 +58,33 @@ module Wurk
|
|
|
29
58
|
docs/authentication.md in the wurk gem's repository
|
|
30
59
|
STEPS
|
|
31
60
|
end
|
|
61
|
+
|
|
62
|
+
private
|
|
63
|
+
|
|
64
|
+
def sidekiq_dependents
|
|
65
|
+
specs = locked_specs
|
|
66
|
+
# The shim is the `sidekiq` spec that depends on wurk: already in place.
|
|
67
|
+
return [] if specs.any? { |spec| spec.name == 'sidekiq' && depends_on?(spec, 'wurk') }
|
|
68
|
+
|
|
69
|
+
specs.select { |spec| depends_on?(spec, 'sidekiq') }.map(&:name).uniq
|
|
70
|
+
.reject { |name| SIDEKIQ_TIERS.include?(name) }.sort
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
def locked_specs
|
|
74
|
+
lockfile = File.join(destination_root, 'Gemfile.lock')
|
|
75
|
+
File.file?(lockfile) ? ::Bundler::LockfileParser.new(File.read(lockfile)).specs : []
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
def depends_on?(spec, name)
|
|
79
|
+
spec.dependencies.any? { |dep| dep.name == name }
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
def procfile_sidekiq_lines
|
|
83
|
+
procfile = File.join(destination_root, 'Procfile')
|
|
84
|
+
return [] unless File.file?(procfile)
|
|
85
|
+
|
|
86
|
+
File.readlines(procfile, chomp: true).grep(SIDEKIQ_COMMAND)
|
|
87
|
+
end
|
|
32
88
|
end
|
|
33
89
|
end
|
|
34
90
|
end
|
data/lib/sidekiq/cli.rb
CHANGED
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
# Drop-in require path (see lib/sidekiq.rb). In Sidekiq, `Sidekiq.server?`
|
|
4
4
|
# is literally "has sidekiq/cli been required" — apps and ecosystem test
|
|
5
|
-
# helpers require this file to make `configure_server` blocks run
|
|
6
|
-
#
|
|
7
|
-
#
|
|
5
|
+
# helpers require this file to make `configure_server` blocks run, so the
|
|
6
|
+
# passthrough carries that *semantic* as well as the CLI class: requiring it
|
|
7
|
+
# declares this process a server.
|
|
8
8
|
require 'wurk'
|
|
9
|
+
Sidekiq.const_get(:CLI)
|
|
9
10
|
Wurk.enter_server_mode
|
data/lib/sidekiq/deploy.rb
CHANGED
data/lib/sidekiq/embedded.rb
CHANGED
data/lib/sidekiq/iterable_job.rb
CHANGED
data/lib/sidekiq/job/iterable.rb
CHANGED
data/lib/sidekiq/launcher.rb
CHANGED
data/lib/sidekiq/manager.rb
CHANGED
data/lib/sidekiq/pro/web.rb
CHANGED
data/lib/sidekiq/scheduled.rb
CHANGED
data/lib/sidekiq/web.rb
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Drop-in require path (see lib/sidekiq.rb)
|
|
3
|
+
# Drop-in require path (see lib/sidekiq.rb): loads the lazy surface it names.
|
|
4
4
|
require 'wurk'
|
|
5
|
+
Sidekiq.const_get(:Web)
|
|
5
6
|
|
|
6
7
|
# Extension renderer dependencies, deferred on the worker path (web/extension.rb).
|
|
7
8
|
# Loaded here for a helper called outside a request, as unique-jobs' specs do.
|
data/lib/sidekiq.rb
CHANGED
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
# Sidekiq::* alias layer (lib/wurk/compat.rb), so code and third-party gems
|
|
5
5
|
# written against Sidekiq load Wurk without changing a single require. The
|
|
6
6
|
# sibling files under lib/sidekiq/ cover the documented `require "sidekiq/…"`
|
|
7
|
-
# sub-paths the ecosystem uses
|
|
8
|
-
#
|
|
7
|
+
# sub-paths the ecosystem uses. "wurk" loads the client tier and autoloads the
|
|
8
|
+
# rest (Wurk::LazyLoader); a sub-path whose surface is lazy loads it, so
|
|
9
|
+
# `require "sidekiq/web"` defines Sidekiq::Web as it does upstream.
|
|
9
10
|
#
|
|
10
11
|
# Bundler-level substitution (a gem's `add_dependency "sidekiq"`) is handled
|
|
11
12
|
# by the companion shim gem in ecosystem/sidekiq-shim/.
|
data/lib/wurk/api/fast.rb
CHANGED
|
@@ -4,8 +4,8 @@ require_relative '../lua'
|
|
|
4
4
|
|
|
5
5
|
module Wurk
|
|
6
6
|
module API
|
|
7
|
-
# Pro parity (§11): Lua-backed
|
|
8
|
-
#
|
|
7
|
+
# Pro parity (§11): Lua-backed replacements for the ruby-side LRANGE loops
|
|
8
|
+
# in Queue, one round trip per Lua::FastDelete::WINDOW entries. Mixed into the existing data API class
|
|
9
9
|
# so the surface is `Sidekiq::Queue#delete_job(jid)` — wire-compat with Pro
|
|
10
10
|
# consumer code that drops in on a one-line require swap.
|
|
11
11
|
#
|
|
@@ -20,14 +20,7 @@ module Wurk
|
|
|
20
20
|
def delete_job(jid)
|
|
21
21
|
raise ArgumentError, 'jid required' if jid.nil? || jid.to_s.empty?
|
|
22
22
|
|
|
23
|
-
Wurk.redis
|
|
24
|
-
Wurk::Lua::Loader.eval_cached(
|
|
25
|
-
conn,
|
|
26
|
-
:fast_delete_job,
|
|
27
|
-
keys: [Keys.queue(name)],
|
|
28
|
-
argv: [jid.to_s]
|
|
29
|
-
)
|
|
30
|
-
end
|
|
23
|
+
Wurk.redis { |conn| Wurk::Lua::FastDelete.delete_job(conn, Keys.queue(name), jid.to_s) }
|
|
31
24
|
end
|
|
32
25
|
|
|
33
26
|
# @param klass [Class, String, Symbol]
|
|
@@ -36,14 +29,7 @@ module Wurk
|
|
|
36
29
|
klass_name = klass.is_a?(Class) ? klass.name : klass.to_s
|
|
37
30
|
raise ArgumentError, 'class name required' if klass_name.empty?
|
|
38
31
|
|
|
39
|
-
Wurk.redis
|
|
40
|
-
Wurk::Lua::Loader.eval_cached(
|
|
41
|
-
conn,
|
|
42
|
-
:fast_delete_by_class,
|
|
43
|
-
keys: [Keys.queue(name)],
|
|
44
|
-
argv: [klass_name]
|
|
45
|
-
)
|
|
46
|
-
end.to_i
|
|
32
|
+
Wurk.redis { |conn| Wurk::Lua::FastDelete.delete_by_class(conn, Keys.queue(name), klass_name) }
|
|
47
33
|
end
|
|
48
34
|
end
|
|
49
35
|
end
|