chore(compass-e2e-tests): Add tests for "Export aggregation" feature COMPASS-5822 (#3116)

* chore(compass-e2e-tests): Add tests for "Export aggregation" feature

* chore(compass-e2e-tests): Relax error message check to cover different server versions

* chore(compass-e2e-tests): Simplify regex even more

Author: gribnoysup

packages/compass-e2e-tests/helpers/commands/index.ts

@@ -39,3 +39,4 @@ export * from './navigate-to-connect-tab';
 export * from './expand-connect-form-options';
 export * from './reset-connect-form';
 export * from './scroll-to-virtual-item';
+export * from './set-export-filename';

packages/compass-e2e-tests/helpers/commands/set-export-filename.ts

@@ -0,0 +1,27 @@
+import chai, { expect } from 'chai';
+import { promises as fs } from 'fs';
+import type { CompassBrowser } from '../compass-browser';
+import * as Selectors from '../selectors';
+import chaiAsPromised from 'chai-as-promised';
+
+chai.use(chaiAsPromised);
+
+export async function setExportFilename(
+  browser: CompassBrowser,
+  filename: string
+): Promise<void> {
+  // make sure the file doesn't already exist
+  await expect(fs.stat(filename)).to.be.rejected;
+
+  await browser.execute(function (f) {
+    document.dispatchEvent(
+      new CustomEvent('selectExportFileName', { detail: f })
+    );
+  }, filename);
+
+  await browser.waitUntil(async () => {
+    const exportModalFileText = await browser.$(Selectors.ExportModalFileText);
+    const value = await exportModalFileText.getValue();
+    return value === filename;
+  });
+}

packages/compass-e2e-tests/helpers/selectors.ts

@@ -625,10 +625,14 @@ export const SavePipelineMenuContent = '[data-testid="save-menu-content"]';
 export const SavePipelineCreateViewAction =
   '[data-testid="save-menu-createView"]';
 export const SavePipelineSaveAsAction = '[data-testid="save-menu-saveAs"]';
+export const AggregationAutoPreviewToggle =
+  '[data-testid="pipeline-toolbar-preview-toggle"]';
+export const AggregationErrorBanner = '[data-testid="pipeline-results-error"]';
 
 export const RunPipelineButton = `[data-testid="pipeline-toolbar-run-button"]`;
 export const EditPipelineButton = `[data-testid="pipeline-toolbar-edit-button"]`;
 export const GoToCollectionButton = `[data-testid="pipeline-results-go-to-collection"]`;
+export const ExportAggregationResultsButton = `[data-testid="pipeline-toolbar-export-aggregation-button"]`;
 
 // New Aggregation Toolbar Specific
 export const AggregationToolbarCreateMenu = '[data-testid="create-new-menu"]';

packages/compass-e2e-tests/tests/collection-aggregations-tab.test.ts

@@ -1,8 +1,14 @@
 import chai from 'chai';
 import semver from 'semver';
 import type { Element } from 'webdriverio';
+import { promises as fs } from 'fs';
 import type { CompassBrowser } from '../helpers/compass-browser';
-import { beforeTests, afterTests, afterTest } from '../helpers/compass';
+import {
+  beforeTests,
+  afterTests,
+  afterTest,
+  outputFilename,
+} from '../helpers/compass';
 import type { Compass } from '../helpers/compass';
 import { MONGODB_VERSION } from '../helpers/compass';
 import * as Selectors from '../helpers/selectors';
@@ -703,6 +709,64 @@ describe('Collection aggregations tab', function () {
     await emptyResultsBanner.waitForDisplayed();
   });
 
+  it('handles errors in aggregations', async function () {
+    // Disable autopreview so we can run an aggregation that will cause an error
+    await browser.clickVisible(Selectors.AggregationAutoPreviewToggle);
+
+    // Set first stage to an invalid $project stage to trigger server error
+    await browser.focusStageOperator(0);
+    await browser.selectStageOperator(0, '$project');
+    await browser.setAceValue(Selectors.stageEditor(0), '{}');
+
+    // Run and wait for results
+    await goToRunAggregation();
+
+    const errorBanner = await browser.$(Selectors.AggregationErrorBanner);
+    await errorBanner.waitForDisplayed();
+    const errorText = await errorBanner.getText();
+
+    expect(errorText).to.match(
+      /(\$project )?specification must have at least one field/
+    );
+  });
+
+  it('supports exporting aggregation results', async function () {
+    // Set first stage to $match
+    await browser.focusStageOperator(0);
+    await browser.selectStageOperator(0, '$match');
+    await browser.setAceValue(Selectors.stageEditor(0), '{ i: 5 }');
+
+    // Open the modal
+    await browser.clickVisible(Selectors.ExportAggregationResultsButton);
+    const exportModal = await browser.$(Selectors.ExportModal);
+    await exportModal.waitForDisplayed();
+
+    // Set filename
+    const filename = outputFilename('aggregated-numbers.json');
+    await browser.setExportFilename(filename);
+
+    // Start export and wait for results
+    await browser.clickVisible(Selectors.ExportModalExportButton);
+    const exportModalShowFileButtonElement = await browser.$(
+      Selectors.ExportModalShowFileButton
+    );
+    await exportModalShowFileButtonElement.waitForDisplayed();
+
+    // Close modal
+    await browser.clickVisible(Selectors.ExportModalCloseButton);
+    const exportModalElement = await browser.$(Selectors.ExportModal);
+    await exportModalElement.waitForDisplayed({ reverse: true });
+
+    // Confirm that we exported what we expected to export
+    const text = await fs.readFile(filename, 'utf-8');
+    const docs = JSON.parse(text);
+
+    expect(docs).to.have.lengthOf(1);
+    expect(docs[0]).to.have.property('_id');
+    expect(docs[0]).to.have.property('i', 5);
+    expect(docs[0]).to.have.property('j', 0);
+  });
+
   // TODO: stages can be re-arranged by drag and drop and the preview is refreshed after rearranging them
   // TODO: test auto-preview and limit
   // TODO: save a pipeline, close compass, re-open compass, load the pipeline

packages/compass-e2e-tests/tests/collection-export.test.ts

@@ -1,6 +1,5 @@
 import { promises as fs } from 'fs';
-import chai from 'chai';
-import chaiAsPromised from 'chai-as-promised';
+import { expect } from 'chai';
 import type { CompassBrowser } from '../helpers/compass-browser';
 import { startTelemetryServer } from '../helpers/telemetry';
 import type { Telemetry } from '../helpers/telemetry';
@@ -14,10 +13,6 @@ import type { Compass } from '../helpers/compass';
 import * as Selectors from '../helpers/selectors';
 import { createNumbersCollection } from '../helpers/insert-data';
 
-chai.use(chaiAsPromised);
-
-const { expect } = chai;
-
 async function selectExportFileTypeCSV(browser: CompassBrowser) {
   // select csv (unselected at first, selected by the end)
   await browser.clickVisible(
@@ -29,25 +24,6 @@ async function selectExportFileTypeCSV(browser: CompassBrowser) {
   await selectExportFileTypeButtonElement.waitForDisplayed();
 }
 
-async function setExportFilename(browser: CompassBrowser, filename: string) {
-  // make sure the file doesn't already exist
-  await expect(fs.stat(filename)).to.be.rejected;
-
-  await browser.execute(function (f) {
-    // eslint-disable-next-line no-undef
-    document.dispatchEvent(
-      // eslint-disable-next-line no-undef
-      new CustomEvent('selectExportFileName', { detail: f })
-    );
-  }, filename);
-
-  await browser.waitUntil(async () => {
-    const exportModalFileText = await browser.$(Selectors.ExportModalFileText);
-    const value = await exportModalFileText.getValue();
-    return value === filename;
-  });
-}
-
 describe('Collection export', function () {
   let compass: Compass;
   let browser: CompassBrowser;
@@ -103,7 +79,7 @@ describe('Collection export', function () {
     // select CSV
     await selectExportFileTypeCSV(browser);
     const filename = outputFilename('filtered-numbers.csv');
-    await setExportFilename(browser, filename);
+    await browser.setExportFilename(filename);
     await browser.clickVisible(Selectors.ExportModalExportButton);
 
     // wait for it to finish
@@ -176,7 +152,7 @@ describe('Collection export', function () {
     // CSV file type
     await selectExportFileTypeCSV(browser);
     const filename = outputFilename('all-numbers.csv');
-    await setExportFilename(browser, filename);
+    await browser.setExportFilename(filename);
     await browser.clickVisible(Selectors.ExportModalExportButton);
 
     // wait for it to finish, then close the modal
@@ -236,7 +212,7 @@ describe('Collection export', function () {
     // CSV file type
     await selectExportFileTypeCSV(browser);
     const filename = outputFilename('numbers-only.csv');
-    await setExportFilename(browser, filename);
+    await browser.setExportFilename(filename);
     await browser.clickVisible(Selectors.ExportModalExportButton);
 
     // wait for it to finish
@@ -303,7 +279,7 @@ describe('Collection export', function () {
 
     // leave the file type on the default (JSON)
     const filename = outputFilename('filtered-numbers.json');
-    await setExportFilename(browser, filename);
+    await browser.setExportFilename(filename);
     await browser.clickVisible(Selectors.ExportModalExportButton);
 
     // wait for it to finish
@@ -374,7 +350,7 @@ describe('Collection export', function () {
 
     // go with the default file type (JSON)
     const filename = outputFilename('all-numbers.json');
-    await setExportFilename(browser, filename);
+    await browser.setExportFilename(filename);
     await browser.clickVisible(Selectors.ExportModalExportButton);
 
     // wait for it to finish, then close the modal
@@ -432,7 +408,7 @@ describe('Collection export', function () {
 
     // go with the default file type (JSON)
     const filename = outputFilename('numbers-only.json');
-    await setExportFilename(browser, filename);
+    await browser.setExportFilename(filename);
     await browser.clickVisible(Selectors.ExportModalExportButton);
 
     // wait for it to finish