hirefire-resource 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e583f65c0c003cc4543482e3730952319ddc0069d97332f4f40b85701f61eebd
-  data.tar.gz: efdc10ea1bf9f75333e4605a4ffbc7dd63e40d3e198a552badfb1a79bad21697
+  metadata.gz: 0bf414cb7e6529a04049ad3e7a7575a1932ec91fc8be57d8a2ce1ccc0922ab49
+  data.tar.gz: 8c78e71660e89df170ca061a328bfaff3d19714d55bf3a8fac04a59fbd9f2569
 SHA512:
-  metadata.gz: 03fe9362bc04329ad02fccb8cc2836176bfbd1d06cef683a24dffa12f399386b592efcc1e8271b854c766a3c495a7d9abeda9e0736d59c86cda38723379c5690
-  data.tar.gz: b80ca0e325253750e54771f9dcf03e60e88c99b999b2dff0f7b596186c23356095dad90fd5ddc0bde1c2ec57fd6cf2475f3d8452c260467f9ef9f7730aaffeef
+  metadata.gz: 2f84e86124b9467d166a839b3c90fd979ac13ccb4f50005dfa0e61e77763191206714a569fe59ea991da41b287d3a165a4740ea49f603ecc65caebc2d924c654
+  data.tar.gz: ce69dbda35b2762f727caa5e0d9fb5c76b3890ffa33cec9c20e46cc021d5b54f5842f337fc7264b00453dcf7074c3befd0db1970f89964ffb3703944d1837bb5

data/hirefire-resource.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name = "hirefire-resource"
-  gem.version = "0.7.0"
+  gem.version = "0.7.1"
   gem.platform = Gem::Platform::RUBY
   gem.authors = "Michael van Rooijen"
   gem.email = "michael@hirefire.io"

data/lib/hirefire/middleware.rb

@@ -3,104 +3,108 @@
 module HireFire
   class Middleware
 
-    INFO_HEADERS = {
-      "Content-Type" => "application/json",
-      "Cache-Control" => "must-revalidate, private, max-age=0"
-    }
-
-    TEST_HEADERS = {
-      "Content-Type" => "text/html"
-    }
-
-    # Initialize the HireFire::Middleware and store the `app` in `@app`
-    # and `ENV["HIREFIRE_TOKEN"]` in `@token` for convenience.
+    # Initializes HireFire::Middleware.
     #
-    # @param [ActionDispatch::Routing::RouteSet] app.
+    # @param [Proc] app call with `env` to continue down the middleware stack.
     #
     def initialize(app)
-      @app   = app
-      @token = ENV["HIREFIRE_TOKEN"]
-      if defined?(Rails) && Rails.application.config.relative_url_root
-        @path_prefix = Regexp.new("^" + Regexp.escape(Rails.application.config.relative_url_root))
-      end
+      @app         = app
+      @token       = ENV["HIREFIRE_TOKEN"]
+      @path_prefix = get_path_prefix
     end
 
-    # Will respond to the request here if either the `test` or the `info` url was requested.
-    # Otherwise, fall through to the rest of the middleware below HireFire::Middleware.
+    # Intercepts and handles the /hirefire/test, /hirefire/development/info,
+    # and /hirefire/HIREFIRE_TOKEN/info paths. If none of these paths match,
+    # then then request will continue down the middleware stack.
+    #
+    # When HireFire::Resource.log_queue_metrics is enabled, and the HTTP_X_REQUEST_START
+    # header has been injected at the Heroku Router layer, queue time information will be
+    # logged to STDOUT. This data can be used by the HireFire Logdrain with the
+    # Web.Logplex.QueueTime autoscaling strategy.
+    #
+    # Important: Don't set/update instance variables within this- or any underlying methods.
+    # Doing so may result in race conditions when using threaded application servers.
     #
     # @param [Hash] env containing request information.
     #
     def call(env)
-      @env = env
-
       handle_queue(env["HTTP_X_REQUEST_START"])
 
-      if test?
-        [ 200, TEST_HEADERS, self ]
-      elsif info?
-        [ 200, INFO_HEADERS, self ]
+      if test_path?(env["PATH_INFO"])
+        build_test_response
+      elsif info_path?(env["PATH_INFO"])
+        build_info_response
       else
         @app.call(env)
       end
     end
 
