@salesforcedevs/dx-components 0.20.2 → 0.21.0

package/src/modules/dx/sidebarSearch/__tests__/sidebarSearch.test.ts

@@ -3,6 +3,8 @@ import SidebarSearch from "dx/sidebarSearch";
 import { createRenderComponent, renderLightningElement } from "utils/tests";
 import { coveoXMLDocsConfig } from "utils/coveo";
 import { mockQueryParameter, unmockQueryParameter } from "utils/jest";
+import { SESSION_KEY } from "dx/sidebarSearch";
+import mockPreloadedState from "./mockPreloadedState";
 
 const TAG = "dx-sidebar-search";
 const render = createRenderComponent(TAG, SidebarSearch);
@@ -11,8 +13,40 @@ const PROPS = coveoXMLDocsConfig;
 const QUERY = "test";
 
 describe(TAG, () => {
+    beforeEach(() => {
+        window.sessionStorage.clear();
+        jest.restoreAllMocks();
+    });
     afterEach(unmockQueryParameter);
 
+    it("correctly sets coveo advanced configuration", () => {
+        const element = render(PROPS);
+
+        element.coveoAdvancedQueryConfig = JSON.stringify(
+            coveoXMLDocsConfig.coveoAdvancedQueryConfig
+        );
+
+        expect(element.coveoAdvancedQueryConfig).toEqual(
+            coveoXMLDocsConfig.coveoAdvancedQueryConfig
+        );
+
+        return expect(element).toBeAccessible();
+    });
+
+    it("calls dispatchOnChangeEvent with empty query", () => {
+        const element = render(PROPS);
+
+        const mockOnChange = jest.fn();
+
+        element.addEventListener("change", mockOnChange);
+
+        element.setInputValue("reference");
+        element.setInputValue("");
+
+        expect(mockOnChange).toHaveBeenCalled();
+        return expect(element).toBeAccessible();
+    });
+
     it("renders with the correct initial empty query", () => {
         const element = render(PROPS);
 
@@ -90,24 +124,49 @@ describe(TAG, () => {
             );
         });
     });
-});
 
-// git("correctly consumes a valid session storage object", () => {
-//     mockQueryParameter(mockPreloadedState.query.q);
+    it("correctly consumes a valid session storage object", () => {
+        mockQueryParameter(mockPreloadedState.state.query.q);
 
-//     window.sessionStorage.setItem(
-//         SESSION_KEY,
-//         JSON.stringify(mockPreloadedState)
-//     );
+        window.sessionStorage.setItem(
+            SESSION_KEY,
+            JSON.stringify(mockPreloadedState)
+        );
 
-//     const mockOnChange = jest.fn();
+        const element = render(PROPS);
+
+        expect(window.sessionStorage.getItem(SESSION_KEY)).not.toBeNull();
+
+        expect(element).toBeAccessible();
+    });
+
+    it("ignores and deletes a session storage object if query and config don't match", () => {
+        mockQueryParameter("test");
+
+        window.sessionStorage.setItem(
+            SESSION_KEY,
+            JSON.stringify(mockPreloadedState)
+        );
+
+        const element = render(PROPS);
 
-//     const element = render(PROPS);
-//     element.addEventListener("change", mockOnChange);
+        expect(window.sessionStorage.getItem(SESSION_KEY)).toBeNull();
 
-//     return Promise.resolve().then(() => {
-//         expect(mockOnChange).toHaveBeenCalledTimes(1);
+        expect(element).toBeAccessible();
+    });
+
+    it("ignores and deletes a session storage object on incorrect config", () => {
+        mockQueryParameter(mockPreloadedState.state.query.q);
+
+        window.sessionStorage.setItem(
+            SESSION_KEY,
+            JSON.stringify({ state: { query: { q: "test" } } })
+        );
+
+        const element = render(PROPS);
+
+        expect(window.sessionStorage.getItem(SESSION_KEY)).toBeNull();
 
-//         expect(element).toBeAccessible();
-//     });
-// });
+        expect(element).toBeAccessible();
+    });
+});

package/src/modules/dx/sidebarSearch/sidebarSearch.ts

@@ -125,6 +125,7 @@ export default class SidebarSearch extends LightningElement {
     renderedCallback() {
         // in prod some of the critical coveo configuration attributes seem to arrive later
         // so I needed to put this coveo startup flow here where we can wait for them to arrive
+
         if (this.hasCorrectCoveoConfig && !this.engine) {
             this.initializeUserSession();
             this.initializeCoveo();
@@ -151,12 +152,14 @@ export default class SidebarSearch extends LightningElement {
 
     private initializeUserSession() {
         const stringified = window.sessionStorage.getItem(SESSION_KEY);
+
         if (!stringified) {
             return;
         }
 
         try {
             const json = JSON.parse(stringified);
+
             const hasSameConfig = Object.entries(
                 json.coveoAdvancedQueryConfig
             ).every(
@@ -164,6 +167,7 @@ export default class SidebarSearch extends LightningElement {
                     this.coveoAdvancedQueryConfig[key] === value
             );
             const hasSameQuery = json?.state?.query?.q === this.value;
+
             if (hasSameConfig && hasSameQuery) {
                 this.preloadedState = json?.state;
             } else {