sidekiq-unique-jobs 4.0.17 → 4.0.18

data/rails_example/config/environments/test.rb

@@ -12,9 +12,11 @@ Rails.application.configure do
   # preloads Rails for running tests, you may have to set it to true.
   config.eager_load = false
 
-  # Configure static file server for tests with Cache-Control for performance.
-  config.serve_static_files   = true
-  config.static_cache_control = 'public, max-age=3600'
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => 'public, max-age=3600'
+  }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
@@ -25,15 +27,13 @@ Rails.application.configure do
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
+  config.action_mailer.perform_caching = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
 
-  # Randomize the order test cases are executed.
-  config.active_support.test_order = :random
-
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 

data/rails_example/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,6 @@
+# Be sure to restart your server when you modify this file.
+
+# ApplicationController.renderer.defaults.merge!(
+#   http_host: 'example.org',
+#   https: false
+# )

data/rails_example/config/initializers/backtrace_silencers.rb

@@ -3,6 +3,7 @@
 # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
 # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
 
-# You can also remove all the silencers if you're trying to debug a problem that might
-#   stem from framework code.
+# You can also remove all the silencers
+#   if you're trying to debug a problem that might stem
+#   from framework code.
 # Rails.backtrace_cleaner.remove_silencers!

data/rails_example/config/initializers/cookies_serializer.rb

@@ -1,3 +1,5 @@
 # Be sure to restart your server when you modify this file.
 
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
 Rails.application.config.action_dispatch.cookies_serializer = :json

data/rails_example/config/initializers/new_framework_defaults.rb

@@ -0,0 +1,23 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains migration options to ease your Rails 5.0 upgrade.
+#
+# Once upgraded flip defaults one by one to migrate to the new default.
+#
+# Read the Rails 5.0 release notes for more info on each option.
+
+# Enable per-form CSRF tokens. Previous versions had false.
+Rails.application.config.action_controller.per_form_csrf_tokens = false
+
+# Enable origin-checking CSRF mitigation. Previous versions had false.
+Rails.application.config.action_controller.forgery_protection_origin_check = false
+
+# Make Ruby 2.4 preserve the timezone of the receiver when calling `to_time`.
+# Previous versions had false.
+ActiveSupport.to_time_preserves_timezone = false
+
+# Require `belongs_to` associations by default. Previous versions had false.
+Rails.application.config.active_record.belongs_to_required_by_default = false
+
+# Do not halt callback chains when a callback returns false. Previous versions had true.
+ActiveSupport.halt_callback_chains_on_return_false = true

data/rails_example/config/initializers/session_store.rb

@@ -1,3 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.session_store :cookie_store, key: '_sidekiq-unique-job-app_session'
+Rails.application.config.session_store :cookie_store, key: '_rails_example_session'

data/rails_example/config/initializers/sidekiq.rb

@@ -4,10 +4,10 @@ Sidekiq.default_worker_options = {
 }
 
 Sidekiq.configure_server do |config|
-  config.redis = { url: ENV['REDIS_URL'], namespace: "rails_example_#{Rails.env}" }
+  config.redis = { url: ENV['REDIS_URL'] }
   # config.error_handlers << Proc.new { |ex, context| Airbrake.notify_or_ignore(ex, parameters: context) }
 end
 
 Sidekiq.configure_client do |config|
-  config.redis = { url: ENV['REDIS_URL'], namespace: "rails_example_#{Rails.env}" }
+  config.redis = { url: ENV['REDIS_URL'] }
 end

data/rails_example/config/initializers/wrap_parameters.rb

@@ -5,10 +5,10 @@
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+  wrap_parameters format: [:json]
 end
 
 # To enable root element in JSON for ActiveRecord objects.
 # ActiveSupport.on_load(:active_record) do
-#  self.include_root_in_json = true
+#   self.include_root_in_json = true
 # end

data/rails_example/config/puma.rb

@@ -0,0 +1,38 @@
+threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }.to_i
+threads threads_count, threads_count
+port ENV.fetch('PORT') { 3000 }
+environment ENV.fetch('RAILS_ENV') { 'development' }
+# daemonize false
+
+# Store the pid of the server in the file at "path".
+#
+# pidfile '/u/apps/lolcat/tmp/pids/puma.pid'
+
+# Use "path" as the file to store the server info state. This is
+# used by "pumactl" to query and control the server.
+#
+# state_path '/u/apps/lolcat/tmp/pids/puma.state'
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+# preload_app!
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted this block will be run, if you are using `preload_app!`
+# option you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+
+# Allow puma to be restarted by `rails restart` command.
+# plugin :tmp_restart

