fix(compass-schema): limit complexity and toast for errors

paula-stacho · paula-stacho · commit d7f9ceb8bff2 · 2025-02-21T10:33:34.000+01: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.26.2",
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.3.0",
-    "mongodb-schema": "^12.3.2",
+    "mongodb-schema": "^12.4.0",
     "prop-types": "^15.7.2",
     "re-resizable": "^6.9.0",
     "react": "^17.0.2",
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.6.2",
     "hadron-app-registry": "^9.4.2",
     "lodash": "^4.17.21",
-    "mongodb-schema": "^12.3.2",
+    "mongodb-schema": "^12.4.0",
     "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.33.2",
     "hadron-app-registry": "^9.4.2",
     "mongodb": "^6.12.0",
-    "mongodb-schema": "^12.3.2",
+    "mongodb-schema": "^12.4.0",
     "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.25.2",
     "mongodb-ns": "^2.4.2",
     "mongodb-query-parser": "^4.3.0",
-    "mongodb-schema": "^12.3.2",
+    "mongodb-schema": "^12.4.0",
     "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.3.0",
     "mongodb-query-util": "^2.4.2",
-    "mongodb-schema": "^12.3.2",
+    "mongodb-schema": "^12.4.0",
     "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
@@ -92,7 +92,7 @@
     "lodash": "^4.17.21",
     "mongodb": "^6.12.0",
     "mongodb-query-util": "^2.4.2",
-    "mongodb-schema": "^12.3.2",
+    "mongodb-schema": "^12.4.0",
     "numeral": "^1.5.6",
     "prop-types": "^15.7.2",
     "react": "^17.0.2",
diff --git a/packages/compass-schema/src/components/schema-toolbar/schema-toolbar.tsx b/packages/compass-schema/src/components/schema-toolbar/schema-toolbar.tsx
@@ -11,11 +11,7 @@ import {
 } from '@mongodb-js/compass-components';
 import { usePreference } from 'compass-preferences-model/provider';
 import type { AnalysisState } from '../../constants/analysis-states';