-    # Returns text/html when the `test` url is requested.
-    # This is purely to see whether the URL works through the HireFire command-line utility.
-    #
-    # Returns a JSON String when the `info` url is requested.
-    # This url will be requested every minute by HireFire in order to fetch dyno data.
+    private
+
+    # Determines whether or not the test path has been requested.
     #
-    # @return [text/html, application/json] based on whether the `test` or `info` url was requested.
+    # @param [String] path_info the requested path.
+    # @return [Boolean] true if the requested path matches the test path.
     #
-    def each(&block)
-      if test?
-        block.call "HireFire Middleware Found!"
-      elsif info?
-        block.call(dynos)
-      end
+    def test_path?(path_info)
+      get_path(path_info) == "/hirefire/test"
     end
 
-    private
-
-    # Generates a JSON string based on the dyno data.
+    # Determines whether or not the info path has been requested.
     #
-    # @return [String] in JSON format.
+    # @param [String] path_info the requested path.
+    # @return [Boolean] true if the requested path matches the info path.
     #
-    def dynos
-      dyno_data = HireFire::Resource.dynos.inject(String.new) do |json, dyno|
-        json << %(,{"name":"#{dyno[:name]}","quantity":#{dyno[:quantity].call || "null"}})
-        json
-      end
-
-      "[#{dyno_data.sub(",","")}]"
+    def info_path?(path_info)
+      get_path(path_info) == "/hirefire/#{@token || "development"}/info"
     end
 
-    # Rack PATH_INFO with any RAILS_RELATIVE_URL_ROOT stripped off
+    # The provided path with @path_prefix stripped off.
     #
-    # @return [String]
+    # @param [String] path_info the requested path.
+    # @return [String] the path without the @path_prefix.
     #
-    def path
+    def get_path(path_info)
       if @path_prefix
-        @env["PATH_INFO"].gsub(@path_prefix, "")
+        path_info.gsub(@path_prefix, "")
       else
-        @env["PATH_INFO"]
+        path_info
       end
     end
 
-    # Returns true if the PATH_INFO matches the test url.
+    # Builds the response for the test path.
     #
-    # @return [Boolean] true if the requested url matches the test url.
+    # @return [String] in text/html format.
     #
-    def test?
-      path == "/hirefire/test"
+    def build_test_response
+      status  = 200
+      headers = {"Content-Type" => "text/html"}
+      body    = "HireFire Middleware Found!"
+
+      [status, headers, [body]]
     end
 
-    # Returns true if the PATH_INFO matches the info url.
+    # Builds the response for the info path containing the configured
+    # queues and their sizes based on the HireFire::Resource configuration.
     #
-    # @return [Boolean] true if the requested url matches the info url.
+    # @return [String] in application/json format.
     #
-    def info?
-      path == "/hirefire/#{@token || "development"}/info"
+    def build_info_response
+      entry_builder = lambda do |config|
+        %({"name":"#{config[:name]}","quantity":#{config[:quantity].call || "null"}})
+      end
+
+      entries = HireFire::Resource.dynos.inject([]) do |buffer, config|
+        buffer << entry_builder.call(config)
+      end
+
+      status                   = 200
+      headers                  = Hash.new
+      headers["Content-Type"]  = "application/json"
+      headers["Cache-Control"] = "must-revalidate, private, max-age=0"
+      body                     = "[" + entries.join(",") + "]"
+
+      [status, headers, [body]]
     end
 
     # Writes the Heroku Router queue time to STDOUT if a String was provided.
@@ -129,5 +133,14 @@ module HireFire
       ms = (Time.now.to_f * 1000).to_i - value.to_i
       ms < 0 ? 0 : ms
     end
+
+    # Configures the @path_prefix in order to handle apps
+    # mounted under RAILS_RELATIVE_URL_ROOT.
+    #
+    def get_path_prefix
+      if defined?(Rails) && Rails.application.config.relative_url_root
+        Regexp.new("^" + Regexp.escape(Rails.application.config.relative_url_root))
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hirefire-resource
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies: []
 description: Load- and schedule-based scaling for web- and worker dynos
 email: michael@hirefire.io