reactor 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4fa5081f033ae7a323804804d1cbc15a2b8dcf6
-  data.tar.gz: 9019ae68c897b156598209b62d6e108965431341
+  metadata.gz: 84d1960b3d89f85ef116fbf0e2d97d93972cfee9
+  data.tar.gz: d6a69705d1496e401a93f8dcd86ab18de483b220
 SHA512:
-  metadata.gz: f9fd84fb796b3a8cedd5830c5052d0409ebd6e16f60510ba37725f59a3b6b79690716e16e4c3e012b58e528b197da31682e03b01bf44d699c78b7e500049347f
-  data.tar.gz: a10b609164beff5b4eb21d6bdc167ef14a3c02a13e5a983eb8a0da257560c6abd34391be108141cd0816a32675d1e8eaa4daebe25530e823c7b527c14e5fb07d
+  metadata.gz: 46258859a0c80d002aa59b6e9c9ab382bbacae87219afe46c3507dcf613cd2f3382ec8bb8ebcedd02f1d8792390a55499dceadd4ade4ad0707c30af38503f0b8
+  data.tar.gz: 5b388408b18555bb93eda610c29eeef2d2e77798e9c529f3ca5544c9ce382a6d27671c88a2a8128e7c82ab6d3b427409a6555ea28240b4fca8a1035892bd3091

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reactor (0.15.1)
+    reactor (0.16.0)
       rails
       sidekiq (> 4.0)
 
@@ -174,4 +174,4 @@ DEPENDENCIES
   test_after_commit
 
 BUNDLED WITH
-   1.15.2
+   1.15.3

data/README.md

@@ -234,10 +234,35 @@ end
 
 for your testing convenience.
 
+
+### Production Deployments
+
+TLDR; Everything is a Sidekiq::Job, so all the same gotchas apply with regard to removing & renaming jobs that may have a live reference sitting in the queue. (AKA, you'll start seeing 'const undefined' exceptions when the job gets picked up if you've already deleted/renamed the job code.)
+
+#### Adding Events and Subscribers
+
+This is as easy as write + deploy. Of course your events getting fired won't have a subscriber pick them up until the new subscriber code is deployed in your sidekiq instances, but that's not too surprising.
+
+#### Removing Events and Subscribers
+
+Removing an event is as simple as deleting the line of code that `publish`es it.
+Removing a subscriber requires awareness of basic Sidekiq principles.
+
+**Is the subscriber that you're deleting virtually guaranteed to have a worker for it sitting in the queue when your deletion is deployed?**
+
+If yes -> deprecate your subscriber first to ensure there are no references left in Redis. This will prevent Reactor from enqueuing more workers for it and make it safe for you delete in a secondry deploy.
+```
+on_event :high_frequency_event, :do_something, deprecated: true
+```
+
+If no -> you can probably just delete the subscriber. 
+In the worst case scenario, you get some background exceptions for a job you didn't intend to have run anyway. Pick your poison. 
+
+
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature/fix branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/lib/reactor/subscription.rb

@@ -1,7 +1,8 @@
 module Reactor
   class Subscription
 
-    attr_reader :source, :event_name, :action, :handler_name, :delay, :async, :worker_class
+    attr_reader :source, :event_name, :action, :handler_name, :delay, :async, :worker_class,
+                :deprecated
 
     def self.build_handler_name(event_name, handler_name_option = nil)
       if handler_name_option
@@ -24,6 +25,7 @@ module Reactor
 
       @delay = options[:delay].to_i
       @async = determine_async(options)
+      @deprecated = !!options[:deprecated]
       build_worker_class
     end
 
@@ -82,6 +84,7 @@ module Reactor
         self.action = subscription.action
         self.async  = subscription.async
         self.delay  = subscription.delay
+        self.deprecated  = subscription.deprecated
       end
     end
 
@@ -92,6 +95,7 @@ module Reactor
         self.action = subscription.action
         self.delay  = subscription.delay
         self.async  = subscription.async
+        self.deprecated  = subscription.deprecated
       end
     end
 

data/lib/reactor/version.rb

@@ -1,3 +1,3 @@
 module Reactor
-  VERSION = "0.15.1"
+  VERSION = "0.16.0"
 end

data/lib/reactor/workers/concerns/configuration.rb

@@ -0,0 +1,66 @@
+module Reactor
+  module Workers
+    module Configuration
+      extend ActiveSupport::Concern
+
+      included do
+        include Sidekiq::Worker
+
+        CONFIG = [:source, :action, :async, :delay, :deprecated]
+
+        class_attribute *CONFIG
+      end
+
+      class_methods do
+        def configured?
+          CONFIG.all? {|field| !self.send(field).nil? }
+        end
+
+        def perform_where_needed(data)
+          if deprecated
+            return
+          elsif delay > 0
+            perform_in(delay, data)
+          elsif async
+            perform_async(data)
+          else
+            new.perform(data)
+          end
+          source
+        end
+      end
+
+      def configured?
+        self.class.configured?
+      end
+
+      def perform(data)
+        raise_unconfigured! unless configured?
+        return :__perform_aborted__ unless should_perform?
+        event = Reactor::Event.new(data)
+        if action.is_a?(Symbol)
+          source.send(action, event)
+        else
+          action.call(event)
+        end
+      end
+
+      def should_perform?
+        if Reactor.test_mode?
+          Reactor.test_mode_subscriber_enabled? source
+        else
+          true
+        end
+      end
+
+      private
+
+      def raise_unconfigured!
+        settings = Hash[CONFIG.map {|s| [s, self.class.send(s)] }]
+        raise UnconfiguredWorkerError.new(
+            "#{self.class.name} is not properly configured! Here are the settings: #{settings}"
+        )
+      end
+    end
+  end
+end

data/lib/reactor/workers/event_worker.rb

@@ -8,58 +8,8 @@ module Reactor
   module Workers
     class EventWorker
 
-      include Sidekiq::Worker
+     include Reactor::Workers::Configuration
 
-      CONFIG = [:source, :action, :async, :delay]
-
-      class_attribute *CONFIG
-
-      def self.configured?
-        CONFIG.all? {|field| !self.send(field).nil? }
-      end
-
-      def self.perform_where_needed(data)
-        if delay > 0
-          perform_in(delay, data)
-        elsif async
-          perform_async(data)
-        else
-          new.perform(data)
-        end
-        source
-      end
-
-      def configured?
-        self.class.configured?
-      end
-
-      def perform(data)
-        raise_unconfigured! unless configured?
-        return :__perform_aborted__ unless should_perform?
-        event = Reactor::Event.new(data)
-        if action.is_a?(Symbol)
-          source.send(action, event)
-        else
-          action.call(event)
-        end
-      end
-
-      def should_perform?
-        if Reactor.test_mode?
-          Reactor.test_mode_subscriber_enabled? source
-        else
-          true
-        end
-      end
-
-      private
-
-      def raise_unconfigured!
-        settings = Hash[CONFIG.map {|s| [s, self.class.send(s)] }]
-        raise UnconfiguredWorkerError.new(
-          "#{self.class.name} is not properly configured! Here are the settings: #{settings}"
-        )
-      end
     end
   end
 end

data/lib/reactor/workers/mailer_worker.rb

@@ -6,30 +6,7 @@ module Reactor
   module Workers
     class MailerWorker
 
-      include Sidekiq::Worker
-
-      CONFIG = [:source, :action, :async, :delay]
-
-      class_attribute *CONFIG
-
-      def self.configured?
-        CONFIG.all? {|field| field.present? }
-      end
-
-      def self.perform_where_needed(data)
-        if delay > 0
-          perform_in(delay, data)
-        elsif async
-          perform_async(data)
-        else
-          new.perform(data)
-        end
-        source
-      end
-
-      def configured?
-        self.class.configured?
-      end
+      include Reactor::Workers::Configuration
 
       def perform(data)
         raise_unconfigured! unless configured?
@@ -59,22 +36,6 @@ module Reactor
         msg.respond_to?(:deliver_now) || msg.respond_to?(:deliver)
       end
 
-      def should_perform?
-        if Reactor.test_mode?
-          Reactor.test_mode_subscriber_enabled? source
-        else
-          true
-        end
-      end
-
-      private
-
-      def raise_unconfigured!
-        settings = Hash[CONFIG.map {|s| [s, self.class.send(s)] }]
-        raise UnconfiguredWorkerError.new(
-          "#{self.class.name} is not properly configured! Here are the settings: #{settings}"
-        )
-      end
     end
   end
 end

data/lib/reactor.rb

@@ -5,6 +5,7 @@ require "action_mailer"
 require "reactor/version"
 require "reactor/errors"
 require "reactor/static_subscribers"
+require "reactor/workers/concerns/configuration"
 require "reactor/workers"
 require "reactor/subscription"
 require "reactor/models"

data/spec/models/concerns/subscribable_spec.rb

@@ -15,10 +15,14 @@ class Auction < ActiveRecord::Base
     event.actor.more_puppies! if event.name == 'another_event'
   end
 
-  on_event :cat_delivered, in_memory: true do |event|
+  on_event :cat_delivered, async: false do |event|
     puppies!
   end
 
+  on_event :a_high_frequency_event, deprecated: true do |event|
+    raise 'hell'
+  end
+
   def self.ring_bell(event)
     "ring ring! #{event}"
   end
@@ -123,19 +127,28 @@ describe Reactor::Subscribable do
       expect { Reactor::Event.publish :auction }.not_to raise_error
     end
 
-    describe 'in_memory flag' do
-      it 'doesnt fire perform_async when true' do
+    describe 'async flag' do
+      it 'doesnt fire perform_async when false' do
         expect(Auction).to receive(:puppies!)
         expect(Reactor::StaticSubscribers::Auction::CatDeliveredHandler).not_to receive(:perform_async)
         Reactor::Event.publish(:cat_delivered)
       end
 
-      it 'fires perform_async when falsey' do
+      it 'fires perform_async when true / default' do
         expect(Reactor::StaticSubscribers::Auction::WildcardHandler).to receive(:perform_async)
         Reactor::Event.publish(:puppy_delivered)
       end
     end
 
+    describe 'deprecate flag for high-frequency events in production deployments' do
+      it 'doesnt enqueue subscriber worker when true' do
+        # so subscriber can be safely deleted in next deploy
+        expect {
+          Reactor::Event.publish(:a_high_frequency_event)
+        }.to_not raise_exception
+      end
+    end
+
     describe '#perform' do
       around(:each) do |example|
         Reactor.in_test_mode { example.run }

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'bundler/setup'
 require 'pry'
 
 require 'support/active_record'
+require 'support/shared_examples'
 require 'sidekiq'
 require 'sidekiq/testing/inline'
 require 'sidekiq/api'

data/spec/support/shared_examples.rb

@@ -0,0 +1,47 @@
+shared_examples_for 'configurable subscriber worker' do
+  describe '.configured?' do
+    context 'for unconfigured class' do
+      subject { FailingEventWorker.configured? }
+
+      it { is_expected.to eq(false) }
+    end
+
+    context 'for configured class' do
+      subject { MyEventWorker.configured? }
+
+      it { is_expected.to eq(true) }
+    end
+  end
+
+  describe '.perform_where_needed?' do
+    context 'for delayed worker' do
+      let(:klass) { MyDelayedWorker }
+      subject { klass.perform_where_needed(event_data) }
+
+      it 'uses perform_in to delay execution' do
+        expect(klass).to receive(:perform_in).with(1, event_data)
+        subject
+      end
+    end
+
+    context 'for async workers' do
+      let(:klass) { MyEventWorker }
+      subject { klass.perform_where_needed(event_data) }
+
+      it 'uses perform_async to execute wherever' do
+        expect(klass).to receive(:perform_async).with(event_data)
+        subject
+      end
+    end
+
+    context 'for immediate workers' do
+      let(:klass) { MyImmediateWorker }
+      subject { klass.perform_where_needed(event_data) }
+
+      it 'creates and executes new instance' do
+        expect_any_instance_of(klass).to receive(:perform).with(event_data)
+        subject
+      end
+    end
+  end
+end

data/spec/workers/event_worker_spec.rb

@@ -16,6 +16,7 @@ class MyEventWorker < Reactor::Workers::EventWorker
   self.action = :fire_worker
   self.async  = true
   self.delay  = 0
+  self.deprecated = false
 end
 
 class MyBlockWorker < Reactor::Workers::EventWorker
@@ -23,6 +24,7 @@ class MyBlockWorker < Reactor::Workers::EventWorker
   self.action = lambda { |event| :block_ran }
   self.async  = true
   self.delay  = 0
+  self.deprecated = false
 end
 
 class MyDelayedWorker < Reactor::Workers::EventWorker
@@ -30,6 +32,7 @@ class MyDelayedWorker < Reactor::Workers::EventWorker
   self.action = :fire_worker
   self.async  = true
   self.delay  = 1 # seconds
+  self.deprecated = false
 end
 
 class MyImmediateWorker < Reactor::Workers::EventWorker
@@ -37,57 +40,14 @@ class MyImmediateWorker < Reactor::Workers::EventWorker
   self.action = :fire_worker
   self.async  = false
   self.delay  = 0
+  self.deprecated = false
 end
 
 describe Reactor::Workers::EventWorker do
   let(:event_name) { :fire_worker }
   let(:event_data) { Hash[my_event_data: true] }
 
-  describe '.configured?' do
-    context 'for unconfigured class' do
-      subject { FailingEventWorker.configured? }
-
-      it { is_expected.to eq(false) }
-    end
-
-    context 'for configured class' do
-      subject { MyEventWorker.configured? }
-
-      it { is_expected.to eq(true) }
-    end
-  end
-
-  describe '.perform_where_needed?' do
-    context 'for delayed worker' do
-      let(:klass) { MyDelayedWorker }
-      subject { klass.perform_where_needed(event_data) }
-
-      it 'uses perform_in to delay execution' do
-        expect(klass).to receive(:perform_in).with(1, event_data)
-        subject
-      end
-    end
-
-    context 'for async workers' do
-      let(:klass) { MyEventWorker }
-      subject { klass.perform_where_needed(event_data) }
-
-      it 'uses perform_async to execute wherever' do
-        expect(klass).to receive(:perform_async).with(event_data)
-        subject
-      end
-    end
-
-    context 'for immediate workers' do
-      let(:klass) { MyImmediateWorker }
-      subject { klass.perform_where_needed(event_data) }
-
-      it 'creates and executes new instance' do
-        expect_any_instance_of(klass).to receive(:perform).with(event_data)
-        subject
-      end
-    end
-  end
+  it_behaves_like 'configurable subscriber worker'
 
   describe '#perform' do
     let(:klass) { MyEventWorker }

data/spec/workers/mailer_worker_spec.rb

@@ -16,6 +16,7 @@ class MyMailerWorker < Reactor::Workers::MailerWorker
   self.action = :fire_mailer
   self.async  = false
   self.delay  = 0
+  self.deprecated = false
 end
 
 class MyBlockMailerWorker < Reactor::Workers::MailerWorker
@@ -23,6 +24,7 @@ class MyBlockMailerWorker < Reactor::Workers::MailerWorker
   self.async  = false
   self.delay  = 0
   self.action = lambda { |event| fire_mailer(event) }
+  self.deprecated = false
 end
 
 describe Reactor::Workers::MailerWorker do
@@ -34,6 +36,8 @@ describe Reactor::Workers::MailerWorker do
     allow_any_instance_of(klass).to receive(:should_perform?).and_return(true)
   end
 
+  it_behaves_like 'configurable subscriber worker'
+
   it 'sends an email from symbol method name' do
     expect { subject }.to change { ActionMailer::Base.deliveries.count }.by(1)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reactor
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - winfred
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -228,6 +228,7 @@ files:
 - lib/reactor/testing/matchers.rb
 - lib/reactor/version.rb
 - lib/reactor/workers.rb
+- lib/reactor/workers/concerns/configuration.rb
 - lib/reactor/workers/database_subscriber_worker.rb
 - lib/reactor/workers/event_worker.rb
 - lib/reactor/workers/mailer_worker.rb
@@ -241,6 +242,7 @@ files:
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
 - spec/support/active_record.rb
+- spec/support/shared_examples.rb
 - spec/workers/database_subscriber_worker_spec.rb
 - spec/workers/event_worker_spec.rb
 - spec/workers/mailer_worker_spec.rb
@@ -264,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Sidekiq/ActiveRecord pubsub lib
@@ -278,6 +280,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/subscription_spec.rb
 - spec/support/active_record.rb
+- spec/support/shared_examples.rb
 - spec/workers/database_subscriber_worker_spec.rb
 - spec/workers/event_worker_spec.rb
 - spec/workers/mailer_worker_spec.rb