postjob 0.5.5 → 0.5.6

data/lib/postjob/workflow.rb

@@ -1,56 +1,32 @@
-
-# including the Workflow module marks a module as a Postjob::Job, and mixes
-# in a couple of methods into the module (see Workflow::JobMethods)
+# This module defines the interface available for workflow modules.
+#
+# This module is extended into the actual workflow module during registering.
 module Postjob::Workflow
-  def self.included(job)
-    expect! job.class.name => "Module"
-
-    # This method should make sure there is a public run method. This, however,
-    # is not possible before the run method is defined. We could do the check
-    # with a job like
-    #
-    # module Foo
-    #   def self.run(arg); ..; end
-    #   include Postjob::Workflow
-    # end
-    #
-    # but not the other way around:
-    #
-    # module Foo
-    #   include Postjob::Workflow
-    #   def self.run(arg); ..; end
-    # end
-    #
-    # We therefore do not make this test here.
-    job.extend JobMethods
+  # Note: we would like to sure that there is a public run method, and we could
+  # inspect the module with a +extended+ callback. This, however, is only
+  # possible when the run method is already defined. So, with a job definition
+  # of
+  #
+  #     module Foo
+  #       include Postjob::Workflow
+  #       def self.run(arg); ..; end
+  #     end
+  #
+  # we cannot run such a test.
+
+  # see Postjob::Runner.async
+  def async(runner, *args, timeout: nil, max_attempts: nil)
+    ::Postjob::Runner.async(runner, *args, timeout: timeout, max_attempts: max_attempts)
   end
 
-  module JobMethods
-    def async(runner, *args, timeout: nil, max_attempts: nil)
-      ::Postjob::Runner.async(runner, *args, timeout: timeout, max_attempts: max_attempts)
-    end
-
-    def await(job, *args, timeout: nil, max_attempts: nil)
-      ::Postjob::Runner.await(job, *args, timeout: timeout, max_attempts: max_attempts)
-    end
-
-    def workflow_token(job)
-      expect! job.parent_id => ::Postjob::Runner.current_job.id
-      ::Postjob::Queue.find_or_create_token(job)
-    end
-
-    def workflow_version
-      @workflow_version || "0.0"
-    end
-
-    def workflow_name
-      "#{name}@#{workflow_version}"
-    end
-
-    private
+  # see Postjob::Runner.await
+  def await(job, *args, timeout: nil, max_attempts: nil)
+    ::Postjob::Runner.await(job, *args, timeout: timeout, max_attempts: max_attempts)
+  end
 
-    def set_workflow_version(workflow_version)
-      @workflow_version = workflow_version
-    end
+  # see Postjob::Runner.workflow_token
+  def workflow_token(job)
+    expect! job.parent_id => ::Postjob::Runner.current_job.id
+    ::Postjob::Queue.find_or_create_token(job)
   end
 end

data/lib/postjob.rb

@@ -1,5 +1,9 @@
 # rubocop:disable Metrics/ParameterLists
 # rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/ModuleLength
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/PerceivedComplexity
 
 require "expectation"
 require "simple/sql"
@@ -13,6 +17,7 @@ require_relative "postjob/workflow"
 require_relative "postjob/registry"
 require_relative "postjob/job"
 require_relative "postjob/worker_session"
+require_relative "postjob/host"
 require_relative "postjob/error"
 require_relative "postjob/queue"
 require_relative "postjob/runner"
@@ -21,26 +26,46 @@ module Postjob
   attr_accessor :logger
   extend self
 
+  def host_id
+    Host.host_id
+  end
+
   # In fast mode <tt>Postjob.run</tt> doesn't wait that long between retrying
   # failed jobs. This mode is enabled by default during tests; and it can be
   # enabled via "postjob run --fast"
   #
   # Note that fast mode should only be used during development and tests.
-  attr_accessor :fast_mode
+  attr_accessor :fast_mode # :nodoc:
   self.fast_mode = false
 
+  # Enqueues a workflow.
+  #
+  # Options include
+  #
+  # - version
+  # - max_attempts
+  # - timeout
+  # - sticky
+  # - cron_interval
+  # - queue
+  #
   def enqueue!(workflow, *args, queue: nil,
                parent_id: nil,
                max_attempts: nil,
                timeout: nil,
                version: nil,
-               tags: nil)
+               tags: nil,
+               cron_interval: nil,
+               sticky: nil)
     expect! queue => [nil, String]
     expect! workflow => String
     expect! parent_id => [nil, Integer]
     expect! max_attempts => [nil, Integer]
     expect! timeout => [nil, Numeric]
     expect! tags => [nil, Hash]
