@coveo/quantic 3.42.1 → 3.43.1

package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/fixture.ts

@@ -44,70 +44,77 @@ type QuanticGeneratedAnswerE2EInsightFixtures =
 
 export const exampleQuery = 'test';
 
-export const testSearch = quanticBase.extend<QuanticGeneratedAnswerE2ESearchFixtures>({
-  pageUrl,
-  genQaData,
-  options: {},
-  analyticsMode: AnalyticsModeEnum.legacy,
-  withFacets: false,
-  search: async ({page}, use) => {
-    await use(new SearchObject(page, searchRequestRegex));
-  },
-  baseFacet: async ({page}, use) => {
-    await use(new BaseFacetObject(page, searchRequestRegex));
-  },
-  generatedAnswer: async (
-    {
-      page,
-      options,
-      configuration,
-      search,
-      genQaData: data,
-      analytics,
-      withFacets,
+export const testSearch =
+  quanticBase.extend<QuanticGeneratedAnswerE2ESearchFixtures>({
+    pageUrl,
+    genQaData,
+    options: {},
+    analyticsMode: AnalyticsModeEnum.legacy,
+    withFacets: false,
+    search: async ({page}, use) => {
+      await use(new SearchObject(page, searchRequestRegex));
     },
-    use
-  ) => {
-    const generatedAnswerObject = new GeneratedAnswerObject(
-      page,
-      data.streamId,
-      analytics,
-      !!options.answerConfigurationId,
-      rgaGenerateRequestRegex,
-      withFacets,
-    );
-
-    const streamingUrl = options.answerConfigurationId
-      ? ANSWER_API_URL
-      : `${MACHINE_LEARNING_API_URL}/${data.streamId}`;
-    await generatedAnswerObject.mockStreamResponse(
-      streamingUrl,
-      data.streams,
-      data.streamId
-    );
-
-    await page.goto(pageUrl);
-    if (withFacets) {
-      await generatedAnswerObject.clickAddFacetsButton();
-    }
-    await configuration.configure(options);
-    await search.waitForSearchResponse();
+    baseFacet: async ({page}, use) => {
+      await use(new BaseFacetObject(page, searchRequestRegex));
+    },
+    generatedAnswer: async (
+      {
+        page,
+        options,
+        configuration,
+        search,
+        genQaData: data,
+        analytics,
+        withFacets,
+      },
+      use
+    ) => {
+      const generatedAnswerObject = new GeneratedAnswerObject(
+        page,
+        data.streamId,
+        analytics,
+        {
+          answerApiEnabled: !!options.answerConfigurationId,
+          headAnswerRequestRegex: rgaGenerateRequestRegex,
+          withFacets,
+        }
+      );
+
+      const streamingUrl = options.answerConfigurationId
+        ? ANSWER_API_URL
+        : `${MACHINE_LEARNING_API_URL}/${data.streamId}`;
+      await generatedAnswerObject.mockStreamResponse(
+        streamingUrl,
+        data.streams,
+        data.streamId
+      );
+
+      await search.mockSearchWithBaseResponse();
+      await page.goto(pageUrl);
+      if (withFacets) {
+        await generatedAnswerObject.clickAddFacetsButton();
+      }
+      await configuration.configure(options);
+      await search.waitForSearchResponse();
 
       generatedAnswerObject.streamEndAnalyticRequestPromise =
         generatedAnswerObject.waitForStreamEndAnalytics();
+
       if (options.answerConfigurationId) {
         generatedAnswerObject.generateRequestPromise =
-          generatedAnswerObject.waitForGenerateRequest();
+          generatedAnswerObject.waitForHeadAnswerRequest();
       }
 
-    await search.fillSearchInput(exampleQuery);
-    await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
-    await search.performSearch();
-    await search.waitForSearchResponse();
+      await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
+      await search.fillSearchInput(exampleQuery);
+      await Promise.all([
+        search.waitForSearchResponse(),
+        search.performSearch(),
+      ]);
 
-    await use(generatedAnswerObject);
-  },
-});
+      await use(generatedAnswerObject);
+    },
+  });
 
 export const testInsight =
   quanticBase.extend<QuanticGeneratedAnswerE2EInsightFixtures>({
@@ -142,9 +149,11 @@ export const testInsight =
         page,
         data.streamId,
         analytics,
-        !!options.answerConfigurationId,
-        insightRgaGenerateRequestRegex,
-        withFacets
+        {
+          answerApiEnabled: !!options.answerConfigurationId,
+          headAnswerRequestRegex: insightRgaGenerateRequestRegex,
+          withFacets,
+        }
       );
 
       const streamingUrl = options.answerConfigurationId
@@ -156,27 +165,27 @@ export const testInsight =
         data.streamId
       );
 
+      await search.mockSearchWithBaseResponse();
       await page.goto(pageUrl);
       if (withFacets) {
         await generatedAnswerObject.clickAddFacetsButton();
       }
       configuration.configure({...options, useCase: useCaseEnum.insight});
-
       await insightSetup.waitForInsightInterfaceInitialization();
-      await search.performSearch();
-      await search.waitForSearchResponse();
 
-      await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
       generatedAnswerObject.streamEndAnalyticRequestPromise =
         generatedAnswerObject.waitForStreamEndAnalytics();
       if (options.answerConfigurationId) {
         generatedAnswerObject.generateRequestPromise =
-          generatedAnswerObject.waitForGenerateRequest();
+          generatedAnswerObject.waitForHeadAnswerRequest();
       }
 
+      await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
       await search.fillSearchInput(exampleQuery);
-      await search.performSearch();
-      await search.waitForSearchResponse();
+      await Promise.all([
+        search.waitForSearchResponse(),
+        search.performSearch(),
+      ]);
 
       await use(generatedAnswerObject);
     },

