feat(save-user-data): extend user data abstract class for api backend COMPASS-9558 #7114

myang1220 · 2025-07-15T19:46:36Z

Description

Extend the IUserData abstract class to create an AtlasUserData class that uses the endpoints created in CCS. Contains unit testing.

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

See comments

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

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

packages/compass-user-data/package.json

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

myang1220 · 2025-07-18T21:09:39Z

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

+      }
+
+      return true;
+    } catch (error) {


How does the logging look? Are there any changes that I should make to make this more consistent with Compass behavior?

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

Copilot

Pull Request Overview

This PR extends the user data abstract class system by implementing a new AtlasUserData class that communicates with Atlas backend API endpoints for cloud-based user data storage, as an alternative to the existing file-based storage.

Adds AtlasUserData class implementing the IUserData interface for API-based storage
Includes comprehensive test coverage for all CRUD operations and URL construction
Updates exports to make the new class available to consumers

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.

File	Description
packages/compass-user-data/src/user-data.ts	Implements AtlasUserData class with HTTP-based CRUD operations
packages/compass-user-data/src/user-data.spec.ts	Adds comprehensive test suite for AtlasUserData functionality
packages/compass-user-data/src/index.ts	Exports the new AtlasUserData class

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

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

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

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

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

myang1220 · 2025-07-29T20:48:01Z

packages/bson-transpilers/lib/symbol-table/shelltocsharp.js

@gribnoysup @Anemy
Do you guys have any clue where these may have come from? I haven't personally modified any of them, so I wonder whether it's due to command line commands?

Yeah, those are not really related. Probably accidentally run a compile command across all packages? We haven't updated this in a while, so I guess there might be some slight formatting variations or something, probably better to just revert those from your patch

gribnoysup · 2025-07-30T08:56:04Z

packages/compass-shell/src/modules/history-storage.ts

@@ -6,9 +6,8 @@ export class HistoryStorage {
  userData;

  constructor(basePath?: string) {
-    this.userData = new FileUserData(z.string().array(), {
+    this.userData = new FileUserData(z.string().array(), getAppName() ?? '', {
      // Todo: https://jira.mongodb.org/browse/COMPASS-7080


Nit: this todo should probably still point at the getAppName() part

myang1220 and others added 13 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

github-actions bot added the feat label Jul 15, 2025

myang1220 added the no release notes Fix or feature not for release notes label Jul 15, 2025

gribnoysup reviewed Jul 16, 2025

View reviewed changes

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

gribnoysup reviewed Jul 16, 2025

View reviewed changes

packages/compass-user-data/package.json Outdated Show resolved Hide resolved

gribnoysup reviewed Jul 16, 2025

View reviewed changes

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

myang1220 added 2 commits July 17, 2025 10:34

potentital org and group id retrieval

5edf5e2

minor fixes

729c6db

Anemy reviewed Jul 17, 2025

View reviewed changes

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

myang1220 added 2 commits July 18, 2025 16:59

unit testing

055b898

fix package-lock.json merge conflict

fed4e96

myang1220 commented Jul 18, 2025

View reviewed changes

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

myang1220 commented Jul 18, 2025

View reviewed changes

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

myang1220 commented Jul 18, 2025

View reviewed changes

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

myang1220 requested review from Anemy and gribnoysup July 18, 2025 21:21

myang1220 marked this pull request as ready for review July 18, 2025 21:21

Copilot AI review requested due to automatic review settings July 18, 2025 21:21

myang1220 requested a review from a team as a code owner July 18, 2025 21:21

Copilot AI reviewed Jul 18, 2025

View reviewed changes

myang1220 and others added 3 commits July 18, 2025 17:25

typo

2058a32

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

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

gribnoysup reviewed Jul 21, 2025

View reviewed changes

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

myang1220 added 3 commits July 21, 2025 15:37

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

Anemy reviewed Jul 22, 2025

View reviewed changes

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

myang1220 and others added 14 commits July 22, 2025 12:16

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

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

myang1220 commented Jul 29, 2025

View reviewed changes

gribnoysup reviewed Jul 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(save-user-data): extend user data abstract class for api backend COMPASS-9558 #7114

feat(save-user-data): extend user data abstract class for api backend COMPASS-9558 #7114

Uh oh!

myang1220 commented Jul 15, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

myang1220 Jul 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

myang1220 Jul 29, 2025

Uh oh!

gribnoysup Jul 30, 2025

Uh oh!

gribnoysup Jul 30, 2025

Uh oh!

Uh oh!

feat(save-user-data): extend user data abstract class for api backend COMPASS-9558 #7114

Are you sure you want to change the base?

feat(save-user-data): extend user data abstract class for api backend COMPASS-9558 #7114

Uh oh!

Conversation

myang1220 commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

myang1220 Jul 18, 2025

Choose a reason for hiding this comment

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!

Uh oh!

Uh oh!

myang1220 Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

gribnoysup Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

gribnoysup Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

myang1220 commented Jul 15, 2025 •

edited

Loading