hirefire-resource 0.7.5 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c7c314af60ca51b3e19880d4f676a5e07ecb5625d8078b7200827a9b2c9338b
-  data.tar.gz: 486392f48c5986bdf100c03a2047496a840c788ffc2af2e27712d41ce6c6cc0b
+  metadata.gz: ff7c7b164fe5e2bb61f464feda1046fff39f0a100825316dc488bf280f73b0b7
+  data.tar.gz: 840da97d1a8463a1ed71e45bd751c57d90ee2b0e428472871e3142d1c8d03c4e
 SHA512:
-  metadata.gz: c10d31c05160fcd258c804e9e7e1ca9d4e608d71ef0a579255f03cac37c2f50b5a81e4c8ea9c24abf57179c3e0e86c5616a0855cee52561eb793d2957608edd2
-  data.tar.gz: b44fd34a1ec5395d2734745e1f72b6a189f37aa285d67177e19764619de1c4770d6a6f40d133cc02e6e3285cc781761df03b9cfb63916974731d2de02325d023
+  metadata.gz: 5be7fb8d94c53c24de38fbc2e55dbf4087eac4cfbf6458ca0ec307c502dbdd5b9dec81d932476dac495d9a5ccdb13d9e1a86033f7efc8f32557279a3b94544f0
+  data.tar.gz: a8c2af9bb6384b663f27ff9267f5b6703425b269c32e302224d43e4defd47d580ded7a3020eec710cdf555dff24f9b241c15e8cbb5a4550296ef927267e99c9a

data/CHANGELOG.md

@@ -1,4 +1,23 @@
-## v0.7.5/Master
+## v0.9.1
+
+* Support GoodJob > 2.2 where Job class is renamed to Execution
+
+## v0.9.0
+
+* 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).
 

data/README.md

@@ -1,18 +1,19 @@
-## [HireFire](https://www.hirefire.io/) - Autoscaling for your Heroku dynos
+## [HireFire] - Autoscaling for [Heroku]
 
-Load-based scaling, schedule-based scaling, dyno crash recovery, for [Heroku](https://www.heroku.com/) web- and worker dynos.
+Response times, queue times, job queues, load and schedule-based autoscaling for web and worker dynos on [Heroku].
 
 ---
 
 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.*
@@ -83,8 +84,12 @@ dj_worker: QUEUES=encode,compress bundle exec rake jobs:work
 
 Now that HireFire will scale both of the these dyno types based on their individual queue sizes. To customize how they scale, log in to the HireFire web interface.
 
-Visit the [official website](https://www.hirefire.io/) for more information!
+Visit the [official website] for more information!
 
 ### License
 
 hirefire-resource is released under the Apache 2.0 license. See LICENSE.
+
+[HireFire]: https://www.hirefire.io/
+[official website]: https://www.hirefire.io/
+[Heroku]: https://www.heroku.com/

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.5"
+  gem.version = "0.9.1"
   gem.platform = Gem::Platform::RUBY
   gem.authors = "Michael van Rooijen"
   gem.email = "michael@hirefire.io"

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

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,26 @@
+# 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)
+        base_class = defined?(::GoodJob::Execution) ? ::GoodJob::Execution : ::GoodJob::Job
+        scope = base_class.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
@@ -20,17 +16,40 @@ FROM que_jobs WHERE run_at < now() }.freeze
       # @return [Integer] the number of jobs in the queue(s).
       #
       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
-
+        query   = queues.empty? && base_query || base_query + " AND queue IN (#{names(queues)})"
         results = ::Que.execute(query).first
         (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

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,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module HireFire
   module Resource

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)
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hirefire-resource
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.9.1
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-30 00:00:00.000000000 Z
+date: 2021-09-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
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Autoscaling for your Heroku dynos