hirefire-resource 0.10.0 → 1.0.0

data/lib/hirefire/middleware.rb

@@ -1,138 +1,85 @@
 # frozen_string_literal: true
 
+require "json"
+
 module HireFire
   class Middleware
-    # Initializes HireFire::Middleware.
-    #
-    # @param [Proc] app call with `env` to continue down the middleware stack.
-    #
     def initialize(app)
       @app = app
-      @token = ENV["HIREFIRE_TOKEN"]
-      @path_prefix = get_path_prefix
+      @path_prefix = determine_path_prefix
     end
 
-    # 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)
-      handle_queue(env["HTTP_X_REQUEST_START"])
-
-      if test_path?(env["PATH_INFO"])
-        build_test_response
-      elsif info_path?(env["PATH_INFO"])
-        build_info_response
-      else
-        @app.call(env)
+      process_request_queue_time(env)
+
+      if matches_hirefire_path?(env) || matches_info_path?(env)
+        return construct_info_response
       end
+
+      @app.call(env)
     end
 
     private
 
-    # Determines whether or not the test path has been requested.
-    #
-    # @param [String] path_info the requested path.
-    # @return [Boolean] true if the requested path matches the test path.
-    #
-    def test_path?(path_info)
-      get_path(path_info) == "/hirefire/test"
+    def matches_hirefire_path?(env)
+      ENV["HIREFIRE_TOKEN"] && extract_path(env) == "/hirefire" && ENV["HIREFIRE_TOKEN"] == env["HTTP_HIREFIRE_TOKEN"]
     end
 
-    # Determines whether or not the info path has been requested.
-    #
-    # @param [String] path_info the requested path.
-    # @return [Boolean] true if the requested path matches the info path.
-    #
-    def info_path?(path_info)
-      get_path(path_info) == "/hirefire/#{@token || "development"}/info"
+    def matches_info_path?(env)
+      ENV["HIREFIRE_TOKEN"] && extract_path(env) == "/hirefire/#{ENV["HIREFIRE_TOKEN"]}/info"
     end
 
-    # The provided path with @path_prefix stripped off.
-    #
-    # @param [String] path_info the requested path.
-    # @return [String] the path without the @path_prefix.
-    #
-    def get_path(path_info)
-      if @path_prefix
-        path_info.gsub(@path_prefix, "")
-      else
-        path_info
-      end
+    def extract_path(env)
+      @path_prefix ? env["PATH_INFO"].gsub(@path_prefix, "") : env["PATH_INFO"]
     end
 
-    # Builds the response for the test path.
-    #
-    # @return [String] in text/html format.
-    #
-    def build_test_response
-      status = 200
-      headers = {"Content-Type" => "text/html"}
-      body = "HireFire Middleware Found!"
-
-      [status, headers, [body]]
+    def construct_info_response
+      [
+        200,
+        {
+          "Content-Type" => "application/json",
+          "Cache-Control" => "must-revalidate, private, max-age=0",
+          "HireFire-Resource" => "Ruby-#{HireFire::VERSION}"
+        },
+        [
+          HireFire.configuration.workers.map do |worker|
+            {name: worker.name, value: worker.value}
+          end.to_json
+        ]
+      ]
     end
 
