shoryuken 6.2.1 → 7.0.2

data/.github/workflows/stale.yml

@@ -1,20 +0,0 @@
-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@v9
-        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/.reek.yml

@@ -1,5 +0,0 @@
----
-detectors:
-
-  UtilityFunction:
-    public_methods_only: true

data/Appraisals

@@ -1,42 +0,0 @@
-appraise 'aws_sdk_core_2' do
-  group :test do
-    gem 'aws-sdk-core', '~> 2'
-    gem 'webrick' # required for Ruby 3
-    remove_gem 'aws-sdk-sqs'
-  end
-end
-
-appraise 'rails_4_2' do
-  group :test do
-    gem 'activejob', '~> 4.2'
-  end
-
-  group :development do
-    gem 'appraisal', '~> 2.2'
-    remove_gem 'pry-byebug'
-  end
-end
-
-appraise 'rails_5_2' do
-  group :test do
-    gem 'activejob', '~> 5.2'
-  end
-end
-
-appraise 'rails_6_0' do
-  group :test do
-    gem 'activejob', '~> 6.0'
-  end
-end
-
-appraise 'rails_6_1' do
-  group :test do
-    gem 'activejob', '~> 6.1'
-  end
-end
-
-appraise 'rails_7_0' do
-  group :test do
-    gem 'activejob', '~> 7.0'
-  end
-end

data/gemfiles/.gitignore

@@ -1 +0,0 @@
-*.gemfile.lock

data/gemfiles/aws_sdk_core_2.gemfile

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

data/gemfiles/rails_4_2.gemfile

@@ -1,20 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-group :test do
-  gem "activejob", "~> 4.2"
-  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", "~> 2.2"
-  gem "rubocop"
-end
-
-gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -1,21 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-group :test do
-  gem "activejob", "~> 5.2"
-  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 "pry-byebug", "3.9.0"
-  gem "rubocop"
-end
-
-gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -1,21 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-group :test do
-  gem "activejob", "~> 6.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 "pry-byebug", "3.9.0"
-  gem "rubocop"
-end
-
-gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -1,21 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-group :test do
-  gem "activejob", "~> 6.1"
-  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 "pry-byebug", "3.9.0"
-  gem "rubocop"
-end
-
-gemspec path: "../"

data/gemfiles/rails_7_0.gemfile

@@ -1,22 +0,0 @@
-# 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/core_ext.rb

@@ -1,69 +0,0 @@
-module Shoryuken
-  module HashExt
-    module StringifyKeys
-      def stringify_keys
-        keys.each do |key|
-          self[key.to_s] = delete(key)
-        end
-        self
-      end
-    end
-
-    module SymbolizeKeys
-      def symbolize_keys
-        keys.each do |key|
-          self[(key.to_sym rescue key) || key] = delete(key)
-        end
-        self
-      end
-    end
-
-    module DeepSymbolizeKeys
-      def deep_symbolize_keys
-        keys.each do |key|
-          value = delete(key)
-          self[(key.to_sym rescue key) || key] = value
-
-          value.deep_symbolize_keys if value.is_a? Hash
-        end
-        self
-      end
-    end
-  end
-
-  module StringExt
-    module Constantize
-      def constantize
-        names = split('::')
-        names.shift if names.empty? || names.first.empty?
-
-        constant = Object
-        names.each do |name|
-          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
-        end
-        constant
-      end
-    end
-  end
-end
-
-begin
-  require 'active_support/core_ext/hash/keys'
-  require 'active_support/core_ext/hash/deep_merge'
-rescue LoadError
-end
-
-class Hash
-  include Shoryuken::HashExt::StringifyKeys unless method_defined?(:stringify_keys)
-  include Shoryuken::HashExt::SymbolizeKeys unless method_defined?(:symbolize_keys)
-  include Shoryuken::HashExt::DeepSymbolizeKeys unless method_defined?(:deep_symbolize_keys)
-end
-
-begin
-  require 'active_support/core_ext/string/inflections'
-rescue LoadError
-end
-
-class String
-  include Shoryuken::StringExt::Constantize unless method_defined?(:constantize)
-end

data/lib/shoryuken/extensions/active_job_adapter.rb

@@ -1,103 +0,0 @@
-# ActiveJob docs: http://edgeguides.rubyonrails.org/active_job_basics.html
-# Example adapters ref: https://github.com/rails/rails/tree/master/activejob/lib/active_job/queue_adapters
-
-require 'shoryuken'
-
-module ActiveJob
-  module QueueAdapters
-    # == Shoryuken adapter for Active Job
-    #
-    # Shoryuken ("sho-ryu-ken") is a super-efficient AWS SQS thread based message processor.
-    #
-    # Read more about Shoryuken {here}[https://github.com/phstc/shoryuken].
-    #
-    # To use Shoryuken set the queue_adapter config to +:shoryuken+.
-    #
-    #   Rails.application.config.active_job.queue_adapter = :shoryuken
-    class ShoryukenAdapter
-      class << self
-        def instance
-          # https://github.com/phstc/shoryuken/pull/174#issuecomment-174555657
-          @instance ||= new
-        end
-
-        def enqueue(job)
-          instance.enqueue(job)
-        end
-
-        def enqueue_at(job, timestamp)
-          instance.enqueue_at(job, timestamp)
-        end
-      end
-
-      def enqueue(job, options = {}) #:nodoc:
-        register_worker!(job)
-
-        job.sqs_send_message_parameters.merge! options
-
-        queue = Shoryuken::Client.queues(job.queue_name)
-        send_message_params = message queue, job
-        job.sqs_send_message_parameters = send_message_params
-        queue.send_message send_message_params
-      end
-
-      def enqueue_at(job, timestamp) #:nodoc:
-        enqueue(job, delay_seconds: calculate_delay(timestamp))
-      end
-
-      private
-
-      def calculate_delay(timestamp)
-        delay = (timestamp - Time.current.to_f).round
-        raise 'The maximum allowed delay is 15 minutes' if delay > 15.minutes
-
-        delay
-      end
-
-      def message(queue, job)
-        body = job.serialize
-        job_params = job.sqs_send_message_parameters
-
-        attributes = job_params[:message_attributes] || {}
-
-        msg = {
-          message_body: body,
-          message_attributes: attributes.merge(MESSAGE_ATTRIBUTES)
-        }
-
-        if queue.fifo?
-          # 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))
-      end
-
-      def register_worker!(job)
-        Shoryuken.register_worker(job.queue_name, JobWrapper)
-      end
-
-      class JobWrapper #:nodoc:
-        include Shoryuken::Worker
-
-        shoryuken_options body_parser: :json, auto_delete: true
-
-        def perform(sqs_msg, hash)
-          receive_count = sqs_msg.attributes['ApproximateReceiveCount'].to_i
-          past_receives = receive_count - 1
-          Base.execute hash.merge({ 'executions' => past_receives })
-        end
-      end
-
-      MESSAGE_ATTRIBUTES = {
-        'shoryuken_class' => {
-          string_value: JobWrapper.to_s,
-          data_type: 'String'
-        }
-      }.freeze
-    end
-  end
-end

data/lib/shoryuken/extensions/active_job_concurrent_send_adapter.rb

