sidekiq 5.2.3 → 5.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f67e98eb8e3fff8ee4d57f08d5668e41b320fa4
-  data.tar.gz: a11f770fd95fd45b3c0be43beee5c83417811fd4
+SHA256:
+  metadata.gz: 196f3dd99544e452ff05bef91694c5fad03709698b2f8db7003d68c06f052331
+  data.tar.gz: d99781e4c97a42b38c0cb9f46632190b941d8a332d763aeb4b92755848f94142
 SHA512:
-  metadata.gz: 3e6739681028126924c049e41bbfcdc92bea0d1ee4fb965f4e332da4cca9f10352f5cf18e05345a843d19b6111510f55c88aa97f4e21585bf66b479b7ae2f9bc
-  data.tar.gz: 07f0432c69395be2933f152acb09c8fa4fe43be104011df237b0b4db56073b4725eb3fa3073872376f09d072ea15608f79a32b3dc28104ba18665082ad64adf4
+  metadata.gz: 8cc76b2d418c6d9025aeede974085a8beb6e24d960a7dc01890ab8233081c99b3bf929411f7605f47f8adeaac034760f74bdb7d10e186dd2ba9b6200e3e5e24e
+  data.tar.gz: e0b6469801595ed80c059a73af86e6fc8d5092666af399d64cec4fc0e7bc0b4fd1a6f0547767540e680050a56c10afbe36388a01a44bb81745e1c57ef6a99954

data/.gitignore

@@ -2,6 +2,7 @@
 .ruby-version
 tags
 Gemfile.lock
+gemfiles/*.lock
 *.swp
 dump.rdb
 .rbx
@@ -11,3 +12,4 @@ vendor/
 .sass-cache/
 tmp/
 pkg/*.gem
+.byebug_history

data/.travis.yml

@@ -4,11 +4,14 @@ cache: bundler
 services:
   - redis-server
 before_install:
-  - gem install bundler
-  - gem update bundler
+  - gem update --system
+gemfile:
+  - gemfiles/rails_4.gemfile
+  - gemfiles/rails_5.gemfile
+bundler_args: --without development load_test
 rvm:
-  - 2.2.10
   - 2.3.7
   - 2.4.4
   - 2.5.1
-  - jruby-9.1.17.0
+  - 2.6.0
+  - jruby

data/Appraisals

@@ -0,0 +1,9 @@
+appraise "rails-4" do
+  gem "rails", "~> 4.2"
+  gem 'activerecord-jdbcsqlite3-adapter', '< 50', platforms: :jruby
+end
+
+appraise "rails-5" do
+  gem "rails", "~> 5.2"
+  gem 'activerecord-jdbcsqlite3-adapter', '>= 50', platforms: :jruby
+end

data/Changes.md

@@ -2,6 +2,13 @@
 
 [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.2.4
+---------
+
+- Add warnings for various deprecations and changes coming in Sidekiq 6.0.
+  See the 6-0 branch. [#4056]
+- Various improvements to the Sidekiq test suite and coverage [#4026, #4039, Tensho]
+
 5.2.3
 ---------
 

data/Ent-Changes.md

@@ -4,9 +4,10 @@
 
 Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how to buy.
 
-HEAD
+1.7.2
 -------------
 
+- Add PT and JA 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.
 - Fix elapsed time calculations to use monotonic clock [#4000, sj26]
 - Fix edge case where flapping leadership would cause old periodic
   jobs to be fired once [#3974]

data/Gemfile

@@ -1,14 +1,29 @@
 source 'https://rubygems.org'
+
 gemspec
 
-# load testing
-#gem "hiredis"
-#gem 'toxiproxy'
+gem 'rake'
+gem 'redis-namespace'
+gem 'rails', '~> 5.2'
+gem 'sqlite3', platforms: :ruby
+gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+
+group :development do
+  gem 'appraisal'
+end
 
 group :test do
-  gem 'rails', '>= 5.0.1'
   gem 'minitest'
-  gem 'rake'
-  gem 'redis-namespace'
+  gem 'minitest-focus'
+  gem 'minitest-reporters'
   gem 'simplecov'
 end
+
+group :development, :test do
+  gem 'pry-byebug', platforms: :mri
+end
+
+group :load_test do
+  gem 'hiredis'
+  gem 'toxiproxy'
+end

data/Pro-Changes.md

@@ -7,7 +7,8 @@ Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how t
 HEAD
 ---------
 
-- Add Japanese and Russian translations, see [issue #3951](https://github.com/mperham/sidekiq/issues/3951) to add your own language
+- Better handling of invalid job JSON by reliable scheduler [#4053]
+- Added ZH, PT, JA and RU 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.
 
 4.0.4
 ---------

data/Rakefile

@@ -1,8 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+
 Rake::TestTask.new(:test) do |test|
   test.warning = true
   test.pattern = 'test/**/test_*.rb'
 end
 
