inst-jobs 0.15.20 → 1.0.1

data/lib/delayed/periodic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fugit'
 
 module Delayed
@@ -47,10 +49,10 @@ class Periodic
   end
 
   def enqueue
-    Delayed::Job.enqueue(self, @job_args.merge(:max_attempts => 1,
-                                               :run_at => @cron.next_time(Delayed::Periodic.now).utc.to_time,
-                                               :singleton => tag,
-                                               on_conflict: :patient))
+    Delayed::Job.enqueue(self, **@job_args.merge(:max_attempts => 1,
+                                                 :run_at => @cron.next_time(Delayed::Periodic.now).utc.to_time,
+                                                 :singleton => tag,
+                                                 on_conflict: :patient))
   end
 
   def perform

data/lib/delayed/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/class/attribute'
 
 module Delayed

data/lib/delayed/pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
 class Pool
   include Delayed::Logging

data/lib/delayed/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 require 'sinatra/json'
 require 'json'

data/lib/delayed/server/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
   class Server
     module Helpers

data/lib/delayed/settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'erb'
 require 'active_support/core_ext/hash/indifferent_access'
@@ -23,7 +25,10 @@ module Delayed
       :worker_health_check_config,
       :worker_procname_prefix,
     ]
-    SETTINGS_WITH_ARGS = [ :num_strands ]
+    SETTINGS_WITH_ARGS = [
+      :job_detailed_log_format,
+      :num_strands
+    ]
 
     SETTINGS.each do |setting|
       mattr_writer(setting)
@@ -65,6 +70,7 @@ module Delayed
 
     self.num_strands = ->(strand_name){ nil }
     self.default_job_options = ->{ Hash.new }
+    self.job_detailed_log_format = ->(job){ job.to_json(include_root: false, only: %w(tag strand priority attempts created_at max_attempts source)) }
 
     # Send workers KILL after QUIT if they haven't exited within the
     # slow_exit_timeout

data/lib/delayed/testing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
 module Testing
   def self.run_job(job)

data/lib/delayed/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
-  VERSION = "0.15.20"
+  VERSION = "1.0.1"
 end

data/lib/delayed/work_queue/in_process.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
 module WorkQueue
 # The simplest possible implementation of a WorkQueue -- just turns around and

data/lib/delayed/work_queue/parent_process.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'socket'
 require 'timeout'

data/lib/delayed/work_queue/parent_process/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
 module WorkQueue
 class ParentProcess

data/lib/delayed/work_queue/parent_process/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
 module WorkQueue
 class ParentProcess
@@ -5,7 +7,7 @@ class ParentProcess
     attr_reader :clients, :listen_socket
 
     include Delayed::Logging
-    SIGNALS = %i{INT TERM QUIT CHLD}
+    SIGNALS = %i{INT TERM QUIT}
 
     def initialize(listen_socket, parent_pid: nil, config: Settings.parent_process)
       @listen_socket = listen_socket

data/lib/delayed/worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
 
 class TimeoutError < RuntimeError; end
@@ -253,7 +255,7 @@ class Worker
   def log_job(job, format = :short)
     case format
     when :long
-      "#{job.full_name} #{ job.to_json(:include_root => false, :only => %w(tag strand priority attempts created_at max_attempts source)) }"
+      "#{job.full_name} #{ Settings.job_detailed_log_format.call(job) }"
     else
       job.full_name
     end

data/lib/delayed/worker/consul_health_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'health_check'
 require_relative 'process_helper'
 require 'socket'
@@ -11,7 +13,7 @@ module Delayed
       DEFAULT_SERVICE_NAME = 'inst-jobs_worker'.freeze
       attr_reader :agent_client, :catalog_client
 
-      def initialize(*args)
+      def initialize(*, **)
         super
         # Because we don't want the consul client to be a hard dependency we're
         # only requiring it once it's absolutely needed

data/lib/delayed/worker/health_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
   class Worker
     class HealthCheck

data/lib/delayed/worker/null_health_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
   class Worker
     class NullHealthCheck < HealthCheck

data/lib/delayed/worker/process_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
   class Worker
     module ProcessHelper

data/lib/delayed/yaml_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # New definitions for YAML to aid in serialization and deserialization of delayed jobs.
 
 require 'yaml'

data/lib/delayed_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
   MIN_PRIORITY = 0
   HIGH_PRIORITY = 0
@@ -17,6 +19,8 @@ require 'active_support/core_ext/module/attribute_accessors'
 require 'active_record'
 require 'after_transaction_commit'
 
+require 'delayed/core_ext/kernel'
+
 require 'delayed/settings'
 require 'delayed/yaml_extensions'
 

data/lib/inst-jobs.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'delayed_job'

data/spec/active_record_job_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path("../spec_helper", __FILE__)
 
 describe 'Delayed::Backed::ActiveRecord::Job' do
@@ -5,10 +7,6 @@ describe 'Delayed::Backed::ActiveRecord::Job' do
     Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
   end
 
-  after :all do
-    Delayed.send(:remove_const, :Job)
-  end
-
   before do
     Delayed::Testing.clear_all!
   end
@@ -17,7 +15,7 @@ describe 'Delayed::Backed::ActiveRecord::Job' do
 
   it "should recover as well as possible from a failure failing a job" do
     allow(Delayed::Job::Failed).to receive(:create).and_raise(RuntimeError)
-    job = "test".send_later_enqueue_args :reverse, no_delay: true
+    job = "test".delay(ignore_transaction: true).reverse
     job_id = job.id
     proc { job.fail! }.should raise_error(RuntimeError)
     proc { Delayed::Job.find(job_id) }.should raise_error(ActiveRecord::RecordNotFound)
@@ -43,7 +41,7 @@ describe 'Delayed::Backed::ActiveRecord::Job' do
     it "should select the next job at random if enabled" do
       begin
         Delayed::Settings.select_random_from_batch = true
-        15.times { "test".send_later :length }
+        15.times { "test".delay.length }
         founds = []
         15.times do
           job = Delayed::Job.get_and_lock_next_available('tester')

data/spec/delayed/cli_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Delayed::CLI do

data/spec/delayed/daemon_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Delayed::Daemon do

data/spec/delayed/message_sending_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'debug_inspector'
+
+RSpec.describe Delayed::MessageSending do
+  before do
+    allow(::Rails.env).to receive(:test?).and_return(true)
+  end
+
+  let(:klass) do
+    Class.new do
+      def call_private(**enqueue_args)
+        delay(**enqueue_args).private_method
+      end
+
+      private
+
+      def private_method
+      end
+    end
+  end
+
+  it "allows an object to send a private message to itself" do
+    klass.new.call_private
+  end
+
+  it "allows an object to send a private message to itself synchronouosly" do
+    klass.new.call_private(synchronous: true)
+  end
+
+  it "warns about directly sending a private message asynchronously" do
+    expect { klass.new.delay.private_method }.to raise_error(NoMethodError)
+  end
+
+  it "warns about directly sending a private message synchronusly" do
+    expect { klass.new.delay(synchronous: true).private_method }.to raise_error(NoMethodError)
+  end
+
+  it "does not warn about directly sending a private message in production" do
+    allow(::Rails.env).to receive(:test?).and_return(false)
+    allow(::Rails.env).to receive(:development?).and_return(false)
+    klass.new.delay.private_method
+  end
+
+  it "does not warn about directly sending a private message synchronously in production" do
+    allow(::Rails.env).to receive(:test?).and_return(false)
+    allow(::Rails.env).to receive(:development?).and_return(false)
+    klass.new.delay(synchronous: true).private_method
+  end
+end

data/spec/delayed/server_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'delayed/server'
 
