feat(schema): add schema export modal, feature flag gated COMPASS-8703 (#6668)

Author: Anemy

package-lock.json

@@ -91,7 +91,7 @@
     "mongodb-instance-model": "^12.26.0",
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.3.0",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "prop-types": "^15.7.2",
     "re-resizable": "^6.9.0",
     "react": "^17.0.2",

packages/compass-aggregations/package.json

@@ -1011,6 +1011,10 @@ export const AggregationWizardSortFormDirectionSelect = (idx: number) =>
 
 // Schema tab
 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 ExportSchemaOutput = '[data-testid="export-schema-content"]';
 export const SchemaFieldList = '[data-testid="schema-field-list"]';
 export const AnalysisMessage =
   '[data-testid="schema-content"] [data-testid="schema-analysis-message"]';

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

@@ -109,6 +109,54 @@ describe('Collection schema tab', function () {
     });
   }
 
+  describe('with the enableExportSchema feature flag enabled', function () {
+    beforeEach(async function () {
+      // TODO(COMPASS-8819): remove web skip when defaulted true.
+      skipForWeb(this, "can't toggle features in compass-web");
+      await browser.setFeature('enableExportSchema', true);
+    });
+
+    it('shows an exported schema to copy', 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();
+
+      const exportSchemaContent = browser.$(Selectors.ExportSchemaOutput);
+      await exportSchemaContent.waitForDisplayed();
+      const text = await browser.$(Selectors.ExportSchemaOutput).getText();
+      const parsedText = JSON.parse(text);
+      delete parsedText.$defs;
+      expect(parsedText).to.deep.equal({
+        $schema: 'https://json-schema.org/draft/2020-12/schema',
+        type: 'object',
+        required: ['_id', 'i', 'j'],
+        properties: {
+          _id: {
+            $ref: '#/$defs/ObjectId',
+          },
+          i: {
+            type: 'integer',
+          },
+          j: {
+            type: 'integer',
+          },
+        },
+      });
+    });
+  });
+
   it('analyzes the schema with a query');
   it('can reset the query');
   it('can create a geoquery from a map');

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

@@ -73,7 +73,7 @@
     "@mongodb-js/compass-logging": "^1.6.0",
     "hadron-app-registry": "^9.4.0",
     "lodash": "^4.17.21",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
     "redux": "^4.2.1",

packages/compass-field-store/package.json

@@ -62,7 +62,7 @@
     "compass-preferences-model": "^2.33.0",
     "hadron-app-registry": "^9.4.0",
     "mongodb": "^6.12.0",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
     "redux": "^4.2.1",

packages/compass-generative-ai/package.json

@@ -68,7 +68,7 @@
     "mongodb-data-service": "^22.25.0",
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.3.0",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "papaparse": "^5.3.2",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",

packages/compass-import-export/package.json

@@ -17,6 +17,7 @@ export type FeatureFlags = {
   enableOidc: boolean; // Not capitalized "OIDC" for spawn arg casing.
   newExplainPlan: boolean;
   showInsights: boolean;
+  enableExportSchema: boolean;
   enableRenameCollectionModal: boolean;
   enableQueryHistoryAutocomplete: boolean;
   enableProxySupport: boolean;
@@ -100,4 +101,14 @@ export const featureFlags: Required<{
       short: 'Enable Global Writes tab in Atlas Cloud',
     },
   },
+
+  /**
+   * Feature flag for export schema. Epic: COMPASS-6862.
+   */
+  enableExportSchema: {
+    stage: 'development',
+    description: {
+      short: 'Enable schema export',
+    },
+  },
 };

packages/compass-preferences-model/src/feature-flags.ts

@@ -87,7 +87,7 @@
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.3.0",
     "mongodb-query-util": "^2.4.0",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
     "redux": "^4.2.1",

packages/compass-query-bar/package.json

@@ -91,7 +91,7 @@
     "lodash": "^4.17.21",
     "mongodb": "^6.12.0",
     "mongodb-query-util": "^2.4.0",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "numeral": "^1.5.6",
     "prop-types": "^15.7.2",
     "react": "^17.0.2",