Fix ImageGeneratingChatClient duplicating preceding content and dropping following content (#7622)

* Initial plan

* Fix ReplaceImageGenerationFunctionResults to use forward iteration; add regression tests

* Fix comment

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: David Cantú <dacantu@microsoft.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 3 people

src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ImageGeneratingChatClient.cs

@@ -319,16 +319,16 @@ public IList<AIContent> ReplaceImageGenerationFunctionResults(IList<AIContent> c
         {
             List<AIContent>? newContents = null;
 
-            // Replace FunctionResultContent instances with generated image content
-            for (int i = contents.Count - 1; i >= 0; i--)
+            // Replace image-generation FunctionCallContent with ImageGenerationToolCallContent, and FunctionResultContent with generated image content
+            for (int i = 0; i < contents.Count; i++)
             {
                 var content = contents[i];
 
                 // We must lookup by name because in the streaming case we have not yet been called to record the CallId.
                 if (content is FunctionCallContent functionCall &&
                     _toolNames.Contains(functionCall.Name))
                 {
-                    // create a new list and omit the FunctionCallContent
+                    // create a new list copying all items before this one, and omit the FunctionCallContent
                     newContents ??= CopyList(contents, i);
 
                     if (functionCall.Name != nameof(GetImagesForEdit))
@@ -339,6 +339,7 @@ public IList<AIContent> ReplaceImageGenerationFunctionResults(IList<AIContent> c
                 else if (content is FunctionResultContent functionResult &&
                     _imageContentByCallId.TryGetValue(functionResult.CallId, out var imageContents))
                 {
+                    // create a new list copying all items before this one
                     newContents ??= CopyList(contents, i);
 
                     if (imageContents.Any())

test/Libraries/Microsoft.Extensions.AI.Tests/ChatCompletion/ImageGeneratingChatClientTests.cs

@@ -383,4 +383,152 @@ async IAsyncEnumerable<ChatResponseUpdate> GetUpdatesAsync()
         var imageToolCallContent = Assert.IsType<ImageGenerationToolCallContent>(update.Contents[0]);
         Assert.Equal(callId, imageToolCallContent.CallId);
     }
+
+    [Theory]
+    [InlineData("at-start")]
+    [InlineData("in-middle")]
+    [InlineData("at-end")]
+    public async Task GetResponseAsync_FunctionCallContent_SurroundingContentPreservedInOrder(string position)
+    {
+        // Regression test for: image generation content duplicating preceding content and dropping following content.
+        // The image-generation FunctionCallContent should be replaced with ImageGenerationToolCallContent,
+        // while all other content items retain their original order and cardinality.
+        var imageCallId = "image-call-id";
+        var otherCallId = "other-call-id";
+
+        using var innerClient = new TestChatClient
+        {
+            GetResponseAsyncCallback = (messages, options, cancellationToken) =>
+            {
+                IList<AIContent> contents = position switch
+                {
+                    "at-start" => [new FunctionCallContent(imageCallId, "GenerateImage", new Dictionary<string, object?> { ["prompt"] = "a cat" }),
+                                   new FunctionResultContent(otherCallId, "other-result")],
+                    "at-end" => [new FunctionResultContent(otherCallId, "other-result"),
+                                 new FunctionCallContent(imageCallId, "GenerateImage", new Dictionary<string, object?> { ["prompt"] = "a cat" })],
+                    _ => [new FunctionResultContent(otherCallId, "before-result"),
+                          new FunctionCallContent(imageCallId, "GenerateImage", new Dictionary<string, object?> { ["prompt"] = "a cat" }),
+                          new UsageContent(new UsageDetails { InputTokenCount = 5 })],
+                };
+                return Task.FromResult(new ChatResponse(new ChatMessage(ChatRole.Assistant, contents)));
+            },
+        };
+
+        using var imageGenerator = new TestImageGenerator();
+        using var client = new ImageGeneratingChatClient(innerClient, imageGenerator);
+
+        var chatOptions = new ChatOptions
+        {
+            Tools = [new HostedImageGenerationTool()]
+        };
+
+        // Act
+        var response = await client.GetResponseAsync([new(ChatRole.User, "test")], chatOptions);
+
+        // Assert
+        Assert.NotNull(response);
+        Assert.Single(response.Messages);
+        var contents = response.Messages[0].Contents;
+
+        if (position == "at-start")
+        {
+            Assert.Equal(2, contents.Count);
+            Assert.IsType<ImageGenerationToolCallContent>(contents[0]);
+            var otherResult = Assert.IsType<FunctionResultContent>(contents[1]);
+            Assert.Equal(otherCallId, otherResult.CallId);
+        }
+        else if (position == "at-end")
+        {
+            Assert.Equal(2, contents.Count);
+            var otherResult = Assert.IsType<FunctionResultContent>(contents[0]);
+            Assert.Equal(otherCallId, otherResult.CallId);
+            Assert.IsType<ImageGenerationToolCallContent>(contents[1]);
+        }
+        else
+        {
+            Assert.Equal(3, contents.Count);
+            var beforeResult = Assert.IsType<FunctionResultContent>(contents[0]);
+            Assert.Equal(otherCallId, beforeResult.CallId);
+            Assert.IsType<ImageGenerationToolCallContent>(contents[1]);
+            var usageContent = Assert.IsType<UsageContent>(contents[2]);
+            Assert.Equal(5, usageContent.Details.InputTokenCount);
+        }
+    }
+
+    [Theory]
+    [InlineData("at-start")]
+    [InlineData("in-middle")]
+    [InlineData("at-end")]
+    public async Task GetStreamingResponseAsync_FunctionCallContent_SurroundingContentPreservedInOrder(string position)
+    {
+        // Regression test for: image generation content duplicating preceding content and dropping following content.
+        // The image-generation FunctionCallContent should be replaced with ImageGenerationToolCallContent,
+        // while all other content items retain their original order and cardinality.
+        var imageCallId = "image-call-id";
+        var otherCallId = "other-call-id";
+
+        using var innerClient = new TestChatClient
+        {
+            GetStreamingResponseAsyncCallback = (messages, options, cancellationToken) => GetUpdatesAsync()
+        };
+
+        async IAsyncEnumerable<ChatResponseUpdate> GetUpdatesAsync()
+        {
+            await Task.Yield();
+            IList<AIContent> contents = position switch
+            {
+                "at-start" => [new FunctionCallContent(imageCallId, "GenerateImage", new Dictionary<string, object?> { ["prompt"] = "a cat" }),
+                               new FunctionResultContent(otherCallId, "other-result")],
+                "at-end" => [new FunctionResultContent(otherCallId, "other-result"),
+                             new FunctionCallContent(imageCallId, "GenerateImage", new Dictionary<string, object?> { ["prompt"] = "a cat" })],
+                _ => [new FunctionResultContent(otherCallId, "before-result"),
+                      new FunctionCallContent(imageCallId, "GenerateImage", new Dictionary<string, object?> { ["prompt"] = "a cat" }),
+                      new UsageContent(new UsageDetails { InputTokenCount = 5 })],
+            };
+            yield return new ChatResponseUpdate(ChatRole.Assistant, contents);
+        }
+
+        using var imageGenerator = new TestImageGenerator();
+        using var client = new ImageGeneratingChatClient(innerClient, imageGenerator);
+
+        var chatOptions = new ChatOptions
+        {
+            Tools = [new HostedImageGenerationTool()]
+        };
+
+        // Act
+        var updates = new List<ChatResponseUpdate>();
+        await foreach (var update in client.GetStreamingResponseAsync([new(ChatRole.User, "test")], chatOptions))
+        {
+            updates.Add(update);
+        }
+
+        // Assert
+        Assert.Single(updates);
+        var contents = updates[0].Contents;
+
+        if (position == "at-start")
+        {
+            Assert.Equal(2, contents.Count);
+            Assert.IsType<ImageGenerationToolCallContent>(contents[0]);
+            var otherResult = Assert.IsType<FunctionResultContent>(contents[1]);
+            Assert.Equal(otherCallId, otherResult.CallId);
+        }
+        else if (position == "at-end")
+        {
+            Assert.Equal(2, contents.Count);
+            var otherResult = Assert.IsType<FunctionResultContent>(contents[0]);
+            Assert.Equal(otherCallId, otherResult.CallId);
+            Assert.IsType<ImageGenerationToolCallContent>(contents[1]);
+        }
+        else
+        {
+            Assert.Equal(3, contents.Count);
+            var beforeResult = Assert.IsType<FunctionResultContent>(contents[0]);
+            Assert.Equal(otherCallId, beforeResult.CallId);
+            Assert.IsType<ImageGenerationToolCallContent>(contents[1]);
+            var usageContent = Assert.IsType<UsageContent>(contents[2]);
+            Assert.Equal(5, usageContent.Details.InputTokenCount);
+        }
+    }
 }