feat(save-user-data): extend user data abstract class for api backend COMPASS-9558

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

@@ -7,7 +7,7 @@ import { createNoopLogger } from '@mongodb-js/compass-logging/provider';
 import { CompassAtlasAuthService } from './compass-atlas-auth-service';
 
 const ATLAS_CONFIG = {
-  wsBaseUrl: 'ws://example.com',
+  ccsBaseUrl: 'ws://example.com',
   cloudBaseUrl: 'ws://example.com/cloud',
   atlasApiBaseUrl: 'http://example.com/api',
   atlasLogin: {

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

@@ -76,7 +76,7 @@ export class AtlasService {
     return this.cloudEndpoint(path);
   }
   driverProxyEndpoint(path?: string): string {
-    return `${this.config.wsBaseUrl}${normalizePath(path)}`;
+    return `${this.config.ccsBaseUrl}${normalizePath(path)}`;
   }
   async fetch(url: RequestInfo | URL, init?: RequestInit): Promise<Response> {
     throwIfNetworkTrafficDisabled(this.preferences);

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

@@ -48,7 +48,7 @@ describe('CompassAuthServiceMain', function () {
   };
 
   const defaultConfig = {
-    wsBaseUrl: 'ws://example.com',
+    ccsBaseUrl: 'ws://example.com',
     cloudBaseUrl: 'ws://example.com/cloud',
     atlasApiBaseUrl: 'http://example.com/api',
     atlasLogin: {

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

@@ -7,8 +7,7 @@ export class SecretStore {
   private readonly userData: FileUserData<typeof AtlasPluginStateSchema>;
   private readonly fileName = 'AtlasPluginState';
   constructor(basePath?: string) {
-    this.userData = new FileUserData(AtlasPluginStateSchema, {
-      subdir: 'AtlasState',
+    this.userData = new FileUserData(AtlasPluginStateSchema, 'AtlasState', {
       basePath,
     });
   }

packages/atlas-service/src/util.ts

@@ -96,7 +96,7 @@ export type AtlasServiceConfig = {
   /**
    * MongoDB Driver WebSocket proxy base url
    */
-  wsBaseUrl: string;
+  ccsBaseUrl: string;
   /**
    * Cloud UI backend base url
    */
@@ -131,7 +131,7 @@ export type AtlasServiceConfig = {
  */
 const config = {
   'atlas-local': {
-    wsBaseUrl: 'ws://localhost:61001/ws',
+    ccsBaseUrl: 'ws://localhost:61001/ws',
     cloudBaseUrl: '',
     atlasApiBaseUrl: 'http://localhost:8080/api/private',
     atlasLogin: {
@@ -141,7 +141,7 @@ const config = {
     authPortalUrl: 'https://account-dev.mongodb.com/account/login',
   },
   'atlas-dev': {
-    wsBaseUrl: '',
+    ccsBaseUrl: '',
     cloudBaseUrl: '',
     atlasApiBaseUrl: 'https://cloud-dev.mongodb.com/api/private',
     atlasLogin: {
@@ -151,7 +151,7 @@ const config = {
     authPortalUrl: 'https://account-dev.mongodb.com/account/login',
   },
   'atlas-qa': {
-    wsBaseUrl: '',
+    ccsBaseUrl: '',
     cloudBaseUrl: '',
     atlasApiBaseUrl: 'https://cloud-qa.mongodb.com/api/private',
     atlasLogin: {
@@ -161,7 +161,7 @@ const config = {
     authPortalUrl: 'https://account-qa.mongodb.com/account/login',
   },
   atlas: {
-    wsBaseUrl: '',
+    ccsBaseUrl: '',
     cloudBaseUrl: '',
     atlasApiBaseUrl: 'https://cloud.mongodb.com/api/private',
     atlasLogin: {
@@ -171,7 +171,7 @@ const config = {
     authPortalUrl: 'https://account.mongodb.com/account/login',
   },
   'web-sandbox-atlas-local': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'http://localhost:8080/api/private',
     atlasLogin: {
@@ -181,7 +181,7 @@ const config = {
     authPortalUrl: 'https://account-dev.mongodb.com/account/login',
   },
   'web-sandbox-atlas-dev': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'https://cloud-dev.mongodb.com/api/private',
     atlasLogin: {
@@ -191,7 +191,7 @@ const config = {
     authPortalUrl: 'https://account-dev.mongodb.com/account/login',
   },
   'web-sandbox-atlas-qa': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'https://cloud-dev.mongodb.com/api/private',
     atlasLogin: {
@@ -201,7 +201,7 @@ const config = {
     authPortalUrl: 'https://account-dev.mongodb.com/account/login',
   },
   'web-sandbox-atlas': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'https://cloud.mongodb.com/api/private',
     atlasLogin: {

packages/compass-data-modeling/src/services/data-model-storage-electron.tsx

@@ -12,10 +12,13 @@ class DataModelStorageElectron implements DataModelStorage {
     typeof MongoDBDataModelDescriptionSchema
   >;
   constructor(basePath?: string) {
-    this.userData = new FileUserData(MongoDBDataModelDescriptionSchema, {
-      subdir: 'DataModelDescriptions',
-      basePath,
-    });
+    this.userData = new FileUserData(
+      MongoDBDataModelDescriptionSchema,
+      'DataModelDescription',
+      {
+        basePath,
+      }
+    );
   }
   save(description: MongoDBDataModelDescription) {
     return this.userData.write(description.id, description);

packages/compass-preferences-model/src/preferences-persistent-storage.ts

@@ -25,10 +25,13 @@ export class PersistentStorage implements PreferencesStorage {
   private safeStorage?: PreferencesSafeStorage;
 
   constructor(basePath?: string, safeStorage?: PreferencesSafeStorage) {
-    this.userData = new FileUserData(getPreferencesValidator(), {
-      subdir: 'AppPreferences',
-      basePath,
-    });
+    this.userData = new FileUserData(
+      getPreferencesValidator(),
+      'AppPreferences',
+      {
+        basePath,
+      }
+    );
     this.safeStorage = safeStorage;
   }
 

packages/compass-preferences-model/src/user-storage.ts

@@ -26,8 +26,7 @@ export interface UserStorage {
 export class UserStorageImpl implements UserStorage {
   private readonly userData: FileUserData<typeof UserSchema>;
   constructor(basePath?: string) {
-    this.userData = new FileUserData(UserSchema, {
-      subdir: 'Users',
+    this.userData = new FileUserData(UserSchema, 'Users', {
       basePath,
     });
   }
@@ -79,8 +78,4 @@ export class UserStorageImpl implements UserStorage {
     await this.userData.write(user.id, user);
     return this.getUser(user.id);
   }
-
-  private getFileName(id: string) {
-    return `${id}.json`;
-  }
 }

packages/compass-saved-aggregations-queries/src/index.spec.tsx

@@ -227,9 +227,11 @@ describe('AggregationsAndQueriesAndUpdatemanyList', function () {
       queryStorageLoadAllStub = sandbox
         .stub(queryStorage, 'loadAll')
         .resolves(queries.map((item) => item.query));
-      sandbox
-        .stub(pipelineStorage, 'loadAll')
-        .resolves(pipelines.map((item) => item.aggregation));
+      sandbox.stub(pipelineStorage, 'loadAll').resolves(
+        pipelines.map((item) => {
+          return { ...item.aggregation, lastModified: new Date() };
+        })
+      );
 
       renderPlugin();
 

packages/compass-shell/src/modules/history-storage.ts

@@ -6,9 +6,8 @@ export class HistoryStorage {
   userData;
 
   constructor(basePath?: string) {
-    this.userData = new FileUserData(z.string().array(), {
+    this.userData = new FileUserData(z.string().array(), getAppName() ?? '', {
       // Todo: https://jira.mongodb.org/browse/COMPASS-7080
-      subdir: getAppName() ?? '',
       basePath,
     });
   }

packages/compass-user-data/src/index.ts

@@ -1,3 +1,3 @@
-export type { Stats, ReadAllResult, ReadAllWithStatsResult } from './user-data';
-export { IUserData, FileUserData } from './user-data';
+export type { ReadAllResult } from './user-data';
+export { type IUserData, FileUserData, AtlasUserData } from './user-data';
 export { z } from 'zod';