good_job 3.22.0 → 3.24.0

data/lib/good_job/probe_server/healthcheck_middleware.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GoodJob
+  class ProbeServer
+    class HealthcheckMiddleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        case Rack::Request.new(env).path
+        when '/', '/status'
+          [200, {}, ["OK"]]
+        when '/status/started'
+          started = GoodJob::Scheduler.instances.any? && GoodJob::Scheduler.instances.all?(&:running?)
+          started ? [200, {}, ["Started"]] : [503, {}, ["Not started"]]
+        when '/status/connected'
+          connected = GoodJob::Scheduler.instances.any? && GoodJob::Scheduler.instances.all?(&:running?) &&
+                      GoodJob::Notifier.instances.any? && GoodJob::Notifier.instances.all?(&:connected?)
+          connected ? [200, {}, ["Connected"]] : [503, {}, ["Not connected"]]
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/good_job/probe_server/not_found_app.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module GoodJob
+  class ProbeServer
+    module NotFoundApp
+      def self.call(_env)
+        [404, {}, ["Not found"]]
+      end
+    end
+  end
+end

data/lib/good_job/probe_server/simple_handler.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module GoodJob
+  class ProbeServer
+    class SimpleHandler
+      SOCKET_READ_TIMEOUT = 5 # in seconds
+
+      def initialize(app, options = {})
+        @app    = app
+        @port   = options[:port]
+        @logger = options[:logger]
+
+        @running = Concurrent::AtomicBoolean.new(false)
+      end
+
+      def stop
+        @running.make_false
+        @server&.close
+      end
+
+      def running?
+        @running.true?
+      end
+
+      def build_future
+        Concurrent::Future.new { run }
+      end
+
+      private
+
+      def run
+        @running.make_true
+        start_server
+        handle_connections if @running.true?
+      rescue StandardError => e
+        @logger.error "Server encountered an error: #{e}"
+      ensure
+        stop
+      end
+
+      def start_server
+        @server = TCPServer.new('0.0.0.0', @port)
+      rescue StandardError => e
+        @logger.error "Failed to start server: #{e}"
+        @running.make_false
+      end
+
+      def handle_connections
+        while @running.true?
+          begin
+            ready_sockets, = IO.select([@server], nil, nil, SOCKET_READ_TIMEOUT)
+            next unless ready_sockets
+
+            client = @server.accept_nonblock
+            request = client.gets
+
+            if request
+              status, headers, body = @app.call(parse_request(request))
+              respond(client, status, headers, body)
+            end
+
+            client.close
+          rescue IO::WaitReadable, Errno::EINTR, Errno::EPIPE
+            retry
+          end
+        end
+      end
+
+      def parse_request(request)
+        method, full_path = request.split
+        path, query = full_path.split('?')
+        { 'REQUEST_METHOD' => method, 'PATH_INFO' => path, 'QUERY_STRING' => query || '' }
+      end
+
+      def respond(client, status, headers, body)
+        client.write "HTTP/1.1 #{status}\r\n"
+        headers.each { |key, value| client.write "#{key}: #{value}\r\n" }
+        client.write "\r\n"
+        body.each { |part| client.write part.to_s }
+      end
+    end
+  end
+end

data/lib/good_job/probe_server/webrick_handler.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GoodJob
+  class ProbeServer
+    class WebrickHandler
+      def initialize(app, options = {})
+        @app    = app
+        @port   = options[:port]
+        @logger = options[:logger]
+        @handler = ::Rack::Handler.get('webrick')
+      end
+
+      def stop
+        @handler&.shutdown
+      end
+
+      def running?
+        @handler&.instance_variable_get(:@server)&.status == :Running
+      end
+
+      def build_future
+        Concurrent::Future.new(args: [@handler, @port, GoodJob.logger]) do |thr_handler, thr_port, thr_logger|
+          thr_handler.run(@app, Port: thr_port, Host: '0.0.0.0', Logger: thr_logger, AccessLog: [])
+        end
+      end
+    end
+  end
+end

data/lib/good_job/probe_server.rb