data/rails_example/config/routes.rb

@@ -1,5 +1,6 @@
 Rails.application.routes.draw do
   require 'sidekiq/web'
   mount Sidekiq::Web, at: '/sidekiq'
-  get 'work/duplicate' => 'work#duplicate'
+  get 'work/duplicate_simple' => 'work#duplicate_simple'
+  get 'work/duplicate_nested' => 'work#duplicate_nested'
 end

data/rails_example/config/secrets.yml

@@ -5,16 +5,16 @@
 
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-# You can use `rake secret` to generate a secure secret key.
+# You can use `rails secret` to generate a secure secret key.
 
 # Make sure the secrets in this file are kept private
 # if you're sharing your code publicly.
 
 development:
-  secret_key_base: 90a782880015a9365614d023fd9a63939efe09ee0655897998847938e08f800685ed8da5aa230f45452387369300f31da50527728bbeba12d2d01f209d83621b
+  secret_key_base: f5771482e38ac985be78a1668b8a155f3be99b707cea923e7f0e55a649f78bb2e9debd08f49f57ba2f3da4ffcfc73a18bd43054e0f704c2513735e57cf612cf0
 
 test:
-  secret_key_base: 9a7b9f197e9c309c5f34669b6c829ca8b22d9e738499852ee0dad7f20becb23cb095eff5a8eb7c955ed182be5626e67de7e1aa1007c40eba55ebd30b61c78388
+  secret_key_base: cb65c5fd20b500e74f0971e1f2eb440c9965e16ff469542ed2077b523c4eeb2fd890a5aae8dc063fba7ef97c5a5a65fdfa5fddea5b8f650916719abcd83861e0
 
 # Do not keep production secrets in the repository,
 # instead read values from the environment.

data/rails_example/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/rails_example/db/migrate/20160724111322_create_posts.rb

@@ -0,0 +1,12 @@
+class CreatePosts < ActiveRecord::Migration[5.0]
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+      t.string :excerpt
+      t.integer :read_count
+
+      t.timestamps
+    end
+  end
+end

data/rails_example/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -11,10 +10,15 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20_151_107_231_835) do
+ActiveRecord::Schema.define(version: 20_160_724_111_322) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension 'plpgsql'
+
   create_table 'posts', force: :cascade do |t|
-    t.string 'title'
-    t.text 'body'
+    t.string   'title'
+    t.text     'body'
+    t.string   'excerpt'
+    t.integer  'read_count'
     t.datetime 'created_at', null: false
     t.datetime 'updated_at', null: false
   end

data/rails_example/dev-entrypoint.sh

@@ -0,0 +1,55 @@
+#! /bin/bash
+
+# The Docker App Container's development entrypoint.
+# This is a script used by the project's Docker development environment to
+# setup the app containers and databases upon runnning.
+set -e
+
+: ${APP_PATH:="/usr/src/app"}
+: ${APP_TEMP_PATH:="$APP_PATH/tmp"}
+: ${APP_SETUP_LOCK:="$APP_TEMP_PATH/setup.lock"}
+: ${APP_SETUP_WAIT:="5"}
+
+# 1: Define the functions lock and unlock our app containers setup processes:
+function lock_setup { mkdir -p $APP_TEMP_PATH && touch $APP_SETUP_LOCK; }
+function unlock_setup { rm -rf $APP_SETUP_LOCK; }
+function wait_setup { echo "Waiting for app setup to finish..."; sleep $APP_SETUP_WAIT; }
+
+# 2: 'Unlock' the setup process if the script exits prematurely:
+trap unlock_setup HUP INT QUIT KILL TERM EXIT
+
+# 3: Wait until the setup 'lock' file no longer exists:
+while [ -f $APP_SETUP_LOCK ]; do wait_setup; done
+
+# 4: 'Lock' the setup process, to prevent a race condition when the project's
+# app containers will try to install gems and setup the database concurrently:
+lock_setup
+
+# 5: Check or install the app dependencies via Bundler:
+bundle check || bundle install --jobs 8 --retry 5
+
+# 6: Check if the database exists, or setup the database if it doesn't, as it is
+# the case when the project runs for the first time.
+#
+# We'll use a custom script `check-or-setup-db` (inside our app's `bin` folder),
+# instead of running `rake db:version  || rake db:setup`, as running that command
+# (at least on rails 4.2.4) will leave a couple of small ruby zombie processes
+# running in the container:
+# check_or_setup_db
+bin/rails db:version || bin/rails db:setup
+bin/rails db:migrate
+
+# 7: 'Unlock' the setup process:
+unlock_setup
+
+# 8: Specify a default command, in case it wasn't issued:
+# if [ -z "$1" ]; then set -- rails server -p 3000 -b 0.0.0.0 "$@"; fi
+
+# 9: If the command to execute is 'rails server', then force it to write the
+# pid file into a non-shared container directory. Suddenly killing and removing
+# app containers without this would leave a pidfile in the project's tmp dir,
+# preventing the app container from starting up on further attempts:
+# if [[ "$1" = "rails" && ("$2" = "s" || "$2" = "server") ]]; then set -- "$@" -P $PID_FILE; fi
+
+# 10: Execute the given or default command:
+exec "$@"

