fixup: use the accessors, fix e2e

Anemy · Anemy · commit d5c9b510ae03 · 2025-02-10T20:27:06.000-05:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/compass-aggregations/package.json b/packages/compass-aggregations/package.json
@@ -91,7 +91,7 @@
     "mongodb-instance-model": "^12.25.5",
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.2.3",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "prop-types": "^15.7.2",
     "re-resizable": "^6.9.0",
     "react": "^17.0.2",
diff --git a/packages/compass-e2e-tests/tests/collection-schema-tab.test.ts b/packages/compass-e2e-tests/tests/collection-schema-tab.test.ts
@@ -114,7 +114,7 @@ describe('Collection schema tab', function () {
       await browser.setFeature('enableExportSchema', true);
     });
 
-    it.only('shows an exported schema to copy', async function () {
+    it('shows an exported schema to copy', async function () {
       await browser.navigateToCollectionTab(
         DEFAULT_CONNECTION_NAME_1,
         'test',
@@ -131,16 +131,27 @@ describe('Collection schema tab', function () {
       const exportModal = browser.$(Selectors.ExportSchemaFormatOptions);
       await exportModal.waitForDisplayed();
 
-      // TODO: Check format and then change it.
-      // await browser.clickVisible(Selectors.AnalyzeSchemaButton);
-
       const exportSchemaContent = browser.$(Selectors.ExportSchemaOutput);
       await exportSchemaContent.waitForDisplayed();
-      // expect(
-      //   await browser.getCodemirrorEditorText(Selectors.ExportSchemaOutput)
-      // ).to.match(/{\s+\$set:\s+{\s+},?\s+}/);
       const text = await browser.$(Selectors.ExportSchemaOutput).getText();
-      expect(text).to.match('test');
+      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',
+          },
+        },
+      });
     });
   });
 
diff --git a/packages/compass-field-store/package.json b/packages/compass-field-store/package.json
@@ -73,7 +73,7 @@
     "@mongodb-js/compass-logging": "^1.5.5",
     "hadron-app-registry": "^9.3.5",
     "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",
diff --git a/packages/compass-generative-ai/package.json b/packages/compass-generative-ai/package.json
@@ -62,7 +62,7 @@
     "compass-preferences-model": "^2.32.5",
     "hadron-app-registry": "^9.3.5",
     "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",
diff --git a/packages/compass-import-export/package.json b/packages/compass-import-export/package.json
@@ -68,7 +68,7 @@
     "mongodb-data-service": "^22.24.5",
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.2.3",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "papaparse": "^5.3.2",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
diff --git a/packages/compass-query-bar/package.json b/packages/compass-query-bar/package.json
@@ -87,7 +87,7 @@
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.2.3",
     "mongodb-query-util": "^2.3.5",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",
     "redux": "^4.2.1",
diff --git a/packages/compass-schema/package.json b/packages/compass-schema/package.json
@@ -91,7 +91,7 @@
     "lodash": "^4.17.21",
     "mongodb": "^6.12.0",
     "mongodb-query-util": "^2.3.5",
-    "mongodb-schema": "^12.2.0",
+    "mongodb-schema": "^12.3.2",
     "numeral": "^1.5.6",
     "prop-types": "^15.7.2",
     "react": "^17.0.2",
diff --git a/packages/compass-schema/src/components/export-schema-modal.tsx b/packages/compass-schema/src/components/export-schema-modal.tsx
@@ -39,6 +39,16 @@ const contentContainerStyles = css({
   paddingBottom: spacing[400],
 });
 
+const codeStyles = css({
+  maxHeight: `${spacing[1600] * 4 - spacing[800]}px`,
+  overflow: 'auto',
+});
+
+const footerStyles = css({
+  display: 'flex',
+  gap: spacing[200],
+});
+
 const exportSchemaFormatOptions: {
   title: string;
   id: SchemaFormat;
@@ -135,7 +145,7 @@ const ExportSchemaModal: React.FunctionComponent<{
               The JSON Extended format is deprecated and will be removed in a
               future release.
             </strong>
-            We&apos;re transitioning to a better format. Discover the new
+            &nbsp;We&apos;re transitioning to a better format. Discover the new
             experience by selecting a relevant format from above.
           </Banner>
         )}
@@ -154,6 +164,7 @@ const ExportSchemaModal: React.FunctionComponent<{
               id="export-schema-content"
               data-testid="export-schema-content"
               language="json"
+              className={codeStyles}
               copyable={true}
             >
               {exportedSchema ?? 'Empty'}
@@ -169,7 +180,7 @@ const ExportSchemaModal: React.FunctionComponent<{
           )}
         </div>
       </ModalBody>
-      <ModalFooter>
+      <ModalFooter className={footerStyles}>
         <Button onClick={onClose} variant="default">
           Cancel
         </Button>
