mongodb 6.5.0 → 6.6.0-dev.20240504.sha.2609953

package/src/utils.ts

@@ -1,8 +1,8 @@
 import * as crypto from 'crypto';
 import type { SrvRecord } from 'dns';
 import { type EventEmitter } from 'events';
+import { promises as fs } from 'fs';
 import * as http from 'http';
-import { clearTimeout, setTimeout } from 'timers';
 import * as url from 'url';
 import { URL } from 'url';
 import { promisify } from 'util';
@@ -64,6 +64,19 @@ export const ByteUtils = {
   }
 };
 
+/**
+ * Returns true if value is a Uint8Array or a Buffer
+ * @param value - any value that may be a Uint8Array
+ */
+export function isUint8Array(value: unknown): value is Uint8Array {
+  return (
+    value != null &&
+    typeof value === 'object' &&
+    Symbol.toStringTag in value &&
+    value[Symbol.toStringTag] === 'Uint8Array'
+  );
+}
+
 /**
  * Determines if a connection's address matches a user provided list
  * of domain wildcards.
@@ -178,6 +191,7 @@ export function isPromiseLike<T = unknown>(value?: unknown): value is PromiseLik
     value != null &&
     typeof value === 'object' &&
     'then' in value &&
+    // eslint-disable-next-line github/no-then
     typeof value.then === 'function'
   );
 }
@@ -1156,7 +1170,7 @@ export async function request(
   uri: string,
   options: RequestOptions = {}
 ): Promise<string | Record<string, any>> {
-  return new Promise<string | Record<string, any>>((resolve, reject) => {
+  return await new Promise<string | Record<string, any>>((resolve, reject) => {
     const requestOptions = {
       method: 'GET',
       timeout: 10000,
@@ -1201,33 +1215,6 @@ export async function request(
   });
 }
 
-/**
- * A custom AbortController that aborts after a specified timeout.
- *
- * If `timeout` is undefined or \<=0, the abort controller never aborts.
- *
- * This class provides two benefits over the built-in AbortSignal.timeout() method.
- * - This class provides a mechanism for cancelling the timeout
- * - This class supports infinite timeouts by interpreting a timeout of 0 as infinite.  This is
- *    consistent with existing timeout options in the Node driver (serverSelectionTimeoutMS, for example).
- * @internal
- */
-export class TimeoutController extends AbortController {
-  constructor(
-    timeout = 0,
-    private timeoutId = timeout > 0 ? setTimeout(() => this.abort(), timeout) : null
-  ) {
-    super();
-  }
-
-  clear() {
-    if (this.timeoutId != null) {
-      clearTimeout(this.timeoutId);
-    }
-    this.timeoutId = null;
-  }
-}
-
 /** @internal */
 export const DOCUMENT_DB_CHECK = /(\.docdb\.amazonaws\.com$)|(\.docdb-elastic\.amazonaws\.com$)/;
 /** @internal */
@@ -1245,9 +1232,13 @@ export function isHostMatch(match: RegExp, host?: string): boolean {
   return host && match.test(host.toLowerCase()) ? true : false;
 }
 
