sidekiq 5.0.0.rc1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d7e0b4092aa035c45d6dd4893cd470bb9a249d6
-  data.tar.gz: fbb9d06f9875133960daf397b8c338ca74c2d225
+  metadata.gz: f2a9cd7270e53981aaf7b3f2639596ff042f5ae3
+  data.tar.gz: 7b6e4fbfee794de34d9b6b15772cbf085e05a65b
 SHA512:
-  metadata.gz: f1dd673960ace0f7e30a09bb480de64265a64b997042b65c8cb0057757129def2005c75b6f017c3b5fb589681c2f2180e2f0b8f698f4ac63ef9bf44b641ad426
-  data.tar.gz: d9a1a3270d371bf7d7bddf98d103e6be2886a4dd6acbb08c1d5edd7b951b7f8d91d11e56c0892e10c6e6981f028ea8d64db5900cef0c3cb4023b91a9adbb30cd
+  metadata.gz: dfaecc27ce4071e36b5ab994c27f59d85b4cf7f16ca05a5b786c79125c311f58fbb38b94f7e1c71e4dbf90e6645cb358102e8940a94881981f7bbc2578fd18ff
+  data.tar.gz: a98e9b87e5f4abe2580ea5fcb6f20ef1d28623eae9be4ca758d5f5b52c65dbef7a6b5df74f673449177f36494b9075573315c7ef6cd6b757ba6a59e825737833

data/Changes.md

@@ -1,5 +1,7 @@
 # Sidekiq Changes
 
+[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)
+
 5.0.0
 -----------
 
@@ -16,6 +18,9 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogging
   must opt into them.
 - The Web UI is now BiDi and can render RTL languages like Arabic, Farsi and Hebrew.
 - Rails 3.2 and Ruby 2.0 and 2.1 are no longer supported.
+- The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152]
+- Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead
+  of random hex bytes.
 - Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail.
 
 4.2.10

data/Ent-Changes.md

@@ -1,5 +1,6 @@
-Sidekiq Enterprise Changelog
-=======================
+# Sidekiq Enterprise Changelog
+
+[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)
 
 Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how to buy.
 

data/Pro-Changes.md

@@ -1,5 +1,6 @@
-Sidekiq Pro Changelog
-=======================
+# Sidekiq Pro Changelog
+
+[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)
 
 Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how to buy.
 

data/lib/sidekiq.rb

@@ -12,7 +12,7 @@ require 'sidekiq/delay'
 require 'json'
 
 module Sidekiq
