inst-jobs 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c754ed71778d5b3f08641e133be947fae204a56dcee71aef08a7780a7d6afa5
-  data.tar.gz: 10949318e78e8e9d56b92ee7f2d14bfd647da20ff70578d894e4d1e85441d2fe
+  metadata.gz: 2dad83034c6ca9ae9a7f7129581ecd36f64d1d51f93aa1126582ff2141068020
+  data.tar.gz: 8b155f2ed6ce13b956d8383bc484ef19ed3b661502bf2aed734a4618befebf40
 SHA512:
-  metadata.gz: 1a014e191bc0d6ccd083340b6d5c4bca0b7e03439aca459f79a5a704d93d16c42dd9e4855ca5985f7b1e4fb1fe62eead160cb6cb356c73b00ac297dc30112d8a
-  data.tar.gz: 53997c66017cf6db561104054379cb9e7e934fcc56c54d552b7629ff29eeb58de37c8674088661ba683e7e4d8b19234f26021819753ac06a6c738dd435c3f169
+  metadata.gz: 783af3d9f654e07a55a6be57691216a255bb548a720ae31d7c085ba0c70be20164a2a2c6a7b36767976468e034b5bafc6de427f577a05c2c70d0a6621301e86d
+  data.tar.gz: cbc4ff85dea6bc2f12d8eb2cecb25cecae4dc47e5e5155e46c63ebdbc4884e15f43f41b69b8611c44cbb42f4539843ecffe8cf5e96cab852bf9ace06a7a6b6fa

data/lib/delayed/core_ext/kernel.rb

@@ -0,0 +1,9 @@
+module Kernel
+  def sender(i = 0)
+    frame_self = nil
+    # 3. one for the block, one for this method, one for the method calling this
+    # method, and _then_ we get to the self for who sent the message we want
+    RubyVM::DebugInspector.open { |dc| frame_self = dc.frame_self(3 + i) }
+    frame_self
+  end
+end

data/lib/delayed/message_sending.rb

@@ -1,14 +1,40 @@
 # frozen_string_literal: true
 
+if ::Rails.env.test? || ::Rails.env.development?
+  require 'debug_inspector'
+end
+
 module Delayed
   module MessageSending
     class DelayProxy < BasicObject
-      def initialize(object, enqueue_args)
+      def initialize(object, synchronous: false, public_send: false, **enqueue_args)
         @object = object
         @enqueue_args = enqueue_args
+        @synchronous = synchronous
+        @public_send = public_send
       end
 
       def method_missing(method, *args, **kwargs)
+        if @synchronous
+          if @public_send
+            if kwargs.empty?
+              return @object.public_send(method, *args)
+            else
+              return @object.public_send(method, *args, **kwargs)
+            end
+          else
+            if kwargs.empty?
+              return @object.send(method, *args)
+            else
+              return @object.send(method, *args, **kwargs)
+            end
+          end
+        end
+
+        if @public_send && @object.private_methods.include?(method)
+          ::Kernel.raise ::NoMethodError.new("undefined method `#{method}' for #{@object}", method)
+        end
+
         ignore_transaction = @enqueue_args.delete(:ignore_transaction)
         on_failure = @enqueue_args.delete(:on_failure)
         on_permanent_failure = @enqueue_args.delete(:on_permanent_failure)
@@ -42,17 +68,29 @@ module Delayed
       end
     end
 
-    def delay(**enqueue_args)
+    def delay(public_send: nil, **enqueue_args)
       # support procs/methods as enqueue arguments
       enqueue_args.each do |k,v|
         if v.respond_to?(:call)
           enqueue_args[k] = v.call(self)
         end
       end
-      if enqueue_args.delete(:synchronous)
-        return self
+
+      public_send ||= __calculate_public_send_for_delay
+
+      DelayProxy.new(self, public_send: public_send, **enqueue_args)
+    end
+
+    def __calculate_public_send_for_delay
+      # enforce public send in dev and test, but not prod (since it uses
+      # debug APIs, it's expensive)
+      public_send = if ::Rails.env.test? || ::Rails.env.development?
+        sender = self.sender(1)
+        # if the caller isn't self, use public_send; i.e. enforce method visibility
+        sender != self
+      else
+        false
       end
-      DelayProxy.new(self, enqueue_args)
     end
 
     module ClassMethods

