chore(compass-aggregations): stricter validation for configureStore method COMPASS-6462 COMPASS-6563 (#4124)

* chore(compass-aggregations): avoid loading pipeline from disk multiple times; add options to set initial pipeline value; fix sourcePipeline handling

* chore(compass-aggregations): stricter validation and types for createStore method

* chore(compass-aggregations): small tweaks to option descriptions

Author: gribnoysup

packages/compass-aggregations/src/components/aggregations/aggregations.spec.jsx

@@ -3,7 +3,7 @@ import { mount } from 'enzyme';
 import { expect } from 'chai';
 
 import Aggregations from '../aggregations';
-import configureStore from '../../stores';
+import configureStore from '../../../test/configure-store';
 import styles from './aggregations.module.less';
 import { Provider } from 'react-redux';
 

packages/compass-aggregations/src/components/focus-mode/focus-mode-stage-editor.spec.tsx

@@ -4,7 +4,7 @@ import { render, screen } from '@testing-library/react';
 import { expect } from 'chai';
 import { Provider } from 'react-redux';
 
-import configureStore from '../../stores/store';
+import configureStore from '../../../test/configure-store';
 import { FocusModeStageEditor } from './focus-mode-stage-editor';
 
 const renderFocusModeStageEditor = (
@@ -13,11 +13,7 @@ const renderFocusModeStageEditor = (
   render(
     <Provider
       store={configureStore({
-        sourcePipeline: [
-          { $match: { _id: 1 } },
-          { $limit: 10 },
-          { $out: 'out' },
-        ],
+        pipeline: [{ $match: { _id: 1 } }, { $limit: 10 }, { $out: 'out' }],
       })}
     >
       <FocusModeStageEditor index={-1} operator={null} {...props} />

packages/compass-aggregations/src/components/focus-mode/focus-mode-stage-preview.spec.tsx

@@ -13,18 +13,18 @@ import {
   OUT_STAGE_PREVIEW_TEXT,
 } from '../../constants';
 
-import configureStore from '../../stores/store';
+import configureStore from '../../../test/configure-store';
 
 const DEFAULT_PIPELINE: Document[] = [{ $match: { _id: 1 } }, { $limit: 10 }];
 
 const renderFocusModePreview = (
   props: Partial<ComponentProps<typeof FocusModePreview>> = {},
-  sourcePipeline = DEFAULT_PIPELINE
+  pipeline = DEFAULT_PIPELINE
 ) => {
   render(
     <Provider
       store={configureStore({
-        sourcePipeline,
+        pipeline,
       })}
     >
       <FocusModePreview

packages/compass-aggregations/src/components/focus-mode/focus-mode.spec.tsx

@@ -5,7 +5,7 @@ import { expect } from 'chai';
 import { Provider } from 'react-redux';
 import sinon from 'sinon';
 
-import configureStore from '../../stores/store';
+import configureStore from '../../../test/configure-store';
 import { FocusMode } from './focus-mode';
 
 const renderFocusMode = (
@@ -14,11 +14,7 @@ const renderFocusMode = (
   render(
     <Provider
       store={configureStore({
-        sourcePipeline: [
-          { $match: { _id: 1 } },
-          { $limit: 10 },
-          { $out: 'out' },
-        ],
+        pipeline: [{ $match: { _id: 1 } }, { $limit: 10 }, { $out: 'out' }],
       })}
     >
       <FocusMode

packages/compass-aggregations/src/components/pipeline-builder-workspace/pipeline-as-text-workspace/index.spec.tsx

@@ -4,15 +4,15 @@ import { render, screen } from '@testing-library/react';
 import { expect } from 'chai';
 import { Provider } from 'react-redux';
 
-import configureStore from '../../../stores/store';
+import configureStore from '../../../../test/configure-store';
 
 import { PipelineAsTextWorkspace } from '.';
 
 const renderPipelineAsTextWorkspace = (
   props: Partial<ComponentProps<typeof PipelineAsTextWorkspace>> = {}
 ) => {
   render(
-    <Provider store={configureStore({})}>
+    <Provider store={configureStore()}>
       <PipelineAsTextWorkspace isAutoPreview={true} {...props} />
     </Provider>
   );

packages/compass-aggregations/src/components/pipeline-builder-workspace/pipeline-as-text-workspace/pipeline-editor.spec.tsx

@@ -5,7 +5,7 @@ import { MongoServerError } from 'mongodb';
 import { expect } from 'chai';
 import { Provider } from 'react-redux';
 
-import configureStore from '../../../stores/store';
+import configureStore from '../../../../test/configure-store';
 
 import { PipelineEditor } from './pipeline-editor';
 import { PipelineParserError } from '../../../modules/pipeline-builder/pipeline-parser/utils';
@@ -14,7 +14,7 @@ const renderPipelineEditor = (
   props: Partial<ComponentProps<typeof PipelineEditor>> = {}
 ) => {
   render(
-    <Provider store={configureStore({})}>
+    <Provider store={configureStore()}>
       <PipelineEditor
         pipelineText="[{$match: {}}]"
         syntaxErrors={[]}

packages/compass-aggregations/src/components/pipeline-builder-workspace/pipeline-as-text-workspace/pipeline-preview.spec.tsx

@@ -5,7 +5,7 @@ import { expect } from 'chai';
 import { Provider } from 'react-redux';
 import userEvent from '@testing-library/user-event';
 
-import configureStore from '../../../stores/store';
+import configureStore from '../../../../test/configure-store';
 
 import { PipelinePreview } from './pipeline-preview';
 
@@ -142,7 +142,7 @@ describe('PipelinePreview', function () {
         isOutStage: true,
       },
       {
-        sourcePipeline: `[{$limit: 20}, {$out: "users"}]`,
+        pipeline: [{ $limit: 20 }, { $out: 'users' }],
       }
     );
 

packages/compass-aggregations/src/components/pipeline-builder-workspace/pipeline-as-text-workspace/pipeline-stages-preview.spec.tsx

@@ -6,15 +6,15 @@ import sinon from 'sinon';
 import { Provider } from 'react-redux';
 import userEvent from '@testing-library/user-event';
 
-import configureStore from '../../../stores/store';
+import configureStore from '../../../../test/configure-store';
 
 import { OutputStagePreview } from './pipeline-stages-preview';
 
 const renderStageBanner = (
   props: Partial<ComponentProps<typeof OutputStagePreview>> = {}
 ) => {
   render(
-    <Provider store={configureStore({})}>
+    <Provider store={configureStore()}>
       <OutputStagePreview
         stageOperator="$out"
         isAtlas={false}

packages/compass-aggregations/src/components/pipeline-builder-workspace/pipeline-builder-ui-workspace.spec.jsx

@@ -2,7 +2,7 @@ import React from 'react';
 import { render, screen } from '@testing-library/react';
 import { expect } from 'chai';
 import { Provider } from 'react-redux';
-import configureStore from '../../stores/store';
+import configureStore from '../../../test/configure-store';
 import PipelineBuilderUIWorkspace from './pipeline-builder-ui-workspace';
 
 const SOURCE_PIPELINE = [
@@ -15,7 +15,7 @@ const renderPipelineBuilderUIWorkspace = (props = {}, options = {}) => {
   render(
     <Provider
       store={configureStore({
-        sourcePipeline: SOURCE_PIPELINE,
+        pipeline: SOURCE_PIPELINE,
         ...options,
       })}
     >
@@ -91,24 +91,24 @@ describe('PipelineBuilderUIWorkspace [Component]', function () {
 
   context('when pipeline is empty', function () {
     it('does not render any stage', function () {
-      renderPipelineBuilderUIWorkspace({}, { sourcePipeline: [] });
+      renderPipelineBuilderUIWorkspace({}, { pipeline: [] });
       expect(screen.queryByTestId('stage-card')).to.not.exist;
     });
 
     it('does not render icon buttons', function () {
-      renderPipelineBuilderUIWorkspace({}, { sourcePipeline: [] });
+      renderPipelineBuilderUIWorkspace({}, { pipeline: [] });
       expect(screen.queryByTestId('add-stage-icon-button')).to.not.exist;
     });
 
     it('renders (text) add stage button', function () {
-      renderPipelineBuilderUIWorkspace({}, { sourcePipeline: [] });
+      renderPipelineBuilderUIWorkspace({}, { pipeline: [] });
       const button = screen.getByTestId('add-stage');
       expect(button).to.exist;
       expect(button).to.have.text('Add Stage');
     });
 
     it('adds a stage when (text) button is clicked', function () {
-      renderPipelineBuilderUIWorkspace({}, { sourcePipeline: [] });
+      renderPipelineBuilderUIWorkspace({}, { pipeline: [] });
       const button = screen.getByTestId('add-stage');
       button.click();
       expect(screen.getAllByTestId('stage-card')).to.have.lengthOf(1);

packages/compass-aggregations/src/components/pipeline-builder-workspace/pipeline-builder-workspace.spec.tsx

@@ -3,14 +3,14 @@ import { Provider } from 'react-redux';
 import type { ComponentProps } from 'react';
 import { render, screen, within } from '@testing-library/react';
 import { expect } from 'chai';
-import configureStore from '../../stores/store';
+import configureStore from '../../../test/configure-store';
 import { PipelineBuilderWorkspace } from './pipeline-builder-workspace';
 
 const renderBuilderWorkspace = (
   props: Partial<ComponentProps<typeof PipelineBuilderWorkspace>> = {}
 ) => {
   return render(
-    <Provider store={configureStore({})}>
+    <Provider store={configureStore()}>
       <PipelineBuilderWorkspace pipelineMode="as-text" {...props} />
     </Provider>
   );