good_job 2.6.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6815620f600cf3f925daf7a5f13074f79ee26d7ab16b28b28c3be9e1ac2b9ac9
-  data.tar.gz: b7befdf977e9bebe94ac2707bea503c9e60e112045838885ee398a319026af9c
+  metadata.gz: f44a377e368104479ccd928977d0c99c673e468fdcce61530cdfef1ee045c61d
+  data.tar.gz: 3a5b29ba222be53ee571036ed27275517cb810a03bbd9b6fa5733b215742ef50
 SHA512:
-  metadata.gz: ba25873794f78d9e7081a0ae387d4e2c8cf6de96eaa28859e7fe565d85261de57538680f00d172f6eadcb91c157c1d2f34d66df2a630e94440b55fdd1f8ded05
-  data.tar.gz: 76a0d3cd4b76758f72a81f99a04aff2ea50396828b7fa4c440a3d401c01fc4accfb9d821f333b3ff71d517be565f9f9376ad27da5742611ff1744bc70c7d2f16
+  metadata.gz: 833b35f3faa5660d45e14adbb15d2b6f65c7a7cbc127ae0d6d9085844e55fe33c6c1b02cbb6196f5f753bdf7ec76cff18a1976cef3ca26288960f6028c6d3fac
+  data.tar.gz: def64d311e93139e7232fddd9aec1f0c0e0ff49696680dede67f87705d3a0dbc9338d083f1f2a22fdfff572465032c6ec75c97dee1ece7ffac20ca46c76fdc6c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [v2.7.0](https://github.com/bensheldon/good_job/tree/v2.7.0) (2021-11-10)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.6.2...v2.7.0)
+
+**Implemented enhancements:**
+
+- Add http probe for CLI healthcheck/readiness/liveliness [\#452](https://github.com/bensheldon/good_job/pull/452) ([bensheldon](https://github.com/bensheldon))
+- Add explicit Content Security Policy \(CSP\) for Dashboard [\#449](https://github.com/bensheldon/good_job/pull/449) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Add a default Content-Security-Policy for the Dashboard [\#420](https://github.com/bensheldon/good_job/issues/420)
+
 ## [v2.6.2](https://github.com/bensheldon/good_job/tree/v2.6.2) (2021-11-05)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.6.1...v2.6.2)

data/README.md

@@ -55,6 +55,7 @@ For more of the story of GoodJob, read the [introductory blog post](https://isla
     - [Migrate to GoodJob from a different ActiveJob backend](#migrate-to-goodjob-from-a-different-activejob-backend)
     - [Monitor and preserve worked jobs](#monitor-and-preserve-worked-jobs)
     - [PgBouncer compatibility](#pgbouncer-compatibility)
+    - [CLI HTTP health check probes](#cli-http-healthcheck-probes)
 - [Contribute](#contribute)
     - [Gem development](#gem-development)
     - [Release](#release)
@@ -170,6 +171,7 @@ Options:
   [--enable-cron]              # Whether to run cron process (default: false)
   [--daemonize]                # Run as a background daemon (default: false)
   [--pidfile=PIDFILE]          # Path to write daemonized Process ID (env var: GOOD_JOB_PIDFILE, default: tmp/pids/good_job.pid)
+  [--probe-port=PORT]          # Port for http health check (env var: GOOD_JOB_PROBE_PORT, default: nil)
 
 Executes queued jobs.
 
@@ -837,6 +839,61 @@ A workaround to this limitation is to make a direct database connection availabl
     GoodJob.active_record_parent_class = "ApplicationDirectRecord"
     ```
 
+### CLI HTTP health check probes
+
+GoodJob's CLI offers an http health check probe to better manage process lifecycle in containerized environments like Kubernetes:
+
+```bash
+# Run the CLI with a health check on port 7001
+good_job start --probe-port=7001
+
+# or via an environment variable
+GOOD_JOB_PROBE_PORT=7001 good_job start
+
+# Probe the status
+curl localhost:7001/status
+curl localhost:7001/status/started
+curl localhost:7001/status/connected
+```
+
+Multiple health checks are available at different paths:
+
+- `/` or `/status`: the CLI process is running
+- `/status/started`: the multithreaded job executor is running
+- `/status/connected`: the database connection is established
+
+This can be configured, for example with Kubernetes:
+
+```yaml
+spec:
+  containers:
+    - name: good_job
+      image: my_app:latest
+      env:
+        - name: RAILS_ENV
+          value: production
+        - name: GOOD_JOB_PROBE_PORT
+          value: 7001
+      command:
+          - good_job
+          - start
+      ports:
+        - name: probe-port
+          containerPort: 7001
+      startupProbe:
+        httpGet:
+          path: "/status/started"
+          port: probe-port
+        failureThreshold: 30
+        periodSeconds: 10
+      livenessProbe:
+        httpGet:
+          path: "/status/connected"
+          port: probe-port
+        failureThreshold: 1
+        periodSeconds: 10
+```
+
 ## Contribute
 
 Contributions are welcomed and appreciated 🙏

data/engine/app/controllers/good_job/base_controller.rb

@@ -5,6 +5,25 @@ module GoodJob
 
     around_action :switch_locale
 
+    content_security_policy do |policy|
+      policy.default_src(:none) if policy.default_src.blank?
+      policy.connect_src(:self) if policy.connect_src.blank?
+      policy.base_uri(:none) if policy.base_uri.blank?
+      policy.font_src(:self) if policy.font_src.blank?
+      policy.img_src(:self, :data) if policy.img_src.blank?
+      policy.object_src(:none) if policy.object_src.blank?
+      policy.script_src(:self) if policy.script_src.blank?
+      policy.style_src(:self) if policy.style_src.blank?
+      policy.form_action(:self) if policy.form_action.blank?
+      policy.frame_ancestors(:none) if policy.frame_ancestors.blank?
+    end
+
+    before_action do
+      next if request.content_security_policy_nonce_generator
+
+      request.content_security_policy_nonce_generator = ->(_request) { SecureRandom.base64(16) }
+    end
+
     private
 
     def switch_locale(&action)

data/lib/good_job/cli.rb

@@ -79,6 +79,9 @@ module GoodJob
     method_option :pidfile,
                   type: :string,
                   desc: "Path to write daemonized Process ID (env var: GOOD_JOB_PIDFILE, default: tmp/pids/good_job.pid)"
+    method_option :probe_port,
+                  type: :numeric,
+                  desc: "Port for http health check (env var: GOOD_JOB_PROBE_PORT, default: nil)"
 
     def start
       set_up_application!
@@ -93,6 +96,10 @@ module GoodJob
       poller.recipients << [scheduler, :create_thread]
 
       cron_manager = GoodJob::CronManager.new(configuration.cron_entries, start_on_initialize: true) if configuration.enable_cron?
+      if configuration.probe_port
+        probe_server = GoodJob::ProbeServer.new(port: configuration.probe_port)
+        probe_server.start
+      end
 
       @stop_good_job_executable = false
       %w[INT TERM].each do |signal|
@@ -106,6 +113,7 @@ module GoodJob
 
       executors = [notifier, poller, cron_manager, scheduler].compact
       GoodJob._shutdown_all(executors, timeout: configuration.shutdown_timeout)
+      probe_server&.stop
     end
 
     default_task :start

data/lib/good_job/configuration.rb

@@ -195,6 +195,13 @@ module GoodJob
         Rails.application.root.join('tmp', 'pids', 'good_job.pid')
     end
 
+    # Port of the probe server
+    # @return [nil,Integer]
+    def probe_port
+      options[:probe_port] ||
+        env['GOOD_JOB_PROBE_PORT']
+    end
+
     private
 
     def rails_config

data/lib/good_job/probe_server.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GoodJob
+  class ProbeServer
+    RACK_SERVER = 'webrick'
+
+    def self.task_observer(time, output, thread_error) # rubocop:disable Lint/UnusedMethodArgument
+      return if thread_error.is_a? Concurrent::CancelledOperationError
+
+      GoodJob.on_thread_error.call(thread_error) if thread_error && GoodJob.on_thread_error.respond_to?(:call)
+    end
+
+    def initialize(port:)
+      @port = port
+    end
+
+    def start
+      @handler = Rack::Handler.get(RACK_SERVER)
+      @future = Concurrent::Future.new(args: [@handler, @port, GoodJob.logger]) do |thr_handler, thr_port, thr_logger|
+        thr_handler.run(self, Port: thr_port, Logger: thr_logger, AccessLog: [])
+      end
+      @future.add_observer(self.class, :task_observer)
+      @future.execute
+    end
+
+    def running?
+      @handler&.instance_variable_get(:@server)&.status == :Running
+    end
+
+    def stop
+      @handler&.shutdown
+      @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?(&:listening?)
+        connected ? [200, {}, ["Connected"]] : [503, {}, ["Not connected"]]
+      else
+        [404, {}, ["Not found"]]
+      end
+    end
+  end
+end

data/lib/good_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GoodJob
   # GoodJob gem version.
-  VERSION = '2.6.2'
+  VERSION = '2.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -94,6 +94,20 @@ 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: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -410,6 +424,7 @@ files:
 - lib/good_job/multi_scheduler.rb
 - lib/good_job/notifier.rb
 - lib/good_job/poller.rb
+- lib/good_job/probe_server.rb
 - lib/good_job/railtie.rb
 - lib/good_job/scheduler.rb
 - lib/good_job/version.rb