-    # Builds the response for the info path containing the configured
-    # queues and their sizes based on the HireFire::Resource configuration.
-    #
-    # @return [String] in application/json format.
-    #
-    def build_info_response
-      entries = HireFire::Resource.dynos.map do |config|
-        %({"name":"#{config[:name]}","value":#{config[:value].call || "null"}})
-      end
+    def process_request_queue_time(env)
+      request_start = env["HTTP_X_REQUEST_START"]
 
-      status = 200
-      headers = {}
-      headers["Content-Type"] = "application/json"
-      headers["Cache-Control"] = "must-revalidate, private, max-age=0"
-      body = "[" + entries.join(",") + "]"
+      if HireFire.configuration.web && ENV["HIREFIRE_TOKEN"] && request_start
+        request_queue_time = calculate_request_queue_time(request_start)
+        collect_request_queue_time(request_queue_time)
+      end
 
-      [status, headers, [body]]
+      if HireFire.configuration.log_queue_metrics && request_start
+        request_queue_time = calculate_request_queue_time(request_start)
+        log_request_queue_time(request_queue_time)
+      end
     end
 
-    # Writes the Heroku Router queue time to $stdout if a String was provided.
-    #
-    # @param [String] the timestamp from HTTP_X_REQUEST_START.
-    #
-    def handle_queue(value)
-      HireFire::Resource.log_queue_metrics && value && log_queue(value)
+    def collect_request_queue_time(request_queue_time)
+      HireFire
+        .configuration
+        .web
+        .tap(&:start_dispatcher)
+        .add_to_buffer(request_queue_time)
     end
 
-    # Writes the Heroku Router queue time to $stdout.
-    #
-    # @param [String] the timestamp from HTTP_X_REQUEST_START.
-    #
-    def log_queue(value)
-      puts("[hirefire:router] queue=#{get_queue(value)}ms")
+    def log_request_queue_time(request_queue_time)
+      puts "[hirefire:router] queue=#{request_queue_time}ms"
     end
 
-    # Calculates the difference, in milliseconds, between the
-    # HTTP_X_REQUEST_START time and the current time.
-    #
-    # @param [String] the timestamp from HTTP_X_REQUEST_START.
-    # @return [Integer] the queue time in milliseconds.
-    #
-    def get_queue(value)
-      ms = (Time.now.to_f * 1000).to_i - value.to_i
-      ms < 0 ? 0 : ms
+    def calculate_request_queue_time(timestamp)
+      [(Time.now.to_f * 1000).to_i - timestamp.to_i, 0].max
     end
 
-    # Configures the @path_prefix in order to handle apps
-    # mounted under RAILS_RELATIVE_URL_ROOT.
-    #
-    def get_path_prefix
+    def determine_path_prefix
       if defined?(Rails) && Rails.application.config.relative_url_root
         Regexp.new("^" + Regexp.escape(Rails.application.config.relative_url_root))
       end

data/lib/hirefire/railtie.rb

@@ -2,7 +2,7 @@
 
 module HireFire
   class Railtie < ::Rails::Railtie
-    initializer "hirefire.add_middleware" do |app|
+    initializer "hirefire.insert_middleware" do |app|
       app.config.middleware.insert 0, HireFire::Middleware
     end
   end

data/lib/hirefire/resource.rb

@@ -1,51 +1,5 @@
 # frozen_string_literal: true
 
 module HireFire
-  module Resource
-    extend self
-
-    # 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.
-    #
-    attr_writer :log_queue_metrics
-
-    # @return [Boolean] True if the queue metrics option is enabled.
-    #
-    def log_queue_metrics
-      @log_queue_metrics ||= false
-    end
-
-    # @return [Array] The configured dynos.
-    #
-    def dynos
-      @dynos ||= []
-    end
-
-    # Configures HireFire::Resource.
-    #
-    # @example Resource Configuration
-    #   HireFire::Resource.configure do |config|
-    #     config.log_queue_metrics = true # disabled by default
-    #     config.dyno(:worker) do
-    #       # Macro or Custom logic for the :worker dyno here..
-    #     end
-    #   end
-    #
-    # @yield [HireFire::Resource] to allow for block-style configuration.
-    #
-    def configure
-      yield self
-    end
-
-    # Will be used through block-style configuration with the `configure` method.
-    #
-    # @param [Symbol, String] name the name of the dyno as defined in the Procfile.
-    # @param [Proc] block an Integer containing the value calculation logic.
-    #
-    def dyno(name, &block)
-      dynos << {name: name, value: block}
-    end
-  end
+  Resource = HireFire
 end

data/lib/hirefire/utility.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module HireFire
+  module Utility
+    extend self
+
+    private
+
+    def normalize_queues(queues, allow_empty:)
+      queues = queues.flatten.map { |queue| queue.to_s.strip }
+
+      if queues.any?
+        Set.new(queues)
+      elsif allow_empty
+        Set.new
+      else
+        raise HireFire::Errors::MissingQueueError,
+          "No queue was specified. Please specify at least one queue."
+      end
+    end
+  end
+end

data/lib/hirefire/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HireFire
+  VERSION = "1.0.0"
+end

data/lib/hirefire/web.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+
+module HireFire
+  class Web
+    class DispatchError < StandardError; end
+
+    def initialize
+      @buffer = {}
+      @mutex = Mutex.new
+      @dispatcher_running = false
+      @dispatch_interval = 1
+      @dispatch_timeout = 5
+      @buffer_ttl = 60
+    end
+
+    def start_dispatcher
+      @mutex.synchronize do
+        return false if @dispatcher_running
+        @dispatcher_running = true
+      end
+
+      logger.info "[HireFire] Starting web metrics dispatcher."
+
+      @dispatcher = Thread.new do
+        while dispatcher_running?
+          dispatch_buffer
+          sleep @dispatch_interval
+        end
+      end
+
+      true
+    end
+
+    def stop_dispatcher
+      @mutex.synchronize do
+        return false unless @dispatcher_running
+        @dispatcher_running = false
+      end
+
+      @dispatcher.join(@dispatch_timeout)
+      @dispatcher = nil
+
+      flush_buffer
+
+      logger.info "[HireFire] Web metrics dispatcher stopped."
+
+      true
+    end
+
+    def dispatcher_running?
+      @mutex.synchronize { @dispatcher_running }
+    end
+
+    def add_to_buffer(request_queue_time)
+      @mutex.synchronize do
+        timestamp = Time.now.to_i
+        @buffer[timestamp] ||= []
+        @buffer[timestamp] << request_queue_time
+      end
+    end
+
+    private
+
+    def flush_buffer
+      @mutex.synchronize do
+        @buffer.tap { @buffer = {} }
+      end
+    end
+
+    def dispatch_buffer
+      return unless (buffer = flush_buffer).any?
+      logger.info "[HireFire] Dispatching web metrics: #{buffer}" if ENV["HIREFIRE_VERBOSE"]
+      submit_buffer(buffer)
+    rescue => e
+      repopulate_buffer(buffer)
+      logger.error "[HireFire] Error while dispatching web metrics: #{e.message}"
+    end
+
+    def repopulate_buffer(buffer)
+      now = Time.now.to_i
+      @mutex.synchronize do
+        buffer.each do |timestamp, request_queue_times|
+          next if timestamp < now - @buffer_ttl
+          @buffer[timestamp] ||= []
+          @buffer[timestamp].concat(request_queue_times)
+        end
+      end
+    end
+
+    def submit_buffer(buffer)
+      hirefire_token = ENV["HIREFIRE_TOKEN"]
+
+      unless hirefire_token
+        raise DispatchError, <<~MSG
+          The HIREFIRE_TOKEN environment variable is not set. Unable to submit
+          Request Queue Time metric data. The HIREFIRE_TOKEN can be found in
+          the HireFire Web UI in the web dyno manager settings.
+        MSG
+      end
+
+      uri = URI.parse(ENV.fetch("HIREFIRE_DISPATCH_URL", "https://logdrain.hirefire.io/"))
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.read_timeout = @dispatch_timeout
+      http.open_timeout = @dispatch_timeout
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request["Content-Type"] = "application/json"
+      request["HireFire-Token"] = ENV["HIREFIRE_TOKEN"]
+      request["HireFire-Resource"] = "Ruby-#{HireFire::VERSION}"
+      request.body = buffer.to_json
+      response = http.request(request)
+
+      case response
+      when Net::HTTPSuccess
+        adjust_parameters(response)
+        response
+      when Net::HTTPServerError
+        raise DispatchError, "Server responded with #{response.code} status."
+      else
+        raise DispatchError, "Unexpected response code #{response.code}."
+      end
+    rescue Timeout::Error
+      raise DispatchError, "Request timed out."
+    rescue SocketError => e
+      raise DispatchError, "Network error occurred (#{e.message})."
+    rescue => e
+      raise DispatchError, "An unexpected error occurred (#{e.message})."
+    end
+
+    def adjust_parameters(response)
+      if response.key?("HireFire-Resource-Dispatch-Interval")
+        @dispatch_interval = response["HireFire-Resource-Dispatch-Interval"].to_i
+      end
+
+      if response.key?("HireFire-Resource-Dispatch-Timeout")
+        @dispatch_timeout = response["HireFire-Resource-Dispatch-Timeout"].to_i
+      end
+
+      if response.key?("HireFire-Resource-Buffer-TTL")
+        @buffer_ttl = response["HireFire-Resource-Buffer-TTL"].to_i
+      end
+    end
+
+    def logger
+      HireFire.configuration.logger
+    end
+  end
+end

data/lib/hirefire/worker.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module HireFire
+  class Worker
+    class InvalidDynoNameError < StandardError; end
+
+    class MissingDynoBlockError < StandardError; end
+
+    PROCESS_NAME_PATTERN = /\A[a-zA-Z][a-zA-Z0-9_]{0,29}\z/
+
+    attr_reader :name
+
+    def initialize(name, &block)
+      validate(name, &block)
+      @name = name
+      @block = block
+    end
+
+    def value
+      @block.call
+    end
+
+    private
+
+    def validate(name, &block)
+      unless name.to_s.match?(PROCESS_NAME_PATTERN)
+        raise InvalidDynoNameError,
+          "Invalid name for HireFire::Worker.new(#{name}, &block). " \
+          "Ensure it matches the Procfile process name (i.e. web, worker)."
+      end
+
+      unless block
+        raise MissingDynoBlockError,
+          "Missing block for HireFire::Worker.new(#{name}, &block). " \
+          "Ensure that you provide a block that returns the job queue metric."
+      end
+    end
+  end
+end

data/lib/hirefire-resource.rb

@@ -1,13 +1,8 @@
 # frozen_string_literal: true
 
-HIREFIRE_PATH = File.expand_path("../hirefire", __FILE__)
+require_relative "hirefire/utility"
 
-%w[middleware resource].each do |file|
-  require "#{HIREFIRE_PATH}/#{file}"
+Dir[File.expand_path("../hirefire/**/*.rb", __FILE__)].sort.each do |file|
+  next if file.include?("railtie.rb") && !defined?(Rails::Railtie)
+  require file
 end
-
-%w[delayed_job resque sidekiq qu qc bunny que good_job].each do |file|
-  require "#{HIREFIRE_PATH}/macro/#{file}"
-end
-
-require "#{HIREFIRE_PATH}/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,51 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: hirefire-resource
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael van Rooijen
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-14 00:00:00.000000000 Z
-dependencies: []
-description: Load- and schedule-based scaling for web- and worker dynos
-email: michael@hirefire.io
+date: 2024-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 
+email:
+- support@hirefire.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
 - hirefire-resource.gemspec
 - lib/hirefire-resource.rb
+- lib/hirefire/configuration.rb
+- lib/hirefire/errors.rb
+- lib/hirefire/errors/job_queue_latency_unsupported.rb
+- lib/hirefire/hirefire.rb
 - lib/hirefire/macro/bunny.rb
 - lib/hirefire/macro/delayed_job.rb
+- lib/hirefire/macro/deprecated/bunny.rb
+- lib/hirefire/macro/deprecated/delayed_job.rb
+- lib/hirefire/macro/deprecated/good_job.rb
+- lib/hirefire/macro/deprecated/que.rb
+- lib/hirefire/macro/deprecated/queue_classic.rb
+- lib/hirefire/macro/deprecated/resque.rb
+- lib/hirefire/macro/deprecated/sidekiq.rb
 - lib/hirefire/macro/good_job.rb
-- lib/hirefire/macro/qc.rb
-- lib/hirefire/macro/qu.rb
 - lib/hirefire/macro/que.rb
+- lib/hirefire/macro/queue_classic.rb
 - lib/hirefire/macro/resque.rb
 - lib/hirefire/macro/sidekiq.rb
+- lib/hirefire/macro/solid_queue.rb
 - lib/hirefire/middleware.rb
 - lib/hirefire/railtie.rb
 - lib/hirefire/resource.rb
-homepage: https://www.hirefire.io
+- lib/hirefire/utility.rb
+- lib/hirefire/version.rb
+- lib/hirefire/web.rb
+- lib/hirefire/worker.rb
+homepage: https://hirefire.io
 licenses:
-- Apache License
+- MIT
 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:
+  homepage_uri: https://hirefire.io
+  documentation_uri: https://www.rubydoc.info/gems/hirefire-resource
+  changelog_uri: https://github.com/hirefire/hirefire-resource-ruby/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/hirefire/hirefire-resource-ruby
+  bug_tracker_uri: https://github.com/hirefire/hirefire-resource-ruby/issues
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -53,15 +79,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
-summary: Autoscaling for your Heroku dynos
+summary: HireFire integration library for Ruby applications
 test_files: []

data/.github/workflows/main.yml

@@ -1,16 +0,0 @@
-name: Ruby
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0.2
-        bundler-cache: true
-    - name: Run standardrb
-      run: bundle exec rake standard

data/.gitignore

@@ -1,5 +0,0 @@
-.DS_Store
-*.swp
-*.swo
-*.gem
-.yardoc

data/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-gem "rake"
-gem "standardrb"