active_elastic_job 2.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8e455f174d4846927c18875dd2e1f645a87f870
-  data.tar.gz: 3cd316cd0b53a07cbf66234ccbb2ec71f5fe6e61
+SHA256:
+  metadata.gz: 7314269003451ee2d9b211948b70a351621f340395ffddcf47e7f8362a5e4d4e
+  data.tar.gz: 3b75e291c60225b28aaf879143e49ba16955bd3faed096a9b1c7dc6804aa40f8
 SHA512:
-  metadata.gz: d7ef1844c86ce29e4a93e0184eca63e879b0d43bcc08d1e35ab7573a08975e6943f8eb489028d4f47960780ab60743cbefc760961dd25b3cf49ed49500a00d9b
-  data.tar.gz: e0e5d7390144a3ebf53c756dc7a56436e14dabf4a6e2e37765fefff5625568a93669b7c8623b1f3aa1124c148938468e46d9059d59f604d2f85cb89b9d917798
+  metadata.gz: 0fe756ae355407bb1f923850efbb53e6587dcb136aee42b64467780ab73bc1935210494039a88e02ea7d525846bdcd90ac398136ca33c6389dae66be975d417b
+  data.tar.gz: c6cb04a7f3acee2cce0991d66b665ed544d42903f9b89a124705717af8b3787fd6b4e69de60d0d1c78ff03bde436377d803fc169f3accff0d6f61f50297e1e98

data/active-elastic-job.gemspec

@@ -8,20 +8,31 @@ Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.name          = 'active_elastic_job'
   spec.version       = ActiveElasticJob.version
-  spec.authors       = ['Tawan Sierek']
-  spec.email         = ['tawan@sierek.com']
+  spec.authors       = ['Tawan Sierek', 'Joey Paris']
+  spec.email         = ['tawan@sierek.com', 'mail@joeyparis.me']
   spec.summary       = 'Active Elastic Job is a simple to use Active Job backend for Rails applications deployed on the Amazon Elastic Beanstalk platform.'
   spec.description   = 'Run background jobs / tasks of Rails applications deployed in Amazon Elastic Beanstalk environments. Active Elastic Job is an Active Job backend which is easy to setup. No need for customised container commands or other workarounds.'
   spec.license       = 'MIT'
-  spec.homepage      = 'https://github.com/tawan/active-elastic-job'
+  spec.homepage      = 'https://github.com/active-elastic-job/active-elastic-job'
 
   spec.files         = Dir.glob('lib/**/*') + [ 'active-elastic-job.gemspec' ]
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.add_dependency 'aws-sdk', '~> 2'
-  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_dependency 'aws-sdk-sqs', '~> 1'
+  spec.add_dependency 'rails', '>= 5.0', '<7'
+
+  spec.add_development_dependency 'benchmark-ips', '~> 2.8'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'byebug', '~> 11.1'
+  spec.add_development_dependency 'climate_control', '~> 0.2'
+  spec.add_development_dependency 'dotenv', '~> 2.7'
+  spec.add_development_dependency 'fuubar', '~> 2.5'
+  spec.add_development_dependency 'rdoc', '~> 6.3'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'amazing_print', '~> 1.2'
 end

data/lib/active_elastic_job/rack/sqs_message_consumer.rb

@@ -25,7 +25,10 @@ module ActiveElasticJob
         { 'Content-Type'.freeze => 'text/plain'.freeze },
         [ 'Request forbidden!'.freeze ]
       ]
-      DOCKER_HOST_IP = '172.17.0.1'.freeze
+
+      # 172.17.0.x is the default for Docker
+      # 172.18.0.x is the default for the bridge network of Docker Compose
+      DOCKER_HOST_IP = /172.1(7|8).0.\d+/.freeze
 
       def initialize(app) #:nodoc:
         @app = app
@@ -33,7 +36,7 @@ module ActiveElasticJob
 
       def call(env) #:nodoc:
         request = ActionDispatch::Request.new env
-        if enabled? && aws_sqsd?(request)
+        if enabled? && (aws_sqsd?(request) || sqsd?(request))
           unless request.local? || sent_from_docker_host?(request)
             return FORBIDDEN_RESPONSE
           end
@@ -47,7 +50,7 @@ module ActiveElasticJob
             rescue ActiveElasticJob::MessageVerifier::InvalidDigest => e
               return FORBIDDEN_RESPONSE
             end
-            return OK_RESPONSE 
+            return OK_RESPONSE
           end
         end
         @app.call(env)
@@ -87,6 +90,18 @@ module ActiveElasticJob
           current_user_agent[0..('aws-sqsd'.freeze.size - 1)] == 'aws-sqsd'.freeze)
       end
 
+      def sqsd?(request)
+        # Does not match against a Regexp
+        # in order to avoid performance penalties.
+        # Instead performs a simple string comparison.
+        # Benchmark runs showed an performance increase of
+        # up to 40%
+        current_user_agent = request.headers['User-Agent'.freeze]
+        return (current_user_agent.present? &&
+          current_user_agent.size >= 'sqsd'.freeze.size &&
+          current_user_agent[0..('sqsd'.freeze.size - 1)] == 'sqsd'.freeze)
+      end
+
       def periodic_tasks_route
         @periodic_tasks_route ||= config.periodic_tasks_route
       end
