add e2e test

Author: paula-stacho

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

@@ -2,7 +2,6 @@ import { inspect } from 'util';
 import { ObjectId, EJSON } from 'bson';
 import { promises as fs, rmdirSync } from 'fs';
 import type Mocha from 'mocha';
-import path from 'path';
 import os from 'os';
 import { execFile } from 'child_process';
 import type { ExecFileOptions, ExecFileException } from 'child_process';
@@ -42,6 +41,8 @@ import {
   ELECTRON_PATH,
 } from './test-runner-paths';
 import treeKill from 'tree-kill';
+import { downloadPath } from './downloads';
+import path from 'path';
 
 const killAsync = async (pid: number, signal?: string) => {
   return new Promise<void>((resolve, reject) => {
@@ -677,6 +678,13 @@ async function startCompassElectron(
 
   try {
     browser = (await remote(options)) as CompassBrowser;
+    // https://webdriver.io/docs/best-practices/file-download/#configuring-chromium-browser-downloads
+    const page = await browser.getPuppeteer();
+    const cdpSession = await page.target().createCDPSession();
+    await cdpSession.send('Browser.setDownloadBehavior', {
+      behavior: 'allow',
+      downloadPath: downloadPath,
+    });
   } catch (err) {
     debug('Failed to start remote webdriver session', {
       error: (err as Error).stack,
@@ -755,6 +763,26 @@ export async function startBrowser(
   runCounter++;
   const { webdriverOptions, wdioOptions } = await processCommonOpts();
 
+  const browserCapabilities: Record<string, Record<string, unknown>> = {
+    chrome: {
+      'goog:chromeOptions': {
+        prefs: {
+          'download.default_directory': downloadPath,
+        },
+      },
+    },
+    firefox: {
+      'moz:firefoxOptions': {
+        prefs: {
+          'browser.download.dir': downloadPath,
+          'browser.download.folderList': 2,
+          'browser.download.manager.showWhenStarting': false,
+          'browser.helperApps.neverAsk.saveToDisk': '*/*',
+        },
+      },
+    },
+  };
+
   // webdriverio removed RemoteOptions. It is now
   // Capabilities.WebdriverIOConfig, but Capabilities is not exported
   const options = {
@@ -763,6 +791,7 @@ export async function startBrowser(
       ...(context.browserVersion && {
         browserVersion: context.browserVersion,
       }),
+      ...browserCapabilities[context.browserName],
 
       // from https://github.com/webdriverio-community/wdio-electron-service/blob/32457f60382cb4970c37c7f0a19f2907aaa32443/packages/wdio-electron-service/src/launcher.ts#L102
       'wdio:enforceWebDriverClassic': true,

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

@@ -0,0 +1,33 @@
+import path from 'path';
+import fs from 'fs';
+
+export const downloadPath = path.join(__dirname, 'downloads');
+
+export const waitForFileDownload = async (
+  filename: string,
+  browser: WebdriverIO.Browser
+): Promise<{
+  fileExists: boolean;
+  filePath: string;
+}> => {
+  const filePath = `${downloadPath}/${filename}`;
+  await browser.waitUntil(
+    function () {
+      return fs.existsSync(filePath);
+    },
+    { timeout: 3000, timeoutMsg: 'file not downloaded yet.' }
+  );
+
+  return { fileExists: fs.existsSync(filePath), filePath };
+};
+
+export const cleanUpDownloadedFile = (filename: string) => {
+  const filePath = `${downloadPath}/${filename}`;
+  try {
+    if (fs.existsSync(filePath)) {
+      fs.unlinkSync(filePath);
+    }
+  } catch (err) {
+    console.error(`Error deleting file: ${(err as Error).message}`);
+  }
+};

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

@@ -1025,7 +1025,12 @@ export const AnalyzeSchemaButton = '[data-testid="analyze-schema-button"]';
 export const ExportSchemaButton = '[data-testid="open-schema-export-button"]';
 export const ExportSchemaFormatOptions =
   '[data-testid="export-schema-format-type-box-group"]';
+export const exportSchemaFormatOption = (
+  option: 'standardJSON' | 'mongoDBJSON' | 'extendedJSON'
+) => `[data-testid="export-schema-format-${option}-button"]`;
 export const ExportSchemaOutput = '[data-testid="export-schema-content"]';
+export const ExportSchemaDownloadButton =
+  '[data-testid="schema-export-download-button"]';
 export const SchemaFieldList = '[data-testid="schema-field-list"]';
 export const AnalysisMessage =
   '[data-testid="schema-content"] [data-testid="schema-analysis-message"]';

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

@@ -13,6 +13,11 @@ import {
   createGeospatialCollection,
   createNumbersCollection,
 } from '../helpers/insert-data';
+import {
+  cleanUpDownloadedFile,
+  waitForFileDownload,
+} from '../helpers/downloads';
+import { readFileSync } from 'fs';
 
 const { expect } = chai;
 
@@ -116,7 +121,17 @@ describe('Collection schema tab', function () {
       await browser.setFeature('enableExportSchema', true);
     });
 
-    it('shows an exported schema to copy', async function () {
+    const filename = 'schema-test-numbers-standardJSON.json';
+
+    before(() => {
+      cleanUpDownloadedFile(filename);
+    });
+
+    after(() => {
+      cleanUpDownloadedFile(filename);
+    });
+
+    it('shows an exported schema to copy (standard JSON Schema)', async function () {
       await browser.navigateToCollectionTab(
         DEFAULT_CONNECTION_NAME_1,
         'test',
@@ -157,6 +172,57 @@ describe('Collection schema tab', function () {
         },
       });
     });
+
+    it('can download schema (MongoDB $jsonSchema)', async function () {
+      await browser.navigateToCollectionTab(
+        DEFAULT_CONNECTION_NAME_1,
+        'test',
+        'numbers',
+        'Schema'
+      );
+      await browser.clickVisible(Selectors.AnalyzeSchemaButton);
+
+      const element = browser.$(Selectors.SchemaFieldList);
+      await element.waitForDisplayed();
+
+      await browser.clickVisible(Selectors.ExportSchemaButton);
+
+      const exportModal = browser.$(Selectors.ExportSchemaFormatOptions);
+      await exportModal.waitForDisplayed();
+
+      await browser.clickVisible(
+        Selectors.exportSchemaFormatOption('mongoDBJSON')
+      );
+
+      const exportSchemaButton = browser.$(
+        Selectors.ExportSchemaDownloadButton
+      );
+      await exportSchemaButton.waitForEnabled();
+      await exportSchemaButton.click();
+
+      const { fileExists, filePath } = await waitForFileDownload(
+        filename,
+        browser
+      );
+      expect(fileExists).to.be.true;
+
+      const content = readFileSync(filePath, 'utf-8');
+      expect(JSON.parse(content)).to.deep.equal({
+        bsonType: 'object',
+        required: ['_id', 'i', 'j'],
+        properties: {
+          _id: {
+            bsonType: 'objectId',
+          },
+          i: {
+            bsonType: 'int',
+          },
+          j: {
+            bsonType: 'int',
+          },
+        },
+      });
+    });
   });
 
   it('analyzes the schema with a query');

packages/compass-schema/src/components/export-schema-modal.tsx

@@ -14,7 +14,6 @@ import {
   ErrorSummary,
   Label,
   CancelLoader,
-  Link,
   SpinLoader,
 } from '@mongodb-js/compass-components';
 import { CodemirrorMultilineEditor } from '@mongodb-js/compass-editor';
@@ -190,17 +189,18 @@ const ExportSchemaModal: React.FunctionComponent<{
         <Button onClick={onClose} variant="default">
           Cancel
         </Button>
-          <Button
-            variant="primary"
-            isLoading={!downloadUrl}
-            loadingIndicator={<SpinLoader />}
-            disabled={!exportedSchema}
-             download={filename}
-             href={downloadUrl}
-             onClick={onExportedSchema}
-          >
-            Export
-          </Button>
+        <Button
+          variant="primary"
+          isLoading={!downloadUrl}
+          loadingIndicator={<SpinLoader />}
+          disabled={!exportedSchema}
+          download={filename}
+          href={downloadUrl}
+          onClick={onExportedSchema}
+          data-testid="schema-export-download-button"
+        >
+          Export
+        </Button>
       </ModalFooter>
     </Modal>
   );

packages/compass-schema/src/stores/schema-export-reducer.ts

@@ -156,7 +156,7 @@ async function getSchemaByFormat({
       break;
   }
 
-  JSON.stringify(schema, null, 2);
+  return JSON.stringify(schema, null, 2);
 }
 
 const _trackSchemaExportFailed = (stage: string): SchemaThunkAction<void> => {
@@ -235,14 +235,17 @@ const prepareDownload = (): SchemaThunkAction<void> => {
       const blob = new Blob([exportedSchema], {
         type: 'application/json',
       });
-      const filename = `schema-${exportFormat}-${namespace}.json`;
+      const filename = `schema-${namespace.replace(
+        '.',
+        '-'
+      )}-${exportFormat}.json`;
       dispatch({
         type: SchemaExportActions.schemaDownloadReady,
         blob,
         filename,
       });
     } catch (error) {
-      _trackSchemaExportFailed('prepareDownload');
+      dispatch(_trackSchemaExportFailed('prepareDownload'));
     }
   };
 };
@@ -309,7 +312,7 @@ export const changeExportSchemaFormat = (
         type: SchemaExportActions.changeExportSchemaFormatError,
         errorMessage: (err as Error).message,
       });
-      _trackSchemaExportFailed('changeExportFormat');
+      dispatch(_trackSchemaExportFailed('changeExportFormat'));
       return;
     }
 

packages/compass-schema/src/stores/store.spec.ts

@@ -158,8 +158,13 @@ describe('Schema Store', function () {
               'complete'
             );
           });
-          const { exportStatus, errorMessage, exportedSchema } =
-            store.getState().schemaExport;
+          const {
+            exportStatus,
+            errorMessage,
+            exportedSchema,
+            filename,
+            blobToDownload,
+          } = store.getState().schemaExport;
           expect(exportStatus).to.equal('complete');
           expect(!!errorMessage).to.be.false;
           expect(exportedSchema).not.to.be.undefined;
@@ -171,14 +176,23 @@ describe('Schema Store', function () {
           expect(JSON.parse(exportedSchema!).properties).to.deep.equal({
             name: { type: 'string' },
           });
+          expect(filename).to.equal('schema-db-coll-standardJSON.json');
+          expect(blobToDownload).to.be.a('Blob');
+          expect(blobToDownload?.type).to.equal('application/json');
+          expect(blobToDownload?.size).to.be.greaterThan(0);
         });
 
         it('runs schema export formatting with a new format', async function () {
           sampleStub.resolves([{ name: 'Hans' }, { name: 'Greta' }]);
           await store.dispatch(changeExportSchemaFormat('mongoDBJSON'));
           expect(sampleStub).to.have.been.called;
-          const { exportStatus, errorMessage, exportedSchema } =
-            store.getState().schemaExport;
+          const {
+            exportStatus,
+            errorMessage,
+            exportedSchema,
+            filename,
+            blobToDownload,
+          } = store.getState().schemaExport;
           expect(exportStatus).to.equal('complete');
           expect(!!errorMessage).to.be.false;
           expect(exportedSchema).not.to.be.undefined;
@@ -189,6 +203,10 @@ describe('Schema Store', function () {
           expect(JSON.parse(exportedSchema!).properties).to.deep.equal({
             name: { bsonType: 'string' },
           });
+          expect(filename).to.equal('schema-db-coll-mongoDBJSON.json');
+          expect(blobToDownload).to.be.a('Blob');
+          expect(blobToDownload?.type).to.equal('application/json');
+          expect(blobToDownload?.size).to.be.greaterThan(0);
         });
       });
     });