@@ -8,13 +8,20 @@ module GoodJob
       GoodJob._on_thread_error(thread_error) if thread_error
     end
 
-    def initialize(port:)
-      @port = port
+    def self.default_app
+      ::Rack::Builder.new do
+        use GoodJob::ProbeServer::HealthcheckMiddleware
+        run GoodJob::ProbeServer::NotFoundApp
+      end
+    end
+
+    def initialize(port:, handler: nil, app: nil)
+      app ||= self.class.default_app
+      @handler = build_handler(port: port, handler: handler, app: app)
     end
 
     def start
-      @handler = HttpServer.new(self, port: @port, logger: GoodJob.logger)
-      @future = Concurrent::Future.new { @handler.run }
+      @future = @handler.build_future
       @future.add_observer(self.class, :task_observer)
       @future.execute
     end
@@ -28,19 +35,17 @@ module GoodJob
       @future&.value # wait for Future to exit
     end
 
-    def call(env)
-      case Rack::Request.new(env).path
-      when '/', '/status'
-        [200, {}, ["OK"]]
-      when '/status/started'
-        started = GoodJob::Scheduler.instances.any? && GoodJob::Scheduler.instances.all?(&:running?)
-        started ? [200, {}, ["Started"]] : [503, {}, ["Not started"]]
-      when '/status/connected'
-        connected = GoodJob::Scheduler.instances.any? && GoodJob::Scheduler.instances.all?(&:running?) &&
-                    GoodJob::Notifier.instances.any? && GoodJob::Notifier.instances.all?(&:connected?)
-        connected ? [200, {}, ["Connected"]] : [503, {}, ["Not connected"]]
+    def build_handler(port:, handler:, app:)
+      if handler == :webrick
+        begin
+          require 'webrick'
+          WebrickHandler.new(app, port: port, logger: GoodJob.logger)
+        rescue LoadError
+          GoodJob.logger.warn("WEBrick was requested as the probe server handler, but it's not in the load path. GoodJob doesn't keep WEBrick as a dependency, so you'll have to make sure its added to your Gemfile to make use of it. GoodJob will fallback to its own webserver in the meantime.")
+          SimpleHandler.new(app, port: port, logger: GoodJob.logger)
+        end
       else
-        [404, {}, ["Not found"]]
+        SimpleHandler.new(app, port: port, logger: GoodJob.logger)
       end
     end
   end

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.22.0'
+  VERSION = '3.24.0'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

data/lib/good_job.rb

@@ -32,8 +32,11 @@ require "good_job/log_subscriber"
 require "good_job/multi_scheduler"
 require "good_job/notifier"
 require "good_job/poller"
-require "good_job/http_server"
 require "good_job/probe_server"
+require "good_job/probe_server/healthcheck_middleware"
+require "good_job/probe_server/not_found_app"
+require "good_job/probe_server/simple_handler"
+require "good_job/probe_server/webrick_handler"
 require "good_job/scheduler"
 require "good_job/shared_executor"
 require "good_job/systemd_service"
@@ -247,7 +250,7 @@ module GoodJob
     loop do
       break if limit && iteration >= limit
 
-      result = Rails.application.reloader.wrap { job_performer.next }
+      result = Rails.application.executor.wrap { job_performer.next }
       break unless result
       raise result.unhandled_error if result.unhandled_error
 
@@ -273,7 +276,7 @@ module GoodJob
   def self.migrated?
     # Always update with the most recent migration check
     GoodJob::Execution.reset_column_information
-    GoodJob::Execution.active_job_id_index_removal_migrated?
+    GoodJob::Execution.candidate_lookup_index_migrated?
   end
 
   ActiveSupport.run_load_hooks(:good_job, self)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.22.0
+  version: 3.24.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-03 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -316,6 +330,7 @@ files:
 - app/views/good_job/shared/icons/_dots.html.erb
 - app/views/good_job/shared/icons/_eject.html.erb
 - app/views/good_job/shared/icons/_exclamation.html.erb
+- app/views/good_job/shared/icons/_globe.html.erb
 - app/views/good_job/shared/icons/_info.html.erb
 - app/views/good_job/shared/icons/_moon_stars_fill.html.erb
 - app/views/good_job/shared/icons/_pause.html.erb