+    expect! sticky => [nil, false, true]
+
+    # -- prepare arguments ----------------------------------------------------
 
     if workflow == "__manual__" && max_attempts != 1
       if parent_id
@@ -52,13 +77,40 @@ module Postjob
       max_attempts = 1
     end
 
+    # -- fetch defaults from registry -----------------------------------------
+
+    spec = Postjob::Registry[workflow]
+    if spec
+      max_attempts    = spec.options.max_attempts if max_attempts.nil?
+      timeout         = spec.options.timeout if timeout.nil?
+      sticky          = spec.options.sticky if sticky.nil?
+      cron_interval   = spec.options.cron_interval if cron_interval.nil?
+      queue           = spec.options.queue if queue.nil?
+    end
+
+    if cron_interval && cron_interval < 300
+      raise "cron interval must be at least 5 minutes"
+    end
+
+    # -- disable existing cron jobs -------------------------------------------
+
+    if cron_interval
+      Queue.disable_cron_jobs(workflow, args)
+    end
+
+    # -- enqueue jobs ---------------------------------------------------------
+
     tags = stringify_hash(tags) if tags
+
     job = Queue.enqueue_job current_worker_session.id, workflow, *args, queue: queue,
                                                                         parent_id: parent_id,
                                                                         max_attempts: max_attempts,
                                                                         timeout: timeout,
                                                                         tags: tags,
-                                                                        version: version
+                                                                        version: version,
+                                                                        cron_interval: cron_interval,
+                                                                        sticky: sticky
+
     logger.info "Generated process #{job}"
     job.id
   end
@@ -147,7 +199,48 @@ module Postjob
   # This method connects to the queue. This means it registers as a new worker_session,
   # if there was no worker_session yet.
   def current_worker_session
-    @worker_session ||= WorkerSession.start!(Registry.workflows_with_versions)
+    @worker_session ||= begin
+      WorkerSession.start!(Registry.runnable_workflows_with_versions)
+    end
+  end
+
+  # Explicitely resolve a workflow.
+  def resolve(token:, result:)
+    job = Queue.find_job_by_token(token)
+    raise "No job with token #{token}" unless job
+
+    Queue.set_job_result current_worker_session.id, job, result, version: nil
+  end
+
+  # Registers a workflow.
+  #
+  # This call registers a workflow with a set of options.
+  #
+  # This is usually used via
+  #
+  #
+  #     module X
+  #       Postjob.register self, max_attempts: 2, timeout: 86400
+  #     end
+  #
+  #
+  # The +workflow+ parameter is either a module which implements a workflow,
+  # or a String with the name of a workflow, and a set of options.
+  #
+  # Options include
+  #
+  # - version
+  # - max_attempts
+  # - timeout
+  # - sticky
+  # - cron_interval
+  # - queue
+  #
+  def register_workflow(workflow, options = {})
+    expect! workflow => [ Module, String ]
+
+    workflow.extend Postjob::Workflow if workflow.is_a?(Module)
+    Registry.register workflow, options
   end
 
   private
@@ -177,23 +270,4 @@ module Postjob
 
     shutdown
   end
-
-  public
-
-  def resolve(token:, result:)
-    job = Queue.find_job_by_token(token)
-    raise "No job with token #{token}" unless job
-
-    Queue.set_job_result current_worker_session.id, job, result, version: nil
-  end
-
-  def register_workflow(workflow, options = {})
-    expect! options => {
-      version: [nil, /^\d+(\.\d+)*/]
-    }
-
-    workflow.include Postjob::Workflow
-    workflow.send(:set_workflow_version, options[:version] || "0.0")
-    Registry.register workflow, options
-  end
 end

data/lib/tools/heartbeat.rb

@@ -26,7 +26,7 @@ require "vmstat/task"
 # and yields current measurements once a second.
 #
 #
-module Heartbeat
+module Heartbeat # :nodoc:
   # The heartbeat monitor watches various machine metrics (disk usage, CPU load, network traffic)
   # and yields current measurements once every cycle_length_seconds seconds.
 
@@ -62,7 +62,7 @@ module Heartbeat
     end
   end
 
