event_engine-subscribers 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2a695d8809af3af1b9145dd9866e96aa710304f3ccdba661ec5ed46e059577e
-  data.tar.gz: 4625cf214a4b49c8814afd693b099f5d46bfe94421ceec5d346ce362acb87e33
+  metadata.gz: 77ec2b6b5c9768d1968ead2a2d567e796a91747036be8d6c407137a36997c781
+  data.tar.gz: 4f97fd5b867ca07942c082c3e37a65e4a0bb452c6e7c4d59fd409561ccb9ea23
 SHA512:
-  metadata.gz: '08d6aeee53d7aa109bf72227d0cc5dd9698f57307389c052ff6113eb1859018ec4e852c5c9b2ef95d6ace4f057663c4e31e1596d106d3debd72162ccef0d4efd'
-  data.tar.gz: f0469ee662fd07bd01598b44125d1123f5a1bb2b972442c3b246ca28a1d8bb0d7a8a6b6c6dbf81c00db9f0575bdaf2598988af025c47e6dc55c2b09e96c20c53
+  metadata.gz: b806c0dbe05a8c57a1d3b1c0cd0fbe7937d015f5822d37c3f5feafd083d922a5f528b871564aaa8259866d8f0bd6ca4b90af63351788b8521f4baadf57346201
+  data.tar.gz: fcc63467dcf27dc0021304dd36821de214c30f9eff44efca1f3f2cd6a9b5a59cbe6f43693547f28e86bc4b0f7dfa949f8d912ee25c914bd1ff35328ba9aed617

data/README.md

@@ -92,9 +92,35 @@ EventEngine::UnregisteredProcessorError: the rule for event :lead_created
   under that name
 ```
 
-If subscribers do not run for an event that *is* routed here, check that the
-subscriber class is in `app/subscribers`. A subscriber anywhere else registers only
-once Rails has loaded its class.
+If an event is routed to `inline` or `background` and no subscriber is registered for
+it, the app refuses to start and names each such event:
+
+```
+EventEngine::Subscribers::UnsubscribedEventsError: These events are routed to
+  subscribers but have none: hay_baled
+```
+
+The check runs once the app has started, after every class in `app/subscribers` is
+registered. A subscriber anywhere else registers only once Rails has loaded its class,
+so keep subscribers in `app/subscribers`.
+
+## Requiring every event 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 calls the event start check once the subscriber
+processors are registered:
+
+```ruby
+# config/application.rb
+config.after_initialize do
+  EventEngine::Subscribers.check_inline!(EventEngine::Subscribers.routes)
+end
+```
+
+The app then refuses to start when an event has no rule, when a rule names a processor
+nothing registered, or when any event is routed to `background`. The last error names
+every such event. A host that does not call it can route events to `background` as
+before.
 
 ## A working example app
 

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

@@ -14,6 +14,10 @@ module EventEngine
         end
       end
 
+      initializer "event_engine.subscribers.check_every_routed_event_has_a_subscriber" do
+        config.after_initialize { Subscribers.check!(Subscribers.routes) }
+      end
+
       initializer "event_engine.subscribers.forget_unloaded_subscribers" do |app|
         app.reloader.before_class_unload { Registry.clear! }
       end

data/lib/event_engine/subscribers/registry.rb

@@ -23,6 +23,13 @@ module EventEngine
         registrations[event_name&.to_sym] || []
       end
 
+      def self.unsubscribed(routes)
+        routes.select { |event_name, process_type| routed_to_subscribers?(process_type) && subscribers_for(event_name).empty? }.keys
+      end
+
+      def self.routed_to_subscribers?(process_type) = Processor::HANDLED_PROCESS_TYPES.include?(process_type&.to_sym)
+      private_class_method :routed_to_subscribers?
+
       # Removes all registrations. Intended for test isolation.
       #
       # @return [void]

data/lib/event_engine/subscribers/unsubscribed_events_error.rb

@@ -0,0 +1,9 @@
+module EventEngine
+  module Subscribers
+    class UnsubscribedEventsError < StandardError
+      def initialize(event_names)
+        super("These events are routed to subscribers but have none: #{event_names.join(", ")}")
+      end
+    end
+  end
+end

data/lib/event_engine/subscribers/version.rb

@@ -1,5 +1,5 @@
 module EventEngine
   module Subscribers
-    VERSION = "0.1.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/event_engine/subscribers.rb

@@ -3,8 +3,34 @@ require "event_engine/subscribers/engine"
 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
+    def self.routes
+      EventEngine.schema_registry.events.to_h { |event_name| [ event_name, process_type_of(event_name) ] }
+    end
+
+    def self.process_type_of(event_name)
+      domain = EventEngine.schema_registry.latest_for(event_name).domain
+      EventEngine.processing_rules.for(event_name: event_name, pack: domain)
+    end
+    private_class_method :process_type_of
+
+    def self.check!(routes)
+      unsubscribed = Registry.unsubscribed(routes)
+      raise UnsubscribedEventsError, unsubscribed if unsubscribed.any?
+
+      true
+    end
+
+    def self.check_inline!(routes)
+      EventEngine.validate_rules!
+      background = routes.reject { |_event_name, process_type| process_type == :inline }.keys
+      raise BackgroundEventsError, background if background.any?
+
+      true
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_engine-subscribers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - tylercschneider
@@ -81,10 +81,12 @@ 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
 - lib/event_engine/subscribers/registry.rb
+- lib/event_engine/subscribers/unsubscribed_events_error.rb
 - lib/event_engine/subscribers/version.rb
 - lib/tasks/event_engine/subscribers_tasks.rake
 - the_local/agents/event_engine-subscribers-develop.md