@@ -330,7 +345,9 @@ files:
 - config/locales/es.yml
 - config/locales/fr.yml
 - config/locales/ja.yml
+- config/locales/ko.yml
 - config/locales/nl.yml
+- config/locales/pt-BR.yml
 - config/locales/ru.yml
 - config/locales/tr.yml
 - config/locales/uk.yml
@@ -349,6 +366,7 @@ files:
 - lib/generators/good_job/templates/update/migrations/08_create_good_job_labels.rb.erb
 - lib/generators/good_job/templates/update/migrations/09_create_good_job_labels_index.rb.erb
 - lib/generators/good_job/templates/update/migrations/10_remove_good_job_active_id_index.rb.erb
+- lib/generators/good_job/templates/update/migrations/11_create_index_good_job_jobs_for_candidate_lookup.rb.erb
 - lib/generators/good_job/update_generator.rb
 - lib/good_job.rb
 - lib/good_job/active_job_extensions/batches.rb
@@ -369,7 +387,6 @@ files:
 - lib/good_job/daemon.rb
 - lib/good_job/dependencies.rb
 - lib/good_job/engine.rb
-- lib/good_job/http_server.rb
 - lib/good_job/interrupt_error.rb
 - lib/good_job/job_performer.rb
 - lib/good_job/job_performer/metrics.rb
@@ -379,6 +396,10 @@ files:
 - lib/good_job/notifier/process_heartbeat.rb
 - lib/good_job/poller.rb
 - lib/good_job/probe_server.rb
+- lib/good_job/probe_server/healthcheck_middleware.rb
+- lib/good_job/probe_server/not_found_app.rb
+- lib/good_job/probe_server/simple_handler.rb
+- lib/good_job/probe_server/webrick_handler.rb
 - lib/good_job/scheduler.rb
 - lib/good_job/sd_notify.rb
 - lib/good_job/shared_executor.rb
@@ -416,7 +437,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A multithreaded, Postgres-based ActiveJob backend for Ruby on Rails

data/lib/good_job/http_server.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module GoodJob
-  class HttpServer
-    SOCKET_READ_TIMEOUT = 5 # in seconds
-
-    def initialize(app, options = {})
-      @app    = app
-      @port   = options[:port]
-      @logger = options[:logger]
-
-      @running = Concurrent::AtomicBoolean.new(false)
-    end
-
-    def run
-      @running.make_true
-      start_server
-      handle_connections if @running.true?
-    rescue StandardError => e
-      @logger.error "Server encountered an error: #{e}"
-    ensure
-      stop
-    end
-
-    def stop
-      @running.make_false
-      @server&.close
-    end
-
-    def running?
-      @running.true?
-    end
-
-    private
-
-    def start_server
-      @server = TCPServer.new('0.0.0.0', @port)
-    rescue StandardError => e
-      @logger.error "Failed to start server: #{e}"
-      @running.make_false
-    end
-
-    def handle_connections
-      while @running.true?
-        begin
-          ready_sockets, = IO.select([@server], nil, nil, SOCKET_READ_TIMEOUT)
-          next unless ready_sockets
-
-          client = @server.accept_nonblock
-          request = client.gets
-
-          if request
-            status, headers, body = @app.call(parse_request(request))
-            respond(client, status, headers, body)
-          end
-
-          client.close
-        rescue IO::WaitReadable, Errno::EINTR, Errno::EPIPE
-          retry
-        end
-      end
-    end
-
-    def parse_request(request)
-      method, full_path = request.split
-      path, query = full_path.split('?')
-      { 'REQUEST_METHOD' => method, 'PATH_INFO' => path, 'QUERY_STRING' => query || '' }
-    end
-
-    def respond(client, status, headers, body)
-      client.write "HTTP/1.1 #{status}\r\n"
-      headers.each { |key, value| client.write "#{key}: #{value}\r\n" }
-      client.write "\r\n"
-      body.each { |part| client.write part.to_s }
-    end
-  end
-end