chore: PR feedback for tests

brobro10000 · brobro10000 · commit 50918bdf3d03 · 2025-05-01T11:54:14.000-04:00
diff --git a/src/components/skills-quiz-v2/tests/SkillsQuiz.test.jsx b/src/components/skills-quiz-v2/tests/SkillsQuiz.test.jsx
@@ -8,7 +8,7 @@ import { renderWithRouter } from '../../../utils/tests';
 import SkillsQuizV2 from '../SkillsQuiz';
 import { useAlgoliaSearch, useDefaultSearchFilters, useEnterpriseCustomer } from '../../app/data';
 import { authenticatedUserFactory, enterpriseCustomerFactory } from '../../app/data/services/data/__factories__';
-import { setFakeHits } from '../../skills-quiz/__mocks__/react-instantsearch-dom';
+import { resetMockReactInstantSearch, setFakeHits } from '../../skills-quiz/__mocks__/react-instantsearch-dom';
 
 // [tech debt] We appear to attempting to call legit Algolia APIs in these tests; lots
 // of test output related to Algolia errors. Does not appear to impact the test results.
@@ -58,15 +58,17 @@ const hits = [
     ],
   },
 ];
-setFakeHits(hits);
 describe('<SkillsQuizV2 />', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     useEnterpriseCustomer.mockReturnValue({ data: mockEnterpriseCustomer });
     useAlgoliaSearch.mockReturnValue(mockAlgoliaSearch);
     useDefaultSearchFilters.mockReturnValue(`enterprise_customer_uuids:${mockEnterpriseCustomer.uuid}`);
+    setFakeHits(hits);
+  });
+  afterEach(() => {
+    resetMockReactInstantSearch();
   });
-
   it('renders SkillsQuizV2 component correctly', () => {
     renderWithRouter(
       <IntlProvider locale="en">
diff --git a/src/components/skills-quiz-v2/tests/SkillsQuizForm.test.jsx b/src/components/skills-quiz-v2/tests/SkillsQuizForm.test.jsx
@@ -11,7 +11,7 @@ import { GOAL_DROPDOWN_DEFAULT_OPTION } from '../../skills-quiz/constants';
 import SkillQuizForm from '../SkillsQuizForm';
 import { authenticatedUserFactory, enterpriseCustomerFactory } from '../../app/data/services/data/__factories__';
 import { useAlgoliaSearch, useDefaultSearchFilters, useEnterpriseCustomer } from '../../app/data';
-import { setFakeHits } from '../../skills-quiz/__mocks__/react-instantsearch-dom';
+import { resetMockReactInstantSearch, setFakeHits } from '../../skills-quiz/__mocks__/react-instantsearch-dom';
 
 jest.mock('algoliasearch/lite', () => jest.fn());
 const mockSearch = jest.fn().mockResolvedValue({ hits: [] });
@@ -85,15 +85,17 @@ const hits = [
     ],
   },
 ];
-setFakeHits(hits);
 describe('<SkillQuizForm />', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     useEnterpriseCustomer.mockReturnValue({ data: mockEnterpriseCustomer });
     useAlgoliaSearch.mockReturnValue(mockAlgoliaSearch);
     useDefaultSearchFilters.mockReturnValue(`enterprise_customer_uuids:${mockEnterpriseCustomer.uuid}`);
+    setFakeHits(hits);
+  });
+  afterEach(() => {
+    resetMockReactInstantSearch();
   });
