shoryuken 7.0.0.rc1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44ec6add623605d696f0a4151aab96d37331250fa66a6b804edea13b06a2b816
-  data.tar.gz: efe2733bb86113a83b7788041262421c84ee4c50a47718b32ef8bdb505fa15fe
+  metadata.gz: 8aa80df1d9e932b7541e1ced2dc836e8d16334f886d304928f7b1b9d69f9451e
+  data.tar.gz: 34c2e2d53e6f25ff1fecbb8992b66c30291f4c386cc89bea1daeb2fee7070fa9
 SHA512:
-  metadata.gz: 84daafb107ff842e74cdb3872885b6c01ea34d95a5eaf6cf2efeeb3398bc835e570ea5b7f93b9451e4e5841d1d27b53ea35db677a4ddd78cdd75c13b417eebae
-  data.tar.gz: ad0dcb19240b8179c62bb6b74e23b1801d1f0d671a0f72a5b26d74a0bbd1f47158abd57a6cee091d88fe903ea91ce09afd34702f9086cb4b2cf14a9a17397509
+  metadata.gz: 8a7ec77e7eb0f199fa6ee0ad22e3c3750b896832943d4a388c7e8c41aa6ac6273ada3d2683e06fc452fc37c5e30ac12fe3476df9a141cd36351521c4f040fba5
+  data.tar.gz: bd79f0794dbf0b3b00902452cfce63410d8c5c835ad08a012c385f21a7fc228bd41b824e1abdbcfd13e26b52f7ebaeec271c9e7a4053ac11a99cf2a6115f023c

data/.github/workflows/push.yml

@@ -19,12 +19,12 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
         with:
           fetch-depth: 0
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@d5126b9b3579e429dd52e51e68624dda2e05be25 # v1.267.0
+        uses: ruby/setup-ruby@708024e6c902387ab41de36e1669e43b5ee7085e # v1.283.0
         with:
           bundler-cache: false
 

data/.github/workflows/specs.yml

@@ -2,17 +2,36 @@ name: Specs
 on:
   - push
   - pull_request
+permissions:
+  contents: read
 jobs:
-  all_specs:
-    name: All Specs
+  specs:
+    name: Specs
     strategy:
       matrix:
-        ruby: ['3.1', '3.2', '3.3', '3.4']
-        gemfile: ['Gemfile']
+        ruby: ['3.2', '3.3', '3.4', '4.0']
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+
+      - uses: ruby/setup-ruby@708024e6c902387ab41de36e1669e43b5ee7085e # v1.283.0
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run specs
+        run: bundle exec rake spec
+
+  integrations:
+    name: Integrations
+    strategy:
+      matrix:
+        ruby: ['3.2', '3.3', '3.4', '4.0']
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       - name: Start LocalStack
         run: docker compose up -d
@@ -26,58 +45,21 @@ jobs:
           done
           '
 
-      - uses: ruby/setup-ruby@d5126b9b3579e429dd52e51e68624dda2e05be25 # v1.267.0
+      - uses: ruby/setup-ruby@708024e6c902387ab41de36e1669e43b5ee7085e # v1.283.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Run specs
-        run: bundle exec rake spec
-        env:
-          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
-
       - name: Run integration specs
         run: bundle exec rake spec:integration
-        env:
-          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
-
-  rails_specs:
-    name: Rails Specs
-    strategy:
-      matrix:
-        rails: ['7.2', '8.0', '8.1']
-        include:
-          - rails: '7.2'
-            ruby: '3.2'
-            gemfile: gemfiles/rails_7_2.gemfile
-          - rails: '8.0'
-            ruby: '3.3'
-            gemfile: gemfiles/rails_8_0.gemfile
-          - rails: '8.1'
-            ruby: '3.4'
-            gemfile: gemfiles/rails_8_1.gemfile
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-
-      - uses: ruby/setup-ruby@d5126b9b3579e429dd52e51e68624dda2e05be25 # v1.267.0
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Run Rails specs
-        run: bundle exec rake spec:rails
 
   ci-success:
     name: CI Success
     runs-on: ubuntu-latest
     if: always()
     needs:
-      - all_specs
-      - rails_specs
+      - specs
+      - integrations
     steps:
       - name: Check all jobs passed
         if: |

data/.github/workflows/verify-action-pins.yml

@@ -7,7 +7,7 @@ jobs:
   verify:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
       - name: Check SHA pins
         run: |
           if grep -E -r "uses: .*/.*@(v[0-9]+|main|master)($|[[:space:]]|$)" --include="*.yml" --include="*.yaml" .github/workflows/ | grep -v "#"; then

data/.gitignore

@@ -27,3 +27,6 @@ shoryuken.yml
 rubocop.html
 .byebug_history
 .localstack
+spec/integration/**/Gemfile.lock
+spec/integration/**/vendor/
+spec/integration/**/.bundle/

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--exclude-pattern "spec/integration/**/*"

data/.ruby-version

@@ -1 +1 @@
-3.4.7
+4.0.0

data/.yard-lint.yml

@@ -0,0 +1,279 @@
+# YARD-Lint Configuration
+# See https://github.com/mensfeld/yard-lint for documentation
+
+# Global settings for all validators
+AllValidators:
+  YardOptions:
+  - "--private"
+  - "--protected"
+  Exclude:
+  - "\\.git"
+  - vendor/**/*
+  - node_modules/**/*
+  - spec/**/*
+  - test/**/*
+  - bin/**/*
+  - examples/**/*
+  - test_workers/**/*
+  FailOnSeverity: convention
+  MinCoverage: 100
+  DiffMode:
+    DefaultBaseRef:
+
+# Documentation validators
+Documentation/UndocumentedObjects:
+  Description: Checks for classes, modules, and methods without documentation.
+  Enabled: true
+  Severity: error
+  ExcludedMethods:
+  - initialize/0
+  - "/^_/"
+
+Documentation/UndocumentedMethodArguments:
+  Description: Checks for method parameters without @param tags.
+  Enabled: true
+  Severity: error
+
+Documentation/UndocumentedBooleanMethods:
+  Description: Checks that question mark methods document their boolean return.
+  Enabled: true
+  Severity: error
+
+Documentation/UndocumentedOptions:
+  Description: Detects methods with options hash parameters but no @option tags.
+  Enabled: true
+  Severity: error
+
+Documentation/MarkdownSyntax:
+  Description: Detects common markdown syntax errors in documentation.
+  Enabled: true
+  Severity: error
+
+Documentation/EmptyCommentLine:
+  Description: Detects empty comment lines at the start or end of documentation blocks.
+  Enabled: true
+  Severity: convention
+  EnabledPatterns:
+    Leading: true
+    Trailing: true
+
+Documentation/BlankLineBeforeDefinition:
+  Description: Detects blank lines between YARD documentation and method definition.
+  Enabled: true
+  Severity: convention
+  OrphanedSeverity: convention
+  EnabledPatterns:
+    SingleBlankLine: true
+    OrphanedDocs: true
+
+# Tags validators
+Tags/Order:
+  Description: Enforces consistent ordering of YARD tags.
+  Enabled: true
+  Severity: error
+  EnforcedOrder:
+  - param
+  - option
+  - return
+  - raise
+  - example
+
+Tags/InvalidTypes:
+  Description: Validates type definitions in @param, @return, @option tags.
+  Enabled: true
+  Severity: error
+  ValidatedTags:
+  - param
+  - option
+  - return
+
+Tags/TypeSyntax:
+  Description: Validates YARD type syntax using YARD parser.
+  Enabled: true
+  Severity: error
+  ValidatedTags:
+  - param
+  - option
+  - return
+  - yieldreturn
+
+Tags/MeaninglessTag:
+  Description: Detects @param/@option tags on classes, modules, or constants.
+  Enabled: true
+  Severity: error
+  CheckedTags:
+  - param
+  - option
+  InvalidObjectTypes:
+  - class
+  - module
+  - constant
+
+Tags/CollectionType:
+  Description: Validates Hash collection syntax consistency.
+  Enabled: true
+  Severity: error
+  EnforcedStyle: long
+  ValidatedTags:
+  - param
+  - option
+  - return
+  - yieldreturn
+
+Tags/TagTypePosition:
+  Description: Validates type annotation position in tags.
+  Enabled: true
+  Severity: error
+  CheckedTags:
+  - param
+  - option
+  EnforcedStyle: type_after_name
+
+Tags/ApiTags:
+  Description: Enforces @api tags on public objects.
+  Enabled: false
+  Severity: error
+  AllowedApis:
+  - public
+  - private
+  - internal
+
+Tags/OptionTags:
+  Description: Requires @option tags for methods with options parameters.
+  Enabled: true
+  Severity: error
+
+Tags/ExampleSyntax:
+  Description: Validates Ruby syntax in @example tags.
+  Enabled: true
+  Severity: warning
+
+Tags/RedundantParamDescription:
+  Description: Detects meaningless parameter descriptions that add no value.
+  Enabled: true
+  Severity: convention
+  CheckedTags:
+  - param
+  - option
+  Articles:
+  - The
+  - the
+  - A
+  - a
+  - An
+  - an
+  MaxRedundantWords: 6
+  GenericTerms:
+  - object
+  - instance
+  - value
+  - data
+  - item
+  - element
+  EnabledPatterns:
+    ArticleParam: true
+    PossessiveParam: true
+    TypeRestatement: true
+    ParamToVerb: true
+    IdPattern: true
+    DirectionalDate: true
+    TypeGeneric: true
+
+Tags/InformalNotation:
+  Description: Detects informal tag notation patterns like "Note:" instead of @note.
+  Enabled: true
+  Severity: warning
+  CaseSensitive: false
+  RequireStartOfLine: true
+  Patterns:
+    Note: "@note"
+    Todo: "@todo"
+    TODO: "@todo"
+    FIXME: "@todo"
+    See: "@see"
+    See also: "@see"
+    Warning: "@deprecated"
+    Deprecated: "@deprecated"
+    Author: "@author"
+    Version: "@version"
+    Since: "@since"
+    Returns: "@return"
+    Raises: "@raise"
+    Example: "@example"
+
+Tags/NonAsciiType:
+  Description: Detects non-ASCII characters in type annotations.
+  Enabled: true
+  Severity: warning
+  ValidatedTags:
+  - param
+  - option
+  - return
+  - yieldreturn
+  - yieldparam
+
+Tags/TagGroupSeparator:
+  Description: Enforces blank line separators between different YARD tag groups.
+  Enabled: false
+  Severity: convention
+  TagGroups:
+    param:
+    - param
+    - option
+    return:
+    - return
+    error:
+    - raise
+    - throws
+    example:
+    - example
+    meta:
+    - see
+    - note
+    - todo
+    - deprecated
+    - since
+    - version
+    - api
+    yield:
+    - yield
+    - yieldparam
+    - yieldreturn
+  RequireAfterDescription: false
+
+# Warnings validators - catches YARD parser errors
+Warnings/UnknownTag:
+  Description: Detects unknown YARD tags.
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownDirective:
+  Description: Detects unknown YARD directives.
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidTagFormat:
+  Description: Detects malformed tag syntax.
+  Enabled: true
+  Severity: error
+
+Warnings/InvalidDirectiveFormat:
+  Description: Detects malformed directive syntax.
+  Enabled: true
+  Severity: error
+
+Warnings/DuplicatedParameterName:
+  Description: Detects duplicate @param tags.
+  Enabled: true
+  Severity: error
+
+Warnings/UnknownParameterName:
+  Description: Detects @param tags for non-existent parameters.
+  Enabled: true
+  Severity: error
+
+# Semantic validators
+Semantic/AbstractMethods:
+  Description: Ensures @abstract methods do not have real implementations.
+  Enabled: true
+  Severity: error

data/CHANGELOG.md

@@ -1,16 +1,70 @@
-## [7.0.0] - Unreleased
+## [7.0.0] - 2026-01-19
+
+**See the [Upgrading to 7.0](https://github.com/ruby-shoryuken/shoryuken/wiki/Upgrading-to-7.0) guide for detailed migration instructions.**
+
+- Breaking: Add `Shoryuken::Errors` module with domain-specific error classes
+  - Introduces `Shoryuken::Errors::BaseError` as base class for all Shoryuken errors
+  - `Shoryuken::Errors::QueueNotFoundError` for non-existent or inaccessible SQS queues
+  - `Shoryuken::Errors::InvalidConfigurationError` for configuration validation failures
+  - `Shoryuken::Errors::InvalidWorkerRegistrationError` for worker registration conflicts
+  - `Shoryuken::Errors::InvalidPollingStrategyError` for invalid polling strategy configuration
+  - `Shoryuken::Errors::InvalidEventError` for invalid lifecycle event names
+  - `Shoryuken::Errors::InvalidDelayError` for delays exceeding SQS 15-minute maximum
+  - `Shoryuken::Errors::InvalidArnError` for invalid ARN format
+  - Replaces generic Ruby exceptions (ArgumentError, RuntimeError) with specific error types
+
+- Removed: `Shoryuken::Shutdown` class
+  - This class was unused since the Celluloid removal in 2016
+  - Originally used to raise on worker threads during hard shutdown
+  - Current shutdown flow uses `Interrupt` and executor-level shutdown instead
+
+- Fix: Raise ArgumentError when using delay with FIFO queues
+  - FIFO queues do not support per-message DelaySeconds
+  - Previously caused confusing AWS errors with ActiveJob's `retry_on` (Rails 6.1+ defaults to `wait: 3.seconds`)
+  - Now raises clear ArgumentError with guidance to use `wait: 0`
+  - Fixes #924
+
+- Enhancement: Use fiber-local storage for logging context
+  - Replaces thread-local storage with Fiber[] for proper isolation in async environments
+  - Ensures logging context doesn't leak between fibers in the same thread
+  - Leverages Ruby 3.2+ fiber-local storage API
+
+- Enhancement: Add yard-lint with comprehensive YARD documentation
+  - Adds yard-lint gem for documentation linting
+  - Documents all public classes, modules, and methods with YARD tags
+  - Ensures 100% documentation coverage
+
+- Enhancement: Add `enqueue_all` for bulk ActiveJob enqueuing (Rails 7.1+)
+  - Implements efficient bulk enqueuing using SQS `send_message_batch` API
+  - Called by `ActiveJob.perform_all_later` for batching multiple jobs
+  - Batches jobs in groups of 10 (SQS limit) per queue
+  - Groups jobs by queue name for efficient multi-queue handling
+
 - Enhancement: Add ActiveJob Continuations support (Rails 8.1+)
   - Implements `stopping?` method in ActiveJob adapters to signal graceful shutdown
   - Enables jobs to checkpoint progress and resume after interruption
   - Handles past timestamps correctly (SQS treats negative delays as immediate delivery)
   - Tracks shutdown state in Launcher via `stopping?` flag
   - Leverages existing Shoryuken shutdown lifecycle (stop/stop! methods)
-  - Includes comprehensive integration tests with continuable jobs
   - See Rails PR #55127 for more details on ActiveJob Continuations
 
+- Enhancement: Add CurrentAttributes persistence support
+  - Enables Rails `ActiveSupport::CurrentAttributes` to flow from enqueue to job execution
+  - Automatically serializes current attributes into job payload when enqueuing
+  - Restores attributes before job execution and resets them afterward
+  - Supports multiple CurrentAttributes classes
+  - Based on Sidekiq's approach using `ActiveJob::Arguments` for serialization
+  - Usage: `require 'shoryuken/active_job/current_attributes'` and
+    `Shoryuken::ActiveJob::CurrentAttributes.persist('MyApp::Current')`
+
+- Breaking: Drop support for Ruby 3.1 (EOL March 2025)
+  - Minimum required Ruby version is now 3.2.0
+  - Supported Ruby versions: 3.2, 3.3, 3.4
+  - Users on Ruby 3.1 should upgrade or remain on Shoryuken 6.x
+
 - Breaking: Remove support for Rails versions older than 7.2
-  - Rails 7.0 and 7.1 have reached end-of-life and are no longer supported
-  - Supported versions: Rails 7.2, 8.0, and 8.1
+  - Rails 7.0 and 7.1 have reached end-of-life (April 2025) and are no longer supported
+  - Supported Rails versions: 7.2, 8.0, and 8.1
   - Users on older Rails versions should upgrade or remain on Shoryuken 6.x
 
 - Enhancement: Replace Concurrent::AtomicFixnum with pure Ruby AtomicCounter

data/Gemfile

@@ -9,10 +9,10 @@ group :test do
   gem 'multi_xml'
   gem 'simplecov'
   gem 'warning'
+  gem 'yard-lint'
 end
 
 group :development do
-  gem 'appraisal', git: 'https://github.com/thoughtbot/appraisal.git'
   gem 'pry-byebug'
   gem 'rubocop'
 end

data/README.md

@@ -63,15 +63,10 @@ To run all unit specs against the latest dependency versions, execute
 bundle exec rake spec
 ```
 
-To run all Rails-related specs against all supported versions of Rails, execute
-
-```sh
-bundle exec appraisal rake spec:rails
-```
-
-To run integration specs, start a mock SQS server on `localhost:5000`. One such option is [cjlarose/moto-sqs-server](https://github.com/cjlarose/moto-sqs-server). Then execute
+To run integration specs (including Rails tests), start LocalStack and run:
 
 ```sh
+docker compose up -d
 bundle exec rake spec:integration
 ```
 

data/Rakefile

@@ -5,19 +5,13 @@ $stdout.sync = true
 
 begin
   require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.exclude_pattern = 'spec/integration/**/*_spec.rb'
-  end
+  RSpec::Core::RakeTask.new(:spec)
 
   namespace :spec do
-    desc 'Run Rails specs only'
-    RSpec::Core::RakeTask.new(:rails) do |t|
-      t.pattern = 'spec/shoryuken/{environment_loader_spec,extensions/active_job_*}.rb'
-    end
-
     desc 'Run integration specs only'
-    RSpec::Core::RakeTask.new(:integration) do |t|
-      t.pattern = 'spec/integration/**/*_spec.rb'
+    task :integration do
+      puts "Running integration tests..."
+      system('./bin/integrations') || exit(1)
     end
   end
 rescue LoadError

data/bin/clean_localstack

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Removes all integration test SQS queues from LocalStack
+#
+# Useful when having a long-running LocalStack instance that cannot be fully
+# restarted between test runs. All integration test queues use the 'it-' prefix,
+# making them easy to identify and remove.
+#
+# Usage:
+#   bin/clean_localstack
+
+require 'aws-sdk-sqs'
+
+THREADS_COUNT = 3
+
+sqs = Aws::SQS::Client.new(
+  region: 'us-east-1',
+  endpoint: 'http://localhost:4566',
+  access_key_id: 'fake',
+  secret_access_key: 'fake'
+)
+
+# Find all queues with 'it-' prefix
+response = sqs.list_queues(queue_name_prefix: 'it-')
+queues_for_removal = response.queue_urls || []
+
+if queues_for_removal.empty?
+  puts "No integration test queues found (prefix: it-)"
+  exit 0
+end
+
+puts "Found #{queues_for_removal.size} queues to remove"
+
+queue = SizedQueue.new(THREADS_COUNT)
+
+threads = Array.new(THREADS_COUNT) do
+  Thread.new do
+    while (queue_url = queue.pop)
+      queue_name = queue_url.split('/').last
+      puts "Removing queue: #{queue_name}"
+      sqs.delete_queue(queue_url: queue_url)
+    end
+  end
+end
+
+queues_for_removal.each { |url| queue << url }
+
+queue.close
+threads.each(&:join)
+
+puts "Cleanup complete"

data/bin/cli/base.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 module Shoryuken
   module CLI
+    # Base class for CLI commands providing common helper methods.
     class Base < Thor
       no_commands do
+        # Prints entries as a formatted table
+        #
+        # @param entries [Array<Array>] rows to print as a table
+        # @return [void]
         def print_table(entries)
           column_sizes = print_columns_size(entries)
 
@@ -10,6 +17,10 @@ module Shoryuken
           end
         end
 
+        # Calculates the maximum width for each column
+        #
+        # @param entries [Array<Array>] the table rows
+        # @return [Hash<Integer, Integer>] column index to max width mapping
         def print_columns_size(entries)
           column_sizes = Hash.new(0)
 
@@ -23,11 +34,21 @@ module Shoryuken
           column_sizes
         end
 
+        # Formats a column value with padding
+        #
+        # @param column [Object] the column value to format
+        # @param size [Integer] the target width
+        # @return [String] the formatted column
         def print_format_column(column, size)
           size_with_padding = size + 4
           column.to_s.ljust(size_with_padding)
         end
 
+        # Outputs a failure message and optionally exits
+        #
+        # @param msg [String] the failure message
+        # @param quit [Boolean] whether to exit the program
+        # @return [void]
         def fail_task(msg, quit = true)
           say "[FAIL] #{msg}", :red
           exit(1) if quit