-task :default => :test
+task default: :test

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,31 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "redis-namespace"
+gem "rails", "~> 4.2"
+gem "sqlite3", platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", "< 50", platforms: :jruby
+
+group :development do
+  gem "appraisal"
+end
+
+group :test do
+  gem "minitest"
+  gem "minitest-focus"
+  gem "minitest-reporters"
+  gem "simplecov"
+end
+
+group :development, :test do
+  gem "pry-byebug", platforms: :mri
+end
+
+group :load_test do
+  gem "hiredis"
+  gem "toxiproxy"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,31 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "redis-namespace"
+gem "rails", "~> 5.2"
+gem "sqlite3", platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", ">= 50", platforms: :jruby
+
+group :development do
+  gem "appraisal"
+end
+
+group :test do
+  gem "minitest"
+  gem "minitest-focus"
+  gem "minitest-reporters"
+  gem "simplecov"
+end
+
+group :development, :test do
+  gem "pry-byebug", platforms: :mri
+end
+
+group :load_test do
+  gem "hiredis"
+  gem "toxiproxy"
+end
+
+gemspec path: "../"

data/lib/sidekiq.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'sidekiq/version'
 fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.2.2." if RUBY_PLATFORM != 'java' && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
 
@@ -56,6 +57,7 @@ module Sidekiq
   def self.options
     @options ||= DEFAULTS.dup
   end
+
   def self.options=(opts)
     @options = opts
   end

data/lib/sidekiq/cli.rb

@@ -9,6 +9,7 @@ require 'fileutils'
 
 require 'sidekiq'
 require 'sidekiq/util'
+require 'sidekiq/launcher'
 
 module Sidekiq
   class CLI
@@ -23,23 +24,13 @@ module Sidekiq
       proc { |me, data| "stopping" if me.stopping? },
     ]
 
-    # Used for CLI testing
-    attr_accessor :code
     attr_accessor :launcher
     attr_accessor :environment
 
-    def initialize
-      @code = nil
-    end
-
-    def parse(args=ARGV)
-      @code = nil
-
+    def parse(args = ARGV)
       setup_options(args)
       initialize_logger
       validate!
-      daemonize
-      write_pid
     end
 
     def jruby?
@@ -50,8 +41,10 @@ module Sidekiq
     # global process state irreversibly.  PRs which improve the
     # test coverage of Sidekiq::CLI are welcomed.
     def run
+      daemonize if options[:daemon]
+      write_pid
       boot_system
-      print_banner
+      print_banner if environment == 'development' && $stdout.tty?
 
       self_read, self_write = IO.pipe
       sigs = %w(INT TERM TTIN TSTP)
@@ -79,6 +72,7 @@ module Sidekiq
       # fire startup and start multithreading.
       ver = Sidekiq.redis_info['redis_version']
       raise "You are using Redis v#{ver}, Sidekiq requires Redis v2.8.0 or greater" if ver < '2.8'
+      logger.warn "Sidekiq 6.0 will require Redis 4.0+, you are using Redis v#{ver}" if ver < '4'
 
       # Since the user can pass us a connection pool explicitly in the initializer, we
       # need to verify the size is large enough or else Sidekiq's performance is dramatically slowed.
@@ -99,11 +93,14 @@ module Sidekiq
       logger.debug { "Client Middleware: #{Sidekiq.client_middleware.map(&:klass).join(', ')}" }
       logger.debug { "Server Middleware: #{Sidekiq.server_middleware.map(&:klass).join(', ')}" }
 
+      launch(self_read)
+    end
+
+    def launch(self_read)
       if !options[:daemon]
         logger.info 'Starting processing, hit Ctrl-C to stop'
       end
 
-      require 'sidekiq/launcher'
       @launcher = Sidekiq::Launcher.new(options)
 
       begin
@@ -185,23 +182,15 @@ module Sidekiq
     private
 
     def print_banner
-      # Print logo and banner for development
-      if environment == 'development' && $stdout.tty?
-        puts "\e[#{31}m"
-        puts Sidekiq::CLI.banner
-        puts "\e[0m"
-      end
+      puts "\e[#{31}m"
+      puts Sidekiq::CLI.banner
+      puts "\e[0m"
     end
 
     def daemonize
-      return unless options[:daemon]
-
       raise ArgumentError, "You really should set a logfile if you're going to daemonize" unless options[:logfile]
