REPLACE received stamp with a new message stamp

AymDev · AymDev · commit 2133b5de4f2c · 2022-02-14T18:33:21.000+01:00
Deprecates the AzureReceivedStamp and replaces it with a new
AzureMessageStamp.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,15 +1,23 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [1.0.0] - 2022-02-10
-### Added
- - **Symfony Messenger** transport for **Azure Service Bus** *queues* and *topics*
-
-[Unreleased]: https://github.com/AymDev/MessengerAzureBundle/compare/v1.0.0...HEAD
-[1.0.0]: https://github.com/AymDev/MessengerAzureBundle/releases/tag/v1.0.0
-
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2022-02-14
+### Added
+ - **AzureMessageStamp** stamp for sent/received messages with *queue*/*topic* name, message, subscription name and delete location
+
+### Deprecated
+ - **AzureReceivedStamp** in favor of the new **AzureMessageStamp**
+
+## [1.0.0] - 2022-02-10
+### Added
+ - **Symfony Messenger** transport for **Azure Service Bus** *queues* and *topics*
+
+[Unreleased]: https://github.com/AymDev/MessengerAzureBundle/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/AymDev/MessengerAzureBundle/releases/tag/v1.1.0
+[1.0.0]: https://github.com/AymDev/MessengerAzureBundle/releases/tag/v1.0.0
+
diff --git a/README.md b/README.md
@@ -1,78 +1,89 @@
-# Messenger Azure Service Bus Bundle
-A **Symfony 4 / 5 / 6** bundle providing a **Symfony Messenger** *transport* for **Azure Service Bus** using the *Azure REST API*.
-
-![Testing](https://github.com/AymDev/MessengerAzureBundle/workflows/Testing/badge.svg)
-![Coding Standards](https://github.com/AymDev/MessengerAzureBundle/workflows/Coding%20Standards/badge.svg)
-![Bundle installation](https://github.com/AymDev/MessengerAzureBundle/workflows/Bundle%20installation/badge.svg)
-[![Latest Stable Version](https://poser.pugx.org/aymdev/messenger-azure-bundle/v)](//packagist.org/packages/aymdev/messenger-azure-bundle)
-[![License](https://poser.pugx.org/aymdev/messenger-azure-bundle/license)](//packagist.org/packages/aymdev/messenger-azure-bundle)
-
-## Installation
-
-You only need to install the bundle using **Composer**:
-```shell
-composer require aymdev/messenger-azure-bundle
-```
-As it uses [Symfony HttpClient](https://symfony.com/doc/current/http_client.html),
-you will need to install a [PSR-18 client](https://symfony.com/doc/current/http_client.html#psr-18-and-psr-17).
-Example:
-```shell
-composer require nyholm/psr7
-```
-
-## Configuration
-
-### Transport DSN
-
-Your DSN must respect the following format to build the authentication header for a specific *namespace*:
-```
-azure://KEY_NAME:KEY_VALUE@NAMESPACE
-```
->Where `KEY_NAME` is your **shared access key name**, `KEY_VALUE` is your **shared access key** and `NAMESPACE` is your
->*Azure Service Bus* **namespace**.
-
-### Transport options
-
-Detailed list of transport options:
-
-| Option name | Description | Required | Default value |  
-| ------------- | ------------- | ----: | ----: |
-| `entity_path`  | The **topic** or **queue** name.  | Yes | |
-| `subscription`  | The subcription name to consume messages from a **topic**.  | Only for *topic consumer transports* | |
-| `token_expiry`  | [SAS token](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas#generate-a-shared-access-signature-token) validity duration in seconds.  | | `3600` |
-| `receive_mode`  | Set to `peek-lock` to perform a [non destructive read](https://docs.microsoft.com/en-us/rest/api/servicebus/peek-lock-message-non-destructive-read) or to `receive-and-delete` to perform a [destructive-read](https://docs.microsoft.com/en-us/rest/api/servicebus/receive-and-delete-message-destructive-read)  | | `peek-lock` |
-
-Example `config/packages/messenger.yaml`:
-```yaml
-framework:
-    messenger:
-        transports:
-            azure_transport:
-                dsn: '%env(AZURE_SERVICE_BUS_DSN)%'
-                serializer: 'App\Messenger\YourAzureSerializer'
-                options:
-                    entity_path: 'your-topic'
-                    subscription: 'subscription-name'
-                    token_expiry: 60
-                    receive_mode: 'receive-and-delete'
-```
-
-## Stamps
-
-This transport provides 2 stamps:
-
-### AzureReceivedStamp
-
-The `AymDev\MessengerAzureBundle\Messenger\Stamp\AzureReceivedStamp` stamp holds the original message body and an optional deletion URL.
-
-### AzureBrokerPropertiesStamp
-
-The `AymDev\MessengerAzureBundle\Messenger\Stamp\AzureBrokerPropertiesStamp` stamp is used for the [message properties](https://docs.microsoft.com/en-us/rest/api/servicebus/message-headers-and-properties).
-It is automatically decoded when consuming a message and is encoded when producing a message if added to the *envelope*.
-
-## Serialization
-
-There is no serializer provided, but here is the expected array structure of an encoded envelope:
-
- - `body`: your plain text message
+# Messenger Azure Service Bus Bundle
+A **Symfony 4 / 5 / 6** bundle providing a **Symfony Messenger** *transport* for **Azure Service Bus** using the *Azure REST API*.
+
+![Testing](https://github.com/AymDev/MessengerAzureBundle/workflows/Testing/badge.svg)
+![Coding Standards](https://github.com/AymDev/MessengerAzureBundle/workflows/Coding%20Standards/badge.svg)
+![Bundle installation](https://github.com/AymDev/MessengerAzureBundle/workflows/Bundle%20installation/badge.svg)
+[![Latest Stable Version](https://poser.pugx.org/aymdev/messenger-azure-bundle/v)](//packagist.org/packages/aymdev/messenger-azure-bundle)
+[![License](https://poser.pugx.org/aymdev/messenger-azure-bundle/license)](//packagist.org/packages/aymdev/messenger-azure-bundle)
+
+## Installation
+
+You only need to install the bundle using **Composer**:
+```shell
+composer require aymdev/messenger-azure-bundle
+```
+As it uses [Symfony HttpClient](https://symfony.com/doc/current/http_client.html),
+you will need to install a [PSR-18 client](https://symfony.com/doc/current/http_client.html#psr-18-and-psr-17).
+Example:
+```shell
+composer require nyholm/psr7
+```
+
+## Configuration
+
+### Transport DSN
+
+Your DSN must respect the following format to build the authentication header for a specific *namespace*:
+```
+azure://KEY_NAME:KEY_VALUE@NAMESPACE
+```
+>Where `KEY_NAME` is your **shared access key name**, `KEY_VALUE` is your **shared access key** and `NAMESPACE` is your
+>*Azure Service Bus* **namespace**.
+
+### Transport options
+
+Detailed list of transport options:
+
+| Option name | Description | Required | Default value |  
+| ------------- | ------------- | ----: | ----: |
+| `entity_path`  | The **topic** or **queue** name.  | Yes | |
+| `subscription`  | The subcription name to consume messages from a **topic**.  | Only for *topic consumer transports* | |
+| `token_expiry`  | [SAS token](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas#generate-a-shared-access-signature-token) validity duration in seconds.  | | `3600` |
+| `receive_mode`  | Set to `peek-lock` to perform a [non destructive read](https://docs.microsoft.com/en-us/rest/api/servicebus/peek-lock-message-non-destructive-read) or to `receive-and-delete` to perform a [destructive-read](https://docs.microsoft.com/en-us/rest/api/servicebus/receive-and-delete-message-destructive-read)  | | `peek-lock` |
+
+Example `config/packages/messenger.yaml`:
+```yaml
+framework:
+    messenger:
+        transports:
+            azure_transport:
+                dsn: '%env(AZURE_SERVICE_BUS_DSN)%'
+                serializer: 'App\Messenger\YourAzureSerializer'
+                options:
+                    entity_path: 'your-topic'
+                    subscription: 'subscription-name'
+                    token_expiry: 60
+                    receive_mode: 'receive-and-delete'
+```
+
+## Stamps
+
+This transport provides 2 stamps:
+
+### AzureMessageStamp
+
+The `AymDev\MessengerAzureBundle\Messenger\Stamp\AzureMessageStamp` stamp is added to sent and received messages and
+contains:
+
+ - the *topic* or *queue* name
+ - the original sent/received message
+ - the subscription name for received messages from *topics*
+ - the delete URL for received messages in `peek-lock` receive mode 
+
+### AzureBrokerPropertiesStamp
+
+The `AymDev\MessengerAzureBundle\Messenger\Stamp\AzureBrokerPropertiesStamp` stamp is used for the [message properties](https://docs.microsoft.com/en-us/rest/api/servicebus/message-headers-and-properties).
+It is automatically decoded when consuming a message and is encoded when producing a message if added to the *envelope*.
+
+### AzureReceivedStamp
+
+The `AymDev\MessengerAzureBundle\Messenger\Stamp\AzureReceivedStamp` stamp holds the original message body and an optional deletion URL.
+>This stamp is deprecated in favor of the AzureMessageStamp and will be removed in v2.
+
+## Serialization
+
+There is no serializer provided, but here is the expected array structure of an encoded envelope:
+
+ - `body`: your plain text message
  - `headers`: optional HTTP headers (either received from *Azure Service Bus* response or to send to the REST API)
diff --git a/src/Messenger/Stamp/AzureMessageStamp.php b/src/Messenger/Stamp/AzureMessageStamp.php
@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AymDev\MessengerAzureBundle\Messenger\Stamp;
+
+use Symfony\Component\Messenger\Stamp\StampInterface;
+use Symfony\Contracts\HttpClient\Exception\HttpExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+/**
+ * Azure Service Bus stamp added to sent and received messages containing message metadata
+ */
+class AzureMessageStamp implements StampInterface
+{
+    /** @var string */
+    private $entityPath;
+
+    /** @var string */
+    private $message;
+
+    /** @var null|string */
+    private $subscriptionName;
+
+    /** @var string|null */
+    private $locationHeader;
+
+    /**
+     * @internal
+     * @param string $message the original message
+     * @param string|null $locationHeader optional "Location" response header
+     */
+    public function __construct(
+        string $entityPath,
+        string $message,
+        ?string $subscriptionName = null,
+        ?string $locationHeader = null
+    ) {
+        $this->entityPath = $entityPath;
+        $this->message = $message;
+        $this->subscriptionName = $subscriptionName;
+        $this->locationHeader = $locationHeader;
+    }
+
+    /**
+     * Create a stamp from an HTTP response in the receiver transport
+     * @internal
+     * @throws HttpExceptionInterface|TransportExceptionInterface
+     */
+    public static function createFromResponse(
+        ResponseInterface $response,
+        string $entityPath,
+        ?string $subscriptionName
+    ): self {
+        return new self(
+            $entityPath,
+            $response->getContent(),
+            $subscriptionName,
+            $response->getHeaders()['location'][0] ?? null
+        );
+    }
+
+    public function getEntityPath(): string
+    {
+        return $this->entityPath;
+    }
+
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+
+    public function getSubscriptionName(): ?string
+    {
+        return $this->subscriptionName;
+    }
+
+    public function getLocationHeader(): ?string
+    {
+        return $this->locationHeader;
+    }
+}
diff --git a/src/Messenger/Stamp/AzureReceivedStamp.php b/src/Messenger/Stamp/AzureReceivedStamp.php
@@ -11,6 +11,8 @@
 
 /**
  * Azure Service Bus receiver stamp with message metadata
+ * TODO: remove stamp in v2
+ * @deprecated AzureReceivedStamp is kept for compatibility purposes. Use AzureMessageStamp instead
  */
 class AzureReceivedStamp implements NonSendableStampInterface
 {
diff --git a/src/Messenger/Transport/AzureTransport.php b/src/Messenger/Transport/AzureTransport.php
@@ -5,6 +5,7 @@
 namespace AymDev\MessengerAzureBundle\Messenger\Transport;
 
 use AymDev\MessengerAzureBundle\Messenger\Stamp\AzureBrokerPropertiesStamp;
+use AymDev\MessengerAzureBundle\Messenger\Stamp\AzureMessageStamp;
 use AymDev\MessengerAzureBundle\Messenger\Stamp\AzureReceivedStamp;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Exception\TransportException;
@@ -36,16 +37,26 @@ final class AzureTransport implements TransportInterface
     /** @var string */
     private $receiveMode;
 
+    /** @var string */
+    private $entityPath;
+
+    /** @var string|null */
+    private $subscriptionName;
+
     public function __construct(
         SerializerInterface $serializer,
         HttpClientInterface $senderClient,
         HttpClientInterface $receiverClient,
-        string $receiveMode
+        string $receiveMode,
+        string $entityPath,
+        ?string $subscriptionName = null
     ) {
         $this->serializer = $serializer;
         $this->senderClient = $senderClient;
         $this->receiverClient = $receiverClient;
         $this->receiveMode = $receiveMode;
+        $this->entityPath = $entityPath;
+        $this->subscriptionName = $subscriptionName;
     }
 
     /**
@@ -90,6 +101,7 @@ public function get(): iterable
         $brokerPropertiesStamp = AzureBrokerPropertiesStamp::createFromResponse($response);
         $envelope = $envelope
             ->with(AzureReceivedStamp::createFromResponse($response))
+            ->with(AzureMessageStamp::createFromResponse($response, $this->entityPath, $this->subscriptionName))
             ->with($brokerPropertiesStamp)
         ;
 
@@ -155,7 +167,11 @@ public function send(Envelope $envelope): Envelope
             );
         }
 
-        return $envelope;
+        return $envelope->with(new AzureMessageStamp(
+            $this->entityPath,
+            $encodedMessage['body'],
+            $this->subscriptionName
+        ));
     }
 
     /**
@@ -187,8 +203,8 @@ private function delete(Envelope $envelope): void
     private function getDeleteUri(Envelope $envelope): string
     {
         // Use delete location URL
-        /** @var null|AzureReceivedStamp $receivedStamp */
-        $receivedStamp = $envelope->last(AzureReceivedStamp::class);
+        /** @var null|AzureMessageStamp $receivedStamp */
+        $receivedStamp = $envelope->last(AzureMessageStamp::class);
 
         if (null !== $receivedStamp && null !== $receivedStamp->getLocationHeader()) {
             return $receivedStamp->getLocationHeader();
diff --git a/src/Messenger/Transport/AzureTransportFactory.php b/src/Messenger/Transport/AzureTransportFactory.php
@@ -61,7 +61,14 @@ public function createTransport(string $dsn, array $options, SerializerInterface
             $receiverConfiguration['options']
         );
 
-        return new AzureTransport($serializer, $senderClient, $receiverClient, $options['receive_mode']);
+        return new AzureTransport(
+            $serializer,
+            $senderClient,
+            $receiverClient,
+            $options['receive_mode'],
+            $options['entity_path'],
+            $options['subscription']
+        );
     }
 
     /**
diff --git a/tests/Messenger/Stamp/AzureMessageStampTest.php b/tests/Messenger/Stamp/AzureMessageStampTest.php
diff --git a/tests/Messenger/Transport/AzureTransportTest.php b/tests/Messenger/Transport/AzureTransportTest.php

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* Azure Service Bus receiver stamp with message metadata`
	`14`	`+ * TODO: remove stamp in v2`
	`15`	`+ * @deprecated AzureReceivedStamp is kept for compatibility purposes. Use AzureMessageStamp instead`
`14`	`16`	`*/`
`15`	`17`	`class AzureReceivedStamp implements NonSendableStampInterface`
`16`	`18`	`{`