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

* 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

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

* potentital org and group id retrieval

* minor fixes

* unit testing

* typo

Co-authored-by: Copilot <[email protected]>

* 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

* change wsBaseUrl to ccsBaseUrl in spec files

* chore(user-data): remove redundant withStats methods

* fix(user-data): remove nonexistent exports

* fix(my-queries-storage): adjust types to match the method behavior

* fix(saved-aggregations-queries): adjust test fixture

* 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

* revert: reset bson-transpilers files to master state

Remove unwanted bson-transpilers changes that were accidentally included in the rebase.
This resets the bson-transpilers package back to its master state while preserving
the user-data related changes that are needed for this PR.

* fix: rebuild bson-transpilers symbol tables

Rebuild the generated symbol table files to ensure they are properly
formatted and up-to-date with the current source templates.

* restore big files

* restore again

* package lock

* comments

* log ids

* changes

* copilot review changes

---------

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

Author: 4 people

package-lock.json

@@ -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.spec.ts

@@ -79,7 +79,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/atlas-service.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/main.spec.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/secret-store.ts

@@ -96,7 +96,7 @@ export type AtlasServiceConfig = {
   /**
    * MongoDB Driver WebSocket proxy base url
    */
-  wsBaseUrl: string;
+  ccsBaseUrl: string;
   /**
    * Cloud UI backend base url
    */
@@ -135,7 +135,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: {
@@ -146,7 +146,7 @@ const config = {
     assistantApiBaseUrl: 'https://knowledge.staging.corp.mongodb.com/api/v1',
   },
   'atlas-dev': {
-    wsBaseUrl: '',
+    ccsBaseUrl: '',
     cloudBaseUrl: '',
     atlasApiBaseUrl: 'https://cloud-dev.mongodb.com/api/private',
     atlasLogin: {
@@ -157,7 +157,7 @@ const config = {
     assistantApiBaseUrl: 'https://knowledge.staging.corp.mongodb.com/api/v1',
   },
   'atlas-qa': {
-    wsBaseUrl: '',
+    ccsBaseUrl: '',
     cloudBaseUrl: '',
     atlasApiBaseUrl: 'https://cloud-qa.mongodb.com/api/private',
     atlasLogin: {
@@ -168,7 +168,7 @@ const config = {
     assistantApiBaseUrl: 'https://knowledge.staging.corp.mongodb.com/api/v1',
   },
   atlas: {
-    wsBaseUrl: '',
+    ccsBaseUrl: '',
     cloudBaseUrl: '',
     atlasApiBaseUrl: 'https://cloud.mongodb.com/api/private',
     atlasLogin: {
@@ -179,7 +179,7 @@ const config = {
     assistantApiBaseUrl: 'https://knowledge.staging.corp.mongodb.com/api/v1',
   },
   'web-sandbox-atlas-local': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'http://localhost:8080/api/private',
     atlasLogin: {
@@ -190,7 +190,7 @@ const config = {
     assistantApiBaseUrl: 'https://knowledge.staging.corp.mongodb.com/api/v1',
   },
   'web-sandbox-atlas-dev': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'https://cloud-dev.mongodb.com/api/private',
     atlasLogin: {
@@ -201,7 +201,7 @@ const config = {
     assistantApiBaseUrl: 'https://knowledge.staging.corp.mongodb.com/api/v1',
   },
   'web-sandbox-atlas-qa': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'https://cloud-dev.mongodb.com/api/private',
     atlasLogin: {
@@ -212,7 +212,7 @@ const config = {
     assistantApiBaseUrl: 'https://knowledge.staging.corp.mongodb.com/api/v1',
   },
   'web-sandbox-atlas': {
-    wsBaseUrl: '/ccs',
+    ccsBaseUrl: '/ccs',
     cloudBaseUrl: '/cloud-mongodb-com',
     atlasApiBaseUrl: 'https://cloud.mongodb.com/api/private',
     atlasLogin: {

packages/atlas-service/src/util.ts

@@ -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,
+      'DataModelDescriptions',
+      {
+        basePath,
+      }
+    );
   }
   save(description: MongoDBDataModelDescription) {
     return this.userData.write(description.id, description);

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

@@ -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/preferences-persistent-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,
     });
   }

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

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