fix lint

Author: baileympearson

.evergreen/run-kerberos-tests.sh

@@ -24,11 +24,6 @@ set -o xtrace
 npm install kerberos@">=2.0.0-beta.0"
 npm run check:kerberos
 
-if [ "$NODE_LTS_VERSION" != "latest" ] && [ $NODE_LTS_VERSION -lt 20 ]; then
-  npm install kerberos@"^1.1.7"
-  npm run check:kerberos
-fi
-
 set +o xtrace
 
 # destroy ticket

src/client-side-encryption/errors.ts

@@ -5,12 +5,8 @@ import { type Document } from '../bson';
  * An error indicating that something went wrong specifically with MongoDB Client Encryption
  */
 export class MongoCryptError extends Error {
-  cause?: Error | string;
-  constructor(message: string, options: { cause?: Error | string } = {}) {
-    super(message);
-    if (options.cause != null) {
-      this.cause = options.cause;
-    }
+  constructor(message: string, options: { cause?: Error } = {}) {
+    super(message, options);
   }
 
   override get name() {
@@ -24,7 +20,7 @@ export class MongoCryptError extends Error {
  */
 export class MongoCryptCreateDataKeyError extends MongoCryptError {
   encryptedFields: Document;
-  constructor({encryptedFields, cause}: { encryptedFields: Document, cause: Error }) {
+  constructor({ encryptedFields, cause }: { encryptedFields: Document; cause: Error }) {
     super(`Unable to complete creating data keys: ${cause.message}`, { cause });
     this.encryptedFields = encryptedFields;
   }
@@ -40,7 +36,7 @@ export class MongoCryptCreateDataKeyError extends MongoCryptError {
  */
 export class MongoCryptCreateEncryptedCollectionError extends MongoCryptError {
   encryptedFields: Document;
-  constructor({encryptedFields, cause}: { encryptedFields: Document, cause: Error }) {
+  constructor({ encryptedFields, cause }: { encryptedFields: Document; cause: Error }) {
     super(`Unable to create collection: ${cause.message}`, { cause });
     this.encryptedFields = encryptedFields;
   }

src/client-side-encryption/providers/azure.ts

@@ -6,54 +6,61 @@ import * as utils from './utils';
 
 const MINIMUM_TOKEN_REFRESH_IN_MILLISECONDS = 6000;
 
+/**
+ * The access token that libmongocrypt expects for Azure kms.
+ */
 interface AccessToken {
   accessToken: string;
+}
+
+/**
+ * The response from the azure idms endpoint, including the `expiresOnTimestamp`.
+ * `expiresOnTimestamp` is needed for caching.
+ */
+interface AzureTokenCacheEntry extends AccessToken {
+  accessToken: string;
   expiresOnTimestamp: number;
 }
+
 /**
  * @internal
  */
 export class AzureCredentialCache {
-  /** @internal */
-  cachedToken: AccessToken | null = null;
+  cachedToken: AzureTokenCacheEntry | null = null;
 
   async getToken(): Promise<AccessToken> {
-    if (this.needsRefresh(this.cachedToken)) {
+    if (this.cachedToken == null || this.needsRefresh(this.cachedToken)) {
       this.cachedToken = await this._getToken();
     }
 
-    return { ...this.cachedToken! };
+    return { accessToken: this.cachedToken.accessToken };
   }
 
-  needsRefresh(token: typeof this.cachedToken): boolean {
-    if (token == null) {
-      return true;
-    }
+  needsRefresh(token: AzureTokenCacheEntry): boolean {
     const timeUntilExpirationMS = token.expiresOnTimestamp - Date.now();
     return timeUntilExpirationMS <= MINIMUM_TOKEN_REFRESH_IN_MILLISECONDS;
   }
 
   /**
    * exposed for testing
-   * @internal
    */
   resetCache() {
     this.cachedToken = null;
   }
 
   /**
    * exposed for testing
-   * @internal
    */
-  _getToken(): Promise<typeof this.cachedToken> {
+  _getToken(): Promise<AzureTokenCacheEntry> {
     return fetchAzureKMSToken();
   }
 }
 
 /** @internal */
 export const tokenCache = new AzureCredentialCache();
 
-async function parseResponse(response: { body: string; status?: number }): Promise<AccessToken> {
+/** @internal */
+async function parseResponse(response: { body: string; status?: number }): Promise<AzureTokenCacheEntry> {
   const { status, body: rawBody } = response;
 
   const body: { expires_in?: number; access_token?: string } = (() => {
@@ -120,7 +127,7 @@ export function prepareRequest(options: AzureKMSRequestOptions): {
       : // The Node URL constructor technically supports "any object that converts to a valid URL string",
         // but Node types doesn't support this.  See the Node docs for new URL().
         // https://nodejs.org/api/url.html#new-urlinput-base
-        // @ts-ignore
+        // @ts-expect-error URL constructor typings incorrect
         new URL(options.url);
 
   url.searchParams.append('api-version', '2018-02-01');
@@ -140,7 +147,9 @@ export function prepareRequest(options: AzureKMSRequestOptions): {
  * exposed for CSFLE
  * [prose test 18](https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#azure-imds-credentials)
  */
-export async function fetchAzureKMSToken(options: AzureKMSRequestOptions = {}) {
+export async function fetchAzureKMSToken(
+  options: AzureKMSRequestOptions = {}
+): Promise<AzureTokenCacheEntry> {
   const { headers, url } = prepareRequest(options);
   const response = await utils.get(url, { headers }).catch(error => {
     if (error instanceof MongoCryptKMSRequestNetworkTimeoutError) {

src/deps.ts

@@ -77,7 +77,7 @@ export function getZstdLibrary(): typeof ZStandard | { kModuleError: MongoMissin
 
 /**
  * @internal
- * Copy of the AwsCredentialIdentityProvider interface from [`@smithy/types`](https://socket.dev/npm/package/@smithy/types/files/1.1.1/dist-types/identity/awsCredentialIdentity.d.ts),
+ * Copy of the AwsCredentialIdentityProvider interface from [`smithy/types`](https://socket.dev/npm/package/\@smithy/types/files/1.1.1/dist-types/identity/awsCredentialIdentity.d.ts),
  * the return type of the aws-sdk's `fromNodeProviderChain().provider()`.
  */
 export interface AWSCredentials {

test/unit/client-side-encryption/requirements.helper.ts

@@ -1,4 +1,5 @@
-import {getGcpMetadata , getAwsCredentialProvider} from '../../../src/deps';
+// eslint-disable-next-line @typescript-eslint/no-restricted-imports
+import { getAwsCredentialProvider, getGcpMetadata } from '../../../src/deps';
 
 // Data Key Stuff
 export const AWS_ACCESS_KEY_ID = process.env.AWS_ACCESS_KEY_ID;

tsconfig.json

@@ -9,7 +9,8 @@
     "moduleResolution": "node",
     "skipLibCheck": true,
     "lib": [
-      "es2021"
+      "es2021",
+      "ES2022.Error"
     ],
     // We don't make use of tslib helpers, all syntax used is supported by target engine
     "importHelpers": false,