feat(workspaces): Save and restore tabs COMPASS-9499 #7253

syn-zhu · 2025-08-29T03:43:01Z

Description

https://jira.mongodb.org/browse/COMPASS-9499

Screen.Recording.2025-09-17.at.11.48.12.AM.mov

Implement saving and restoring of session tabs.

Filed https://jira.mongodb.org/browse/COMPASS-9913 to track a couple of potential followups that I'm omitting from this PR

TODO: add test cases:

there is no saved state.
one of the tabs we're trying to restore references a connection that no longer exists.
one of the tabs we're trying to restore no longer exists (e.g. collection / database was deleted);
user declines restore tabs

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/compass-workspaces/src/components/index.tsx

packages/compass-workspaces/src/components/workspaces.tsx

packages/compass-workspaces/src/index.ts

packages/compass-workspaces/src/stores/workspaces-middleware.ts

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

syn-zhu · 2025-09-30T15:57:36Z

haven't fixed the logging comment yet but tried to address the other comments, @gribnoysup can you lmk if this looks better?

packages/compass-workspaces/src/index.ts

gribnoysup · 2025-10-02T12:04:26Z

packages/compass-workspaces/src/provider.tsx

+  loadSavedWorkspaces: async () => {
+    throwIfNotTestEnv();
+    return Promise.reject();
+  },
+  restoreSavedWorkspaces: () => throwIfNotTestEnv,


This is a public interface of workspaces that you are adding this to, loading / restoring workspaces shouldn't be exposed through it: we shouldn't allow other parts of the app to trigger this process

gribnoysup

Seems to work well overall and aligned with all the architecture patterns nicely, good work! Still some code changes that I think we need to make. I mentioned this in one of the new review comments: this is a pretty big chunk of work and doing it in one go is just making it harder for yourself. We should add a feature flag and split the remaining work into smaller chunks

Also the e2e test failures are legit and need to be addressed, this feature now gets in the way of expected app behavior in some scenarios. Adding a FF will temporarily help to deal with that, but moving forward we should add some explicit e2e tests for a feature like that

packages/compass-workspaces/src/stores/workspaces-middleware.ts

packages/compass-workspaces/src/stores/workspaces.ts

gribnoysup · 2025-10-07T07:47:49Z

packages/compass-workspaces/src/services/workspaces-storage.tsx

+ * Schema for saving workspace tab state to user data
+ */
+
+// Define schema for collection subtab


Almost everything here is exact copy of types defined in packages/compass-workspaces/src/types.ts, to avoid these diverging we should use one of those as source. As you'd need the schemas to use with UserData, we should probalby make schemas the source of types. This will require you to split the schemas here a bit to follow the type structure that we need in the app

tried to address this in 76ae816, lmk if that's better

Answered in #7253 (comment)

gribnoysup · 2025-10-07T07:51:19Z

packages/compass-workspaces/src/services/workspaces-storage.tsx

+// Define schema for a workspace tab
+export const WorkspaceTabSchema = z.object({
+  id: z.string(),
+  type: WorkspaceTabTypeSchema,
+  connectionId: z.string().optional(),
+  namespace: z.string().optional(),
+  initialQuery: z.record(z.any()).optional(),
+  initialAggregation: z.record(z.any()).optional(),
+  initialPipeline: z.array(z.record(z.any())).optional(),
+  initialPipelineText: z.string().optional(),
+  editViewName: z.string().optional(),
+  initialEvaluate: z.union([z.string(), z.array(z.string())]).optional(),
+  initialInput: z.string().optional(),
+  subTab: CollectionSubtabSchema.optional(),
+});


Sort of relevant to my comment above: the schema here should be a tuple of values by workspace type, similar to how it's defined in the types file. That way zod will make sure that we will never end up with workspaces where properties are not matching the type

Tried to address this and the comment above in 76ae816; Can you lmk if that's better?

packages/compass-workspaces/src/stores/workspaces-middleware.ts

packages/compass-workspaces/src/services/workspaces-storage-desktop.tsx

packages/compass-workspaces/src/services/workspaces-storage-web.tsx

addaleax

Looks good, just one question + one optional suggestion

addaleax · 2025-10-21T23:32:37Z

packages/compass-workspaces/src/stores/workspaces.ts

+            return;
+          }
+
+          void connections.connect(connectionInfo);


How do we deal with failures to connect?

packages/compass-workspaces/src/stores/workspaces.ts

gribnoysup

Now that the feature is behind a feature flag, nothing immediately blocking this PR from my side (there are some legit failures in the CI, so please take a look). But a couple of things definitely need follow-ups. Can you please open tickets for those?

One thing that we discussed, but is still not addressed is the "invisible" tab titles while connections are loading:

Kapture.2025-10-22.at.10.27.21.mp4

As discussed before, this is due ConnectionInfoProvider rendering nothing while connection is in progress. Instead I think we should allow some sort of fallback rendering there and do this for titles inside the workspace to make it clear that we actually restored the tabs, they are just not ready.

The e2e tests are also missing and for a feature like that we definitely want some.

packages/compass-workspaces/src/index.ts

packages/compass-workspaces/src/services/index.ts

gribnoysup · 2025-10-22T07:44:09Z

packages/compass-workspaces/src/services/workspaces-storage.tsx

+
+const CollectionSubtabSchema = z.enum(collectionSubtabValues);
+
+export const WorkspaceTabSchema = z


This is better, but only half way there IMO. As I said before, these types are now even more of a copy of what's defined in types.ts. Can you maybe walk me through your thought process here? Is there any reason you don't want to replace existing types in types.ts with types derived from the schemas? I don't see the reason not to do it, but maybe there's one I'm missing 🙂 Like imagine next time someone needs to add a new workspace, now they need to add exactly the same types twice in two different places, is there a good reason to do so?

I think I just don't understand what the suggestion is 😄

replace existing types in types.ts with types derived from the schemas

How exactly do I actually do this? I think I'm getting a bit mixed up on the terminology here, can we maybe refer to specific file / class names?

I would like to follow the suggestion but I don't actually understand what the suggestion is

It sounds like you're implying that there's some way to convert a typescript type (from types.ts) "directly" into a zod schema but I'm just not aware of how you would do that

packages/compass-workspaces/src/index.ts

packages/compass-workspaces/src/stores/workspaces.ts

syn-zhu · 2025-10-28T18:51:03Z

@gribnoysup Okay, I think I finally resolved everything. Check one last time?

Copilot

Pull Request Overview

This PR implements saving and restoring of session tabs in Compass, allowing users to reopen their previous workspace state when restarting the application. The feature is controlled by a new enableRestoreWorkspaces feature flag and includes a confirmation dialog before restoring tabs.

Key changes:

Added Zod schemas for workspace type validation and serialization
Implemented middleware to debounce and persist workspace state changes
Created storage service providers for both desktop and web platforms
Added thunk action to load and restore saved workspaces with connection validation

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/compass/src/app/components/entrypoint.tsx	Added WorkspacesStorageServiceProviderDesktop to the provider chain
packages/compass-workspaces/src/types.ts	Converted workspace type definitions to Zod schemas for validation and persistence
packages/compass-workspaces/src/stores/workspaces.ts	Added RestoreWorkspaces action and loadSavedWorkspaces thunk for loading persisted state
packages/compass-workspaces/src/stores/workspaces-middleware.ts	Created middleware to debounce and save workspace state changes
packages/compass-workspaces/src/services/workspaces-storage.tsx	Defined storage service context and noop implementation for tests
packages/compass-workspaces/src/services/workspaces-storage-web.tsx	Implemented Atlas-based storage provider for web platform
packages/compass-workspaces/src/services/workspaces-storage-desktop.tsx	Implemented file-based storage provider for desktop platform
packages/compass-workspaces/src/index.ts	Integrated storage service and middleware into plugin activation
packages/compass-web/src/entrypoint.tsx	Added WorkspacesStorageServiceProviderWeb to the web provider chain
packages/compass-user-data/src/index.ts	Exported IUserData as a class rather than just a type
packages/compass-preferences-model/src/feature-flags.ts	Added enableRestoreWorkspaces feature flag
packages/atlas-service/src/atlas-service.ts	Added savedWorkspaces to the list of supported resource types

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/compass-workspaces/src/stores/workspaces.ts

Copilot · 2025-10-28T18:51:31Z

packages/compass-workspaces/src/stores/workspaces.ts

+      dispatch({
+        type: WorkspacesActions.RestoreWorkspaces,
+        tabs: workspacesToRestore,
+      });


The dispatch occurs unconditionally even when confirm is false and workspacesToRestore is empty. This should be moved inside the if (confirm) block or wrapped in a condition checking workspacesToRestore.length > 0.

Suggested change

dispatch({

type: WorkspacesActions.RestoreWorkspaces,

tabs: workspacesToRestore,

});

if (confirm && workspacesToRestore.length > 0) {

dispatch({

type: WorkspacesActions.RestoreWorkspaces,

tabs: workspacesToRestore,

});

}

syn-zhu · 2025-10-28T18:56:33Z

packages/compass-preferences-model/src/feature-flags.ts

+    name: 'enableRestoreWorkspaces',
+    stage: 'development',
+    atlasCloudFeatureFlagName:
+      'DATA_EXPLORER_COMPASS_WEB_ENABLE_RESTORE_WORKSPACES',