-      files_to_reopen = []
-      ObjectSpace.each_object(File) do |file|
-        files_to_reopen << file unless file.closed?
-      end
 
+      files_to_reopen = ObjectSpace.each_object(File).reject { |f| f.closed? }
       ::Process.daemon(true, true)
 
       files_to_reopen.each do |file|
@@ -239,15 +228,33 @@ module Sidekiq
     alias_method :☠, :exit
 
     def setup_options(args)
+      # parse CLI options
       opts = parse_options(args)
+
       set_environment opts[:environment]
 
-      cfile = opts[:config_file]
-      opts = parse_config(cfile).merge(opts) if cfile
+      # check config file presence
+      if opts[:config_file]
+        if opts[:config_file] && !File.exist?(opts[:config_file])
+          raise ArgumentError, "No such file #{opts[:config_file]}"
+        end
+      else
+        if opts[:require] && File.directory?(opts[:require])
+          %w[config/sidekiq.yml config/sidekiq.yml.erb].each do |filename|
+            path = File.expand_path(filename, opts[:require])
+            opts[:config_file] ||= path if File.exist?(path)
+          end
+        end
+      end
+
+      # parse config file options
+      opts = parse_config(opts[:config_file]).merge(opts) if opts[:config_file]
 
+      opts[:queues] = Array(opts[:queues]) << 'default' if opts[:queues].nil? || opts[:queues].empty?
       opts[:strict] = true if opts[:strict].nil?
-      opts[:concurrency] = Integer(ENV["RAILS_MAX_THREADS"]) if !opts[:concurrency] && ENV["RAILS_MAX_THREADS"]
+      opts[:concurrency] = Integer(ENV["RAILS_MAX_THREADS"]) if opts[:concurrency].nil? && ENV["RAILS_MAX_THREADS"]
 
+      # merge with defaults
       options.merge!(opts)
     end
 
@@ -258,8 +265,6 @@ module Sidekiq
     def boot_system
       ENV['RACK_ENV'] = ENV['RAILS_ENV'] = environment
 
-      raise ArgumentError, "#{options[:require]} does not exist" unless File.exist?(options[:require])
-
       if File.directory?(options[:require])
         require 'rails'
         if ::Rails::VERSION::MAJOR < 4
@@ -279,10 +284,7 @@ module Sidekiq
         end
         options[:tag] ||= default_tag
       else
-        not_required_message = "#{options[:require]} was not required, you should use an explicit path: " +
-            "./#{options[:require]} or /path/to/#{options[:require]}"
-
-        require(options[:require]) || raise(ArgumentError, not_required_message)
+        require options[:require]
       end
     end
 
@@ -298,8 +300,6 @@ module Sidekiq
     end
 
     def validate!
