use .sample and add more precise error typing and handling

Author: ncarbon

package-lock.json

@@ -59,6 +59,7 @@
     "@mongodb-js/mongodb-constants": "^0.12.2",
     "compass-preferences-model": "^2.49.0",
     "hadron-document": "^8.9.4",
+    "mongodb": "^6.18.0",
     "mongodb-collection-model": "^5.31.0",
     "mongodb-ns": "^2.4.2",
     "mongodb-schema": "^12.6.2",

packages/compass-collection/package.json

@@ -17,9 +17,11 @@ import {
   SCHEMA_ANALYSIS_STATE_COMPLETE,
   SCHEMA_ANALYSIS_STATE_ERROR,
   SCHEMA_ANALYSIS_STATE_INITIAL,
-  type SchemaAnalysis,
+  type SchemaAnalysisError,
+  type SchemaAnalysisState,
 } from '../schema-analysis-types';
 import { calculateSchemaDepth } from '../calculate-schema-depth';
+import type { MongoError } from 'mongodb';
 
 const DEFAULT_SAMPLE_SIZE = 100;
 
@@ -32,6 +34,24 @@ function isAction<A extends AnyAction>(
   return action.type === type;
 }
 
+const ERROR_CODE_MAX_TIME_MS_EXPIRED = 50;
+
+function getErrorDetails(error: Error): SchemaAnalysisError {
+  const errorCode = (error as MongoError).code;
+  const errorMessage = error.message || 'Unknown error';
+  let errorType: SchemaAnalysisError['errorType'] = 'general';
+  if (errorCode === ERROR_CODE_MAX_TIME_MS_EXPIRED) {
+    errorType = 'timeout';
+  } else if (error.message.includes('Schema analysis aborted: Fields count')) {
+    errorType = 'highComplexity';
+  }
+
+  return {
+    errorType,
+    errorMessage,
+  };
+}
+
 type CollectionThunkAction<R, A extends AnyAction = AnyAction> = ThunkAction<
   R,
   CollectionState,
@@ -51,7 +71,7 @@ export type CollectionState = {
   namespace: string;
   metadata: CollectionMetadata | null;
   editViewName?: string;
-  schemaAnalysis: SchemaAnalysis;
+  schemaAnalysis: SchemaAnalysisState;
 };
 
 enum CollectionActions {
@@ -154,7 +174,7 @@ const reducer: Reducer<CollectionState, Action> = (
       ...state,
       schemaAnalysis: {
         status: SCHEMA_ANALYSIS_STATE_ERROR,
-        error: action.error,
+        error: getErrorDetails(action.error),
       },
     };
   }
@@ -204,15 +224,14 @@ export const analyzeCollectionSchema = (): CollectionThunkAction<
       const driverOptions = {
         maxTimeMS: preferences.getPreferences().maxTimeMS,
       };
-      const sampleCursor = dataService.sampleCursor(
+      const sampleDocuments = await dataService.sample(
         namespace,
         samplingOptions,
         driverOptions,
         {
           fallbackReadPreference: 'secondaryPreferred',
         }
       );
-      const sampleDocuments: Array<Document> = await sampleCursor.toArray();
       if (sampleDocuments.length === 0) {
         logger.debug(NO_DOCUMENTS_ERROR);
         dispatch({

packages/compass-collection/src/modules/collection-tab.ts

@@ -11,20 +11,25 @@ export type SchemaAnalysisStatus =
   | typeof SCHEMA_ANALYSIS_STATE_COMPLETE
   | typeof SCHEMA_ANALYSIS_STATE_ERROR;
 
-export type SchemaAnalysisInitial = {
+export type SchemaAnalysisInitialState = {
   status: typeof SCHEMA_ANALYSIS_STATE_INITIAL;
 };
 
-export type SchemaAnalysisStarted = {
+export type SchemaAnalysisStartedState = {
   status: typeof SCHEMA_ANALYSIS_STATE_ANALYZING;
 };
 
 export type SchemaAnalysisError = {
+  errorMessage: string;
+  errorType: 'timeout' | 'highComplexity' | 'general';
+};
+
+export type SchemaAnalysisErrorState = {
   status: typeof SCHEMA_ANALYSIS_STATE_ERROR;
-  error: Error;
+  error: SchemaAnalysisError;
 };
 
-export type SchemaAnalysisCompleted = {
+export type SchemaAnalysisCompletedState = {
   status: typeof SCHEMA_ANALYSIS_STATE_COMPLETE;
   schema: Schema;
   sampleDocument: Document;
@@ -34,8 +39,8 @@ export type SchemaAnalysisCompleted = {
   };
 };
 
-export type SchemaAnalysis =
-  | SchemaAnalysisError
-  | SchemaAnalysisInitial
-  | SchemaAnalysisStarted
-  | SchemaAnalysisCompleted;
+export type SchemaAnalysisState =
+  | SchemaAnalysisErrorState
+  | SchemaAnalysisInitialState
+  | SchemaAnalysisStartedState
+  | SchemaAnalysisCompletedState;