good_job 3.16.4 → 3.17.0

data/lib/good_job/sd_notify.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# This is a copy of https://github.com/agis/ruby-sdnotify as of v0.1.1
+# (commit 21240f1)
+# Any changes have been marked with "FORK:" comments.
+#
+# It is included here because it is a very small gem, and doing so reduces
+# the number of dependencies and the supply chain risks they pose.
+
+# FORK: nest SdNotify inside the GoodJob module to prevent name collisions in
+# case a GoodJob user also uses the actual sd_notify gem.
+module GoodJob
+
+# The MIT License
+#
+# Copyright (c) 2017, 2018, 2019, 2020 Agis Anastasopoulos
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require "socket"
+
+# SdNotify is a pure-Ruby implementation of sd_notify(3). It can be used to
+# notify systemd about state changes. Methods of this package are no-op on
+# non-systemd systems (eg. Darwin).
+#
+# The API maps closely to the original implementation of sd_notify(3),
+# therefore be sure to check the official man pages prior to using SdNotify.
+#
+# @see https://www.freedesktop.org/software/systemd/man/sd_notify.html
+module SdNotify
+  # Exception raised when there's an error writing to the notification socket
+  class NotifyError < RuntimeError; end
+
+  READY     = "READY=1"
+  RELOADING = "RELOADING=1"
+  STOPPING  = "STOPPING=1"
+  STATUS    = "STATUS="
+  ERRNO     = "ERRNO="
+  MAINPID   = "MAINPID="
+  WATCHDOG  = "WATCHDOG=1"
+  FDSTORE   = "FDSTORE=1"
+
+  def self.ready(unset_env=false)
+    notify(READY, unset_env)
+  end
+
+  def self.reloading(unset_env=false)
+    notify(RELOADING, unset_env)
+  end
+
+  def self.stopping(unset_env=false)
+    notify(STOPPING, unset_env)
+  end
+
+  # @param status [String] a custom status string that describes the current
+  #   state of the service
+  def self.status(status, unset_env=false)
+    notify("#{STATUS}#{status}", unset_env)
+  end
+
+  # @param errno [Integer]
+  def self.errno(errno, unset_env=false)
+    notify("#{ERRNO}#{errno}", unset_env)
+  end
+
+  # @param pid [Integer]
+  def self.mainpid(pid, unset_env=false)
+    notify("#{MAINPID}#{pid}", unset_env)
+  end
+
+  def self.watchdog(unset_env=false)
+    notify(WATCHDOG, unset_env)
+  end
+
+  def self.fdstore(unset_env=false)
+    notify(FDSTORE, unset_env)
+  end
+
+  # @param [Boolean] true if the service manager expects watchdog keep-alive
+  #   notification messages to be sent from this process.
+  #
+  # If the $WATCHDOG_USEC environment variable is set,
+  # and the $WATCHDOG_PID variable is unset or set to the PID of the current
+  # process
+  #
+  # @note Unlike sd_watchdog_enabled(3), this method does not mutate the
+  #   environment.
+  def self.watchdog?
+    wd_usec = ENV["WATCHDOG_USEC"]
+    wd_pid = ENV["WATCHDOG_PID"]
+
+    return false if !wd_usec
+
+    begin
+      wd_usec = Integer(wd_usec)
+    rescue
+      return false
+    end
+
+    return false if wd_usec <= 0
+    return true if !wd_pid || wd_pid == $$.to_s
+
+    false
+  end
+
+  # Notify systemd with the provided state, via the notification socket, if
+  # any.
+  #
+  # Generally this method will be used indirectly through the other methods
+  # of the library.
+  #
+  # @param state [String]
+  # @param unset_env [Boolean]
+  #
+  # @return [Fixnum, nil] the number of bytes written to the notification
+  #   socket or nil if there was no socket to report to (eg. the program wasn't
+  #   started by systemd)
+  #
+  # @raise [NotifyError] if there was an error communicating with the systemd
+  #   socket
+  #
+  # @see https://www.freedesktop.org/software/systemd/man/sd_notify.html
+  def self.notify(state, unset_env=false)
+    sock = ENV["NOTIFY_SOCKET"]
+
+    return nil if !sock
+
+    ENV.delete("NOTIFY_SOCKET") if unset_env
+
+    begin
+      Addrinfo.unix(sock, :DGRAM).connect do |s|
+        s.close_on_exec = true
+        s.write(state)
+      end
+    rescue StandardError => e
+      raise NotifyError, "#{e.class}: #{e.message}", e.backtrace
+    end
+  end
+end
+
+# FORK: Finish nesting inside GoodJob.
+end

