chore: comments

Author: durran

src/cmap/auth/mongodb_oidc/azure_machine_workflow.ts

@@ -1,7 +1,7 @@
 import { addAzureParams, AZURE_BASE_URL } from '../../../client-side-encryption/providers/azure';
 import { MongoAzureError } from '../../../error';
 import { get } from '../../../utils';
-import type { OIDCCallbackParams, OIDCResponse } from '../mongodb_oidc';
+import type { OIDCCallbackFunction, OIDCCallbackParams, OIDCResponse } from '../mongodb_oidc';
 
 /** Azure request headers. */
 const AZURE_HEADERS = Object.freeze({ Metadata: 'true', Accept: 'application/json' });
@@ -19,7 +19,9 @@ const TOKEN_RESOURCE_MISSING_ERROR =
  * @param params - The OIDC callback parameters.
  * @returns The OIDC response.
  */
-export async function callback(params: OIDCCallbackParams): Promise<OIDCResponse> {
+export const callback: OIDCCallbackFunction = async (
+  params: OIDCCallbackParams
+): Promise<OIDCResponse> => {
   const tokenAudience = params.tokenAudience;
   const username = params.username;
   if (!tokenAudience) {
@@ -30,7 +32,7 @@ export async function callback(params: OIDCCallbackParams): Promise<OIDCResponse
     throw new MongoAzureError(ENDPOINT_RESULT_ERROR);
   }
   return response;
-}
+};
 
 /**
  * Hit the Azure endpoint to get the token data.

src/cmap/auth/mongodb_oidc/gcp_machine_workflow.ts

@@ -1,6 +1,6 @@
 import { MongoGCPError } from '../../../error';
 import { get } from '../../../utils';
-import type { OIDCCallbackParams, OIDCResponse } from '../mongodb_oidc';
+import type { OIDCCallbackFunction, OIDCCallbackParams, OIDCResponse } from '../mongodb_oidc';
 
 /** GCP base URL. */
 const GCP_BASE_URL =
@@ -18,13 +18,15 @@ const TOKEN_RESOURCE_MISSING_ERROR =
  * @param params - The OIDC callback parameters.
  * @returns The OIDC response.
  */
-export async function callback(params: OIDCCallbackParams): Promise<OIDCResponse> {
+export const callback: OIDCCallbackFunction = async (
+  params: OIDCCallbackParams
+): Promise<OIDCResponse> => {
   const tokenAudience = params.tokenAudience;
   if (!tokenAudience) {
     throw new MongoGCPError(TOKEN_RESOURCE_MISSING_ERROR);
   }
   return await getGcpTokenData(tokenAudience);
-}
+};
 
 /**
  * Hit the GCP endpoint to get the token data.

src/cmap/auth/mongodb_oidc/k8s_machine_workflow.ts

@@ -1,6 +1,6 @@
 import { readFile } from 'fs/promises';
 
-import type { OIDCResponse } from '../mongodb_oidc';
+import type { OIDCCallbackFunction, OIDCResponse } from '../mongodb_oidc';
 
 /** The fallback file name */
 const FALLBACK_FILENAME = '/var/run/secrets/kubernetes.io/serviceaccount/token';
@@ -16,7 +16,7 @@ const AWS_FILENAME = 'AWS_WEB_IDENTITY_TOKEN_FILE';
  * @param params - The OIDC callback parameters.
  * @returns The OIDC response.
  */
-export async function callback(): Promise<OIDCResponse> {
+export const callback: OIDCCallbackFunction = async (): Promise<OIDCResponse> => {
   let filename: string;
   if (process.env[AZURE_FILENAME]) {
     filename = process.env[AZURE_FILENAME];
@@ -27,4 +27,4 @@ export async function callback(): Promise<OIDCResponse> {
   }
   const token = await readFile(filename, 'utf8');
   return { accessToken: token };
-}
+};

src/cmap/auth/mongodb_oidc/token_machine_workflow.ts

@@ -1,7 +1,7 @@
 import * as fs from 'fs';
 
 import { MongoAWSError } from '../../../error';
-import { type OIDCResponse } from '../mongodb_oidc';
+import type { OIDCCallbackFunction, OIDCResponse } from '../mongodb_oidc';
 
 /** Error for when the token is missing in the environment. */
 const TOKEN_MISSING_ERROR = 'OIDC_TOKEN_FILE must be set in the environment.';
@@ -11,11 +11,11 @@ const TOKEN_MISSING_ERROR = 'OIDC_TOKEN_FILE must be set in the environment.';
  * @param params - The OIDC callback parameters.
  * @returns The OIDC response.
  */
-export async function callback(): Promise<OIDCResponse> {
+export const callback: OIDCCallbackFunction = async (): Promise<OIDCResponse> => {
   const tokenFile = process.env.OIDC_TOKEN_FILE;
   if (!tokenFile) {
     throw new MongoAWSError(TOKEN_MISSING_ERROR);
   }
   const token = await fs.promises.readFile(tokenFile, 'utf8');
   return { accessToken: token };
-}
+};