data/rails_example/dev.env

@@ -0,0 +1,12 @@
+SECRET_KEY_BASE=10167c7f7654ed02b3557b05b88ece1866a9748a2e8e064016f76cb74ddae38264f7403ba65f301d63c21d770e0ee2ac6906f245e904b3b140d12297f67e0db1
+APP_DOMAIN=localhost
+APP_WEB_URL=http://localhost:3000
+APP_CABLE_URL=ws://localhost:28080
+WEB_CONSOLE_WHITELISTED_IPS=127.0.0.1 ::1 127.0.0.0/8 ::1
+DB_HOST=postgres
+DB_PORT=5432
+DB_USERNAME=postgres
+DB_PASSWORD=3x4mpl3
+DB_POOL=25
+DB_TIMEOUT=5000
+DB_REAPING_FREQUENCY=10

data/rails_example/docker-compose.yml

@@ -0,0 +1,90 @@
+version: '2'
+volumes:
+  postgres-data:
+    driver: local
+  redis-data:
+    driver: local
+  gems:
+    driver: local
+
+networks:
+  front-tier:
+    driver: bridge
+  back-tier:
+    driver: bridge
+
+services:
+  jobs: &app
+    extends:
+      file: common-services.yml
+      service: rails
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec sidekiq -c 25
+    networks:
+      - back-tier
+    depends_on:
+      - postgres
+      - redis
+
+  web:
+    extends:
+      file: common-services.yml
+      service: rails
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec puma --bind tcp://0.0.0.0:3000
+    ports:
+      - 3000:3000
+    networks:
+      - front-tier
+      - back-tier
+    depends_on:
+      - postgres
+      - redis
+
+  cable:
+    extends:
+      file: common-services.yml
+      service: rails
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec puma --bind tcp://0.0.0.0:28080 cable.ru
+    ports:
+      - 28080:28080
+    networks:
+      - front-tier
+      - back-tier
+    depends_on:
+      - postgres
+      - redis
+
+  redis:
+    image: redis
+    ports:
+      # We'll bind our host's port 6379 to redis's port 6379, so we can use
+      # Redis Desktop Manager (or other tools) with it:
+      - 6379:6379
+    volumes:
+      # We'll store the redis data in the 'redis-data' volume we defined:
+      - redis-data:/var/lib/redis
+    command: redis-server --appendonly yes
+    # Make the redis service available only on the "back-tier" network:
+    # NOTE: See networks comment on the postgres service above.
+    networks: [ "back-tier" ]
+
+
+  postgres:
+    image: postgres
+    ports:
+      # We'll bind our host's port 5432 to postgres's port 5432, so we can use
+            # our database IDEs with it:
+      - 5432:5432
+    volumes:
+      # We'll store the postgres data in the 'postgres-data' volume we defined:
+      - postgres-data:/var/lib/postgresql/data
+    networks:
+      # Make the database service available only on the "back-tier" network:
+      # NOTE: Although the service is available only on the "back-tier" network,
+      # the host-to-container port binding we've defined for development
+      # purposes will allow connection from the development host.
+      - back-tier
+    environment:
+      POSTGRES_PASSWORD: 3x4mpl3

data/rails_example/docker/rails.Dockerfile

@@ -0,0 +1,27 @@
+FROM ruby:2.3
+MAINTAINER Mika Hel <mikael@zoolutions.se>
+
+# ENV BUILD_PACKAGES bash curl-dev ruby-dev build-base git libc-dev linux-headers
+# ENV RUBY_PACKAGES ruby ruby-io-console openssl-dev postgresql-dev ruby-bundler libxml2-dev libxslt-dev
+
+# RUN apk update \
+#     && apk upgrade \
+#     && apk add $BUILD_PACKAGES \
+#     && apk add $RUBY_PACKAGES \
+#     && rm -rf /var/cache/apk/* \
+#     && mkdir -p /usr/src/app \
+#     && bundle config --global jobs 8
+
+# WORKDIR /usr/src/app
+
+# COPY Gemfile /usr/src/app/
+# COPY Gemfile.lock /usr/src/app/
+
+# ENV BUNDLE_GEMFILE /usr/src/app/Gemfile
+# ENV BUNDLE_JOBS 8
+# ENV BUNDLE_RETRY 5
+# ENV BUNDLE_PATH /usr/local/bundle
+
+# RUN bundle install --jobs 8 --retry 5
+
+# COPY . /usr/src/app

