feat(compass-collection): Add connection string to script screen CLOUDP-347558 (#7470)

* Add connection string to script screen

Author: kylelai1

package-lock.json

@@ -66,6 +66,7 @@
     "hadron-document": "^8.10.5",
     "mongodb": "^6.19.0",
     "mongodb-collection-model": "^5.35.5",
+    "mongodb-connection-string-url": "^3.0.2",
     "mongodb-ns": "^3.0.1",
     "mongodb-schema": "^12.6.3",
     "react": "^17.0.2",

packages/compass-collection/package.json

@@ -214,6 +214,7 @@ describe('CollectionHeaderActions [Component]', function () {
           globalWrites: false,
           rollingIndexes: true,
         },
+        userConnectionString: 'mongodb+srv://localhost:27017',
       },
     };
 

packages/compass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx

@@ -372,6 +372,7 @@ describe('CollectionHeader [Component]', function () {
           globalWrites: false,
           rollingIndexes: true,
         },
+        userConnectionString: 'mongodb+srv://localhost:27017',
       },
     };
 

packages/compass-collection/src/components/collection-header/collection-header.spec.tsx

@@ -118,3 +118,5 @@ export const MONGO_TYPE_TO_FAKER_METHODS: Record<
   Symbol: ['lorem.word', 'string.symbol'],
   DBRef: ['database.mongodbObjectId'],
 };
+
+export const DEFAULT_CONNECTION_STRING_FALLBACK = '<connection-string>';

packages/compass-collection/src/components/mock-data-generator-modal/constants.ts

@@ -13,7 +13,10 @@ import { createStore, applyMiddleware } from 'redux';
 import thunk from 'redux-thunk';
 import MockDataGeneratorModal from './mock-data-generator-modal';
 import { MockDataGeneratorStep } from './types';
-import { StepButtonLabelMap } from './constants';
+import {
+  DEFAULT_CONNECTION_STRING_FALLBACK,
+  StepButtonLabelMap,
+} from './constants';
 import type { CollectionState } from '../../modules/collection-tab';
 import { default as collectionTabReducer } from '../../modules/collection-tab';
 import type { ConnectionInfo } from '@mongodb-js/connection-info';
@@ -38,6 +41,7 @@ const defaultSchemaAnalysisState: SchemaAnalysisState = {
     avgDocumentSize: undefined,
   },
 };
