active_elastic_job 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33d8c9fbb99bf26f435b6ec527e34022b1967473
-  data.tar.gz: e87b6fb000e3ee8feac2b549af57b83852358c72
+  metadata.gz: d8e455f174d4846927c18875dd2e1f645a87f870
+  data.tar.gz: 3cd316cd0b53a07cbf66234ccbb2ec71f5fe6e61
 SHA512:
-  metadata.gz: ca2572266cbfd44cfa04270ece01d0e99c26f6768ac6d20aa4f7fd3969130ff5afb2d82f11ac3ba092ddf2378dedeada37c344844a677aebf4e73b650ee50cde
-  data.tar.gz: 068c7a6062081d4d0196d4a865179515f89b9a93375aa55574cd6a724c9316295d56a3b277aaf01c9debf882ed337e00741caf6f83e8111517b2bc920b38fa23
+  metadata.gz: d7ef1844c86ce29e4a93e0184eca63e879b0d43bcc08d1e35ab7573a08975e6943f8eb489028d4f47960780ab60743cbefc760961dd25b3cf49ed49500a00d9b
+  data.tar.gz: e0e5d7390144a3ebf53c756dc7a56436e14dabf4a6e2e37765fefff5625568a93669b7c8623b1f3aa1124c148938468e46d9059d59f604d2f85cb89b9d917798

data/lib/active_elastic_job/rack/sqs_message_consumer.rb

@@ -5,7 +5,13 @@ module ActiveElasticJob
     # This middleware intercepts requests which are sent by the SQS daemon
     # running in {Amazon Elastic Beanstalk worker environments}[http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html].
     # It does this by looking at the +User-Agent+ header.
-    # Furthermore, it verifies the digest which is sent along with a legit SQS
+    # Requesets from the SQS daemon are handled in two alternative cases:
+    #
+    # (1) the processed SQS message was originally triggered by a periodic task
+    # supported by Elastic Beanstalk's Periodic Task feature
+    #
+    # (2) the processed SQS message was queued by this gem representing an active job.
+    # In this case it verifies the digest which is sent along with a legit SQS
     # message, and passed as an HTTP header in the resulting request.
     # The digest is based on Rails' +secrets.secret_key_base+.
     # Therefore, the application running in the web environment, which generates
@@ -13,14 +19,13 @@ module ActiveElasticJob
     # environment, which verifies the digest, have to use the *same*
     # +secrets.secret_key_base+ setting.
     class SqsMessageConsumer
-      USER_AGENT_PREFIX = 'aws-sqsd'.freeze
-      DIGEST_HEADER_NAME = 'HTTP_X_AWS_SQSD_ATTR_MESSAGE_DIGEST'.freeze
-      ORIGIN_HEADER_NAME = 'HTTP_X_AWS_SQSD_ATTR_ORIGIN'.freeze
-      CONTENT_TYPE = 'application/json'.freeze
-      CONTENT_TYPE_HEADER_NAME = 'Content-Type'.freeze
-      OK_RESPONSE_CODE = '200'.freeze
-      INSIDE_DOCKER_CONTAINER = `[ -f /proc/1/cgroup ] && cat /proc/1/cgroup` =~ /docker/
-      DOCKER_HOST_IP = "172.17.0.1".freeze
+      OK_RESPONSE = [ '200'.freeze, { 'Content-Type'.freeze => 'text/plain'.freeze }, [ 'OK'.freeze ] ]
+      FORBIDDEN_RESPONSE = [
+        '403'.freeze,
+        { 'Content-Type'.freeze => 'text/plain'.freeze },
+        [ 'Request forbidden!'.freeze ]
+      ]
+      DOCKER_HOST_IP = '172.17.0.1'.freeze
 
       def initialize(app) #:nodoc:
         @app = app
@@ -28,25 +33,22 @@ module ActiveElasticJob
 
       def call(env) #:nodoc:
         request = ActionDispatch::Request.new env
-        if enabled? && aws_sqsd?(request) && originates_from_gem?(request)
+        if enabled? && aws_sqsd?(request)
           unless request.local? || sent_from_docker_host?(request)
-            m = "Accepts only requests from localhost for job processing".freeze
-            return ['403', {CONTENT_TYPE_HEADER_NAME => 'text/plain' }, [ m ]]
+            return FORBIDDEN_RESPONSE
           end
