sidekiq 4.2.10 → 5.2.10

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of sidekiq might be problematic. Click here for more details.

Files changed (75) hide show
  1. checksums.yaml +5 -5
  2. data/.circleci/config.yml +61 -0
  3. data/.github/issue_template.md +3 -1
  4. data/.gitignore +3 -0
  5. data/.travis.yml +6 -13
  6. data/5.0-Upgrade.md +56 -0
  7. data/COMM-LICENSE +12 -10
  8. data/Changes.md +177 -1
  9. data/Ent-Changes.md +67 -2
  10. data/Gemfile +12 -22
  11. data/LICENSE +1 -1
  12. data/Pro-4.0-Upgrade.md +35 -0
  13. data/Pro-Changes.md +133 -2
  14. data/README.md +8 -6
  15. data/Rakefile +2 -5
  16. data/bin/sidekiqctl +13 -92
  17. data/bin/sidekiqload +5 -10
  18. data/lib/generators/sidekiq/templates/worker_spec.rb.erb +1 -1
  19. data/lib/sidekiq/api.rb +148 -58
  20. data/lib/sidekiq/cli.rb +120 -81
  21. data/lib/sidekiq/client.rb +25 -18
  22. data/lib/sidekiq/core_ext.rb +1 -119
  23. data/lib/sidekiq/ctl.rb +221 -0
  24. data/lib/sidekiq/delay.rb +42 -0
  25. data/lib/sidekiq/exception_handler.rb +2 -4
  26. data/lib/sidekiq/extensions/generic_proxy.rb +7 -1
  27. data/lib/sidekiq/fetch.rb +1 -1
  28. data/lib/sidekiq/job_logger.rb +25 -0
  29. data/lib/sidekiq/job_retry.rb +262 -0
  30. data/lib/sidekiq/launcher.rb +20 -20
  31. data/lib/sidekiq/logging.rb +18 -2
  32. data/lib/sidekiq/manager.rb +5 -6
  33. data/lib/sidekiq/middleware/server/active_record.rb +10 -0
  34. data/lib/sidekiq/processor.rb +126 -48
  35. data/lib/sidekiq/rails.rb +8 -73
  36. data/lib/sidekiq/redis_connection.rb +43 -5
  37. data/lib/sidekiq/scheduled.rb +35 -8
  38. data/lib/sidekiq/testing.rb +16 -7
  39. data/lib/sidekiq/util.rb +5 -2
  40. data/lib/sidekiq/version.rb +1 -1
  41. data/lib/sidekiq/web/action.rb +3 -7
  42. data/lib/sidekiq/web/application.rb +37 -17
  43. data/lib/sidekiq/web/helpers.rb +69 -22
  44. data/lib/sidekiq/web/router.rb +10 -10
  45. data/lib/sidekiq/web.rb +4 -4
  46. data/lib/sidekiq/worker.rb +118 -19
  47. data/lib/sidekiq.rb +27 -27
  48. data/sidekiq.gemspec +6 -17
  49. data/web/assets/javascripts/application.js +0 -0
  50. data/web/assets/javascripts/dashboard.js +32 -17
  51. data/web/assets/stylesheets/application-rtl.css +246 -0
  52. data/web/assets/stylesheets/application.css +371 -6
  53. data/web/assets/stylesheets/bootstrap-rtl.min.css +9 -0
  54. data/web/assets/stylesheets/bootstrap.css +2 -2
  55. data/web/locales/ar.yml +81 -0
  56. data/web/locales/en.yml +2 -0
  57. data/web/locales/es.yml +4 -3
  58. data/web/locales/fa.yml +1 -0
  59. data/web/locales/he.yml +79 -0
  60. data/web/locales/ja.yml +5 -3
  61. data/web/locales/ur.yml +80 -0
  62. data/web/views/_footer.erb +5 -2
  63. data/web/views/_nav.erb +4 -18
  64. data/web/views/_paging.erb +1 -1
  65. data/web/views/busy.erb +9 -5
  66. data/web/views/dashboard.erb +1 -1
  67. data/web/views/layout.erb +11 -2
  68. data/web/views/morgue.erb +4 -4
  69. data/web/views/queue.erb +8 -7
  70. data/web/views/queues.erb +2 -0
  71. data/web/views/retries.erb +9 -5
  72. data/web/views/scheduled.erb +2 -2
  73. metadata +30 -159
  74. data/lib/sidekiq/middleware/server/logging.rb +0 -31
  75. data/lib/sidekiq/middleware/server/retry_jobs.rb +0 -205
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 595500a3810c25e8e04e86c644f966ff01cb035f
4
- data.tar.gz: 3f92a9f61e61848bc2c0639469ce3588f3848fc0
2
+ SHA256:
3
+ metadata.gz: 22b205223a123bbe3a8812f1e2804be148afb5fe91c201ecb9a073eb4a188a06
4
+ data.tar.gz: '08ab2999267df91afb8f62b9a6b00810299791cad99763d5b16f70bda946410a'
5
5
  SHA512:
6
- metadata.gz: c4e97c3665d1e902f47cfb579fda437dc834ac4b584606f1ca3b8fd9225e8502cacf5fb687673b4735b359de6af179589759a34369f1c74e904b37f8fe70a4ee
7
- data.tar.gz: a4e6d41067bf6b88c77577def0c1f9ecc3f5d46f0bdfb0821952c26867e91a71c64231aab09a25096d22c3272dea2dcc37547bc6096dd7622a192fa00e0a4e50
6
+ metadata.gz: ad90b8ed3b060ce4521326a0dd4173550ee6bf64b0674fc08fbf37770aaec5ca0ea82738ed1730ccfcff4e0b616afcc47789ca8610cdd41a20abc0ef7d734891
7
+ data.tar.gz: 2ed367f9801d28616a1b56b0b209cfe797c2b5a137d2e67cfb8c6864c8d5ed8f58992924ddce654f1fec53b84a5f18abdf88d4df45373b98f46786d511bac3f2
@@ -0,0 +1,61 @@
1
+ version: 2
2
+ references:
3
+ unit: &unit
4
+ run:
5
+ name: Run test suite
6
+ command: bundle exec rake
7
+ restore: &restore
8
+ restore_cache:
9
+ keys:
10
+ - v1-dependencies-{{ checksum "Gemfile.lock" }}
11
+ # fallback to using the latest cache if no exact match is found
12
+ - v1-dependencies-
13
+ bundle: &bundle
14
+ run:
15
+ name: install dependencies
16
+ command: |
17
+ bundle install --jobs=4 --retry=3 --path vendor/bundle
18
+ save: &save
19
+ save_cache:
20
+ paths:
21
+ - ./vendor/bundle
22
+ key: v1-dependencies-{{ checksum "Gemfile.lock" }}
23
+ jobs:
24
+ "ruby-2.5":
25
+ docker:
26
+ - image: circleci/ruby:2.5
27
+ - image: circleci/redis:4.0
28
+ steps:
29
+ - checkout
30
+ - <<: *restore
31
+ - <<: *bundle
32
+ - <<: *save
33
+ - <<: *unit
34
+ "ruby-2.6":
35
+ docker:
36
+ - image: circleci/ruby:2.6
37
+ - image: circleci/redis:4.0
38
+ steps:
39
+ - checkout
40
+ - <<: *restore
41
+ - <<: *bundle
42
+ - <<: *save
43
+ - <<: *unit
44
+ "jruby":
45
+ docker:
46
+ - image: circleci/jruby:latest
47
+ - image: circleci/redis:4.0
48
+ steps:
49
+ - checkout
50
+ - <<: *restore
51
+ - <<: *bundle
52
+ - <<: *save
53
+ - <<: *unit
54
+
55
+ workflows:
56
+ version: 2
57
+ build:
58
+ jobs:
59
+ - "ruby-2.5"
60
+ - "ruby-2.6"
61
+ - "jruby"
@@ -4,6 +4,8 @@ Sidekiq / Pro / Enterprise version(s):
4
4
  Please include your initializer and any error message with the full backtrace.
5
5
 
6
6
  Are you using an old version?
7
- Have you checked the changelog to see if your issue has been fixed in a later version?
7
+ Have you checked the changelogs to see if your issue has been fixed in a later version?
8
8
 
9
9
  https://github.com/mperham/sidekiq/blob/master/Changes.md
10
+ https://github.com/mperham/sidekiq/blob/master/Pro-Changes.md
11
+ https://github.com/mperham/sidekiq/blob/master/Ent-Changes.md
data/.gitignore CHANGED
@@ -2,6 +2,7 @@
2
2
  .ruby-version
3
3
  tags
4
4
  Gemfile.lock
