Introduce plugin-specific Messenger buses in Invoicing Plugin

Author: tomkalon

UPGRADE-3.0.md

@@ -0,0 +1,21 @@
+# UPGRADE FROM 2.1 TO 3.0
+
+## Changes
+
+1. Introduced plugin-specific Messenger buses (`sylius_invoicing.command_bus` and `sylius_invoicing.event_bus`):
+
+- The Invoicing Plugin no longer uses the global `sylius.command_bus` or `sylius.event_bus`.
+- If you have custom message handlers, middleware, or routing related to the plugin, update them to use the new plugin-specific buses.
+- Example configuration:
+
+```yaml
+framework:
+    messenger:
+        buses:
+            sylius_invoicing.command_bus:
+                middleware:
+                    - 'validation'
+                    - 'doctrine_transaction'
+            sylius_invoicing.event_bus:
+                default_middleware: allow_no_handlers
+```

config/config.yaml

@@ -114,9 +114,9 @@ sylius_grid:
 framework:
     messenger:
         buses:
-            sylius.event_bus:
+            sylius_invoicing.event_bus:
                 default_middleware: allow_no_handlers
-            sylius.command_bus:
+            sylius_invoicing.command_bus:
                 middleware:
                     - 'validation'
                     - 'doctrine_transaction'

config/services.xml

@@ -37,7 +37,7 @@
             <argument type="service" id="sylius_invoicing.repository.invoice" />
             <argument type="service" id="sylius.repository.order" />
             <argument type="service" id="sylius_invoicing.email.invoice_email_sender" />
-            <tag name="messenger.message_handler" />
+            <tag name="messenger.message_handler" bus="sylius_invoicing.command_bus"/>
         </service>
 
         <service id="sylius_invoicing.security.voter.invoice" class="Sylius\InvoicingPlugin\Security\Voter\InvoiceVoter">

config/services/listeners.xml

@@ -20,26 +20,26 @@
         <defaults public="true" />
 
         <service id="sylius_invoicing.event_producer.order_payment_paid" class="Sylius\InvoicingPlugin\EventProducer\OrderPaymentPaidProducer">
-            <argument type="service" id="sylius.event_bus" />
+            <argument type="service" id="sylius_invoicing.event_bus" />
             <argument type="service" id="clock" />
             <argument type="service" id="sylius_invoicing.repository.invoice" />
         </service>
 
         <service id="sylius_invoicing.listener.order_placed" class="Sylius\InvoicingPlugin\EventListener\CreateInvoiceOnOrderPlacedListener">
             <argument type="service" id="sylius_invoicing.creator.invoice" />
-            <tag name="messenger.message_handler" bus="sylius.event_bus" />
+            <tag name="messenger.message_handler" bus="sylius_invoicing.event_bus" />
         </service>
 
         <service id="sylius_invoicing.event_producer.order_placed" class="Sylius\InvoicingPlugin\EventProducer\OrderPlacedProducer">
-            <argument type="service" id="sylius.event_bus" />
+            <argument type="service" id="sylius_invoicing.event_bus" />
             <argument type="service" id="clock" />
             <tag name="doctrine.event_listener" event="postPersist" />
             <tag name="doctrine.event_listener" event="postUpdate" />
         </service>
 
         <service id="sylius_invoicing.listener.order_payment_paid" class="Sylius\InvoicingPlugin\EventListener\OrderPaymentPaidListener">
-            <argument type="service" id="sylius.command_bus" />
-            <tag name="messenger.message_handler" bus="sylius.event_bus" />
+            <argument type="service" id="sylius_invoicing.command_bus" />
+            <tag name="messenger.message_handler" bus="sylius_invoicing.event_bus" />
         </service>
     </services>
 </container>