-  NAME = 'Sidekiq'
+  NAME = 'Sidekiq'.freeze
   LICENSE = 'See LICENSE and the LGPL-3.0 for licensing details.'
 
   DEFAULTS = {

data/lib/sidekiq/api.rb

@@ -338,12 +338,16 @@ module Sidekiq
                 when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
                   job_args = self['wrapped'] ? args[0]["arguments"] : []
                   if 'ActionMailer::DeliveryJob' == (self['wrapped'] || args[0])
-                   # remove MailerClass, mailer_method and 'deliver_now'
-                   job_args.drop(3)
+                    # remove MailerClass, mailer_method and 'deliver_now'
+                    job_args.drop(3)
                   else
-                   job_args
+                    job_args
                   end
                 else
+                  if self['encrypt'.freeze]
+                    # no point in showing 150+ bytes of random garbage
+                    args[-1] = '[encrypted data]'.freeze
+                  end
                   args
                 end
     end

data/lib/sidekiq/client.rb

@@ -63,11 +63,11 @@ module Sidekiq
     #
     def push(item)
       normed = normalize_item(item)
-      payload = process_single(item['class'], normed)
+      payload = process_single(item['class'.freeze], normed)
 
       if payload
         raw_push([payload])
-        payload['jid']
+        payload['jid'.freeze]
       end
     end
 
@@ -84,19 +84,19 @@ module Sidekiq
     # Returns an array of the of pushed jobs' jids.  The number of jobs pushed can be less
     # than the number given if the middleware stopped processing for one or more jobs.
     def push_bulk(items)
-      arg = items['args'].first
+      arg = items['args'.freeze].first
       return [] unless arg # no jobs to push
       raise ArgumentError, "Bulk arguments must be an Array of Arrays: [[1], [2]]" if !arg.is_a?(Array)
 
       normed = normalize_item(items)
-      payloads = items['args'].map do |args|
-        copy = normed.merge('args' => args, 'jid' => SecureRandom.hex(12), 'enqueued_at' => Time.now.to_f)
-        result = process_single(items['class'], copy)
+      payloads = items['args'.freeze].map do |args|
+        copy = normed.merge('args'.freeze => args, 'jid'.freeze => SecureRandom.hex(12), 'enqueued_at'.freeze => Time.now.to_f)
+        result = process_single(items['class'.freeze], copy)
         result ? result : nil
       end.compact
 
       raw_push(payloads) if !payloads.empty?
-      payloads.collect { |payload| payload['jid'] }
+      payloads.collect { |payload| payload['jid'.freeze] }
     end
 
     # Allows sharding of jobs across any number of Redis instances.  All jobs
@@ -140,14 +140,14 @@ module Sidekiq
       # Messages are enqueued to the 'default' queue.
       #
       def enqueue(klass, *args)
-        klass.client_push('class' => klass, 'args' => args)
+        klass.client_push('class'.freeze => klass, 'args'.freeze => args)
       end
 
       # Example usage:
       #   Sidekiq::Client.enqueue_to(:queue_name, MyWorker, 'foo', 1, :bat => 'bar')
       #
       def enqueue_to(queue, klass, *args)
-        klass.client_push('queue' => queue, 'class' => klass, 'args' => args)
+        klass.client_push('queue'.freeze => queue, 'class'.freeze => klass, 'args'.freeze => args)
       end
 
       # Example usage:
@@ -158,7 +158,7 @@ module Sidekiq
         now = Time.now.to_f
         ts = (int < 1_000_000_000 ? now + int : int)
 
-        item = { 'class' => klass, 'args' => args, 'at' => ts, 'queue' => queue }
+        item = { 'class'.freeze => klass, 'args'.freeze => args, 'at'.freeze => ts, 'queue'.freeze => queue }
         item.delete('at'.freeze) if ts <= now
 
         klass.client_push(item)
@@ -184,13 +184,13 @@ module Sidekiq
     end
 
     def atomic_push(conn, payloads)
-      if payloads.first['at']
+      if payloads.first['at'.freeze]
         conn.zadd('schedule'.freeze, payloads.map do |hash|
           at = hash.delete('at'.freeze).to_s
           [at, Sidekiq.dump_json(hash)]
         end)
       else
-        q = payloads.first['queue']
+        q = payloads.first['queue'.freeze]
         now = Time.now.to_f
         to_push = payloads.map do |entry|
           entry['enqueued_at'.freeze] = now
@@ -202,7 +202,7 @@ module Sidekiq
     end
 
     def process_single(worker_class, item)
-      queue = item['queue']
+      queue = item['queue'.freeze]
 
       middleware.invoke(worker_class, item, queue, @redis_pool) do
         item

data/lib/sidekiq/redis_connection.rb

@@ -67,7 +67,7 @@ module Sidekiq
           opts.delete(:network_timeout)
         end
 
-        opts[:driver] ||= 'ruby'
+        opts[:driver] ||= 'ruby'.freeze
 
         # Issue #3303, redis-rb will silently retry an operation.
         # This can lead to duplicate jobs if Sidekiq::Client's LPUSH

data/lib/sidekiq/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sidekiq
-  VERSION = "5.0.0.rc1"
+  VERSION = "5.0.0"
 end

data/lib/sidekiq/worker.rb

@@ -4,6 +4,7 @@ require 'sidekiq/core_ext'
 
 module Sidekiq
 
+
   ##
   # Include this module in your worker class and you can easily create
   # asynchronous jobs:
@@ -37,6 +38,34 @@ module Sidekiq
       Sidekiq.logger
     end
 
+    # This helper class encapsulates the set options for `set`, e.g.
+    #
+    #     SomeWorker.set(queue: 'foo').perform_async(....)
+    #
+    class Setter
+      def initialize(opts)
+        @opts = opts
+      end
+
+      def perform_async(*args)
+        @opts['class'.freeze].client_push(@opts.merge!('args'.freeze => args))
+      end
+
+      # +interval+ must be a timestamp, numeric or something that acts
+      #   numeric (like an activesupport time interval).
+      def perform_in(interval, *args)
+        int = interval.to_f
+        now = Time.now.to_f
+        ts = (int < 1_000_000_000 ? now + int : int)
+
+        @opts.merge! 'args'.freeze => args, 'at'.freeze => ts
+        # Optimization to enqueue something now that is scheduled to go out now or in the past
+        @opts.delete('at'.freeze) if ts <= now
+        @opts['class'.freeze].client_push(@opts)
+      end
+      alias_method :perform_at, :perform_in
+    end
+
     module ClassMethods
 
       def delay(*args)
@@ -52,12 +81,11 @@ module Sidekiq
       end
 
       def set(options)
-        Thread.current[:sidekiq_worker_set] = options
-        self
+        Setter.new(options.merge!('class'.freeze => self))
       end
 
       def perform_async(*args)
-        client_push('class' => self, 'args' => args)
+        client_push('class'.freeze => self, 'args'.freeze => args)
       end
 
       # +interval+ must be a timestamp, numeric or something that acts
@@ -67,7 +95,7 @@ module Sidekiq
         now = Time.now.to_f
         ts = (int < 1_000_000_000 ? now + int : int)
 
-        item = { 'class' => self, 'args' => args, 'at' => ts }
+        item = { 'class'.freeze => self, 'args'.freeze => args, 'at'.freeze => ts }
 
         # Optimization to enqueue something now that is scheduled to go out now or in the past
         item.delete('at'.freeze) if ts <= now
@@ -106,13 +134,8 @@ module Sidekiq
       end
 
       def client_push(item) # :nodoc:
-        pool = Thread.current[:sidekiq_via_pool] || get_sidekiq_options['pool'] || Sidekiq.redis_pool
-        hash = if Thread.current[:sidekiq_worker_set]
-          x, Thread.current[:sidekiq_worker_set] = Thread.current[:sidekiq_worker_set], nil
-          x.stringify_keys.merge(item.stringify_keys)
-        else
-          item.stringify_keys
-        end
+        pool = Thread.current[:sidekiq_via_pool] || get_sidekiq_options['pool'.freeze] || Sidekiq.redis_pool
+        hash = item.stringify_keys
         Sidekiq::Client.new(pool).push(hash)
       end
 

data/sidekiq.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.name          = "sidekiq"
   gem.require_paths = ["lib"]
   gem.version       = Sidekiq::VERSION
-  gem.add_dependency                  'redis', '~> 3.2', '>= 3.2.1'
+  gem.add_dependency                  'redis', '~> 3.3', '>= 3.3.3'
   gem.add_dependency                  'connection_pool', '~> 2.2', '>= 2.2.0'
   gem.add_dependency                  'concurrent-ruby', '~> 1.0'
   gem.add_dependency                  'rack-protection', '>= 1.5.0'

data/web/locales/he.yml

@@ -7,7 +7,7 @@ he:
   Realtime: זמן אמת
   History: היסטוריה
   Busy: עסוקים
-  Processed: מעובדים
+  Processed: עובדו
   Failed: נכשלו
   Scheduled: מתוכננים
   Retries: נסיונות חוזרים
@@ -34,24 +34,24 @@ he:
   RetryCount: מספר נסיונות חוזרים
   RetryNow: נסה שוב עכשיו
   Kill: הרוג
-  LastRetry: ניסיון חוזר האחרון
+  LastRetry: ניסיון חוזר אחרון
   OriginallyFailed: נכשל בניסיון הראשון
   AreYouSure: אתם בטוחים?
   DeleteAll: מחק הכל
   RetryAll: נסה שוב את הכל
   NoRetriesFound: לא נמצאו נסיונות חוזרים
   Error: שגיאה
-  ErrorClass: מחלקת השגיאה
-  ErrorMessage: מסר השגיאה
+  ErrorClass: סוג השגיאה
+  ErrorMessage: הודעת השגיאה
   ErrorBacktrace: מעקב לאחור של השגיאה
   GoBack: ← אחורה
   NoScheduledFound: לא נמצאו עבודות מתוכננות
   When: מתי
   ScheduledJobs: עבודות מתוכננות
-  idle: סרק
+  idle: במנוחה
   active: פעיל
   Version: גירסה
-  Connections: קישורים
+  Connections: חיבורים
   MemoryUsage: שימוש בזיכרון
   PeakMemoryUsage: שיא השימוש בזיכרון
   Uptime: זמן פעילות (ימים)
@@ -64,15 +64,15 @@ he:
   NoDeadJobsFound: לא נמצאו עבודות מתות
   Dead: מתים
   Processes: תהליכים
-  Thread: נים
-  Threads: נימים
+  Thread: חוט
+  Threads: חוטים
   Jobs: עבודות
-  Paused: נפסקים
+  Paused: הופסקו
   Stop: עצור
   Quiet: שקט
-  StopAll: עצור את כולם
+  StopAll: עצור הכל
   QuietAll: השקט את כולם
-  PollingInterval: רווח בין תשאולים
+  PollingInterval: מרווח זמן בין תשאולים
   Plugins: תוספים
   NotYetEnqueued: עוד לא בתור
   CreatedAt: נוצר ב

data/web/views/queue.erb

@@ -22,13 +22,13 @@
       <tr>
         <td><%= h(msg.display_class) %></td>
         <td>
-          <% a = msg.display_args.inspect %>
-          <% if a.size > 100 %>
-            <span class="worker_<%= index %>"><%= h(msg.display_args.inspect[0..100]) + "... " %></span>
+          <% a = msg.display_args %>
+          <% if a.inspect.size > 100 %>
+            <span class="worker_<%= index %>"><%= h(a.inspect[0..100]) + "... " %></span>
             <button data-toggle="collapse" data-target=".worker_<%= index %>" class="btn btn-default btn-xs"><%= t('ShowAll') %></button>
-            <div class="toggle worker_<%= index %>"><%= h(msg.display_args) %></div>
+            <div class="toggle worker_<%= index %>"><%= display_args(a) %></div>
           <% else %>
-            <%= h(msg.display_args) %>
+            <%= display_args(msg.display_args) %>
           <% end %>
         </td>
         <td>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc1
+  version: 5.0.0
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.3.3
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -354,9 +354,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2