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

kylelai1 · 2025-10-17T00:58:18Z

Description

Adds the connection string to the script screen of the mock data generator modal

Checklist

New tests and/or benchmarks are included
Documentation is changed or added
If this change updates the UI, screenshots/videos are added and a design review is requested
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

Bugfix
New feature
Dependency update
Misc

Types of changes

Backport Needed
Patch (non-breaking change which fixes an issue)
Minor (non-breaking change which adds functionality)
Major (fix or feature that would cause existing functionality to change)

Copilot

Pull Request Overview

Adds a user-friendly Atlas connection string to metadata and surfaces it in the mock data generator script screen.

Introduces atlasMetadata.userConnectionString and a fallback constant.
Updates script generation to interpolate the connection string.
Adds tests for both provided and fallback connection string display.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/connection-info/src/connection-info.ts	Adds userConnectionString field with doc comment.
packages/compass-generative-ai/src/atlas-ai-service.spec.ts	Updates mock ConnectionInfo to include new field.
packages/compass-collection/src/stores/collection-tab.spec.ts	Adds userConnectionString to mock atlas connection info.
packages/compass-collection/src/components/mock-data-generator-modal/script-screen.tsx	Makes mongosh command dynamic based on connection string with fallback.
packages/compass-collection/src/components/mock-data-generator-modal/mock-data-generator-modal.spec.tsx	Adds tests for userConnectionString and fallback behavior.
packages/compass-collection/src/components/mock-data-generator-modal/constants.ts	Defines DEFAULT_CONNECTION_STRING_FALLBACK constant.
packages/compass-collection/src/components/collection-header/collection-header.spec.tsx	Adds userConnectionString to mock metadata.
packages/compass-collection/src/components/collection-header-actions/collection-header-actions.spec.tsx	Adds userConnectionString to mock metadata.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-17T15:36:54Z

packages/connection-info/src/connection-info.ts

+   * User-friendly connection string for the Atlas cluster, which uses the SRV address if available.
+   * Otherwise, will default to <your-cluster> as a placeholder.


The doc comment says the fallback defaults to , but the actual fallback used elsewhere is the full SRV form mongodb+srv://.mongodb.net/. Update the comment to reflect the exact expected format and clarify whether userConnectionString should always be a full connection string (including protocol and optional database) or just a host placeholder.

Suggested change

* User-friendly connection string for the Atlas cluster, which uses the SRV address if available.

* Otherwise, will default to <your-cluster> as a placeholder.

* User-friendly connection string for the Atlas cluster, typically in the SRV format:

* mongodb+srv://<your-cluster>.mongodb.net/<your-database>

* If the SRV address is not available, the fallback is the full SRV form with placeholders:

* mongodb+srv://<your-cluster>.mongodb.net/<your-database>

* This property should always be a full connection string, including protocol and optional database.

lerouxb · 2025-10-17T18:18:50Z

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

-const RUN_SCRIPT_COMMAND = `
-mongosh "mongodb+srv://<your-cluster>.mongodb.net/<your-database>" \\
+const RUN_SCRIPT_COMMAND = (connectionString: string) => `
+mongosh "${connectionString}" \\


And this is definitely not going to already contain username/password or even placeholders for username/password?

Correct, only the SRV address connection string here, without the username/password.

That's fine, but just in case you want some extra certainty for-almost-free, you can use

Suggested change

mongosh "${connectionString}" \\

mongosh "${redactConnectionString(connectionString)}" \\

with

import { redactConnectionString } from 'mongodb-connection-string-url';

That's a dependency we already freely use within Compass so it's basically an extra zero-cost safeguard

Ah yeah, good idea. Let me add this in.

jcobis · 2025-10-17T18:58:33Z

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

 };
+
+export const DEFAULT_CONNECTION_STRING_FALLBACK =
+  'mongodb+srv://<your-cluster>.mongodb.net/<your-database>';


Just want to confirm that this fallback with the <your-database> at the end is proper

Technically <your-cluster> alone as well isn't the best representation here of the connection string, since it'll be the SRV address, so something like Cluster0.AHFBW.mongodb.net for example. I took the existing placeholder and just refactored that here.

