@coveo/quantic 3.33.0 → 3.33.2

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

@@ -0,0 +1,56 @@
+const exampleStreamId = crypto.randomUUID();
+const genQaMarkdownTextPayload = {
+  payloadType: 'genqa.messageType',
+  payload: JSON.stringify({
+    textDelta:
+      'THIS IS SOME LOREM IPSUM: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin accumsan felis vel nulla venenatis, vel volutpat mauris suscipit. Praesent aliquam, ex et dapibus fermentum, ligula metus condimentum nunc, non vehicula magna magna a nulla. Integer efficitur nunc eget semper facilisis. Quisque nec tortor at nunc blandit dictum sit amet vel mauris. Duis at tellus sit amet mi pharetra tincidunt. Nullam id risus eget risus accumsan molestie ac quis velit. Vivamus consectetur nisi vel enim finibus, nec laoreet risus facilisis. Integer a lacinia ligula. Etiam cursus urna nisi, ut tincidunt elit consectetur quis. Pellentesque nec sem vel neque malesuada euismod vitae nec augue. Suspendisse non ligula eu purus posuere dictum quis et magna. Curabitur dignissim, magna non feugiat consectetur, lorem orci fringilla sapien, sit amet vehicula eros nulla eget enim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin accumsan felis vel nulla venenatis, vel volutpat mauris suscipit. Praesent aliquam, ex et dapibus fermentum, ligula metus condimentum nunc, non vehicula magna magna a nulla. Integer efficitur nunc eget semper facilisis. Quisque nec tortor at nunc blandit dictum sit amet vel mauris. Duis at tellus sit amet mi pharetra tincidunt. Nullam id risus eget risus accumsan molestie ac quis velit. Vivamus consectetur nisi vel enim finibus, nec laoreet risus facilisis. Integer a lacinia ligula. Etiam cursus urna nisi, ut tincidunt elit consectetur quis. Pellentesque nec sem vel neque malesuada euismod vitae nec augue. Suspendisse non ligula eu purus posuere dictum quis et magna. Curabitur dignissim, magna non feugiat consectetur, lorem orci fringilla sapien, sit amet vehicula eros nulla eget enim.',
+  }),
+  finishReason: 'COMPLETED',
+};
+const genQaMarkdownTypePayload = {
+  payloadType: 'genqa.headerMessageType',
+  payload: JSON.stringify({
+    contentFormat: 'text/markdown',
+  }),
+};
+const genQaStreamEndPayload = {
+  payloadType: 'genqa.endOfStreamType',
+  payload: JSON.stringify({
+    answerGenerated: true,
+  }),
+};
+const exampleCitation = {
+  id: 'some-id-1',
+  title: 'Some Title 1',
+  uri: 'https://www.coveo.com',
+  permanentid: 'some-permanent-id-1',
+  clickUri: 'https://www.coveo.com',
+  text: 'example text 1',
+  source: 'Some source 1',
+};
+const exampleCitations = [exampleCitation];
+const genQaCitationPayload = {
+  payloadType: 'genqa.citationsType',
+  payload: JSON.stringify({
+    citations: exampleCitations,
+  }),
+};
+
+export type GenQaData = {
+  streamId: string;
+  streams: Array<{payloadType: string; payload: string; finishReason?: string}>;
+  citations: Array<Record<string, any>>;
+};
+
+const genQaData: GenQaData = {
+  streamId: exampleStreamId,
+  streams: [
+    genQaMarkdownTypePayload,
+    genQaMarkdownTextPayload,
+    genQaCitationPayload,
+    genQaStreamEndPayload,
+  ],
+  citations: exampleCitations,
+};
+
+export default genQaData;

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

@@ -0,0 +1,185 @@
+import {quanticBase} from '../../../../../../playwright/fixtures/baseFixture';
+import {SearchObject} from '../../../../../../playwright/page-object/searchObject';
+import {
+  searchRequestRegex,
+  insightSearchRequestRegex,
+  rgaGenerateRequestRegex,
+  insightRgaGenerateRequestRegex,
+} from '../../../../../../playwright/utils/requests';
+import {InsightSetupObject} from '../../../../../../playwright/page-object/insightSetupObject';
+import {useCaseEnum} from '../../../../../../playwright/utils/useCase';
+import {GeneratedAnswerObject} from './pageObject';
+import genQaData from './data';
+import type {GenQaData} from './data';
+import {AnalyticsModeEnum} from '../../../../../../playwright/utils/analyticsMode';
+import {BaseFacetObject} from '../../../../../../playwright/page-object/baseFacetObject';
+
+const MACHINE_LEARNING_API_URL = '**/machinelearning/streaming';
+const ANSWER_API_URL = '**/answer/v1/configs/**/generate';
+const ANSWER_API_INSIGHT_URL = '**/insight/v1/configs/**/answer/**/generate';
+
+const pageUrl = 's/quantic-generated-answer';
+
+interface GeneratedAnswerOptions {
+  fieldsToIncludeInCitations: string;
+  collapsible: boolean;
+  withToggle: boolean;
+  useCase: string;
+  answerConfigurationId: string;
+}
+
+type QuanticGeneratedAnswerE2ESearchFixtures = {
+  genQaData: GenQaData;
+  generatedAnswer: GeneratedAnswerObject;
+  search: SearchObject;
+  options: Partial<GeneratedAnswerOptions>;
+  withFacets: boolean;
+  baseFacet: BaseFacetObject;
+};
+
+type QuanticGeneratedAnswerE2EInsightFixtures =
+  QuanticGeneratedAnswerE2ESearchFixtures & {
+    insightSetup: InsightSetupObject;
+  };
+
+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,
+    },
+    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();
+
+      generatedAnswerObject.streamEndAnalyticRequestPromise =
+        generatedAnswerObject.waitForStreamEndAnalytics();
+      if (options.answerConfigurationId) {
+        generatedAnswerObject.generateRequestPromise =
+          generatedAnswerObject.waitForGenerateRequest();
+      }
+
+    await search.fillSearchInput(exampleQuery);
+    await search.mockSearchWithGenerativeQuestionAnsweringId(data.streamId);
+    await search.performSearch();
+    await search.waitForSearchResponse();
+
+    await use(generatedAnswerObject);
+  },
+});
+
+export const testInsight =
+  quanticBase.extend<QuanticGeneratedAnswerE2EInsightFixtures>({
+    pageUrl,
+    genQaData,
+    options: {},
+    analyticsMode: AnalyticsModeEnum.legacy,
+    withFacets: false,
+    search: async ({page}, use) => {
+      await use(new SearchObject(page, insightSearchRequestRegex));
+    },
+    baseFacet: async ({page}, use) => {
+      await use(new BaseFacetObject(page, insightSearchRequestRegex));
+    },
+    insightSetup: async ({page}, use) => {
+      await use(new InsightSetupObject(page));
+    },
+    generatedAnswer: async (
+      {
+        page,
+        options,
+        search,
+        configuration,
+        insightSetup,
+        genQaData: data,
+        analytics,
+        withFacets,
+      },
+      use
+    ) => {
+      const generatedAnswerObject = new GeneratedAnswerObject(
+        page,
+        data.streamId,
+        analytics,
+        !!options.answerConfigurationId,
+        insightRgaGenerateRequestRegex,
+        withFacets
+      );
+
+      const streamingUrl = options.answerConfigurationId
+        ? ANSWER_API_INSIGHT_URL
+        : `${MACHINE_LEARNING_API_URL}/${data.streamId}`;
+      await generatedAnswerObject.mockStreamResponse(
+        streamingUrl,
+        data.streams,
+        data.streamId
+      );
+
+      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();
+      }
+
+      await search.fillSearchInput(exampleQuery);
+      await search.performSearch();
+      await search.waitForSearchResponse();
+
+      await use(generatedAnswerObject);
+    },
+  });
+
+export {expect} from '@playwright/test';

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

@@ -0,0 +1,451 @@
+import type {Locator, Page, Request} from '@playwright/test';
+import {
+  AnalyticsMode,
+  AnalyticsModeEnum,
+} from '../../../../../../playwright/utils/analyticsMode';
+import {AnalyticsObject} from '../../../../../../playwright/page-object/analytics';
+import {isRgaEvaluationRequest} from '../../../../../../playwright/utils/requests';
+
+const minimumCitationTooltipDisplayDurationMs = 1500;
+const removeUnknownFields = (object: Record<string, unknown>) => {
+  return Object.fromEntries(
+    Object.entries(object).filter(([, value]) => value !== 'unknown')
+  );
+};
+
+const selectors = {
+  addFacetsButton: 'c-action-add-facets button',
+};
+
+const facetElementsSelectors = {
+  timeframeFacet: {
+    component: 'c-quantic-timeframe-facet',
+    facetValueComponent: 'c-quantic-facet-value',
+  },
+};
+
+export class GeneratedAnswerObject {
+  private analyticsMode: AnalyticsMode;
+
+  constructor(
+    private page: Page,
+    private streamId: string,
+    private analytics: AnalyticsObject,
+    private answerApiEnabled: boolean,
+    private generateRequestRegex: RegExp,
+    private withFacets: boolean
+  ) {
+    this.page = page;
+    this.streamId = streamId;
+    this.analytics = analytics;
+    this.analyticsMode = this.analytics.analyticsMode;
+    this.answerApiEnabled = answerApiEnabled;
+    this.generateRequestRegex = generateRequestRegex;
+    this.withFacets = withFacets;
+  }
+
+  get likeButton(): Locator {
+    return this.page.getByRole('button', {name: 'This answer was helpful'});
+  }
+
+  get dislikeButton(): Locator {
+    return this.page.getByRole('button', {name: 'This answer was not helpful'});
+  }
+
+  get copyToClipboardButton(): Locator {
+    return this.page.getByRole('button', {name: 'Copy'});
+  }
+
+  get toggleButton(): Locator {
+    return this.page.getByTestId('generated-answer__toggle-button');
+  }
+
+  get firstTimeframeFacet(): Locator {
+    return this.page
+      .locator(facetElementsSelectors.timeframeFacet.component)
+      .first();
+  }
+
+  get firstTimeframeFacetValue(): Promise<string | null> {
+    return this.firstTimeframeFacet
+      .locator(facetElementsSelectors.timeframeFacet.facetValueComponent)
+      .first()
+      .locator('.facet__value-text')
+      .textContent();
+  }
+
+  get addFacetsButton(): Locator {
+    return this.page.locator(selectors.addFacetsButton);
+  }
+
+  async clickAddFacetsButton(): Promise<void> {
+    await this.addFacetsButton.click();
+  }
+
+  async clickFirstTimeframeFacetLink(): Promise<void> {
+    await this.firstTimeframeFacet.click();
+  }
+
+  questionContainer(questionId: string): Locator {
+    return this.page.getByTestId(questionId);
+  }
+
+  answerOption(questionId: string, answerValue: string): Locator {
+    return this.questionContainer(questionId).locator('.slds-radio_button', {
+      hasText: new RegExp(`^${answerValue}$`),
+    });
+  }
+
+  get feedbackDocumentUrlInput(): Locator {
+    return this.page.locator(
+      '.feedback-modal-qna__body input[name="documentUrl"]'
+    );
+  }
+
+  get feedbackDetailsInput(): Locator {
+    return this.page
+      .locator('.feedback-modal-qna__body [data-name="details"]')
+      .getByRole('textbox');
+  }
+
+  get submitFeedbackButton(): Locator {
+    return this.page.getByRole('button', {name: /Send feedback/i});
+  }
+
+  get completeFeedbackButton(): Locator {
+    return this.page.getByRole('button', {name: /Done/i});
+  }
+
+  get citationLink(): Locator {
+    return this.page
+      .getByTestId('generated-answer__citations')
+      .locator('.citation__link');
+  }
+
+  get showMoreButton(): Locator {
+    return this.page.getByTestId('generated-answer__answer-toggle');
+  }
+
+  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);
+    await this.citationLink.nth(index).hover();
+    await this.page.waitForTimeout(minimumCitationTooltipDisplayDurationMs);
+    await this.page.mouse.move(0, 0);
+  }
+
+  async clickOnCitation(index: number): Promise<void> {
+    await this.citationLink.nth(index).click();
+  }
+
+  async typeInFeedbackDocumentUrlInput(text: string): Promise<void> {
+    await this.feedbackDocumentUrlInput.fill(text);
+  }
+
+  async typeInFeedbackDetailsInput(text: string): Promise<void> {
+    await this.feedbackDetailsInput.fill(text);
+  }
+
+  async clickSubmitFeedbackButton(): Promise<void> {
+    await this.submitFeedbackButton.click();
+  }
+
+  async clickCompleteFeedbackButton(): Promise<void> {
+    await this.completeFeedbackButton.click();
+  }
+
+  async fillFeedbackForm(answers: Record<string, string>): Promise<void> {
+    for (const [questionId, answerValue] of Object.entries(answers)) {
+      const option = this.answerOption(questionId, answerValue);
+      // eslint-disable-next-line no-await-in-loop
+      await option.click();
+    }
+  }
+
+  async clickLikeButton(): Promise<void> {
+    await this.likeButton.click();
+  }
+
+  async clickDislikeButton(): Promise<void> {
+    await this.dislikeButton.click();
+  }
+
+  async clickCopyToClipboardButton(): Promise<void> {
+    await this.copyToClipboardButton.click();
+  }
+
+  async clickToggleButton(): Promise<void> {
+    await this.toggleButton.click();
+  }
+
+  async waitForGenerateRequest(): Promise<Request> {
+    return this.page.waitForRequest(this.generateRequestRegex);
+  }
+
+  async waitForStreamEndAnalytics(): Promise<Request | boolean> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'generatedAnswerStreamEnd',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.AnswerReceived',
+      (event) => event.answerGenerated === true
+    );
+  }
+
+  async waitForLikeGeneratedAnswerAnalytics(): Promise<Request> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'likeGeneratedAnswer',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.AnswerAction',
+      (event) => event.action === 'like'
+    );
+  }
+
+  async waitForDislikeGeneratedAnswerAnalytics(): Promise<Request> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'dislikeGeneratedAnswer',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.AnswerAction',
+      (event) => event.action === 'dislike'
+    );
+  }
+
+  async waitForCopyToClipboardAnalytics(): Promise<Request> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'generatedAnswerCopyToClipboard',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.AnswerAction',
+      (event) => event.action === 'copyToClipboard'
+    );
+  }
+
+  async waitForShowAnswersAnalytics(): Promise<Request> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'generatedAnswerShowAnswers',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.AnswerAction',
+      (event) => event.action === 'show'
+    );
+  }
+
+  async waitForHideAnswersAnalytics(): Promise<Request> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'generatedAnswerHideAnswers',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.AnswerAction',
+      (event) => event.action === 'hide'
+    );
+  }
+
+  async waitForSourceHoverAnalytics(
+    expectedPayload: Record<string, any>
+  ): Promise<Request> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'generatedAnswerSourceHover',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId &&
+          Object.keys(expectedPayload).every(
+            (key) => event?.customData?.[key] === expectedPayload[key]
+          )
+      );
+    }
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.CitationHover',
+      (event) =>
+        event.citationId === expectedPayload.citationId &&
+        event.itemMetadata?.uniqueFieldName === 'permanentid' &&
+        event.itemMetadata?.uniqueFieldValue === expectedPayload.permanentId
+    );
+  }
+
+  async waitForEvaluationsRequest(
+    expectedPayload: Record<string, any>
+  ): Promise<Request> {
+    const payloadToMatch = removeUnknownFields(expectedPayload);
+
+    const evaluationRequest = this.page.waitForRequest((request) => {
+      const event = request.postDataJSON?.();
+      if (isRgaEvaluationRequest(request)) {
+        return AnalyticsObject.isMatchingPayload(
+          {
+            correctTopic: event.details?.correctTopic ? 'yes' : 'no',
+            readable: event.details?.readable ? 'yes' : 'no',
+            hallucinationFree: event.details?.hallucinationFree ? 'yes' : 'no',
+            documented: event.details?.documented ? 'yes' : 'no',
+            helpful: event.helpful,
+            details: event.additionalNotes,
+            documentUrl: event.correctAnswerUrl,
+          },
+          payloadToMatch
+        );
+      }
+      return false;
+    });
+    return evaluationRequest;
+  }
+
+  async waitForFeedbackSubmitRequest(
+    expectedPayload: Record<string, any>
+  ): Promise<Request> {
+    if (this.answerApiEnabled) {
+      return this.waitForEvaluationsRequest(expectedPayload);
+    }
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForCustomUaAnalytics(
+        {
+          eventType: 'generatedAnswer',
+          eventValue: 'generatedAnswerFeedbackSubmitV2',
+        },
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId &&
+          Object.keys(expectedPayload).every(
+            (key) => event?.customData?.[key] === expectedPayload[key]
+          )
+      );
+    }
+
+    const payloadToMatch = removeUnknownFields(expectedPayload);
+
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.SubmitFeedback',
+      (event) =>
+        AnalyticsObject.isMatchingPayload(
+          {
+            correctTopic: event.details?.correctTopic ? 'yes' : 'no',
+            readable: event.details?.readable ? 'yes' : 'no',
+            hallucinationFree: event.details?.hallucinationFree ? 'yes' : 'no',
+            documented: event.details?.documented ? 'yes' : 'no',
+            helpful: event.helpful,
+            details: event.additionalNotes,
+            documentUrl: event.correctAnswerUrl,
+          },
+          payloadToMatch
+        )
+    );
+  }
+
+  async waitForCitationClickAnalytics(
+    expectedPayload: Record<string, any>
+  ): Promise<Request> {
+    if (this.analyticsMode === AnalyticsModeEnum.legacy) {
+      return this.analytics.waitForClickUaAnalytics(
+        'generatedAnswerCitationClick',
+        (event) =>
+          event?.customData?.generativeQuestionAnsweringId === this.streamId &&
+          AnalyticsObject.isMatchingPayload(
+            {
+              documentTitle: event.documentTitle,
+              sourceName: event.sourceName,
+              documentPosition: event.documentPosition,
+              documentUri: event.documentUri,
+              documentUrl: event.documentUrl,
+              citationId: event.customData?.citationId,
+              contentIDKey: event.customData?.documentId?.contentIdKey,
+              contentIDValue: event.customData?.documentId?.contentIdValue,
+            },
+            expectedPayload
+          )
+      );
+    }
+    const payloadToMatch = {
+      citationId: expectedPayload.citationId,
+      uniqueFieldName: expectedPayload.contentIDKey,
+      uniqueFieldValue: expectedPayload.contentIDValue,
+      title: expectedPayload.documentTitle,
+      url: expectedPayload.documentUrl,
+    };
+    return this.analytics.waitForEventProtocolAnalytics(
+      'Rga.CitationClick',
+      (event) =>
+        AnalyticsObject.isMatchingPayload(
+          {
+            citationId: event.citationId,
+            uniqueFieldName: event.itemMetadata?.uniqueFieldName,
+            uniqueFieldValue: event.itemMetadata?.uniqueFieldValue,
+            title: event.itemMetadata?.title,
+            url: event.itemMetadata?.url,
+          },
+          payloadToMatch
+        )
+    );
+  }
+
+  async mockStreamResponse(
+    url: string,
+    body: Array<{payloadType: string; payload: string; finishReason?: string}>,
+    answerId?: string
+  ) {
+    await this.page.route(url, (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',
+          ...(answerId && {
+            'access-control-expose-headers': 'X-Answer-Id',
+            'x-answer-id': answerId,
+          }),
+        },
+      });
+    });
+  }
+
+  streamEndAnalyticRequestPromise!: Promise<boolean | Request>;
+  generateRequestPromise!: Promise<Request>;
+}