feat(compass-web): add the AtlasUserData class to save user data COMPASS-9565

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

@@ -78,6 +78,11 @@ export class AtlasService {
     // https://github.com/10gen/mms/blob/9f858bb987aac6aa80acfb86492dd74c89cbb862/client/packages/project/common/ajaxPrefilter.ts#L34-L49
     return this.cloudEndpoint(path);
   }
+  userDataEndpoint(path?: string): string {
+    return `https://cluster-connection.cloud-dev.mongodb.com/userData${normalizePath(
+      path
+    )}`;
+  }
   driverProxyEndpoint(path?: string): string {
     return `${this.config.ccsBaseUrl}${normalizePath(path)}`;
   }
@@ -91,13 +96,14 @@ export class AtlasService {
       { url }
     );
     try {
+      const headers = {
+        ...this.options?.defaultHeaders,
+        ...(shouldAddCSRFHeaders(init?.method) && getCSRFHeaders()),
+        ...init?.headers,
+      };
       const res = await fetch(url, {
         ...init,
-        headers: {
-          ...this.options?.defaultHeaders,
-          ...(shouldAddCSRFHeaders(init?.method) && getCSRFHeaders()),
-          ...init?.headers,
-        },
+        headers,
       });
       this.logger.log.info(
         this.logger.mongoLogId(1_001_000_309),

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

@@ -8,7 +8,7 @@ import {
 import { expect } from 'chai';
 import { renderWithStore } from '../../../test/configure-store';
 import { PipelineToolbar } from './index';
-import { CompassPipelineStorage } from '@mongodb-js/my-queries-storage';
+import { createElectronPipelineStorage } from '@mongodb-js/my-queries-storage/electron';
 
 describe('PipelineToolbar', function () {
   describe('renders with setting row - visible', function () {
@@ -23,7 +23,12 @@ describe('PipelineToolbar', function () {
         />,
         { pipeline: [{ $match: { _id: 1 } }] },
         undefined,
-        { pipelineStorage: new CompassPipelineStorage() }
+        {
+          pipelineStorage: {
+            getStorage: () =>
+              createElectronPipelineStorage({ basepath: '/tmp/test' }),
+          },
+        }
       );
       toolbar = screen.getByTestId('pipeline-toolbar');
     });

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

@@ -5,7 +5,7 @@ import { spy } from 'sinon';
 import type { SinonSpy } from 'sinon';
 import { renderWithStore } from '../../../../test/configure-store';
 import { PipelineHeader } from '.';
-import { CompassPipelineStorage } from '@mongodb-js/my-queries-storage';
+import { createElectronPipelineStorage } from '@mongodb-js/my-queries-storage/electron';
 
 describe('PipelineHeader', function () {
   let container: HTMLElement;
@@ -23,7 +23,12 @@ describe('PipelineHeader', function () {
       />,
       undefined,
       undefined,
-      { pipelineStorage: new CompassPipelineStorage() }
+      {
+        pipelineStorage: {
+          getStorage: () =>
+            createElectronPipelineStorage({ basepath: '/tmp/test' }),
+        },
+      }
     );
     container = screen.getByTestId('pipeline-header');
   });

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

@@ -1,6 +1,6 @@
 import React from 'react';
 import { connect } from 'react-redux';
-import { Button, css, Icon, spacing } from '@mongodb-js/compass-components';
+import { Button, Icon, css, spacing } from '@mongodb-js/compass-components';
 import { exportToLanguage } from '../../../modules/export-to-language';
 import { SaveMenu } from './pipeline-menus';
 import PipelineName from './pipeline-name';

packages/compass-aggregations/src/modules/id.ts

@@ -1,4 +1,4 @@
-import { ObjectId } from 'bson';
+import { UUID } from 'bson';
 import type { ClonePipelineAction } from './clone-pipeline';
 import { CLONE_PIPELINE } from './clone-pipeline';
 import type { NewPipelineConfirmedAction } from './is-new-pipeline-confirm';
@@ -51,7 +51,7 @@ export default function reducer(
       ConfirmNewPipelineActions.NewPipelineConfirmed
     )
   ) {
-    return new ObjectId().toHexString();
+    return new UUID().toString();
   }
   if (isAction<RestorePipelineAction>(action, RESTORE_PIPELINE)) {
     return action.storedOptions.id;

packages/compass-aggregations/src/modules/pipeline-builder/stage-editor.spec.ts

@@ -21,7 +21,7 @@ import {
 } from './stage-editor';
 import type { StageEditorState, StoreStage, Wizard } from './stage-editor';
 import reducer from '../';
-import { CompassPipelineStorage } from '@mongodb-js/my-queries-storage';
+import { createElectronPipelineStorage } from '@mongodb-js/my-queries-storage/electron';
 import Sinon from 'sinon';
 import type Stage from './stage';
 import { mockDataService } from '../../../test/mocks/data-service';
@@ -130,7 +130,9 @@ function createStore({
         localAppRegistry: new AppRegistry(),
         atlasAiService: {} as any,
         pipelineBuilder,
-        pipelineStorage: new CompassPipelineStorage(),
+        pipelineStorage: createElectronPipelineStorage({
+          basepath: '/tmp/test',
+        }),
         instance: {} as any,
         workspaces: {} as any,
         preferences,

packages/compass-aggregations/src/modules/pipeline-builder/text-editor-pipeline.spec.ts

@@ -10,7 +10,7 @@ import type { PipelineBuilderThunkDispatch } from '..';
 import reducer from '..';
 import Sinon from 'sinon';
 import { toggleAutoPreview } from '../auto-preview';
-import { CompassPipelineStorage } from '@mongodb-js/my-queries-storage';
+import { createElectronPipelineStorage } from '@mongodb-js/my-queries-storage/electron';
 import { mockDataService } from '../../../test/mocks/data-service';
 
 function createStore(
@@ -46,7 +46,9 @@ function createStore(
       thunk.withExtraArgument({
         atlasAiService: {} as any,
         pipelineBuilder,
-        pipelineStorage: new CompassPipelineStorage(),
+        pipelineStorage: createElectronPipelineStorage({
+          basepath: '/tmp/test',
+        }),
         instance: {} as any,
         workspaces: {} as any,
         preferences: {

packages/compass-aggregations/src/stores/store.ts

@@ -33,7 +33,7 @@ import type { CollectionTabPluginMetadata } from '@mongodb-js/compass-collection
 import type { PreferencesAccess } from 'compass-preferences-model';
 import type { Logger } from '@mongodb-js/compass-logging/provider';
 import type { AtlasAiService } from '@mongodb-js/compass-generative-ai/provider';
-import type { PipelineStorage } from '@mongodb-js/my-queries-storage/provider';
+import type { PipelineStorageAccess } from '@mongodb-js/my-queries-storage/provider';
 import { maxTimeMSChanged } from '../modules/max-time-ms';
 import type {
   ConnectionInfoRef,
@@ -80,7 +80,7 @@ export type AggregationsPluginServices = {
   logger: Logger;
   track: TrackFunction;
   atlasAiService: AtlasAiService;
-  pipelineStorage?: PipelineStorage;
+  pipelineStorage?: PipelineStorageAccess;
   connectionInfoRef: ConnectionInfoRef;
   connectionScopedAppRegistry: ConnectionScopedAppRegistry<'open-export'>;
   collection: Collection;
@@ -178,7 +178,7 @@ export function activateAggregationsPlugin(
         globalAppRegistry,
         localAppRegistry,
         pipelineBuilder,
-        pipelineStorage,
+        pipelineStorage: pipelineStorage?.getStorage(),
         workspaces,
         instance,
         preferences,

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

@@ -852,18 +852,6 @@ export const storedUserPreferencesProps: Required<{
     type: 'boolean',
   },
 
-  enableMyQueries: {
-    ui: true,
-    cli: true,
-    global: true,
-    description: {
-      short:
-        'Enable My Queries feature to save and manage favorite queries and aggregations',
-    },
-    validator: z.boolean().default(true),
-    type: 'boolean',
-  },
-
   enableAggregationBuilderRunPipeline: {
     ui: true,
     cli: true,
@@ -1032,6 +1020,17 @@ export const storedUserPreferencesProps: Required<{
     validator: z.boolean().default(true),
     type: 'boolean',
   },
+  enableMyQueries: {
+    ui: true,
+    cli: true,
+    global: true,
+    description: {
+      short:
+        'Enable My Queries feature to save and manage favorite queries and aggregations',
+    },
+    validator: z.boolean().default(true),
+    type: 'boolean',
+  },
 
   inferNamespacesFromPrivileges: {
     ui: true,

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

@@ -27,9 +27,9 @@ import {
   RecentQueryStorageProvider,
 } from '@mongodb-js/my-queries-storage/provider';
 import {
-  compassFavoriteQueryStorageAccess,
-  compassRecentQueryStorageAccess,
-} from '@mongodb-js/my-queries-storage';
+  createElectronFavoriteQueryStorage,
+  createElectronRecentQueryStorage,
+} from '@mongodb-js/my-queries-storage/electron';
 import { createNoopTrack } from '@mongodb-js/compass-telemetry/provider';
 
 const noop = () => {
@@ -67,10 +67,19 @@ describe('QueryBar Component', function () {
     } as QueryBarExtraArgs);
     store.dispatch(toggleQueryOptions(expanded));
 
+    const favoriteQueryStorage = {
+      getStorage: () =>
+        createElectronFavoriteQueryStorage({ basepath: '/tmp/test' }),
+    };
+    const recentQueryStorage = {
+      getStorage: () =>
+        createElectronRecentQueryStorage({ basepath: '/tmp/test' }),
+    };
+
     const component = (
       <PreferencesProvider value={preferences}>
-        <FavoriteQueryStorageProvider value={compassFavoriteQueryStorageAccess}>
-          <RecentQueryStorageProvider value={compassRecentQueryStorageAccess}>
+        <FavoriteQueryStorageProvider value={favoriteQueryStorage}>
+          <RecentQueryStorageProvider value={recentQueryStorage}>
             <Provider store={store}>
               <QueryBar
                 source="test"

packages/compass-query-bar/src/components/query-history/index.spec.tsx

@@ -14,8 +14,12 @@ import os from 'os';
 import path from 'path';
 import QueryHistory from '.';
 import {
-  CompassFavoriteQueryStorage,
-  CompassRecentQueryStorage,
+  createElectronFavoriteQueryStorage,
+  createElectronRecentQueryStorage,
+} from '@mongodb-js/my-queries-storage/electron';
+import {
+  FavoriteQueryStorageProvider,
+  RecentQueryStorageProvider,
 } from '@mongodb-js/my-queries-storage';
 import { fetchRecents, fetchFavorites } from '../../stores/query-bar-reducer';
 import { configureStore } from '../../stores/query-bar-store';
@@ -47,8 +51,8 @@ const FAVORITE_QUERY = {
 };
 
 function createStore(basepath: string) {
-  const favoriteQueryStorage = new CompassFavoriteQueryStorage({ basepath });
-  const recentQueryStorage = new CompassRecentQueryStorage({ basepath });
+  const favoriteQueryStorage = createElectronFavoriteQueryStorage({ basepath });
+  const recentQueryStorage = createElectronRecentQueryStorage({ basepath });
 
   const store = configureStore(
     {
@@ -79,13 +83,25 @@ function createStore(basepath: string) {
 
 const renderQueryHistory = (basepath: string) => {
   const data = createStore(basepath);
+
+  const favoriteQueryStorage = {
+    getStorage: () => data.favoriteQueryStorage,
+  };
+  const recentQueryStorage = {
+    getStorage: () => data.recentQueryStorage,
+  };
+
   render(
-    <Provider store={data.store}>
-      <QueryHistory
-        onUpdateRecentChoosen={() => {}}
-        onUpdateFavoriteChoosen={() => {}}
-      />
-    </Provider>
+    <FavoriteQueryStorageProvider value={favoriteQueryStorage}>
+      <RecentQueryStorageProvider value={recentQueryStorage}>
+        <Provider store={data.store}>
+          <QueryHistory
+            onUpdateRecentChoosen={() => {}}
+            onUpdateFavoriteChoosen={() => {}}
+          />
+        </Provider>
+      </RecentQueryStorageProvider>
+    </FavoriteQueryStorageProvider>
   );
   return data;
 };

packages/compass-query-bar/src/stores/query-bar-reducer.spec.ts

@@ -216,7 +216,7 @@ describe('queryBarReducer', function () {
         .deep.eq(appliedQuery);
 
       // updateAttributes is called in saveRecentAsFavorite and updateFavoriteQuery
-      expect(updateAttributesStub).to.have.been.calledTwice;
+      expect(updateAttributesStub).to.have.been.calledOnce;
       expect(saveQueriesStub).not.to.have.been.calledTwice;
     });
   });

packages/compass-query-bar/src/stores/query-bar-reducer.ts

@@ -268,9 +268,20 @@ export const fetchRecents = (): QueryBarThunkAction<
   return async (
     dispatch,
     _getState,
-    { recentQueryStorage, logger: { debug } }
+    { recentQueryStorage, logger: { debug }, preferences }
   ) => {
     try {
+      // Check if My Queries feature is enabled
+      const { enableMyQueries } = preferences.getPreferences();
+      if (!enableMyQueries) {
+        // If feature is disabled, dispatch empty array
+        dispatch({
+          type: QueryBarActions.RecentQueriesFetched,
+          recents: [],
+        });
+        return;
+      }
+
       const {
         queryBar: { namespace },
       } = _getState();
@@ -286,7 +297,14 @@ export const fetchRecents = (): QueryBarThunkAction<
 };
 
 export const fetchSavedQueries = (): QueryBarThunkAction<void> => {
-  return (dispatch) => {
+  return (dispatch, _getState, { preferences }) => {
+    // Check if My Queries feature is enabled
+    const { enableMyQueries } = preferences.getPreferences();
+    if (!enableMyQueries) {
+      // If feature is disabled, don't fetch anything
+      return;
+    }
+
     void dispatch(fetchRecents());
     void dispatch(fetchFavorites());
   };
@@ -303,9 +321,20 @@ export const fetchFavorites = (): QueryBarThunkAction<
   return async (
     dispatch,
     _getState,
-    { favoriteQueryStorage, logger: { debug } }
+    { favoriteQueryStorage, logger: { debug }, preferences }
   ) => {
     try {
+      // Check if My Queries feature is enabled
+      const { enableMyQueries } = preferences.getPreferences();
+      if (!enableMyQueries) {
+        // If feature is disabled, dispatch empty array
+        dispatch({
+          type: QueryBarActions.FavoriteQueriesFetched,
+          favorites: [],
+        });
+        return;
+      }
+
       const {
         queryBar: { namespace },
       } = _getState();
@@ -356,10 +385,7 @@ export const saveRecentAsFavorite = (
       };
 
       // add it in the favorite
-      await favoriteQueryStorage?.updateAttributes(
-        favoriteQuery._id,
-        favoriteQuery
-      );
+      await favoriteQueryStorage?.saveQuery(favoriteQuery, favoriteQuery._id);
 
       // update favorites
       void dispatch(fetchFavorites());