-      options[:queues] << 'default' if options[:queues].empty?
-
       if !File.exist?(options[:require]) ||
          (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
         logger.info "=================================================================="
@@ -325,6 +325,7 @@ module Sidekiq
 
         o.on '-d', '--daemon', "Daemonize process" do |arg|
           opts[:daemon] = arg
+          puts "WARNING: Daemonization mode will be removed in Sidekiq 6.0, see #4045. Please use a proper process supervisor to start and manage your services"
         end
 
         o.on '-e', '--environment ENV', "Application environment" do |arg|
@@ -364,10 +365,12 @@ module Sidekiq
 
         o.on '-L', '--logfile PATH', "path to writable logfile" do |arg|
           opts[:logfile] = arg
+          puts "WARNING: Logfile redirection will be removed in Sidekiq 6.0, see #4045. Sidekiq will only log to STDOUT"
         end
 
         o.on '-P', '--pidfile PATH', "path to pidfile" do |arg|
           opts[:pidfile] = arg
+          puts "WARNING: PID file creation will be removed in Sidekiq 6.0, see #4045. Please use a proper process supervisor to start and manage your services"
         end
 
         o.on '-V', '--version', "Print version and exit" do |arg|
@@ -381,11 +384,8 @@ module Sidekiq
         logger.info @parser
         die 1
       end
-      @parser.parse!(argv)
 
-      %w[config/sidekiq.yml config/sidekiq.yml.erb].each do |filename|
-        opts[:config_file] ||= filename if File.exist?(filename)
-      end
+      @parser.parse!(argv)
 
       opts
     end
@@ -405,23 +405,18 @@ module Sidekiq
       end
     end
 
-    def parse_config(cfile)
-      opts = {}
-      if File.exist?(cfile)
-        opts = YAML.load(ERB.new(IO.read(cfile)).result) || opts
+    def parse_config(path)
+      opts = YAML.load(ERB.new(File.read(path)).result) || {}
 
-        if opts.respond_to? :deep_symbolize_keys!
-          opts.deep_symbolize_keys!
-        else
-          symbolize_keys_deep!(opts)
-        end
-
-        opts = opts.merge(opts.delete(environment.to_sym) || {})
-        parse_queues(opts, opts.delete(:queues) || [])
+      if opts.respond_to? :deep_symbolize_keys!
+        opts.deep_symbolize_keys!
       else
-        # allow a non-existent config file so Sidekiq
-        # can be deployed by cap with just the defaults.
+        symbolize_keys_deep!(opts)
       end
+
+      opts = opts.merge(opts.delete(environment.to_sym) || {})
+      parse_queues(opts, opts.delete(:queues) || [])
+
       ns = opts.delete(:namespace)
       if ns
         # logger hasn't been initialized yet, puts is all we have.
@@ -435,10 +430,10 @@ module Sidekiq
       queues_and_weights.each { |queue_and_weight| parse_queue(opts, *queue_and_weight) }
     end
 
-    def parse_queue(opts, q, weight=nil)
+    def parse_queue(opts, queue, weight = nil)
       opts[:queues] ||= []
-      raise ArgumentError, "queues: #{q} cannot be defined twice" if opts[:queues].include?(q)
-      [weight.to_i, 1].max.times { opts[:queues] << q }
+      raise ArgumentError, "queues: #{queue} cannot be defined twice" if opts[:queues].include?(queue)
+      [weight.to_i, 1].max.times { opts[:queues] << queue }
       opts[:strict] = false if weight.to_i > 0
     end
   end

data/lib/sidekiq/rails.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Sidekiq
   class Rails < ::Rails::Engine
     # We need to setup this up before any application configuration which might
@@ -54,4 +55,4 @@ if defined?(::Rails) && ::Rails::VERSION::MAJOR < 4
   $stderr.puts("**************************************************")
   $stderr.puts("⛔️ WARNING: Sidekiq server is no longer supported by Rails 3.2 - please ensure your server/workers are updated")
   $stderr.puts("**************************************************")
-end
+end

data/lib/sidekiq/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sidekiq
-  VERSION = "5.2.3"
+  VERSION = "5.2.4"
 end

data/lib/sidekiq/web/application.rb

@@ -17,7 +17,7 @@ module Sidekiq
       "manifest-src 'self'",
       "media-src 'self'",
       "object-src 'none'",
-      "script-src 'self' https: http:",
+      "script-src 'self' https: http: 'unsafe-inline'",
       "style-src 'self' https: http: 'unsafe-inline'",
       "worker-src 'self'",
       "base-uri 'self'"

data/lib/sidekiq/worker.rb

@@ -7,13 +7,13 @@ module Sidekiq
   # Include this module in your worker class and you can easily create
   # asynchronous jobs:
   #
-  # class HardWorker
-  #   include Sidekiq::Worker
+  #   class HardWorker
+  #     include Sidekiq::Worker
   #
-  #   def perform(*args)
-  #     # do some work
+  #     def perform(*args)
+  #       # do some work
+  #     end
   #   end
-  # end
   #
   # Then in your Rails app, you can do this:
   #

data/sidekiq.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/sidekiq/version', __FILE__)
+require_relative 'lib/sidekiq/version'
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Mike Perham"]
@@ -11,13 +10,12 @@ Gem::Specification.new do |gem|
 
   gem.executables   = ['sidekiq', 'sidekiqctl']
   gem.files         = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
-  gem.test_files    = []
   gem.name          = "sidekiq"
-  gem.require_paths = ["lib"]
   gem.version       = Sidekiq::VERSION
   gem.required_ruby_version = ">= 2.2.2"
 
   gem.add_dependency 'redis', '>= 3.3.5', '< 5'
   gem.add_dependency 'connection_pool', '~> 2.2', '>= 2.2.2'
+  gem.add_dependency 'rack', '>= 1.5.0'
   gem.add_dependency 'rack-protection', '>= 1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 5.2.3
+  version: 5.2.4
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -50,6 +50,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rack-protection
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,7 @@ files:
 - 3.0-Upgrade.md
 - 4.0-Upgrade.md
 - 5.0-Upgrade.md
+- Appraisals
 - COMM-LICENSE
 - Changes.md
 - Ent-Changes.md
@@ -95,6 +110,8 @@ files:
 - bin/sidekiqctl
 - bin/sidekiqload
 - code_of_conduct.md
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_5.gemfile
 - lib/generators/sidekiq/templates/worker.rb.erb
 - lib/generators/sidekiq/templates/worker_spec.rb.erb
 - lib/generators/sidekiq/templates/worker_test.rb.erb
@@ -208,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple, efficient background processing for Ruby