@@ -18,10 +20,6 @@ RSpec.describe Delayed::Server, sinatra: true do
     Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
   end
 
-  after :all do
-    Delayed.send(:remove_const, :Job)
-  end
-
   describe "get '/running'" do
     before do
       3.times do |i|

data/spec/delayed/settings_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Delayed::Settings do

data/spec/delayed/work_queue/in_process_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Delayed::WorkQueue::InProcess do
@@ -5,10 +7,6 @@ RSpec.describe Delayed::WorkQueue::InProcess do
     Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
   end
 
-  after :all do
-    Delayed.send(:remove_const, :Job)
-  end
-
   after :each do
     Delayed::Worker.lifecycle.reset!
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Delayed::WorkQueue::ParentProcess::Client do
@@ -14,10 +16,6 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Client do
     Delayed.select_backend(Delayed::Backend::ActiveRecord::Job)
   end
 
-  after :all do
-    Delayed.send(:remove_const, :Job)
-  end
-
   it 'marshals the given arguments to the server and returns the response' do
     expect(addrinfo).to receive(:connect).once.and_return(connection)
     expect(connection).to receive(:eof?).and_return(false)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
@@ -29,7 +31,6 @@ RSpec.describe Delayed::WorkQueue::ParentProcess::Server do
   end
 
   after :all do
-    Delayed.send(:remove_const, :Job)
     Delayed::Settings.parent_process = {}
   end
 

data/spec/delayed/work_queue/parent_process_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'fileutils'
 
@@ -11,7 +13,6 @@ RSpec.describe Delayed::WorkQueue::ParentProcess do
   end
 
   after :all do
-    Delayed.send(:remove_const, :Job)
     Delayed::Settings.parent_process = {}
   end
 

data/spec/delayed/worker/consul_health_check_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'imperium'
 
@@ -15,7 +17,7 @@ RSpec.describe Delayed::Worker::ConsulHealthCheck do
 
   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'})
+      check = Delayed::Worker::ConsulHealthCheck.new(worker_name: 'foobar')
       expect(check.agent_client).to eq Imperium::Agent.default_client
     end
 

data/spec/delayed/worker/health_check_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Delayed::Worker::HealthCheck do

data/spec/delayed/worker_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../spec_helper"
 
 describe Delayed::Worker do
@@ -38,6 +40,33 @@ describe Delayed::Worker do
     end
   end
 
+  describe "#log_job" do
+    around(:each) do |block|
+      prev_logger = Delayed::Settings.job_detailed_log_format
+      block.call
+      Delayed::Settings.job_detailed_log_format = prev_logger
+    end
+
+    it "has a reasonable default format" do
+      payload = double(perform: nil)
+      job = Delayed::Job.new(payload_object: payload, priority: 25, strand: "test_jobs")
+      short_log_format = subject.log_job(job, :short)
+      expect(short_log_format).to eq("RSpec::Mocks::Double")
+      long_format = subject.log_job(job, :long)
+      expect(long_format).to eq("RSpec::Mocks::Double {\"priority\":25,\"attempts\":0,\"created_at\":null,\"tag\":\"RSpec::Mocks::Double#perform\",\"max_attempts\":null,\"strand\":\"test_jobs\",\"source\":null}")
+    end
+
+    it "logging format can be changed with settings" do
+      Delayed::Settings.job_detailed_log_format = ->(job){ "override format #{job.strand}"}
+      payload = double(perform: nil)
+      job = Delayed::Job.new(payload_object: payload, priority: 25, strand: "test_jobs")
+      short_log_format = subject.log_job(job, :short)
+      expect(short_log_format).to eq("RSpec::Mocks::Double")
+      long_format = subject.log_job(job, :long)
+      expect(long_format).to eq("RSpec::Mocks::Double override format test_jobs")
+    end
+  end
+
   describe "#run" do
     it "passes extra config options through to the WorkQueue" do
       expect(subject.work_queue).to receive(:get_and_lock_next_available).