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

* feat(save-user-data): create a user data abstract class

* fix: rm defaults and add semaphore to FileUserData

* feat(save-user-data): push for help

* feat(save-user-data): comment out nulls

* feat(save-user-data): create a user data abstract class

* fix: rm defaults and add semaphore to FileUserData

* feat(save-user-data): push for help

* potentital org and group id retrieval

* minor fixes

* unit testing

* package-lock.json

* fix: parse one by one in readAll

* fix: change updateAttributes return type to boolean

* stricter typing for type param and fix update tests

* add getResourceUrl and change groupId to projectId

* put data type in IUserData class

* fix(user-data): add datatype to IUserData abstract class & tests

* fix(user-data): make create and update return type to be boolean, like queries

* fix(compass-aggregations): fix method typing

* feat: building demo for saving user data project

* path segment and method binding

* working demo

* restore again

* make it work on dev

* test fixes

* save progress

* everything working WITH feature flag

* Fix compass-sidebar dependency issue by moving useMyQueriesFeature to compass-preferences-model

* some fixes

* post rebase

* fix dangling participles

* fix tests

* fix some stuff for test

* recents and favorites but aggs not work

* checks and stuff

* change aggs to uuid and remove response.ok checks

* service accessed through locator

* Working with build time impls

* redone code

* tests

* no credentials: include

* fixes

* fix my queries storage package check

* test fixes

* fix saved aggregations unit test

* check

* db coll testS

---------

Co-authored-by: Niva Vaani Sivakumar <[email protected]>

Author: myang1220

package-lock.json

@@ -78,6 +78,12 @@ export class AtlasService {
     // https://github.com/10gen/mms/blob/9f858bb987aac6aa80acfb86492dd74c89cbb862/client/packages/project/common/ajaxPrefilter.ts#L34-L49
     return this.cloudEndpoint(path);
   }
+  // TODO (COMPASS-9663): these should come from the config property per environment
+  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 +97,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),
@@ -132,6 +139,7 @@ export class AtlasService {
         ...init?.headers,
         ...authHeaders,
       },
+      credentials: 'include',
     });
   }
   async automationAgentRequest(

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

@@ -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/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-header/index.spec.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/components/pipeline-toolbar/pipeline-settings/index.tsx

@@ -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/id.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/stage-editor.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/modules/pipeline-builder/text-editor-pipeline.spec.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-aggregations/src/stores/store.ts

@@ -11,7 +11,15 @@ import {
 import BulkUpdateModal from './bulk-update-modal';
 
 import { FavoriteQueryStorageProvider } from '@mongodb-js/my-queries-storage/provider';
-import { compassFavoriteQueryStorageAccess } from '@mongodb-js/my-queries-storage';
+import { createElectronFavoriteQueryStorage } from '@mongodb-js/my-queries-storage';
+
+// Create mock storage access object for testing
+const mockFavoriteQueryStorage = createElectronFavoriteQueryStorage({
+  basepath: '/tmp/test',
+});
+const compassFavoriteQueryStorageAccess = {
+  getStorage: () => mockFavoriteQueryStorage,
+};
 
 function renderBulkUpdateModal(
   props?: Partial<React.ComponentProps<typeof BulkUpdateModal>>