hirefire-resource 0.7.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36cd4a0814e19db1108226ae96b3c45ecad0a34554ce7373d7d30d7f662e2f3f
-  data.tar.gz: f0d2ea85ac01ca75761ac19702f04fa123beddd0eb4685219196656d1229c2d8
+  metadata.gz: f395466dc5805c8bd4d686f22181e515ac14a600e15e062a8e55d582dc6a0e57
+  data.tar.gz: ad6fd4856109de19979e8a975f65c0697672f09ccbbc67ef635c1e83384533d0
 SHA512:
-  metadata.gz: 57fbf0cd4f9235a99202281f81bb141006b12e816be31ff2d3fc4686c67dd49f7e37f90caeaa22c98b55b93dd2c95d718c09495978cb1165b903a4c654d3f842
-  data.tar.gz: e3a8649ee7bad06d046b2b4c787a531176e90deaa8f5b193254b7f6bdb541f8923c245ca336f22c68f205de9aa10e95d43800fe8a536be1dc4a8db44ace7c6e4
+  metadata.gz: fff67ee5f1bb27f874fbb2f401681ab1fb37c6904f62ac10ab42fb38b256ba1f8638407fc78f914e3aa40c5178c6bffff95a0a40dfab4882aa2726fc815bf8a0
+  data.tar.gz: 52cc6314c95f940140afb1798e2afac18c4cbc7a494f8cc6ea4e3a111aee6fa53876dcb9f85f924a02e843eb560cbc7b755f3ed7e5522d00f1b23f7727e7c70c

data/CHANGELOG.md

@@ -1,4 +1,28 @@
-## v0.7.3/Master
+## v0.9.0/master
+
+* Add `skip_working` to Sidekiq macro
+* Use separate queries for Que 0.x and 1.x
+* Remove `# encoding: utf-8` magic comments
+* Add `# frozen_string_literal: true` magic comments
+
+## v0.8.1
+
+* Correct GoodJob macro to not count finished jobs.
+
+## v0.8.0
+
+* Add GoodJob macro for `good_job` adapter. https://github.com/bensheldon/good_job
+
+## v0.7.5
+
+* 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.

data/README.md

@@ -6,13 +6,14 @@ Load-based scaling, schedule-based scaling, dyno crash recovery, for [Heroku](ht
 
 It supports practically any worker library. We provide out-of-the-box support for:
 
+* Sidekiq
 * Delayed Job
 * Resque
+* GoodJob
 * Qu
+* Que
 * QueueClassic
-* Sidekiq
 * Bunny
-* Que
 
 *Note that you can write your own worker queue logic for almost any other worker library as well.
 HireFire can scale multiple individual worker libraries at the same time, as well as multiple individual queues for any worker library.*

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"

data/hirefire-resource.gemspec

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 Gem::Specification.new do |gem|
   gem.name = "hirefire-resource"
-  gem.version = "0.7.3"
+  gem.version = "0.9.0"
   gem.platform = Gem::Platform::RUBY
   gem.authors = "Michael van Rooijen"
   gem.email = "michael@hirefire.io"
@@ -10,6 +8,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-resource.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 HIREFIRE_PATH = File.expand_path("../hirefire", __FILE__)
 
@@ -6,9 +6,8 @@ HIREFIRE_PATH = File.expand_path("../hirefire", __FILE__)
   require "#{HIREFIRE_PATH}/#{file}"
 end
 
-%w[delayed_job resque sidekiq qu qc bunny que].each do |file|
+%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)
-

data/lib/hirefire/cli.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require "open-uri"
 require "openssl"
@@ -45,4 +45,3 @@ else
     exit 1
   end
 end
-

data/lib/hirefire/macro/bunny.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Macro
@@ -70,9 +70,9 @@ module HireFire
 
       def count_messages(channel, queue_names, options)
         queue_names.inject(0) do |sum, queue_name|
-          if options.key?("x-max-priority")
+          if options.key?(:'x-max-priority')
             queue = channel.queue(queue_name, :durable   => options[:durable],
-                                              :arguments => {"x-max-priority" => options["x-max-priority"]})
+                                              :arguments => {"x-max-priority" => options[:'x-max-priority']})
           else
             queue = channel.queue(queue_name, :durable => options[:durable])
           end

data/lib/hirefire/macro/delayed_job.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Macro
@@ -78,4 +78,3 @@ module HireFire
     end
   end
 end
-

data/lib/hirefire/macro/good_job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module HireFire
+  module Macro
+    module GoodJob
+      extend self
+
+      # Queries the PostgreSQL database through GoodJob in order to
+      # count the amount of jobs in the specified queue.
+      #
+      # @example Queue Macro Usage
+      #   HireFire::Macro::GoodJob.queue # counts all queues.
+      #   HireFire::Macro::GoodJob.queue("email") # counts the `email` queue.
+      #
+      # @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(*queues)
+        scope = ::GoodJob::Job.only_scheduled.unfinished
+        scope = scope.where(queue_name: queues) if queues.any?
+        scope.count
+      end
+    end
+  end
+end