diff --git a/packages/compass-schema/src/modules/schema-analysis.spec.ts b/packages/compass-schema/src/modules/schema-analysis.spec.ts
@@ -4,6 +4,7 @@ import { expect } from 'chai';
 import mongoDBSchemaAnalyzeSchema from 'mongodb-schema';
 import type { Schema } from 'mongodb-schema';
 import { createNoopLogger } from '@mongodb-js/compass-logging/provider';
+import { isInternalFieldPath } from 'hadron-document';
 
 import {
   analyzeSchema,
@@ -159,7 +160,12 @@ describe('schema-analysis', function () {
         count: 2,
       };
 
-      expect(schema).to.deep.equal(expectedSchema);
+      const internalSchema = await schema!.getInternalSchema();
+      internalSchema.fields = internalSchema.fields.filter(
+        ({ path }) => !isInternalFieldPath(path[0])
+      );
+
+      expect(internalSchema).to.deep.equal(expectedSchema);
     });
 
     it('adds promoteValues: false so the analyzer can report more accurate types', async function () {
diff --git a/packages/compass-schema/src/modules/schema-analysis.ts b/packages/compass-schema/src/modules/schema-analysis.ts
@@ -1,6 +1,5 @@
-import { isInternalFieldPath } from 'hadron-document';
 import type { AggregateOptions, Filter, Document } from 'mongodb';
-import mongodbSchema from 'mongodb-schema';
+import { analyzeDocuments } from 'mongodb-schema';
 import type {
   Schema,
   ArraySchemaType,
@@ -36,6 +35,8 @@ function promoteMongoErrorCode(err?: Error & { code?: unknown }) {
   return err;
 }
 
+export type SchemaAccessor = Awaited<ReturnType<typeof analyzeDocuments>>;
+
 export const analyzeSchema = async (
   dataService: DataService,
   abortSignal: AbortSignal,
@@ -49,7 +50,7 @@ export const analyzeSchema = async (
     | undefined,
   aggregateOptions: AggregateOptions,
   { log, mongoLogId, debug }: Logger
-): Promise<Schema | null> => {
+): Promise<SchemaAccessor | null> => {
   try {
     log.info(mongoLogId(1001000089), 'Schema', 'Starting schema analysis', {
       ns,
@@ -66,14 +67,13 @@ export const analyzeSchema = async (
         abortSignal,
       }
     );
-    const schemaData = await mongodbSchema(docs);
-    schemaData.fields = schemaData.fields.filter(
-      ({ path }) => !isInternalFieldPath(path[0])
-    );
+    const schemaAccessor = await analyzeDocuments(docs, {
+      signal: abortSignal,
+    });
     log.info(mongoLogId(1001000090), 'Schema', 'Schema analysis completed', {
       ns,
     });
-    return schemaData;
+    return schemaAccessor;
   } catch (err: any) {
     log.error(mongoLogId(1001000091), 'Schema', 'Schema analysis failed', {
       ns,
diff --git a/packages/compass-schema/src/stores/schema-analysis-reducer.ts b/packages/compass-schema/src/stores/schema-analysis-reducer.ts
@@ -1,4 +1,5 @@
-import type { Schema } from 'mongodb-schema';
+import type { Schema, InternalSchema } from 'mongodb-schema';
+import { isInternalFieldPath } from 'hadron-document';
 import type { Action, Reducer } from 'redux';
 import { type AnalysisState } from '../constants/analysis-states';
 import {
@@ -12,6 +13,7 @@ import { addLayer, generateGeoQuery } from '../modules/geo';
 import {
   analyzeSchema,
   calculateSchemaDepth,
+  type SchemaAccessor,
   schemaContainsGeoData,
 } from '../modules/schema-analysis';
 import { capMaxTimeMSAtPreferenceLimit } from 'compass-preferences-model/provider';
@@ -30,6 +32,7 @@ export type SchemaAnalysisState = {
   analysisState: AnalysisState;
   errorMessage: string;
   schema: Schema | null;
+  schemaAccessor: SchemaAccessor | null;
   resultId: string;
 };
 
@@ -45,6 +48,7 @@ export type AnalysisStartedAction = {
 
 export type AnalysisFinishedAction = {
   type: SchemaAnalysisActions.analysisFinished;
+  schemaAccessor: SchemaAccessor | null;
   schema: Schema | null;
 };
 
@@ -68,6 +72,7 @@ export const schemaAnalysisReducer: Reducer<SchemaAnalysisState, Action> = (
       analysisState: ANALYSIS_STATE_ANALYZING,
       errorMessage: '',
       schema: null,
+      schemaAccessor: null,
     };
   }
 
@@ -83,6 +88,7 @@ export const schemaAnalysisReducer: Reducer<SchemaAnalysisState, Action> = (
         ? ANALYSIS_STATE_COMPLETE
         : ANALYSIS_STATE_INITIAL,
       schema: action.schema,
+      schemaAccessor: action.schemaAccessor,
       resultId: resultId(),
     };
   }
@@ -173,6 +179,7 @@ const getInitialState = (): SchemaAnalysisState => ({
   analysisState: ANALYSIS_STATE_INITIAL,
   errorMessage: '',
   schema: null,
+  schemaAccessor: null,
   resultId: resultId(),
 });
 
@@ -264,30 +271,41 @@ export const startAnalysis = (): SchemaThunkAction<
       maxTimeMS: capMaxTimeMSAtPreferenceLimit(preferences, query.maxTimeMS),
     };
 
+    abortControllerRef.current = new AbortController();
+    const abortSignal = abortControllerRef.current.signal;
+
     try {
       debug('analysis started');
 
-      abortControllerRef.current = new AbortController();
-      const abortSignal = abortControllerRef.current.signal;
-
       dispatch({ type: SchemaAnalysisActions.analysisStarted });
 
       const analysisStartTime = Date.now();
-      const schema = await analyzeSchema(
+      const schemaAccessor = await analyzeSchema(
         dataService,
         abortSignal,
         namespace,
         samplingOptions,
         driverOptions,
         logger
       );
+      let schema: InternalSchema | null = null;
+      if (schemaAccessor) {
+        schema = await schemaAccessor.getInternalSchema();
+        schema.fields = schema.fields.filter(
+          ({ path }) => !isInternalFieldPath(path[0])
+        );
+      }
       const analysisTime = Date.now() - analysisStartTime;
 
       if (schema !== null) {
         fieldStoreService.updateFieldsFromSchema(namespace, schema);
       }
 
-      dispatch({ type: SchemaAnalysisActions.analysisFinished, schema });
+      dispatch({
+        type: SchemaAnalysisActions.analysisFinished,
+        schema,
+        schemaAccessor,
+      });
 
       // track schema analyzed
       const trackEvent = () => ({
diff --git a/packages/compass-schema/src/stores/schema-export-reducer.ts b/packages/compass-schema/src/stores/schema-export-reducer.ts
@@ -1,8 +1,15 @@
 import type { Action, Reducer } from 'redux';
 import { mongoLogId } from '@mongodb-js/compass-logging/provider';
+import type {
+  StandardJSONSchema,
+  InternalSchema,
+  MongoDBJSONSchema,
+  ExpandedJSONSchema,
+} from 'mongodb-schema';
 
 import type { SchemaThunkAction } from './store';
 import { isAction } from '../utils';
+import type { SchemaAccessor } from '../modules/schema-analysis';
 
 export type SchemaFormat =
   | 'standardJSON'
@@ -110,6 +117,38 @@ export const cancelExportSchema = (): SchemaThunkAction<
   };
 };
 
+async function getSchemaByFormat({
+  exportFormat,
+  schemaAccessor,
+}: {
+  exportFormat: SchemaFormat;
+  schemaAccessor: SchemaAccessor;
+  signal: AbortSignal;
+}): Promise<string> {
+  // TODO: Use the signal once we pull in the schema accessor type changes.
+  let schema:
+    | StandardJSONSchema
+    | MongoDBJSONSchema
+    | ExpandedJSONSchema
+    | InternalSchema;
+  switch (exportFormat) {
+    case 'standardJSON':
+      schema = await schemaAccessor.getStandardJsonSchema();
+      break;
+    case 'mongoDBJSON':
+      schema = await schemaAccessor.getMongoDBJsonSchema();
+      break;
+    case 'extendedJSON':
+      schema = await schemaAccessor.getExpandedJSONSchema();
+      break;
+    case 'legacyJSON':
+      schema = await schemaAccessor.getInternalSchema();
+      break;
+  }
+
+  return JSON.stringify(schema, null, 2);
+}
+
 export const changeExportSchemaFormat = (
   exportFormat: SchemaFormat
 ): SchemaThunkAction<
@@ -145,10 +184,16 @@ export const changeExportSchemaFormat = (
         }
       );
 
-      // TODO.
-      await new Promise((resolve) => setTimeout(resolve, 1000));
+      const schemaAccessor = getState().schemaAnalysis.schemaAccessor;
+      if (!schemaAccessor) {
+        throw new Error('No schema analysis available');
+      }
 
-      exportedSchema = JSON.stringify(getState().schemaAnalysis.schema);
+      exportedSchema = await getSchemaByFormat({
+        schemaAccessor,
+        exportFormat,
+        signal: abortController.signal,
+      });
     } catch (err: any) {
       if (abortController.signal.aborted) {
         return;
diff --git a/packages/compass-schema/src/stores/store.spec.ts b/packages/compass-schema/src/stores/store.spec.ts
