@coveo/quantic 3.44.0 → 3.44.2

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

@@ -1,333 +0,0 @@
-import {testSearch, testInsight, expect} from './fixture';
-import {useCaseTestCases} from '../../../../../../playwright/utils/useCase';
-import genQaData from './data';
-import {analyticsModeTest} from '../../../../../../playwright/utils/analyticsMode';
-
-const fixtures = {
-  search: testSearch,
-  insight: testInsight,
-};
-
-const exampleAnswerConfigurationId = 'fc581be0-6e61-4039-ab26-a3f2f52f308f';
-
-useCaseTestCases.forEach((useCase) => {
-  let test = fixtures[useCase.value];
-
-  test.describe(`quantic generated answer ${useCase.label}`, () => {
-    analyticsModeTest.forEach((analytics) => {
-      test.describe(analytics.label, () => {
-        test.use({
-          analyticsMode: analytics.mode,
-        });
-
-        const configurations = [
-          {
-            name: 'with answerConfigurationId',
-            options: {
-              answerConfigurationId: exampleAnswerConfigurationId,
-            },
-          },
-          {
-            name: 'without answerConfigurationId',
-            options: {},
-          },
-        ];
-
-        for (const config of configurations) {
-          test.describe(config.name, () => {
-            test.use({analyticsMode: analytics.mode, options: config.options});
-
-            test.describe('when the answer has been generated', () => {
-              test('should send a stream end analytics event', async ({
-                generatedAnswer,
-              }) => {
-                await generatedAnswer.streamEndAnalyticRequestPromise;
-              });
-
-              if (config.options.answerConfigurationId) {
-                test('should send searchboxSubmit as the action cause in the analytics payload of the generate request', async ({
-                  generatedAnswer,
-                }) => {
-                  await generatedAnswer.streamEndAnalyticRequestPromise;
-                  const generateRequest =
-                    await generatedAnswer.generateRequestPromise;
-                  const generateRequestBody = generateRequest.postDataJSON();
-                  expect(generateRequestBody.analytics.actionCause).toBe(
-                    'searchboxSubmit'
-                  );
-                });
-              }
-            });
-
-            test.describe('when providing positive feedback', () => {
-              test('should send positive feedback analytics containing all details', async ({
-                generatedAnswer,
-              }) => {
-                await generatedAnswer.streamEndAnalyticRequestPromise;
-                const likeAnalyticRequestPromise =
-                  generatedAnswer.waitForLikeGeneratedAnswerAnalytics();
-                await generatedAnswer.clickLikeButton();
-                await likeAnalyticRequestPromise;
-
-                const exampleDocumentUrl = 'https://www.coveo.com/';
-                const exampleDetails = 'example details...';
-                await generatedAnswer.fillFeedbackForm({
-                  correctTopic: 'Yes',
-                  hallucinationFree: 'Yes',
-                  documented: 'Not sure',
-                  readable: 'Yes',
-                });
-                await generatedAnswer.typeInFeedbackDocumentUrlInput(
-                  exampleDocumentUrl
-                );
-                await generatedAnswer.typeInFeedbackDetailsInput(
-                  exampleDetails
-                );
-
-                const feedbackRequestPromise =
-                  generatedAnswer.waitForFeedbackSubmitRequest({
-                    correctTopic: 'yes',
-                    hallucinationFree: 'yes',
-                    documented: 'unknown',
-                    readable: 'yes',
-                    documentUrl: exampleDocumentUrl,
-                    details: exampleDetails,
-                    helpful: true,
-                  });
-
-                await generatedAnswer.clickSubmitFeedbackButton();
-                await feedbackRequestPromise;
-              });
-
-              test('should keep sending RGA analytics events after submitting feedback', async ({
-                generatedAnswer,
-              }) => {
-                await generatedAnswer.streamEndAnalyticRequestPromise;
-                const likeAnalyticRequestPromise =
-                  generatedAnswer.waitForLikeGeneratedAnswerAnalytics();
-                await generatedAnswer.clickLikeButton();
-                await likeAnalyticRequestPromise;
-
-                const exampleDocumentUrl = 'https://www.coveo.com/';
-                const exampleDetails = 'example details...';
-                await generatedAnswer.fillFeedbackForm({
-                  correctTopic: 'Yes',
-                  hallucinationFree: 'Yes',
-                  documented: 'Not sure',
-                  readable: 'Yes',
-                });
-                await generatedAnswer.typeInFeedbackDocumentUrlInput(
-                  exampleDocumentUrl
-                );
-                await generatedAnswer.typeInFeedbackDetailsInput(
-                  exampleDetails
-                );
-
-                const feedbackRequestPromise =
-                  generatedAnswer.waitForFeedbackSubmitRequest({
-                    correctTopic: 'yes',
-                    hallucinationFree: 'yes',
-                    documented: 'unknown',
-                    readable: 'yes',
-                    documentUrl: exampleDocumentUrl,
-                    details: exampleDetails,
-                    helpful: true,
-                  });
-
-                await generatedAnswer.clickSubmitFeedbackButton();
-                await feedbackRequestPromise;
-
-                await generatedAnswer.clickCompleteFeedbackButton();
-
-                // Click the copy to clipboard button and ensure the analytic is sent.
-                const copyToClipboardAnalyticRequestPromise =
-                  generatedAnswer.waitForCopyToClipboardAnalytics();
-                await generatedAnswer.clickCopyToClipboardButton();
-                await copyToClipboardAnalyticRequestPromise;
-              });
-            });
-
-            test.describe('when providing negative feedback', () => {
-              test('should send negative feedback analytics containing all details', async ({
-                generatedAnswer,
-              }) => {
-                await generatedAnswer.streamEndAnalyticRequestPromise;
-                const dislikeAnalyticRequestPromise =
-                  generatedAnswer.waitForDislikeGeneratedAnswerAnalytics();
-                await generatedAnswer.clickDislikeButton();
-                await dislikeAnalyticRequestPromise;
-
-                const exampleDocumentUrl = 'https://www.coveo.com/';
-                const exampleDetails = 'example details...';
-                await generatedAnswer.fillFeedbackForm({
-                  correctTopic: 'No',
-                  hallucinationFree: 'Not sure',
-                  documented: 'No',
-                  readable: 'No',
-                });
-                await generatedAnswer.typeInFeedbackDocumentUrlInput(
-                  exampleDocumentUrl
-                );
-                await generatedAnswer.typeInFeedbackDetailsInput(
-                  exampleDetails
-                );
-
-                const feedbackRequestPromise =
-                  generatedAnswer.waitForFeedbackSubmitRequest({
-                    correctTopic: 'no',
-                    hallucinationFree: 'unknown',
-                    documented: 'no',
-                    readable: 'no',
-                    documentUrl: exampleDocumentUrl,
-                    details: exampleDetails,
-                    helpful: false,
-                  });
-                await generatedAnswer.clickSubmitFeedbackButton();
-                await feedbackRequestPromise;
-              });
-            });
-
-            test.describe('when copying the generated answer to clipboard', () => {
-              test('should send a copy to clipboard analytics event', async ({
-                generatedAnswer,
-              }) => {
-                await generatedAnswer.streamEndAnalyticRequestPromise;
-                const analyticRequestPromise =
-                  generatedAnswer.waitForCopyToClipboardAnalytics();
-                await generatedAnswer.clickCopyToClipboardButton();
-                await analyticRequestPromise;
-              });
-            });
-
-            test.describe('when the property withToggle is set to true', () => {
-              test.use({
-                options: {
-                  ...config.options,
-                  withToggle: true,
-                },
-              });
-
-              test('should allow toggling the generated OFF and ON and log analytics', async ({
-                generatedAnswer,
-              }) => {
-                await generatedAnswer.streamEndAnalyticRequestPromise;
-                const hideAnswerAnalyticRequestPromise =
-                  generatedAnswer.waitForHideAnswersAnalytics();
-                await generatedAnswer.clickToggleButton();
-                await hideAnswerAnalyticRequestPromise;
-
-                const showAnswerAnalyticRequestPromise =
-                  generatedAnswer.waitForShowAnswersAnalytics();
-                await generatedAnswer.clickToggleButton();
-                await showAnswerAnalyticRequestPromise;
-              });
-            });
-
-            test.describe('when interacting with citations', () => {
-              test.describe('when hovering over a citation', () => {
-                test('should log citation hover analytics', async ({
-                  generatedAnswer,
-                }) => {
-                  await generatedAnswer.streamEndAnalyticRequestPromise;
-                  const citationIndex = 0;
-                  const {id, permanentid} = genQaData.citations[citationIndex];
-                  const citationHoverAnalyticRequestPromise =
-                    generatedAnswer.waitForSourceHoverAnalytics({
-                      citationId: id,
-                      permanentId: permanentid,
-                    });
-
-                  await generatedAnswer.hoverOverCitation(citationIndex);
-                  await citationHoverAnalyticRequestPromise;
-                });
-              });
-
-              test.describe('when clicking on a citation', () => {
-                test('should log citation click analytics', async ({
-                  generatedAnswer,
-                }) => {
-                  await generatedAnswer.streamEndAnalyticRequestPromise;
-                  const citationIndex = 0;
-                  const {id, title, source, uri, clickUri, permanentid} =
-                    genQaData.citations[citationIndex];
-                  const citationClickAnalyticRequestPromise =
-                    generatedAnswer.waitForCitationClickAnalytics({
-                      documentTitle: title,
-                      sourceName: source,
-                      documentPosition: citationIndex + 1,
-                      documentUri: uri,
-                      documentUrl: clickUri,
-                      citationId: id,
-                      contentIDKey: 'permanentid',
-                      contentIDValue: permanentid,
-                    });
-                  await generatedAnswer.clickOnCitation(citationIndex);
-                  await citationClickAnalyticRequestPromise;
-                });
-              });
-            });
-
-            test.describe('when the answer is generated in a single shot and the answer exceeds the maximum height', () => {
-              test.use({
-                options: {
-                  ...config.options,
-                  collapsible: true,
-                },
-              });
-              test('should display the answer as collapsed', async ({
-                generatedAnswer,
-              }) => {
-                const expectedShowMoreLabel = 'Show more';
-                await generatedAnswer.streamEndAnalyticRequestPromise;
-
-                const showMoreButton = generatedAnswer.showMoreButton;
-                expect(showMoreButton).not.toBeNull();
-
-                const showMoreButtonLabel = await showMoreButton.textContent();
-                expect(showMoreButtonLabel).not.toBeNull();
-                expect(showMoreButtonLabel).toEqual(expectedShowMoreLabel);
-              });
-            });
-
-            if (config.options.answerConfigurationId) {
-              test.describe('when selecting a timeframe facet after the answer is generated', () => {
-                test.use({
-                  options: {
-                    ...config.options,
-                  },
-                  withFacets: true,
-                });
-
-                test('should trigger a new generate call to the answer API', async ({
-                  generatedAnswer,
-                  baseFacet,
-                }) => {
-                  await generatedAnswer.streamEndAnalyticRequestPromise;
-
-                  const generateRequestPromise =
-                    generatedAnswer.waitForHeadAnswerRequest();
-
-                  const streamEndAnalyticRequestPromise =
-                    generatedAnswer.waitForStreamEndAnalytics();
-
-                  const searchResponsePromise =
-                    baseFacet.waitForSearchResponse();
-
-                  await generatedAnswer.clickFirstTimeframeFacetLink();
-
-                  const generateRequest = await generateRequestPromise;
-                  const generateRequestBody = generateRequest.postDataJSON();
-                  expect(generateRequestBody.analytics.actionCause).toBe(
-                    'facetSelect'
-                  );
-                  await streamEndAnalyticRequestPromise;
-                  await searchResponsePromise;
-                });
-              });
-            }
-          });
-        }
-      });
-    });
-  });
-});

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

@@ -1,298 +0,0 @@
-import {testAgent, expect} from './fixture-agent';
-import agentData, {turnLimitErrorStream, genericErrorStream} from './agentData';
-import {
-  analyticsModeTest,
-  AnalyticsModeEnum,
-} from '../../../../../../playwright/utils/analyticsMode';
-
-const exampleAgentId = '5fd0b5ea-d368-488e-bdeb-f6221ec0fb98';
-
-analyticsModeTest.forEach((analytics) => {
-  testAgent.describe(`quantic generated answer - agent - ${analytics.label}`, () => {
-    testAgent.use({
-      analyticsMode: analytics.mode,
-      options: {agentId: exampleAgentId},
-      permissions: ['clipboard-read', 'clipboard-write'],
-    });
-
-    if (analytics.mode !== AnalyticsModeEnum.legacy) {
-      testAgent.fixme(true, 'Agent next analytics mode not yet implemented');
-      return;
-    }
-
-    testAgent(
-      'should handle multiple answer generation, feedback, clipboard, citation, and follow-up interactions',
-      async ({generatedAnswer, page}) => {
-        await testAgent.step(
-          'should send a stream end analytics event when the first answer is generated',
-          async () => {
-            await generatedAnswer.streamEndAnalyticRequestPromise;
-          }
-        );
-
-        await testAgent.step(
-          'should send like analytics event when liking the first answer',
-          async () => {
-            const likeAnalyticRequestPromise =
-              generatedAnswer.waitForLikeGeneratedAnswerAnalytics();
-            await generatedAnswer.clickLikeButton();
-            await likeAnalyticRequestPromise;
-          }
-        );
-
-        await testAgent.step(
-          'should send dislike analytics event when disliking the first answer',
-          async () => {
-            const dislikeAnalyticRequestPromise =
-              generatedAnswer.waitForDislikeGeneratedAnswerAnalytics();
-            await generatedAnswer.clickDislikeButton();
-            await dislikeAnalyticRequestPromise;
-          }
-        );
-
-        await testAgent.step(
-          'should send a copy to clipboard analytics event and update the clipboard with the first answer content',
-          async () => {
-            const analyticRequestPromise =
-              generatedAnswer.waitForCopyToClipboardAnalytics();
-            await generatedAnswer.clickCopyToClipboardButton();
-            await analyticRequestPromise;
-            
-            const clipboardContent = await page.evaluate(() =>
-              navigator.clipboard.readText()
-            );
-            expect(clipboardContent).toContain('Testing in Coveo');
-          }
-        );
-
-        await testAgent.step(
-          'should log citation hover analytics when hovering over a citation from the first answer',
-          async () => {
-            const citationIndex = 0;
-            const {id, permanentid} = agentData.citations[citationIndex];
-            const citationHoverAnalyticRequestPromise =
-              generatedAnswer.waitForSourceHoverAnalytics({
-                citationId: id,
-                permanentId: permanentid,
-              });
-
-            await generatedAnswer.hoverOverCitation(citationIndex);
-            await citationHoverAnalyticRequestPromise;
-          }
-        );
-
-        await testAgent.step(
-          'should log citation click analytics when clicking on a citation from the first answer',
-          async () => {
-            const citationIndex = 0;
-            const {id, title, source, uri, clickUri, permanentid} =
-              agentData.citations[citationIndex];
-            const citationClickAnalyticRequestPromise =
-              generatedAnswer.waitForCitationClickAnalytics({
-                documentTitle: title,
-                sourceName: source,
-                documentPosition: citationIndex + 1,
-                documentUri: uri,
-                documentUrl: clickUri,
-                citationId: id,
-                contentIDKey: 'permanentid',
-                contentIDValue: permanentid,
-              });
-            await generatedAnswer.clickOnCitation(citationIndex);
-            await citationClickAnalyticRequestPromise;
-          }
-        );
-
-        await testAgent.step(
-          'FIRST FOLLOW-UP: should send the follow-up request with the correct conversationId and conversationToken',
-          async () => {
-            const followUpRequestPromise =
-              generatedAnswer.waitForAgentFollowUpRequest();
-
-            await generatedAnswer.typeFollowUpQuestion('follow-up question');
-            await generatedAnswer.submitFollowUp();
-
-            const followUpRequest = await followUpRequestPromise;
-            const followUpRequestBody = followUpRequest.postDataJSON();
-            expect(followUpRequestBody.conversationId).toBe(
-              agentData.conversationId
-            );
-            expect(followUpRequestBody.conversationToken).toBe(
-              agentData.conversationToken
-            );
-          }
-        );
-
-        await testAgent.step(
-          'should send stream end analytics with the right answerId for the follow-up',
-          async () => {
-            const followUpStreamEndPromise =
-              generatedAnswer.waitForFollowUpStreamEndAnalytics(
-                agentData.answerId2
-              );
-            await followUpStreamEndPromise;
-          }
-        );
-
-        await testAgent.step(
-          'should send like analytics with the follow-up answerId when liking the first follow-up answer',
-          async () => {
-            const likeAnalyticRequestPromise =
-              generatedAnswer.waitForLikeGeneratedAnswerAnalyticsForId(
-                agentData.answerId2
-              );
-            // Should be the first like button, since the previous answers are collapsed and the follow-up answer is the only one visible.
-            await generatedAnswer.clickNthLikeButton(0);
-            await likeAnalyticRequestPromise;
-          }
-        );
-
-        await testAgent.step(
-          'SECOND FOLLOW-UP: should send the second follow-up request with the correct conversationId and conversationToken',
-          async () => {
-            const followUpRequestPromise =
-              generatedAnswer.waitForAgentFollowUpRequest();
-
-            await generatedAnswer.typeFollowUpQuestion(
-              'second follow-up question'
-            );
-            await generatedAnswer.submitFollowUp();
-
-            const followUpRequest = await followUpRequestPromise;
-            const followUpRequestBody = followUpRequest.postDataJSON();
-            expect(followUpRequestBody.conversationId).toBe(
-              agentData.conversationId
-            );
-            expect(followUpRequestBody.conversationToken).toBe(
-              agentData.conversationToken
-            );
-          }
-        );
-
-        await testAgent.step(
-          'should send stream end analytics with the right answerId for the second follow-up',
-          async () => {
-            const followUpStreamEndPromise =
-              generatedAnswer.waitForFollowUpStreamEndAnalytics(
-                agentData.answerId3
-              );
-            await followUpStreamEndPromise;
-          }
-        );
-
-        await testAgent.step(
-          'should send dislike analytics with the right answerId for the second follow-up when disliking the second follow-up answer',
-          async () => {
-            const dislikeAnalyticRequestPromise =
-              generatedAnswer.waitForDislikeGeneratedAnswerAnalyticsForId(
-                agentData.answerId3
-              );
-            // Should be the first dislike button, since the previous answers are collapsed and the second follow-up answer is the only one visible.
-            await generatedAnswer.clickNthDislikeButton(0);
-            await dislikeAnalyticRequestPromise;
-          }
-        );
-
-        await testAgent.step(
-          'should expand previous answers when clicking on the "Show previous answers" button',
-          async () => {
-            await generatedAnswer.clickShowPreviousAnswersButton();
-            await expect(generatedAnswer.threadItems).toHaveCount(3);
-          }
-        );
-
-        await testAgent.step(
-          'should expand the first answer when clicking on the toggle button of the first answer',
-          async () => {
-            await generatedAnswer.clickNthThreadItem(0);
-            await expect(generatedAnswer.generatedAnswerBody.nth(0)).toBeVisible();
-            await expect(generatedAnswer.generatedAnswerBody.nth(1)).not.toBeVisible();
-            await expect(generatedAnswer.generatedAnswerBody.nth(2)).toBeVisible();
-          }
-        );
-
-        await testAgent.step(
-          'should allow to like the first answer, sending the correct analytics and not affecting the other answers',
-          async () => {
-            const likeAnalyticRequestPromise =
-              generatedAnswer.waitForLikeGeneratedAnswerAnalyticsForId(
-                agentData.answerId1
-              );
-            await generatedAnswer.clickNthLikeButton(0);
-            await likeAnalyticRequestPromise;
-            await expect(generatedAnswer.likeButton.nth(0)).toHaveAttribute('aria-pressed', 'true');
-            await expect(generatedAnswer.dislikeButton.nth(0)).toHaveAttribute('aria-pressed', 'false');
-            // Only two answers are visible, so only 2 like/dislike buttons visible.
-            await expect(generatedAnswer.dislikeButton.nth(1)).toHaveAttribute('aria-pressed', 'true');
-            await expect(generatedAnswer.likeButton.nth(1)).toHaveAttribute('aria-pressed', 'false');
-          }
-        );
-      }
-    );
-  });
-});
-
-testAgent.describe('quantic generated answer - agent follow-up error handling', () => {
-  testAgent.use({
-    options: {agentId: exampleAgentId},
-  });
-
-  testAgent(
-    'should display a generic error message when the follow-up request fails due to a network error',
-    async ({generatedAnswer}) => {
-      await generatedAnswer.streamEndAnalyticRequestPromise;
-      await generatedAnswer.mockAgentFollowUpNetworkError();
-
-      await generatedAnswer.typeFollowUpQuestion('follow-up question');
-      await generatedAnswer.submitFollowUp();
-
-      await expect(generatedAnswer.threadItems).toHaveCount(2);
-
-      const errorMessage = generatedAnswer.threadItems
-        .last()
-        .getByTestId('generated-answer-body__error');
-      await expect(errorMessage).toBeVisible();
-      await expect(errorMessage).toContainText('Something went wrong.');
-    }
-  );
-
-  testAgent(
-    'should display a distinct turn-limit message when the follow-up SSE stream reports a turn-limit error',
-    async ({generatedAnswer}) => {
-      await generatedAnswer.streamEndAnalyticRequestPromise;
-      await generatedAnswer.mockAgentFollowUpResponse([turnLimitErrorStream]);
-
-      await generatedAnswer.typeFollowUpQuestion('follow-up question');
-      await generatedAnswer.submitFollowUp();
-
-      await expect(generatedAnswer.threadItems).toHaveCount(2);
-
-      const errorMessage = generatedAnswer.threadItems
-        .last()
-        .getByTestId('generated-answer-body__error');
-      await expect(errorMessage).toBeVisible();
-      await expect(errorMessage).toContainText(
-        'Conversation turn limit reached. Please start a new conversation.'
-      );
-    }
-  );
-
-  testAgent(
-    'should display a generic error message when the follow-up SSE stream reports a generic error',
-    async ({generatedAnswer}) => {
-      await generatedAnswer.streamEndAnalyticRequestPromise;
-      await generatedAnswer.mockAgentFollowUpResponse([genericErrorStream]);
-
-      await generatedAnswer.typeFollowUpQuestion('follow-up question');
-      await generatedAnswer.submitFollowUp();
-
-      await expect(generatedAnswer.threadItems).toHaveCount(2);
-
-      const errorMessage = generatedAnswer.threadItems
-        .last()
-        .getByTestId('generated-answer-body__error');
-      await expect(errorMessage).toBeVisible();
-      await expect(errorMessage).toContainText('Something went wrong.');
-    }
-  );
-});