hirefire-resource 0.7.0 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e583f65c0c003cc4543482e3730952319ddc0069d97332f4f40b85701f61eebd
-  data.tar.gz: efdc10ea1bf9f75333e4605a4ffbc7dd63e40d3e198a552badfb1a79bad21697
+  metadata.gz: 2c7c314af60ca51b3e19880d4f676a5e07ecb5625d8078b7200827a9b2c9338b
+  data.tar.gz: 486392f48c5986bdf100c03a2047496a840c788ffc2af2e27712d41ce6c6cc0b
 SHA512:
-  metadata.gz: 03fe9362bc04329ad02fccb8cc2836176bfbd1d06cef683a24dffa12f399386b592efcc1e8271b854c766a3c495a7d9abeda9e0736d59c86cda38723379c5690
-  data.tar.gz: b80ca0e325253750e54771f9dcf03e60e88c99b999b2dff0f7b596186c23356095dad90fd5ddc0bde1c2ec57fd6cf2475f3d8452c260467f9ef9f7730aaffeef
+  metadata.gz: c10d31c05160fcd258c804e9e7e1ca9d4e608d71ef0a579255f03cac37c2f50b5a81e4c8ea9c24abf57179c3e0e86c5616a0855cee52561eb793d2957608edd2
+  data.tar.gz: b44fd34a1ec5395d2734745e1f72b6a189f37aa285d67177e19764619de1c4770d6a6f40d133cc02e6e3285cc781761df03b9cfb63916974731d2de02325d023

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+## v0.7.5/Master
+
+* Fix compatibility issue with Que 1.x (backwards-compatible with Que 0.x).
+
+## v0.7.4
+
+* Attempt to fix an issue where the STDOUT IO Stream has been closed for an unknown reason.
+  * This resulted in errors in an application with `log_queue_metrics` enabled after a random period of time.
+
+## v0.7.3
+
+* Added priority queue support for bunny message count.
+  * Allows for passing in the `x-max-priority` option when opening up a queue to check the messages remaining.
+  * Usage: `HireFire::Macro::Bunny.queue(queue, amqp_url: url, "x-max-priority": 10 )`
+
+## v0.7.2
+
+* Changed Que macro to query take into account scheduled jobs.
+
+## v0.7.1
+
+* Made entire library threadsafe.
+
+## v0.7.0
+
+* Made `HireFire::Resource.log_queue_metrics` optional. This is now disabled by default.
+  * Enable by setting `log_queue_metrics = true`.
+  * Required when using the `Manager::Web::Logplex::QueueTime` autoscaling strategy.

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.5"
   gem.platform = Gem::Platform::RUBY
   gem.authors = "Michael van Rooijen"
   gem.email = "michael@hirefire.io"
@@ -10,6 +10,12 @@ Gem::Specification.new do |gem|
   gem.summary = "Autoscaling for your Heroku dynos"
   gem.description = "Load- and schedule-based scaling for web- and worker dynos"
   gem.licenses = ["Apache License"]
+  gem.metadata = {
+    "homepage_uri" => "https://www.hirefire.io",
+    "changelog_uri" => "https://github.com/hirefire/hirefire-resource/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/hirefire/hirefire-resource/",
+    "bug_tracker_uri" => "https://github.com/hirefire/hirefire-resource/issues",
+  }
 
   gem.files = %x[git ls-files].split("\n")
   gem.executables = ["hirefire", "hirefireapp"]

data/lib/hirefire/macro/bunny.rb

@@ -70,11 +70,15 @@ module HireFire
 
       def count_messages(channel, queue_names, options)
         queue_names.inject(0) do |sum, queue_name|
-          queue = channel.queue(queue_name, :durable => options[:durable])
+          if options.key?(:'x-max-priority')
+            queue = channel.queue(queue_name, :durable   => options[:durable],
+                                              :arguments => {"x-max-priority" => options[:'x-max-priority']})
+          else
+            queue = channel.queue(queue_name, :durable => options[:durable])
+          end
           sum + queue.message_count
         end
       end
     end
   end
 end
