elastic_beans 0.13.0.alpha5 → 0.13.0.alpha6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1afb81d4fa7f5f42059df586f24b1e39a4306f2e
-  data.tar.gz: bf4b9d6263e6e75e76fd1fb02ac3240193712f61
+  metadata.gz: 664c74c9be1710fc97174af435e1cc4e67db6c06
+  data.tar.gz: eb6e2d1028c9a5ca81d0ec6295dd127255f567a5
 SHA512:
-  metadata.gz: c82526896458dd23dff5d494c204b3effde9567f0a752b2bf08800cc7e25017b83c91e01dbfe2399a293f0d763378b2cc3df6249732d2972bac590ca19aabe96
-  data.tar.gz: a5b9fc5746ed2aec887b38fa05212dc7e29bb79c4e7851b65f8405095087c77479b31cdaab069b82f5f6d3fed35ea065dfbaff724de8f32836d3ae30efbcb284
+  metadata.gz: 7890ae4cbe0d96b740cc3348425ce17a49e64766023a2693977198c3f34948803fbf1dd8e7d6fc4bfd779ee0405daabbe5d1dd1fc11fc2eb24f8061af13233ca
+  data.tar.gz: dd413fc4e2ffb0b9a74da493fc87918352cc24d643d58491d3cedefd3625bd19ab19f8903b3cd66fc19c2cb24e26fd52448912af5bcaa02cfd8568664f733f0c

data/README.md

@@ -79,6 +79,25 @@ Elastic Beans exposes the classes it uses to manage Elastic Beanstalk so you can
 
 AWS SDK clients must be passed into Elastic Beans constructors.
 
+### Health check
+
+Elastic Beanstalk worker environments have an internal health check performed on the instance that does not support HTTPS.
+Elastic Beans includes a health check middleware to respond to `GET /` requests originating from `localhost`.
+
+In `config/initializers/elastic_beans.rb`, add the middleware into your stack, below forcing HTTPS:
+
+    require "elastic_beans/rack/health_check"
+
+    if Rails.configuration.force_ssl
+      Rails.configuration.middleware.insert_before(
+        ActionDispatch::SSL,
+        ElasticBeans::Rack::HealthCheck,
+        logger: Rails.logger,
+      )
+    else
+      Rails.configuration.middleware.use(ElasticBeans::Rack::HealthCheck, logger: Rails.logger)
+    end
+
 ### Periodic tasks
 
 Elastic Beanstalk [supports periodic tasks][periodic] by sending a POST request to an endpoint of your application.

data/lib/elastic_beans/rack/exec.rb

@@ -7,7 +7,7 @@ module ElasticBeans
     # ElasticBeans::Application#enqueue_command.
     # Load it in your Rails application so the "scheduler" environment enqueues commands for execution.
     #
-    # Only accepts localhost requests from `aws-sqsd`.
+    # Only accepts localhost requests from +aws-sqsd+.
     class Exec
       FAILURE = ['500', {'Content-type' => 'text/plain'}, [""]]
       SUCCESS = ['200', {'Content-type' => 'text/plain'}, [""]]

data/lib/elastic_beans/rack/health_check.rb

@@ -0,0 +1,43 @@
+require "logger"
+require "action_dispatch"
+
+module ElasticBeans
+  module Rack
+    # A middleware that returns 200 OK to +aws-sqsd+'s health check, which does not support HTTPS.
+    # Load it in your Rails application so non-webserver environments are considered healthy.
+    #
+    # Only accepts localhost requests to +GET+ the root path.
+    class HealthCheck
+      SUCCESS = ['200', {'Content-type' => 'text/plain'}, [""]]
+
+      def initialize(app, args={})
+        @app = app
+        @logger = args[:logger] || Logger.new("/dev/null")
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+        if enabled? && health_request?(request)
+          logger.debug { "[elastic_beans] Healthy response to local client" }
+          return SUCCESS
+        end
+
+        logger.debug { "[elastic_beans] skipped health request: #{request.path}" }
+        app.call(env)
+      end
+
+      private
+
+      attr_reader :app, :logger
+
+      def enabled?
+        worker_disabled = ENV['DISABLE_SQS_CONSUMER'] || 'false'
+        worker_disabled == 'false'
+      end
+
+      def health_request?(request)
+        request.local? && request.method == 'GET' && request.path == '/'
+      end
+    end
+  end
+end

data/lib/elastic_beans/version.rb

@@ -1,3 +1,3 @@
 module ElasticBeans
-  VERSION = "0.13.0.alpha5"
+  VERSION = "0.13.0.alpha6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_beans
 version: !ruby/object:Gem::Version
-  version: 0.13.0.alpha5
+  version: 0.13.0.alpha6
 platform: ruby
 authors:
 - Adam Stegman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -232,6 +232,7 @@ files:
 - lib/elastic_beans/exec/sqs_consumer.rb
 - lib/elastic_beans/network.rb
 - lib/elastic_beans/rack/exec.rb
+- lib/elastic_beans/rack/health_check.rb
 - lib/elastic_beans/scheduler/ebextension.yml
 - lib/elastic_beans/ssh.rb
 - lib/elastic_beans/ui.rb