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

nvs119 · 2025-09-02T03:28:32Z

Description

Make feature flag to gate user queries. Once this is merged we will use this feature flag in the implementation PR

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)

Copilot

Pull Request Overview

This PR introduces a feature flag MY_QUERIES_DATA_EXPLORER to control access to user query data features. The feature flag gates functionality related to saved queries, aggregations, recent queries autocomplete, and favorite queries/aggregations.

Adds the new feature flag to preferences schema and default configurations
Creates a dedicated hook useMyQueriesFeature for checking feature availability
Integrates the feature flag into UI components to conditionally enable My Queries functionality

Reviewed Changes

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

Show a summary per file

File	Description
packages/compass-web/src/preferences.tsx	Sets default value for MY_QUERIES_DATA_EXPLORER feature flag to false
packages/compass-web/src/hooks/use-my-queries-feature.ts	Creates new hook to check if My Queries feature is enabled
packages/compass-web/src/entrypoint.tsx	Imports and uses the new feature flag hook (for future implementation)
packages/compass-web/sandbox/index.tsx	Adds feature flag configuration to sandbox environment
packages/compass-sidebar/src/components/multiple-connections/navigation/navigation.tsx	Gates My Queries navigation item based on feature flag
packages/compass-query-bar/src/components/query-bar.tsx	Conditionally enables saved queries functionality based on feature flag
packages/compass-preferences-model/src/preferences-schema.tsx	Adds MY_QUERIES_DATA_EXPLORER to preferences type definitions and schema validation

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

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

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

paula-stacho · 2025-09-02T08:24:20Z

packages/compass-web/src/entrypoint.tsx

    onDebug,
  });
  const preferencesAccess = useCompassWebPreferences(initialPreferences);
+  const isMyQueriesEnabled = useMyQueriesFeature();


lint will complain about unused variables, you can just leave this commented out together with the todo. we also try to add ticket numbers to todos, I don't think it'll be forgotten in this instance but it's a good habit

paula-stacho · 2025-09-02T08:32:31Z

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

+export function useMyQueriesFeature(): boolean {
+  const cloudFeatureRolloutAccess = usePreference('cloudFeatureRolloutAccess');
+  return cloudFeatureRolloutAccess?.MY_QUERIES_DATA_EXPLORER ?? false;
+}


compass-web is not the best place for the hook, check out the compass-preferences-model package. there are similar hooks in the utils.

once moved, you can use the hook in the sidebar and query bar

paula-stacho · 2025-09-02T08:44:19Z

packages/compass-web/sandbox/index.tsx

              enableDataModeling: true,
+              cloudFeatureRolloutAccess: {
+                MY_QUERIES_DATA_EXPLORER: false, // Disabled by default
+              },


this shouldn't be necessary

paula-stacho · 2025-09-04T09:44:27Z

What happened, where did the changes in compass-preferences-model go? We might need a section on this in the Compass Dev Guide 😅
You'll need to register your new setting in the preferences-schema.tsx. If I'm getting it right and you want a gradual rollout in web, see editable preferences in compass-web-preferences-access.ts.
Additionally, I noticed that the My Queries plugin is actually not included in compass-web at the moment, so you'll need to add it. Search for <WorkspacesProvider, you'll find two versions, the web one is missing My Queries.

In the end, you can test your changes locally with npm run start-web.

Feel free to hit me on slack or schedule a pairing session

packages/compass-web/src/entrypoint.tsx

paula-stacho · 2025-09-04T16:24:45Z

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

+    description: {
+      short: 'Save and manage favorite queries and aggregations',
+    },
+  },


so this part is a bit confusing, but this configuration and feature flags relate to compass, not DE. so adding it here with stage: 'development' adds it to these "feature preview" flags that we have in Compass. They are also turned off by default, which we don't want here.

So instead of adding it to FeatureFlags, let's add it to the "other" section in UserConfigurablePreferences and storedUserPreferencesProps. Example you can follow is enableImportExport (make sure to use default true, you can still override that for compass-web, but the default compass setting for this feature is on).