-export function promiseWithResolvers<T>() {
-  let resolve!: Parameters<ConstructorParameters<typeof Promise<T>>[0]>[0];
-  let reject!: Parameters<ConstructorParameters<typeof Promise<T>>[0]>[1];
+export function promiseWithResolvers<T>(): {
+  promise: Promise<T>;
+  resolve: (value: T) => void;
+  reject: (error: Error) => void;
+} {
+  let resolve!: (value: T) => void;
+  let reject!: (error: Error) => void;
   const promise = new Promise<T>(function withResolversExecutor(promiseResolve, promiseReject) {
     resolve = promiseResolve;
     reject = promiseReject;
@@ -1255,6 +1246,20 @@ export function promiseWithResolvers<T>() {
   return { promise, resolve, reject } as const;
 }
 
+/**
+ * A noop function intended for use in preventing unhandled rejections.
+ *
+ * @example
+ * ```js
+ * const promise = myAsyncTask();
+ * // eslint-disable-next-line github/no-then
+ * promise.then(undefined, squashError);
+ * ```
+ */
+export function squashError(_error: unknown) {
+  return;
+}
+
 export const randomBytes = promisify(crypto.randomBytes);
 
 /**
@@ -1280,3 +1285,51 @@ export async function once<T>(ee: EventEmitter, name: string): Promise<T> {
     throw error;
   }
 }
+
+export function maybeAddIdToDocuments(
+  coll: Collection,
+  docs: Document[],
+  options: { forceServerObjectId?: boolean }
+): Document[];
+export function maybeAddIdToDocuments(
+  coll: Collection,
+  docs: Document,
+  options: { forceServerObjectId?: boolean }
+): Document;
+export function maybeAddIdToDocuments(
+  coll: Collection,
+  docOrDocs: Document[] | Document,
+  options: { forceServerObjectId?: boolean }
+): Document[] | Document {
+  const forceServerObjectId =
+    typeof options.forceServerObjectId === 'boolean'
+      ? options.forceServerObjectId
+      : coll.s.db.options?.forceServerObjectId;
+
+  // no need to modify the docs if server sets the ObjectId
+  if (forceServerObjectId === true) {
+    return docOrDocs;
+  }
+
+  const transform = (doc: Document): Document => {
+    if (doc._id == null) {
+      doc._id = coll.s.pkFactory.createPk();
+    }
+
+    return doc;
+  };
+  return Array.isArray(docOrDocs) ? docOrDocs.map(transform) : transform(docOrDocs);
+}
+
+export async function fileIsAccessible(fileName: string, mode?: number) {
+  try {
+    await fs.access(fileName, mode);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+export function noop() {
+  return;
+}

package/lib/operations/common_functions.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.maybeAddIdToDocuments = exports.indexInformation = void 0;
-async function indexInformation(db, name, options) {
-    if (options == null) {
-        options = {};
-    }
-    // If we specified full information
-    const full = options.full == null ? false : options.full;
-    // Get the list of indexes of the specified collection
-    const indexes = await db.collection(name).listIndexes(options).toArray();
-    if (full)
-        return indexes;
-    const info = {};
-    for (const index of indexes) {
-        info[index.name] = Object.entries(index.key);
-    }
-    return info;
-}
-exports.indexInformation = indexInformation;
-function maybeAddIdToDocuments(coll, docOrDocs, options) {
-    const forceServerObjectId = typeof options.forceServerObjectId === 'boolean'
-        ? options.forceServerObjectId
-        : coll.s.db.options?.forceServerObjectId;
-    // no need to modify the docs if server sets the ObjectId
-    if (forceServerObjectId === true) {
-        return docOrDocs;
-    }
-    const transform = (doc) => {
-        if (doc._id == null) {
-            doc._id = coll.s.pkFactory.createPk();
-        }
-        return doc;
-    };
-    return Array.isArray(docOrDocs) ? docOrDocs.map(transform) : transform(docOrDocs);
-}
-exports.maybeAddIdToDocuments = maybeAddIdToDocuments;
-//# sourceMappingURL=common_functions.js.map

package/lib/operations/common_functions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"common_functions.js","sourceRoot":"","sources":["../../src/operations/common_functions.ts"],"names":[],"mappings":";;;AAwBO,KAAK,UAAU,gBAAgB,CACpC,EAAM,EACN,IAAY,EACZ,OAAiC;IAEjC,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,OAAO,GAAG,EAAE,CAAC;KACd;IACD,mCAAmC;IACnC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACzD,sDAAsD;IACtD,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IACzE,IAAI,IAAI;QAAE,OAAO,OAAO,CAAC;IAEzB,MAAM,IAAI,GAA6C,EAAE,CAAC;IAC1D,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAC9C;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAnBD,4CAmBC;AAYD,SAAgB,qBAAqB,CACnC,IAAgB,EAChB,SAAgC,EAChC,OAA0C;IAE1C,MAAM,mBAAmB,GACvB,OAAO,OAAO,CAAC,mBAAmB,KAAK,SAAS;QAC9C,CAAC,CAAC,OAAO,CAAC,mBAAmB;QAC7B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,CAAC;IAE7C,yDAAyD;IACzD,IAAI,mBAAmB,KAAK,IAAI,EAAE;QAChC,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,SAAS,GAAG,CAAC,GAAa,EAAY,EAAE;QAC5C,IAAI,GAAG,CAAC,GAAG,IAAI,IAAI,EAAE;YACnB,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;SACvC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IACF,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;AACpF,CAAC;AAvBD,sDAuBC"}

package/src/operations/common_functions.ts

@@ -1,79 +0,0 @@
-import type { Document } from '../bson';
-import type { Collection } from '../collection';
-import type { Db } from '../db';
-import type { ReadPreference } from '../read_preference';
-import type { ClientSession } from '../sessions';
-
-/** @public */
-export interface IndexInformationOptions {
-  full?: boolean;
-  readPreference?: ReadPreference;
-  session?: ClientSession;
-}
-/**
- * Retrieves this collections index info.
- *
- * @param db - The Db instance on which to retrieve the index info.
- * @param name - The name of the collection.
- */
-export async function indexInformation(db: Db, name: string): Promise<any>;
-export async function indexInformation(
-  db: Db,
-  name: string,
-  options?: IndexInformationOptions
-): Promise<any>;
-export async function indexInformation(
-  db: Db,
-  name: string,
-  options?: IndexInformationOptions
-): Promise<any> {
-  if (options == null) {
-    options = {};
-  }
-  // If we specified full information
-  const full = options.full == null ? false : options.full;
-  // Get the list of indexes of the specified collection
-  const indexes = await db.collection(name).listIndexes(options).toArray();
-  if (full) return indexes;
-
-  const info: Record<string, Array<[string, unknown]>> = {};
-  for (const index of indexes) {
-    info[index.name] = Object.entries(index.key);
-  }
-  return info;
-}
-
-export function maybeAddIdToDocuments(
-  coll: Collection,
-  docs: Document[],
-  options: { forceServerObjectId?: boolean }
-): Document[];
-export function maybeAddIdToDocuments(
-  coll: Collection,
-  docs: Document,
-  options: { forceServerObjectId?: boolean }
-): Document;
-export function maybeAddIdToDocuments(
-  coll: Collection,
-  docOrDocs: Document[] | Document,
-  options: { forceServerObjectId?: boolean }
-): Document[] | Document {
-  const forceServerObjectId =
-    typeof options.forceServerObjectId === 'boolean'
-      ? options.forceServerObjectId
-      : coll.s.db.options?.forceServerObjectId;
-
-  // no need to modify the docs if server sets the ObjectId
-  if (forceServerObjectId === true) {
-    return docOrDocs;
-  }
-
-  const transform = (doc: Document): Document => {
-    if (doc._id == null) {
-      doc._id = coll.s.pkFactory.createPk();
-    }
-
-    return doc;
-  };
-  return Array.isArray(docOrDocs) ? docOrDocs.map(transform) : transform(docOrDocs);
-}