workhorse 1.2.16 → 1.2.17.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c50e38fd05785d30e0dfa783d732f46df2be9b980ac0a54dca1a2d91264ff9d
-  data.tar.gz: a4b282a25d39429da15c5380a41a1786b54b24b2b8afb4961786881380eecacf
+  metadata.gz: 25908f294cd9623ebde44ec8bba5181ee54965703f4fb93df18876b216718eb8
+  data.tar.gz: 568e620571a9ded165fee1fc4420efbb6810f073edd4365c6c8efbe7c3676052
 SHA512:
-  metadata.gz: f8fefeb28bb6651e93163e5d9b8744994f681064bf55168b73d8ca5e9c72aee9e3f7642d03a86eb496ebd81bf15e724757cb4f0a6790dcb87e3ae5f3ef09344d
-  data.tar.gz: '090f112b83a2a69015e0244345d30616af8701bf99f2a6814238006efa2cca49850dfe024b26d1359b2863d01bf2c84d0bbf84a7122419f540969ba7f8d66dea'
+  metadata.gz: 83b6ac441e3762f251e35f04dd213044d6fb904a005155235546391cdecd4f9c0c1db24be7c30371da4704b27e6f18aa6ce0b448b6c6c1dbc8c77eeb81faa9e3
+  data.tar.gz: 9c2940a6bfb7cd0be49170d81af2378f27395dbf597f6d8fa2c777bdc812b26d06cc849454ba5925fcf5f26b7724779b3d6e941bc6c9237d6dc251b7d071188f

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Workhorse Changelog
 