-import {
-  ANALYSIS_STATE_ERROR,
-  ANALYSIS_STATE_TIMEOUT,
-  ANALYSIS_STATE_COMPLETE,
-} from '../../constants/analysis-states';
+import { ANALYSIS_STATE_COMPLETE } from '../../constants/analysis-states';
 import { QueryBar } from '@mongodb-js/compass-query-bar';
 
 const schemaToolbarStyles = css({
@@ -47,9 +43,6 @@ const schemaToolbarActionBarRightStyles = css({
   paddingLeft: spacing[2],
 });
 
-const ERROR_WARNING = 'An error occurred during schema analysis';
-const INCREASE_MAX_TIME_MS_HINT_MESSAGE =
-  'Operation exceeded time limit. Please try increasing the maxTimeMS for the query in the filter options.';
 const OUTDATED_WARNING_MESSAGE =
   'The schema content is outdated and no longer in sync' +
   ' with the documents view. Press "Analyze" again to see the schema for the' +
@@ -130,15 +123,6 @@ const SchemaToolbar: React.FunctionComponent<SchemaToolbarProps> = ({
           </div>
         </div>
       )}
-      {analysisState === ANALYSIS_STATE_ERROR && (
-        <ErrorSummary
-          data-testid="schema-toolbar-error-message"
-          errors={[`${ERROR_WARNING}: ${errorMessage}`]}
-        />
-      )}
-      {analysisState === ANALYSIS_STATE_TIMEOUT && (
-        <WarningSummary warnings={[INCREASE_MAX_TIME_MS_HINT_MESSAGE]} />
-      )}
       {analysisState === ANALYSIS_STATE_COMPLETE && isOutdated && (
         <WarningSummary warnings={[OUTDATED_WARNING_MESSAGE]} />
       )}
diff --git a/packages/compass-schema/src/constants/analysis-states.ts b/packages/compass-schema/src/constants/analysis-states.ts
@@ -1,12 +1,8 @@
 export const ANALYSIS_STATE_INITIAL = 'initial';
 export const ANALYSIS_STATE_ANALYZING = 'analyzing';
-export const ANALYSIS_STATE_ERROR = 'error';
 export const ANALYSIS_STATE_COMPLETE = 'complete';
-export const ANALYSIS_STATE_TIMEOUT = 'timeout';
 
 export type AnalysisState =
   | typeof ANALYSIS_STATE_INITIAL
   | typeof ANALYSIS_STATE_ANALYZING
-  | typeof ANALYSIS_STATE_ERROR
-  | typeof ANALYSIS_STATE_COMPLETE
-  | typeof ANALYSIS_STATE_TIMEOUT;
+  | typeof ANALYSIS_STATE_COMPLETE;
diff --git a/packages/compass-schema/src/modules/schema-analysis.ts b/packages/compass-schema/src/modules/schema-analysis.ts
@@ -19,6 +19,8 @@ function promoteMongoErrorCode(err?: Error & { code?: unknown }) {
     return new Error('Unknown error');
   }
 
+  console.log({ name: err.name, code: err.code });
+
   if (err.name === 'MongoError' && err.code !== undefined) {
     err.code = JSON.parse(JSON.stringify(err.code));
   }
@@ -59,6 +61,8 @@ export const analyzeSchema = async (
     );
     const schemaAccessor = await analyzeDocuments(docs, {
       signal: abortSignal,
+      storedValuesLengthLimit: 100,
+      distinctFieldsAbortThreshold: 1000,
     });
     log.info(mongoLogId(1001000090), 'Schema', 'Schema analysis completed', {
       ns,
@@ -69,6 +73,7 @@ export const analyzeSchema = async (
       ns,
       error: err.message,
     });
+    console.log('FAILED', err);
     if (dataService.isCancelError(err)) {
       debug('caught background operation terminated error', err);
       return;
diff --git a/packages/compass-schema/src/stores/schema-analysis-reducer.ts b/packages/compass-schema/src/stores/schema-analysis-reducer.ts
@@ -1,15 +1,17 @@
 import type { Schema } from 'mongodb-schema';
 import { isInternalFieldPath } from 'hadron-document';
+import {
+  openToast,
+  type ToastProperties,
+} from '@mongodb-js/compass-components';
 import type { Action, Reducer } from 'redux';
 import type { AggregateOptions } from 'mongodb';
 import type { QueryBarService } from '@mongodb-js/compass-query-bar';
 import { type AnalysisState } from '../constants/analysis-states';
 import {
   ANALYSIS_STATE_ANALYZING,
   ANALYSIS_STATE_COMPLETE,
-  ANALYSIS_STATE_ERROR,
   ANALYSIS_STATE_INITIAL,
-  ANALYSIS_STATE_TIMEOUT,
 } from '../constants/analysis-states';
 import { addLayer, generateGeoQuery } from '../modules/geo';
 import {
@@ -23,6 +25,14 @@ import type { SchemaThunkAction } from './store';
 import { UUID } from 'bson';
 import { isAction } from '../utils';
 
+const ERROR_WARNING = 'An error occurred during schema analysis';
+const COMPLEXITY_ABORT_MESSAGE = `
+Analysis was aborted due to: Fields count above 1000.
+Consider breaking up your data into more collections with smaller documents, and using references to consolidate the data you need.
+`;
+const INCREASE_MAX_TIME_MS_HINT_MESSAGE =
+  'Operation exceeded time limit. Please try increasing the maxTimeMS for the query in the filter options.';
+
 const DEFAULT_SAMPLE_SIZE = 1000;
 
 const ERROR_CODE_MAX_TIME_MS_EXPIRED = 50;
@@ -91,32 +101,34 @@ export const schemaAnalysisReducer: Reducer<SchemaAnalysisState, Action> = (
     };
   }
 
-  if (
-    isAction<AnalysisFailedAction>(action, SchemaAnalysisActions.analysisFailed)
-  ) {
-    return {
-      ...state,
-      ...getErrorState(action.error),
-      resultId: resultId(),
-    };
-  }
-
   return state;
 };
 
-function getErrorState(err: Error & { code?: number }) {
-  const errorMessage = (err && err.message) || 'Unknown error';
-  const errorCode = err && err.code;
-
-  let analysisState: AnalysisState;
-
+function getErrorDetails(
+  errorMessage: string,
+  errorCode?: number
+): Partial<ToastProperties> {
   if (errorCode === ERROR_CODE_MAX_TIME_MS_EXPIRED) {
-    analysisState = ANALYSIS_STATE_TIMEOUT;
+    return { description: INCREASE_MAX_TIME_MS_HINT_MESSAGE };
+  } else if (errorMessage.includes('Schema analysis aborted: Fields count')) {
+    return {
+      description: COMPLEXITY_ABORT_MESSAGE,
+      actionElement: `<a href="https://www.mongodb.com/cloud/atlas/lp/search-1">Learn more</a>`,
+    };
   } else {
-    analysisState = ANALYSIS_STATE_ERROR;
+    return { description: `${ERROR_WARNING}: ${errorMessage}` };
   }
+}
 
-  return { analysisState, errorMessage };
+function handleError(err: Error & { code?: number }) {
+  const errorMessage = (err && err.message) || 'Unknown error';
+  const errorCode = err && err.code;
+
+  openToast('schema-analysis-error', {
+    variant: 'important',
+    title: 'Schema Analysis Failed',
+    ...getErrorDetails(errorMessage, errorCode),
+  });
 }
 
 function resultId(): string {
@@ -345,10 +357,8 @@ export const startAnalysis = (): SchemaThunkAction<
           error: err.stack,
         }
       );
-      dispatch({
-        type: SchemaAnalysisActions.analysisFailed,
-        error: err as Error,
-      });
+      dispatch({ type: SchemaAnalysisActions.analysisFinished, schema: null });
+      handleError(err as Error);
     } finally {
       analysisAbortControllerRef.current = undefined;
     }
