feat: Using the AtlasUserData class to demo save user data project COMPASS-9565 #7152

myang1220 · 2025-07-29T18:49:04Z

Description

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

Open Questions

Dependents

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)

Merge branch 'user-data-interface' of https://github.com/mongodb-js/compass into user-data-interface

Merge branch 'extend-user-data' of https://github.com/mongodb-js/compass into extend-user-data

…end-user-data

Co-authored-by: Copilot <[email protected]>

Merge branch 'extend-user-data' of https://github.com/mongodb-js/compass into extend-user-data

Merge branch 'main' into extend-user-data

…e queries

Merge branch 'extend-user-data' of https://github.com/mongodb-js/compass into extend-user-data

nbbeeken · 2025-07-30T17:06:19Z

packages/my-queries-storage/src/compass-query-storage.ts

+        options.getResourceUrl,
+        options.authenticatedFetch,
+        {
+          serialize: (content) => EJSON.stringify(content, undefined, 2),


This is good for debugging but I'd expect us to use unspaced EJSON in prod

nbbeeken · 2025-07-30T17:07:06Z

packages/my-queries-storage/src/compass-query-storage.ts

+    // TODO: verify that this doesn't break anything in compass
+    const _id = new ObjectId().toHexString();


Was there something wrong with UUIDs?

In either case we haven't changed the type, just the string format, is that what we want here? just making sure if we want an ObjectId or UUID to be stored, we shouldn't toString this, we should leave it as the type we want

Is this going to impact existing compass data that does use UUID?

Notes:

For now we will just make the zod schema support string without the uuid assertion.

We should consider storing OID directly to keep type information encoded into the format, just need to get zod to agree to that.

We need to handle migrations of existing compass files (-ish) depending on what relies on _id

nbbeeken · 2025-07-30T17:12:31Z

packages/compass-user-data/src/user-data.ts

+  abstract readOne(
+    id: string,
+    options?: ReadOptions
+  ): Promise<z.output<T> | undefined>;


When does this return undefined? I kinda would've expected this to return a version of ReadAllResult that either has a single item in the arrays or the properties are one item instead of an array

Identified that readOne in AtlasUserData should not be returning null when an error is found. readOne in FileUserData originally had a return type of Promise<z.output<T> | undefined>, so the abstract method should also have type undefined.

nbbeeken · 2025-07-30T17:13:40Z

packages/my-queries-storage/src/compass-query-storage.ts

+    // TODO: verify that this doesn't break anything in compass
+    const _id = new ObjectId().toHexString();


Is this going to impact existing compass data that does use UUID?

Copilot

Pull Request Overview

This PR adds support for using the AtlasUserData class to demonstrate saving user data in Compass Web, integrating Atlas cloud storage for queries and pipelines alongside the existing file-based storage.

Updates query and pipeline storage classes to support both Atlas cloud storage and file-based storage
Modifies ID generation from UUID to ObjectId and changes schema validation to accept any string for _id
Integrates Atlas storage providers into the Compass Web entrypoint with proper authentication

Reviewed Changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
packages/my-queries-storage/src/query-storage.ts	Adds optional `id` parameter to favorite query interface
packages/my-queries-storage/src/query-storage-schema.ts	Changes `_id` validation from UUID to any string
packages/my-queries-storage/src/compass-query-storage.ts	Adds Atlas storage support and switches from UUID to ObjectId
packages/my-queries-storage/src/compass-pipeline-storage.ts	Adds Atlas storage support with dual storage backend logic
packages/my-queries-storage/src/compass-pipeline-storage.spec.ts	Updates test to use new constructor options format
packages/compass-web/src/entrypoint.tsx	Integrates Atlas storage providers and removes context menu tracking
packages/compass-user-data/src/user-data.ts	Adds `readOne` method to interface and refactors AtlasUserData API calls
packages/compass-user-data/src/user-data.spec.ts	Updates tests for new API endpoint structure
packages/compass-sidebar/src/components/multiple-connections/navigation/navigation.tsx	Adds redundant condition to My Queries visibility
packages/compass-query-bar/src/stores/query-bar-reducer.ts	Changes from `updateAttributes` to `saveQuery` method
packages/compass-data-modeling/src/services/data-model-storage-electron.tsx	Adds whitespace formatting
packages/atlas-service/src/provider.tsx	Exports `useAtlasServiceContext` function
packages/atlas-service/src/atlas-service.ts	Adds user data endpoints and includes credentials in authenticated requests
package.json	Adds `@leafygreen-ui/avatar` dependency

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

Copilot · 2025-09-02T18:35:13Z

packages/my-queries-storage/src/compass-query-storage.ts

  ): Promise<void> {
-    const _id = new UUID().toString();
+    // TODO: verify that this doesn't break anything in compass
+    _id ??= new ObjectId().toHexString();


Variable _id is being used but the parameter is named id in the interface. This should use the correct parameter name to avoid potential undefined behavior.

Copilot · 2025-09-02T18:35:14Z

packages/compass-web/src/entrypoint.tsx

+  const getResourceUrl = (path?: string) => {
+    const url = atlasService.userDataEndpoint(`/${path || ''}`);
+    console.log('getResourceUrl called with path:', path, '-> URL:', url);


Console.log statements should not be present in production code. Remove this debug statement or replace with proper logging.

Suggested change

const getResourceUrl = (path?: string) => {

const url = atlasService.userDataEndpoint(`/${path || ''}`);

console.log('getResourceUrl called with path:', path, '-> URL:', url);

const logger = useCompassWebLogger();

const getResourceUrl = (path?: string) => {

const url = atlasService.userDataEndpoint(`/${path || ''}`);

logger.debug('getResourceUrl called with path:', path, '-> URL:', url);

Copilot · 2025-09-02T18:35:14Z

packages/compass-sidebar/src/components/multiple-connections/navigation/navigation.tsx

@@ -104,7 +104,7 @@ export function Navigation({
  const isDataModelingEnabled = usePreference('enableDataModeling');
  return (
    <div>
-      {hasWorkspacePlugin('My Queries') && (
+      {hasWorkspacePlugin('My Queries') && true && (


The redundant && true condition serves no purpose and makes the code unclear. Remove this unnecessary condition.

Suggested change

{hasWorkspacePlugin('My Queries') && true && (

{hasWorkspacePlugin('My Queries') && (

Copilot · 2025-09-02T18:35:15Z

packages/compass-web/src/entrypoint.tsx

+          // TODO: Re-add context menu tracking once CompassComponentsProvider supports these props
+          // onContextMenuOpen and onContextMenuItemClick props are not available in current version


[nitpick] Important functionality has been commented out. Consider tracking this as a proper issue or ticket rather than leaving TODO comments in production code.

Suggested change

// TODO: Re-add context menu tracking once CompassComponentsProvider supports these props

// onContextMenuOpen and onContextMenuItemClick props are not available in current version

// Context menu tracking is currently disabled until CompassComponentsProvider supports

// onContextMenuOpen and onContextMenuItemClick props.

// Tracked in issue: https://github.com/mongodb-js/compass/issues/XXXX

Copilot · 2025-09-02T18:35:15Z

packages/atlas-service/src/atlas-service.ts

+    return `https://cluster-connection.cloud-dev.mongodb.com${normalizePath(
+      path
+    )}`;
+  }
+  userDataEndpoint(path?: string): string {
+    return `https://cluster-connection.cloud-dev.mongodb.com/userData${normalizePath(
+      path
+    )}`;


Hard-coded development endpoint URL in production code poses security risks. This should be configurable or removed from production builds.

Suggested change

return `https://cluster-connection.cloud-dev.mongodb.com${normalizePath(

path

)}`;

}

userDataEndpoint(path?: string): string {

return `https://cluster-connection.cloud-dev.mongodb.com/userData${normalizePath(

path

)}`;

if (!this.config.tempBaseUrl) {

throw new Error('tempBaseUrl is not configured');

}

return `${this.config.tempBaseUrl}${normalizePath(path)}`;

}

userDataEndpoint(path?: string): string {

if (!this.config.tempBaseUrl) {

throw new Error('tempBaseUrl is not configured');

}

return `${this.config.tempBaseUrl}/userData${normalizePath(path)}`;

Copilot · 2025-09-02T18:35:15Z

packages/atlas-service/src/atlas-service.ts

+    return `https://cluster-connection.cloud-dev.mongodb.com${normalizePath(
+      path
+    )}`;
+  }
+  userDataEndpoint(path?: string): string {
+    return `https://cluster-connection.cloud-dev.mongodb.com/userData${normalizePath(
+      path
+    )}`;


Hard-coded development endpoint URL in production code poses security risks. This should be configurable or removed from production builds.

Suggested change

return `https://cluster-connection.cloud-dev.mongodb.com${normalizePath(

path

)}`;

}

userDataEndpoint(path?: string): string {

return `https://cluster-connection.cloud-dev.mongodb.com/userData${normalizePath(

path

)}`;

if (!this.config.tempEndpointBaseUrl) {

throw new Error('tempEndpointBaseUrl is not configured');

}

return `${this.config.tempEndpointBaseUrl}${normalizePath(path)}`;

}

userDataEndpoint(path?: string): string {

if (!this.config.userDataEndpointBaseUrl) {

throw new Error('userDataEndpointBaseUrl is not configured');

}

return `${this.config.userDataEndpointBaseUrl}${normalizePath(path)}`;

myang1220 and others added 30 commits July 10, 2025 11:55

feat(save-user-data): create a user data abstract class

3f336ec

Merge branch 'main' into user-data-interface

ad5e416

fix: rm defaults and add semaphore to FileUserData

78026a3

merge remote branch back into local

b24d748

Merge branch 'user-data-interface' of https://github.com/mongodb-js/compass into user-data-interface

Merge branch 'main' into user-data-interface

8413d43

feat(save-user-data): push for help

dc38640

feat(save-user-data): comment out nulls

41abc96

feat(save-user-data): create a user data abstract class

e90412e

fix: rm defaults and add semaphore to FileUserData

701adaf

feat(save-user-data): push for help

daee65a

feat(save-user-data): comment out nulls

90573c7

rebase main into branch

0e997ff

Merge branch 'extend-user-data' of https://github.com/mongodb-js/compass into extend-user-data

Merge branch 'main' of https://github.com/mongodb-js/compass into ext…

5d39eb3

…end-user-data

potentital org and group id retrieval

5edf5e2

minor fixes

729c6db

unit testing

055b898

fix package-lock.json merge conflict

fed4e96

typo

2058a32

Co-authored-by: Copilot <[email protected]>

package-lock.json

296147a

merge origin back into branch

d128447

Merge branch 'extend-user-data' of https://github.com/mongodb-js/compass into extend-user-data

fix: parse one by one in readAll

18240da

fix: change updateAttributes return type to boolean

31a8643

stricter typing for type param and fix update tests

e88856f

add getResourceUrl and change groupId to projectId

3b8fc66

merge main back into branch

7d42eef

Merge branch 'main' into extend-user-data

change wsBaseUrl to ccsBaseUrl in spec files

3c033fe

chore(user-data): remove redundant withStats methods

ef94ff8

fix(user-data): remove nonexistent exports

3f8405a

fix(my-queries-storage): adjust types to match the method behavior

7f07ddd

fix(saved-aggregations-queries): adjust test fixture

e09d426

myang1220 added 8 commits July 23, 2025 16:36

put data type in IUserData class

04ba804

Merge branch 'main' into extend-user-data

cf510ce

fix(user-data): add datatype to IUserData abstract class & tests

73b2bd1

fix: merge stats change to branch

51ab01e

fix(user-data): make create and update return type to be boolean, lik…

df135f3

…e queries

pull remote branch back into local

0bb77b8

Merge branch 'extend-user-data' of https://github.com/mongodb-js/compass into extend-user-data

fix(compass-aggregations): fix method typing

f6efcd6

feat: building demo for saving user data project

2c0de81

myang1220 added feat no release notes Fix or feature not for release notes labels Jul 29, 2025

path segment and method binding

3eab096

myang1220 changed the base branch from main to extend-user-data July 30, 2025 17:02

nbbeeken requested changes Jul 30, 2025

View reviewed changes

working demo

61265d6

Base automatically changed from extend-user-data to main August 15, 2025 16:05

nvs119 added 6 commits August 15, 2025 14:35

merge

59e2a40

restore again

8e5d686

make it work on dev

8e94ca9

merge main

905addd

test fixes

8b17775

Merge remote-tracking branch 'origin' into use-atlas-user-data

ce55bc5

nvs119 marked this pull request as ready for review September 2, 2025 18:33

Copilot AI review requested due to automatic review settings September 2, 2025 18:33

nvs119 requested a review from a team as a code owner September 2, 2025 18:33

Copilot AI reviewed Sep 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Using the AtlasUserData class to demo save user data project COMPASS-9565 #7152

feat: Using the AtlasUserData class to demo save user data project COMPASS-9565 #7152

myang1220 commented Jul 29, 2025

Uh oh!

nbbeeken Jul 30, 2025

Uh oh!

nbbeeken Jul 30, 2025

Uh oh!

nbbeeken Jul 30, 2025

Uh oh!

nbbeeken Jul 30, 2025

Uh oh!

nbbeeken Jul 30, 2025

Uh oh!

nbbeeken Jul 30, 2025

Uh oh!

myang1220 Aug 7, 2025

Uh oh!

nbbeeken Jul 30, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Uh oh!

		// TODO: verify that this doesn't break anything in compass
		const _id = new ObjectId().toHexString();

	{hasWorkspacePlugin('My Queries') && true && (
	{hasWorkspacePlugin('My Queries') && (

		// TODO: Re-add context menu tracking once CompassComponentsProvider supports these props
		// onContextMenuOpen and onContextMenuItemClick props are not available in current version

-          // TODO: Re-add context menu tracking once CompassComponentsProvider supports these props
-          // onContextMenuOpen and onContextMenuItemClick props are not available in current version
+          // Context menu tracking is currently disabled until CompassComponentsProvider supports
+          // onContextMenuOpen and onContextMenuItemClick props.
+          // Tracked in issue: https://github.com/mongodb-js/compass/issues/XXXX

-    return `https://cluster-connection.cloud-dev.mongodb.com${normalizePath(
-      path
-    )}`;
-  }
-  userDataEndpoint(path?: string): string {
-    return `https://cluster-connection.cloud-dev.mongodb.com/userData${normalizePath(
-      path
-    )}`;
+    if (!this.config.tempBaseUrl) {
+      throw new Error('tempBaseUrl is not configured');
+    }
+    return `${this.config.tempBaseUrl}${normalizePath(path)}`;
+  }
+  userDataEndpoint(path?: string): string {
+    if (!this.config.tempBaseUrl) {
+      throw new Error('tempBaseUrl is not configured');
+    }
+    return `${this.config.tempBaseUrl}/userData${normalizePath(path)}`;

-    return `https://cluster-connection.cloud-dev.mongodb.com${normalizePath(
-      path
-    )}`;
-  }
-  userDataEndpoint(path?: string): string {
-    return `https://cluster-connection.cloud-dev.mongodb.com/userData${normalizePath(
-      path
-    )}`;
+    if (!this.config.tempEndpointBaseUrl) {
+      throw new Error('tempEndpointBaseUrl is not configured');
+    }
+    return `${this.config.tempEndpointBaseUrl}${normalizePath(path)}`;
+  }
+  userDataEndpoint(path?: string): string {
+    if (!this.config.userDataEndpointBaseUrl) {
+      throw new Error('userDataEndpointBaseUrl is not configured');
+    }
+    return `${this.config.userDataEndpointBaseUrl}${normalizePath(path)}`;

feat: Using the AtlasUserData class to demo save user data project COMPASS-9565 #7152

Are you sure you want to change the base?

feat: Using the AtlasUserData class to demo save user data project COMPASS-9565 #7152

Conversation

myang1220 commented Jul 29, 2025

Description

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

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!

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!