-

data/lib/hirefire/macro/que.rb

@@ -4,14 +4,8 @@ module HireFire
   module Macro
     module Que
       QUERY =  %{
-SELECT count(*)                                                          AS total,
-       count(locks.job_id)                                               AS running,
-       coalesce(sum((error_count > 0 AND locks.job_id IS NULL)::int), 0) AS failing,
-       coalesce(sum((error_count = 0 AND locks.job_id IS NULL)::int), 0) AS scheduled
-FROM que_jobs LEFT JOIN (
-  SELECT (classid::bigint << 32) + objid::bigint AS job_id
-  FROM pg_locks WHERE locktype = 'advisory'
-) locks USING (job_id) }.freeze
+SELECT count(*) AS total
+FROM que_jobs WHERE run_at < now() }.freeze
 
       extend self
 
@@ -25,10 +19,17 @@ FROM que_jobs LEFT JOIN (
       # @param [String] queue the queue name to count. (default: nil # gets all queues)
       # @return [Integer] the number of jobs in the queue(s).
       #
-      def queue(queue = nil)
-        query = queue ? "#{QUERY} WHERE queue = '#{queue}'" : QUERY
+      def queue(*queues)
+        query = case
+        when queues.none? then QUERY
+        when queues.one? then "#{QUERY} AND queue = '#{queues.first}'"
+        else
+          queue_names = queues.map { |queue| "'#{queue}'" }.join(', ')
+          %Q{#{QUERY} AND queue IN (#{queue_names})}
+        end
+
         results = ::Que.execute(query).first
-        results["total"].to_i - results["failing"].to_i
+        (results[:total] || results["total"]).to_i
       end
     end
   end

data/lib/hirefire/middleware.rb

@@ -3,107 +3,107 @@
 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
+      entries = HireFire::Resource.dynos.map do |config|
+        %({"name":"#{config[:name]}","quantity":#{config[:quantity].call || "null"}})
+      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.
+    # Writes the Heroku Router queue time to $stdout if a String was provided.
     #
     # @param [String] the timestamp from HTTP_X_REQUEST_START.
     #
@@ -111,12 +111,12 @@ module HireFire
       HireFire::Resource.log_queue_metrics && value && log_queue(value)
     end
 
-    # Writes the Heroku Router queue time to STDOUT.
+    # Writes the Heroku Router queue time to $stdout.
     #
     # @param [String] the timestamp from HTTP_X_REQUEST_START.
     #
     def log_queue(value)
-      STDOUT.puts("[hirefire:router] queue=#{get_queue(value)}ms")
+      puts("[hirefire:router] queue=#{get_queue(value)}ms")
     end
 
     # Calculates the difference, in milliseconds, between the
@@ -129,5 +129,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

data/lib/hirefire/resource.rb

@@ -4,7 +4,7 @@ module HireFire
   module Resource
     extend self
 
-    # This option, when enabled, will write queue metrics to STDOUT,
+    # This option, when enabled, will write queue metrics to $stdout,
     # and is only required when using the Web.Logplex.QueueTime strategy.
     #
     # @param [Boolean] Whether or not the queue metrics should be logged.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hirefire-resource
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.5
 platform: ruby
 authors:
 - Michael van Rooijen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies: []
 description: Load- and schedule-based scaling for web- and worker dynos
 email: michael@hirefire.io
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
@@ -40,8 +41,12 @@ files:
 homepage: https://www.hirefire.io
 licenses:
 - Apache License
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://www.hirefire.io
+  changelog_uri: https://github.com/hirefire/hirefire-resource/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/hirefire/hirefire-resource/
+  bug_tracker_uri: https://github.com/hirefire/hirefire-resource/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,9 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Autoscaling for your Heroku dynos
 test_files: []