https://github.com/aymdev/messengerazurebundle
A Symfony 4/5/6 bundle providing a Messenger transport for Azure Service Bus using the Azure REST API.
https://github.com/aymdev/messengerazurebundle
Last synced: 10 months ago
JSON representation
A Symfony 4/5/6 bundle providing a Messenger transport for Azure Service Bus using the Azure REST API.
- Host: GitHub
- URL: https://github.com/aymdev/messengerazurebundle
- Owner: AymDev
- License: mit
- Created: 2022-02-10T17:46:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-14T21:11:37.000Z (over 2 years ago)
- Last Synced: 2025-08-15T08:42:07.700Z (11 months ago)
- Language: PHP
- Size: 80.1 KB
- Stars: 12
- Watchers: 2
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Messenger Azure Service Bus Bundle
A **PHP 8.1+** & **Symfony 5 / 6 / 7** bundle providing a **Symfony Messenger** *transport* for **Azure Service Bus** using the *Azure REST API*.
[](//packagist.org/packages/aymdev/messenger-azure-bundle)
[](//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**.
>**Important note:** the keys can contain special characters that could break the URL parsing. Be sure to URL encode
>them.
### 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 a few 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*.
## Serialization
### Creating your serializers
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)
### Logging decoding errors
When a serializer throws a `Symfony\Component\Messenger\Exception\MessageDecodingFailedException` while decoding a message,
it will be converted to a `AymDev\MessengerAzureBundle\Messenger\Exception\SerializerDecodingException` which contains an
envelope with an empty message but with the same stamps as a successfully decoded message.
You can then [listen](https://symfony.com/doc/current/event_dispatcher.html) to the `console.error` Symfony event and get
the topic/queue name where then decoding failure happened, the original message, etc.