-  class Monitor
+  class Monitor # :nodoc:
     def initialize(cycle_length_seconds)
       @history = History.new(15 * 60 / cycle_length_seconds + 1)
       @cycle_length_seconds = cycle_length_seconds

data/lib/tools/history.rb

@@ -1,7 +1,7 @@
 # A History object, which holds the last +size+ objects in memory.
 #
 # Implemented as a ring buffer which wraps over.
-class History
+class History # :nodoc:
   attr_reader :size
 
   def initialize(size)

data/spec/postjob/enqueue_spec.rb

@@ -2,6 +2,9 @@ require "spec_helper"
 
 describe "Postjob.enqueue!" do
   let(:workflow_name) { "WorkflowName" }
+  before(:all) do
+    Postjob.register_workflow "WorkflowName"
+  end
 
   include TestHelper
 

data/spec/postjob/events/heartbeat_event_spec.rb

@@ -3,83 +3,21 @@ require "spec_helper"
 describe "Heartbeat Events" do
   include TestHelper
 
-  # This test uses the nil host_id, which is configured during migration.
-  let(:null_host_id) { "00000000-0000-0000-0000-000000000000" }
-
-  def heartbeat!(host_id: nil)
-    host_id ||= null_host_id
-    Postjob::WorkerSession.send(:run_heartbeat_monitor, host_id) do
-      # By returning false we create only a single heartbeat event
-      false
+  describe "::Postjob::Queue.host_heartbeat" do
+    def run!
+      ::Postjob::Queue.host_heartbeat(null_host_id, {})
     end
-  end
-
-  describe "creation" do
-    before { heartbeat! }
 
     it "creates a heartbeat event" do
-      event = Simple::SQL.ask <<~SQL, into: OpenStruct
-        SELECT * FROM postjob.events
-        WHERE name='heartbeat' ORDER BY created_at DESC
-      SQL
-
-      expect(event.worker_session_id).to be_nil
-      expect(event.host_id).to eq(null_host_id)
-
-      expected_keys = %w(
-        cpu_load_1min cpu_load_5min cpu_load_15min
-        disk_available disk_used
-        net_errors_1min net_errors_5min net_errors_15min
-        net_in_1min net_in_5min net_in_15min
-        net_out_1min net_out_5min net_out_15min
-        uptime
-      )
-
-      expect(event.attributes.keys).to include(*expected_keys)
-    end
+      run!
 
-    it "creates a zombie event" do
       event = Simple::SQL.ask <<~SQL, into: OpenStruct
         SELECT * FROM postjob.events
-        WHERE name='zombie' ORDER BY created_at DESC
+        WHERE name='heartbeat' ORDER BY created_at DESC
       SQL
 
       expect(event.worker_session_id).to be_nil
       expect(event.host_id).to eq(null_host_id)
-      expect(event.attributes.keys).to eq([ "zombie_count" ])
-      expect(event.attributes["zombie_count"]).to be_a(Integer)
-    end
-  end
-
-  describe "zombie checking" do
-    let!(:job_id) { Postjob.enqueue! "HeartbeatSpecWorkflow" }
-
-    before do
-      # change the job status to processing, and move all timestamps into the past.
-      # This simulates a zombie situation.
-      Simple::SQL.ask "UPDATE postjob.postjobs SET status='processing' WHERE id=$1", job_id
-      Simple::SQL.ask "UPDATE postjob.events SET created_at = (now() at time zone 'utc' - interval '2 hours')"
-    end
-
-    context "when running with the real host_id" do
-      it "detects zombies" do
-        job = load_job(job_id)
-        session = Simple::SQL.ask "SELECT * FROM postjob.worker_sessions WHERE id=$1", job.last_worker_session_id, into: OpenStruct
-
-        heartbeat! host_id: session.host_id
-
-        job = Simple::SQL.ask "SELECT * FROM postjob.postjobs WHERE id=$1", job_id, into: Hash
-        expect(job).to include(status: "err", failed_attempts: 1, error: "Zombie", error_message: "zombie")
-      end
-    end
-
-    context "when running with a different host_id" do
-      it "detects zombies" do
-        heartbeat!
-
-        job = Simple::SQL.ask "SELECT * FROM postjob.postjobs WHERE id=$1", job_id, into: Hash
-        expect(job).to include(status: "err", failed_attempts: 1, error: "Zombie", error_message: "zombie")
-      end
     end
   end
 end

data/spec/postjob/events/zombie_event_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+module HeartbeatSpecWorkflow
+  Postjob.register_workflow self
+end
+
+describe "Heartbeat Events" do
+  include TestHelper
+
+  before do
+    Postjob.enqueue! "HeartbeatSpecWorkflow"
+
+    @host_id = Simple::SQL.ask "SELECT id FROM postjob.hosts WHERE id != $1", null_host_id
+
+    send_heartbeat!
+
+    Simple::SQL.ask "UPDATE postjob.postjobs SET status='processing'"
+  end
+
+  let(:host_id) { @host_id || raise("host_id must be set") }
+
+  def send_heartbeat!
+    ::Postjob::Queue.host_heartbeat(host_id, {})
+  end
+
+  describe "::Postjob::Queue.host_heartbeat" do
+    context "zombies in the database" do
+      before do
+        Simple::SQL.ask "UPDATE postjob.events SET created_at = (now() at time zone 'utc' - interval '2 days')"
+      end
+
+      it "does creates a zombie events" do
+        send_heartbeat!
+
+        event = Simple::SQL.ask <<~SQL, into: Hash
+          SELECT * FROM postjob.events
+          WHERE name='zombie' ORDER BY created_at DESC
+        SQL
+
+        expect(event).to include(
+          attributes: { "zombie_count" => 1 },
+          name: "zombie",
+          postjob_id: nil
+        )
+      end
+    end
+  end
+
+  context "no zombies in the database, 2" do
+    it "does creates a zombie events" do
+      send_heartbeat!
+
+      event = Simple::SQL.ask <<~SQL, into: Hash
+        SELECT * FROM postjob.events
+        WHERE name='zombie' ORDER BY created_at DESC
+      SQL
+
+      expect(event).to be_nil
+    end
+  end
+end

data/spec/postjob/worker_session_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "Postjob::WorkerSession.start!" do
-  let(:store_path) { ".postjob.host_id" }
+  let(:store_path) { ".postjob.test.host_id" }
 
   def session_count
     Simple::SQL.ask "SELECT count(*) from postjob.worker_sessions"
@@ -15,27 +15,4 @@ describe "Postjob::WorkerSession.start!" do
       expect(session.id).to match(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i)
     end.to change { session_count }.by(1)
   end
-
-  it "stores and reuses the host_id" do
-    FileUtils.rm_rf store_path
-
-    session = Postjob::WorkerSession.start!(workflows_with_versions)
-    expect(File.read(store_path)).to match(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i)
-
-    session2 = Postjob::WorkerSession.start!(workflows_with_versions)
-    expect(session2.host_id).to eq(session.host_id)
-  end
-
-  context "when passing in an invalid host id" do
-    it "raises an argument error" do
-      invalid_uuid = "foo"
-      File.open store_path, "w" do |io|
-        io.write invalid_uuid
-      end
-
-      expect do
-        Postjob::WorkerSession.start!(workflows_with_versions)
-      end.to raise_error(ArgumentError)
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -40,6 +40,6 @@ RSpec.configure do |config|
   config.after {}
 
   config.before(:all) do
-    FileUtils.rm_rf ::Postjob::WorkerSession::HOST_ID_PATH
+    ::Postjob::Host.clear_storage
   end
 end

data/spec/support/configure_active_record.rb

@@ -1,18 +1,9 @@
 require "active_record"
-ActiveRecord::Base.establish_connection(adapter: "postgresql",
-                                        database: "postjob_test",
-                                        username: "postjob",
-                                        password: "postjob")
 
-# RSpec.configure do |config|
-#   config.around(:each) do |example|
-#     if example.metadata[:transactions] == false
-#       example.run
-#     else
-#       ::ActiveRecord::Base.connection.transaction do
-#         example.run
-#         raise ActiveRecord::Rollback, "clean up"
-#       end
-#     end
-#   end
-# end
+lambda do
+  require "yaml"
+  configs = YAML.load_file "config/database.yml"
+  config = configs.fetch("test")
+
+  ActiveRecord::Base.establish_connection(config)
+end.call

data/spec/support/configure_database.rb

@@ -5,9 +5,20 @@ else
 end
 
 RSpec.configure do |config|
+  # This test uses the nil host_id, which is configured during migration.
+  def null_host_id
+    "00000000-0000-0000-0000-000000000000"
+  end
+
   config.around(:each) do |example|
     Simple::SQL.ask "DELETE FROM postjob.postjobs"
     Simple::SQL.ask "DELETE FROM postjob.tokens"
+    Simple::SQL.ask "DELETE FROM postjob.events"
+    Simple::SQL.ask "DELETE FROM postjob.tokens"
+
+    # Simple::SQL.ask "DELETE FROM postjob.hosts"
+    # Simple::SQL.ask "DELETE FROM postjob.worker_sessions"
+
     example.run
   end
 end

data/spec/support/configure_simple_sql.rb

@@ -1,17 +1 @@
-ENV["DATABASE_URL"] = "postgresql://postjob:postjob@localhost/postjob_test"
 ::Simple::SQL.connect!
-
-# RSpec.configure do |config|
-#   config.around(:each) do |example|
-#     if example.metadata[:transactions] == false
-#       example.run
-#     else
-#       catch(:rollback) do
-#         ::Simple::SQL.transaction do
-#           example.run
-#           throw :rollback
-#         end
-#       end
-#     end
-#   end
-# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postjob
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - radiospiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -226,7 +226,9 @@ files:
 - bin/postjob
 - lib/postjob.rb
 - lib/postjob/cli.rb
+- lib/postjob/cli/cron.rb
 - lib/postjob/cli/db.rb
+- lib/postjob/cli/enqueue.rb
 - lib/postjob/cli/events.rb
 - lib/postjob/cli/heartbeat.rb
 - lib/postjob/cli/hosts.rb
@@ -236,6 +238,7 @@ files:
 - lib/postjob/cli/sessions.rb
 - lib/postjob/cli/version.rb
 - lib/postjob/error.rb
+- lib/postjob/host.rb
 - lib/postjob/job.rb
 - lib/postjob/migrations.rb
 - lib/postjob/migrations/002_statuses.rb
@@ -247,19 +250,21 @@ files:
 - lib/postjob/migrations/006_enqueue.sql
 - lib/postjob/migrations/006a_processing.sql
 - lib/postjob/migrations/007_job_results.sql
-- lib/postjob/migrations/008_checkout_runnable.sql
 - lib/postjob/migrations/008a_childjobs.sql
 - lib/postjob/migrations/009_tokens.sql
 - lib/postjob/migrations/010_settings.sql
 - lib/postjob/migrations/011_null_uuid.sql
 - lib/postjob/migrations/012_hosts.sql
 - lib/postjob/migrations/013_worker_sessions.sql
+- lib/postjob/migrations/013a_checkout_runnable.sql
 - lib/postjob/migrations/014_postjob_session_id.sql
 - lib/postjob/migrations/015_events.sql
 - lib/postjob/migrations/016_sessions_functions.sql
 - lib/postjob/migrations/017_zombie_check.sql
 - lib/postjob/migrations/018_heartbeat.sql
 - lib/postjob/migrations/019_heartbeat_indices.sql
+- lib/postjob/migrations/021_cron_jobs.sql
+- lib/postjob/migrations/023_sticky_jobs.sql
 - lib/postjob/queue.rb
 - lib/postjob/queue/associations.rb
 - lib/postjob/queue/encoder.rb
@@ -273,12 +278,12 @@ files:
 - lib/postjob/runner.rb
 - lib/postjob/worker_session.rb
 - lib/postjob/workflow.rb
-- lib/tools/atomic_store.rb
 - lib/tools/heartbeat.rb
 - lib/tools/history.rb
 - spec/postjob/enqueue_spec.rb
 - spec/postjob/events/heartbeat_event_spec.rb
 - spec/postjob/events/job_event_spec.rb
+- spec/postjob/events/zombie_event_spec.rb
 - spec/postjob/full_workflow_spec.rb
 - spec/postjob/job_control/error_status_spec.rb
 - spec/postjob/job_control/manual_spec.rb
@@ -317,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: restartable, asynchronous, and distributed processes

data/lib/tools/atomic_store.rb

@@ -1,17 +0,0 @@
-module AtomicStore
-  def self.with(path)
-    File.open(path, File::RDWR | File::CREAT, 0644) do |f|
-      f.flock(File::LOCK_EX)
-      value = f.read
-      value = nil if value == ""
-      new_value = yield value
-      expect! new_value => /./
-      next if new_value == value
-
-      f.rewind
-      f.write(new_value)
-      f.flush
-      f.truncate(f.pos)
-    end
-  end
-end