-          begin
-            verify!(request)
-            job = JSON.load(request.body)
-            ActiveJob::Base.execute(job)
-          rescue ActiveElasticJob::MessageVerifier::InvalidDigest => e
-            return [
-              '403',
-              {CONTENT_TYPE_HEADER_NAME => 'text/plain' },
-              ["incorrect digest"]]
+
+          if periodic_task?(request)
+            execute_periodic_task(request)
+            return OK_RESPONSE
+          elsif originates_from_gem?(request)
+            begin
+              execute_job(request)
+            rescue ActiveElasticJob::MessageVerifier::InvalidDigest => e
+              return FORBIDDEN_RESPONSE
+            end
+            return OK_RESPONSE 
           end
-          return [
-            OK_RESPONSE_CODE ,
-            {CONTENT_TYPE_HEADER_NAME => CONTENT_TYPE },
-            [ '' ]]
         end
         @app.call(env)
       end
@@ -54,35 +56,61 @@ module ActiveElasticJob
       private
 
       def enabled?
-        var = ENV['DISABLE_SQS_CONSUMER'.freeze]
-        var == nil || var == 'false'.freeze
+        Rails.application.config.active_elastic_job.process_jobs == true
       end
 
       def verify!(request)
-        secret_key_base = Rails.application.secrets[:secret_key_base]
         @verifier ||= ActiveElasticJob::MessageVerifier.new(secret_key_base)
-        digest = request.headers[DIGEST_HEADER_NAME]
+        digest = request.headers['HTTP_X_AWS_SQSD_ATTR_MESSAGE_DIGEST'.freeze]
         message = request.body_stream.read
         request.body_stream.rewind
         @verifier.verify!(message, digest)
       end
 
+      def secret_key_base
+        config.secret_key_base
+      end
+
+      def config
+        Rails.application.config.active_elastic_job
+      end
+
       def aws_sqsd?(request)
-        # we do not match against a Regexp
+        # Does not match against a Regexp
         # in order to avoid performance penalties.
-        # Instead we make a simple string comparison.
+        # 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 >= USER_AGENT_PREFIX.size &&
-          current_user_agent[0..(USER_AGENT_PREFIX.size - 1)] == USER_AGENT_PREFIX)
+          current_user_agent.size >= 'aws-sqsd'.freeze.size &&
+          current_user_agent[0..('aws-sqsd'.freeze.size - 1)] == 'aws-sqsd'.freeze)
+      end
+
+      def periodic_tasks_route
+        @periodic_tasks_route ||= config.periodic_tasks_route
+      end
+
+      def periodic_task?(request)
+        !request.fullpath.nil? && request.fullpath[0..(periodic_tasks_route.size - 1)] == periodic_tasks_route
+      end
+
+      def execute_job(request)
+        verify!(request)
+        job = JSON.load(request.body)
+        ActiveJob::Base.execute(job)
+      end
+
+      def execute_periodic_task(request)
+        job_name = request.headers['X-Aws-Sqsd-Taskname']
+        job = job_name.constantize.new
+        job.perform_now
       end
 
       def originates_from_gem?(request)
-        if request.headers[ORIGIN_HEADER_NAME] == ActiveElasticJob::ACRONYM
+        if request.headers['HTTP_X_AWS_SQSD_ATTR_ORIGIN'.freeze] == ActiveElasticJob::ACRONYM
           return true
-        elsif request.headers[DIGEST_HEADER_NAME] != nil
+        elsif request.headers['HTTP_X_AWS_SQSD_ATTR_MESSAGE_DIGEST'.freeze] != nil
           return true
         else
           return false
@@ -90,7 +118,11 @@ module ActiveElasticJob
       end
 
       def sent_from_docker_host?(request)
-        INSIDE_DOCKER_CONTAINER && request.remote_ip == DOCKER_HOST_IP
+        app_runs_in_docker_container? && request.remote_ip == DOCKER_HOST_IP
+      end
+
+      def app_runs_in_docker_container?
+        @app_in_docker_container ||= `[ -f /proc/1/cgroup ] && cat /proc/1/cgroup` =~ /docker/
       end
     end
   end

data/lib/active_elastic_job/railtie.rb

@@ -1,14 +1,16 @@
 module ActiveElasticJob
   class Railtie < Rails::Railtie
     config.active_elastic_job = ActiveSupport::OrderedOptions.new
