inst-jobs 0.16.0 → 1.0.4

data/lib/delayed/performable_method.rb

@@ -1,13 +1,23 @@
+# frozen_string_literal: true
+
 module Delayed
-  class PerformableMethod < Struct.new(:object, :method, :args, :fail_cb, :permanent_fail_cb)
-    def initialize(object, method, args = [], fail_cb = nil, permanent_fail_cb = nil)
+  class PerformableMethod < Struct.new(:object, :method, :args, :kwargs, :fail_cb, :permanent_fail_cb, :sender)
+    def initialize(object, method, args: [], kwargs: {}, on_failure: nil, on_permanent_failure: nil, sender: nil)
       raise NoMethodError, "undefined method `#{method}' for #{object.inspect}" unless object.respond_to?(method, true)
 
       self.object = object
       self.args   = args
+      self.kwargs = kwargs
       self.method = method.to_sym
-      self.fail_cb           = fail_cb
-      self.permanent_fail_cb = permanent_fail_cb
+      self.fail_cb           = on_failure
+      self.permanent_fail_cb = on_permanent_failure
+      self.sender = sender
+      begin
+        YAML.load(YAML.dump(sender))
+      rescue
+        # if for some reason you can't dump the sender, just drop it
+        self.sender = nil
+      end
     end
 
     def display_name
@@ -20,7 +30,24 @@ module Delayed
     alias_method :tag, :display_name
 
     def perform
-      object.send(method, *args)
+      kwargs = self.kwargs || {}
+
+      sender_is_object = sender == object
+      sender_is_class = sender.is_a?(object.class)
+
+      if sender.nil? || sender_is_object || sender_is_class && object.protected_methods.include?(method)
+        if kwargs.empty?
+          object.send(method, *args)
+        else
+          object.send(method, *args, **kwargs)
+        end
+      else
+        if kwargs.empty?
+          object.public_send(method, *args)
+        else
+          object.public_send(method, *args, **kwargs)
+        end
+      end
     end
 
     def on_failure(error)
@@ -46,7 +73,9 @@ module Delayed
 
     def full_name
       obj_name = object.is_a?(ActiveRecord::Base) ? "#{object.class}.find(#{object.id}).#{method}" : display_name
-      "#{obj_name}(#{args.map { |a| deep_de_ar_ize(a) }.join(', ')})"
+      kgs = kwargs || {}
+      kwargs_str = kgs.map { |(k, v)| ", #{k}: #{deep_de_ar_ize(v)}"}.join("")
+      "#{obj_name}(#{args.map { |a| deep_de_ar_ize(a) }.join(', ')}#{kwargs_str})"
     end
   end
 end

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'

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.16.0"
+  VERSION = "1.0.4"
 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

data/lib/delayed/worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Delayed
 
 class TimeoutError < RuntimeError; 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,101 @@
+# 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
+
+  before (:all) do
+    class SpecClass
+      def call_private(**enqueue_args)
+        delay(**enqueue_args).private_method
+      end
+
+      def call_protected(**enqueue_args)
+        other = self.class.new
+        other.delay(**enqueue_args).protected_method
+      end
+
+      private
+
+      def private_method
+      end
+
+      protected
+
+      def protected_method
+      end
+    end
+  end
+
+  after(:all) do
+    Object.send(:remove_const, :SpecClass)
+  end
+
+  let(:klass) { SpecClass }
+
+  it "allows an object to send a private message to itself" do
+    job = klass.new.call_private(ignore_transaction: true)
+    job.invoke_job
+  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
+
+  it "allows an object to send a protected message to itself" do
+    job = klass.new.call_protected(ignore_transaction: true)
+    job.invoke_job
+  end
+
+  it "allows an object to send a protected message to itself synchronouosly" do
+    klass.new.call_protected(synchronous: true)
+  end
+
+  it "warns about directly sending a protected message asynchronously" do
+    expect { klass.new.delay.protected_method }.to raise_error(NoMethodError)
+  end
+
+  it "warns about directly sending a protected message synchronusly" do
+    expect { klass.new.delay(synchronous: true).protected_method }.to raise_error(NoMethodError)
+  end
+
+  it "doesn't explode if you can't dump the sender" do
+    klass = Class.new do
+      def delay_something
+        Kernel.delay.sleep(1)
+      end
+
+      def encode_with(encoder)
+        raise "yaml encoding failed"
+      end
+    end
+
+    obj = klass.new
+    expect { YAML.dump(obj) }.to raise_error("yaml encoding failed")
+    expect { obj.delay_something }.not_to raise_error
+  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