@@ -118,11 +133,15 @@ module ActiveElasticJob
       end
 
       def sent_from_docker_host?(request)
-        app_runs_in_docker_container? && request.remote_ip == DOCKER_HOST_IP
+        app_runs_in_docker_container? && ip_originates_from_docker?(request)
+      end
+
+      def ip_originates_from_docker?(request)
+        (request.remote_ip =~ DOCKER_HOST_IP).present? or (request.remote_addr =~ DOCKER_HOST_IP).present?
       end
 
       def app_runs_in_docker_container?
-        @app_in_docker_container ||= `[ -f /proc/1/cgroup ] && cat /proc/1/cgroup` =~ /docker/
+        (`[ -f /proc/1/cgroup ] && cat /proc/1/cgroup` =~ /(ecs|docker)/).present?
       end
     end
   end

data/lib/active_elastic_job/railtie.rb

@@ -1,8 +1,10 @@
 module ActiveElasticJob
   class Railtie < Rails::Railtie
     config.active_elastic_job = ActiveSupport::OrderedOptions.new
-    config.active_elastic_job.process_jobs = ENV['PROCESS_ACTIVE_ELASTIC_JOBS'] == 'true' || false
-    config.active_elastic_job.aws_credentials = Aws::InstanceProfileCredentials.new
+    process_active_elastic_jobs = ENV['PROCESS_ACTIVE_ELASTIC_JOBS']
+    config.active_elastic_job.process_jobs = !process_active_elastic_jobs.nil? && process_active_elastic_jobs.downcase == 'true'
+    config.active_elastic_job.aws_credentials = lambda { Aws::InstanceProfileCredentials.new }
+    config.active_elastic_job.aws_region = ENV['AWS_REGION']
     config.active_elastic_job.periodic_tasks_route = '/periodic_tasks'.freeze
 
     initializer "active_elastic_job.insert_middleware" do |app|
@@ -11,6 +13,7 @@ module ActiveElasticJob
       end
 
       if app.config.active_elastic_job.process_jobs == true
+        app.config.active_elastic_job.aws_credentials ||= lambda { Aws::InstanceProfileCredentials.new }
         if app.config.force_ssl
           app.config.middleware.insert_before(ActionDispatch::SSL,ActiveElasticJob::Rack::SqsMessageConsumer)
         else

data/lib/active_elastic_job/version.rb

@@ -1,7 +1,7 @@
 module ActiveElasticJob
   module VERSION
-    MAJOR = 2
-    MINOR = 0
+    MAJOR = 3
+    MINOR = 1
     TINY  = 0
     PRE   = nil
 

data/lib/active_elastic_job.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk-core'
+require 'aws-sdk-sqs'
 require 'active_elastic_job/version'
 require 'active_elastic_job/md5_message_digest_calculation'
 require 'active_job/queue_adapters/active_elastic_job_adapter'

data/lib/active_job/queue_adapters/active_elastic_job_adapter.rb

@@ -27,9 +27,8 @@ module ActiveJob
       # imposed by Amazon SQS.
       class SerializedJobTooBig < Error
         def initialize(serialized_job)
-          msg = <<-MSG
           super(<<-MSG)
-            The job contains #{serialized_job.bytesize} bytes in its serialzed form,
+            The job contains #{serialized_job.bytesize} bytes in its serialized form,
             which exceeds the allowed maximum of #{MAX_MESSAGE_SIZE} bytes imposed by Amazon SQS.
           MSG
         end
@@ -77,6 +76,18 @@ module ActiveJob
         end
       end
 
+      # Raised when the delay is longer than the MAX_DELAY_IN_MINUTES
+      class DelayTooLong < RangeError
+        def initialize()
+          super(<<-MSG)
+            Jobs cannot be scheduled more than #{MAX_DELAY_IN_MINUTES} minutes
+            into the future.
+            See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html
+            for further details!
+          MSG
+        end
+      end
+
       def enqueue(job) #:nodoc:
         self.class.enqueue job
       end
@@ -101,6 +112,7 @@ module ActiveJob
               message[:message_body],
               message[:message_attributes])
           end
+          job.provider_job_id = resp.message_id
         rescue Aws::SQS::Errors::NonExistentQueue => e
           unless @queue_urls[job.queue_name.to_s].nil?
             @queue_urls[job.queue_name.to_s] = nil
@@ -114,27 +126,46 @@ module ActiveJob
         private
 
         def aws_client_verifies_md5_digests?
-          Gem::Version.new(Aws::VERSION) >= Gem::Version.new('2.2.19'.freeze)
+          Gem::Version.new(Aws::CORE_GEM_VERSION) >= Gem::Version.new('2.2.19'.freeze)
         end
 
         def build_message(queue_name, serialized_job, timestamp)
