Merge pull request #14 from MacPaw/develop

Release

Author: alekseytupichenkov

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MacPaw Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -63,13 +63,22 @@ public function index(BaggageSchemaResolver $schemaResolver)
 Decorate your http client in your service configuration:
 ```yaml
 services:
+  baggage_aware_payment_http_client:
+    class: Macpaw\SchemaContextBundle\HttpClient\BaggageAwareHttpClient
+    decorates: payment_http_client #http client to decorate
+    arguments:
+      - '@baggage_aware_payment_http_client.inner'
+```
+
+### A Note on Testing
+
+If you are replacing or mocking HTTP clients in your test environment, for example, using a library like [`macpaw/extended-mock-http-client`](https://github.com/MacPaw/extended_mock_http_client), you need to disable the `BaggageAwareHttpClient` decoration.
+
+```yaml
+when@test:
+  services:
     baggage_aware_payment_http_client:
       class: Macpaw\SchemaContextBundle\HttpClient\BaggageAwareHttpClient
-      decorates: payment_http_client #http client to decorate
-      arguments:
-        - '@baggage_aware_payment_http_client.inner'
-        - '@Macpaw\SchemaContextBundle\Service\BaggageSchemaResolver'
-        - '@Macpaw\SchemaContextBundle\Service\BaggageCodec'
 ```
 
 ## Messenger Integration
@@ -87,7 +96,7 @@ framework:
     buses:
       messenger.bus.default:
         middleware:
-        - Macpaw\SchemaContextBundle\Messenger\Middleware\BaggageMiddleware
+        - Macpaw\SchemaContextBundle\Messenger\Middleware\BaggageSchemaMiddleware
 ```
 
 ## Testing

config/services.yaml

@@ -8,6 +8,10 @@ services:
     public: true
     shared: true
 
+  Macpaw\SchemaContextBundle\Service\BaggageCodec:
+    public: true
+    shared: true
+
   Macpaw\SchemaContextBundle\EventListener\BaggageRequestListener:
     arguments:
       $baggageSchemaResolver: '@Macpaw\SchemaContextBundle\Service\BaggageSchemaResolver'
@@ -18,6 +22,6 @@ services:
     tags:
       - { name: kernel.event_subscriber }
 
-  Macpaw\SchemaContextBundle\Messenger\Middleware\BaggageMiddleware:
+  Macpaw\SchemaContextBundle\Messenger\Middleware\BaggageSchemaMiddleware:
     tags:
       - { name: messenger.middleware }