fixup! Update existing tests to handle dialog elements remaining in the DOM

Author: kraenhansen

packages/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.spec.tsx

@@ -134,23 +134,27 @@ describe('MockDataGeneratorModal', () => {
     it('renders the modal when isOpen is true', async () => {
       await renderModal();
 
-      expect(screen.getByTestId('generate-mock-data-modal')).to.exist;
+      expect(screen.getByTestId('generate-mock-data-modal').firstChild).to
+        .exist;
     });
 
     it('does not render the modal when isOpen is false', async () => {
       await renderModal({ isOpen: false });
 
-      expect(screen.queryByTestId('generate-mock-data-modal')).to.not.exist;
+      expect(screen.queryByTestId('generate-mock-data-modal')?.firstChild).to
+        .not.exist;
     });
 
     it('closes the modal when the close button is clicked', async () => {
       await renderModal();
 
-      expect(screen.getByTestId('generate-mock-data-modal')).to.exist;
+      expect(screen.getByTestId('generate-mock-data-modal').firstChild).to
+        .exist;
       userEvent.click(screen.getByLabelText('Close modal'));
       await waitFor(
         () =>
-          expect(screen.queryByTestId('generate-mock-data-modal')).to.not.exist
+          expect(screen.getByTestId('generate-mock-data-modal').firstChild).to
+            .not.exist
       );
     });
 
@@ -172,11 +176,13 @@ describe('MockDataGeneratorModal', () => {
     it('closes the modal when the cancel button is clicked', async () => {
       await renderModal();
 
-      expect(screen.getByTestId('generate-mock-data-modal')).to.exist;
+      expect(screen.getByTestId('generate-mock-data-modal').firstChild).to
+        .exist;
       userEvent.click(screen.getByText('Cancel'));
       await waitFor(
         () =>
-          expect(screen.queryByTestId('generate-mock-data-modal')).to.not.exist
+          expect(screen.getByTestId('generate-mock-data-modal').firstChild).to
+            .not.exist
       );
     });
 
@@ -1062,11 +1068,13 @@ describe('MockDataGeneratorModal', () => {
         },
       });
 
-      expect(screen.getByTestId('generate-mock-data-modal')).to.exist;
+      expect(screen.getByTestId('generate-mock-data-modal').firstChild).to
+        .exist;
       userEvent.click(screen.getByText('Done'));
       await waitFor(
         () =>
-          expect(screen.queryByTestId('generate-mock-data-modal')).to.not.exist
+          expect(screen.getByTestId('generate-mock-data-modal').firstChild).to
+            .not.exist
       );
     });