If we want something more accurate, we could just remove the placeholder and instead could just do '<srv-connection-string>' and have the user grab the connection string on their own.

Sounds good to me!

jcobis · 2025-10-22T20:19:10Z

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

+        connectionInfo: atlasConnectionInfo,
+        fakerSchemaGeneration: {
+          status: 'completed',
+          fakerSchema: {


Merge conflict fix:

Suggested change

fakerSchema: {

originalLlmResponse: {

name: {

fakerMethod: 'person.firstName',

fakerArgs: [],

probability: 1.0,

mongoType: 'String',

},

},

editedFakerSchema: {

jcobis · 2025-10-22T20:19:38Z

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

+        connectionInfo: atlasConnectionInfoWithoutAtlasMetadata,
+        fakerSchemaGeneration: {
+          status: 'completed',
+          fakerSchema: {


And here

Suggested change

fakerSchema: {

originalLlmResponse: {

name: {

fakerMethod: 'person.firstName',

fakerArgs: [],

probability: 1.0,

mongoType: 'String',

},

},

editedFakerSchema: {

Add connection string

98cccb5

github-actions bot added the feat label Oct 17, 2025

kylelai1 added 2 commits October 16, 2025 22:35

Fix typecheck

488848c

Fix typecheck

b1f5e08

kylelai1 marked this pull request as ready for review October 17, 2025 15:36

kylelai1 requested a review from a team as a code owner October 17, 2025 15:36

kylelai1 requested review from Copilot, jcobis and paula-stacho October 17, 2025 15:36

Copilot AI reviewed Oct 17, 2025

View reviewed changes

kylelai1 requested review from leo-generali and removed request for leo-generali October 17, 2025 15:37

lerouxb reviewed Oct 17, 2025

View reviewed changes

lerouxb approved these changes Oct 17, 2025

View reviewed changes

jcobis reviewed Oct 17, 2025

View reviewed changes

jcobis approved these changes Oct 17, 2025

View reviewed changes

kylelai1 added 2 commits October 20, 2025 11:18

Change connection string placeholder

5dae5c8

Use redactConnectionString

9787c64

jcobis approved these changes Oct 20, 2025

View reviewed changes

kylelai1 added 4 commits October 21, 2025 12:03

Add mongodb-connection-string-url dependency to package.json

97511a1

Merge main

10800ad

Merge branch 'main' into CLOUDP-347558

da1aa78

Update package-lock

d491938

jcobis reviewed Oct 22, 2025

View reviewed changes

Fix typecheck

ff9c15b

paula-stacho approved these changes Oct 23, 2025

View reviewed changes

Fix merge conflicts

66ba903

jcobis added the no release notes Fix or feature not for release notes label Oct 23, 2025

jcobis approved these changes Oct 23, 2025

View reviewed changes

kylelai1 merged commit 2051b4b into main Oct 23, 2025
76 of 80 checks passed

kylelai1 deleted the CLOUDP-347558 branch October 23, 2025 15:55

		* User-friendly connection string for the Atlas cluster, which uses the SRV address if available.
		* Otherwise, will default to <your-cluster> as a placeholder.

-   * User-friendly connection string for the Atlas cluster, which uses the SRV address if available.
-   * Otherwise, will default to <your-cluster> as a placeholder.
+   * User-friendly connection string for the Atlas cluster, typically in the SRV format:
+   *   mongodb+srv://<your-cluster>.mongodb.net/<your-database>
+   * If the SRV address is not available, the fallback is the full SRV form with placeholders:
+   *   mongodb+srv://<your-cluster>.mongodb.net/<your-database>
+   * This property should always be a full connection string, including protocol and optional database.

	mongosh "${connectionString}" \\
	mongosh "${redactConnectionString(connectionString)}" \\

-          fakerSchema: {
+          originalLlmResponse: {
+            name: {
+              fakerMethod: 'person.firstName',
+              fakerArgs: [],
+              probability: 1.0,
+              mongoType: 'String',
+            },
+          },
+          editedFakerSchema: {

Uh oh!

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

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

Uh oh!

Conversation

kylelai1 commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Motivation and Context

Types of changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kylelai1 Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kylelai1 commented Oct 17, 2025 •

edited

Loading

kylelai1 Oct 17, 2025 •

edited

Loading