chore(atlas-service): split atlas service and create a service provider COMPASS-7412 (#5464)

* chore: minimise the atlas service interface

* wip: moving generative ai client out of atlas service

* stuck on cors

* move service to renderer

* atlas provider

* compass web

* cors header

* preferences user

* cors

* separate the services

* inject log and preferences in atlas-service

* use hooks correctly

* fix tests

* split responsibility correctly

* clean up

* depcheck

* changes

* feedback and resolve log ids

* fix log id

* fix tests

* refactor

* fix unit tests

* fix tests

* undo skip

* test

* fix test-electron

* fix home tests

* separate concerns

* fix e2e tests

* correct check

* remove env var

* clean csp

* use logger hook

* remove unwanted dep

* add urls to csp

---------

Co-authored-by: Himanshu Singh <[email protected]>

Author: mabaasit

Diff for: package-lock.json

@@ -23,16 +23,19 @@
     "main.js",
     "main.d.ts",
     "renderer.js",
-    "renderer.d.ts"
+    "renderer.d.ts",
+    "provider.js"
   ],
   "license": "SSPL",
   "exports": {
     "./main": "./main.js",
-    "./renderer": "./renderer.js"
+    "./renderer": "./renderer.js",
+    "./provider": "./dist/provider.js"
   },
   "compass:exports": {
     "./main": "./src/main.ts",
-    "./renderer": "./src/renderer.ts"
+    "./renderer": "./src/renderer.ts",
+    "./provider": "./src/provider.ts"
   },
   "scripts": {
     "bootstrap": "npm run compile",
@@ -57,31 +60,29 @@
     "@mongodb-js/prettier-config-compass": "^1.0.1",
     "@mongodb-js/tsconfig-compass": "^1.0.3",
     "@testing-library/react": "^12.1.4",
-    "@testing-library/user-event": "^13.5.0",
     "@types/chai": "^4.2.21",
     "@types/mocha": "^9.0.0",
     "@types/sinon-chai": "^3.2.5",
     "chai": "^4.3.6",
     "depcheck": "^1.4.1",
     "eslint": "^7.25.0",
     "mocha": "^10.2.0",
-    "mongodb": "^6.3.0",
-    "mongodb-schema": "^12.1.0",
     "nyc": "^15.1.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.3",
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@mongodb-js/compass-user-data": "^0.1.15",
     "@mongodb-js/compass-components": "^1.21.3",
     "@mongodb-js/compass-logging": "^1.2.12",
+    "@mongodb-js/compass-user-data": "^0.1.15",
     "@mongodb-js/compass-utils": "^0.5.11",
     "@mongodb-js/devtools-connect": "^2.4.2",
     "@mongodb-js/oidc-plugin": "^0.3.1",
     "compass-preferences-model": "^2.17.4",
     "electron": "^28.2.1",
     "hadron-ipc": "^3.2.10",
+    "lodash": "^4.17.21",
     "node-fetch": "^2.7.0",
     "react": "^17.0.2",
     "react-redux": "^8.1.3",

Diff for: packages/atlas-service/package.json

@@ -0,0 +1 @@
+export * from './dist/provider.d';

Diff for: packages/atlas-service/provider.d.ts

@@ -0,0 +1,74 @@
+import { EventEmitter } from 'events';
+import type { AtlasUserConfig } from './user-config-store';
+import type { AtlasUserInfo } from './util';
+
+export type ArgsWithSignal<T = Record<string, unknown>> = T & {
+  signal?: AbortSignal;
+};
+export type SignInPrompt = 'none' | 'ai-promo-modal';
+
+type AtlasAuthServiceEvents = {
+  'signed-in': [];
+  'signed-out': [];
+  'token-refresh-failed': [];
+  'user-config-changed': [AtlasUserConfig];
+};
+
+type AtlasAuthEventNames = keyof AtlasAuthServiceEvents;
+type AtlasAuthEventListener<T extends AtlasAuthEventNames> = (
+  ...args: AtlasAuthServiceEvents[T]
+) => void;
+
+export abstract class AtlasAuthService extends EventEmitter {
+  abstract signIn(
+    opts?: ArgsWithSignal<{ promptType?: SignInPrompt }>
+  ): Promise<AtlasUserInfo>;
+  abstract signOut(): Promise<void>;
+  abstract isAuthenticated(opts?: ArgsWithSignal): Promise<boolean>;
+  abstract getAuthHeaders(
+    opts?: ArgsWithSignal
+  ): Promise<Record<string, string>>;
+
+  abstract getUserInfo(opts?: ArgsWithSignal): Promise<AtlasUserInfo>;
+  abstract updateUserConfig(config: AtlasUserConfig): Promise<void>;
+
+  on<T extends AtlasAuthEventNames>(
+    evt: T,
+    listener: AtlasAuthEventListener<T>
+  ): this;
+  on(evt: string, listener: (...args: any[]) => void): this {
+    return super.on(evt, listener);
+  }
+
+  once<T extends AtlasAuthEventNames>(
+    evt: T,
+    listener: AtlasAuthEventListener<T>
+  ): this;
+  once(evt: string, listener: (...args: any[]) => void): this {
+    return super.once(evt, listener);
+  }
+
+  off<T extends AtlasAuthEventNames>(
+    evt: T,
+    listener: AtlasAuthEventListener<T>
+  ): this;
+  off(evt: string, listener: (...args: any[]) => void): this {
+    return super.off(evt, listener);
+  }
+
+  removeListener<T extends AtlasAuthEventNames>(
+    evt: T,
+    listener: AtlasAuthEventListener<T>
+  ): this;
+  removeListener(evt: string, listener: (...args: any[]) => void): this {
+    return super.removeListener(evt, listener);
+  }
+
+  emit<T extends AtlasAuthEventNames>(
+    evt: T,
+    ...args: AtlasAuthServiceEvents[T]
+  ): boolean;
+  emit(evt: string, ...args: any[]): boolean {
+    return super.emit(evt, ...args);
+  }
+}