softonic / laravel-protobuf-events
Helper to allow nuwber/rabbitevents to work with protobuf
Installs: 7 639
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 7
Forks: 0
Open Issues: 0
Requires
- php: >=8.1
- ext-bcmath: *
- ext-pcntl: *
- ext-protobuf: *
- ext-sockets: *
- google/protobuf: ^3.19
- nuwber/rabbitevents: ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.50
- mockery/mockery: ^1.0
- orchestra/testbench: ^8.21
- phpunit/phpunit: ^9.0
- rector/rector: ^0.11.20
- squizlabs/php_codesniffer: ^3
README
Helper to allow nuwber/rabbitevents to work with protobuf
Main features
- Allow to publish/listen protobuf messages using nuwber/rabbit-events easily.
Installation
You can require the last version of the package using composer
composer require softonic/laravel-protobuf-events
Configuration
First you need to configure the nuwber/rabbit-events package to be able to use the package.
Then you must configure config/protobuf-events.php
to set the client of the library. This client allows to isolate
different services, identifying the origin of the message.
Configuring a listener
In the RabbitEventsServiceProvider::boot()
register the listeners that you want using the ExternalEvents::decorateListener()
method.
/** * Register any events for your application. */ public function boot(): void { $this->listen = [ 'my.routing.key' => [ ExternalEvents::decorateListener(MyListener::class), ], ]; parent::boot(); }
The listener needs a method called handle()
that will receive the message and the routing key,
and a method called setClient()
to identify the origin of the message.
class MyListener { public function setClient(string $client): void { // ... } public function handle(ProtobufExampleMessage $event): void { // ... } }
Publishing messages
To publish a message, you need to use the ExternalEvents::publish()
method.
ExternalEvents::publish( ':service:', (new ProtobufExampleMessage) ->setName('My name') ->setAge(10) );
Advanced usage
Sometimes you need to use the package in a different way than the default. For example, you can use the package to decode
a message from a string. In that case, you are able to decode the message using the ExternalEvents::decode()
method.
$message = ExternalEvents::decode( ProtobufExampleMessage::class, '\n My name\n 10\n' // The message is a string with the protobuf message. );
Logging protobuf messages
If you want to log the outgoing protobuf messages and the incoming ones, you can configure a logger and a formatter for the message to be logged.
For that purpose you have the methods ExternalEvents::setLogger()
and ExternalEvents::setFormatter()
.
The logger must implement the Psr\Log\LoggerInterface
and the formatter, the LogMessageFormatterInterface
interface.
ExternalEvents::setLogger(Log:getFacadeRoot()); ExternalEvents::setFormatter(new ProtobufLogMessageFormatter());
The formatter will have two methods, formatOutgoingMessage()
and formatIncomingMessage()
, that will be called when a message is sent or received, respectively.
Both should return a LogMessage
object, which contains the message to log and the context.
The log level can be changed by setting the communications_log_level
key in config/protobuf-events.php
.
Testing
softonic/laravel-protobuf-events
has a PHPUnit test suite, and a coding style compliance test suite using PHP CS Fixer.
To run the tests, run the following command from the project folder.
$ make tests
To open a terminal in the dev environment:
$ make debug
License
The Apache 2.0 license. Please see LICENSE for more information.