feat: Add gen ai org and project settings to Compass for CompassWeb usage COMPASS-8377 #6434
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| import { createNoopLogger } from '@mongodb-js/compass-logging/provider'; | ||
| import { Preferences, type PreferencesAccess } from './preferences'; | ||
| import type { UserPreferences } from './preferences-schema'; | ||
| import { type AllPreferences } from './preferences-schema'; | ||
| import { InMemoryStorage } from './preferences-in-memory-storage'; | ||
| import { getActiveUser } from './utils'; | ||
|
|
||
| export class CompassWebPreferencesAccess implements PreferencesAccess { | ||
| private _preferences: Preferences; | ||
| constructor(preferencesOverrides?: Partial<AllPreferences>) { | ||
| this._preferences = new Preferences({ | ||
| logger: createNoopLogger(), | ||
| preferencesStorage: new InMemoryStorage(preferencesOverrides), | ||
| }); | ||
| } | ||
|
|
||
| savePreferences(_attributes: Partial<UserPreferences>) { | ||
| // Only allow saving the optInDataExplorerGenAIFeatures preference. | ||
| if ( | ||
| Object.keys(_attributes).length === 1 && | ||
| 'optInDataExplorerGenAIFeatures' in _attributes | ||
| ) { | ||
| return Promise.resolve(this._preferences.savePreferences(_attributes)); | ||
| } | ||
| return Promise.resolve(this._preferences.getPreferences()); | ||
| } | ||
|
|
||
| refreshPreferences() { | ||
| return Promise.resolve(this._preferences.getPreferences()); | ||
| } | ||
|
|
||
| getPreferences() { | ||
| return this._preferences.getPreferences(); | ||
| } | ||
|
|
||
| ensureDefaultConfigurableUserPreferences() { | ||
| return this._preferences.ensureDefaultConfigurableUserPreferences(); | ||
| } | ||
|
|
||
| getConfigurableUserPreferences() { | ||
| return Promise.resolve(this._preferences.getConfigurableUserPreferences()); | ||
| } | ||
|
|
||
| getPreferenceStates() { | ||
| return Promise.resolve(this._preferences.getPreferenceStates()); | ||
| } | ||
|
|
||
| onPreferenceValueChanged<K extends keyof AllPreferences>( | ||
| preferenceName: K, | ||
| callback: (value: AllPreferences[K]) => void | ||
| ) { | ||
| return ( | ||
| this._preferences?.onPreferencesChanged?.( | ||
| (preferences: Partial<AllPreferences>) => { | ||
| if (Object.keys(preferences).includes(preferenceName)) { | ||
| return callback((preferences as AllPreferences)[preferenceName]); | ||
| } | ||
| } | ||
| ) ?? | ||
| (() => { | ||
| /* no fallback */ | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| createSandbox() { | ||
| return Promise.resolve( | ||
| new CompassWebPreferencesAccess(this.getPreferences()) | ||
| ); | ||
| } | ||
|
|
||
| getPreferencesUser() { | ||
| return getActiveUser(this); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At the moment this doesn't actually save the preference to the user's AppUser in Atlas since it requires a post request to mms to do that.
We'll need to update the PreferencesStorage that CompassWeb uses to make the post request, and thenonly update the preference when the request succeeds.I'm thinking we'll want to create aI'm thinking we could either do that work in a separate ticket/pr, or include it here.CompassWebPreferencesStoragefor that, it would effectively be anInMemoryStoragewith the same single preferenceoptInDataExplorerGenAIFeaturesoverride when theupdatePreferencesfunction is called, which would then perform the post request.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, one thing that hit me when looking at how we did this the initial
hellocheck is that we don't make preferences themselves to hit the endpoint, right? We send the request and separately update the preferences, so maybe while we're still dealing with just one extra preference here that requires a backend request, we should follow the pattern. What do you think?Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That makes way more sense, thanks for the suggestion. Keep the existing
InMemoryStorageand have the preference update POST request happen in the AtlasAIService and then call thissavePreferencesfrom there when it's successful. @ruchitharajaghatta does that sound good to you?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Chatting with Ruchitha, we'll do it in a follow up pr where we actually use the setting.