feature #350 Remove MessageBagInterface (chr-hertel)

OskarStark · OskarStark · commit 314b183901b9 · 2025-08-25T16:59:30.000+02:00
This PR was merged into the main branch. Discussion ---------- Remove MessageBagInterface | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | Docs? | no | Issues | | License | MIT The MessageBag was final for some time and the interface was needed to bring in more capabilities that users want to have on their end. The interface was quite heavy tho and changes would also be quite impactful - not saying adding a method to a class that gets extended is fun, but still less annoying from maintenance point of view - i hope 😬 Commits ------- d181fbe Remove MessageBagInterface
diff --git a/src/agent/src/Agent.php b/src/agent/src/Agent.php
@@ -17,7 +17,7 @@
 use Symfony\AI\Agent\Exception\MissingModelSupportException;
 use Symfony\AI\Agent\Exception\RuntimeException;
 use Symfony\AI\Platform\Capability;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\PlatformInterface;
 use Symfony\AI\Platform\Result\ResultInterface;
@@ -61,7 +61,7 @@ public function __construct(
      * @throws InvalidArgumentException     When the platform returns a client error (4xx) indicating invalid request parameters
      * @throws RuntimeException             When the platform returns a server error (5xx) or network failure occurs
      */
-    public function call(MessageBagInterface $messages, array $options = []): ResultInterface
+    public function call(MessageBag $messages, array $options = []): ResultInterface
     {
         $input = new Input($this->model, $messages, $options);
         array_map(fn (InputProcessorInterface $processor) => $processor->processInput($input), $this->inputProcessors);
diff --git a/src/agent/src/AgentInterface.php b/src/agent/src/AgentInterface.php
@@ -12,7 +12,7 @@
 namespace Symfony\AI\Agent;
 
 use Symfony\AI\Agent\Exception\ExceptionInterface;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Result\ResultInterface;
 
 /**
@@ -25,5 +25,5 @@ interface AgentInterface
      *
      * @throws ExceptionInterface When the agent encounters an error (e.g., unsupported model capabilities, invalid arguments, network failures, or processor errors)
      */
-    public function call(MessageBagInterface $messages, array $options = []): ResultInterface;
+    public function call(MessageBag $messages, array $options = []): ResultInterface;
 }
diff --git a/src/agent/src/Chat.php b/src/agent/src/Chat.php
@@ -14,7 +14,7 @@
 use Symfony\AI\Agent\Chat\MessageStoreInterface;
 use Symfony\AI\Platform\Message\AssistantMessage;
 use Symfony\AI\Platform\Message\Message;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Message\UserMessage;
 use Symfony\AI\Platform\Result\TextResult;
 
@@ -26,7 +26,7 @@ public function __construct(
     ) {
     }
 
-    public function initiate(MessageBagInterface $messages): void
+    public function initiate(MessageBag $messages): void
     {
         $this->store->clear();
         $this->store->save($messages);
diff --git a/src/agent/src/Chat/MessageStore/CacheStore.php b/src/agent/src/Chat/MessageStore/CacheStore.php
@@ -15,7 +15,6 @@
 use Symfony\AI\Agent\Chat\MessageStoreInterface;
 use Symfony\AI\Agent\Exception\RuntimeException;
 use Symfony\AI\Platform\Message\MessageBag;
-use Symfony\AI\Platform\Message\MessageBagInterface;
 
 final readonly class CacheStore implements MessageStoreInterface
 {
@@ -29,7 +28,7 @@ public function __construct(
         }
     }
 
-    public function save(MessageBagInterface $messages): void
+    public function save(MessageBag $messages): void
     {
         $item = $this->cache->getItem($this->cacheKey);
 
diff --git a/src/agent/src/Chat/MessageStore/InMemoryStore.php b/src/agent/src/Chat/MessageStore/InMemoryStore.php
@@ -13,18 +13,17 @@
 
 use Symfony\AI\Agent\Chat\MessageStoreInterface;
 use Symfony\AI\Platform\Message\MessageBag;
-use Symfony\AI\Platform\Message\MessageBagInterface;
 
 final class InMemoryStore implements MessageStoreInterface
 {
-    private MessageBagInterface $messages;
+    private MessageBag $messages;
 
-    public function save(MessageBagInterface $messages): void
+    public function save(MessageBag $messages): void
     {
         $this->messages = $messages;
     }
 
-    public function load(): MessageBagInterface
+    public function load(): MessageBag
     {
         return $this->messages ?? new MessageBag();
     }
diff --git a/src/agent/src/Chat/MessageStore/SessionStore.php b/src/agent/src/Chat/MessageStore/SessionStore.php
@@ -14,7 +14,6 @@
 use Symfony\AI\Agent\Chat\MessageStoreInterface;
 use Symfony\AI\Agent\Exception\RuntimeException;
 use Symfony\AI\Platform\Message\MessageBag;
-use Symfony\AI\Platform\Message\MessageBagInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 
@@ -32,12 +31,12 @@ public function __construct(
         $this->session = $requestStack->getSession();
     }
 
-    public function save(MessageBagInterface $messages): void
+    public function save(MessageBag $messages): void
     {
         $this->session->set($this->sessionKey, $messages);
     }
 
-    public function load(): MessageBagInterface
+    public function load(): MessageBag
     {
         return $this->session->get($this->sessionKey, new MessageBag());
     }
diff --git a/src/agent/src/Chat/MessageStoreInterface.php b/src/agent/src/Chat/MessageStoreInterface.php
@@ -11,13 +11,13 @@
 
 namespace Symfony\AI\Agent\Chat;
 
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 
 interface MessageStoreInterface
 {
-    public function save(MessageBagInterface $messages): void;
+    public function save(MessageBag $messages): void;
 
-    public function load(): MessageBagInterface;
+    public function load(): MessageBag;
 
     public function clear(): void;
 }
diff --git a/src/agent/src/ChatInterface.php b/src/agent/src/ChatInterface.php
@@ -13,12 +13,12 @@
 
 use Symfony\AI\Agent\Exception\ExceptionInterface;
 use Symfony\AI\Platform\Message\AssistantMessage;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Message\UserMessage;
 
 interface ChatInterface
 {
-    public function initiate(MessageBagInterface $messages): void;
+    public function initiate(MessageBag $messages): void;
 
     /**
      * @throws ExceptionInterface When the chat submission fails due to agent errors
diff --git a/src/agent/src/Input.php b/src/agent/src/Input.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\AI\Agent;
 
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Model;
 
 /**
@@ -24,7 +24,7 @@ final class Input
      */
     public function __construct(
         public Model $model,
-        public MessageBagInterface $messages,
+        public MessageBag $messages,
         private array $options,
     ) {
     }
diff --git a/src/agent/src/Output.php b/src/agent/src/Output.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\AI\Agent;
 
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Model;
 use Symfony\AI\Platform\Result\ResultInterface;
 
@@ -26,7 +26,7 @@ final class Output
     public function __construct(
         public readonly Model $model,
         public ResultInterface $result,
-        public readonly MessageBagInterface $messages,
+        public readonly MessageBag $messages,
         public readonly array $options,
     ) {
     }
diff --git a/src/agent/tests/ChatTest.php b/src/agent/tests/ChatTest.php
@@ -21,7 +21,6 @@
 use Symfony\AI\Platform\Message\AssistantMessage;
 use Symfony\AI\Platform\Message\Message;
 use Symfony\AI\Platform\Message\MessageBag;
-use Symfony\AI\Platform\Message\MessageBagInterface;
 use Symfony\AI\Platform\Result\TextResult;
 
 #[CoversClass(Chat::class)]
@@ -44,7 +43,7 @@ protected function setUp(): void
 
     public function testItInitiatesChatByClearingAndSavingMessages()
     {
-        $messages = $this->createMock(MessageBagInterface::class);
+        $messages = $this->createMock(MessageBag::class);
 
         $this->store->expects($this->once())
             ->method('clear');
@@ -70,7 +69,7 @@ public function testItSubmitsUserMessageAndReturnsAssistantMessage()
 
         $this->agent->expects($this->once())
             ->method('call')
-            ->with($this->callback(function (MessageBagInterface $messages) use ($userMessage) {
+            ->with($this->callback(function (MessageBag $messages) use ($userMessage) {
                 $messagesArray = $messages->getMessages();
 
                 return end($messagesArray) === $userMessage;
@@ -79,7 +78,7 @@ public function testItSubmitsUserMessageAndReturnsAssistantMessage()
 
         $this->store->expects($this->once())
             ->method('save')
-            ->with($this->callback(function (MessageBagInterface $messages) use ($userMessage, $assistantContent) {
+            ->with($this->callback(function (MessageBag $messages) use ($userMessage, $assistantContent) {
                 $messagesArray = $messages->getMessages();
                 $lastTwo = \array_slice($messagesArray, -2);
 
@@ -115,7 +114,7 @@ public function testItAppendsMessagesToExistingConversation()
 
         $this->agent->expects($this->once())
             ->method('call')
-            ->with($this->callback(function (MessageBagInterface $messages) {
+            ->with($this->callback(function (MessageBag $messages) {
                 $messagesArray = $messages->getMessages();
 
                 return 3 === \count($messagesArray);
@@ -124,7 +123,7 @@ public function testItAppendsMessagesToExistingConversation()
 
         $this->store->expects($this->once())
             ->method('save')
-            ->with($this->callback(function (MessageBagInterface $messages) {
+            ->with($this->callback(function (MessageBag $messages) {
                 $messagesArray = $messages->getMessages();
 
                 return 4 === \count($messagesArray);
@@ -150,7 +149,7 @@ public function testItHandlesEmptyMessageStore()
 
         $this->agent->expects($this->once())
             ->method('call')
-            ->with($this->callback(function (MessageBagInterface $messages) {
+            ->with($this->callback(function (MessageBag $messages) {
                 $messagesArray = $messages->getMessages();
 
                 return 1 === \count($messagesArray);
diff --git a/src/platform/src/Bridge/Anthropic/Contract/MessageBagNormalizer.php b/src/platform/src/Bridge/Anthropic/Contract/MessageBagNormalizer.php
@@ -14,7 +14,7 @@
 use Symfony\AI\Platform\Bridge\Anthropic\Claude;
 use Symfony\AI\Platform\Contract;
 use Symfony\AI\Platform\Contract\Normalizer\ModelContractNormalizer;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Model;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
@@ -27,7 +27,7 @@ final class MessageBagNormalizer extends ModelContractNormalizer implements Norm
     use NormalizerAwareTrait;
 
     /**
-     * @param MessageBagInterface $data
+     * @param MessageBag $data
      *
      * @return array{
      *     messages: array<string, mixed>,
@@ -54,7 +54,7 @@ public function normalize(mixed $data, ?string $format = null, array $context =
 
     protected function supportedDataClass(): string
     {
-        return MessageBagInterface::class;
+        return MessageBag::class;
     }
 
     protected function supportsModel(Model $model): bool
diff --git a/src/platform/src/Bridge/Bedrock/Nova/Contract/MessageBagNormalizer.php b/src/platform/src/Bridge/Bedrock/Nova/Contract/MessageBagNormalizer.php
@@ -13,7 +13,7 @@
 
 use Symfony\AI\Platform\Bridge\Bedrock\Nova\Nova;
 use Symfony\AI\Platform\Contract\Normalizer\ModelContractNormalizer;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Model;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
@@ -26,7 +26,7 @@ final class MessageBagNormalizer extends ModelContractNormalizer implements Norm
     use NormalizerAwareTrait;
 
     /**
-     * @param MessageBagInterface $data
+     * @param MessageBag $data
      *
      * @return array{
      *     messages: array<array<string, mixed>>,
@@ -48,7 +48,7 @@ public function normalize(mixed $data, ?string $format = null, array $context =
 
     protected function supportedDataClass(): string
     {
-        return MessageBagInterface::class;
+        return MessageBag::class;
     }
 
     protected function supportsModel(Model $model): bool
diff --git a/src/platform/src/Bridge/Gemini/Contract/MessageBagNormalizer.php b/src/platform/src/Bridge/Gemini/Contract/MessageBagNormalizer.php
@@ -13,7 +13,7 @@
 
 use Symfony\AI\Platform\Bridge\Gemini\Gemini;
 use Symfony\AI\Platform\Contract\Normalizer\ModelContractNormalizer;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Message\Role;
 use Symfony\AI\Platform\Model;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
@@ -27,7 +27,7 @@ final class MessageBagNormalizer extends ModelContractNormalizer implements Norm
     use NormalizerAwareTrait;
 
     /**
-     * @param MessageBagInterface $data
+     * @param MessageBag $data
      *
      * @return array{
      *      contents: list<array{
@@ -59,7 +59,7 @@ public function normalize(mixed $data, ?string $format = null, array $context =
 
     protected function supportedDataClass(): string
     {
-        return MessageBagInterface::class;
+        return MessageBag::class;
     }
 
     protected function supportsModel(Model $model): bool
diff --git a/src/platform/src/Bridge/HuggingFace/Contract/MessageBagNormalizer.php b/src/platform/src/Bridge/HuggingFace/Contract/MessageBagNormalizer.php
@@ -12,7 +12,7 @@
 namespace Symfony\AI\Platform\Bridge\HuggingFace\Contract;
 
 use Symfony\AI\Platform\Contract\Normalizer\ModelContractNormalizer;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Model;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
@@ -25,7 +25,7 @@ class MessageBagNormalizer extends ModelContractNormalizer implements Normalizer
     use NormalizerAwareTrait;
 
     /**
-     * @param MessageBagInterface $data
+     * @param MessageBag $data
      *
      * @return array{
      *     headers: array<'Content-Type', 'application/json'>,
@@ -44,7 +44,7 @@ public function normalize(mixed $data, ?string $format = null, array $context =
 
     protected function supportedDataClass(): string
     {
-        return MessageBagInterface::class;
+        return MessageBag::class;
     }
 
     protected function supportsModel(Model $model): bool
diff --git a/src/platform/src/Bridge/Meta/Contract/MessageBagNormalizer.php b/src/platform/src/Bridge/Meta/Contract/MessageBagNormalizer.php
@@ -14,7 +14,7 @@
 use Symfony\AI\Platform\Bridge\Meta\Llama;
 use Symfony\AI\Platform\Bridge\Meta\LlamaPromptConverter;
 use Symfony\AI\Platform\Contract\Normalizer\ModelContractNormalizer;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Model;
 
 /**
@@ -28,7 +28,7 @@ public function __construct(
     }
 
     /**
-     * @param MessageBagInterface $data
+     * @param MessageBag $data
      *
      * @return array{prompt: string}
      */
@@ -41,7 +41,7 @@ public function normalize(mixed $data, ?string $format = null, array $context =
 
     protected function supportedDataClass(): string
     {
-        return MessageBagInterface::class;
+        return MessageBag::class;
     }
 
     protected function supportsModel(Model $model): bool
diff --git a/src/platform/src/Bridge/Meta/LlamaPromptConverter.php b/src/platform/src/Bridge/Meta/LlamaPromptConverter.php
@@ -15,7 +15,7 @@
 use Symfony\AI\Platform\Message\AssistantMessage;
 use Symfony\AI\Platform\Message\Content\ImageUrl;
 use Symfony\AI\Platform\Message\Content\Text;
-use Symfony\AI\Platform\Message\MessageBagInterface;
+use Symfony\AI\Platform\Message\MessageBag;
 use Symfony\AI\Platform\Message\SystemMessage;
 use Symfony\AI\Platform\Message\UserMessage;
 
@@ -24,7 +24,7 @@
  */
 final class LlamaPromptConverter
 {
-    public function convertToPrompt(MessageBagInterface $messageBag): string
+    public function convertToPrompt(MessageBag $messageBag): string
     {
         $messages = [];
 
diff --git a/src/platform/src/Bridge/Replicate/Contract/LlamaMessageBagNormalizer.php b/src/platform/src/Bridge/Replicate/Contract/LlamaMessageBagNormalizer.php
diff --git a/src/platform/src/Contract/Normalizer/Message/MessageBagNormalizer.php b/src/platform/src/Contract/Normalizer/Message/MessageBagNormalizer.php
diff --git a/src/platform/src/Message/MessageBag.php b/src/platform/src/Message/MessageBag.php
diff --git a/src/platform/src/Message/MessageBagInterface.php b/src/platform/src/Message/MessageBagInterface.php
diff --git a/src/platform/tests/Bridge/Gemini/Contract/MessageBagNormalizerTest.php b/src/platform/tests/Bridge/Gemini/Contract/MessageBagNormalizerTest.php
diff --git a/src/platform/tests/Bridge/Mistral/TokenOutputProcessorTest.php b/src/platform/tests/Bridge/Mistral/TokenOutputProcessorTest.php
diff --git a/src/platform/tests/Bridge/OpenAi/TokenOutputProcessorTest.php b/src/platform/tests/Bridge/OpenAi/TokenOutputProcessorTest.php
diff --git a/src/platform/tests/Contract/Normalizer/Message/MessageBagNormalizerTest.php b/src/platform/tests/Contract/Normalizer/Message/MessageBagNormalizerTest.php

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`namespace Symfony\AI\Agent;`
`13`	`13`
`14`	`14`	`use Symfony\AI\Agent\Exception\ExceptionInterface;`
`15`		`-use Symfony\AI\Platform\Message\MessageBagInterface;`
	`15`	`+use Symfony\AI\Platform\Message\MessageBag;`
`16`	`16`	`use Symfony\AI\Platform\Result\ResultInterface;`
`17`	`17`
`18`	`18`	`/**`
`@@ -25,5 +25,5 @@ interface AgentInterface`
`25`	`25`	`*`
`26`	`26`	`* @throws ExceptionInterface When the agent encounters an error (e.g., unsupported model capabilities, invalid arguments, network failures, or processor errors)`
`27`	`27`	`*/`
`28`		`- public function call(MessageBagInterface $messages, array $options = []): ResultInterface;`
	`28`	`+ public function call(MessageBag $messages, array $options = []): ResultInterface;`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@`
`15`	`15`	`use Symfony\AI\Agent\Chat\MessageStoreInterface;`
`16`	`16`	`use Symfony\AI\Agent\Exception\RuntimeException;`
`17`	`17`	`use Symfony\AI\Platform\Message\MessageBag;`
`18`		`-use Symfony\AI\Platform\Message\MessageBagInterface;`
`19`	`18`
`20`	`19`	`final readonly class CacheStore implements MessageStoreInterface`
`21`	`20`	`{`
`@@ -29,7 +28,7 @@ public function __construct(`
`29`	`28`	`}`
`30`	`29`	`}`
`31`	`30`
`32`		`- public function save(MessageBagInterface $messages): void`
	`31`	`+ public function save(MessageBag $messages): void`
`33`	`32`	`{`
`34`	`33`	`$item = $this->cache->getItem($this->cacheKey);`
`35`	`34`
Original file line number	Diff line number	Diff line change
`@@ -13,18 +13,17 @@`
`13`	`13`
`14`	`14`	`use Symfony\AI\Agent\Chat\MessageStoreInterface;`
`15`	`15`	`use Symfony\AI\Platform\Message\MessageBag;`
`16`		`-use Symfony\AI\Platform\Message\MessageBagInterface;`
`17`	`16`
`18`	`17`	`final class InMemoryStore implements MessageStoreInterface`
`19`	`18`	`{`
`20`		`- private MessageBagInterface $messages;`
	`19`	`+ private MessageBag $messages;`
`21`	`20`
`22`		`- public function save(MessageBagInterface $messages): void`
	`21`	`+ public function save(MessageBag $messages): void`
`23`	`22`	`{`
`24`	`23`	`$this->messages = $messages;`
`25`	`24`	`}`
`26`	`25`
`27`		`- public function load(): MessageBagInterface`
	`26`	`+ public function load(): MessageBag`
`28`	`27`	`{`
`29`	`28`	`return $this->messages ?? new MessageBag();`
`30`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@`
`14`	`14`	`use Symfony\AI\Agent\Chat\MessageStoreInterface;`
`15`	`15`	`use Symfony\AI\Agent\Exception\RuntimeException;`
`16`	`16`	`use Symfony\AI\Platform\Message\MessageBag;`
`17`		`-use Symfony\AI\Platform\Message\MessageBagInterface;`
`18`	`17`	`use Symfony\Component\HttpFoundation\RequestStack;`
`19`	`18`	`use Symfony\Component\HttpFoundation\Session\SessionInterface;`
`20`	`19`
`@@ -32,12 +31,12 @@ public function __construct(`
`32`	`31`	`$this->session = $requestStack->getSession();`
`33`	`32`	`}`
`34`	`33`
`35`		`- public function save(MessageBagInterface $messages): void`
	`34`	`+ public function save(MessageBag $messages): void`
`36`	`35`	`{`
`37`	`36`	`$this->session->set($this->sessionKey, $messages);`
`38`	`37`	`}`
`39`	`38`
`40`		`- public function load(): MessageBagInterface`
	`39`	`+ public function load(): MessageBag`
`41`	`40`	`{`
`42`	`41`	`return $this->session->get($this->sessionKey, new MessageBag());`
`43`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,13 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\AI\Agent\Chat;`
`13`	`13`
`14`		`-use Symfony\AI\Platform\Message\MessageBagInterface;`
	`14`	`+use Symfony\AI\Platform\Message\MessageBag;`
`15`	`15`
`16`	`16`	`interface MessageStoreInterface`
`17`	`17`	`{`
`18`		`- public function save(MessageBagInterface $messages): void;`
	`18`	`+ public function save(MessageBag $messages): void;`
`19`	`19`
`20`		`- public function load(): MessageBagInterface;`
	`20`	`+ public function load(): MessageBag;`
`21`	`21`
`22`	`22`	`public function clear(): void;`
`23`	`23`	`}`