shoryuken 5.3.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1002845b2232c5f7491b2839d7851be5afdb79a3a11e73e2249b81e1f2ea4ec4
-  data.tar.gz: 8398fa557fba47360763bb83ea4e0f529b2c69bad8b15fb3163e03c517b460d8
+  metadata.gz: ba3ab903a9490d367ced7d0d70cb3f3aae142abc17dc466f2248b64ee5566773
+  data.tar.gz: e3f84b09a3e3a888ba280ade138fc8b9c902a0d39d27188ac6e6576a19a6e482
 SHA512:
-  metadata.gz: 010d2f45fe45e6967435b57c1f0c7601f9d3a43a8c1108edbf97b303e60e108e0c6be1ba28915a43bc84f5904bd7f3d634916251b8b1c0d83143d75bdccaaca7
-  data.tar.gz: 00c8f19de3a9fd241bb236023479bd5c3bd27f731001f036377c05b75c18bce119b08666eb13649606904e2950f937f52615eba84facb44074099fde1fc97534
+  metadata.gz: 7273ea2e72c35dd4c443d3376da6e787e0c3c86ee4a048700a73391e662c631e0509bd22bf7cf7016d2bfe9cf35273706037b3621fc4cd5c6c2b19c7a39bb727
+  data.tar.gz: d08532edb206f643cf3fec6ff197efc84768871f90a7ef185ebc1030f5027b8dd333642036a601e8884225a750cd4666bfbc349cb7f2a576a0f2e8fc9d0ece48

data/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.1, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.1-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.1-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/base.Dockerfile

