Consolidate helper functions in test file

Author: jcobis

packages/compass-collection/src/components/collection-header/collection-header.spec.tsx

@@ -28,7 +28,8 @@ import Sinon from 'sinon';
 function renderCollectionHeader(
   props: Partial<ComponentProps<typeof CollectionHeader>> = {},
   workspaceService: Partial<WorkspacesService> = {},
-  stateOverrides: any = {}
+  stateOverrides: Record<string, unknown> = {},
+  connectionInfo?: ConnectionInfo
 ) {
   const defaultState = {
     mockDataGenerator: {
@@ -40,7 +41,11 @@ function renderCollectionHeader(
 
   const mockStore = createStore(() => defaultState);
 
-  return renderWithConnections(
+  const renderMethod = connectionInfo
+    ? renderWithActiveConnection
+    : renderWithConnections;
+
+  return renderMethod(
     <Provider store={mockStore}>
       <WorkspacesServiceProvider value={workspaceService as WorkspacesService}>
         <CollectionHeader
@@ -53,16 +58,17 @@ function renderCollectionHeader(
           {...props}
         />
       </WorkspacesServiceProvider>
-    </Provider>
+    </Provider>,
+    connectionInfo
   );
 }
 
 describe('CollectionHeader [Component]', function () {
   afterEach(cleanup);
 
   context('when the collection is not readonly', function () {
-    beforeEach(function () {
-      renderCollectionHeader();
+    beforeEach(async function () {
+      await renderCollectionHeader();
     });
 
     it('renders the correct root classname', function () {
@@ -91,8 +97,11 @@ describe('CollectionHeader [Component]', function () {
   });
 
   context('when the collection is readonly', function () {
-    beforeEach(function () {
-      renderCollectionHeader({ isReadonly: true, sourceName: 'orig.coll' });
+    beforeEach(async function () {
+      await renderCollectionHeader({
+        isReadonly: true,
+        sourceName: 'orig.coll',
+      });
     });
 
     afterEach(cleanup);
@@ -115,8 +124,8 @@ describe('CollectionHeader [Component]', function () {
   });
 
   context('when the collection is readonly but not a view', function () {
-    beforeEach(function () {
-      renderCollectionHeader({ isReadonly: true, sourceName: undefined });
+    beforeEach(async function () {
+      await renderCollectionHeader({ isReadonly: true, sourceName: undefined });
     });
 
     it('renders the readonly badge', function () {
@@ -129,8 +138,8 @@ describe('CollectionHeader [Component]', function () {
   });
 
   context('when the collection is a time-series collection', function () {
-    beforeEach(function () {
-      renderCollectionHeader({ isTimeSeries: true });
+    beforeEach(async function () {
+      await renderCollectionHeader({ isTimeSeries: true });
     });
 
     it('does not render the readonly badge', function () {
@@ -143,8 +152,8 @@ describe('CollectionHeader [Component]', function () {
   });
 
   context('when the collection is a clustered collection', function () {
-    beforeEach(function () {
-      renderCollectionHeader({ isClustered: true });
+    beforeEach(async function () {
+      await renderCollectionHeader({ isClustered: true });
     });
 
     it('does not render the readonly badge', function () {
@@ -161,8 +170,8 @@ describe('CollectionHeader [Component]', function () {
   });
 
   context('when the collection is a fle collection', function () {
-    beforeEach(function () {
-      renderCollectionHeader({ isFLE: true });
+    beforeEach(async function () {
+      await renderCollectionHeader({ isFLE: true });
     });
 
     it('renders the fle badge', function () {
@@ -171,8 +180,8 @@ describe('CollectionHeader [Component]', function () {
   });
 
   describe('insights', function () {
-    it('should show an insight when $text is used in the pipeline source', function () {
-      renderCollectionHeader({
+    it('should show an insight when $text is used in the pipeline source', async function () {
+      await renderCollectionHeader({
         sourcePipeline: [{ $match: { $text: {} } }],
       });
       expect(screen.getByTestId('insight-badge-button')).to.exist;
@@ -181,8 +190,8 @@ describe('CollectionHeader [Component]', function () {
         .exist;
     });
 
-    it('should show an insight when $regex is used in the pipeline source', function () {
-      renderCollectionHeader({
+    it('should show an insight when $regex is used in the pipeline source', async function () {
+      await renderCollectionHeader({
         sourcePipeline: [{ $match: { $regex: {} } }],
       });
       expect(screen.getByTestId('insight-badge-button')).to.exist;
@@ -191,8 +200,8 @@ describe('CollectionHeader [Component]', function () {
         .exist;
     });
 
-    it('should show an insight when $lookup is used in the pipeline source', function () {
-      renderCollectionHeader({
+    it('should show an insight when $lookup is used in the pipeline source', async function () {
+      await renderCollectionHeader({
         sourcePipeline: [{ $lookup: {} }],
       });
       expect(screen.getByTestId('insight-badge-button')).to.exist;
@@ -211,7 +220,7 @@ describe('CollectionHeader [Component]', function () {
     });
 
     function assertBreadcrumbText(items: string[]) {
-      const crumbs: any[] = [];
+      const crumbs: (string | null)[] = [];
       screen.getByTestId('breadcrumbs').childNodes.forEach((item) => {
         crumbs.push(item.textContent);
       });
@@ -232,22 +241,22 @@ describe('CollectionHeader [Component]', function () {
     }
 
     context('renders correclty', function () {
-      it('for a collection', function () {
-        renderCollectionHeader({ namespace: 'db.coll1' });
+      it('for a collection', async function () {
+        await renderCollectionHeader({ namespace: 'db.coll1' });
         assertBreadcrumbText(['db', 'coll1']);
       });
 
-      it('for a view', function () {
-        renderCollectionHeader({
+      it('for a view', async function () {
+        await renderCollectionHeader({
           namespace: 'db.coll1',
           sourceName: 'db.coll2',
         });
         // For view: connection-db-sourceCollectionName-viewName
         assertBreadcrumbText(['db', 'coll2', 'coll1']);
       });
 
-      it('for a view when its being edited', function () {
-        renderCollectionHeader({
+      it('for a view when its being edited', async function () {
+        await renderCollectionHeader({
           namespace: 'db.coll3',
           editViewName: 'db.coll1',
         });
@@ -257,10 +266,10 @@ describe('CollectionHeader [Component]', function () {
     });
 
     context('calls onClick correclty', function () {
-      it('for a collection', function () {
+      it('for a collection', async function () {
         const openCollectionsWorkspaceStub = sandbox.stub();
         const openCollectionWorkspaceStub = sandbox.stub();
-        renderCollectionHeader(
+        await renderCollectionHeader(
           { namespace: 'db.coll1' },
           {
             openCollectionsWorkspace: openCollectionsWorkspaceStub,
@@ -281,9 +290,9 @@ describe('CollectionHeader [Component]', function () {
         ]);
       });
 
-      it('for a view, opens source collection', function () {
+      it('for a view, opens source collection', async function () {
         const openCollectionWorkspaceStub = sandbox.stub();
-        renderCollectionHeader(
+        await renderCollectionHeader(
           { namespace: 'db.coll1', sourceName: 'db.coll2' },
           {
             openCollectionWorkspace: openCollectionWorkspaceStub,
@@ -360,44 +369,8 @@ describe('CollectionHeader [Component]', function () {
       },
     };
 
-    function renderCollectionHeaderWithSchemaAnalysis(
-      props: Partial<ComponentProps<typeof CollectionHeader>> = {},
-      workspaceService: Partial<WorkspacesService> = {},
-      stateOverrides: any = {},
-      connectionInfo?: ConnectionInfo
-    ) {
-      const defaultState = {
-        mockDataGenerator: {
-          isModalOpen: false,
-          currentStep: MockDataGeneratorStep.SCHEMA_CONFIRMATION,
-        },
-        ...stateOverrides,
-      };
-
-      const mockStore = createStore(() => defaultState);
-
-      return renderWithActiveConnection(
-        <Provider store={mockStore}>
-          <WorkspacesServiceProvider
-            value={workspaceService as WorkspacesService}
-          >
-            <CollectionHeader
-              isAtlas={false}
-              isReadonly={false}
-              isTimeSeries={false}
-              isClustered={false}
-              isFLE={false}
-              namespace="test.test"
-              {...props}
-            />
-          </WorkspacesServiceProvider>
-        </Provider>,
-        connectionInfo
-      );
-    }
-
     it('should show Mock Data Generator button when all conditions are met', async function () {
-      await renderCollectionHeaderWithSchemaAnalysis(
+      await renderCollectionHeader(
         {
           isAtlas: true, // Atlas environment
           isReadonly: false, // Not readonly
@@ -426,7 +399,7 @@ describe('CollectionHeader [Component]', function () {
     });
 
     it('should disable Mock Data Generator button when collection has no schema analysis data', async function () {
-      await renderCollectionHeaderWithSchemaAnalysis(
+      await renderCollectionHeader(
         {
           isAtlas: true,
           isReadonly: false,
@@ -453,7 +426,7 @@ describe('CollectionHeader [Component]', function () {
     });
 
     it('should disable Mock Data Generator button for collections with excessive nesting depth', async function () {
-      await renderCollectionHeaderWithSchemaAnalysis(
+      await renderCollectionHeader(
         {
           isAtlas: true,
           isReadonly: false,
@@ -482,7 +455,7 @@ describe('CollectionHeader [Component]', function () {
     });
 
     it('should not show Mock Data Generator button for readonly collections (views)', async function () {
-      await renderCollectionHeaderWithSchemaAnalysis(
+      await renderCollectionHeader(
         {
           isAtlas: true,
           isReadonly: true, // Readonly (view)
@@ -509,7 +482,7 @@ describe('CollectionHeader [Component]', function () {
     });
 
     it('should not show Mock Data Generator button in non-Atlas environments', async function () {
-      await renderCollectionHeaderWithSchemaAnalysis(
+      await renderCollectionHeader(
         {
           isAtlas: false, // Not Atlas
           isReadonly: false,
@@ -536,7 +509,7 @@ describe('CollectionHeader [Component]', function () {
     });
 
     it('should not show Mock Data Generator button when schema analysis has not run', async function () {
-      await renderCollectionHeaderWithSchemaAnalysis(
+      await renderCollectionHeader(
         {
           isAtlas: true,
           isReadonly: false,