5
+ gemfiles/*.lock
5
6
  *.swp
6
7
  dump.rdb
7
8
  .rbx
@@ -10,3 +11,5 @@ vendor/
10
11
  .bundle/
11
12
  .sass-cache/
12
13
  tmp/
14
+ pkg/*.gem
15
+ .byebug_history
data/.travis.yml CHANGED
@@ -3,16 +3,9 @@ sudo: false
3
3
  cache: bundler
4
4
  services:
5
5
  - redis-server
6
- before_install:
7
- - gem install bundler
8
- - gem update bundler
9
- matrix:
10
- include:
11
- - rvm: 2.2.4
12
- env: "PERCY_ENABLE=0"
13
- - rvm: 2.3.0
14
- env: "PERCY_ENABLE=0"
15
- - rvm: 2.4.0
16
- env: "PERCY_ENABLE=1"
17
- - rvm: jruby-9.1.6.0
18
- env: "PERCY_ENABLE=0"
6
+ rvm:
7
+ - 2.3.7
8
+ - 2.4.4
9
+ - 2.5.1
10
+ - 2.6.0
11
+ - jruby-9.2.6.0
data/5.0-Upgrade.md ADDED
@@ -0,0 +1,56 @@
1
+ # Welcome to Sidekiq 5.0!
2
+
3
+ Sidekiq 5.0 contains a reworked job dispatch and execution core to integrate
4
+ better with the new Rails 5.0 Executor. It also drops support for older
5
+ versions of Ruby and Rails and adds support for RTL languages in the Web UI.
6
+
7
+ ## What's New
8
+
9
+ * Integrate job logging and retry logic directly in with the job
10
+ execution logic in Sidekiq::Processor. Previously this logic was
11
+ defined as middleware. In Rails 5.0, ActiveSupport::Executor handles ActiveRecord
12
+ connection management, job callbacks, development mode class loading,
13
+ etc. Because of its extensive responsibilities, the Executor can't be
14
+ integrated as Sidekiq middleware; the logging/retry logic had to be pulled out
15
+ too. Sidekiq 4.2 had a hack to make it work but this redesign provides
16
+ a cleaner integration. [#3235]
17
+ * The Delayed Extensions `delay`, `delay_in` and `delay_until` APIs are
18
+ no longer available by default. The extensions allow you to marshal
19
+ job arguments as YAML, leading to cases where job payloads could be many
20
+ 100s of KB or larger if not careful, leading to Redis networking
21
+ timeouts or other problems. As noted in the Best Practices wiki page,
22
+ Sidekiq is designed for jobs with small, simple arguments.
23
+
24
+ Add this line to your initializer to re-enable them and get the old behavior:
25
+ ```ruby
26
+ Sidekiq::Extensions.enable_delay!
27
+ ```
28
+ The old `Sidekiq.remove_delay!` API has been removed as it is now the default. [#3299]
29
+ * Sidekiq's quiet signal is now `TSTP` (think of it as **T**hread
30
+ **ST**o**P**) instead of USR1 as USR1 is not available on JRuby.
31
+ USR1 will continue to be supported in Sidekiq 5.x for backwards
32
+ compatibility and will be removed in Sidekiq 6.x. [#3302]
33
+ * The Web UI is now bi-directional - it can render either LTR
34
+ (left-to-right) or RTL languages. With this change, **Farsi, Arabic,
35
+ Hebrew and Urdu** are officially supported. [#3381]
36
+ * Jobs which can't be parsed due to invalid JSON are now pushed
37
+ immediately to the Dead set since they require manual intervention and
38
+ will never execute successfully as is. The Web UI has been updated to
39
+ more gracefully display these jobs. [#3296]
40
+ * **Rails 3.2** is no longer supported.
41
+ * **Ruby 2.0 and Ruby 2.1** are no longer supported. Ruby 2.2.2+ is required.
42
+
43
+ ## Upgrade
44
+
45
+ As always, please upgrade Sidekiq **one major version at a time**.
46
+ If you are already running Sidekiq 4.x, then:
47
+
48
+ * Upgrade to the latest Sidekiq 4.x.
49
+ ```ruby
50
+ gem 'sidekiq', '< 5'
51
+ ```
52
+ * Fix any deprecation warnings you see.
53
+ * Upgrade to 5.x.
54
+ ```ruby
55
+ gem 'sidekiq', '< 6'
56
+ ```
data/COMM-LICENSE CHANGED
@@ -14,13 +14,15 @@ In order to use the Software under this Agreement, you must receive a “Source
14
14
 
15
15
  1.2 Unlimited Organization License. If you purchased an Organization License (included with the Sidekiq Pro Software), you may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. You may also run an unlimited number of Workers. “Worker” means a thread within a Sidekiq server process which executes jobs. You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
16
16
 
17
- 1.3 Limited Organization License. If you purchased an Organization License (included with the Sidekiq Enterprise Software), you may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. The aggregate number of Workers run by the hosts must not exceed the maximum number of Workers authorized at the time of purchase. “Worker” means a thread within a Sidekiq server process which executes jobs. In order to run additional Workers, you must purchase an additional allowance from Contributed Systems.
17
+ 1.3 Limited Enterprise License. If you purchased a Limited License for the Sidekiq Enterprise Software, you may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. The aggregate number of Workers run by the hosts must not exceed the maximum number of Workers authorized at the time of purchase. “Worker” means a thread within a Sidekiq server process which executes jobs. In order to run additional Workers, you must purchase an additional allowance from Contributed Systems.
18
18
 
19
- 1.4 Appliance License. If you purchased an Appliance License, you may distribute the Software in any applications, frameworks, or elements (collectively referred to as an “Application” or “Applications”) that you develop using the Software in accordance with this EULA, provided that such distribution does not violate the restrictions set forth in section 3 of this EULA. You must not remove, obscure or interfere with any copyright, acknowledgment, attribution, trademark, warning or disclaimer statement affixed to, incorporated in or otherwise applied in connection with the Software. You are required to ensure that the Software is not reused by or with any applications other than those with which you distribute it as permitted herein. For example, if You install the Software on a customer’s server, that customer is not permitted to use the Software independently of your Application. You must inform Contributed Systems of your knowledge of any infringing use of the Software by any of your customers. You are liable for compliance by those third parties with the terms and conditions of this EULA. You will not owe Contributed Systems any royalties for your distribution of the Software in accordance with this EULA.
19
+ 1.4 Enterprise Site License. If you purchased a Site License for the Sidekiq Enterprise Software, you may install the Software on an unlimited number of Hosts. “Host” means any physical or virtual machine which is controlled by you. You may also run an unlimited number of Workers. “Worker” means a thread within a Sidekiq server process which executes jobs. You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
20
20
 
21
- 1.5 Archive Copies. You are entitled to make a reasonable amount of copies of the Software for archival purposes. Each copy must reproduce all copyright and other proprietary rights notices on or in the Software Product.
21
+ 1.5 Appliance License. If you purchased an Appliance License, you may distribute the Software in any applications, frameworks, or elements (collectively referred to as an “Application” or “Applications”) that you develop using the Software in accordance with this EULA, provided that such distribution does not violate the restrictions set forth in section 3 of this EULA. You must not remove, obscure or interfere with any copyright, acknowledgment, attribution, trademark, warning or disclaimer statement affixed to, incorporated in or otherwise applied in connection with the Software. You are required to ensure that the Software is not reused by or with any applications other than those with which you distribute it as permitted herein. For example, if You install the Software on a customer's server, that customer is not permitted to use the Software independently of your Application. You must inform Contributed Systems of your knowledge of any infringing use of the Software by any of your customers. You are liable for compliance by those third parties with the terms and conditions of this EULA. You will not owe Contributed Systems any royalties for your distribution of the Software in accordance with this EULA.
22
22
 
23
- 1.6 Electronic Delivery. All Software and license documentation shall be delivered by electronic means unless otherwise specified on the applicable invoice or at the time of purchase. Software shall be deemed delivered when it is made available for download by you (“Delivery”).
23
+ 1.6 Archive Copies. You are entitled to make a reasonable amount of copies of the Software for archival purposes. Each copy must reproduce all copyright and other proprietary rights notices on or in the Software Product.
24
+
25
+ 1.7 Electronic Delivery. All Software and license documentation shall be delivered by electronic means unless otherwise specified on the applicable invoice or at the time of purchase. Software shall be deemed delivered when it is made available for download by you (“Delivery”).
24
26
 
25
27
  2. Modifications. Contributed Systems shall provide you with source code so that you can create Modifications of the original software. “Modification” means: (a) any addition to or deletion from the contents of a file included in the original Software or previous Modifications created by You, or (b) any new file that contains any part of the original Software or previous Modifications. While you retain all rights to any original work authored by you as part of the Modifications, We continue to own all copyright and other intellectual property rights in the Software.
26
28
 
@@ -31,18 +33,18 @@ In order to use the Software under this Agreement, you must receive a “Source
31
33
  3.2 UNDER NO CIRCUMSTANCES MAY YOU USE THE SOFTWARE AS PART OF A PRODUCT OR SERVICE THAT PROVIDES SIMILAR FUNCTIONALITY TO THE SOFTWARE ITSELF.
32
34
 
33
35
  The Open Source version of the Software (“LGPL Version”) is licensed
34
- under the terms of the GNU Lesser General Public License versions 3.0
36
+ under the terms of the GNU Lesser General Public License version 3.0
35
37
  (“LGPL”) and not under this EULA.
36
38
 
37
39
  4. Ownership. Notwithstanding anything to the contrary contained herein, except for the limited license rights expressly provided herein, Contributed Systems and its suppliers have and will retain all rights, title and interest (including, without limitation, all patent, copyright, trademark, trade secret and other intellectual property rights) in and to the Software and all copies, modifications and derivative works thereof (including any changes which incorporate any of your ideas, feedback or suggestions). You acknowledge that you are obtaining only a limited license right to the Software, and that irrespective of any use of the words “purchase”, “sale” or like terms hereunder no ownership rights are being conveyed to you under this Agreement or otherwise.
38
40
 
39
41
  5. Fees and Payment. The Software license fees will be due and payable in full as set forth in the applicable invoice or at the time of purchase. If the Software does not function properly within two weeks of purchase, please contact us within those two weeks for a refund. You shall be responsible for all taxes, withholdings, duties and levies arising from the order (excluding taxes based on the net income of Contributed Systems).
40
42
 
41
- 6. Support, Maintenance and Services. Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth on the Sidekiq Pro support page (https://github.com/mperham/sidekiq/wiki/Pro-Support), support and maintenance services may be included with the purchase of your license subscription.
43
+ 6. Support, Maintenance and Services. Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth on the Sidekiq Pro support page (https://github.com/mperham/sidekiq/wiki/Commercial-Support), support and maintenance services may be included with the purchase of your license subscription.
42
44
 
43
45
  7. Term of Agreement.
44
46
 
45
- 7.1 Term. This Agreement is effective as of the Delivery of the Software and expires at such time as all license and service subscriptions hereunder have expired in accordance with their own terms (the “Term”). For clarification, the term of your license under this Agreement may be perpetual, limited for Evaluation Version, or designated as a fixed-term license in the Invoice, and shall be specified at your time of purchase. Either party may terminate this Agreement (including all related Invoices) if the other party: (a) fails to cure any material breach of this Agreement within thirty (30) days after written notice of such breach, provided that Contributed Systems may terminate this Agreement immediately upon any breach of Section 3 or if you exceed any other restrictions contained in Section 1, unless otherwise specified in this agreement; (b) ceases operation without a successor; or (c) seeks protection under any bankruptcy, receivership, trust deed, creditors arrangement, composition or comparable proceeding, or if any such proceeding is instituted against such party (and not dismissed within sixty (60) days)). Termination is not an exclusive remedy and the exercise by either party of any remedy under this Agreement will be without prejudice to any other remedies it may have under this Agreement, by law, or otherwise.
47
+ 7.1 Term. This Agreement is effective as of the Delivery of the Software and expires at such time as all license and service subscriptions hereunder have expired in accordance with their own terms (the “Term”). For clarification, the term of your license under this Agreement may be perpetual, limited for Evaluation Version, or designated as a fixed-term license in the Invoice, and shall be specified at your time of purchase. Either party may terminate this Agreement (including all related Invoices) if the other party: (a) fails to cure any material breach of this Agreement within thirty (30) days after written notice of such breach, provided that Contributed Systems may terminate this Agreement immediately upon any breach of Section 3 or if you exceed any other restrictions contained in Section 1, unless otherwise specified in this agreement; (b) ceases operation without a successor; or (c) seeks protection under any bankruptcy, receivership, trust deed, creditors arrangement, composition or comparable proceeding, or if any such proceeding is instituted against such party (and not dismissed within sixty (60) days)). Termination is not an exclusive remedy and the exercise by either party of any remedy under this Agreement will be without prejudice to any other remedies it may have under this Agreement, by law, or otherwise.
46
48
 
47
49
  7.2 Termination. Upon any termination of this Agreement, you shall cease any and all use of any Software and destroy all copies thereof.
48
50
 
@@ -57,7 +59,7 @@ In no event will Contributed Systems be liable for any direct, indirect, consequ
57
59
 
58
60
  In no event will Contributed Systems' liability exceed the Software license price as indicated in the invoice. The existence of more than one claim will not enlarge or extend this limit.
59
61
 
60
- 10. Remedies. Your exclusive remedy and Contributed Systems entire liability for breach of this Agreement shall be limited, at Contributed Systems sole and exclusive discretion, to (a) replacement of any defective software or documentation; or (b) refund of the license fee paid to Contributed Systems, payable in accordance with Contributed Systems' refund policy.
62
+ 10. Remedies. Your exclusive remedy and Contributed Systems' entire liability for breach of this Agreement shall be limited, at Contributed Systems' sole and exclusive discretion, to (a) replacement of any defective software or documentation; or (b) refund of the license fee paid to Contributed Systems, payable in accordance with Contributed Systems' refund policy.
61
63
 
62
64
  11. Acknowledgements.
63
65
 
@@ -67,7 +69,7 @@ In no event will Contributed Systems' liability exceed the Software license pric
67
69
 
68
70
  11.3 Government End Users. If the Software and related documentation are supplied to or purchased by or on behalf of the United States Government, then the Software is deemed to be "commercial software" as that term is used in the Federal Acquisition Regulation system. Rights of the United States shall not exceed the minimum rights set forth in FAR 52.227-19 for "restricted computer software". All other terms and conditions of this Agreement apply.
69
71
 
70
- 12. Third Party Software. Examples included in Software may provide links to third party libraries or code (collectively “Third Party Software”) to implement various functions. Third Party Software does not comprise part of the Software. In some cases, access to Third Party Software may be included along with the Software delivery as a convenience for demonstration purposes. Such source code and libraries may be included in the “…/examples” source tree delivered with the Software and do not comprise the Software. Licensee acknowledges (1) that some part of Third Party Software may require additional licensing of copyright and patents from the owners of such, and (2) that distribution of any of the Software referencing or including any portion of a Third Party Software may require appropriate licensing from such third parties.
72
+ 12. Third Party Software. Examples included in Software may provide links to third party libraries or code (collectively “Third Party Software”) to implement various functions. Third Party Software does not comprise part of the Software. In some cases, access to Third Party Software may be included along with the Software delivery as a convenience for demonstration purposes. Such source code and libraries may be included in the “…/examples” source tree delivered with the Software and do not comprise the Software. Licensee acknowledges (1) that some part of Third Party Software may require additional licensing of copyright and patents from the owners of such, and (2) that distribution of any of the Software referencing or including any portion of a Third Party Software may require appropriate licensing from such third parties.
71
73
 
72
74
 
73
75
  13. Miscellaneous
@@ -84,7 +86,7 @@ In no event will Contributed Systems' liability exceed the Software license pric
84
86
 
85
87
  13.6 Governing Law. This Agreement is governed by the laws of the State of Oregon and the United States without regard to conflicts of laws provisions thereof, and without regard to the United Nations Convention on the International Sale of Goods or the Uniform Computer Information Transactions Act, as currently enacted by any jurisdiction or as may be codified or amended from time to time by any jurisdiction. The jurisdiction and venue for actions related to the subject matter hereof shall be the state of Oregon and United States federal courts located in Portland, Oregon, and both parties hereby submit to the personal jurisdiction of such courts.
86
88
 
87
- 13.7 Attorneys Fees and Costs. The prevailing party in any action to enforce this Agreement will be entitled to recover its attorneys fees and costs in connection with such action.
89
+ 13.7 Attorneys' Fees and Costs. The prevailing party in any action to enforce this Agreement will be entitled to recover its attorneys' fees and costs in connection with such action.
88
90
 
89
91
  13.8 Severability. If any provision of this Agreement is held by a court of competent jurisdiction to be invalid, illegal, or unenforceable, the remainder of this Agreement will remain in full force and effect.
90
92
 
data/Changes.md CHANGED
@@ -1,6 +1,182 @@
1
1
  # Sidekiq Changes
2
2
 
3
- HEAD
3
+ [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/master/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/master/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/master/Ent-Changes.md)
4
+
5
+ 5.2.10
6
+ ---------
7
+
8
+ - Backport fix for CVE-2022-23837.
9
+ - Migrate to `exists?` for redis-rb.
10
+ - Lock redis-rb to <4.6 to avoid deprecations.
11
+
12
+ 5.2.9
13
+ ---------
14
+
15
+ - Release Rack lock due to a cascade of CVEs. [#4566]
16
+ Pro-tip: don't lock Rack.
17
+
18
+ 5.2.8
19
+ ---------
20
+
21
+ - Lock to Rack 2.0.x to prevent future incompatibilities
22
+ - Fix invalid reference in `sidekiqctl`
23
+
24
+ 5.2.7
25
+ ---------
26
+
27
+ - Fix stale `enqueued_at` when retrying [#4149]
28
+ - Move build to [Circle CI](https://circleci.com/gh/mperham/sidekiq) [#4120]
29
+
30
+ 5.2.6
31
+ ---------
32
+
33
+ - Fix edge case where a job failure during Redis outage could result in a lost job [#4141]
34
+ - Better handling of malformed job arguments in payload [#4095]
35
+ - Restore bootstap's dropdown css component [#4099, urkle]
36
+ - Display human-friendly time diff for longer queue latencies [#4111, interlinked]
37
+ - Allow `Sidekiq::Worker#set` to be chained
38
+
39
+ 5.2.5
40
+ ---------
41
+
42
+ - Fix default usage of `config/sidekiq.yml` [#4077, Tensho]
43
+
44
+ 5.2.4
45
+ ---------
46
+
47
+ - Add warnings for various deprecations and changes coming in Sidekiq 6.0.
48
+ See the 6-0 branch. [#4056]
49
+ - Various improvements to the Sidekiq test suite and coverage [#4026, #4039, Tensho]
50
+
51
+ 5.2.3
52
+ ---------
53
+
54
+ - Warning message on invalid REDIS\_PROVIDER [#3970]
55
+ - Add `sidekiqctl status` command [#4003, dzunk]
56
+ - Update elapsed time calculatons to use monotonic clock [#3999]
57
+ - Fix a few issues with mobile Web UI styling [#3973, navied]
58
+ - Jobs with `retry: false` now go through the global `death_handlers`,
59
+ meaning you can take action on failed ephemeral jobs. [#3980, Benjamin-Dobell]
60
+ - Fix race condition in defining Workers. [#3997, mattbooks]
61
+
62
+ 5.2.2
63
+ ---------
64
+
65
+ - Raise error for duplicate queue names in config to avoid unexpected fetch algorithm change [#3911]
66
+ - Fix concurrency bug on JRuby [#3958, mattbooks]
67
+ - Add "Kill All" button to the retries page [#3938]
68
+
69
+ 5.2.1
70
+ -----------
71
+
72
+ - Fix concurrent modification error during heartbeat [#3921]
73
+
74
+ 5.2.0
75
+ -----------
76
+
77
+ - **Decrease default concurrency from 25 to 10** [#3892]
78
+ - Verify connection pool sizing upon startup [#3917]
79
+ - Smoother scheduling for large Sidekiq clusters [#3889]
80
+ - Switch Sidekiq::Testing impl from alias\_method to Module#prepend, for resiliency [#3852]
81
+ - Update Sidekiq APIs to use SCAN for scalability [#3848, ffiller]
82
+ - Remove concurrent-ruby gem dependency [#3830]
83
+ - Optimize Web UI's bootstrap.css [#3914]
84
+
85
+ 5.1.3
86
+ -----------
87
+
88
+ - Fix version comparison so Ruby 2.2.10 works. [#3808, nateberkopec]
89
+
90
+ 5.1.2
91
+ -----------
92
+
93
+ - Add link to docs in Web UI footer
94
+ - Fix crash on Ctrl-C in Windows [#3775, Bernica]
95
+ - Remove `freeze` calls on String constants. This is superfluous with Ruby
96
+ 2.3+ and `frozen_string_literal: true`. [#3759]
97
+ - Fix use of AR middleware outside of Rails [#3787]
98
+ - Sidekiq::Worker `sidekiq_retry_in` block can now return nil or 0 to use
99
+ the default backoff delay [#3796, dsalahutdinov]
100
+
101
+ 5.1.1
102
+ -----------
103
+
104
+ - Fix Web UI incompatibility with Redis 3.x gem [#3749]
105
+
106
+ 5.1.0
107
+ -----------
108
+
109
+ - **NEW** Global death handlers - called when your job exhausts all
110
+ retries and dies. Now you can take action when a job fails permanently. [#3721]
111
+ - **NEW** Enable ActiveRecord query cache within jobs by default [#3718, sobrinho]
112
+ This will prevent duplicate SELECTS; cache is cleared upon any UPDATE/INSERT/DELETE.
113
+ See the issue for how to bypass the cache or disable it completely.
114
+ - Scheduler timing is now more accurate, 15 -> 5 seconds [#3734]
115
+ - Exceptions during the :startup event will now kill the process [#3717]
116
+ - Make `Sidekiq::Client.via` reentrant [#3715]
117
+ - Fix use of Sidekiq logger outside of the server process [#3714]
118
+ - Tweak `constantize` to better match Rails class lookup. [#3701, caffeinated-tech]
119
+
120
+ 5.0.5
121
+ -----------
122
+
123
+ - Update gemspec to allow newer versions of the Redis gem [#3617]
124
+ - Refactor Worker.set so it can be memoized [#3602]
125
+ - Fix display of Redis URL in web footer, broken in 5.0.3 [#3560]
126
+ - Update `Sidekiq::Job#display_args` to avoid mutation [#3621]
127
+
128
+ 5.0.4
129
+ -----------
130
+
131
+ - Fix "slow startup" performance regression from 5.0.2. [#3525]
132
+ - Allow users to disable ID generation since some redis providers disable the CLIENT command. [#3521]
133
+
134
+ 5.0.3
135
+ -----------
136
+
137
+ - Fix overriding `class_attribute` core extension from ActiveSupport with Sidekiq one [PikachuEXE, #3499]
138
+ - Allow job logger to be overridden [AlfonsoUceda, #3502]
139
+ - Set a default Redis client identifier for debugging [#3516]
140
+ - Fix "Uninitialized constant" errors on startup with the delayed extensions [#3509]
141
+
142
+ 5.0.2
143
+ -----------
144
+
145
+ - fix broken release, thanks @nateberkopec
146
+
147
+ 5.0.1
148
+ -----------
149
+
150
+ - Fix incorrect server identity when daemonizing [jwilm, #3496]
151
+ - Work around error running Web UI against Redis Cluster [#3492]
152
+ - Remove core extensions, Sidekiq is now monkeypatch-free! [#3474]
153
+ - Reimplement Web UI's HTTP\_ACCEPT\_LANGUAGE parsing because the spec is utterly
154
+ incomprehensible for various edge cases. [johanlunds, natematykiewicz, #3449]
155
+ - Update `class_attribute` core extension to avoid warnings
156
+ - Expose `job_hash_context` from `Sidekiq::Logging` to support log customization
157
+
158
+ 5.0.0
159
+ -----------
160
+
161
+ - **BREAKING CHANGE** Job dispatch was refactored for safer integration with
162
+ Rails 5. The **Logging** and **RetryJobs** server middleware were removed and
163
+ functionality integrated directly into Sidekiq::Processor. These aren't
164
+ commonly used public APIs so this shouldn't impact most users.
165
+ ```
166
+ Sidekiq::Middleware::Server::RetryJobs -> Sidekiq::JobRetry
167
+ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger
168
+ ```
169
+ - Quieting Sidekiq is now done via the TSTP signal, the USR1 signal is deprecated.
170
+ - The `delay` extension APIs are no longer available by default, you
171
+ must opt into them.
172
+ - The Web UI is now BiDi and can render RTL languages like Arabic, Farsi and Hebrew.
173
+ - Rails 3.2 and Ruby 2.0 and 2.1 are no longer supported.
174
+ - The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
175
+ - Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
176
+ of random hex bytes.
177
+ - Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
178
+
179
+ 4.2.10
4
180
  -----------
5
181
 
6
182
  - Scheduled jobs can now be moved directly to the Dead queue via API [#3390]
data/Ent-Changes.md CHANGED
@@ -1,8 +1,73 @@
1
- Sidekiq Enterprise Changelog
2
- =======================
1
+ # Sidekiq Enterprise Changelog
2
+
3
+ [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/master/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/master/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/master/Ent-Changes.md)
3
4
 
4
5
  Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how to buy.
5
6
 
7
+ 1.8.1
8
+ -------------
9
+
10
+ - Fix excessive lock reclaims with concurrent limiter [#4105]
11
+ - Add ES translations, see issues [#3949](https://github.com/mperham/sidekiq/issues/3949) and [#3951](https://github.com/mperham/sidekiq/issues/3951) to add your own language.
12
+
13
+ 1.8.0
14
+ -------------
15
+
16
+ - Require Sidekiq Pro 4.0 and Sidekiq 5.2.
17
+ - Refactor historical metrics API to use revamped Statsd support in Sidekiq Pro
18
+ - Add a gauge to historical metrics for `default` queue latency [#4079]
19
+
20
+ 1.7.2
21
+ -------------
22
+
23
+ - Add PT and JA translations
24
+ - Fix elapsed time calculations to use monotonic clock [#4000, sj26]
25
+ - Fix edge case where flapping leadership would cause old periodic
26
+ jobs to be fired once [#3974]
27
+ - Add support for sidekiqswarm memory monitoring on FreeBSD [#3884]
28
+
29
+ 1.7.1
30
+ -------------
31
+
32
+ - Fix Lua error in concurrent rate limiter under heavy contention
33
+ - Remove superfluous `freeze` calls on Strings [#3759]
34
+
35
+ 1.7.0
36
+ -------------
37
+
38
+ - **NEW FEATURE** [Rolling restarts](https://github.com/mperham/sidekiq/wiki/Ent-Rolling-Restarts) - great for long running jobs!
39
+ - Adjust middleware so unique jobs that don't push aren't registered in a Batch [#3662]
40
+ - Add new unlimited rate limiter, useful for testing [#3743]
41
+ ```ruby
42
+ limiter = Sidekiq::Limiter.unlimited(...any args...)
43
+ ```
44
+
45
+ 1.6.1
46
+ -------------
47
+
48
+ - Fix crash in rate limiter middleware when used with custom exceptions [#3604]
49
+
50
+ 1.6.0
51
+ -------------
52
+
53
+ - Show process "leader" tag on Busy page, requires Sidekiq 5.0.2 [#2867]
54
+ - Capture custom metrics with the `save_history` API. [#2815]
55
+ - Implement new `unique_until: 'start'` policy option. [#3471]
56
+
57
+ 1.5.4
58
+ -------------
59
+
60
+ - Fix broken Cron page in Web UI [#3458]
61
+
62
+ 1.5.3
63
+ -------------
64
+
65
+ - Remove dependency on the algorithms gem [#3446]
66
+ - Allow user to specify max memory in megabytes with SIDEKIQ\_MAXMEM\_MB [#3451]
67
+ - Implement logic to detect app startup failure, sidekiqswarm will exit
68
+ rather than try to restart the app forever [#3450]
69
+ - Another fix for doubly-encrypted arguments [#3368]
70
+
6
71
  1.5.2
7
72
  -------------
8
73
 
data/Gemfile CHANGED
@@ -1,29 +1,19 @@
1
1
  source 'https://rubygems.org'
2
- gemspec
3
2
 
4
- gem 'rails', '>= 5.0.1'
5
- gem "hiredis"
6
- gem 'simplecov'
7
- gem 'minitest'
8
- #gem 'minitest-utils'
9
- gem 'toxiproxy'
3
+ gemspec
10
4
 
11
- platforms :rbx do
12
- gem 'rubysl', '~> 2.0' # if using anything in the ruby standard library
13
- gem 'psych' # if using yaml
14
- gem 'rubinius-developer_tools' # if using any of coverage, debugger, profiler
15
- end
5
+ gem 'rake'
6
+ gem 'redis-namespace'
7
+ gem 'rails', '~> 5.2'
8
+ gem 'sqlite3', platforms: :ruby
9
+ gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
16
10
 
17
- platforms :ruby do
18
- gem 'sqlite3'
11
+ group :test do
12
+ gem 'minitest'
13
+ gem 'simplecov'
19
14
  end
20
15
 
21
- platforms :mri do
22
- gem 'pry-byebug'
23
- gem 'ruby-prof'
16
+ group :load_test do
17
+ gem 'hiredis'
18
+ gem 'toxiproxy'
24
19
  end
25
-
26
- #platforms :jruby do
27
- #gem 'jruby-openssl'
28
- #gem 'activerecord-jdbcsqlite3-adapter'
29
- #end
data/LICENSE CHANGED
@@ -5,5 +5,5 @@ the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
5
5
  for license text.
6
6
 
7
7
  Sidekiq Pro has a commercial-friendly license allowing private forks
8
- and modifications of Sidekiq. Please see http://sidekiq.org/pro/ for
8
+ and modifications of Sidekiq. Please see https://sidekiq.org/products/pro.html for
9
9
  more detail. You can find the commercial license terms in COMM-LICENSE.
@@ -0,0 +1,35 @@
1
+ # Welcome to Sidekiq Pro 4.0!
2
+
3
+ Sidekiq Pro 4.0 is designed to work with Sidekiq 5.0.
4
+
5
+ ## What's New
6
+
7
+ * Batches now "die" if any of their jobs die. You can enumerate the set
8
+ of dead batches and their associated dead jobs. The success callback
9
+ for a dead batch will never fire unless these jobs are fixed.
10
+ ```ruby
11
+ Sidekiq::Batch::DeadSet.new.each do |status|
12
+ status.dead? # => true
13
+ status.dead_jobs # => [...]
14
+ end
15
+ ```
16
+ This API allows you to enumerate the batches which need help.
17
+ If you fix the issue and the dead jobs succeed, the batch will succeed.
18
+ * The older `reliable_fetch` and `timed_fetch` algorithms have been
19
+ removed. Only super\_fetch is available in 4.0.
20
+ * The statsd middleware has been tweaked to remove support for legacy,
21
+ pre-3.6.0 configuration and add relevant tags.
22
+ * Requires Sidekiq 5.0.5+.
23
+
24
+ ## Upgrade
25
+
26
+ * Upgrade to the latest Sidekiq Pro 3.x.
27
+ ```ruby
28
+ gem 'sidekiq-pro', '< 4'
29
+ ```
30
+ * Fix any deprecation warnings you see.
31
+ * Upgrade to 4.x.
32
+ ```ruby
33
+ gem 'sidekiq-pro', '< 5'
34
+ ```
35
+