chore(compass-preferences-model): use optInGenAIFeatures for Compass COMPASS-9593 #7129

gagik · 2025-07-21T15:13:25Z

Aligns Compass and DE in their opt-in requirements for AI features. Feature flagged.

…and DE

…n-ai

gagik · 2025-07-28T09:04:24Z

packages/compass-e2e-tests/tests/atlas-login.test.ts

-  )}`;
-}
-
-describe('Atlas Login', function () {


I could also skip these if re-introducing is likely enough.
I also assume we're not going to delete stores/atlas-login.

I think you should clean it up, but I don't think you necessarily need to do it in this PR. This plugin was the first attempt at this sort of hight level cross plugin interface and implementation and so contains some patterns that we moved away from, it's probably for the better if we can completely drop it from the codebase

added #7150 to handle the cleanup

Copilot

Pull Request Overview

This PR standardizes the naming of the opt-in preference for AI features across Compass and Data Explorer by renaming optInDataExplorerGenAIFeatures to optInGenAIFeatures. This aligns the naming convention between the two products and makes the preference more generic and reusable.

Renames preference key from optInDataExplorerGenAIFeatures to optInGenAIFeatures
Updates preference description to be more generic
Changes default value from true to false
Updates all references and tests to use the new preference name

Reviewed Changes

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

Show a summary per file

File	Description
packages/compass-web/src/preferences.tsx	Updates preference name in default preferences object
packages/compass-web/sandbox/sandbox-atlas-sign-in.tsx	Updates type definition and variable assignment for the new preference name
packages/compass-web/sandbox/index.tsx	Updates preference name in sandbox configuration
packages/compass-preferences-model/src/preferences-schema.tsx	Defines the new preference schema with updated name, description, and default value
packages/compass-preferences-model/src/compass-web-preferences-access.ts	Updates editable preferences list with new name
packages/compass-generative-ai/src/store/atlas-optin-reducer.ts	Updates preference checks and method calls to use new naming
packages/compass-generative-ai/src/store/atlas-optin-reducer.spec.ts	Updates all test cases to use new preference and method names
packages/compass-generative-ai/src/atlas-ai-service.ts	Refactors opt-in method and removes unnecessary imports
packages/compass-generative-ai/src/atlas-ai-service.spec.ts	Adds comprehensive tests for the new opt-in method
packages/compass-e2e-tests/tests/atlas-login.test.ts	Removes entire test file
packages/compass-e2e-tests/tests/atlas-cloud/collection-ai-query.test.ts	Updates feature flag references to use new preference name

Copilot · 2025-07-28T09:05:28Z

packages/compass-generative-ai/src/atlas-ai-service.ts

+      // Performs a post request to Atlas to set the user opt in preference to true.
+      await this.atlasService.authenticatedFetch(
+        this.atlasService.cloudEndpoint(
+          'settings/optInDataExplorerGenAIFeatures'


The URL path still references 'optInDataExplorerGenAIFeatures' but the preference has been renamed to 'optInGenAIFeatures'. Consider updating the API endpoint to match the new naming convention for consistency.

Suggested change

'settings/optInDataExplorerGenAIFeatures'

'settings/optInGenAIFeatures'

This is how we ensure backwards-compatibility

Copilot · 2025-07-28T09:05:29Z

packages/compass-preferences-model/src/preferences-schema.tsx

    },
-    validator: z.boolean().default(true),
+    validator: z.boolean().default(false),


Changing the default value from true to false is a breaking change that could affect existing users who had the feature enabled by default. This could disable AI features for users who were previously opted in.

Suggested change

validator: z.boolean().default(false),

validator: z.boolean().default(true),

This was likely an unintentional default which always gets overriden by the 'settings/optInDataExplorerGenAIFeatures' fetch

gagik · 2025-07-28T09:06:44Z

packages/compass-preferences-model/src/preferences-schema.tsx

    },
-    validator: z.boolean().default(true),
+    validator: z.boolean().default(false),


correct me if not so but this change shouldn't have any side effects on DE. The state of this was always being overriden by the API request and we'd likely not have wanted this to be true anyhow.

Anemy · 2025-08-05T05:35:01Z

packages/compass-web/src/preferences.tsx

@@ -55,7 +55,7 @@ export function useCompassWebPreferences(
      enableShell: false,
      enableCreatingNewConnections: false,
      enableGlobalWrites: false,
-      optInDataExplorerGenAIFeatures: false,
+      optInGenAIFeatures: false,


Do we have a CLOUDP ticket to update where we pass this preference to CompassWeb initialPreferences? https://github.com/10gen/mms/blob/8e00a3d4899e1f495b25ba30a22bb5d28ddd3bc4/client/packages/project/dataExplorerCompassWeb/router.tsx#L320

I may not fully understand the flow but I think because we continue to both GET and POST to the old endpoints which use the MMS OPTED_INTO_GEN_AI_DATA_EXPLORER_FIELD field, there's no changes needed on the cloud end. The naming is now slightly off on client but in practice we're still just consuming the old database field on DE.

https://github.com/10gen/mms/blob/677f241fef1153c7d28682c699cee7ef9b38af27/server/src/main/com/xgen/svc/mms/res/SettingsResource.java#L891
⬇️
https://github.com/10gen/mms/blob/677f241fef1153c7d28682c699cee7ef9b38af27/server/src/main/com/xgen/cloud/user/_private/dao/UserDao.java#L1075

ohhh, I see this is about the client-side routing there, I didn't realize there's MMS react code for DE. Will look into this.

actually I guess what I'm mentioning still stands: https://github.com/10gen/mms/blob/335c98b78c1b9e9dd8b4fd69efb2bc2170c843a5/client/packages/common/models/Settings.ts#L720

If I'm understanding it correctly the name of the preference variable we pass to initialPreferences does matter in how it's mapped to the Compass setting (purely on the frontend), we'll want to update that from optInDataExplorerGenAIFeatures to optInGenAIFeatures. It should typescript error when we update compass-web at least though.

ah got it, yes the shared types aspect of it would be an issue. created CLOUDP-336196

do we first need to i.e. merge this and then do a Compass dependency release and then bump it in compass-web and update there?

Yup! Just making sure we had that planned. Changes here look good!

chore(compass-preferences-model): use optInGenAIFeatures for Compass …

bed75dd

…and DE

gagik force-pushed the gagik/opt-in-ai branch from e8d1aa5 to bed75dd Compare July 25, 2025 11:13

gagik added 2 commits July 28, 2025 10:53

fix: delete atlas login tests

617ff7c

Merge branch 'main' of github.com:mongodb-js/compass into gagik/opt-i…

1c3bcc3

…n-ai

gagik changed the title ~~WIP chore(compass-preferences-model): use optInGenAIFeatures for Compass~~ WIP chore(compass-preferences-model): use optInGenAIFeatures for Compass COMPASS-9593 Jul 28, 2025

gagik commented Jul 28, 2025

View reviewed changes

gagik changed the title ~~WIP chore(compass-preferences-model): use optInGenAIFeatures for Compass COMPASS-9593~~ chore(compass-preferences-model): use optInGenAIFeatures for Compass COMPASS-9593 Jul 28, 2025

gagik marked this pull request as ready for review July 28, 2025 09:04

Copilot AI review requested due to automatic review settings July 28, 2025 09:04

gagik requested a review from a team as a code owner July 28, 2025 09:04

gagik force-pushed the gagik/opt-in-ai branch from 1c3bcc3 to 7562746 Compare July 28, 2025 09:04

Copilot AI reviewed Jul 28, 2025

View reviewed changes

gagik commented Jul 28, 2025

View reviewed changes

fix: cleanup test

3df8f4a

gagik force-pushed the gagik/opt-in-ai branch from 7562746 to 3df8f4a Compare July 28, 2025 09:08

gagik changed the base branch from main to compass-remove-ai-auth July 29, 2025 10:55

gagik changed the base branch from compass-remove-ai-auth to feature/no-auth-ai July 29, 2025 10:57

This was referenced Jul 29, 2025

chore: remove Atlas Sign-In logic COMPASS-9595 #7150

Draft

chore(compass-generative-ai): update Gen AI opt-in modal COMPASS-9593 #7164

Draft

chore: use a feature flag

44e5585

gagik changed the base branch from feature/no-auth-ai to main August 4, 2025 14:59

Anemy reviewed Aug 5, 2025

View reviewed changes

Anemy approved these changes Aug 5, 2025

View reviewed changes

	'settings/optInDataExplorerGenAIFeatures'
	'settings/optInGenAIFeatures'

	validator: z.boolean().default(false),
	validator: z.boolean().default(true),

chore(compass-preferences-model): use optInGenAIFeatures for Compass COMPASS-9593 #7129

Are you sure you want to change the base?

chore(compass-preferences-model): use optInGenAIFeatures for Compass COMPASS-9593 #7129

Uh oh!

Conversation

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

Uh oh!

Uh oh!

gagik Jul 28, 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!

gagik Jul 29, 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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gagik Jul 28, 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!

gagik Aug 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!

gagik Aug 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!

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!

gagik Aug 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gagik commented Jul 21, 2025 •

edited

Loading

gagik Jul 28, 2025 •

edited

Loading

gagik Jul 29, 2025 •

edited

Loading

gagik Jul 28, 2025 •

edited

Loading

gagik Aug 5, 2025 •

edited

Loading

gagik Aug 5, 2025 •

edited

Loading

gagik Aug 5, 2025 •

edited

Loading