emag-tech-labs/messenger-mongo-bundle

A Mongo transport for the Symfony Messenger component

1.3.0 2024-03-29 22:21 UTC

Requires

• php: ^8.1
• ext-json: *
• ext-mongodb: *
• mongodb/mongodb: ^1.12
• symfony/messenger: ^5.0 || ^6.0 || ^7.0

Requires (Dev)

• infection/infection: ^0.27.9
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.5
• symfony/framework-bundle: ^5.0 || ^6.0 || ^7.0
• symfony/property-access: ^5.0 || ^6.0 || ^7.0
• symfony/serializer: ^5.0 || ^6.0 || ^7.0
• symfony/var-dumper: ^5.0 || ^6.0 || ^7.0

MIT

• Iosif Chiriluta
• eMAGTechLabs

README

This bundle offers a new type of transport for the Symfony Messenger component. While MongoDB is not the best tool to be used as a queue, sometimes it's more convenient to use the tools that your application already uses. For example, if your application already uses MongoDB and you want a persistent storage for the failed messages, I think it's quite handy to use MongoDB as a storage.

Installation

The recommended way to install the bundle is through Composer:

$ composer require emag-tech-labs/messenger-mongo-bundle

Configuration & usage

Take a look here if you need to find out how to configure the driverOptions, uriOptions and dsn options.

framework:
    messenger:
        transports:
            hello_queue:
                dsn: mongodb://127.0.0.1:27017
                options:
                    uriOptions: []
                    driverOptions: []
                    database: symfony # required
                    collection: hello_messages # default is "messenger_queue"
                    queue: hello_queue # default is "default"
                    redeliver_timeout: 4800 # default is 3600
                    enable_writeConcern_majority: false # default is true

The features described here can be used also, therefore the following commands are available in order to manually debug the failed messages:

# see all messages in the failure transport
$ php bin/console messenger:failed:show

# see details about a specific failed message
$ php bin/console messenger:failed:show 20 -vv

# view and retry messages one-by-one
$ php bin/console messenger:failed:retry -vv

# retry specific messages
$ php bin/console messenger:failed:retry 20 30 --force

# remove a message without retrying it
$ php bin/console messenger:failed:remove

# displays the number of queued messages in all transports
$ php bin/console messenger:stats

Submitting bugs and feature requests

If you found a nasty bug or want to propose a new feature, you're welcome to open an issue or create a pull request here.