data/rails_example/spec/controllers/work_controller_spec.rb

@@ -0,0 +1,172 @@
+require 'rails_helper'
+
+describe WorkController do
+  context 'with real redis' do
+    before(:each) do
+      SidekiqUniqueJobs.configure do |config|
+        config.redis_test_mode = :redis
+      end
+
+      Sidekiq::Queues.clear_all
+      Sidekiq.redis(&:flushdb)
+      Sidekiq.redis do |c|
+        c.keys.each do |key|
+          c.del(key)
+        end
+      end
+    end
+
+    describe 'GET /work/duplicate_simple' do
+      context 'when test mode is fake', sidekiq: :fake do
+        specify do
+          expect { get :duplicate_simple }
+            .to change { SimpleWorker.jobs.size }
+            .from(0)
+            .to(1)
+        end
+      end
+
+      context 'when test mode is disabled', sidekiq: :disable do
+        specify do
+          get :duplicate_simple
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(1)
+            expect(c.keys).to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+
+      context 'when test mode is inline', sidekiq: :inline do
+        specify do
+          get :duplicate_simple
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(0)
+            expect(c.keys).not_to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+    end
+
+    describe 'GET /work/duplicate_nested' do
+      context 'when test mode is fake', sidekiq: :fake do
+        specify do
+          expect { get :duplicate_nested }
+            .to change { SpawnSimpleWorker.jobs.size }
+            .from(0)
+            .to(4)
+
+          SpawnSimpleWorker.perform_one
+          SpawnSimpleWorker.perform_one
+          expect(SpawnSimpleWorker.jobs.size).to eq(2)
+          expect(SimpleWorker.jobs.size).to eq(1)
+        end
+      end
+
+      context 'when test mode is disabled', sidekiq: :disable do
+        specify do
+          get :duplicate_nested
+
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(4)
+            expect(c.keys).not_to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+
+      context 'when test mode is inline', sidekiq: :inline do
+        specify do
+          get :duplicate_nested
+
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(0)
+            expect(c.keys).not_to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+    end
+  end
+
+  context 'with mock_redis' do
+    before do
+      SidekiqUniqueJobs.configure do |config|
+        config.redis_test_mode = :mock
+      end
+      Sidekiq::Queues.clear_all
+      Sidekiq::Worker.clear_all
+
+      MOCK_REDIS.keys.each do |key|
+        MOCK_REDIS.del(key)
+      end
+      allow(Redis).to receive(:new).and_return(MOCK_REDIS)
+    end
+
+    describe 'GET /work/duplicate_simple' do
+      context 'when test mode is fake', sidekiq: :fake do
+        specify do
+          expect { get :duplicate_simple }
+            .to change { SimpleWorker.jobs.size }
+            .from(0)
+            .to(1)
+        end
+      end
+
+      context 'when test mode is disabled', sidekiq: :disable do
+        specify do
+          get :duplicate_simple
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(1)
+            expect(c.keys).to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+
+      context 'when test mode is inline', sidekiq: :inline do
+        specify do
+          get :duplicate_simple
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(0)
+            expect(c.keys).not_to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+    end
+
+    describe 'GET /work/duplicate_nested' do
+      context 'when test mode is fake', sidekiq: :fake do
+        specify do
+          expect { get :duplicate_nested }
+            .to change { SpawnSimpleWorker.jobs.size }
+            .from(0)
+            .to(4)
+
+          SpawnSimpleWorker.perform_one
+          SpawnSimpleWorker.perform_one
+          expect(SpawnSimpleWorker.jobs.size).to eq(2)
+          expect(SimpleWorker.jobs.size).to eq(1)
+        end
+      end
+
+      context 'when test mode is disabled', sidekiq: :disable do
+        specify do
+          get :duplicate_nested
+
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(4)
+            expect(c.keys).not_to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+
+      context 'when test mode is inline', sidekiq: :inline do
+        specify do
+          get :duplicate_nested
+
+          Sidekiq.redis do |c|
+            expect(c.llen('queue:default')).to eq(0)
+            expect(c.keys).not_to include('uniquejobs:83bda9f47b05071ffcb35cbb59e1fada')
+          end
+        end
+      end
+    end
+  end
+end