+const mockUserConnectionString = 'mockUserConnectionString';
 
 describe('MockDataGeneratorModal', () => {
   async function renderModal({
@@ -925,6 +929,7 @@ describe('MockDataGeneratorModal', () => {
             globalWrites: false,
             rollingIndexes: true,
           },
+          userConnectionString: mockUserConnectionString,
         },
       };
 
@@ -1069,6 +1074,94 @@ describe('MockDataGeneratorModal', () => {
       expect(screen.getByText('firstName')).to.exist; // faker method
       expect(screen.getByText('insertMany')).to.exist;
     });
+
+    it('shows userConnectionString in the mongosh command when available', async () => {
+      const atlasConnectionInfo: ConnectionInfo = {
+        id: 'test-atlas-connection',
+        connectionOptions: { connectionString: 'mongodb://localhost:27017' },
+        atlasMetadata: {
+          orgId: 'test-org',
+          projectId: 'test-project-123',
+          clusterName: 'test-cluster',
+          clusterUniqueId: 'test-cluster-unique-id',
+          clusterType: 'REPLICASET' as const,
+          clusterState: 'IDLE' as const,
+          metricsId: 'test-metrics-id',
+          metricsType: 'replicaSet' as const,
+          regionalBaseUrl: null,
+          instanceSize: 'M10',
+          supports: {
+            globalWrites: false,
+            rollingIndexes: true,
+          },
+          userConnectionString: mockUserConnectionString,
+        },
+      };
+
+      await renderModal({
+        currentStep: MockDataGeneratorStep.GENERATE_DATA,
+        connectionInfo: atlasConnectionInfo,
+        fakerSchemaGeneration: {
+          status: 'completed',
+          originalLlmResponse: {
+            name: {
+              fakerMethod: 'person.firstName',
+              fakerArgs: [],
+              probability: 1.0,
+              mongoType: 'String',
+            },
+          },
+          editedFakerSchema: {
+            name: {
+              fakerMethod: 'person.firstName',
+              fakerArgs: [],
+              probability: 1.0,
+              mongoType: 'String',
+            },
+          },
+          requestId: 'test-request-id',
+        },
+      });
+
+      expect(screen.getByText(mockUserConnectionString, { exact: false })).to
+        .exist;
+    });
+
+    it('shows fallback connection string when there is no Atlas metadata', async () => {
+      const atlasConnectionInfoWithoutAtlasMetadata: ConnectionInfo = {
+        id: 'test-atlas-connection',
+        connectionOptions: { connectionString: 'mongodb://localhost:27017' },
+      };
+
+      await renderModal({
+        currentStep: MockDataGeneratorStep.GENERATE_DATA,
+        connectionInfo: atlasConnectionInfoWithoutAtlasMetadata,
+        fakerSchemaGeneration: {
+          status: 'completed',
+          originalLlmResponse: {
+            name: {
+              fakerMethod: 'person.firstName',
+              fakerArgs: [],
+              probability: 1.0,
+              mongoType: 'String',
+            },
+          },
+          editedFakerSchema: {
+            name: {
+              fakerMethod: 'person.firstName',
+              fakerArgs: [],
+              probability: 1.0,
+              mongoType: 'String',
+            },
+          },
+          requestId: 'test-request-id',
+        },
+      });
+
+      expect(
+        screen.getByText(DEFAULT_CONNECTION_STRING_FALLBACK, { exact: false })
+      ).to.exist;
+    });
   });
 
   describe('when rendering the modal in a specific step', () => {

packages/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.spec.tsx

@@ -22,9 +22,11 @@ import type { FakerSchema } from './types';
 import type { ArrayLengthMap } from './script-generation-utils';
 import type { CollectionState } from '../../modules/collection-tab';
 import { SCHEMA_ANALYSIS_STATE_COMPLETE } from '../../schema-analysis-types';
+import { DEFAULT_CONNECTION_STRING_FALLBACK } from './constants';
+import { redactConnectionString } from 'mongodb-connection-string-url';
 
-const RUN_SCRIPT_COMMAND = `
-mongosh "mongodb+srv://<your-cluster>.mongodb.net/<your-database>" \\
+const RUN_SCRIPT_COMMAND = (connectionString: string) => `
+mongosh "${redactConnectionString(connectionString)}" \\
   --username <your-username> \\
   --password "<your-password>" \\
   mockdatascript.js
@@ -92,6 +94,10 @@ const ScriptScreen = ({
   const isDarkMode = useDarkMode();
   const connectionInfo = useConnectionInfo();
 
+  const connectionString =
+    connectionInfo?.atlasMetadata?.userConnectionString ??
+    DEFAULT_CONNECTION_STRING_FALLBACK;
+
   const { database, collection } = toNS(namespace);
 
   // Generate the script using the faker schema
@@ -175,7 +181,9 @@ const ScriptScreen = ({
             reversible.
           </em>
         </Body>
-        <Code language={Language.Bash}>{RUN_SCRIPT_COMMAND}</Code>
+        <Code language={Language.Bash}>
+          {RUN_SCRIPT_COMMAND(connectionString)}
+        </Code>
       </section>
       <section
         className={cx(

packages/compass-collection/src/components/mock-data-generator-modal/script-screen.tsx

@@ -77,6 +77,7 @@ const mockAtlasConnectionInfo = {
         globalWrites: false,
         rollingIndexes: true,
       },
+      userConnectionString: 'mongodb+srv://localhost:27017',
     },
   },
 };

packages/compass-collection/src/stores/collection-tab.spec.ts

@@ -41,6 +41,7 @@ const mockConnectionInfo: ConnectionInfo = {
       globalWrites: false,
       rollingIndexes: false,
     },
+    userConnectionString: 'mongodb+srv://localhost:27020',
   },
 };
 

packages/compass-generative-ai/src/atlas-ai-service.spec.ts

@@ -106,6 +106,12 @@ export interface AtlasClusterMetadata {
      */
     rollingIndexes: boolean;
   };
+
+  /**
+   * User-friendly connection string for the Atlas cluster, which uses the SRV address if available.
+   * Otherwise, will default to <your-cluster> as a placeholder.
+   */
+  userConnectionString: string;
 }
 
 export interface ConnectionInfo {