feat(compass-web): add the AtlasUserData class to save user data 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)

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

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

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

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.}

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

packages/compass-web/src/entrypoint.tsx

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

packages/compass-web/src/entrypoint.tsx

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)}`;

this will be fixed in follow up pr

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)}`;

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

packages/compass-aggregations/src/components/pipeline-toolbar/pipeline-settings/index.tsx

packages/compass-query-bar/src/components/query-bar.tsx

packages/compass-query-bar/src/stores/query-bar-reducer.ts

packages/compass-web/src/hooks/use-my-queries-feature.ts

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

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

package.json

nvs119 · 2025-09-08T22:33:55Z

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

+      options.orgId &&
+      options.projectId &&
+      options.getResourceUrl &&
+      options.authenticatedFetch


where it decides to use atlas user data -- if all Atlas options are provided

Interesting, seems.. okay not something we want to just explicitly request? The Welcome page is split into web and desktop variants at build time, I was originally imagining this would also be build time. Seems fine for an initial approach

Yes, for other services that's the patterns we're following and we should stick to it here too. See data-modeling exports for example where we have a pretty similar case, there is a shared interface and two separate exports, one for web, one for electron

nbbeeken · 2025-09-16T21:55:44Z

packages/compass-preferences-model/src/react.ts

+ * - Recent queries autocomplete
+ * - Favorite queries/aggregations
+ */
+export function useMyQueriesFeature(): boolean {


not used anywhere?

nbbeeken · 2025-09-16T22:04:02Z

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

+      options.orgId &&
+      options.projectId &&
+      options.getResourceUrl &&
+      options.authenticatedFetch


Interesting, seems.. okay not something we want to just explicitly request? The Welcome page is split into web and desktop variants at build time, I was originally imagining this would also be build time. Seems fine for an initial approach

gribnoysup · 2025-09-17T09:20:03Z

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

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


This should be coming from the config property

Yes! I was going to do this in a followup PR for this ticket: https://jira.mongodb.org/browse/COMPASS-9663

Super small nit for the future, if you already have a TODO like that in mind, it's super helpful to add it in the code to clarify that something is out of scope for the particular change being up for review 🙂

packages/atlas-service/src/provider.tsx

gribnoysup · 2025-09-17T09:37:22Z

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

+      options.orgId &&
+      options.projectId &&
+      options.getResourceUrl &&
+      options.authenticatedFetch


Yes, for other services that's the patterns we're following and we should stick to it here too. See data-modeling exports for example where we have a pretty similar case, there is a shared interface and two separate exports, one for web, one for electron

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

gribnoysup

Very neat!

gribnoysup · 2025-09-18T12:59:59Z

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

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


Super small nit for the future, if you already have a TODO like that in mind, it's super helpful to add it in the code to clarify that something is out of scope for the particular change being up for review 🙂

gribnoysup · 2025-09-18T14:43:10Z

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

-          ...(shouldAddCSRFHeaders(init?.method) && getCSRFHeaders()),
-          ...init?.headers,
-        },
+        headers,


(Hard to leave a comment about this in more relevant place) Because we now doing cross origin authenticated requests through AtlasService, we need to allow fetch to include cookies in the request when possible. This is how you do it:

Suggested change

headers,

headers,

credentials: 'include',

But we should probably do this only for authenticatedFetch below

gribnoysup · 2025-09-18T14:57:13Z

packages/compass-web/src/entrypoint.tsx

+      <PipelineStorageProvider value={pipelineStorage.current}>
+        <FavoriteQueryStorageProvider value={favoriteQueryStorage.current}>
+          <RecentQueryStorageProvider value={recentQueryStorage.current}>
+            {children}
+          </RecentQueryStorageProvider>
+        </FavoriteQueryStorageProvider>
+      </PipelineStorageProvider>


Not super important, but we can probably do all this wiring inside my-queries package and expose only something like MyQueriesStorageProvider component outside. And a similar cleanup can be done for desktop counterpart. This would probably require moving around even more code, so fine as is for now, just thinking out loud.

nbbeeken

Final stretch!!

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

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

packages/my-queries-storage/src/compass-query-storage.ts Outdated Show resolved Hide resolved

packages/my-queries-storage/src/compass-query-storage.ts Outdated Show resolved Hide resolved

nbbeeken requested changes Jul 30, 2025

View reviewed changes

packages/compass-user-data/src/user-data.ts Show resolved Hide resolved

nbbeeken requested changes Jul 30, 2025

View reviewed changes

packages/my-queries-storage/src/compass-query-storage.ts Outdated Show resolved Hide resolved

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

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

nvs119 mentioned this pull request Sep 4, 2025

chore(my-queries): make feature flag ready for saving user data COMPASS-9657 #7264

Merged

12 tasks

nbbeeken requested changes Sep 5, 2025

View reviewed changes

nbbeeken reviewed Sep 5, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

myang1220 added 16 commits September 8, 2025 11:28

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

e04e887

fix: rm defaults and add semaphore to FileUserData

6e7876b

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

b28596b

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

669f626

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

c00749f

fix: rm defaults and add semaphore to FileUserData

c41114e

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

10b0bc1

potentital org and group id retrieval

d22cebc

minor fixes

eb9c0c2

unit testing

b3612a7

package-lock.json

0e9d6dc

fix: parse one by one in readAll

6a3f59d

fix: change updateAttributes return type to boolean

4c6bb7c

stricter typing for type param and fix update tests

817d4c5

add getResourceUrl and change groupId to projectId

f0db6d0

put data type in IUserData class

d18cd15

fix tests

7809ed8

nvs119 reviewed Sep 8, 2025

View reviewed changes

nvs119 added 4 commits September 9, 2025 15:33

fix some stuff for test

d99d1b1

merge

f1c3ac1

recents and favorites but aggs not work

834454f

checks and stuff

953fa73

nvs119 requested a review from nbbeeken September 16, 2025 21:50

nbbeeken changed the title ~~feat: Using the AtlasUserData class to demo save user data project COMPASS-9565~~ feat(compass-web): add the AtlasUserData class to save user data COMPASS-9565 Sep 16, 2025

nbbeeken requested changes Sep 16, 2025

View reviewed changes

gribnoysup reviewed Sep 17, 2025

View reviewed changes

packages/compass-user-data/src/user-data.ts Outdated Show resolved Hide resolved

nvs119 added 4 commits September 17, 2025 14:08

change aggs to uuid and remove response.ok checks

0c38299

service accessed through locator

fc98fd8

Working with build time impls

18c3f4a

redone code

f57e87c

nvs119 requested review from gribnoysup and nbbeeken September 18, 2025 00:54

nvs119 added 2 commits September 17, 2025 21:46

tests

860bbae

no credentials: include

110ee91

gribnoysup approved these changes Sep 18, 2025

View reviewed changes

nbbeeken approved these changes Sep 18, 2025

View reviewed changes

nvs119 added 7 commits September 18, 2025 13:26

fixes

3176131

fix my queries storage package check

412c700

test fixes

08c9f20

Merge branch 'main' into use-atlas-user-data

765c77e

fix saved aggregations unit test

6bc78e2

check

c406f40

db coll testS

7b79c0a

nvs119 merged commit a90ac01 into main Sep 19, 2025
60 checks passed

nvs119 deleted the use-atlas-user-data branch September 19, 2025 13:27

-    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(compass-web): add the AtlasUserData class to save user data COMPASS-9565 #7152

feat(compass-web): add the AtlasUserData class to save user data COMPASS-9565 #7152

Uh oh!

Conversation

myang1220 commented Jul 29, 2025

Description

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gribnoysup left a comment

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!

nbbeeken left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone