Merge branch 'master' into SFINT-6015

Author: SimonMilord

packages/atomic/src/components/commerce/atomic-commerce-recommendation-interface/store.spec.ts

@@ -0,0 +1,64 @@
+import {describe, it, expect, beforeEach, vi} from 'vitest';
+import {
+  createBaseStore,
+  setLoadingFlag,
+  unsetLoadingFlag,
+} from '../../common/interface/store';
+import {
+  createCommerceRecommendationStore,
+  CommerceRecommendationStore,
+} from './store';
+
+vi.mock('../../common/interface/store', {spy: true});
+
+describe('#createCommerceRecommendationStore', () => {
+  let store: CommerceRecommendationStore;
+
+  beforeEach(() => {
+    store = createCommerceRecommendationStore();
+  });
+
+  it('should call #createBaseStore with the correct arguments', () => {
+    expect(store).toBeDefined();
+    expect(createBaseStore).toHaveBeenCalledExactlyOnceWith({
+      loadingFlags: [],
+      iconAssetsPath: '',
+      resultList: undefined,
+    });
+  });
+
+  it('should return an object that includes all properties and methods from the base store', () => {
+    const createBaseStoreSpy = vi.mocked(createBaseStore);
+    const baseStore = createBaseStoreSpy.mock.results[0].value;
+
+    expect(store).toEqual({
+      ...baseStore,
+      unsetLoadingFlag: expect.any(Function),
+      setLoadingFlag: expect.any(Function),
+    });
+  });
+
+  it('should delegate its #setLoadingFlag to the core #setLoadingFlag with the correct arguments', () => {
+    const createBaseStoreSpy = vi.mocked(createBaseStore);
+    const baseStore = createBaseStoreSpy.mock.results[0].value;
+
+    store.setLoadingFlag('testFlag');
+
+    expect(setLoadingFlag).toHaveBeenCalledExactlyOnceWith(
+      baseStore,
+      'testFlag'
+    );
+  });
+
+  it('should delegate its #unsetLoadingFlag to the core #unsetLoadingFlag with the correct arguments', () => {
+    const createBaseStoreSpy = vi.mocked(createBaseStore);
+    const baseStore = createBaseStoreSpy.mock.results[0].value;
+
+    store.unsetLoadingFlag('testFlag');
+
+    expect(unsetLoadingFlag).toHaveBeenCalledExactlyOnceWith(
+      baseStore,
+      'testFlag'
+    );
+  });
+});

packages/atomic/src/global/environment.spec.ts

@@ -0,0 +1,64 @@
+import {describe, it, expect, vi, beforeEach, afterEach} from 'vitest';
+import * as env from './environment';
+
+vi.mock('@coveo/headless', () => ({VERSION: 'HEADLESS_VERSION'}));
+
+describe('environment', () => {
+  const globalWindow = window as Record<string, unknown>;
+  const originalCoveoAtomic = globalWindow['COVEO_ATOMIC'];
+  const originalEnv = process.env.VERSION;
+
+  beforeEach(() => {
+    delete globalWindow['COVEO_ATOMIC'];
+    process.env.VERSION = 'ATOMIC_VERSION';
+  });
+
+  afterEach(() => {
+    globalWindow['COVEO_ATOMIC'] = originalCoveoAtomic;
+    if (originalEnv !== undefined) {
+      process.env.VERSION = originalEnv;
+    } else {
+      delete process.env.VERSION;
+    }
+  });
+
+  describe('#getAtomicEnvironment', () => {
+    it('should return correct versions', () => {
+      const result = env.getAtomicEnvironment();
+
+      expect(result).toEqual({
+        version: 'ATOMIC_VERSION',
+        headlessVersion: 'HEADLESS_VERSION',
+      });
+    });
+  });
+
+  describe('#setCoveoGlobal', () => {
+    it('should set the COVEO_ATOMIC global variable when not already set', () => {
+      expect(
+        (window as Record<string, unknown>)['COVEO_ATOMIC']
+      ).toBeUndefined();
+
+      env.setCoveoGlobal('COVEO_ATOMIC');
+
+      expect((window as Record<string, unknown>)['COVEO_ATOMIC']).toEqual({
+        version: 'ATOMIC_VERSION',
+        headlessVersion: 'HEADLESS_VERSION',
+      });
+    });
+
+    it('should not overwrite the COVEO_ATOMIC global variable when already set', () => {
+      (window as Record<string, unknown>)['COVEO_ATOMIC'] = {
+        version: 'EXISTING',
+        headlessVersion: 'EXISTING',
+      };
+
+      env.setCoveoGlobal('COVEO_ATOMIC');
+
+      expect((window as Record<string, unknown>)['COVEO_ATOMIC']).toEqual({
+        version: 'EXISTING',
+        headlessVersion: 'EXISTING',
+      });
+    });
+  });
+});

packages/quantic/cypress/e2e/default-2/search-box/search-box-selectors.ts

@@ -16,10 +16,10 @@ export interface SearchBoxSelector extends ComponentSelector {
 export const SearchBoxSelectors: SearchBoxSelector = {
   get: () => cy.get(standaloneSearchBoxComponent),
   quanticSearchBoxInput: () =>
-    SearchBoxSelectors.get().find('[data-cy="quantic-search-box-input"]'),
+    SearchBoxSelectors.get().find('[data-testid="quantic-search-box-input"]'),
   input: (textarea = false) =>
     SearchBoxSelectors.get().find(
-      `c-quantic-search-box-input [data-cy="${textarea ? 'search-box-textarea' : 'search-box-input'}"]`
+      `c-quantic-search-box-input [data-testid="${textarea ? 'search-box-textarea' : 'search-box-input'}"]`
     ),
   suggestionList: () =>
     SearchBoxSelectors.get().find(
@@ -31,18 +31,18 @@ export const SearchBoxSelectors: SearchBoxSelector = {
     ),
   clearRecentQueriesButton: () =>
     SearchBoxSelectors.get().find(
-      'c-quantic-search-box-input [data-cy="clear-recent-queries"]'
+      'c-quantic-search-box-input [data-testid="clear-recent-queries-button"]'
     ),
   querySuggestions: () =>
     SearchBoxSelectors.get().find(
-      'c-quantic-search-box-input [data-cy="suggestions-option"]'
+      'c-quantic-search-box-input [data-testid="suggestions-option"]'
     ),
   querySuggestionByIndex: (index: number) =>
     SearchBoxSelectors.querySuggestions().eq(index),
   querySuggestionContentByIndex: (index: number) =>
     SearchBoxSelectors.get()
       .find(
-        'c-quantic-search-box-input [data-cy="suggestions-option"] lightning-formatted-rich-text'
+        'c-quantic-search-box-input [data-testid="suggestions-option"] lightning-formatted-rich-text'
       )
       .eq(index),
 };

packages/quantic/cypress/e2e/default-2/standalone-search-box/standalone-search-box-selectors.ts

@@ -15,13 +15,13 @@ export const StandaloneSearchBoxSelectors: StandaloneSearchBoxSelector = {
   get: () => cy.get(standaloneSearchBoxComponent),
   quanticSearchBoxInput: () =>
     StandaloneSearchBoxSelectors.get().find(
-      '[data-cy="quantic-search-box-input"]'
+      '[data-testid="quantic-search-box-input"]'
     ),
   input: (textarea = false) =>
     StandaloneSearchBoxSelectors.get().find(
       textarea
-        ? 'c-quantic-search-box-input [data-cy="search-box-textarea"]'
-        : 'c-quantic-search-box-input [data-cy="search-box-input"]'
+        ? 'c-quantic-search-box-input [data-testid="search-box-textarea"]'
+        : 'c-quantic-search-box-input [data-testid="search-box-input"]'
     ),
   suggestionList: () =>
     StandaloneSearchBoxSelectors.get().find(

packages/quantic/force-app/examples/main/lwc/actionLocalStorage/actionLocalStorage.html

@@ -0,0 +1,27 @@
+<template>
+  <div>
+    <lightning-input
+      label={inputLabel}
+      value={inputValue}
+      data-testid="localstorage-input"
+      onchange={handleInputChange}
+    ></lightning-input>
+    <lightning-button
+      label="Set Value"
+      onclick={handleSetValue}
+      class="slds-var-m-top_small"
+      data-testid="localstorage-set-button"
+    ></lightning-button>
+
+    <lightning-button
+      label="Print Value"
+      onclick={handlePrintValue}
+      class="slds-var-m-top_small slds-var-m-left_small"
+      data-testid="localstorage-get-button"
+    ></lightning-button>
+
+    <p class="slds-var-m-top_medium" data-testid="localstorage-output">
+      {outputValue}
+    </p>
+  </div>
+</template>

packages/quantic/force-app/examples/main/lwc/actionLocalStorage/actionLocalStorage.js

@@ -0,0 +1,28 @@
+import {api, LightningElement} from 'lwc';
+
+export default class ActionLocalStorage extends LightningElement {
+  @api storageKey;
+
+  inputValue = '';
+  outputValue = '';
+
+  handleInputChange(event) {
+    this.inputValue = event.target.value;
+  }
+
+  handleSetValue() {
+    if (this.storageKey) {
+      localStorage.setItem(this.storageKey, this.inputValue);
+    }
+  }
+
+  handlePrintValue() {
+    if (this.storageKey) {
+      this.outputValue = localStorage.getItem(this.storageKey) || '';
+    }
+  }
+
+  get inputLabel() {
+    return `Set value for key "${this.storageKey}":`;
+  }
+}

packages/quantic/force-app/examples/main/lwc/actionLocalStorage/actionLocalStorage.js-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+  <apiVersion>52.0</apiVersion>
+  <isExposed>false</isExposed>
+</LightningComponentBundle>

packages/quantic/force-app/examples/main/lwc/exampleQuanticSearchBox/exampleQuanticSearchBox.html

@@ -6,6 +6,7 @@
 
     <div slot="configuration">
       <c-configurator options={options} ontryitnow={handleTryItNow}>
+         <c-action-local-storage slot="actions" storage-key={recentQueriesStorageKey}></c-action-local-storage>
       </c-configurator>
     </div>
 

packages/quantic/force-app/examples/main/lwc/exampleQuanticSearchBox/exampleQuanticSearchBox.js

@@ -1,7 +1,12 @@
 import {LightningElement, track} from 'lwc';
 
+const DEFAULT_ENGINE_ID = 'quantic-search-box-engine';
+const RECENT_QUERIES_STORAGE_KEY_SUFFIX = '_quantic-recent-queries';
+
 export default class ExampleQuanticSearchBox extends LightningElement {
-  @track config = {};
+  @track config = {
+    engineId: DEFAULT_ENGINE_ID,
+  };
   isConfigured = false;
 
   pageTitle = 'Quantic Search Box';
@@ -12,7 +17,7 @@ export default class ExampleQuanticSearchBox extends LightningElement {
       attribute: 'engineId',
       label: 'Engine id',
       description: 'The ID of the engine instance the component registers to.',
-      defaultValue: 'quantic-search-box-engine',
+      defaultValue: DEFAULT_ENGINE_ID,
     },
     {
       attribute: 'useCase',
@@ -61,4 +66,8 @@ export default class ExampleQuanticSearchBox extends LightningElement {
     this.config = evt.detail;
     this.isConfigured = true;
   }
+
+  get recentQueriesStorageKey() {
+    return `${this.config.engineId}${RECENT_QUERIES_STORAGE_KEY_SUFFIX}`;
+  }
 }

packages/quantic/force-app/main/default/lwc/quanticPager/e2e/fixture.ts

@@ -35,8 +35,9 @@ export const testSearch = quanticBase.extend<QuanticPagerE2ESearchFixtures>({
   },
   pager: async ({page, options, configuration, search, urlHash}, use) => {
     await page.goto(urlHash ? `${pageUrl}#${urlHash}` : pageUrl);
+    const searchResponsePromise = search.waitForSearchResponse();
     configuration.configure(options);
-    await search.waitForSearchResponse();
+    await searchResponsePromise;
 
     await use(new PagerObject(page));
   },
@@ -54,8 +55,9 @@ export const testInsight = quanticBase.extend<QuanticPagerE2EInsightFixtures>({
     await page.goto(pageUrl);
     configuration.configure({...options, useCase: useCaseEnum.insight});
     await insightSetup.waitForInsightInterfaceInitialization();
+    const searchResponsePromise = search.waitForSearchResponse();
     await search.performSearch();
-    await search.waitForSearchResponse();
+    await searchResponsePromise;
     await use(new PagerObject(page));
   },
 });

packages/quantic/force-app/main/default/lwc/quanticPager/e2e/quanticPager.e2e.ts

@@ -18,11 +18,12 @@ useCaseTestCases.forEach((useCase) => {
         search,
       }) => {
         const searchResponsePromise = search.waitForSearchResponse();
+        const pagerNextUaAnalyticsPromise = pager.waitForPagerNextUaAnalytics();
         await pager.clickNextPageButton();
         const searchResponse = await searchResponsePromise;
         const {firstResult} = searchResponse.request().postDataJSON();
         expect(firstResult).toBe(numberOfResultsPerPage);
-        await pager.waitForPagerNextUaAnalytics();
+        await pagerNextUaAnalyticsPromise;
       });
     });
 
@@ -36,11 +37,13 @@ useCaseTestCases.forEach((useCase) => {
         await initialSearchResponsePromise;
 
         const searchResponsePromise = search.waitForSearchResponse();
+        const pagerPreviousUaAnalyticsPromise =
+          pager.waitForPagerPreviousUaAnalytics();
         await pager.clickPreviousPageButton();
         const searchResponse = await searchResponsePromise;
         const {firstResult} = searchResponse.request().postDataJSON();
         expect(firstResult).toBe(0);
-        await pager.waitForPagerPreviousUaAnalytics();
+        await pagerPreviousUaAnalyticsPromise;
       });
     });
 