-          {
+          args = {
             queue_url: queue_url(queue_name),
             message_body: serialized_job,
             delay_seconds: calculate_delay(timestamp),
-            message_attributes: {
-              "message-digest".freeze => {
-                string_value: message_digest(serialized_job),
-                data_type: "String".freeze
-              },
-              origin: {
-                string_value: ActiveElasticJob::ACRONYM,
-                data_type: "String".freeze
-              }
+            message_attributes: build_message_attributes(serialized_job)
+          }
+
+          if queue_name.split('.').last == 'fifo'
+            args.merge!(fifo_required_params(serialized_job))
+          end
+
+          return args
+        end
+
+        def build_message_attributes(serialized_job)
+          {
+            "message-digest".freeze => {
+              string_value: message_digest(serialized_job),
+              data_type: "String".freeze
+            },
+            origin: {
+              string_value: ActiveElasticJob::ACRONYM,
+              data_type: "String".freeze
             }
           }
         end
 
+        def fifo_required_params(serialized_job)
+          parsed_job = JSON.parse(serialized_job)
+
+          {
+            message_group_id: parsed_job['job_class'],
+            message_deduplication_id: parsed_job['job_id']
+          }
+        end
+
         def queue_url(queue_name)
           cache_key = queue_name.to_s
           @queue_urls ||= { }
@@ -142,18 +173,13 @@ module ActiveJob
           resp = aws_sqs_client.get_queue_url(queue_name: queue_name.to_s)
           @queue_urls[cache_key] = resp.queue_url
         rescue Aws::SQS::Errors::NonExistentQueue => e
-          raise NonExistentQueue, queue_name
+          raise NonExistentQueue.new(queue_name, aws_region)
         end
 
         def calculate_delay(timestamp)
           delay = (timestamp - Time.current.to_f).to_i + 1
           if delay > MAX_DELAY_IN_MINUTES.minutes
-            msg = "Jobs cannot be scheduled more than " <<
-            "#{MAX_DELAY_IN_MINUTES} minutes into the future. " <<
-            "See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html" <<
-            " for further details!"
-
-            raise RangeError, msg
+            raise DelayTooLong.new
           end
           delay = 0 if delay < 0
           delay
@@ -166,11 +192,21 @@ module ActiveJob
         end
 
         def aws_sqs_client
-          @aws_sqs_client ||= Aws::SQS::Client.new(credentials: aws_sqs_client_credentials )
+          options = {
+            credentials: aws_sqs_client_credentials,
+            region: aws_region
+          }
+          endpoint = Rails.application.config.active_elastic_job.endpoint
+          options[:endpoint] = endpoint if endpoint.present?
+          @aws_sqs_client ||= Aws::SQS::Client.new(options)
         end
 
         def aws_sqs_client_credentials
-          config.aws_credentials
+          @aws_credentials ||= if config.aws_credentials.kind_of?(Proc)
+                                 config.aws_credentials.call
+                               else
+                                 config.aws_credentials
+                               end
         end
 
         def aws_region
@@ -181,13 +217,13 @@ module ActiveJob
           Rails.application.config.active_elastic_job
         end
 
-        def message_digest(messsage_body)
+        def message_digest(message_body)
           @verifier ||= ActiveElasticJob::MessageVerifier.new(secret_key_base)
-          @verifier.generate_digest(messsage_body)
+          @verifier.generate_digest(message_body)
         end
 
-        def verify_md5_digests!(response, messsage_body, message_attributes)
-          calculated = md5_of_message_body(messsage_body)
+        def verify_md5_digests!(response, message_body, message_attributes)
+          calculated = md5_of_message_body(message_body)
           returned = response.md5_of_message_body
           if calculated != returned
             raise MD5MismatchError.new response.message_id, calculated, returned
@@ -196,7 +232,7 @@ module ActiveJob
           if message_attributes
             calculated = md5_of_message_attributes(message_attributes)
             returned = response.md5_of_message_attributes
-            if  calculated != returned
+            if calculated != returned
               raise MD5MismatchError.new response.message_id, calculated, returned
             end
           end

metadata

@@ -1,48 +1,196 @@
 --- !ruby/object:Gem::Specification
 name: active_elastic_job
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Tawan Sierek
+- Joey Paris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-27 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-sqs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Run background jobs / tasks of Rails applications deployed in Amazon
   Elastic Beanstalk environments. Active Elastic Job is an Active Job backend which
   is easy to setup. No need for customised container commands or other workarounds.
 email:
 - tawan@sierek.com
+- mail@joeyparis.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -55,7 +203,7 @@ files:
 - lib/active_elastic_job/railtie.rb
 - lib/active_elastic_job/version.rb
 - lib/active_job/queue_adapters/active_elastic_job_adapter.rb
-homepage: https://github.com/tawan/active-elastic-job
+homepage: https://github.com/active-elastic-job/active-elastic-job
 licenses:
 - MIT
 metadata: {}
@@ -67,15 +215,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Active Elastic Job is a simple to use Active Job backend for Rails applications