https://github.com/10gen/mms/pull/145968

gribnoysup

Very neat! The check failure in CI is legit: you need to add user-data dependency to the workspaces package, but otherwise LGTM for this part of work

syn-zhu added 14 commits August 28, 2025 20:41

init

68b9e53

ef

a9ea81e

ef

fc3f50c

ef

5932624

ef

8cd1ac5

ef

b5c6f66

restore connections

b308225

refactor

a5713b4

refactor

2351763

break something

619362d

break something

25cf5e6

fix imports

e3876f9

fix imports

8908793

refactor

920f572

gribnoysup reviewed Sep 17, 2025

View reviewed changes

syn-zhu commented Sep 17, 2025

View reviewed changes

packages/atlas-service/src/atlas-service.ts Outdated Show resolved Hide resolved

syn-zhu added 9 commits September 17, 2025 12:02

refactor

aa78f68

add workspaces state service

42a15e0

add dekstop storage

9736436

implement web storage provider

3fd3b6b

make the services work

04b30c3

move effect callbacks to service

321a649

remove comment

b667dd5

provider remove

27bae4b

remove unused stuff

0d14953

syn-zhu requested a review from gribnoysup October 1, 2025 05:26

cover decline restore

2932698

gribnoysup reviewed Oct 2, 2025

View reviewed changes

packages/compass-workspaces/src/index.ts Outdated Show resolved Hide resolved

gribnoysup reviewed Oct 2, 2025

View reviewed changes

syn-zhu added the no release notes Fix or feature not for release notes label Oct 5, 2025

gribnoysup reviewed Oct 7, 2025

View reviewed changes

debounce

a7df6a5

syn-zhu commented Oct 8, 2025

View reviewed changes

packages/compass-workspaces/src/stores/workspaces-middleware.ts Outdated Show resolved Hide resolved

addaleax reviewed Oct 8, 2025

View reviewed changes

packages/compass-workspaces/src/services/workspaces-storage-desktop.tsx Show resolved Hide resolved

packages/compass-workspaces/src/services/workspaces-storage-web.tsx Show resolved Hide resolved

syn-zhu added 2 commits October 8, 2025 15:54

typing

76ae816

comments

a6d7db9

syn-zhu requested a review from gribnoysup October 11, 2025 18:29

syn-zhu and others added 4 commits October 11, 2025 14:31

merge

139f4f4

feature flag

e4f9a7a

pref

dec0e41

Merge branch 'main' into smnzhu/save-tab

cac3263

addaleax approved these changes Oct 21, 2025

View reviewed changes

gribnoysup approved these changes Oct 22, 2025

View reviewed changes

gribnoysup reviewed Oct 22, 2025

View reviewed changes

packages/compass-workspaces/src/stores/workspaces.ts Outdated Show resolved Hide resolved

address some comments

a8c7218

syn-zhu requested a review from gribnoysup October 24, 2025 20:40

syn-zhu added 3 commits October 28, 2025 14:21

fix types

22d71c4

fix types

7365633

merge main

86b788d

syn-zhu marked this pull request as ready for review October 28, 2025 18:50

syn-zhu requested a review from a team as a code owner October 28, 2025 18:50

Copilot AI review requested due to automatic review settings October 28, 2025 18:50

Copilot AI reviewed Oct 28, 2025

View reviewed changes

syn-zhu commented Oct 28, 2025

View reviewed changes

syn-zhu added 2 commits October 28, 2025 14:58

merge main

c4625aa

AI review

c417488

syn-zhu force-pushed the smnzhu/save-tab branch from 6067772 to c417488 Compare October 28, 2025 19:04

gribnoysup approved these changes Oct 29, 2025

View reviewed changes


		const CollectionSubtabSchema = z.enum(collectionSubtabValues);

		export const WorkspaceTabSchema = z

Uh oh!

feat(workspaces): Save and restore tabs COMPASS-9499 #7253

Are you sure you want to change the base?

feat(workspaces): Save and restore tabs COMPASS-9499 #7253

Conversation

syn-zhu commented Aug 29, 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!

Uh oh!

syn-zhu commented Sep 30, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gribnoysup left a comment • 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!

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!

Uh oh!

Uh oh!

Uh oh!

addaleax left a comment

Choose a reason for hiding this comment

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!

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!

syn-zhu Oct 24, 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!

Uh oh!

Uh oh!

Uh oh!

syn-zhu commented Oct 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

syn-zhu commented Aug 29, 2025 •

edited

Loading

gribnoysup left a comment •

edited

Loading

syn-zhu Oct 24, 2025 •

edited

Loading