@@ -51,11 +54,13 @@ useCaseTestCases.forEach((useCase) => {
       }) => {
         const examplePage = 3;
         const searchResponsePromise = search.waitForSearchResponse();
+        const pagerPageUaAnalyticsPromise =
+          pager.waitForPagerNumberUaAnalytics();
         await pager.clickPageNumberButton(examplePage);
         const searchResponse = await searchResponsePromise;
         const {firstResult} = searchResponse.request().postDataJSON();
         expect(firstResult).toBe(numberOfResultsPerPage * (examplePage - 1));
-        await pager.waitForPagerNumberUaAnalytics();
+        await pagerPageUaAnalyticsPromise;
       });
     });
 

packages/quantic/force-app/main/default/lwc/quanticResultList/e2e/fixture.ts

@@ -35,6 +35,7 @@ export const testSearch =
       await page.goto(pageUrl);
       configuration.configure(options);
       await search.waitForSearchResponse();
+      await search.waitForSearchResultsVisible();
       await use(new ResultListObject(page));
     },
   });
@@ -57,6 +58,7 @@ export const testInsight =
       await insightSetup.waitForInsightInterfaceInitialization();
       await search.performSearch();
       await search.waitForSearchResponse();
+      await search.waitForSearchResultsVisible();
       await use(new ResultListObject(page));
     },
   });