[AiAssistance] Do not save partial responses to history

Previously, we were managing the history inside the agent
and was deciding what to add to history from the yielded results
in there.

This is changed in crrev.com/c/6239203 where it introduced
`Conversation` (for history feature) separate from the agent's
history and started saving all the yielded results to conversation
history, including the partial ones.

This CL updates AiAssistancePanel to save only complete
responses to conversation history.

Fixed: 396610180
Change-Id: I615156568336aac93346fcbcdec158b3c4d5ad9b
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6268783
Reviewed-by: Alex Rudenko <[email protected]>
Commit-Queue: Alex Rudenko <[email protected]>
Commit-Queue: Ergün Erdoğmuş <[email protected]>
Auto-Submit: Ergün Erdoğmuş <[email protected]>

Author: ergunsh

front_end/panels/ai_assistance/AiAssistancePanel.test.ts

@@ -557,6 +557,29 @@ describeWithMockConnection('AI Assistance Panel', () => {
         },
       ]);
     });
+
+    it('should not save partial responses to conversation history', async () => {
+      updateHostConfig({
+        devToolsFreestyler: {
+          enabled: true,
+        },
+      });
+      const addHistoryItemStub = sinon.stub(AiAssistance.Conversation.prototype, 'addHistoryItem');
+      UI.Context.Context.instance().setFlavor(
+          ElementsPanel.ElementsPanel.ElementsPanel,
+          sinon.createStubInstance(ElementsPanel.ElementsPanel.ElementsPanel));
+      const {view} = await createAiAssistancePanel({
+        aidaClient: mockAidaClient([[
+          {explanation: 'ANSWER: partially started'}, {explanation: 'ANSWER: partially started and now it\'s finished'}
+        ]])
+      });
+      // Trigger running the conversation (observe that there are two answers: one partial, one complete)
+      await view.lastCall.args[0].onTextSubmit('User question to Freestyler?');
+
+      sinon.assert.calledWith(
+          addHistoryItemStub, sinon.match({type: 'answer', text: 'partially started and now it\'s finished'}));
+      sinon.assert.neverCalledWith(addHistoryItemStub, sinon.match({type: 'answer', text: 'partially started'}));
+    });
   });
 
   it('should have empty state after clear chat', async () => {

front_end/panels/ai_assistance/AiAssistancePanel.ts

@@ -1004,7 +1004,10 @@ Output one filename per line and nothing else!
       #saveResponsesToCurrentConversation(items: AsyncIterable<ResponseData, void, void>):
           AsyncGenerator<ResponseData, void, void> {
     for await (const data of items) {
-      this.#currentConversation?.addHistoryItem(data);
+      // We don't want to save partial responses to the conversation history.
+      if (data.type !== ResponseType.ANSWER || data.complete) {
+        this.#currentConversation?.addHistoryItem(data);
+      }
       yield data;
     }
   }

front_end/panels/ai_assistance/agents/AiAgent.test.ts

@@ -231,11 +231,13 @@ describeWithEnvironment('AiAgent', () => {
           },
           {
             type: ResponseType.ANSWER,
+            complete: false,
             text: 'Partial ans',
           },
           {
             type: ResponseType.ANSWER,
             text: 'Partial answer is now completed',
+            complete: true,
             rpcId: undefined,
             suggestions: undefined,
           },

front_end/panels/ai_assistance/agents/AiAgent.ts

@@ -29,6 +29,8 @@ export const enum ErrorType {
 export interface AnswerResponse {
   type: ResponseType.ANSWER;
   text: string;
+  // Whether this is the complete answer or only a part of it (for streaming reasons)
+  complete: boolean;
   rpcId?: Host.AidaClient.RpcGlobalId;
   suggestions?: [string, ...string[]];
 }
@@ -398,6 +400,7 @@ export abstract class AiAgent<T> {
             yield {
               type: ResponseType.ANSWER,
               text: parsedResponse.answer,
+              complete: false,
             };
           }
         }
@@ -429,6 +432,7 @@ export abstract class AiAgent<T> {
           type: ResponseType.ANSWER,
           text: parsedResponse.answer,
           suggestions: parsedResponse.suggestions,
+          complete: true,
           rpcId,
         };
         break;

front_end/panels/ai_assistance/agents/FileAgent.test.ts

@@ -174,6 +174,7 @@ content
           {
             type: ResponseType.ANSWER,
             text: 'This is the answer',
+            complete: true,
             suggestions: undefined,
             rpcId: 123,
           },

front_end/panels/ai_assistance/agents/NetworkAgent.test.ts

@@ -188,6 +188,7 @@ describeWithMockConnection('NetworkAgent', () => {
         {
           type: ResponseType.ANSWER,
           text: 'This is the answer',
+          complete: true,
           suggestions: undefined,
           rpcId: 123,
         },

front_end/panels/ai_assistance/agents/PerformanceAgent.test.ts

@@ -174,6 +174,7 @@ self: 3
         {
           type: ResponseType.ANSWER,
           text: 'This is the answer',
+          complete: true,
           suggestions: undefined,
           rpcId: 123,
         },

front_end/panels/ai_assistance/agents/StylingAgent.test.ts

@@ -794,6 +794,7 @@ STOP`,
         {
           type: AiAssistance.ResponseType.ANSWER,
           text: 'this is the answer',
+          complete: true,
           suggestions: undefined,
           rpcId: undefined,
         },
@@ -904,6 +905,7 @@ STOP`,
         {
           type: AiAssistance.ResponseType.ANSWER,
           text: 'this is the answer',
+          complete: true,
           suggestions: undefined,
           rpcId: 123,
         },
@@ -914,10 +916,10 @@ STOP`,
       const agent = new StylingAgent({
         aidaClient: mockAidaClient([[
           {
-            explanation: 'ANSWER: this is the answer',
+            explanation: 'ANSWER: this is the partial answer',
           },
           {
-            explanation: 'ANSWER: this is another answer',
+            explanation: 'ANSWER: this is the partial answer and now it\'s complete',
             metadata: {
               attributionMetadata: {
                 attributionAction: Host.AidaClient.RecitationAction.BLOCK,
@@ -950,8 +952,9 @@ STOP`,
           type: AiAssistance.ResponseType.QUERYING,
         },
         {
-          text: 'this is the answer',
+          text: 'this is the partial answer',
           type: AiAssistance.ResponseType.ANSWER,
+          complete: false,
         },
         {
           type: AiAssistance.ResponseType.ERROR,
@@ -999,6 +1002,7 @@ STOP`,
         {
           type: AiAssistance.ResponseType.ANSWER,
           text: 'this is the answer',
+          complete: true,
           suggestions: undefined,
           rpcId: 123,
         },
@@ -1129,6 +1133,7 @@ STOP
         {
           type: AiAssistance.ResponseType.ANSWER,
           text: 'this is the actual answer',
+          complete: true,
           suggestions: undefined,
           rpcId: undefined,
         },