nvs119 · 2025-09-04T19:58:15Z

packages/compass-web/src/entrypoint.tsx

-        </div>
-      </CollectionTabsProvider>
-    </WorkspacesProvider>
+    <PipelineStorageProvider value={pipelineStorage}>


placeholder until the implementation PR goes in (COMPASS-9565)

~~Let's add a TODO or note? Also fine as is as I doubt anyone else will be touching it.~~

Giving this some thought, we are constructing the file storage items here, it could lead to some unintended errors or something if we change the file storage implementation. Similarly compassFavoriteQueryStorageAccess is only exported for testing. Should we leave these out until we have the web storage? Is there something we want them for now?

Slightly related, a total nit, and not something we follow in many places of Compass really:
https://react.dev/reference/react/useRef#avoiding-recreating-the-ref-contents

We could instead write the creation as:

// Create a simple pipeline storage instance for sandbox. const pipelineStorageRef = useRef<CompassPipelineStorage | null>(null); if (pipelineStorageRef.current === null) { pipelineStorageRef.current = new CompassPipelineStorage(); }

to avoid calling the constructor of CompassPipelineStorage on each render.

paula-stacho · 2025-09-05T12:12:35Z

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

  // TODO: remove direct check for storage existing, breaks single source of
  // truth rule and exposes services to UI, this breaks the rules for locators
-  const isSavingAggregationsEnabled = !!usePipelineStorage();
+  const pipelineStorageAvailable = !!usePipelineStorage();


if I'm not mistaken we can now replace this check with the new flag. tagging @gribnoysup to confirm that the check was for compass-web and not some other case.

Yep, should replace this with a preference if we have one now

paula-stacho · 2025-09-05T12:13:16Z

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

  // TODO: remove direct check for storage existing, breaks single source of
  // truth rule and exposes services to UI, this breaks the rules for locators
-  const enableSavedAggregationsQueries = !!usePipelineStorage();
+  const pipelineStorageAvailable = !!usePipelineStorage();


same as above

paula-stacho · 2025-09-05T14:12:25Z

packages/my-queries-storage/src/index.ts

+  RecentQueryStorageProvider,
+  PipelineStorageProvider,
+} from './provider';
+


The provider being exported separately is actually intentional, this is to have a clear separation between the service and the provider (we even have a rule that restricts direct use of the service).
You can import these from @mongodb-js/my-queries-storage/provider

Anemy

Changes look good, left a couple small comments/questions

Anemy · 2025-09-08T14:58:33Z

packages/compass-collection/package.json

    "@mongodb-js/connection-info": "^0.18.0",
    "@mongodb-js/mongodb-constants": "^0.14.0",
-    "bson": "^6.10.1",
+    "bson": "^6.10.4",


Is this related?

oops taken out now

Anemy · 2025-09-08T15:01:28Z

packages/compass-user-data/package.json

    "@mongodb-js/compass-utils": "^0.9.12",
    "write-file-atomic": "^5.0.1",
-    "zod": "^3.25.17"
+    "zod": "^3.25.76"


Same q as the bson dep, totally for my own understanding, happy to have drive by updates in prs, although it can make it easier if we have them in a separate one to make things simple if we ever need to revert.

oops taken out now

Anemy · 2025-09-08T15:02:17Z

packages/compass-web/sandbox/index.tsx

  Body,
+  css,
  openToast,
+  resetGlobalCSS,


Alphabetical 🙌 big fan.

Anemy · 2025-09-08T15:03:26Z

packages/compass-web/src/entrypoint.tsx

-        </div>
-      </CollectionTabsProvider>
-    </WorkspacesProvider>
+    <PipelineStorageProvider value={pipelineStorage}>


~~Let's add a TODO or note? Also fine as is as I doubt anyone else will be touching it.~~

Giving this some thought, we are constructing the file storage items here, it could lead to some unintended errors or something if we change the file storage implementation. Similarly compassFavoriteQueryStorageAccess is only exported for testing. Should we leave these out until we have the web storage? Is there something we want them for now?