data/lib/delayed/performable_method.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Delayed
-  class PerformableMethod < Struct.new(:object, :method, :args, :kwargs, :fail_cb, :permanent_fail_cb)
-    def initialize(object, method, args: [], kwargs: {}, on_failure: nil, on_permanent_failure: nil)
+  class PerformableMethod < Struct.new(:object, :method, :args, :kwargs, :fail_cb, :permanent_fail_cb, :public_send)
+    def initialize(object, method, args: [], kwargs: {}, on_failure: nil, on_permanent_failure: nil, public_send: true)
       raise NoMethodError, "undefined method `#{method}' for #{object.inspect}" unless object.respond_to?(method, true)
 
       self.object = object
@@ -11,6 +11,7 @@ module Delayed
       self.method = method.to_sym
       self.fail_cb           = on_failure
       self.permanent_fail_cb = on_permanent_failure
+      self.public_send = public_send
     end
 
     def display_name
@@ -24,10 +25,18 @@ module Delayed
 
     def perform
       kwargs = self.kwargs || {}
-      if kwargs.empty?
-        object.send(method, *args)
+      if public_send
+        if kwargs.empty?
+          object.public_send(method, *args)
+        else
+          object.public_send(method, *args, **kwargs)
+        end
       else
-        object.send(method, *args, **kwargs)
+        if kwargs.empty?
+          object.send(method, *args)
+        else
+          object.send(method, *args, **kwargs)
+        end
       end
     end
 

data/lib/delayed/version.rb

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

data/lib/delayed/worker/consul_health_check.rb

@@ -13,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_job.rb

@@ -19,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/spec/active_record_job_spec.rb

@@ -7,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

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

@@ -20,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/work_queue/in_process_spec.rb

@@ -7,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

@@ -16,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

@@ -31,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

@@ -13,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

@@ -17,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/gemfiles/60.gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: ../..
   specs:
-    inst-jobs (1.0.0)
+    inst-jobs (1.0.1)
       activerecord (>= 4.2)
       activesupport (>= 4.2)
       after_transaction_commit (>= 1.0, < 3)
+      debug_inspector (~> 0.0.3)
       fugit (~> 1.3)
       railties (>= 4.2)
       redis (> 3.0)
@@ -70,7 +71,7 @@ GEM
       zeitwerk (~> 2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    after_transaction_commit (2.2.0)
+    after_transaction_commit (2.2.1)
       activerecord (>= 5.2)
     backports (3.15.0)
     builder (3.2.4)
@@ -80,13 +81,14 @@ GEM
     concurrent-ruby (1.1.7)
     crass (1.0.6)
     database_cleaner (1.6.1)
+    debug_inspector (0.0.3)
     diff-lcs (1.3)
     erubi (1.9.0)
     et-orbi (1.2.4)
       tzinfo
-    fugit (1.3.9)
+    fugit (1.4.0)
       et-orbi (~> 1.1, >= 1.1.8)
-      raabro (~> 1.3)
+      raabro (~> 1.4)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     httpclient (2.8.3)

data/spec/redis_job_spec.rb

@@ -7,10 +7,6 @@ describe 'Delayed::Backend::Redis::Job' do
     Delayed.select_backend(Delayed::Backend::Redis::Job)
   end
 
-  after :all do
-    Delayed.send(:remove_const, :Job)
-  end
-
   before do
     Delayed::Testing.clear_all!
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inst-jobs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tobias Luetke
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -115,6 +115,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: debug_inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -361,6 +375,7 @@ files:
 - lib/delayed/backend/redis/tickle_strand.lua
 - lib/delayed/batch.rb
 - lib/delayed/cli.rb
+- lib/delayed/core_ext/kernel.rb
 - lib/delayed/daemon.rb
 - lib/delayed/engine.rb
 - lib/delayed/job_tracking.rb
@@ -396,6 +411,7 @@ files:
 - spec/active_record_job_spec.rb
 - spec/delayed/cli_spec.rb
 - spec/delayed/daemon_spec.rb
+- spec/delayed/message_sending_spec.rb
 - spec/delayed/server_spec.rb
 - spec/delayed/settings_spec.rb
 - spec/delayed/work_queue/in_process_spec.rb
@@ -474,6 +490,7 @@ test_files:
 - spec/delayed/cli_spec.rb
 - spec/delayed/daemon_spec.rb
 - spec/delayed/worker_spec.rb
+- spec/delayed/message_sending_spec.rb
 - spec/delayed/settings_spec.rb
 - spec/delayed/work_queue/in_process_spec.rb
 - spec/delayed/work_queue/parent_process_spec.rb