@coveo/quantic 3.43.2 → 3.43.4

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

@@ -3,7 +3,7 @@ import {
   useCaseEnum,
   useCaseTestCases,
 } from '../../../../../../playwright/utils/useCase';
-import facetData from './data';
+import {initialFacetData, expandedFacetData, selectedFacetData} from './data';
 
 const fixtures = {
   search: testSearch,
@@ -14,12 +14,22 @@ useCaseTestCases.forEach((useCase) => {
   let test = fixtures[useCase.value];
   test.describe(`quantic facet ${useCase.label}`, () => {
     test.describe('when selecting and deselecting a facet value', () => {
+      test.use({
+        facetResponses: {
+          responses: [
+            [initialFacetData],
+            [selectedFacetData],
+            [initialFacetData],
+          ],
+        },
+      });
+
       test('should trigger a new search and log the corresponding UA analytics events', async ({
         baseFacet,
         facet,
       }) => {
         const selectedIndex = 0;
-        const {facetId, field, values} = facetData;
+        const {facetId, field, values} = initialFacetData;
         const facetSelectUaRequest = baseFacet.waitForFacetSelectUaAnalytics({
           facetId,
           facetField: field,
@@ -54,12 +64,22 @@ useCaseTestCases.forEach((useCase) => {
     });
 
     test.describe('when selecting a facet value and clicking the clear filter button', () => {
+      test.use({
+        facetResponses: {
+          responses: [
+            [initialFacetData],
+            [selectedFacetData],
+            [initialFacetData],
+          ],
+        },
+      });
+
       test('should trigger a new search and log the corresponding UA analytics events', async ({
         baseFacet,
         facet,
       }) => {
         const selectedIndex = 0;
-        const {facetId, field, values} = facetData;
+        const {facetId, field, values} = initialFacetData;
         const facetSelectUaRequest = baseFacet.waitForFacetSelectUaAnalytics({
           facetId,
           facetField: field,
@@ -92,11 +112,20 @@ useCaseTestCases.forEach((useCase) => {
     });
 
     test.describe('when expanding and collapsing facet values using Show More/Less buttons', () => {
+      test.use({
+        facetResponses: {
+          responses: [[initialFacetData], [expandedFacetData], [initialFacetData]],
+        },
+        options: {
+          numberOfValues: 2,
+        },
+      });
+
       test('should fetch additional facet values and send correct UA analytics', async ({
         baseFacet,
         facet,
       }) => {
-        const {facetId, field} = facetData;
+        const {facetId, field} = initialFacetData;
         const uaRequest = baseFacet.waitForShowMoreFacetResultsUaAnalytics({
           facetId,
           facetField: field,
@@ -137,9 +166,12 @@ useCaseTestCases.forEach((useCase) => {
       const facetValueIndex = 0;
 
       test.use({
+        facetResponses: {
+          responses: [[initialFacetData], [selectedFacetData]],
+        },
         options: {
           caption: exampleCaption,
-          value: facetData.values[facetValueIndex].value,
+          value: initialFacetData.values[facetValueIndex].value,
         },
       });
       test('should display the custom caption instead of the raw facet value', async ({
@@ -149,7 +181,7 @@ useCaseTestCases.forEach((useCase) => {
         expect(facet.facetValue.nth(facetValueIndex)).toHaveText(
           new RegExp(exampleCaption)
         );
-        const {facetId, field, values} = facetData;
+        const {facetId, field, values} = initialFacetData;
         const uaRequest = baseFacet.waitForFacetSelectUaAnalytics({
           facetId,
           facetField: field,
@@ -173,7 +205,7 @@ useCaseTestCases.forEach((useCase) => {
           baseFacet,
           facet,
         }) => {
-          const {field: expectedField} = facetData;
+          const {field: expectedField} = initialFacetData;
           const exampleQuery = 'test';
           const facetSearchResponsePromise =
             baseFacet.waitForFacetSearchResponse();
@@ -190,10 +222,12 @@ useCaseTestCases.forEach((useCase) => {
 
       test.describe('with a selected value in the URL', () => {
         const selectedIndex = 0;
-        const {field, values} = facetData;
+        const {field, values} = initialFacetData;
         test.use({
           urlHash: `f-${field}=${values[selectedIndex].value}`,
-          facetResponseMock: undefined,
+          facetResponses: {
+            responses: [],
+          },
         });
 
         test('should select the correct facet value', async ({facet}) => {

package/force-app/main/default/lwc/quanticFacet/quanticFacet.css

@@ -1,6 +1,6 @@
 @import 'c/quanticFacetStyles';
 
 .facet__search-results_more-matches{
-  color: #8e959d;
+  color: var(--slds-g-color-palette-neutral-60, #8e959d);
   font-size: var(--slds-g-font-scale-neg-1, 12px);
 }

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

@@ -0,0 +1,59 @@
+/**
+ * Facet response builder for the facet manager example page
+ * (`exampleQuanticFacetManager.html`), which registers three facets:
+ * a `language` facet, a `date` timeframe facet, and an `objecttype` facet.
+ */
+const facetManagerData = [
+  {
+    facetId: 'language',
+    field: 'language',
+    moreValuesAvailable: false,
+    values: [{value: 'English', state: 'idle', numberOfResults: 100}],
+    indexScore: 0.3,
+  },
+  {
+    facetId: 'date',
+    field: 'date',
+    moreValuesAvailable: false,
+    values: [
+      {
+        start: 'past-1-week',
+        end: 'now',
+        endInclusive: false,
+        state: 'idle',
+        numberOfResults: 10,
+      },
+      {
+        start: 'past-1-month',
+        end: 'now',
+        endInclusive: false,
+        state: 'idle',
+        numberOfResults: 20,
+      },
+      {
+        start: 'past-6-month',
+        end: 'now',
+        endInclusive: false,
+        state: 'idle',
+        numberOfResults: 30,
+      },
+      {
+        start: 'past-1-year',
+        end: 'now',
+        endInclusive: false,
+        state: 'idle',
+        numberOfResults: 40,
+      },
+    ],
+    indexScore: 0.2,
+  },
+  {
+    facetId: 'objecttype',
+    field: 'objecttype',
+    moreValuesAvailable: false,
+    values: [{value: 'People', state: 'idle', numberOfResults: 50}],
+    indexScore: 0.1,
+  },
+];
+
+export default facetManagerData;

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

@@ -1,12 +1,13 @@
 import {FacetManagerObject} from './pageObject';
-import {quanticBase} from '../../../../../../playwright/fixtures/baseFixture';
+import {facetBase} from '../../../../../../playwright/fixtures/baseFacetFixture';
 import {
   searchRequestRegex,
   insightSearchRequestRegex,
 } from '../../../../../../playwright/utils/requests';
 import {InsightSetupObject} from '../../../../../../playwright/page-object/insightSetupObject';
 import {useCaseEnum} from '../../../../../../playwright/utils/useCase';
-import {SearchObject} from '../../../../../../playwright/page-object/searchObject';
+import {BaseFacetObject} from '../../../../../../playwright/page-object/baseFacetObject';
+import facetManagerData from './data';
 
 const pageUrl = 's/quantic-facet-manager';
 
@@ -14,7 +15,6 @@ interface FacetManagerOptions {}
 
 type QuanticFacetManagerE2ESearchFixtures = {
   facetManager: FacetManagerObject;
-  search: SearchObject;
   options: Partial<FacetManagerOptions>;
 };
 
@@ -24,41 +24,52 @@ type QuanticFacetManagerE2EInsightFixtures =
   };
 
 export const testSearch =
-  quanticBase.extend<QuanticFacetManagerE2ESearchFixtures>({
+  facetBase.extend<QuanticFacetManagerE2ESearchFixtures>({
     options: {},
-    search: async ({page}, use) => {
-      await use(new SearchObject(page, searchRequestRegex));
+    facetResponses: {responses: [facetManagerData]},
+    baseFacet: async ({page}, use) => {
+      await use(new BaseFacetObject(page, searchRequestRegex));
     },
-    facetManager: async ({page, options, configuration, search}, use) => {
+    facetManager: async (
+      {page, options, configuration, baseFacet, facetResponses},
+      use
+    ) => {
+      await baseFacet.mockSearchWithFacetResponseSequence(
+        facetResponses?.responses
+      );
       await page.goto(pageUrl);
       configuration.configure(options);
-      await search.waitForSearchResponse();
+      await baseFacet.waitForSearchResponse();
 
       await use(new FacetManagerObject(page));
     },
   });
 
 export const testInsight =
-  quanticBase.extend<QuanticFacetManagerE2EInsightFixtures>({
+  facetBase.extend<QuanticFacetManagerE2EInsightFixtures>({
     options: {},
-    search: async ({page}, use) => {
-      await use(new SearchObject(page, insightSearchRequestRegex));
+    facetResponses: {responses: [facetManagerData]},
+    baseFacet: async ({page}, use) => {
+      await use(new BaseFacetObject(page, insightSearchRequestRegex));
     },
     insightSetup: async ({page}, use) => {
       await use(new InsightSetupObject(page));
     },
     facetManager: async (
-      {page, options, search, configuration, insightSetup},
+      {page, options, baseFacet, configuration, insightSetup, facetResponses},
       use
     ) => {
+      await baseFacet.mockSearchWithFacetResponseSequence(
+        facetResponses?.responses
+      );
       await page.goto(pageUrl);
       configuration.configure({...options, useCase: useCaseEnum.insight});
       await insightSetup.waitForInsightInterfaceInitialization();
-      const searchResponsePromise = search.waitForSearchResponse();
-      await search.performSearch();
+      const searchResponsePromise = baseFacet.waitForSearchResponse();
+      await baseFacet.performSearch();
       await searchResponsePromise;
       await use(new FacetManagerObject(page));
     },
   });
 
-export {expect} from '@playwright/test';
+export {expect} from '@playwright/test';

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

@@ -23,10 +23,10 @@ useCaseTestCases.forEach((useCase) => {
   test.describe(`quantic facet manager ${useCase.label}`, () => {
     test('should load facets in the same order as in the initial search response', async ({
       facetManager,
-      search,
+      baseFacet,
     }) => {
-      const searchResponsePromise = search.waitForSearchResponse();
-      await search.performSearch();
+      const searchResponsePromise = baseFacet.waitForSearchResponse();
+      await baseFacet.performSearch();
 
       const searchResponse = await searchResponsePromise;
       const {facets} = await searchResponse.json();
@@ -45,11 +45,11 @@ useCaseTestCases.forEach((useCase) => {
     test.describe('when the facets are reordered', () => {
       test('should load facets in the reordered order', async ({
         facetManager,
-        search,
+        baseFacet,
       }) => {
-        await search.mockSearchFacetOrder(exampleFacetsOrder);
-        const searchResponsePromise = search.waitForSearchResponse();
-        await search.performSearch();
+        await baseFacet.mockSearchFacetOrder(exampleFacetsOrder);
+        const searchResponsePromise = baseFacet.waitForSearchResponse();
+        await baseFacet.performSearch();
 
         const searchResponse = await searchResponsePromise;
         const {facets} = await searchResponse.json();

package/force-app/main/default/lwc/quanticFacetStyles/quanticFacetStyles.css

@@ -1,8 +1,8 @@
 .facet__search-results_no-match {
-  color: var(--lwc-colorTextLabel, #696969);
+  color: var(--slds-g-color-on-surface-1, var(--lwc-colorTextLabel, #696969));
   background-color: var(--slds-g-color-surface-2, #F6F7F9);
   font-size: var(--slds-g-font-scale-neg-1, 12px);
-  border-radius: 4px;
+  border-radius: var(--slds-g-radius-border-2, 4px);
 }
 
 fieldset {
@@ -11,16 +11,16 @@ fieldset {
 
 .facet__show-less {
   font-size: var(--slds-g-font-scale-neg-1, 12px);
-  background-color: white;
-  color: var(--lwc-colorTextPlaceholder, var(--lwc-colorTextIconDefault, #747474));
+  background-color: var(--slds-g-color-surface-1, white);
+  color: var(--slds-g-color-on-surface-1, var(--lwc-colorTextPlaceholder, var(--lwc-colorTextIconDefault, #747474)));
   border: none;
   margin-bottom: 5px;
 }
 
 .facet__show-more {
   font-size: var(--slds-g-font-scale-neg-1, 12px);
-  background-color: white;
-  color: var(--lwc-brandTextLink, dodgerblue);
+  background-color: var(--slds-g-color-surface-1, white);
+  color: var(--slds-s-link-color, var(--lwc-brandTextLink, dodgerblue));
   border: none;
 }
 
@@ -39,12 +39,12 @@ fieldset {
   display: flex;
   flex-direction: row;
   cursor: pointer;
-  border-radius: .25rem;
+  border-radius: var(--slds-g-radius-border-2, .25rem);
 }
 
 .facet__value-option:hover {
-  color: var(--lwc-brandTextLink, dodgerblue);
-  background-color: #f6f7f9;
+  color: var(--slds-s-link-color, var(--lwc-brandTextLink, dodgerblue));
+  background-color: var(--slds-g-color-surface-2, #f6f7f9);
 }
 
 .facet__clear-filter {
@@ -52,5 +52,5 @@ fieldset {
 }
 
 .facet__number-of-results {
-  color: var(--lwc-colorTextPlaceholder, var(--lwc-colorTextIconDefault, #747474));
+  color: var(--slds-g-color-on-surface-1, var(--lwc-colorTextPlaceholder, var(--lwc-colorTextIconDefault, #747474)));
 }

package/force-app/main/default/lwc/quanticFeedbackModalQna/templates/quanticFeedbackModalQna.css

@@ -15,6 +15,6 @@
         flex-direction: column;
     }
     .feedback-modal-qna__radio-group {
-        margin-top: 0.5rem;
+        margin-top: var(--slds-g-spacing-2, 0.5rem);
     }
 }

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

@@ -36,6 +36,7 @@ export const testSearch =
       await use(new SearchObject(page, searchRequestRegex));
     },
     resultList: async ({page, options, configuration, search}, use) => {
+      await search.mockSearchWithBaseResponse();
       await page.goto(pageUrl);
       configuration.configure(options);
       await search.waitForSearchResponse();
@@ -57,11 +58,14 @@ export const testInsight =
       {page, options, search, configuration, insightSetup},
       use
     ) => {
+      await search.mockSearchWithBaseResponse();
       await page.goto(pageUrl);
       configuration.configure({...options, useCase: useCaseEnum.insight});
       await insightSetup.waitForInsightInterfaceInitialization();
-      await search.performSearch();
-      await search.waitForSearchResponse();
+      await Promise.all([
+        search.waitForSearchResponse(),
+        search.performSearch(),
+      ]);
       await search.waitForSearchResultsVisible();
       await use(new FoldedResultListObject(page));
     },

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

@@ -66,6 +66,13 @@ type AgentCitationType = {
   };
 };
 
+type AgentRunErrorType = {
+  type: 'RUN_ERROR';
+  timestamp: number;
+  message: string;
+  code: string;
+};
+
 const STREAM_ID = 'conv_1';
 const ANSWER_ID_1 = 'conv_1_0001';
 const ANSWER_ID_2 = 'conv_1_0002';
@@ -168,6 +175,16 @@ const runFinishedStream = (answerId: string): AgentRunType => ({
   },
 });
 
+const runErrorStream = (
+  message: string,
+  code: string
+): AgentRunErrorType => ({
+  type: 'RUN_ERROR',
+  timestamp: new Date().valueOf(),
+  message,
+  code,
+});
+
 export type AgentMessage =
   | AgentRunType
   | AgentCustomType
@@ -175,7 +192,21 @@ export type AgentMessage =
   | AgentToolCallType
   | AgentToolCallArgsType
   | AgentTextMessageType
-  | AgentCitationType;
+  | AgentCitationType
+  | AgentRunErrorType;
+
+export const turnLimitErrorStream: Array<AgentMessage> = [
+  runStartStream(ANSWER_ID_2),
+  runErrorStream(
+    'The conversation turn limit has been reached.',
+    'KNOWLEDGE:SSE_TURN_LIMIT_REACHED'
+  ),
+];
+
+export const genericErrorStream: Array<AgentMessage> = [
+  runStartStream(ANSWER_ID_2),
+  runErrorStream('An unexpected error occurred.', 'KNOWLEDGE:SSE_INTERNAL_ERROR'),
+];
 
 export type AgentData = {
   answerStreams: Array<AgentMessage>;

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

@@ -549,6 +549,12 @@ export class GeneratedAnswerObject {
     });
   }
 
+  async mockAgentFollowUpNetworkError() {
+    await this.page.route('**/agents/*/follow-up', (route) => {
+      route.abort('connectionrefused');
+    });
+  }
+
   get followUpInput(): Locator {
     return this.page.locator(
       'c-quantic-generated-answer-follow-up-input textarea'

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

@@ -1,5 +1,5 @@
 import {testAgent, expect} from './fixture-agent';
-import agentData from './agentData';
+import agentData, {turnLimitErrorStream, genericErrorStream} from './agentData';
 import {
   analyticsModeTest,
   AnalyticsModeEnum,
@@ -231,3 +231,68 @@ analyticsModeTest.forEach((analytics) => {
     );
   });
 });
+
+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.');
+    }
+  );
+});

package/force-app/main/default/lwc/quanticGeneratedAnswer/quanticGeneratedAnswer.css

@@ -1,3 +1,3 @@
 .generated-answer__header-title {
-  color: var(--lwc-brandPrimary, #1b96ff);
+  color: var(--slds-g-color-accent-1, var(--lwc-brandPrimary, #1b96ff));
 }

package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/generatedAnswer.css

@@ -10,7 +10,7 @@
 }
 
 .generated-answer__footer {
-  gap: 1rem;
+  gap: var(--slds-g-spacing-4, 1rem);
 }
 
 .generated-answer__answer--collapsed {
@@ -19,12 +19,12 @@
 
 .generated-answer__answer--expanded {
   max-height: 100%;
-  margin-bottom: 1rem;
+  margin-bottom: var(--slds-g-spacing-4, 1rem);
   overflow: visible;
 }
 
 .generated-answer__collapse-generating-message {
-  color: var(--lwc-brandPrimary, #1b96ff);
+  color: var(--slds-g-color-accent-1, var(--lwc-brandPrimary, #1b96ff));
 }
 
 .generated-answer__answer::after {

package/force-app/main/default/lwc/quanticGeneratedAnswer/templates/generatedAnswer.html

@@ -87,8 +87,8 @@
   </template>
   <template lwc:if={cannotAnswer}>
     <template lwc:if={isManualAnswerGeneration}>
-      <div data-testid="generated-answer__no-answer-card" class="slds-box">
-        <div class="generated-answer__card-header slds-grid slds-grid_vertical-align-center slds-border_bottom slds-p-around_x-small">
+      <div data-testid="generated-answer__no-answer-card" class="slds-box slds-p-around_none">
+        <div class="generated-answer__card-header slds-grid slds-grid_vertical-align-center slds-border_bottom slds-p-around_small">
           <div class="generated-answer__header-title slds-grid slds-grid_vertical-align-center">
             <lightning-icon
               icon-name="utility:sparkles"
@@ -101,7 +101,7 @@
         </div>
         <div
           data-testid="generated-answer__no-answer-message"
-          class="generated-answer__content slds-var-m-top_medium"
+          class="generated-answer__content slds-p-around_small"
         >
           <div class={generatedAnswerClass}>
             <slot name="no-answer-message">{labels.noGeneratedAnswer}</slot>

package/force-app/main/default/lwc/quanticGeneratedAnswerBody/__tests__/quanticGeneratedAnswerBody.test.js

@@ -269,6 +269,45 @@ describe('c-quantic-generated-answer-body', () => {
       expect(error).not.toBeNull();
       expect(content).toBeNull();
     });
+
+    it('should render the generic error message when the error has no code (e.g., a network/transport failure)', async () => {
+      const element = createTestComponent({
+        ...defaultOptions,
+        generatedAnswer: {
+          ...defaultOptions.generatedAnswer,
+          answer: '',
+          // @ts-ignore
+          error: {
+            message:
+              'An error occurred while starting the follow-up answer generation.',
+          },
+        },
+      });
+      await flushPromises();
+
+      const error = element.shadowRoot.querySelector(selectors.error);
+
+      expect(error).not.toBeNull();
+      expect(error.textContent).toContain(
+        'Something went wrong while generating the answer. Please try again later.'
+      );
+    });
+
+    it('should not render the error message when the error object is present but empty', async () => {
+      const element = createTestComponent({
+        ...defaultOptions,
+        generatedAnswer: {
+          ...defaultOptions.generatedAnswer,
+          // @ts-ignore
+          error: {},
+        },
+      });
+      await flushPromises();
+
+      const error = element.shadowRoot.querySelector(selectors.error);
+
+      expect(error).toBeNull();
+    });
   });
 
   describe('rendering of actions', () => {

package/force-app/main/default/lwc/quanticGeneratedAnswerBody/quanticGeneratedAnswerBody.js

@@ -78,7 +78,10 @@ export default class QuanticGeneratedAnswerBody extends LightningElement {
   }
 
   get hasError() {
-    return !!this.generatedAnswer?.error?.code;
+    return (
+      !!this.generatedAnswer?.error?.code ||
+      !!this.generatedAnswer?.error?.message
+    );
   }
 
   get cannotAnswer() {