Slightly related, a total nit, and not something we follow in many places of Compass really:
https://react.dev/reference/react/useRef#avoiding-recreating-the-ref-contents

We could instead write the creation as:

// Create a simple pipeline storage instance for sandbox. const pipelineStorageRef = useRef<CompassPipelineStorage | null>(null); if (pipelineStorageRef.current === null) { pipelineStorageRef.current = new CompassPipelineStorage(); }

to avoid calling the constructor of CompassPipelineStorage on each render.

Anemy

lgtm 1 (once tests pass) !

…s into user-data-feature-flag

make feature flag ready for saving user data

6b01986

Copilot AI review requested due to automatic review settings September 2, 2025 03:28

nvs119 requested a review from a team as a code owner September 2, 2025 03:28

Copilot AI reviewed Sep 2, 2025

View reviewed changes

packages/compass-sidebar/src/components/multiple-connections/navigation/navigation.tsx Outdated Show resolved Hide resolved

packages/compass-query-bar/src/components/query-bar.tsx Outdated Show resolved Hide resolved

paula-stacho reviewed Sep 2, 2025

View reviewed changes

nvs119 added 5 commits September 3, 2025 20:01

didn't understand it before but now should be better

893e6f7

fixes

505d90d

unnecessary

d13312d

put entrypoint back

6ea3db4

more

208a602

nvs119 requested a review from paula-stacho September 4, 2025 00:46

addaleax reviewed Sep 4, 2025

View reviewed changes

packages/compass-web/src/entrypoint.tsx Outdated Show resolved Hide resolved

fix

f484042

paula-stacho reviewed Sep 4, 2025

View reviewed changes

nvs119 added 3 commits September 4, 2025 15:43

working w aggs

56e1223

preferences schema

c56a395

merge

97ffb20

nvs119 requested a review from paula-stacho September 4, 2025 19:57

nvs119 commented Sep 4, 2025

View reviewed changes

nvs119 added 2 commits September 4, 2025 17:59

check

923e0d5

merge

95fe0d7

paula-stacho reviewed Sep 5, 2025

View reviewed changes

nvs119 added 3 commits September 5, 2025 12:06

run checks

eed1621

providers

8f742a0

don't need them?

d117d7c

nvs119 added 3 commits September 5, 2025 13:54

merge

72d7115

package lock

6e9dfc8

Merge branch 'main' into user-data-feature-flag

0c8fea4

nvs119 requested a review from gribnoysup September 8, 2025 05:20

Anemy reviewed Sep 8, 2025

View reviewed changes

nvs119 added 2 commits September 9, 2025 15:47

put back package upgrades

775d7e6

take out storage providers until actual implementation

7d765a2

nvs119 requested a review from Anemy September 9, 2025 19:51

Anemy approved these changes Sep 9, 2025

View reviewed changes

nvs119 and others added 3 commits September 9, 2025 15:55

Merge branch 'main' into user-data-feature-flag

b8efa1c

checks

de5fbff

Merge branch 'user-data-feature-flag' of github.com:mongodb-js/compas…

2d86489

…s into user-data-feature-flag

nvs119 merged commit a09702c into main Sep 9, 2025
54 of 55 checks passed

nvs119 deleted the user-data-feature-flag branch September 9, 2025 21:35

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

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

Uh oh!

Conversation

nvs119 commented Sep 2, 2025

Description

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

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!

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!

paula-stacho commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

paula-stacho Sep 4, 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!

nvs119 Sep 4, 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!

Choose a reason for hiding this comment

Uh oh!

paula-stacho Sep 5, 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!

Anemy 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!

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!

Anemy 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

paula-stacho commented Sep 4, 2025 •

edited

Loading

paula-stacho Sep 4, 2025 •

edited

Loading

nvs119 Sep 4, 2025 •

edited

Loading

paula-stacho Sep 5, 2025 •

edited

Loading

Anemy left a comment •

edited

Loading