@@ -0,0 +1,43 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.1, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.1-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.1-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM ruby:${VARIANT}
+
+# Copy library scripts to execute
+COPY library-scripts/*.sh library-scripts/*.env /tmp/library-scripts/
+
+# [Option] Install zsh
+ARG INSTALL_ZSH="true"
+# [Option] Upgrade OS packages to their latest versions
+ARG UPGRADE_PACKAGES="true"
+# Install needed packages and setup non-root user. Use a separate RUN statement to add your own dependencies.
+ARG USERNAME=vscode
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    # Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
+    && apt-get purge -y imagemagick imagemagick-6-common \
+    # Install common packages, non-root user, rvm, core build tools
+    && bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" "true" "true" \
+    && bash /tmp/library-scripts/ruby-debian.sh "none" "${USERNAME}" "true" "true" \
+    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+ENV NVM_DIR=/usr/local/share/nvm
+ENV NVM_SYMLINK_CURRENT=true \
+    PATH=${NVM_DIR}/current/bin:${PATH}
+RUN bash /tmp/library-scripts/node-debian.sh "${NVM_DIR}" "${NODE_VERSION}" "${USERNAME}" \
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+ # Remove library scripts for final image
+RUN rm -rf /tmp/library-scripts
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.3/containers/ruby
+{
+  "name": "Ruby",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "args": {
+      // Update 'VARIANT' to pick a Ruby version: 3, 3.1, 3.0, 2, 2.7, 2.6
+      // Append -bullseye or -buster to pin to an OS version.
+      // Use -bullseye variants on local on arm64/Apple Silicon.
+      "VARIANT": "3-bullseye",
+      // Options
+      "NODE_VERSION": "none"
+    }
+  },
+
+  // Set *default* container specific settings.json values on container create.
+  "settings": {},
+
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": ["rebornix.Ruby"],
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "ruby --version",
+
+  // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode",
+  "features": {
+    "github-cli": "latest",
+    "aws-cli": "latest"
+  }
+}

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/specs.yml

@@ -9,7 +9,7 @@ jobs:
     name: All Specs
     strategy:
       matrix:
-        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
         gemfile: ['Gemfile', 'gemfiles/aws_sdk_core_2.gemfile']
     runs-on: ubuntu-20.04
     services:
@@ -34,7 +34,7 @@ jobs:
     name: Rails Specs
     strategy:
       matrix:
-        rails: ['4.2', '5.2', '6.0', '6.1']
+        rails: ['4.2', '5.2', '6.0', '6.1', '7.0']
         include:
           - rails: '4.2'
             ruby: '2.2'
@@ -48,6 +48,9 @@ jobs:
           - rails: '6.1'
             ruby: '3.0'
             gemfile: gemfiles/rails_6_1.gemfile
+          - rails: '7.0'
+            ruby: '3.1'
+            gemfile: gemfiles/rails_7_0.gemfile
     runs-on: ubuntu-20.04
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}

data/.github/workflows/stale.yml

@@ -0,0 +1,20 @@
+name: "Close stale issues and PRs"
+on:
+  schedule:
+    - cron: "30 1 * * *" # At 01:30 - https://crontab.guru/#30_1_*_*_*
+  workflow_dispatch: {}
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v8
+        with:
+          stale-issue-message: This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon.
+          stale-pr-message: This PR is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon.
+          close-issue-message: This issue was closed because it hasn't seen activity for a while.
+          close-pr-message: This PR was closed because it hasn't seen activity for a while.
+          days-before-stale: 60
+          days-before-close: 7

data/Appraisals

@@ -34,3 +34,9 @@ appraise 'rails_6_1' do
     gem 'activejob', '~> 6.1'
   end
 end
+
+appraise 'rails_7_0' do
+  group :test do
+    gem 'activejob', '~> 7.0'
+  end
+end

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## [v6.1.0] - 2023-11-01
+
+- Add GitHub Codespaces
+  - [#698](https://github.com/ruby-shoryuken/shoryuken/pull/698)
+
+- Fix spec for ruby 3.0
+  - [#727](https://github.com/ruby-shoryuken/shoryuken/pull/727)
+
+- Upgrade test matrix. Add Ruby 3.1, Ruby 3.2 and Rails 7
+  - [#739](https://github.com/ruby-shoryuken/shoryuken/pull/739)
+
+- Fire stopped event after executor is stopped
+  - [#741](https://github.com/ruby-shoryuken/shoryuken/pull/741)
+
+- Allow setup custom exception handlers for failing jobs
+  - [#742](https://github.com/ruby-shoryuken/shoryuken/pull/742)
+
+- Configure dependabot to update GH Actions
+  - [#745](https://github.com/ruby-shoryuken/shoryuken/pull/745)
+
+- Stop the dispatching of new messages when a SIGTERM signal has been received
+  - [#750](https://github.com/ruby-shoryuken/shoryuken/pull/750)
+
+## [v6.0.0] - 2022-02-18
+
+- Breaking changes: Initialize Rails before parsing config file
+  - [#686](https://github.com/ruby-shoryuken/shoryuken/pull/686)
+  - Previously, Shoryuken read its configuration from an optional YAML file, then allowed CLI arguments to override those, then initialized the Rails application (provided that `--rails` or `-R` was specified). This behavior meant that the config file did not have access to things like environment variables that were initialized by Rails (such as when using `dotenv`). With this change, Rails is initialized much earlier in the process. After Rails is initialized, the YAML configuration file is interpreted, and CLI arguments are finally interpreted last. Most applications will not need to undergo changes in order to upgrade, but the new load order could technically result in different behavior depending on the application's YAML configuration file or Rails initializers.
+
 ## [v5.3.2] - 2022-01-19
 
 - (Bugfix) Preserve queue weights when unpausing queues

data/Gemfile

@@ -15,6 +15,6 @@ end
 
 group :development do
   gem 'appraisal', git: 'https://github.com/thoughtbot/appraisal.git'
-  gem 'pry-byebug', '3.9.0'
+  gem 'pry-byebug'
   gem 'rubocop', '<= 1.12'
 end

data/README.md

@@ -1,4 +1,4 @@
-**I'm looking for Shoryuken maintainers, are you interested on helping to maintain Shoryuken? Fill up this form https://forms.gle/8kTso8ixa9Sfp6rJ9**
+**I'm looking for Shoryuken maintainers, are you interested on helping to maintain Shoryuken? [Join our Slack](https://join.slack.com/t/shoryuken/shared_invite/zt-19xjq3iqc-KmoJ6eU6~qvZNqcLzIrjww)**
 
 # Shoryuken
 
@@ -86,3 +86,21 @@ To run integration specs, start a mock SQS server on `localhost:5000`. One such
 ```sh
 bundle exec rake spec:integration
 ```
+
+### To release a new version
+
+Compare latest tag with HEAD:
+
+```sh
+git log $(git describe --tags --abbrev=0)..HEAD --oneline
+```
+
+then update CHANGELOG.md.
+
+Update version in `lib/shoryuken/version.rb` with the appropriate version number [SEMVER](https://semver.org/).
+
+then run:
+
+```sh
+bundle exec rake release
+```

data/gemfiles/aws_sdk_core_2.gemfile

@@ -14,7 +14,7 @@ end
 
 group :development do
   gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
-  gem "pry-byebug", "3.9.0"
+  gem "pry-byebug"
   gem "rubocop"
 end
 

data/gemfiles/rails_7_0.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+group :test do
+  gem "activejob", "~> 7.0"
+  gem "aws-sdk-core", "~> 3"
+  gem "aws-sdk-sqs"
+  gem "codeclimate-test-reporter", require: nil
+  gem "httparty"
+  gem "multi_xml"
+  gem "simplecov"
+end
+
+group :development do
+  gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
+  gem "rubocop"
+  gem "pry", ">= 0.14.2"
+  gem "pry-byebug", ">= 3.10.1"
+end
+
+gemspec path: "../"

data/lib/shoryuken/default_exception_handler.rb

@@ -0,0 +1,10 @@
+module Shoryuken
+  class DefaultExceptionHandler
+    extend Util
+
+    def self.call(exception, _queue, _sqs_msg)
+      logger.error { "Processor failed: #{exception.message}" }
+      logger.error { exception.backtrace.join("\n") } if exception.backtrace
+    end
+  end
+end

data/lib/shoryuken/environment_loader.rb

@@ -18,12 +18,12 @@ module Shoryuken
     end
 
     def setup_options
+      initialize_rails if load_rails?
       initialize_options
       initialize_logger
     end
 
     def load
-      load_rails if Shoryuken.options[:rails]
       prefix_active_job_queue_names
       parse_queues
       require_workers
@@ -55,7 +55,7 @@ module Shoryuken
       Shoryuken.logger.level = Logger::DEBUG if Shoryuken.options[:verbose]
     end
 
-    def load_rails
+    def initialize_rails
       # Adapted from: https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/cli.rb
 
       require 'rails'
@@ -79,6 +79,10 @@ module Shoryuken
       end
     end
 
+    def load_rails?
+      options[:rails]
+    end
+
     def prefix_active_job_queue_name(queue_name, weight)
       return [queue_name, weight] if queue_name.start_with?('https://', 'arn:')
 

data/lib/shoryuken/extensions/active_job_adapter.rb

@@ -66,8 +66,11 @@ module ActiveJob
         }
 
         if queue.fifo?
-          # See https://github.com/phstc/shoryuken/issues/457
-          msg[:message_deduplication_id] = Digest::SHA256.hexdigest(JSON.dump(body.except('job_id')))
+          # See https://github.com/ruby-shoryuken/shoryuken/issues/457 and
+          # https://github.com/ruby-shoryuken/shoryuken/pull/750#issuecomment-1781317929
+          msg[:message_deduplication_id] = Digest::SHA256.hexdigest(
+            JSON.dump(body.except('job_id', 'enqueued_at'))
+          )
         end
 
         msg.merge(job_params.except(:message_attributes))

data/lib/shoryuken/extensions/active_job_extensions.rb

@@ -11,7 +11,7 @@ module Shoryuken
       end
     end
 
-    # Initializes SQS SendMessage parameters on instances of ActiveJobe::Base
+    # Initializes SQS SendMessage parameters on instances of ActiveJob::Base
     # to the empty hash, and populates it whenever `#enqueue` is called, such
     # as when using ActiveJob::Base.set.
     module SQSSendMessageParametersSupport

data/lib/shoryuken/launcher.rb

@@ -16,11 +16,13 @@ module Shoryuken
     def stop!
       initiate_stop
 
-      executor.shutdown
+      # Don't await here so the timeout below is not delayed
+      stop_new_dispatching
 
-      return if executor.wait_for_termination(Shoryuken.options[:timeout])
+      executor.shutdown
+      executor.kill unless executor.wait_for_termination(Shoryuken.options[:timeout])
 
-      executor.kill
+      fire_event(:stopped)
     end
 
     def stop
@@ -33,6 +35,8 @@ module Shoryuken
 
       executor.shutdown
       executor.wait_for_termination
+
+      fire_event(:stopped)
     end
 
     def healthy?

data/lib/shoryuken/logging.rb

@@ -30,11 +30,11 @@ module Shoryuken
     end
 
     def self.logger
-      @logger || initialize_logger
+      @logger ||= initialize_logger
     end
 
     def self.logger=(log)
-      @logger = (log ? log : Logger.new('/dev/null'))
+      @logger = (log || Logger.new('/dev/null'))
     end
   end
 end

data/lib/shoryuken/options.rb

@@ -11,19 +11,21 @@ module Shoryuken
         dispatch: [],
         utilization_update: [],
         quiet: [],
-        shutdown: []
+        shutdown: [],
+        stopped: []
       }
     }.freeze
 
     attr_accessor :active_job_queue_name_prefixing, :cache_visibility_timeout, :groups,
                   :launcher_executor,
-                  :start_callback, :stop_callback, :worker_executor, :worker_registry
+                  :start_callback, :stop_callback, :worker_executor, :worker_registry, :exception_handlers
     attr_writer :default_worker_options, :sqs_client
     attr_reader :sqs_client_receive_message_opts
 
     def initialize
       self.groups = {}
       self.worker_registry = DefaultWorkerRegistry.new
+      self.exception_handlers = [DefaultExceptionHandler]
       self.active_job_queue_name_prefixing = false
       self.worker_executor = Worker::DefaultExecutor
       self.cache_visibility_timeout = false
@@ -134,7 +136,7 @@ module Shoryuken
     end
 
     # Register a block to run at a point in the Shoryuken lifecycle.
-    # :startup, :quiet or :shutdown are valid events.
+    # :startup, :quiet, :shutdown or :stopped are valid events.
     #
     #   Shoryuken.configure_server do |config|
     #     config.on(:shutdown) do

data/lib/shoryuken/processor.rb

@@ -22,8 +22,7 @@ module Shoryuken
         end
       end
     rescue Exception => ex
-      logger.error { "Processor failed: #{ex.message}" }
-      logger.error { ex.backtrace.join("\n") } unless ex.backtrace.nil?
+      Array(Shoryuken.exception_handlers).each { |handler| handler.call(ex, queue, sqs_msg) }
 
       raise
     end

data/lib/shoryuken/runner.rb

@@ -30,9 +30,6 @@ module Shoryuken
 
       loader = EnvironmentLoader.setup_options(options)
 
-      # When cli args exist, override options in config file
-      Shoryuken.options.merge!(options)
-
       daemonize(Shoryuken.options)
       write_pid(Shoryuken.options)
 

data/lib/shoryuken/version.rb

@@ -1,3 +1,3 @@
 module Shoryuken
-  VERSION = '5.3.2'.freeze
+  VERSION = '6.1.0'.freeze
 end

data/lib/shoryuken.rb

@@ -23,6 +23,7 @@ require 'shoryuken/worker/default_executor'
 require 'shoryuken/worker/inline_executor'
 require 'shoryuken/worker_registry'
 require 'shoryuken/default_worker_registry'
+require 'shoryuken/default_exception_handler'
 require 'shoryuken/middleware/chain'
 require 'shoryuken/middleware/server/auto_delete'
 Shoryuken::Middleware::Server.autoload :AutoExtendVisibility, 'shoryuken/middleware/server/auto_extend_visibility'
@@ -73,6 +74,8 @@ module Shoryuken
     :sqs_client=,
     :sqs_client_receive_message_opts,
     :sqs_client_receive_message_opts=,
+    :exception_handlers,
+    :exception_handlers=,
     :options,
     :logger,
     :register_worker,

data/shoryuken.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Pablo Cantero']
   spec.email         = ['pablo@pablocantero.com']
   spec.description = spec.summary = 'Shoryuken is a super efficient AWS SQS thread based message processor'
-  spec.homepage      = 'https://github.com/phstc/shoryuken'
+  spec.homepage      = 'https://github.com/ruby-shoryuken/shoryuken'
   spec.license       = 'LGPL-3.0'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/shared_examples_for_active_job.rb

@@ -42,9 +42,11 @@ RSpec.shared_examples 'active_job_adapters' do
     context 'when fifo' do
       let(:fifo) { true }
 
-      it 'does not include job_id in the deduplication_id' do
+      it 'does not include job_id and enqueued_at in the deduplication_id' do
         expect(queue).to receive(:send_message) do |hash|
-          message_deduplication_id = Digest::SHA256.hexdigest(JSON.dump(job.serialize.except('job_id')))
+          message_deduplication_id = Digest::SHA256.hexdigest(
+            JSON.dump(job.serialize.except('job_id', 'enqueued_at'))
+          )
 
           expect(hash[:message_deduplication_id]).to eq(message_deduplication_id)
         end

data/spec/shoryuken/default_exception_handler_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+# rubocop:disable Metrics/BlockLength
+RSpec.describe Shoryuken::DefaultExceptionHandler do
+  class CustomErrorHandler
+    extend Shoryuken::Util
+
+    def self.call(_ex, queue, _msg)
+      logger.error("#{queue.to_s} failed to process the message")
+    end
+  end
+
+  before do
+    Shoryuken.worker_executor = Shoryuken::Worker::InlineExecutor
+    allow(manager).to receive(:async).and_return(manager)
+    allow(manager).to receive(:real_thread)
+    allow(Shoryuken::Client).to receive(:queues).with(queue).and_return(sqs_queue)
+  end
+
+  after do
+    Shoryuken.worker_executor = Shoryuken::Worker::DefaultExecutor
+  end
+
+  let(:manager) { double Shoryuken::Manager }
+  let(:sqs_queue) { double Shoryuken::Queue, visibility_timeout: 30 }
+  let(:queue) { 'default' }
+
+  let(:sqs_msg) do
+    double(
+      Shoryuken::Message,
+      queue_url: queue,
+      body: 'test',
+      message_attributes: {},
+      message_id: SecureRandom.uuid,
+      receipt_handle: SecureRandom.uuid
+    )
+  end
+
+  subject { Shoryuken::Processor.new(queue, sqs_msg) }
+
+  context "with default handler" do
+    before do
+      Shoryuken.exception_handlers = described_class
+    end
+
+    it "logs an error message" do
+      expect(Shoryuken::Logging.logger).to receive(:error).twice
+
+      allow_any_instance_of(TestWorker).to receive(:perform).and_raise(StandardError, "error")
+      allow(sqs_msg).to receive(:body)
+
+      expect { subject.process }.to raise_error(StandardError)
+    end
+  end
+
+  context "with custom handler" do
+    before do
+      Shoryuken.exception_handlers = [described_class, CustomErrorHandler]
+    end
+
+    it "logs default and custom error messages" do
+      expect(Shoryuken::Logging.logger).to receive(:error).twice
+      expect(Shoryuken::Logging.logger).to receive(:error).with("default failed to process the message").once
+
+      allow_any_instance_of(TestWorker).to receive(:perform).and_raise(StandardError, "error")
+      allow(sqs_msg).to receive(:body)
+
+      expect { subject.process }.to raise_error(StandardError)
+    end
+  end
+end

data/spec/shoryuken/environment_loader_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe Shoryuken::EnvironmentLoader do
 
   describe '#parse_queues loads default queues' do
     before do
-      allow(subject).to receive(:load_rails)
+      allow(subject).to receive(:initialize_rails)
       allow(subject).to receive(:prefix_active_job_queue_names)
       allow(subject).to receive(:require_workers)
       allow(subject).to receive(:validate_queues)
@@ -54,7 +54,7 @@ RSpec.describe Shoryuken::EnvironmentLoader do
 
   describe '#parse_queues includes delay per groups' do
     before do
-      allow(subject).to receive(:load_rails)
+      allow(subject).to receive(:initialize_rails)
       allow(subject).to receive(:prefix_active_job_queue_names)
       allow(subject).to receive(:require_workers)
       allow(subject).to receive(:validate_queues)
@@ -76,7 +76,7 @@ RSpec.describe Shoryuken::EnvironmentLoader do
 
   describe '#prefix_active_job_queue_names' do
     before do
-      allow(subject).to receive(:load_rails)
+      allow(subject).to receive(:initialize_rails)
       allow(subject).to receive(:require_workers)
       allow(subject).to receive(:validate_queues)
       allow(subject).to receive(:validate_workers)

data/spec/shoryuken/extensions/active_job_base_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe ActiveJob::Base do
   end
 
   describe '#perform_now' do
-    it 'allows keyward args' do
+    it 'allows keyword args' do
       collaborator = double 'worker collaborator'
       subject.send(:define_method, :perform) do |**kwargs|
         collaborator.foo(**kwargs)

data/spec/shoryuken/fetcher_spec.rb

@@ -28,12 +28,12 @@ RSpec.describe Shoryuken::Fetcher do
 
       Shoryuken.sqs_client_receive_message_opts[group] = { wait_time_seconds: 10 }
 
-      expect(queue).to receive(:receive_messages).with(
+      expect(queue).to receive(:receive_messages).with({
         wait_time_seconds: 10,
         max_number_of_messages: limit,
         message_attribute_names: ['All'],
         attribute_names: ['All']
-      ).and_return([])
+      }).and_return([])
 
       subject.fetch(queue_config, limit)
     end
@@ -62,11 +62,11 @@ RSpec.describe Shoryuken::Fetcher do
 
         Shoryuken.sqs_client_receive_message_opts[queue_name] = { max_number_of_messages: 1 }
 
-        expect(queue).to receive(:receive_messages).with(
+        expect(queue).to receive(:receive_messages).with({
           max_number_of_messages: 1,
           message_attribute_names: ['All'],
           attribute_names: ['All']
-        ).and_return([])
+        }).and_return([])
 
         subject.fetch(queue_config, limit)
       end
@@ -78,11 +78,11 @@ RSpec.describe Shoryuken::Fetcher do
 
         Shoryuken.sqs_client_receive_message_opts[queue_name] = { max_number_of_messages: 20 }
 
-        expect(queue).to receive(:receive_messages).with(
+        expect(queue).to receive(:receive_messages).with({
           max_number_of_messages: limit,
           message_attribute_names: ['All'],
           attribute_names: ['All']
-        ).and_return([])
+        }).and_return([])
 
         subject.fetch(queue_config, limit)
       end
@@ -93,9 +93,9 @@ RSpec.describe Shoryuken::Fetcher do
 
       specify do
         allow(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
-        expect(queue).to receive(:receive_messages).with(
+        expect(queue).to receive(:receive_messages).with({
           max_number_of_messages: described_class::FETCH_LIMIT, attribute_names: ['All'], message_attribute_names: ['All']
-        ).and_return([])
+        }).and_return([])
 
         subject.fetch(queue_config, limit)
       end
@@ -109,9 +109,9 @@ RSpec.describe Shoryuken::Fetcher do
         # see https://github.com/phstc/shoryuken/pull/530
 
         allow(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
-        expect(queue).to receive(:receive_messages).with(
+        expect(queue).to receive(:receive_messages).with({
           max_number_of_messages: 1, attribute_names: ['All'], message_attribute_names: ['All']
-        ).and_return([])
+        }).and_return([])
 
         subject.fetch(queue_config, limit)
       end
@@ -123,9 +123,9 @@ RSpec.describe Shoryuken::Fetcher do
           allow(Shoryuken::Client).to receive(:queues).with(queue_name).and_return(queue)
           allow(Shoryuken.worker_registry).to receive(:batch_receive_messages?).with(queue.name).and_return(true)
 
-          expect(queue).to receive(:receive_messages).with(
+          expect(queue).to receive(:receive_messages).with({
             max_number_of_messages: limit, attribute_names: ['All'], message_attribute_names: ['All']
-          ).and_return([])
+          }).and_return([])
 
           subject.fetch(queue_config, limit)
         end

data/spec/shoryuken/launcher_spec.rb

@@ -57,4 +57,49 @@ RSpec.describe Shoryuken::Launcher do
       end
     end
   end
-end
+
+  describe '#stop' do
+    before do
+      allow(first_group_manager).to receive(:stop_new_dispatching)
+      allow(first_group_manager).to receive(:await_dispatching_in_progress)
+      allow(second_group_manager).to receive(:stop_new_dispatching)
+      allow(second_group_manager).to receive(:await_dispatching_in_progress)
+    end
+
+    it 'fires quiet, shutdown and stopped event' do
+      allow(subject).to receive(:fire_event)
+      subject.stop
+      expect(subject).to have_received(:fire_event).with(:quiet, true)
+      expect(subject).to have_received(:fire_event).with(:shutdown, true)
+      expect(subject).to have_received(:fire_event).with(:stopped)
+    end
+
+    it 'stops the managers' do
+      subject.stop
+      expect(first_group_manager).to have_received(:stop_new_dispatching)
+      expect(second_group_manager).to have_received(:stop_new_dispatching)
+    end
+  end
+
+  describe '#stop!' do
+    before do
+      allow(first_group_manager).to receive(:stop_new_dispatching)
+      allow(first_group_manager).to receive(:await_dispatching_in_progress)
+      allow(second_group_manager).to receive(:stop_new_dispatching)
+      allow(second_group_manager).to receive(:await_dispatching_in_progress)
+    end
+
+    it 'fires shutdown and stopped event' do
+      allow(subject).to receive(:fire_event)
+      subject.stop!
+      expect(subject).to have_received(:fire_event).with(:shutdown, true)
+      expect(subject).to have_received(:fire_event).with(:stopped)
+    end
+
+    it 'stops the managers' do
+      subject.stop!
+      expect(first_group_manager).to have_received(:stop_new_dispatching)
+      expect(second_group_manager).to have_received(:stop_new_dispatching)
+    end
+  end
+end

data/spec/shoryuken/manager_spec.rb

@@ -73,9 +73,11 @@ RSpec.describe Shoryuken::Manager do
       expect(subject).to receive(:fire_event).with(:dispatch, false, queue_name: q.name)
       expect(subject).to receive(:fire_event).with(:utilization_update,
                                                    false,
-                                                   group: 'default',
-                                                   busy_processors: 1,
-                                                   max_processors: 1)
+                                                   {
+                                                     group: 'default',
+                                                     busy_processors: 1,
+                                                     max_processors: 1
+                                                   })
       expect(Shoryuken::Processor).to receive(:process).with(q, message)
       expect(Shoryuken.logger).to receive(:info).never
 
@@ -106,9 +108,11 @@ RSpec.describe Shoryuken::Manager do
         expect(fetcher).to receive(:fetch).with(q, described_class::BATCH_LIMIT).and_return(messages)
         expect(subject).to receive(:fire_event).with(:utilization_update,
                                                      false,
-                                                     group: 'default',
-                                                     busy_processors: 1,
-                                                     max_processors: 1)
+                                                     {
+                                                       group: 'default',
+                                                       busy_processors: 1,
+                                                       max_processors: 1
+                                                     })
         expect(subject).to receive(:fire_event).with(:dispatch, false, queue_name: q.name)
         allow(subject).to receive(:batched_queue?).with(q).and_return(true)
         expect(Shoryuken::Processor).to receive(:process).with(q, messages)

data/spec/shoryuken/queue_spec.rb

@@ -80,7 +80,8 @@ RSpec.describe Shoryuken::Queue do
     end
 
     it 'deletes' do
-      expect(sqs).to receive(:delete_message_batch).with(entries: entries, queue_url: queue_url).and_return(double(failed: []))
+      expect(sqs).to receive(:delete_message_batch).with({ entries: entries,
+                                                           queue_url: queue_url }).and_return(double(failed: []))
 
       subject.delete_messages(entries: entries)
     end
@@ -91,7 +92,8 @@ RSpec.describe Shoryuken::Queue do
         logger = double 'Logger'
 
         expect(sqs).to(
-          receive(:delete_message_batch).with(entries: entries, queue_url: queue_url).and_return(double(failed: [failure]))
+          receive(:delete_message_batch).with({ entries: entries,
+                                                queue_url: queue_url }).and_return(double(failed: [failure]))
         )
         expect(subject).to receive(:logger).and_return(logger)
         expect(logger).to receive(:error)
@@ -157,7 +159,8 @@ RSpec.describe Shoryuken::Queue do
     it 'accepts SQS request parameters' do
       # https://docs.aws.amazon.com/sdkforruby/api/Aws/SQS/Client.html#send_message_batch-instance_method
       expect(sqs).to(
-        receive(:send_message_batch).with(hash_including(entries: [{ id: '0', message_body: 'msg1' }, { id: '1', message_body: 'msg2' }]))
+        receive(:send_message_batch).with(hash_including(entries: [{ id: '0', message_body: 'msg1' },
+                                                                   { id: '1', message_body: 'msg2' }]))
       )
 
       subject.send_messages(entries: [{ id: '0', message_body: 'msg1' }, { id: '1', message_body: 'msg2' }])
@@ -286,7 +289,8 @@ RSpec.describe Shoryuken::Queue do
         Shoryuken.cache_visibility_timeout = false
 
         expect(sqs).to(
-          receive(:get_queue_attributes).with(queue_url: queue_url, attribute_names: ['All']).and_return(attribute_response).exactly(3).times
+          receive(:get_queue_attributes).with(queue_url: queue_url,
+                                              attribute_names: ['All']).and_return(attribute_response).exactly(3).times
         )
         expect(subject.visibility_timeout).to eq(30)
         expect(subject.visibility_timeout).to eq(30)
@@ -299,7 +303,8 @@ RSpec.describe Shoryuken::Queue do
         Shoryuken.cache_visibility_timeout = true
 
         expect(sqs).to(
-          receive(:get_queue_attributes).with(queue_url: queue_url, attribute_names: ['All']).and_return(attribute_response).once
+          receive(:get_queue_attributes).with({ queue_url: queue_url,
+                                                attribute_names: ['All'] }).and_return(attribute_response).once
         )
         expect(subject.visibility_timeout).to eq(30)
         expect(subject.visibility_timeout).to eq(30)

data/spec/shoryuken/worker/default_executor_spec.rb

@@ -10,16 +10,16 @@ RSpec.describe Shoryuken::Worker::DefaultExecutor do
 
   describe '.perform_in' do
     it 'delays a message' do
-      expect(sqs_queue).to receive(:send_message).with(
-        message_attributes: {
-          'shoryuken_class' => {
-            string_value: TestWorker.to_s,
-            data_type: 'String'
-          }
-        },
-        message_body: 'message',
-        delay_seconds: 60
-      )
+      expect(sqs_queue).to receive(:send_message).with({
+                                                         message_attributes: {
+                                                           'shoryuken_class' => {
+                                                             string_value: TestWorker.to_s,
+                                                             data_type: 'String'
+                                                           }
+                                                         },
+                                                         message_body: 'message',
+                                                         delay_seconds: 60
+                                                       })
 
       TestWorker.perform_in(60, 'message')
     end
@@ -33,16 +33,16 @@ RSpec.describe Shoryuken::Worker::DefaultExecutor do
 
   describe '.perform_at' do
     it 'delays a message' do
-      expect(sqs_queue).to receive(:send_message).with(
-        message_attributes: {
-          'shoryuken_class' => {
-            string_value: TestWorker.to_s,
-            data_type: 'String'
-          }
-        },
-        message_body: 'message',
-        delay_seconds: 60
-      )
+      expect(sqs_queue).to receive(:send_message).with({
+                                                         message_attributes: {
+                                                           'shoryuken_class' => {
+                                                             string_value: TestWorker.to_s,
+                                                             data_type: 'String'
+                                                           }
+                                                         },
+                                                         message_body: 'message',
+                                                         delay_seconds: 60
+                                                       })
 
       TestWorker.perform_in(Time.now + 60, 'message')
     end
@@ -56,30 +56,30 @@ RSpec.describe Shoryuken::Worker::DefaultExecutor do
 
   describe '.perform_async' do
     it 'enqueues a message' do
-      expect(sqs_queue).to receive(:send_message).with(
-        message_attributes: {
-          'shoryuken_class' => {
-            string_value: TestWorker.to_s,
-            data_type: 'String'
-          }
-        },
-        message_body: 'message'
-      )
+      expect(sqs_queue).to receive(:send_message).with({
+                                                         message_attributes: {
+                                                           'shoryuken_class' => {
+                                                             string_value: TestWorker.to_s,
+                                                             data_type: 'String'
+                                                           }
+                                                         },
+                                                         message_body: 'message'
+                                                       })
 
       TestWorker.perform_async('message')
     end
 
     it 'enqueues a message with options' do
-      expect(sqs_queue).to receive(:send_message).with(
-        delay_seconds: 60,
-        message_attributes: {
-          'shoryuken_class' => {
-            string_value: TestWorker.to_s,
-            data_type: 'String'
-          }
-        },
-        message_body: 'delayed message'
-      )
+      expect(sqs_queue).to receive(:send_message).with({
+                                                         delay_seconds: 60,
+                                                         message_attributes: {
+                                                           'shoryuken_class' => {
+                                                             string_value: TestWorker.to_s,
+                                                             data_type: 'String'
+                                                           }
+                                                         },
+                                                         message_body: 'delayed message'
+                                                       })
 
       TestWorker.perform_async('delayed message', delay_seconds: 60)
     end
@@ -89,15 +89,15 @@ RSpec.describe Shoryuken::Worker::DefaultExecutor do
 
       expect(Shoryuken::Client).to receive(:queues).with(new_queue).and_return(sqs_queue)
 
-      expect(sqs_queue).to receive(:send_message).with(
-        message_attributes: {
-          'shoryuken_class' => {
-            string_value: TestWorker.to_s,
-            data_type: 'String'
-          }
-        },
-        message_body: 'delayed message'
-      )
+      expect(sqs_queue).to receive(:send_message).with({
+                                                         message_attributes: {
+                                                           'shoryuken_class' => {
+                                                             string_value: TestWorker.to_s,
+                                                             data_type: 'String'
+                                                           }
+                                                         },
+                                                         message_body: 'delayed message'
+                                                       })
 
       TestWorker.perform_async('delayed message', queue: new_queue)
     end

data/spec/spec_helper.rb

@@ -46,6 +46,8 @@ RSpec.configure do |config|
     Shoryuken.options[:logfile]     = nil
     Shoryuken.options[:queues]      = nil
 
+    Shoryuken.options[:exception_handlers] = []
+
     TestWorker.get_shoryuken_options.clear
     TestWorker.get_shoryuken_options['queue'] = 'default'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoryuken
 version: !ruby/object:Gem::Version
-  version: 5.3.2
+  version: 6.1.0
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -103,8 +103,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".devcontainer/Dockerfile"
+- ".devcontainer/base.Dockerfile"
+- ".devcontainer/devcontainer.json"
 - ".github/FUNDING.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/specs.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rspec"
@@ -126,10 +131,12 @@ files:
 - gemfiles/rails_5_2.gemfile
 - gemfiles/rails_6_0.gemfile
 - gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7_0.gemfile
 - lib/shoryuken.rb
 - lib/shoryuken/body_parser.rb
 - lib/shoryuken/client.rb
 - lib/shoryuken/core_ext.rb
+- lib/shoryuken/default_exception_handler.rb
 - lib/shoryuken/default_worker_registry.rb
 - lib/shoryuken/environment_loader.rb
 - lib/shoryuken/extensions/active_job_adapter.rb
@@ -167,6 +174,7 @@ files:
 - spec/shoryuken/body_parser_spec.rb
 - spec/shoryuken/client_spec.rb
 - spec/shoryuken/core_ext_spec.rb
+- spec/shoryuken/default_exception_handler_spec.rb
 - spec/shoryuken/default_worker_registry_spec.rb
 - spec/shoryuken/environment_loader_spec.rb
 - spec/shoryuken/extensions/active_job_adapter_spec.rb
@@ -195,7 +203,7 @@ files:
 - spec/spec_helper.rb
 - test_workers/endless_interruptive_worker.rb
 - test_workers/endless_uninterruptive_worker.rb
-homepage: https://github.com/phstc/shoryuken
+homepage: https://github.com/ruby-shoryuken/shoryuken
 licenses:
 - LGPL-3.0
 metadata: {}
@@ -214,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Shoryuken is a super efficient AWS SQS thread based message processor
@@ -225,6 +233,7 @@ test_files:
 - spec/shoryuken/body_parser_spec.rb
 - spec/shoryuken/client_spec.rb
 - spec/shoryuken/core_ext_spec.rb
+- spec/shoryuken/default_exception_handler_spec.rb
 - spec/shoryuken/default_worker_registry_spec.rb
 - spec/shoryuken/environment_loader_spec.rb
 - spec/shoryuken/extensions/active_job_adapter_spec.rb