data/lib/hirefire/macro/qc.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Macro
@@ -21,4 +21,3 @@ module HireFire
     end
   end
 end
-

data/lib/hirefire/macro/qu.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Macro
@@ -22,4 +22,3 @@ module HireFire
     end
   end
 end
-

data/lib/hirefire/macro/que.rb

@@ -1,12 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Macro
     module Que
-      QUERY =  %{
-SELECT count(*) AS total
-FROM que_jobs WHERE run_at < now() }.freeze
-
       extend self
 
       # Queries the PostgreSQL database through Que in order to
@@ -19,11 +15,41 @@ FROM que_jobs WHERE run_at < now() }.freeze
       # @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} AND queue = '#{queue}'" : QUERY
+      def queue(*queues)
+        query   = queues.empty? && base_query || base_query + " AND queue IN (#{names(queues)})"
         results = ::Que.execute(query).first
-        results["total"].to_i
+        (results[:total] || results["total"]).to_i
+      end
+
+      private
+
+      def base_query
+        return QUE_V0_QUERY if defined?(::Que::Version)
+        return QUE_V1_QUERY if defined?(::Que::VERSION)
+        raise "Couldn't find Que version"
+      end
+
+      def names(queues)
+        queues.map { |queue| "'#{queue}'" }.join(",")
+      end
+
+      def query_const(query)
+        query.gsub(/\s+/, " ").strip.freeze
       end
+
+      QUE_V0_QUERY = query_const(<<-QUERY)
+        SELECT COUNT(*) AS total
+        FROM que_jobs
+        WHERE run_at < NOW()
+      QUERY
+
+      QUE_V1_QUERY = query_const(<<-QUERY)
+        SELECT COUNT(*) AS total
+        FROM que_jobs
+        WHERE finished_at IS NULL
+        AND expired_at IS NULL
+        AND run_at <= NOW()
+      QUERY
     end
   end
 end

data/lib/hirefire/macro/resque.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Macro

data/lib/hirefire/macro/sidekiq.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Macro
@@ -13,6 +13,7 @@ module HireFire
       #   HireFire::Macro::Sidekiq.queue("audio", "video") # audio and video queues
       #   HireFire::Macro::Sidekiq.queue("email", skip_scheduled: true) # only email, will not count scheduled queue
       #   HireFire::Macro::Sidekiq.queue("audio", skip_retries: true) # only audio, will not count the retries queue
+      #   HireFire::Macro::Sidekiq.queue("audio", skip_working: true) # only audio, will not count already queued
       #
       # @param [Array] queues provide one or more queue names, or none for "all".
       # @return [Integer] the number of jobs in the queue(s).
@@ -60,7 +61,9 @@ module HireFire
           in_retry = ::Sidekiq.redis { |c| c.zcount('retry', '-inf', Time.now.to_f) }
         end
 
-        in_progress = stats.workers_size
+        if !options[:skip_working]
+          in_progress = stats.workers_size
+        end
 
         [in_queues, in_schedule, in_retry, in_progress].compact.inject(&:+)
       end
@@ -96,15 +99,16 @@ module HireFire
 
         now = Time.now.to_i
 
-        # Objects yielded to Workers#each:
-        # https://github.com/mperham/sidekiq/blob/305ab8eedc362325da2e218b2a0e20e510668a42/lib/sidekiq/api.rb#L912
-        in_progress = ::Sidekiq::Workers.new.select do |key, tid, job|
-          queues.include?(job['queue']) && job['run_at'] <= now
-        end.size
+        if !options[:skip_working]
+          # Objects yielded to Workers#each:
+          # https://github.com/mperham/sidekiq/blob/305ab8eedc362325da2e218b2a0e20e510668a42/lib/sidekiq/api.rb#L912
+          in_progress = ::Sidekiq::Workers.new.select do |key, tid, job|
+            queues.include?(job['queue']) && job['run_at'] <= now
+          end.size
+        end
 
         [in_queues, in_schedule, in_retry, in_progress].compact.inject(&:+)
       end
     end
   end
 end
-

data/lib/hirefire/middleware.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   class Middleware
@@ -19,7 +19,7 @@ module HireFire
     #
     # 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
+    # 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.
@@ -103,7 +103,7 @@ module HireFire
       [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

data/lib/hirefire/railtie.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   class Railtie < ::Rails::Railtie

data/lib/hirefire/resource.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 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.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Michael van Rooijen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2020-10-17 00:00:00.000000000 Z
 dependencies: []
 description: Load- and schedule-based scaling for web- and worker dynos
 email: michael@hirefire.io
@@ -30,6 +30,7 @@ files:
 - lib/hirefire/cli.rb
 - lib/hirefire/macro/bunny.rb
 - lib/hirefire/macro/delayed_job.rb
+- lib/hirefire/macro/good_job.rb
 - lib/hirefire/macro/qc.rb
 - lib/hirefire/macro/qu.rb
 - lib/hirefire/macro/que.rb
@@ -41,8 +42,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
@@ -57,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Autoscaling for your Heroku dynos
 test_files: []