package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/pageObject.ts

@@ -5,6 +5,7 @@ import {
 } from '../../../../../../playwright/utils/analyticsMode';
 import {AnalyticsObject} from '../../../../../../playwright/page-object/analytics';
 import {isRgaEvaluationRequest} from '../../../../../../playwright/utils/requests';
+import type {AgentMessage} from './agentData';
 
 const minimumCitationTooltipDisplayDurationMs = 1500;
 const removeUnknownFields = (object: Record<string, unknown>) => {
@@ -24,32 +25,42 @@ const facetElementsSelectors = {
   },
 };
 
+export interface GeneratedAnswerObjectConfig {
+  answerApiEnabled?: boolean;
+  headAnswerRequestRegex?: RegExp;
+  agentFollowUpRequestRegex?: RegExp;
+  withFacets?: boolean;
+}
+
 export class GeneratedAnswerObject {
   private analyticsMode: AnalyticsMode;
+  private answerApiEnabled: boolean;
+  private headAnswerRequestRegex?: RegExp;
+  private agentFollowUpRequestRegex?: RegExp;
+  private withFacets: boolean;
 
   constructor(
     private page: Page,
     private streamId: string,
     private analytics: AnalyticsObject,
-    private answerApiEnabled: boolean,
-    private generateRequestRegex: RegExp,
-    private withFacets: boolean
+    config: GeneratedAnswerObjectConfig = {}
   ) {
     this.page = page;
     this.streamId = streamId;
     this.analytics = analytics;
     this.analyticsMode = this.analytics.analyticsMode;
-    this.answerApiEnabled = answerApiEnabled;
-    this.generateRequestRegex = generateRequestRegex;
-    this.withFacets = withFacets;
+    this.answerApiEnabled = config.answerApiEnabled ?? false;
+    this.headAnswerRequestRegex = config.headAnswerRequestRegex;
+    this.agentFollowUpRequestRegex = config.agentFollowUpRequestRegex;
+    this.withFacets = config.withFacets ?? false;
   }
 
   get likeButton(): Locator {
-    return this.page.getByRole('button', {name: 'This answer was helpful'});
+    return this.page.getByRole('button', {name: 'Like', exact: true});
   }
 
   get dislikeButton(): Locator {
-    return this.page.getByRole('button', {name: 'This answer was not helpful'});
+    return this.page.getByRole('button', {name: 'Dislike', exact: true});
   }
 
   get copyToClipboardButton(): Locator {
@@ -118,7 +129,7 @@ export class GeneratedAnswerObject {
 
   get citationLink(): Locator {
     return this.page
-      .getByTestId('generated-answer__citations')
+      .getByTestId('generated-answer-body__citations')
       .locator('.citation__link');
   }
 
@@ -126,9 +137,25 @@ export class GeneratedAnswerObject {
     return this.page.getByTestId('generated-answer__answer-toggle');
   }
 
+  get showPreviousAnswersButton(): Locator {
+    return this.page.getByTestId('show-previous-button');
+  }
+
+  get threadItems(): Locator {
+    return this.page.locator('c-quantic-thread-item');
+  }
+
+  get threadItemTitleButton(): Locator {
+    return this.threadItems.getByTestId('thread-item-title-button');
+  }
+
+  get generatedAnswerBody(): Locator {
+    return this.page.locator('c-quantic-generated-answer-body');
+  }
+
   async hoverOverCitation(index: number): Promise<void> {
-    // waiting 500ms to allow the component to render completely, cause any re-rendering abort the hover action.
-    await this.page.waitForTimeout(500);
+    // waiting 1000ms to allow the component to render completely, cause any re-rendering abort the hover action.
+    await this.page.waitForTimeout(1000);
     await this.citationLink.nth(index).hover();
     await this.page.waitForTimeout(minimumCitationTooltipDisplayDurationMs);
     await this.page.mouse.move(0, 0);
@@ -166,10 +193,18 @@ export class GeneratedAnswerObject {
     await this.likeButton.click();
   }
 
+  async clickNthLikeButton(answerIndex: number): Promise<void> {
+    await this.likeButton.nth(answerIndex).click();
+  }
+
   async clickDislikeButton(): Promise<void> {
     await this.dislikeButton.click();
   }
 
+  async clickNthDislikeButton(answerIndex: number): Promise<void> {
+    await this.dislikeButton.nth(answerIndex).click();
+  }
+
   async clickCopyToClipboardButton(): Promise<void> {
     await this.copyToClipboardButton.click();
   }
@@ -178,8 +213,26 @@ export class GeneratedAnswerObject {
     await this.toggleButton.click();
   }
 
-  async waitForGenerateRequest(): Promise<Request> {
-    return this.page.waitForRequest(this.generateRequestRegex);
+  async clickShowPreviousAnswersButton(): Promise<void> {
+    await this.showPreviousAnswersButton.click();
+  }
+
+  async clickNthThreadItem(index: number): Promise<void> {
+    await this.threadItemTitleButton.nth(index).click();
+  }
+
+  async waitForHeadAnswerRequest(): Promise<Request> {
+    if (!this.headAnswerRequestRegex) {
+      throw new Error('headAnswerRequestRegex is not configured');
+    }
+    return this.page.waitForRequest(this.headAnswerRequestRegex);
+  }
+
+  async waitForAgentFollowUpRequest(): Promise<Request> {
+    if (!this.agentFollowUpRequestRegex) {
+      throw new Error('agentFollowUpRequestRegex is not configured');
+    }
+    return this.page.waitForRequest(this.agentFollowUpRequestRegex);
   }
 
   async waitForStreamEndAnalytics(): Promise<Request | boolean> {
@@ -200,6 +253,12 @@ export class GeneratedAnswerObject {
   }
 
   async waitForLikeGeneratedAnswerAnalytics(): Promise<Request> {
+    return this.waitForLikeGeneratedAnswerAnalyticsForId(this.streamId);
+  }
+
+  async waitForLikeGeneratedAnswerAnalyticsForId(
+    answerId: string
+  ): Promise<Request> {
     if (this.analyticsMode === AnalyticsModeEnum.legacy) {
       return this.analytics.waitForCustomUaAnalytics(
         {
@@ -207,7 +266,7 @@ export class GeneratedAnswerObject {
           eventValue: 'likeGeneratedAnswer',
         },
         (event) =>
-          event?.customData?.generativeQuestionAnsweringId === this.streamId
+          event?.customData?.generativeQuestionAnsweringId === answerId
       );
     }
     return this.analytics.waitForEventProtocolAnalytics(
@@ -217,6 +276,12 @@ export class GeneratedAnswerObject {
   }
 
   async waitForDislikeGeneratedAnswerAnalytics(): Promise<Request> {
+    return this.waitForDislikeGeneratedAnswerAnalyticsForId(this.streamId);
+  }
+
+  async waitForDislikeGeneratedAnswerAnalyticsForId(
+    answerId: string
+  ): Promise<Request> {
     if (this.analyticsMode === AnalyticsModeEnum.legacy) {
       return this.analytics.waitForCustomUaAnalytics(
         {
@@ -224,7 +289,7 @@ export class GeneratedAnswerObject {
           eventValue: 'dislikeGeneratedAnswer',
         },
         (event) =>
-          event?.customData?.generativeQuestionAnsweringId === this.streamId
+          event?.customData?.generativeQuestionAnsweringId === answerId
       );
     }
     return this.analytics.waitForEventProtocolAnalytics(
@@ -446,6 +511,83 @@ export class GeneratedAnswerObject {
     });
   }
 
+  async mockAgentAnswerResponse(
+    body: Array<AgentMessage>
+  ) {
+    await this.page.route('**/agents/*/answer', (route) => {
+      let bodyText = '';
+      body.forEach((data) => {
+        bodyText += `data:${JSON.stringify(data)} \n\n`;
+      });
+      route.fulfill({
+        status: 200,
+        body: bodyText,
+        headers: {'content-type': 'text/event-stream'},
+      });
+    });
+  }
+
+  async mockAgentFollowUpResponse(
+    bodies: Array<Array<AgentMessage>>
+  ) {
+    let callCount = 0;
+    await this.page.route('**/agents/*/follow-up', (route) => {
+      // After all provided response bodies are used, keep returning the last one
+      // so any additional intercepted follow-up requests still receive a mocked stream.
+      const streams = bodies[Math.min(callCount, bodies.length - 1)];
+      callCount++;
+
+      let bodyText = '';
+      streams.forEach((data) => {
+        bodyText += `data:${JSON.stringify(data)} \n\n`;
+      });
+      route.fulfill({
+        status: 200,
+        body: bodyText,
+        headers: {'content-type': 'text/event-stream'},
+      });
+    });
+  }
+
+  get followUpInput(): Locator {
+    return this.page.locator(
+      'c-quantic-generated-answer-follow-up-input textarea'
+    );
+  }
+
+  get followUpSubmitButton(): Locator {
+    return this.page
+      .locator('c-quantic-generated-answer-follow-up-input')
+      .getByRole('button', {name: 'Submit follow-up'});
+  }
+
+  async typeFollowUpQuestion(question: string): Promise<void> {
+    await this.followUpInput.fill(question);
+  }
+
+  async submitFollowUp(): Promise<void> {
+    await this.followUpSubmitButton.click();
+  }
+
+  async waitForFollowUpStreamEndAnalytics(
+    followUpAnswerId: string
+  ): Promise<Request | boolean> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'generatedAnswerStreamEnd',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === followUpAnswerId
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.AnswerReceived',
+      (event) => event.answerGenerated === true
+    );
+  }
+
   streamEndAnalyticRequestPromise!: Promise<boolean | Request>;
   generateRequestPromise!: Promise<Request>;
 }

package/force-app/main/default/lwc/quanticGeneratedAnswer/e2e/quanticGeneratedAnswer.e2e.ts

@@ -14,10 +14,6 @@ useCaseTestCases.forEach((useCase) => {
   let test = fixtures[useCase.value];
 
   test.describe(`quantic generated answer ${useCase.label}`, () => {
-    test.use({
-      genQaData,
-    });
-
     analyticsModeTest.forEach((analytics) => {
       test.describe(analytics.label, () => {
         test.use({
@@ -309,7 +305,7 @@ useCaseTestCases.forEach((useCase) => {
                   await generatedAnswer.streamEndAnalyticRequestPromise;
 
                   const generateRequestPromise =
-                    generatedAnswer.waitForGenerateRequest();
+                    generatedAnswer.waitForHeadAnswerRequest();
 
                   const streamEndAnalyticRequestPromise =
                     generatedAnswer.waitForStreamEndAnalytics();