+## 1.2.17.rc0 - 2024-02-05
+
+* Add option `config.max_worker_memory_mb` for automatic restart of workers
+  exceeding the specified memory threshold using the `watch` command. Default is
+  `0`, deactivating this feature. See [memory
+  handling](README.md#memory-handling) for more information.
+
+  Sitrox reference: #121312.
+
 ## 1.2.16 - 2023-09-18
 
 * Add support for `--skip-initializer` flag to install generator.

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 - 2023 Sitrox
+Copyright (c) 2017 - 2024 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -464,6 +464,29 @@ jobs database on a regular interval. Workhorse provides the job
 `Workhorse::Jobs::CleanupSucceededJobs` for this purpose that cleans up all
 succeeded jobs. You can run this using your scheduler in a specific interval.
 
+## Memory handling
+
+When dealing with jobs that may exhibit a large memory footprint, it's important
+to note that Ruby might not release consumed memory back to the operating
+system. Consequently, your job workers could accumulate a significant amount of
+memory over time. To address this, Workhorse provides the
+`config.max_worker_memory_mb` option.
+
+If `config.max_worker_memory_mb` is set to a value above `0`, the `watch`
+command will check the memory footprint (RSS / resident size) of all worker
+processes. If any worker exceeds the specified footprint, Workhorse will
+silently restart it to ensure proper memory release. This process does not
+produce any output in the `watch` command.
+
+Example configuration:
+
+```ruby
+# config/initializers/workhorse.rb
+Workhorse.setup do |config|
+  config.max_worker_memory_mb = 512 # Set the memory threshold to 512 megabytes
+end
+```
+
 ## Load hooks
 
 Using the load hook `:workhorse_db_job`, you can inject custom code into the
@@ -540,4 +563,4 @@ Please consult the [FAQ](FAQ.md).
 
 ## Copyright
 
-Copyright © 2017 - 2023 Sitrox. See `LICENSE` for further details.
+Copyright © 2017 - 2024 Sitrox. See `LICENSE` for further details.

data/RUBY_VERSION

@@ -1 +1 @@
-ruby-2.7.1-p83
+ruby-3.2.1-p31

data/VERSION

@@ -1 +1 @@
-1.2.16
+1.2.17.rc0

data/lib/workhorse/daemon.rb

@@ -113,10 +113,14 @@ module Workhorse
       end
 
       if should_be_running && status(quiet: true) != 0
-        return start(quiet: Workhorse.silence_watcher)
+        code = start(quiet: Workhorse.silence_watcher)
       else
-        return 0
+        code = 0
       end
+
+      watch_memory! if should_be_running
+
+      return code
     end
 
     def restart
@@ -144,6 +148,30 @@ module Workhorse
 
     private
 
+    def watch_memory!
+      return if Workhorse.max_worker_memory_mb == 0
+
+      for_each_worker do |worker|
+        pid_file, pid = read_pid(worker)
+        next unless pid_file && pid
+
+        memory = memory_for(pid)
+        next unless memory
+
+        if memory > Workhorse.max_worker_memory_mb
+          stop_worker pid_file, pid
+          start_worker worker
+        end
+      end
+    end
+
+    # Returns the memory (RSS) in MB for the given process.
+    def memory_for(pid)
+      mem = `ps -p #{pid} -o rss=`&.strip
+      return nil if mem.blank?
+      return mem.to_i / 1024
+    end
+
     def for_each_worker(&block)
       @workers.each(&block)
     end

data/lib/workhorse.rb

@@ -75,6 +75,12 @@ module Workhorse
   mattr_accessor :stale_detection_run_time_threshold
   self.stale_detection_run_time_threshold = 12 * 60
 
+  # Maximum memory for a worker in MB. If this memory limit (RSS / resident
+  # size) is reached for a worker process, the 'watch' command will restart said
+  # worker. Set this to 0 disable this feature.
+  mattr_accessor :max_worker_memory_mb
+  self.max_worker_memory_mb = 0
+
   def self.setup
     yield self
   end

data/workhorse.gemspec

@@ -1,48 +1,31 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.16 ruby lib
+# stub: workhorse 1.2.17.rc0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.16"
+  s.version = "1.2.17.rc0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2023-09-18"
+  s.date = "2024-02-05"
   s.files = [".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, "CHANGELOG.md".freeze, "FAQ.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rubocop".freeze, "lib/active_job/queue_adapters/workhorse_adapter.rb".freeze, "lib/generators/workhorse/install_generator.rb".freeze, "lib/generators/workhorse/templates/bin/workhorse.rb".freeze, "lib/generators/workhorse/templates/config/initializers/workhorse.rb".freeze, "lib/generators/workhorse/templates/create_table_jobs.rb".freeze, "lib/workhorse.rb".freeze, "lib/workhorse/active_job_extension.rb".freeze, "lib/workhorse/daemon.rb".freeze, "lib/workhorse/daemon/shell_handler.rb".freeze, "lib/workhorse/db_job.rb".freeze, "lib/workhorse/enqueuer.rb".freeze, "lib/workhorse/jobs/cleanup_succeeded_jobs.rb".freeze, "lib/workhorse/jobs/detect_stale_jobs_job.rb".freeze, "lib/workhorse/jobs/run_active_job.rb".freeze, "lib/workhorse/jobs/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/scoped_env.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze, "workhorse.gemspec".freeze]
-  s.rubygems_version = "3.1.2".freeze
+  s.rubygems_version = "3.4.6".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze
   s.test_files = ["test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
+  s.specification_version = 4
 
-  if s.respond_to? :add_runtime_dependency then
-    s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
-    s.add_development_dependency(%q<rake>.freeze, [">= 0"])
-    s.add_development_dependency(%q<rubocop>.freeze, ["~> 1.28.0"])
-    s.add_development_dependency(%q<minitest>.freeze, [">= 0"])
-    s.add_development_dependency(%q<mysql2>.freeze, [">= 0"])
-    s.add_development_dependency(%q<colorize>.freeze, [">= 0"])
-    s.add_development_dependency(%q<benchmark-ips>.freeze, [">= 0"])
-    s.add_development_dependency(%q<activejob>.freeze, [">= 0"])
-    s.add_development_dependency(%q<pry>.freeze, [">= 0"])
-    s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
-    s.add_runtime_dependency(%q<activerecord>.freeze, [">= 0"])
-    s.add_runtime_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
-  else
-    s.add_dependency(%q<bundler>.freeze, [">= 0"])
-    s.add_dependency(%q<rake>.freeze, [">= 0"])
-    s.add_dependency(%q<rubocop>.freeze, ["~> 1.28.0"])
-    s.add_dependency(%q<minitest>.freeze, [">= 0"])
-    s.add_dependency(%q<mysql2>.freeze, [">= 0"])
-    s.add_dependency(%q<colorize>.freeze, [">= 0"])
-    s.add_dependency(%q<benchmark-ips>.freeze, [">= 0"])
-    s.add_dependency(%q<activejob>.freeze, [">= 0"])
-    s.add_dependency(%q<pry>.freeze, [">= 0"])
-    s.add_dependency(%q<activesupport>.freeze, [">= 0"])
-    s.add_dependency(%q<activerecord>.freeze, [">= 0"])
-    s.add_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
-  end
+  s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
+  s.add_development_dependency(%q<rake>.freeze, [">= 0"])
+  s.add_development_dependency(%q<rubocop>.freeze, ["~> 1.28.0"])
+  s.add_development_dependency(%q<minitest>.freeze, [">= 0"])
+  s.add_development_dependency(%q<mysql2>.freeze, [">= 0"])
+  s.add_development_dependency(%q<colorize>.freeze, [">= 0"])
+  s.add_development_dependency(%q<benchmark-ips>.freeze, [">= 0"])
+  s.add_development_dependency(%q<activejob>.freeze, [">= 0"])
+  s.add_development_dependency(%q<pry>.freeze, [">= 0"])
+  s.add_runtime_dependency(%q<activesupport>.freeze, [">= 0"])
+  s.add_runtime_dependency(%q<activerecord>.freeze, [">= 0"])
+  s.add_runtime_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 1.2.16
+  version: 1.2.17.rc0
 platform: ruby
 authors:
 - Sitrox
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -242,11 +242,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.