@@ -1,50 +0,0 @@
-# ActiveJob docs: http://edgeguides.rubyonrails.org/active_job_basics.html
-# Example adapters ref: https://github.com/rails/rails/tree/master/activejob/lib/active_job/queue_adapters
-module ActiveJob
-  module QueueAdapters
-    # == Shoryuken concurrent adapter for Active Job
-    #
-    # This adapter sends messages asynchronously (ie non-blocking) and allows
-    # the caller to set up handlers for both success and failure
-    #
-    # To use this adapter, set up as:
-    #
-    # success_handler = ->(response, job, options) { StatsD.increment("#{job.class.name}.success") }
-    # error_handler = ->(err, job, options) { StatsD.increment("#{job.class.name}.failure") }
-    #
-    # adapter = ActiveJob::QueueAdapters::ShoryukenConcurrentSendAdapter.new(success_handler, error_handler)
-    #
-    # config.active_job.queue_adapter = adapter
-    class ShoryukenConcurrentSendAdapter < ShoryukenAdapter
-      def initialize(success_handler = nil, error_handler = nil)
-        @success_handler = success_handler
-        @error_handler = error_handler
-      end
-
-      def enqueue(job, options = {})
-        send_concurrently(job, options) { |f_job, f_options| super(f_job, f_options) }
-      end
-
-      def success_handler
-        @success_handler ||= ->(_send_message_response, _job, _options) { nil }
-      end
-
-      def error_handler
-        @error_handler ||= begin
-          lambda { |error, job, _options|
-            Shoryuken.logger.warn("Failed to enqueue job: #{job.inspect} due to error: #{error}")
-          }
-        end
-      end
-
-      private
-
-      def send_concurrently(job, options)
-        Concurrent::Promises
-          .future(job, options) { |f_job, f_options| [yield(f_job, f_options), f_job, f_options] }
-          .then { |send_message_response, f_job, f_options| success_handler.call(send_message_response, f_job, f_options) }
-          .rescue(job, options) { |err, f_job, f_options| error_handler.call(err, f_job, f_options) }
-      end
-    end
-  end
-end

data/lib/shoryuken/polling/base.rb

@@ -1,67 +0,0 @@
-module Shoryuken
-  module Polling
-    QueueConfiguration = Struct.new(:name, :options) do
-      def hash
-        name.hash
-      end
-
-      def ==(other)
-        case other
-        when String
-          if options.empty?
-            name == other
-          else
-            false
-          end
-        else
-          super
-        end
-      end
-
-      alias_method :eql?, :==
-
-      def to_s
-        if options.empty?
-          name
-        else
-          "#<QueueConfiguration #{name} options=#{options.inspect}>"
-        end
-      end
-    end
-
-    class BaseStrategy
-      include Util
-
-      def next_queue
-        fail NotImplementedError
-      end
-
-      def messages_found(_queue, _messages_found)
-        fail NotImplementedError
-      end
-
-      def message_processed(_queue); end
-
-      def active_queues
-        fail NotImplementedError
-      end
-
-      def ==(other)
-        case other
-        when Array
-          @queues == other
-        else
-          if other.respond_to?(:active_queues)
-            active_queues == other.active_queues
-          else
-            false
-          end
-        end
-      end
-
-      def delay
-        @delay || Shoryuken.options[:delay].to_f
-      end
-    end
-  end
-end

data/spec/integration/launcher_spec.rb