-
   it('renders skills quiz v2 page', async () => {
     renderWithRouter(
       <SkillsQuizFormWrapper />,
diff --git a/src/components/skills-quiz/__mocks__/react-instantsearch-dom.jsx b/src/components/skills-quiz/__mocks__/react-instantsearch-dom.jsx
@@ -6,45 +6,52 @@ const MockReactInstantSearch = jest.genMockFromModule(
   'react-instantsearch-dom',
 );
 
-let fakeHits = [
-  {
-    objectID: '1',
-    title: 'bla',
-    key: 'Bees101',
-    type: 'course',
-    aggregation_key: 'course:Bees101',
-    authoring_organizations: [],
-    card_image_url: 'https://fake.image',
-    course_keys: [],
-  },
-  {
-    objectID: '2',
-    title: 'blp',
-    key: 'Wasps200',
-    type: 'course',
-    aggregation_key: 'course:Wasps200',
-    authoring_organizations: [],
-    card_image_url: 'https://fake.image',
-    course_keys: [],
-  },
-];
+let mockState = {
+  hits: [
+    {
+      objectID: '1',
+      title: 'bla',
+      key: 'Bees101',
+      type: 'course',
+      aggregation_key: 'course:Bees101',
+      authoring_organizations: [],
+      card_image_url: 'https://fake.image',
+      course_keys: [],
+    },
+    {
+      objectID: '2',
+      title: 'blp',
+      key: 'Wasps200',
+      type: 'course',
+      aggregation_key: 'course:Wasps200',
+      authoring_organizations: [],
+      card_image_url: 'https://fake.image',
+      course_keys: [],
+    },
+  ],
+  nbHits: 2,
+};
 
 // This allows you to override the built-in hits object
 const setFakeHits = hits => {
-  fakeHits = hits;
+  mockState.hits = hits;
+  mockState.nbHits = hits.length;
 };
 
-MockReactInstantSearch.configure = {
-  nbHits: 2,
+const resetMockReactInstantSearch = () => {
+  mockState = {
+    hits: [...mockState.hits], // deep clone if needed
+    nbHits: 2,
+  };
 };
 
 MockReactInstantSearch.connectStateResults = Component => (props) => (
   <Component
     searchResults={{
-      hits: MockReactInstantSearch.configure.nbHits === 0 ? [] : fakeHits,
+      hits: mockState.hits,
       hitsPerPage: 25,
-      nbHits: MockReactInstantSearch.configure.nbHits,
-      nbPages: MockReactInstantSearch.configure.nbHits === 0 ? 0 : 1,
+      nbHits: mockState.nbHits,
+      nbPages: mockState.nbHits === 0 ? 0 : 1,
       page: 1,
     }}
     isSearchStalled={false}
@@ -57,7 +64,7 @@ MockReactInstantSearch.connectStateResults = Component => (props) => (
 
 MockReactInstantSearch.connectPagination = Component => (props) => (
   <Component
-    nbPages={MockReactInstantSearch.configure.nbHits === 0 ? 0 : 1}
+    nbPages={mockState.nbHits === 0 ? 0 : 1}
     currentRefinement={1}
     maxPagesDisplayed={5}
     {...props}
@@ -84,4 +91,5 @@ MockReactInstantSearch.Index = function Index({ children }) { return children; }
 module.exports = {
   ...MockReactInstantSearch,
   setFakeHits,
+  resetMockReactInstantSearch,
 };
diff --git a/src/components/skills-quiz/tests/SearchCurrentJobCard.test.jsx b/src/components/skills-quiz/tests/SearchCurrentJobCard.test.jsx
@@ -9,7 +9,7 @@ import { SkillsContextProvider } from '../SkillsContextProvider';
 import SearchCurrentJobCard from '../SearchCurrentJobCard';
 import { useAlgoliaSearch, useEnterpriseCustomer } from '../../app/data';
 import { authenticatedUserFactory, enterpriseCustomerFactory } from '../../app/data/services/data/__factories__';
-import { setFakeHits } from '../__mocks__/react-instantsearch-dom';
+import { resetMockReactInstantSearch, setFakeHits } from '../__mocks__/react-instantsearch-dom';
 
 jest.mock('react-loading-skeleton', () => ({
   __esModule: true,
@@ -94,12 +94,15 @@ const mockAlgoliaSearch = {
   },
 };
 
-setFakeHits(hitObject.hits);
 describe('<SearchCurrentJobCard />', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     useEnterpriseCustomer.mockReturnValue({ data: mockEnterpriseCustomer });
     useAlgoliaSearch.mockReturnValue(mockAlgoliaSearch);
+    setFakeHits(hitObject.hits);
+  });
+  afterEach(() => {
+    resetMockReactInstantSearch();
   });
   test('renders the data in job cards correctly', async () => {
     renderWithRouter(
diff --git a/src/components/skills-quiz/tests/SearchJobCard.test.jsx b/src/components/skills-quiz/tests/SearchJobCard.test.jsx
@@ -8,7 +8,7 @@ import { SkillsContextProvider } from '../SkillsContextProvider';
 import SearchJobCard from '../SearchJobCard';
 import { useAlgoliaSearch, useEnterpriseCustomer } from '../../app/data';
 import { authenticatedUserFactory, enterpriseCustomerFactory } from '../../app/data/services/data/__factories__';
-import { setFakeHits } from '../__mocks__/react-instantsearch-dom';
+import { resetMockReactInstantSearch, setFakeHits } from '../__mocks__/react-instantsearch-dom';
 
 jest.mock('react-loading-skeleton', () => ({
   __esModule: true,
@@ -91,12 +91,15 @@ const mockAlgoliaSearch = {
   },
 };
 
-setFakeHits(hitObject.hits);
 describe('<SearchJobCard />', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     useEnterpriseCustomer.mockReturnValue({ data: mockEnterpriseCustomer });
     useAlgoliaSearch.mockReturnValue(mockAlgoliaSearch);
+    setFakeHits(hitObject.hits);
+  });
+  afterEach(() => {
+    resetMockReactInstantSearch();
   });
   test('renders the data in job cards correctly', async () => {
     render(
diff --git a/src/components/skills-quiz/tests/SkillsCourses.test.jsx b/src/components/skills-quiz/tests/SkillsCourses.test.jsx
@@ -13,7 +13,7 @@ import { NO_COURSES_ALERT_MESSAGE_AGAINST_SKILLS } from '../constants';
 import { SkillsContext } from '../SkillsContextProvider';
 import { useAlgoliaSearch, useDefaultSearchFilters, useEnterpriseCustomer } from '../../app/data';
 import { authenticatedUserFactory, enterpriseCustomerFactory } from '../../app/data/services/data/__factories__';
-import { setFakeHits } from '../__mocks__/react-instantsearch-dom';
+import { resetMockReactInstantSearch, setFakeHits } from '../__mocks__/react-instantsearch-dom';
 
 jest.mock('@edx/frontend-enterprise-utils', () => ({
   ...jest.requireActual('@edx/frontend-enterprise-utils'),
@@ -106,15 +106,17 @@ const mockAlgoliaSearch = {
   },
 };
 
-setFakeHits(courses.hits);
 describe('<SkillsCourses />', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     useEnterpriseCustomer.mockReturnValue({ data: mockEnterpriseCustomer });
     useDefaultSearchFilters.mockReturnValue(`enterprise_customer_uuids:${mockEnterpriseCustomer.uuid}`);
     useAlgoliaSearch.mockReturnValue(mockAlgoliaSearch);
+    setFakeHits(courses.hits);
+  });
+  afterEach(() => {
+    resetMockReactInstantSearch();
   });
-
   test('renders the correct data', async () => {
     const { container } = renderWithRouter(
       <SkillsCoursesWithContext />,
diff --git a/src/components/skills-quiz/tests/SkillsQuiz.test.jsx b/src/components/skills-quiz/tests/SkillsQuiz.test.jsx
@@ -11,7 +11,7 @@ import SkillsQuiz from '../SkillsQuiz';
 import { SkillsContextProvider } from '../SkillsContextProvider';
 import { useAlgoliaSearch, useDefaultSearchFilters, useEnterpriseCustomer } from '../../app/data';
 import { authenticatedUserFactory, enterpriseCustomerFactory } from '../../app/data/services/data/__factories__';
-import { setFakeHits } from '../__mocks__/react-instantsearch-dom';
+import { resetMockReactInstantSearch, setFakeHits } from '../__mocks__/react-instantsearch-dom';
 
 jest.mock('@edx/frontend-enterprise-utils', () => ({
   ...jest.requireActual('@edx/frontend-enterprise-utils'),
@@ -72,15 +72,17 @@ const hits = [
     ],
   },
 ];
-setFakeHits(hits);
 describe('<SkillsQuiz />', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     useEnterpriseCustomer.mockReturnValue({ data: mockEnterpriseCustomer });
     useAlgoliaSearch.mockReturnValue(mockAlgoliaSearch);
     useDefaultSearchFilters.mockReturnValue(`enterprise_customer_uuids:${mockEnterpriseCustomer.uuid}`);
+    setFakeHits(hits);
+  });
+  afterEach(() => {
+    resetMockReactInstantSearch();
   });
-
   it('renders skills quiz V1 page successfully.', () => {
     renderWithRouter(
       <SkillsQuizWithContext />,