-    config.active_elastic_job.aws_region = ENV['AWS_REGION']
-    config.active_elastic_job.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
-    config.active_elastic_job.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || ENV['AWS_SECRET_KEY'] || ENV['AMAZON_SECRET_ACCESS_KEY']
-    config.active_elastic_job.disable_sqs_confumer = ENV['DISABLE_SQS_CONSUMER']
+    config.active_elastic_job.process_jobs = ENV['PROCESS_ACTIVE_ELASTIC_JOBS'] == 'true' || false
+    config.active_elastic_job.aws_credentials = Aws::InstanceProfileCredentials.new
+    config.active_elastic_job.periodic_tasks_route = '/periodic_tasks'.freeze
 
     initializer "active_elastic_job.insert_middleware" do |app|
-      disabled = app.config.active_elastic_job.disable_sqs_confumer
-      if disabled == 'false' || disabled.nil?
+      if app.config.active_elastic_job.secret_key_base.blank?
+        app.config.active_elastic_job.secret_key_base = app.secrets[:secret_key_base]
+      end
+
+      if app.config.active_elastic_job.process_jobs == true
         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 = 1
-    MINOR = 7
+    MAJOR = 2
+    MINOR = 0
     TINY  = 0
     PRE   = nil
 

data/lib/active_job/queue_adapters/active_elastic_job_adapter.rb

@@ -19,12 +19,6 @@ module ActiveJob
       MAX_MESSAGE_SIZE = (256 * 1024)
       MAX_DELAY_IN_MINUTES = 15
 
-      if Gem::Version.new(Aws::VERSION) >= Gem::Version.new('2.2.19')
-        AWS_CLIENT_VERIFIES_MD5_DIGESTS = true
-      else
-        AWS_CLIENT_VERIFIES_MD5_DIGESTS = false
-      end
-
       extend ActiveElasticJob::MD5MessageDigestCalculation
 
       class Error < RuntimeError; end;
@@ -56,14 +50,15 @@ module ActiveJob
       #    #..
       #  end
       class NonExistentQueue < Error
-        def initialize(queue_name)
+        def initialize(queue_name, aws_region)
 
           super(<<-MSG)
             The job is bound to queue at #{queue_name}.
             Unfortunately a queue with this name does not exist in this
             region. Either create an Amazon SQS queue named #{queue_name} -
             you can do this in AWS console, make sure to select region
-            '#{ENV['AWS_REGION']}' - or you select another queue for your jobs.
+            '#{aws_region}' - or you
+            select another queue for your jobs.
           MSG
         end
       end
@@ -111,7 +106,7 @@ module ActiveJob
             @queue_urls[job.queue_name.to_s] = nil
             retry
           end
-          raise NonExistentQueue, job
+          raise NonExistentQueue.new(job, aws_region)
         rescue Aws::Errors::ServiceError => e
           raise Error, "Could not enqueue job, #{e.message}"
         end
@@ -119,7 +114,7 @@ module ActiveJob
         private
 
         def aws_client_verifies_md5_digests?
-          return AWS_CLIENT_VERIFIES_MD5_DIGESTS
+          Gem::Version.new(Aws::VERSION) >= Gem::Version.new('2.2.19'.freeze)
         end
 
         def build_message(queue_name, serialized_job, timestamp)
@@ -171,17 +166,19 @@ module ActiveJob
         end
 
         def aws_sqs_client
-          c =  Rails.application.config.active_elastic_job
-          @aws_sqs_client ||= if c.aws_credentials.present?
-                                Aws::SQS::Client.new(
-                                  credentials: c.aws_credentials,
-                                  region: c.aws_region)
-                              else
-                                Aws::SQS::Client.new(
-                                  access_key_id: c.aws_access_key_id,
-                                  secret_access_key: c.aws_secret_access_key,
-                                  region: c.aws_region)
-                              end
+          @aws_sqs_client ||= Aws::SQS::Client.new(credentials: aws_sqs_client_credentials )
+        end
+
+        def aws_sqs_client_credentials
+          config.aws_credentials
+        end
+
+        def aws_region
+          config.aws_region
+        end
+
+        def config
+          Rails.application.config.active_elastic_job
         end
 
         def message_digest(messsage_body)
@@ -206,7 +203,7 @@ module ActiveJob
         end
 
         def secret_key_base
-          @secret_key_base ||= Rails.application.secrets[:secret_key_base]
+          config.secret_key_base
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_elastic_job
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tawan Sierek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-05 00:00:00.000000000 Z
+date: 2016-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk