chore(atlas-service): provide atlas service configuration through a preset (#4825)

Author: gribnoysup

package-lock.json

@@ -50,13 +50,19 @@ describe('AtlasServiceMain', function () {
     destroy: sandbox.stub(),
   };
 
+  const defaultConfig = {
+    atlasApiBaseUrl: 'http://example.com',
+    atlasLogin: {
+      issuer: 'http://example.com',
+      clientId: '1234abcd',
+    },
+    authPortalUrl: 'http://example.com',
+  };
+
   const fetch = AtlasService['fetch'];
   const ipcMain = AtlasService['ipcMain'];
   const createPlugin = AtlasService['createMongoDBOIDCPlugin'];
   const userStore = AtlasService['atlasUserConfigStore'];
-  const apiBaseUrl = process.env.COMPASS_ATLAS_SERVICE_BASE_URL;
-  const issuer = process.env.COMPASS_OIDC_ISSUER;
-  const clientId = process.env.COMPASS_CLIENT_ID;
 
   beforeEach(function () {
     AtlasService['ipcMain'] = { handle: sandbox.stub() };
@@ -65,20 +71,13 @@ describe('AtlasServiceMain', function () {
     AtlasService['atlasUserConfigStore'] =
       mockUserConfigStore as unknown as AtlasUserConfigStore;
 
-    process.env.COMPASS_ATLAS_SERVICE_BASE_URL = 'http://example.com';
-    process.env.COMPASS_OIDC_ISSUER = 'http://example.com';
-    process.env.COMPASS_CLIENT_ID = '1234abcd';
-    process.env.COMPASS_ATLAS_AUTH_PORTAL_URL = 'http://example.com';
+    AtlasService['config'] = defaultConfig;
 
     AtlasService['setupPlugin']();
     AtlasService['attachOidcPluginLoggerEvents']();
   });
 
   afterEach(function () {
-    process.env.COMPASS_ATLAS_SERVICE_BASE_URL = apiBaseUrl;
-    process.env.COMPASS_OIDC_ISSUER = issuer;
-    process.env.COMPASS_CLIENT_ID = clientId;
-
     AtlasService['fetch'] = fetch;
     AtlasService['atlasUserConfigStore'] = userStore;
     AtlasService['ipcMain'] = ipcMain;
@@ -114,34 +113,6 @@ describe('AtlasServiceMain', function () {
           .REQUEST_TOKEN_CALLBACK
       ).to.have.been.calledOnce;
     });
-
-    it('should throw if COMPASS_OIDC_ISSUER is not set', async function () {
-      delete process.env.COMPASS_OIDC_ISSUER;
-
-      try {
-        await AtlasService.signIn();
-        expect.fail('Expected AtlasService.signIn() to throw');
-      } catch (err) {
-        expect(err).to.have.property(
-          'message',
-          'COMPASS_OIDC_ISSUER is required'
-        );
-      }
-    });
-
-    it('should throw if COMPASS_CLIENT_ID is not set', async function () {
-      delete process.env.COMPASS_CLIENT_ID;
-
-      try {
-        await AtlasService.signIn();
-        expect.fail('Expected AtlasService.signIn() to throw');
-      } catch (err) {
-        expect(err).to.have.property(
-          'message',
-          'COMPASS_CLIENT_ID is required'
-        );
-      }
-    });
   });
 
   describe('isAuthenticated', function () {
@@ -353,24 +324,6 @@ describe('AtlasServiceMain', function () {
           expect(err).to.have.property('message', '500 Internal Server Error');
         }
       });
-
-      it('should throw if COMPASS_ATLAS_SERVICE_BASE_URL is not set', async function () {
-        delete process.env.COMPASS_ATLAS_SERVICE_BASE_URL;
-
-        try {
-          await AtlasService[functionName]({
-            userInput: 'test',
-            collectionName: 'test.test',
-            databaseName: 'peanut',
-          });
-          expect.fail('Expected AtlasService.signIn() to throw');
-        } catch (err) {
-          expect(err).to.have.property(
-            'message',
-            'No AI Query endpoint to fetch. Please set the environment variable `COMPASS_ATLAS_SERVICE_BASE_URL`'
-          );
-        }
-      });
     });
   }
 
@@ -427,7 +380,7 @@ describe('AtlasServiceMain', function () {
 
   describe('init', function () {
     it('should try to restore service state by fetching user info', async function () {
-      await AtlasService.init();
+      await AtlasService.init(defaultConfig);
       expect(
         mockOidcPlugin.mongoClientOptions.authMechanismProperties
           .REQUEST_TOKEN_CALLBACK
@@ -476,7 +429,7 @@ describe('AtlasServiceMain', function () {
       const logger = new EventEmitter();
       AtlasService['openExternal'] = sandbox.stub().resolves();
       AtlasService['oidcPluginLogger'] = logger;
-      await AtlasService.init();
+      await AtlasService.init(defaultConfig);
       expect(getListenerCount(logger)).to.eq(25);
       // We did all preparations, reset sinon history for easier assertions
       sandbox.resetHistory();

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

@@ -97,11 +97,6 @@ function throwIfAINotEnabled(atlasService: typeof AtlasService) {
   }
 }
 
-function throwIfRequiredEnvNotSet(atlasService: typeof AtlasService) {
-  // These class properties will throw on access if missing
-  return void (atlasService['clientId'] && atlasService['issuer']);
-}
-
 const AI_MAX_REQUEST_SIZE = 10000;
 
 const AI_MIN_SAMPLE_DOCUMENTS = 1;
@@ -119,6 +114,15 @@ export function getTrackingUserInfo(userInfo: AtlasUserInfo) {
   };
 }
 
+export type AtlasServiceConfig = {
+  atlasApiBaseUrl: string;
+  atlasLogin: {
+    clientId: string;
+    issuer: string;
+  };
+  authPortalUrl: string;
+};
+
 export class AtlasService {
   private constructor() {
     // singleton
@@ -153,46 +157,7 @@ export class AtlasService {
 
   private static ipcMain: Pick<typeof ipcMain, 'handle'> = ipcMain;
 
-  private static get clientId() {
-    const clientId =
-      process.env.COMPASS_CLIENT_ID_OVERRIDE || process.env.COMPASS_CLIENT_ID;
-    if (!clientId) {
-      throw new Error('COMPASS_CLIENT_ID is required');
-    }
-    return clientId;
-  }
-
-  private static get issuer() {
-    const issuer =
-      process.env.COMPASS_OIDC_ISSUER_OVERRIDE ||
-      process.env.COMPASS_OIDC_ISSUER;
-    if (!issuer) {
-      throw new Error('COMPASS_OIDC_ISSUER is required');
-    }
-    return issuer;
-  }
-
-  private static get apiBaseUrl() {
-    const apiBaseUrl =
-      process.env.COMPASS_ATLAS_SERVICE_BASE_URL_OVERRIDE ||
-      process.env.COMPASS_ATLAS_SERVICE_BASE_URL;
-    if (!apiBaseUrl) {
-      throw new Error(
-        'No AI Query endpoint to fetch. Please set the environment variable `COMPASS_ATLAS_SERVICE_BASE_URL`'
-      );
-    }
-    return apiBaseUrl;
-  }
-
-  private static get authPortalUrl() {
-    const authPortalUrl =
-      process.env.COMPASS_ATLAS_AUTH_PORTAL_URL_OVERRIDE ||
-      process.env.COMPASS_ATLAS_AUTH_PORTAL_URL;
-    if (!authPortalUrl) {
-      throw new Error('COMPASS_ATLAS_AUTH_PORTAL_URL is required');
-    }
-    return authPortalUrl;
-  }
+  private static config: AtlasServiceConfig;
 
   private static openExternal(...args: Parameters<typeof shell.openExternal>) {
     return shell?.openExternal(...args);
@@ -215,7 +180,7 @@ export class AtlasService {
         if (data.result === 'redirecting') {
           const { res, status, location } = data;
           res.statusCode = status;
-          const redirectUrl = new URL(this.authPortalUrl);
+          const redirectUrl = new URL(this.config.authPortalUrl);
           redirectUrl.searchParams.set('fromURI', location);
           res.setHeader('Location', redirectUrl.toString());
           res.end();
@@ -238,7 +203,8 @@ export class AtlasService {
     );
   }
 
-  static init(): Promise<void> {
+  static init(config: AtlasServiceConfig): Promise<void> {
+    this.config = config;
     return (this.initPromise ??= (async () => {
       ipcExpose(
         'AtlasService',
@@ -259,7 +225,8 @@ export class AtlasService {
       log.info(
         mongoLogId(1_001_000_210),
         'AtlasService',
-        'Atlas service initialized'
+        'Atlas service initialized',
+        { config: this.config }
       );
       const serializedState = await this.secretStore.getItem(SECRET_STORE_KEY);
       this.setupPlugin(serializedState);
@@ -286,7 +253,6 @@ export class AtlasService {
   }: { signal?: AbortSignal } = {}) {
     throwIfAborted(signal);
     throwIfNetworkTrafficDisabled();
-    throwIfRequiredEnvNotSet(this);
 
     if (!this.plugin) {
       throw new Error(
@@ -295,7 +261,10 @@ export class AtlasService {
     }
 
     return this.plugin.mongoClientOptions.authMechanismProperties.REQUEST_TOKEN_CALLBACK(
-      { clientId: this.clientId, issuer: this.issuer },
+      {
+        clientId: this.config.atlasLogin.clientId,
+        issuer: this.config.atlasLogin.issuer,
+      },
       {
         // Required driver specific stuff
         version: 0,
@@ -348,7 +317,6 @@ export class AtlasService {
       this.signInPromise = (async () => {
         throwIfAborted(signal);
         throwIfNetworkTrafficDisabled();
-        throwIfRequiredEnvNotSet(this);
 
         log.info(mongoLogId(1_001_000_218), 'AtlasService', 'Starting sign in');
 
@@ -411,9 +379,9 @@ export class AtlasService {
     this.currentUser = null;
     this.oidcPluginLogger.emit('atlas-service-signed-out');
     // Open Atlas sign out page to end the browser session created for sign in
-    void this.openExternal(
-      'https://account.mongodb.com/account/login?signedOut=true'
-    );
+    const signOutUrl = new URL(this.config.authPortalUrl);
+    signOutUrl.searchParams.set('signedOut', 'true');
+    void this.openExternal(signOutUrl.toString());
     track('Atlas Sign Out', getTrackingUserInfo(userInfo));
   }
 
@@ -441,18 +409,20 @@ export class AtlasService {
   }: { signal?: AbortSignal } = {}): Promise<AtlasUserInfo> {
     throwIfAborted(signal);
     throwIfNetworkTrafficDisabled();
-    throwIfRequiredEnvNotSet(this);
 
     this.currentUser ??= await (async () => {
       const token = await this.maybeGetToken({ signal });
 
-      const res = await this.fetch(`${this.issuer}/v1/userinfo`, {
-        headers: {
-          Authorization: `Bearer ${token ?? ''}`,
-          Accept: 'application/json',
-        },
-        signal: signal as NodeFetchAbortSignal | undefined,
-      });
+      const res = await this.fetch(
+        `${this.config.atlasLogin.issuer}/v1/userinfo`,
+        {
+          headers: {
+            Authorization: `Bearer ${token ?? ''}`,
+            Accept: 'application/json',
+          },
+          signal: signal as NodeFetchAbortSignal | undefined,
+        }
+      );
 
       await throwIfNotOk(res);
 
@@ -495,10 +465,9 @@ export class AtlasService {
   } = {}) {
     throwIfAborted(signal);
     throwIfNetworkTrafficDisabled();
-    throwIfRequiredEnvNotSet(this);
 
-    const url = new URL(`${this.issuer}/v1/introspect`);
-    url.searchParams.set('client_id', this.clientId);
+    const url = new URL(`${this.config.atlasLogin.issuer}/v1/introspect`);
+    url.searchParams.set('client_id', this.config.atlasLogin.clientId);
 
     tokenType ??= 'accessToken';
 
@@ -530,10 +499,9 @@ export class AtlasService {
   } = {}): Promise<void> {
     throwIfAborted(signal);
     throwIfNetworkTrafficDisabled();
-    throwIfRequiredEnvNotSet(this);
 
-    const url = new URL(`${this.issuer}/v1/revoke`);
-    url.searchParams.set('client_id', this.clientId);
+    const url = new URL(`${this.config.atlasLogin.issuer}/v1/revoke`);
+    url.searchParams.set('client_id', this.config.atlasLogin.clientId);
 
     tokenType ??= 'accessToken';
 
@@ -574,7 +542,6 @@ export class AtlasService {
     throwIfAborted(signal);
     throwIfNetworkTrafficDisabled();
     throwIfAINotEnabled(this);
-    throwIfRequiredEnvNotSet(this);
 
     let msgBody = JSON.stringify({
       userInput,
@@ -605,7 +572,7 @@ export class AtlasService {
     const token = await this.maybeGetToken({ signal });
 
     const res = await this.fetch(
-      `${this.apiBaseUrl}/ai/api/v1/mql-aggregation`,
+      `${this.config.atlasApiBaseUrl}/ai/api/v1/mql-aggregation`,
       {
         signal: signal as NodeFetchAbortSignal | undefined,
         method: 'POST',
@@ -644,7 +611,6 @@ export class AtlasService {
     throwIfAborted(signal);
     throwIfNetworkTrafficDisabled();
     throwIfAINotEnabled(this);
-    throwIfRequiredEnvNotSet(this);
 
     let msgBody = JSON.stringify({
       userInput,
@@ -674,15 +640,18 @@ export class AtlasService {
 
     const token = await this.maybeGetToken({ signal });
 
-    const res = await this.fetch(`${this.apiBaseUrl}/ai/api/v1/mql-query`, {
-      signal: signal as NodeFetchAbortSignal | undefined,
-      method: 'POST',
-      headers: {
-        Authorization: `Bearer ${token ?? ''}`,
-        'Content-Type': 'application/json',
-      },
-      body: msgBody,
-    });
+    const res = await this.fetch(
+      `${this.config.atlasApiBaseUrl}/ai/api/v1/mql-query`,
+      {
+        signal: signal as NodeFetchAbortSignal | undefined,
+        method: 'POST',
+        headers: {
+          Authorization: `Bearer ${token ?? ''}`,
+          'Content-Type': 'application/json',
+        },
+        body: msgBody,
+      }
+    );
 
     await throwIfNotOk(res);