data/lib/good_job/systemd_service.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'concurrent/timer_task'
+require 'good_job/sd_notify'
+
+module GoodJob # :nodoc:
+  #
+  # Manages communication with systemd to notify it about the status of the
+  # GoodJob CLI. If it doesn't look like systemd is controlling the process,
+  # SystemdService doesn't do anything.
+  #
+  class SystemdService
+    def self.task_observer(_time, _output, thread_error) # :nodoc:
+      return if thread_error.is_a? Concurrent::CancelledOperationError
+
+      ActiveSupport::Notifications.instrument("systemd_watchdog_error.good_job", { error: thread_error })
+      GoodJob._on_thread_error(thread_error) if thread_error
+    end
+
+    # Indicates whether the service is actively notifying systemd's watchdog.
+    def notifying?
+      @watchdog&.running? || false
+    end
+
+    # Notify systemd that the process is ready. If the service is configured in
+    # systemd to use the watchdog, this will also start pinging the watchdog.
+    def start
+      GoodJob::SdNotify.ready
+      run_watchdog
+    end
+
+    # Notify systemd that the process is stopping and stop pinging the watchdog
+    # if currently doing so. If given a block, it will wait for the block to
+    # complete before stopping watchdog notifications, so systemd has a clear
+    # indication when graceful shutdown started and finished.
+    def stop
+      GoodJob::SdNotify.stopping
+
+      yield if block_given?
+
+      @watchdog&.kill
+      @watchdog&.wait_for_termination
+    end
+
+    private
+
+    def run_watchdog
+      return false unless GoodJob::SdNotify.watchdog?
+
+      # Systemd recommends pinging the watchdog at half the configured interval:
+      # https://www.freedesktop.org/software/systemd/man/sd_watchdog_enabled.html
+      interval = watchdog_interval / 2
+
+      ActiveSupport::Notifications.instrument("systemd_watchdog_start.good_job", { interval: interval })
+      @watchdog = Concurrent::TimerTask.execute(execution_interval: interval) do
+        GoodJob::SdNotify.watchdog
+      end
+      @watchdog.add_observer(self.class, :task_observer)
+
+      true
+    end
+
+    def watchdog_interval
+      return 0.0 unless GoodJob::SdNotify.watchdog?
+
+      Integer(ENV.fetch('WATCHDOG_USEC')) / 1_000_000.0
+    end
+  end
+end

data/lib/good_job/version.rb

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

data/lib/good_job.rb

@@ -29,9 +29,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/scheduler"
 require "good_job/shared_executor"
+require "good_job/systemd_service"
 
 # GoodJob is a multithreaded, Postgres-based, ActiveJob backend for Ruby on Rails.
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.16.4
+  version: 3.17.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-30 00:00:00.000000000 Z
+date: 2023-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.1
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -334,6 +320,7 @@ files:
 - app/frontend/good_job/modules/document_ready.js
 - app/frontend/good_job/modules/live_poll.js
 - app/frontend/good_job/modules/popovers.js
+- app/frontend/good_job/modules/theme_controller.js
 - app/frontend/good_job/modules/toasts.js
 - app/frontend/good_job/style.css
 - app/frontend/good_job/vendor/bootstrap/bootstrap.bundle.min.js
@@ -378,15 +365,18 @@ files:
 - app/views/good_job/shared/_navbar.erb
 - app/views/good_job/shared/icons/_arrow_clockwise.html.erb
 - app/views/good_job/shared/icons/_check.html.erb
+- app/views/good_job/shared/icons/_circle_half.html.erb
 - app/views/good_job/shared/icons/_clock.html.erb
 - app/views/good_job/shared/icons/_dash_circle.html.erb
 - app/views/good_job/shared/icons/_dots.html.erb
 - app/views/good_job/shared/icons/_exclamation.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
 - app/views/good_job/shared/icons/_play.html.erb
 - app/views/good_job/shared/icons/_skip_forward.html.erb
 - app/views/good_job/shared/icons/_stop.html.erb
+- app/views/good_job/shared/icons/_sun_fill.html.erb
 - app/views/good_job/shared/icons/_trash.html.erb
 - app/views/layouts/good_job/application.html.erb
 - config/locales/de.yml
@@ -427,6 +417,7 @@ 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/log_subscriber.rb
@@ -437,7 +428,9 @@ files:
 - lib/good_job/poller.rb
 - lib/good_job/probe_server.rb
 - lib/good_job/scheduler.rb
+- lib/good_job/sd_notify.rb
 - lib/good_job/shared_executor.rb
+- lib/good_job/systemd_service.rb
 - lib/good_job/version.rb
 homepage: https://github.com/bensheldon/good_job
 licenses: