inst-jobs 2.0.0 → 3.1.0

data/spec/delayed/work_queue/parent_process/server_spec.rb

@@ -1,32 +1,37 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
-RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
-  class JobClass
-    attr_reader :id
+class JobClass
+  attr_reader :id
 
-    def initialize
-      @id = rand
-    end
+  def initialize
+    @id = rand
+  end
 
-    def ==(other)
-      self.id == other.id
-    end
+  def ==(other)
+    id == other.id
   end
+end
+
+RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
+  subject { described_class.new(listen_socket) }
 
   let(:parent) { Delayed::WorkQueue::ParentProcess.new }
-  let(:subject) { described_class.new(listen_socket) }
   let(:listen_socket) { Socket.unix_server_socket(parent.server_address) }
   let(:job) { JobClass.new }
   let(:worker_config) { { queue: "queue_name", min_priority: 1, max_priority: 2 } }
   let(:args) { ["worker_name", worker_config] }
   let(:job_args) { [["worker_name"], "queue_name", 1, 2, hash_including(prefetch: 4)] }
 
+  before do
+    Delayed::Worker.lifecycle.reset!
+  end
+
   before :all do
     Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
     Delayed::Settings.parent_process = {
-      'server_address' => '/tmp/inst-jobs-test.sock'
+      "server_address" => "/tmp/inst-jobs-test.sock"
     }
   end
 
@@ -34,27 +39,28 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     Delayed::Settings.parent_process = {}
   end
 
-  after :each do
-    File.unlink('/tmp/inst-jobs-test.sock') if File.exist?('/tmp/inst-jobs-test.sock')
+  after do
+    File.unlink("/tmp/inst-jobs-test.sock") if File.exist?("/tmp/inst-jobs-test.sock")
+    Delayed::Worker.lifecycle.reset!
   end
 
-  it 'accepts new clients' do
-    client = Socket.unix(subject.listen_socket.local_address.unix_path)
+  it "accepts new clients" do
+    Socket.unix(subject.listen_socket.local_address.unix_path)
     expect { subject.run_once }.to change(subject, :connected_clients).by(1)
   end
 
-  it 'queries the queue on client request' do
+  it "queries the queue on client request" do
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
 
-    expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return('worker_name' => job)
+    expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return("worker_name" => job)
     Marshal.dump(args, client)
     subject.run_once
     expect(client).to be_ready
     expect(Marshal.load(client)).to eq(job)
   end
 
-  it 'can pop multiple jobs at once' do
+  it "can pop multiple jobs at once" do
     client1 = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
     client2 = Socket.unix(subject.listen_socket.local_address.unix_path)
@@ -62,8 +68,8 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
 
     job1 = JobClass.new
     job2 = JobClass.new
-    job_args = [["worker_name1", "worker_name2"], "queue_name", 1, 2, hash_including(prefetch: 3)]
-    jobs = { 'worker_name1' => job1, 'worker_name2' => job2 }
+    job_args = [%w[worker_name1 worker_name2], "queue_name", 1, 2, hash_including(prefetch: 3)]
+    jobs = { "worker_name1" => job1, "worker_name2" => job2 }
 
     expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return(jobs)
     Marshal.dump(["worker_name1", worker_config], client1)
@@ -73,30 +79,78 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     expect(Marshal.load(client2)).to eq(job2)
   end
 
-  it 'will prefetch and use jobs' do
+  it "will prefetch and use jobs" do
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
 
-    allow(subject).to receive(:prefetch_owner).and_return('work_queue:X')
-    job_args = [["worker_name1"], "queue_name", 1, 2, prefetch: 4, prefetch_owner: 'work_queue:X', forced_latency: 6.0]
-    job2 = Delayed::Job.new(:tag => 'tag')
-    job2.create_and_lock!('work_queue:X')
-    job3 = Delayed::Job.new(:tag => 'tag')
-    job3.create_and_lock!('work_queue:X')
-    jobs = { 'worker_name1' => job, 'work_queue:X' => [job2, job3]}
+    allow(subject).to receive(:prefetch_owner).and_return("work_queue:X")
+    job_args = [["worker_name1"], "queue_name", 1, 2,
+                { prefetch: 4, prefetch_owner: "work_queue:X", forced_latency: 6.0 }]
+    job2 = Delayed::Job.new(tag: "tag")
+    job2.create_and_lock!("work_queue:X")
+    job3 = Delayed::Job.new(tag: "tag")
+    job3.create_and_lock!("work_queue:X")
+    jobs = { "worker_name1" => job, "work_queue:X" => [job2, job3] }
 
     expect(Delayed::Job).to receive(:get_and_lock_next_available).once.with(*job_args).and_return(jobs)
     Marshal.dump(["worker_name1", worker_config], client)
     subject.run_once
-    expect(subject).to_not be_all_workers_idle
+    expect(subject).not_to be_all_workers_idle
     expect(Marshal.load(client)).to eq(job)
 
     Marshal.dump(["worker_name1", worker_config], client)
     subject.run_once
-    expect(subject).to_not be_all_workers_idle
+    expect(subject).not_to be_all_workers_idle
     expect(Marshal.load(client)).to eq(job2)
   end
 
+  context "prefetched job unlocking" do
+    let(:job_args) do
+      [["worker_name1"], "queue_name", 1, 2,
+       { prefetch: 4, prefetch_owner: "prefetch:work_queue:X", forced_latency: 6.0 }]
+    end
+    let(:job2) { Delayed::Job.new(tag: "tag").tap { |j| j.create_and_lock!("prefetch:work_queue:X") } }
+    let(:job3) { Delayed::Job.new(tag: "tag").tap { |j| j.create_and_lock!("prefetch:work_queue:X") } }
+
+    before do
+      client = Socket.unix(subject.listen_socket.local_address.unix_path)
+      subject.run_once
+
+      jobs = { "worker_name1" => job, "prefetch:work_queue:X" => [job2, job3] }
+      allow(subject).to receive(:prefetch_owner).and_return("prefetch:work_queue:X")
+      allow(Delayed::Job).to receive(:get_and_lock_next_available).once.with(*job_args).and_return(jobs)
+      Marshal.dump(["worker_name1", worker_config], client)
+      subject.run_once
+    end
+
+    it "doesn't unlock anything if nothing is timed out" do
+      expect(Delayed::Job).not_to receive(:advisory_lock)
+      expect(Delayed::Job).not_to receive(:unlock)
+      subject.unlock_timed_out_prefetched_jobs
+    end
+
+    it "unlocks timed out prefetched jobs" do
+      allow(Delayed::Settings).to receive(:parent_process).and_return(prefetched_jobs_timeout: -1)
+      expect(Delayed::Job).to receive(:unlock).with([job2, job3])
+      subject.unlock_timed_out_prefetched_jobs
+      expect(subject.instance_variable_get(:@prefetched_jobs).values.sum(&:length)).to eq 0
+    end
+
+    it "fails gracefully if the lock times out" do
+      allow(Delayed::Settings).to receive(:parent_process).and_return(prefetched_jobs_timeout: -1)
+      expect(Delayed::Job).not_to receive(:unlock)
+      expect(Delayed::Job).to receive(:advisory_lock).and_raise(ActiveRecord::QueryCanceled)
+      subject.unlock_timed_out_prefetched_jobs
+      expect(subject.instance_variable_get(:@prefetched_jobs).values.sum(&:length)).to eq 2
+    end
+
+    it "unlocks all jobs" do
+      expect(Delayed::Job).to receive(:unlock).with([job2, job3])
+      subject.unlock_all_prefetched_jobs
+      expect(subject.instance_variable_get(:@prefetched_jobs).values.sum(&:length)).to eq 0
+    end
+  end
+
   it "doesn't respond immediately if there are no jobs available" do
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
@@ -107,7 +161,10 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     expect(client).not_to be_ready
 
     # next time around, return the result
-    expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return('worker_name' => job).ordered
+    expect(Delayed::Job).to receive(:get_and_lock_next_available)
+      .with(*job_args)
+      .and_return("worker_name" => job)
+      .ordered
     allow(Delayed::Settings).to receive(:sleep_delay).and_return(0)
     allow(Delayed::Settings).to receive(:sleep_delay_stagger).and_return(0)
     subject.run_once
@@ -115,7 +172,7 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     expect(Marshal.load(client)).to eq(job)
   end
 
-  it 'drops the client on i/o error' do
+  it "drops the client on i/o error" do
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
 
@@ -125,7 +182,7 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     expect { subject.run_once }.to change(subject, :connected_clients).by(-1)
   end
 
-  it 'drops the client when the client disconnects' do
+  it "drops the client when the client disconnects" do
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
 
@@ -138,7 +195,7 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     expect(subject.instance_variable_get(:@waiting_clients).first.last).to eq []
   end
 
-  it 'drops the client when a write fails' do
+  it "drops the client when a write fails" do
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
 
@@ -151,7 +208,7 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     # don't let the server see the close and process it there; we want to check a failure later
     expect(subject).to receive(:handle_request).with(server_client_socket)
 
-    expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return('worker_name' => job)
+    expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return("worker_name" => job)
     # the job gets unlocked
     expect(Delayed::Job).to receive(:unlock).with([job])
     subject.run_once
@@ -161,14 +218,14 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     expect(subject.instance_variable_get(:@waiting_clients).first.last).to eq []
   end
 
-  it 'tracks when clients are idle' do
+  it "tracks when clients are idle" do
     expect(subject.all_workers_idle?).to be(true)
 
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
     expect(subject.all_workers_idle?).to be(true)
 
-    expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return('worker_name' => job)
+    expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return("worker_name" => job)
     Marshal.dump(args, client)
     subject.run_once
     expect(subject.all_workers_idle?).to be(false)
@@ -179,7 +236,7 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     expect(subject.all_workers_idle?).to be(true)
   end
 
-  it 'triggers the lifecycle event around the pop' do
+  it "triggers the lifecycle event around the pop" do
     called = false
     client = Socket.unix(subject.listen_socket.local_address.unix_path)
     subject.run_once
@@ -187,7 +244,7 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     Delayed::Worker.lifecycle.around(:work_queue_pop) do |queue, &cb|
       expect(subject.all_workers_idle?).to be(true)
       expect(queue).to eq(subject)
-      expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return('worker_name' => job)
+      expect(Delayed::Job).to receive(:get_and_lock_next_available).with(*job_args).and_return("worker_name" => job)
       called = true
       res = cb.call(queue)
       expect(subject.all_workers_idle?).to be(false)
@@ -198,7 +255,26 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
     subject.run_once
 
     expect(Marshal.load(client)).to eq(job)
-    expect(called).to eq(true)
+    expect(called).to be(true)
   end
-end
 
+  it "deletes the correct worker when transferring jobs" do
+    client1 = Socket.unix(subject.listen_socket.local_address.unix_path)
+    client2 = Socket.unix(subject.listen_socket.local_address.unix_path)
+    subject.run_once
+    subject.run_once
+
+    Marshal.dump(args, client1)
+    Marshal.dump(["worker_name2", worker_config], client2)
+    subject.run_once
+    subject.run_once
+
+    waiting_clients = subject.instance_variable_get(:@waiting_clients)
+    expect(waiting_clients.first.last.length).to eq 2
+
+    expect(Delayed::Job).to receive(:get_and_lock_next_available).and_return("worker_name" => job,
+                                                                             "worker_name2" => job)
+    subject.run_once
+    expect(waiting_clients.first.last).to be_empty
+  end
+end

data/spec/delayed/work_queue/parent_process_spec.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-require 'fileutils'
+require "spec_helper"
+require "fileutils"
 
 RSpec.describe Delayed::WorkQueue::ParentProcess do
   before :all do
-    FileUtils.mkdir_p(Delayed::Settings.expand_rails_path('tmp'))
+    FileUtils.mkdir_p(Delayed::Settings.expand_rails_path("tmp"))
     Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
     Delayed::Settings.parent_process = {
-      'server_address' => '/tmp/inst-jobs-test.sock'
+      "server_address" => "/tmp/inst-jobs-test.sock"
     }
   end
 
@@ -16,43 +16,41 @@ RSpec.describe Delayed::WorkQueue::ParentProcess do
     Delayed::Settings.parent_process = {}
   end
 
-  after :each do
-    File.unlink('/tmp/inst-jobs-test.sock') if File.exist?('/tmp/inst-jobs-test.sock')
+  after do
+    File.unlink("/tmp/inst-jobs-test.sock") if File.exist?("/tmp/inst-jobs-test.sock")
     Delayed::Worker.lifecycle.reset!
   end
 
-  let(:subject) { described_class.new }
-
-  describe '#initalize(config = Settings.parent_process)' do
-    it 'must expand a relative path to be within the Rails root' do
-      queue = described_class.new('server_address' => 'tmp/foo.sock')
-      expect(queue.server_address).to eq Delayed::Settings.expand_rails_path('tmp/foo.sock')
+  describe "#initalize(config = Settings.parent_process)" do
+    it "must expand a relative path to be within the Rails root" do
+      queue = described_class.new("server_address" => "tmp/foo.sock")
+      expect(queue.server_address).to eq Delayed::Settings.expand_rails_path("tmp/foo.sock")
     end
 
-    it 'must add a file name when a relative path to a directory is supplied' do
-      queue = described_class.new('server_address' => 'tmp')
-      expect(queue.server_address).to eq Delayed::Settings.expand_rails_path('tmp/inst-jobs.sock')
+    it "must add a file name when a relative path to a directory is supplied" do
+      queue = described_class.new("server_address" => "tmp")
+      expect(queue.server_address).to eq Delayed::Settings.expand_rails_path("tmp/inst-jobs.sock")
     end
 
-    it 'must capture a full absolute path' do
-      queue = described_class.new('server_address' => '/tmp/foo.sock')
-      expect(queue.server_address).to eq '/tmp/foo.sock'
+    it "must capture a full absolute path" do
+      queue = described_class.new("server_address" => "/tmp/foo.sock")
+      expect(queue.server_address).to eq "/tmp/foo.sock"
     end
 
-    it 'must add a file name when an absolute path to a directory is supplied' do
-      queue = described_class.new('server_address' => '/tmp')
-      expect(queue.server_address).to eq '/tmp/inst-jobs.sock'
+    it "must add a file name when an absolute path to a directory is supplied" do
+      queue = described_class.new("server_address" => "/tmp")
+      expect(queue.server_address).to eq "/tmp/inst-jobs.sock"
     end
   end
 
-  it 'generates a server listening on a valid unix socket' do
+  it "generates a server listening on a valid unix socket" do
     server = subject.server
     expect(server).to be_a(Delayed::WorkQueue::ParentProcess::Server)
     expect(server.listen_socket.local_address.unix?).to be(true)
     expect { server.listen_socket.accept_nonblock }.to raise_error(IO::WaitReadable)
   end
 
-  it 'generates a client connected to the server unix socket' do
+  it "generates a client connected to the server unix socket" do
     server = subject.server
     client = subject.client
     expect(client).to be_a(Delayed::WorkQueue::ParentProcess::Client)

data/spec/delayed/worker/consul_health_check_spec.rb

@@ -1,76 +1,63 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-require 'imperium'
+require "spec_helper"
 
 RSpec.describe Delayed::Worker::ConsulHealthCheck do
-  let(:health_check) { Delayed::Worker::ConsulHealthCheck.new(worker_name: 'foobar') }
+  let(:health_check) { described_class.new(worker_name: "foobar") }
 
-  # can't use a verifying double for the response because the methods we're
-  # tryig to stub are actually on HTTP::Message
-  let(:response) { double('Imperium::Response') }
-  let(:agent_client) { instance_double(Imperium::Agent) }
-
-  before do
-    allow(Imperium::Agent).to receive(:default_client).and_return(agent_client)
-  end
-
-  describe '#initialize' do
-    it 'must use the default agent client when the config is mostly empty' do
-      check = Delayed::Worker::ConsulHealthCheck.new(worker_name: 'foobar')
-      expect(check.agent_client).to eq Imperium::Agent.default_client
+  describe "#initialize" do
+    it "must use a default service client when the config is mostly empty" do
+      check = described_class.new(worker_name: "foobar")
+      expect(check.service_client.configuration.url.to_s).to eq "http://localhost:8500"
     end
 
-    it 'must create a new agent API client when the config has relevant keys set' do
-      check = Delayed::Worker::ConsulHealthCheck.new(worker_name: 'foobar', config: {url: 'http://consul.example.com:8500'})
-      agent_client = check.agent_client
-      expect(agent_client).to_not eq Imperium::Agent.default_client
-      expect(agent_client.config.url.to_s).to eq 'http://consul.example.com:8500'
+    it "must create a new service API client when the config has relevant keys set" do
+      check = described_class.new(worker_name: "foobar",
+                                  config: { url: "http://consul.example.com:8500" })
+      service_client = check.service_client
+      expect(service_client.configuration.url.to_s).to eq "http://consul.example.com:8500"
     end
   end
 
-  describe '#start' do
-    it 'must register this process as a service with consul' do
-      expect(response).to receive(:ok?).and_return(true)
-      expect(agent_client).to receive(:register_service)
-        .with(an_instance_of(Imperium::Service))
-        .and_return(response)
+  describe "#start" do
+    it "must register this process as a service with consul" do
+      stub = stub_request(:put, "localhost:8500/v1/agent/service/register")
+             .with(body: hash_including({ id: "foobar" }))
+
       health_check.start
+
+      expect(stub).to have_been_requested
     end
 
+    it "must supply a args style check" do
+      stub = stub_request(:put, "localhost:8500/v1/agent/service/register")
+             .with(body: hash_including({ check:  WebMock::API.hash_including({ args: anything }) }))
 
-    it 'must supply a args style check' do
-      allow(response).to receive(:ok?).and_return(true)
-      allow(agent_client).to receive(:register_service) { |service|
-        check = service.checks.first
-        expect(check.args).to_not be_nil
-        response
-      }
       health_check.start
+
+      expect(stub).to have_been_requested
     end
 
-    it 'must include the docker container id when the docker option is set to true' do
-      local_health_check = Delayed::Worker::ConsulHealthCheck.new(
-        worker_name: 'foobar',
-        config: {docker: true}
+    it "must include the docker container id when the docker option is set to true" do
+      stub = stub_request(:put, "localhost:8500/v1/agent/service/register")
+             .with(body: hash_including({ check:  WebMock::API.hash_including({ docker_container_id: anything }) }))
+
+      local_health_check = described_class.new(
+        worker_name: "foobar",
+        config: { docker: true }
       )
-      allow(response).to receive(:ok?).and_return(true)
-      allow(agent_client).to receive(:register_service) { |service|
-        check = service.checks.first
-        expect(check.docker_container_id).to_not be_nil
-        response
-      }
       local_health_check.start
+
+      expect(stub).to have_been_requested
     end
   end
 
-  describe '#stop' do
-    it 'must deregister the service from consul' do
-      allow(response).to receive(:ok?).and_return(true)
-      expect(agent_client).to receive(:deregister_service)
-        .with(health_check.worker_name)
-        .and_return(response)
+  describe "#stop" do
+    it "must deregister the service from consul" do
+      stub = stub_request(:put, "localhost:8500/v1/agent/service/deregister/foobar")
+
       health_check.stop
+      expect(stub).to have_been_requested
     end
   end
 end