Use generated constants for message names (#300)

marein · web-flow · commit 4020a3dfc6a4 · 2025-12-08T21:55:42.000+01:00
Use generated constants for message names, and newly
created factories for message instantiation.

Additionally, make sure that entity manager gets always cleared.
diff --git a/assets/js/Chat/Widget.js b/assets/js/Chat/Widget.js
@@ -60,7 +60,7 @@ customElements.define('chat-widget', class extends HTMLElement {
         this._input.addEventListener('keypress', this._onKeyPress.bind(this));
 
         sse.subscribe(`chat-${chatId}`, {
-            'Chat.MessageWritten': this._onMessageWritten.bind(this)
+            'Chat.MessageWritten.v1': this._onMessageWritten.bind(this)
         }, this._sseAbortController.signal);
     }
 
diff --git a/composer.json b/composer.json
@@ -36,7 +36,7 @@
     "doctrine/doctrine-migrations-bundle": "^3.3",
     "doctrine/migrations": "^3.7",
     "doctrine/orm": "^3.0",
-    "gaming-platform/api": "^1.4",
+    "gaming-platform/api": "^1.5",
     "jms/serializer": "^3.17",
     "marein/php-nchan-client": "^3.1",
     "marein/symfony-lock-doctrine-migrations-bundle": "^1.0",
diff --git a/composer.lock b/composer.lock
diff --git a/config/chat/services/consumer.yml b/config/chat/services/consumer.yml
@@ -1,7 +1,9 @@
 services:
     chat.command-message-handler.topology:
         class: Gaming\Common\MessageBroker\Integration\AmqpLib\Topology\QueueTopology
-        arguments: ['Chat.CommandListener', 'gaming', ['Chat.InitiateChat']]
+        arguments: ['Chat.CommandListener', 'gaming', [
+            !php/const GamingPlatform\Api\Chat\V1\ChatV1::InitiateChatType
+        ]]
         tags: [{ name: 'gaming.message-broker.topology' }]
 
     chat.command-message-handler.consumer:
@@ -18,7 +20,9 @@ services:
 
     chat.publish-to-browser-message-handler.topology:
         class: Gaming\Common\MessageBroker\Integration\AmqpLib\Topology\QueueTopology
-        arguments: ['Chat.BrowserNotification', 'gaming', ['Chat.MessageWritten']]
+        arguments: ['Chat.BrowserNotification', 'gaming', [
+            !php/const GamingPlatform\Api\Chat\V1\ChatV1::MessageWrittenType
+        ]]
         tags: [{ name: 'gaming.message-broker.topology' }]
 
     chat.publish-to-browser-message-handler.consumer:
diff --git a/config/identity/services/command_bus.yml b/config/identity/services/command_bus.yml
@@ -19,5 +19,5 @@ services:
 
     identity.clear-manager-command-bus:
         class: Gaming\Common\Bus\Integration\DoctrineClearManagerBus
-        decorates: 'identity.query-bus'
+        decorates: 'identity.command-bus'
         arguments: ['@.inner', '@identity.doctrine-orm']
diff --git a/config/identity/services/consumer.yml b/config/identity/services/consumer.yml
@@ -1,7 +1,10 @@
 services:
     identity.bot-requests-message-handler.topology:
         class: Gaming\Common\MessageBroker\Integration\AmqpLib\Topology\QueueTopology
-        arguments: ['Identity.BotRequests', 'gaming', ['Identity.RegisterBot', 'Identity.GetBotByUsername']]
+        arguments: ['Identity.BotRequests', 'gaming', [
+            !php/const GamingPlatform\Api\Identity\V1\IdentityV1::RegisterBotType,
+            !php/const GamingPlatform\Api\Identity\V1\IdentityV1::GetBotByUsernameType
+        ]]
         tags: [{ name: 'gaming.message-broker.topology' }]
 
     identity.bot-requests-message-handler.consumer:
diff --git a/src/Chat/Infrastructure/Messaging/PublishDomainEventsToMessageBrokerSubscriber.php b/src/Chat/Infrastructure/Messaging/PublishDomainEventsToMessageBrokerSubscriber.php
@@ -10,6 +10,7 @@
 use Gaming\Common\EventStore\StoredEventSubscriber;
 use Gaming\Common\MessageBroker\Message;
 use Gaming\Common\MessageBroker\Publisher;
+use GamingPlatform\Api\Chat\V1\ChatV1;
 
 final class PublishDomainEventsToMessageBrokerSubscriber implements StoredEventSubscriber
 {
@@ -37,8 +38,8 @@ private function handleMessageWritten(MessageWritten $event): void
     {
         $this->publisher->send(
             new Message(
-                'Chat.MessageWritten',
-                (new \GamingPlatform\Api\Chat\V1\MessageWritten())
+                ChatV1::MessageWrittenType,
+                ChatV1::createMessageWritten()
                     ->setChatId($event->aggregateId())
                     ->setMessageId((string)$event->messageId())
                     ->setAuthorId($event->authorId())
diff --git a/src/Chat/Infrastructure/Messaging/PublishMessageBrokerEventsToBrowserMessageHandler.php b/src/Chat/Infrastructure/Messaging/PublishMessageBrokerEventsToBrowserMessageHandler.php
@@ -9,7 +9,7 @@
 use Gaming\Common\MessageBroker\Message;
 use Gaming\Common\MessageBroker\MessageHandler;
 use Gaming\Common\Usernames\Usernames;
-use GamingPlatform\Api\Chat\V1\ChatV1Factory;
+use GamingPlatform\Api\Chat\V1\ChatV1;
 
 final class PublishMessageBrokerEventsToBrowserMessageHandler implements MessageHandler
 {
@@ -22,14 +22,14 @@ public function __construct(
     public function handle(Message $message, Context $context): void
     {
         match ($message->name()) {
-            'Chat.MessageWritten' => $this->handleMessageWritten($message),
+            ChatV1::MessageWrittenType => $this->handleMessageWritten($message),
             default => true
         };
     }
 
     private function handleMessageWritten(Message $message): void
     {
-        $messageWritten = ChatV1Factory::createMessageWritten($message->body());
+        $messageWritten = ChatV1::createMessageWritten($message->body());
 
         $this->browserNotifier->publish(
             ['chat-' . $message->streamId()],
diff --git a/src/Chat/Presentation/Messaging/CommandMessageHandler.php b/src/Chat/Presentation/Messaging/CommandMessageHandler.php
@@ -9,8 +9,7 @@
 use Gaming\Common\MessageBroker\Context;
 use Gaming\Common\MessageBroker\Message;
 use Gaming\Common\MessageBroker\MessageHandler;
-use GamingPlatform\Api\Chat\V1\ChatV1Factory;
-use GamingPlatform\Api\Chat\V1\InitiateChatResponse;
+use GamingPlatform\Api\Chat\V1\ChatV1;
 
 final class CommandMessageHandler implements MessageHandler
 {
@@ -21,7 +20,7 @@ public function __construct(
 
     public function handle(Message $message, Context $context): void
     {
-        $request = ChatV1Factory::createInitiateChat($message->body());
+        $request = ChatV1::createInitiateChat($message->body());
 
         $chatId = $this->commandBus->handle(
             new InitiateChatCommand(
@@ -32,8 +31,8 @@ public function handle(Message $message, Context $context): void
 
         $context->reply(
             new Message(
-                'Chat.InitiateChatResponse',
-                (new InitiateChatResponse())
+                ChatV1::InitiateChatResponseType,
+                ChatV1::createInitiateChatResponse()
                     ->setChatId($chatId)
                     ->setCorrelationId($request->getCorrelationId())
                     ->serializeToString()
diff --git a/src/Common/Bus/Integration/DoctrineClearManagerBus.php b/src/Common/Bus/Integration/DoctrineClearManagerBus.php
@@ -18,10 +18,10 @@ public function __construct(
 
     public function handle(Request $request): mixed
     {
-        $response = $this->bus->handle($request);
-
-        $this->manager->clear();
-
-        return $response;
+        try {
+            return $this->bus->handle($request);
+        } finally {
+            $this->manager->clear();
+        }
     }
 }
diff --git a/src/Common/Domain/Integration/ReplyWithErrorResponseOnMessageFailedListener.php b/src/Common/Domain/Integration/ReplyWithErrorResponseOnMessageFailedListener.php
@@ -7,10 +7,9 @@
 use Gaming\Common\Domain\Exception\DomainException;
 use Gaming\Common\Domain\Exception\Violation;
 use Gaming\Common\Domain\Exception\ViolationParameter;
-use Gaming\Common\Domain\Exception\Violations;
 use Gaming\Common\MessageBroker\Event\MessageFailed;
 use Gaming\Common\MessageBroker\Message;
-use GamingPlatform\Api\Common\V1\ErrorResponse;
+use GamingPlatform\Api\Common\V1\CommonV1;
 
 final class ReplyWithErrorResponseOnMessageFailedListener
 {
@@ -22,41 +21,28 @@ public function messageFailed(MessageFailed $event): void
 
         $event->context->reply(
             new Message(
-                'Common.ErrorResponse',
-                new ErrorResponse()
-                    ->setViolations($this->mapViolations($event->throwable->violations))
+                CommonV1::ErrorResponseType,
+                CommonV1::createErrorResponse()
+                    ->setViolations(
+                        $event->throwable->violations->map(
+                            static fn(Violation $violation) => CommonV1::createErrorResponse_Violation()
+                                ->setPropertyPath($violation->propertyPath)
+                                ->setIdentifier($violation->identifier)
+                                ->setParameters(
+                                    array_map(
+                                        static fn(ViolationParameter $parameter) => CommonV1
+                                            ::createErrorResponse_Violation_Parameter()
+                                            ->setName($parameter->name)
+                                            ->setValue((string)$parameter->value),
+                                        $violation->parameters
+                                    )
+                                )
+                        )
+                    )
                     ->serializeToString()
             )
         );
 
         $event->stopPropagation();
     }
-
-    /**
-     * @return ErrorResponse\Violation[]
-     */
-    private function mapViolations(Violations $violations): array
-    {
-        return $violations->map(
-            fn(Violation $violation) => new ErrorResponse\Violation()
-                ->setPropertyPath($violation->propertyPath)
-                ->setIdentifier($violation->identifier)
-                ->setParameters($this->mapParameters($violation->parameters))
-        );
-    }
-
-    /**
-     * @param ViolationParameter[] $parameters
-     *
-     * @return ErrorResponse\Violation\Parameter[]
-     */
-    private function mapParameters(array $parameters): array
-    {
-        return array_map(
-            static fn(ViolationParameter $parameter) => new ErrorResponse\Violation\Parameter()
-                ->setName($parameter->name)
-                ->setValue((string)$parameter->value),
-            $parameters
-        );
-    }
 }
diff --git a/src/ConnectFour/Port/Adapter/Messaging/RefereeMessageHandler.php b/src/ConnectFour/Port/Adapter/Messaging/RefereeMessageHandler.php
@@ -9,8 +9,7 @@
 use Gaming\Common\MessageBroker\Message;
 use Gaming\Common\MessageBroker\MessageHandler;
 use Gaming\ConnectFour\Application\Game\Command\AssignChatCommand;
-use GamingPlatform\Api\Chat\V1\ChatV1Factory;
-use GamingPlatform\Api\Chat\V1\InitiateChat;
+use GamingPlatform\Api\Chat\V1\ChatV1;
 
 final class RefereeMessageHandler implements MessageHandler
 {
@@ -22,15 +21,15 @@ public function __construct(
     public function handle(Message $message, Context $context): void
     {
         match ($message->name()) {
-            'Chat.InitiateChatResponse' => $this->handleInitiateChatResponse($message),
+            ChatV1::InitiateChatResponseType => $this->handleInitiateChatResponse($message),
             'ConnectFour.PlayerJoined' => $this->handlePlayerJoined($message, $context),
             default => true
         };
     }
 
     private function handleInitiateChatResponse(Message $message): void
     {
-        $response = ChatV1Factory::createInitiateChatResponse($message->body());
+        $response = ChatV1::createInitiateChatResponse($message->body());
 
         $this->commandBus->handle(
             new AssignChatCommand(
@@ -46,8 +45,8 @@ private function handlePlayerJoined(Message $message, Context $context): void
 
         $context->request(
             new Message(
-                'Chat.InitiateChat',
-                (new InitiateChat())
+                ChatV1::InitiateChatType,
+                ChatV1::createInitiateChat()
                     ->setIdempotencyKey('connect-four.' . $payload['gameId'])
                     ->setCorrelationId($payload['gameId'])
                     ->setAuthors([])
diff --git a/src/Identity/Port/Adapter/Messaging/BotRequestsMessageHandler.php b/src/Identity/Port/Adapter/Messaging/BotRequestsMessageHandler.php
@@ -11,10 +11,8 @@
 use Gaming\Identity\Application\Bot\Command\RegisterBot\RegisterBot;
 use Gaming\Identity\Application\Bot\Query\Bot;
 use Gaming\Identity\Application\Bot\Query\GetBotByUsername\GetBotByUsername;
-use GamingPlatform\Api\Identity\V1\Bot as ProtoBot;
-use GamingPlatform\Api\Identity\V1\GetBotByUsernameResponse;
-use GamingPlatform\Api\Identity\V1\IdentityV1Factory;
-use GamingPlatform\Api\Identity\V1\RegisterBotResponse;
+use GamingPlatform\Api\Identity\V1\Bot as ProtoV1Bot;
+use GamingPlatform\Api\Identity\V1\IdentityV1;
 
 final class BotRequestsMessageHandler implements MessageHandler
 {
@@ -27,24 +25,24 @@ public function __construct(
     public function handle(Message $message, Context $context): void
     {
         match ($message->name()) {
-            'Identity.RegisterBot' => $this->handleRegisterBot($message, $context),
-            'Identity.GetBotByUsername' => $this->handleGetBotByUsername($message, $context),
+            IdentityV1::RegisterBotType => $this->handleRegisterBot($message, $context),
+            IdentityV1::GetBotByUsernameType => $this->handleGetBotByUsername($message, $context),
             default => true
         };
     }
 
     public function handleRegisterBot(Message $message, Context $context): void
     {
-        $request = IdentityV1Factory::createRegisterBot($message->body());
+        $request = IdentityV1::createRegisterBot($message->body());
 
         $response = $this->commandBus->handle(
             new RegisterBot($request->getUsername())
         );
 
         $context->reply(
             new Message(
-                'Identity.RegisterBotResponse',
-                new RegisterBotResponse()
+                IdentityV1::RegisterBotResponseType,
+                IdentityV1::createRegisterBotResponse()
                     ->setBotId($response->botId)
                     ->serializeToString()
             )
@@ -53,28 +51,28 @@ public function handleRegisterBot(Message $message, Context $context): void
 
     public function handleGetBotByUsername(Message $message, Context $context): void
     {
-        $request = IdentityV1Factory::createGetBotByUsername($message->body());
+        $request = IdentityV1::createGetBotByUsername($message->body());
 
         $response = $this->queryBus->handle(
             new GetBotByUsername($request->getUsername())
         );
 
         $context->reply(
             new Message(
-                'Identity.GetBotByUsernameResponse',
+                IdentityV1::GetBotByUsernameResponseType,
                 match ($response->bot) {
-                    null => new GetBotByUsernameResponse()->serializeToString(),
-                    default => new GetBotByUsernameResponse()
+                    null => IdentityV1::createGetBotByUsernameResponse()->serializeToString(),
+                    default => IdentityV1::createGetBotByUsernameResponse()
                         ->setBot($this->castBotToProtoBot($response->bot))
                         ->serializeToString()
                 }
             )
         );
     }
 
-    private function castBotToProtoBot(Bot $bot): ProtoBot
+    private function castBotToProtoBot(Bot $bot): ProtoV1Bot
     {
-        return new ProtoBot()
+        return IdentityV1::createBot()
             ->setBotId($bot->botId)
             ->setUsername($bot->username);
     }
diff --git a/src/Identity/Port/Adapter/Messaging/PublishDomainEventsToMessageBrokerSubscriber.php b/src/Identity/Port/Adapter/Messaging/PublishDomainEventsToMessageBrokerSubscriber.php

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ customElements.define('chat-widget', class extends HTMLElement {`
`60`	`60`	`this._input.addEventListener('keypress', this._onKeyPress.bind(this));`
`61`	`61`
`62`	`62`	sse.subscribe(`chat-${chatId}`, {
`63`		`- 'Chat.MessageWritten': this._onMessageWritten.bind(this)`
	`63`	`+ 'Chat.MessageWritten.v1': this._onMessageWritten.bind(this)`
`64`	`64`	`}, this._sseAbortController.signal);`
`65`	`65`	`}`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`use Gaming\Common\MessageBroker\Message;`
`10`	`10`	`use Gaming\Common\MessageBroker\MessageHandler;`
`11`	`11`	`use Gaming\Common\Usernames\Usernames;`
`12`		`-use GamingPlatform\Api\Chat\V1\ChatV1Factory;`
	`12`	`+use GamingPlatform\Api\Chat\V1\ChatV1;`
`13`	`13`
`14`	`14`	`final class PublishMessageBrokerEventsToBrowserMessageHandler implements MessageHandler`
`15`	`15`	`{`
`@@ -22,14 +22,14 @@ public function __construct(`
`22`	`22`	`public function handle(Message $message, Context $context): void`
`23`	`23`	`{`
`24`	`24`	`match ($message->name()) {`
`25`		`- 'Chat.MessageWritten' => $this->handleMessageWritten($message),`
	`25`	`+ ChatV1::MessageWrittenType => $this->handleMessageWritten($message),`
`26`	`26`	`default => true`
`27`	`27`	`};`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`private function handleMessageWritten(Message $message): void`
`31`	`31`	`{`
`32`		`- $messageWritten = ChatV1Factory::createMessageWritten($message->body());`
	`32`	`+ $messageWritten = ChatV1::createMessageWritten($message->body());`
`33`	`33`
`34`	`34`	`$this->browserNotifier->publish(`
`35`	`35`	`['chat-' . $message->streamId()],`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,10 @@ public function __construct(`
`18`	`18`
`19`	`19`	`public function handle(Request $request): mixed`
`20`	`20`	`{`
`21`		`- $response = $this->bus->handle($request);`
`22`		`-`
`23`		`- $this->manager->clear();`
`24`		`-`
`25`		`- return $response;`
	`21`	`+ try {`
	`22`	`+ return $this->bus->handle($request);`
	`23`	`+ } finally {`
	`24`	`+ $this->manager->clear();`
	`25`	`+ }`
`26`	`26`	`}`
`27`	`27`	`}`