@@ -1,128 +0,0 @@
-require 'spec_helper'
-require 'shoryuken/manager'
-require 'shoryuken/launcher'
-require 'securerandom'
-
-RSpec.describe Shoryuken::Launcher do
-  let(:sqs_client) do
-    Aws::SQS::Client.new(
-      region: 'us-east-1',
-      endpoint: 'http://localhost:5000',
-      access_key_id: 'fake',
-      secret_access_key: 'fake'
-    )
-  end
-
-  let(:executor) do
-    # We can't use Concurrent.global_io_executor in these tests since once you
-    # shut down a thread pool, you can't start it back up. Instead, we create
-    # one new thread pool executor for each spec. We use a new
-    # CachedThreadPool, since that most closely resembles
-    # Concurrent.global_io_executor
-    Concurrent::CachedThreadPool.new auto_terminate: true
-  end
-
-  describe 'Consuming messages' do
-    before do
-      Aws.config[:stub_responses] = false
-
-      allow(Shoryuken).to receive(:launcher_executor).and_return(executor)
-
-      Shoryuken.configure_client do |config|
-        config.sqs_client = sqs_client
-      end
-
-      Shoryuken.configure_server do |config|
-        config.sqs_client = sqs_client
-      end
-
-      StandardWorker.received_messages = 0
-
-      queue = "shoryuken-travis-#{StandardWorker}-#{SecureRandom.uuid}"
-
-      Shoryuken::Client.sqs.create_queue(queue_name: queue)
-
-      Shoryuken.add_group('default', 1)
-      Shoryuken.add_queue(queue, 1, 'default')
-
-      StandardWorker.get_shoryuken_options['queue'] = queue
-
-      Shoryuken.register_worker(queue, StandardWorker)
-    end
-
-    after do
-      Aws.config[:stub_responses] = true
-
-      queue_url = Shoryuken::Client.sqs.get_queue_url(
-        queue_name: StandardWorker.get_shoryuken_options['queue']
-      ).queue_url
-
-      Shoryuken::Client.sqs.delete_queue(queue_url: queue_url)
-    end
-
-    it 'consumes as a command worker' do
-      StandardWorker.perform_async('Yo')
-
-      poll_queues_until { StandardWorker.received_messages > 0 }
-
-      expect(StandardWorker.received_messages).to eq 1
-    end
-
-    it 'consumes a message' do
-      StandardWorker.get_shoryuken_options['batch'] = false
-
-      Shoryuken::Client.queues(StandardWorker.get_shoryuken_options['queue']).send_message(message_body: 'Yo')
-
-      poll_queues_until { StandardWorker.received_messages > 0 }
-
-      expect(StandardWorker.received_messages).to eq 1
-    end
-
-    it 'consumes a batch' do
-      StandardWorker.get_shoryuken_options['batch'] = true
-
-      entries = 10.times.map { |i| { id: SecureRandom.uuid, message_body: i.to_s } }
-
-      Shoryuken::Client.queues(StandardWorker.get_shoryuken_options['queue']).send_messages(entries: entries)
-
-      # Give the messages a chance to hit the queue so they are all available at the same time
-      sleep 2
-
-      poll_queues_until { StandardWorker.received_messages > 0 }
-
-      expect(StandardWorker.received_messages).to be > 1
-    end
-
-    def poll_queues_until
-      subject.start
-
-      Timeout::timeout(10) do
-        begin
-          sleep 0.5
-        end until yield
-      end
-    ensure
-      subject.stop
-    end
-
-    class StandardWorker
-      include Shoryuken::Worker
-
-      @@received_messages = 0
-
-      shoryuken_options auto_delete: true
-
-      def perform(sqs_msg, _body)
-        @@received_messages += Array(sqs_msg).size
-      end
-
-      def self.received_messages
-        @@received_messages
-      end
-
-      def self.received_messages=(received_messages)
-        @@received_messages = received_messages
-      end
-    end
-  end
-end

data/spec/shoryuken/core_ext_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe 'Core Extensions' do
-  describe Hash do
-    describe '#stringify_keys' do
-      it 'converts keys into strings' do
-        expect({ :key1 => 'value1', 'key2' => 'value2' }.stringify_keys).to eq('key1' => 'value1', 'key2' => 'value2')
-      end
-    end
-
-    describe '#symbolize_keys' do
-      it 'converts keys into symbols' do
-        expect({ :key1 => 'value1', 'key2' => 'value2' }.symbolize_keys).to eq(key1: 'value1', key2: 'value2')
-      end
-    end
-
-    describe '#deep_symbolize_keys' do
-      it 'converts keys into symbols' do
-        expect({ :key1 => 'value1',
-                 'key2' => 'value2',
-                 'key3' => {
-                   'key31' => { 'key311' => 'value311' },
-                   'key32' => 'value32'
-                 } }.deep_symbolize_keys).to eq(key1: 'value1',
-                                                key2: 'value2',
-                                                key3: { key31:                                                                                     { key311: 'value311' },
-                                                        key32: 'value32' })
-      end
-    end
-  end
-
-  describe String do
-    describe '#constantize' do
-      class HelloWorld; end
-      it 'returns a class from a string' do
-        expect('HelloWorld'.constantize).to eq HelloWorld
-      end
-    end
-  end
-end

data/spec/shoryuken/extensions/active_job_adapter_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-require 'shared_examples_for_active_job'
-require 'shoryuken/extensions/active_job_adapter'
-
-RSpec.describe ActiveJob::QueueAdapters::ShoryukenAdapter do
-  include_examples 'active_job_adapters'
-end