event_engine-subscribers 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34965b10a7789582de233120f7e16c220292225c732605797c7dd2759f84d070
-  data.tar.gz: 3936714ca836690e78228fdfe66c5be51b5c7a7826264ea5f745ea696c16a277
+  metadata.gz: 9911cefcbfa87b20178f615e68e88cef8f57da763ad42fcdf10a3f7f1b9d7be9
+  data.tar.gz: 1aa83bfbbea17ba4b3d2555f08509545f487e94d38abc52409de1a97bfa52109
 SHA512:
-  metadata.gz: '08c34c7ddcdef975a9c8af1f2289e55bf13bcaa7426e18544bb92bebe80f3acd1f927a9f207d05b130a4481b4aed632506f0e8e24c7fe3384e3cefbf62821088'
-  data.tar.gz: a750d52e0fc9a50cde6feded5f5ac782a027f9618ce4104a7fc2c231bdc403f8e6e607f8e9326297796e6fc4aab740f4912a3e458536acd65ea85d04fc808a1f
+  metadata.gz: 64e5c8652616821523641c4ffa5e17afb165e052847cde405c42f9ba2e852ed90a5c77add76ba3d6315e4fe230b97c280ff6213db5671c18a94e41757d957f82
+  data.tar.gz: 6b420c78274b70abf4cda7d544074e692e400409dac035937204b2270a0a2605b9a3f63198d46b0c9201c49cd3406aab5a6d1f789de28defe4c69aaf4f6fd88c

data/README.md

@@ -104,6 +104,22 @@ The check runs once the app has started, after every class in `app/subscribers`
 registered. A subscriber anywhere else registers only once Rails has loaded its class,
 so keep subscribers in `app/subscribers`.
 
+## Requiring a pack's events to run inline
+
+A subscriber that refuses a change can only undo it when it runs inline, during the
+emit. A host that depends on that names the event packs whose events must run inline:
+
+```ruby
+# config/application.rb
+config.event_engine_subscribers.inline_packs = [:console]
+```
+
+When the app starts, the gem then refuses to start when an event has no rule, when a
+rule names a processor nothing registered, or when an event in a named pack is routed to
+`background`. The last error names every such event. Events in other packs may still
+run in the background. With no packs named, which is the default, the gem runs no inline
+check.
+
 ## A working example app
 
 [**DYB-Development/event_engine_example**](https://github.com/DYB-Development/event_engine_example)

data/lib/event_engine/subscribers/background_events_error.rb

@@ -0,0 +1,9 @@
+module EventEngine
+  module Subscribers
+    class BackgroundEventsError < StandardError
+      def initialize(event_names)
+        super("These events are routed to run in the background, where a refusal cannot undo the change: #{event_names.join(", ")}")
+      end
+    end
+  end
+end

data/lib/event_engine/subscribers/engine.rb

@@ -5,6 +5,9 @@ module EventEngine
     class Engine < ::Rails::Engine
       isolate_namespace EventEngine::Subscribers
 
+      config.event_engine_subscribers = ActiveSupport::OrderedOptions.new
+      config.event_engine_subscribers.inline_packs = []
+
       initializer "event_engine.subscribers.register_processor" do
         config.after_initialize do
           processor = Processor.new
@@ -18,6 +21,13 @@ module EventEngine
         config.after_initialize { Subscribers.check!(Subscribers.routes) }
       end
 
+      initializer "event_engine.subscribers.check_inline_packs", after: "event_engine.subscribers.register_processor" do |app|
+        config.after_initialize do
+          packs = app.config.event_engine_subscribers.inline_packs
+          Subscribers.check_inline!(Subscribers.routes, packs: packs) if packs.any?
+        end
+      end
+
       initializer "event_engine.subscribers.forget_unloaded_subscribers" do |app|
         app.reloader.before_class_unload { Registry.clear! }
       end

data/lib/event_engine/subscribers/version.rb

@@ -1,5 +1,5 @@
 module EventEngine
   module Subscribers
-    VERSION = "0.2.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/event_engine/subscribers.rb

@@ -4,6 +4,7 @@ require "event_engine/subscribers/registry"
 require "event_engine/subscribers/base"
 require "event_engine/subscribers/processor"
 require "event_engine/subscribers/unsubscribed_events_error"
+require "event_engine/subscribers/background_events_error"
 
 module EventEngine
   module Subscribers
@@ -23,5 +24,17 @@ module EventEngine
 
       true
     end
+
+    def self.check_inline!(routes, packs: nil)
+      EventEngine.validate_rules!
+      background = routes.reject { |_event_name, process_type| process_type == :inline }.keys
+      background = background.select { |event_name| packs.include?(pack_of(event_name)) } if packs
+      raise BackgroundEventsError, background if background.any?
+
+      true
+    end
+
+    def self.pack_of(event_name) = EventEngine.schema_registry.latest_for(event_name).domain
+    private_class_method :pack_of
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_engine-subscribers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - tylercschneider
@@ -81,6 +81,7 @@ files:
 - app/jobs/event_engine/subscribers/dispatch_subscribers_job.rb
 - app/views/layouts/event_engine/subscribers/application.html.erb
 - lib/event_engine/subscribers.rb
+- lib/event_engine/subscribers/background_events_error.rb
 - lib/event_engine/subscribers/base.rb
 - lib/event_engine/subscribers/engine.rb
 - lib/event_engine/subscribers/processor.rb