mongodb 5.0.1 → 5.2.0

package/src/read_preference.ts

@@ -16,7 +16,7 @@ export const ReadPreferenceMode = Object.freeze({
 } as const);
 
 /** @public */
-export type ReadPreferenceMode = typeof ReadPreferenceMode[keyof typeof ReadPreferenceMode];
+export type ReadPreferenceMode = (typeof ReadPreferenceMode)[keyof typeof ReadPreferenceMode];
 
 /** @public */
 export interface HedgeOptions {
@@ -56,7 +56,7 @@ export interface ReadPreferenceFromOptions extends ReadPreferenceLikeOptions {
  * used to construct connections.
  * @public
  *
- * @see https://docs.mongodb.com/manual/core/read-preference/
+ * @see https://www.mongodb.com/docs/manual/core/read-preference/
  */
 export class ReadPreference {
   mode: ReadPreferenceMode;
@@ -229,7 +229,7 @@ export class ReadPreference {
 
   /**
    * Indicates that this readPreference needs the "SecondaryOk" bit when sent over the wire
-   * @see https://docs.mongodb.com/manual/reference/mongodb-wire-protocol/#op-query
+   * @see https://www.mongodb.com/docs/manual/reference/mongodb-wire-protocol/#op-query
    */
   secondaryOk(): boolean {
     const NEEDS_SECONDARYOK = new Set<string>([

package/src/sdam/common.ts

@@ -24,7 +24,7 @@ export const TopologyType = Object.freeze({
 } as const);
 
 /** @public */
-export type TopologyType = typeof TopologyType[keyof typeof TopologyType];
+export type TopologyType = (typeof TopologyType)[keyof typeof TopologyType];
 
 /**
  * An enumeration of server types we know about
@@ -44,7 +44,7 @@ export const ServerType = Object.freeze({
 } as const);
 
 /** @public */
-export type ServerType = typeof ServerType[keyof typeof ServerType];
+export type ServerType = (typeof ServerType)[keyof typeof ServerType];
 
 /** @internal */
 export type TimerQueue = Set<NodeJS.Timeout>;

package/src/sdam/monitor.ts

@@ -120,6 +120,7 @@ export class Monitor extends TypedEventEmitter<MonitorEvents> {
       // force BSON serialization options
       {
         raw: false,
+        useBigInt64: false,
         promoteLongs: true,
         promoteValues: true,
         promoteBuffers: true

package/src/sdam/server.ts

@@ -241,7 +241,10 @@ export class Server extends TypedEventEmitter<ServerEvents> {
 
   /** Destroy the server connection */
   destroy(options?: DestroyOptions, callback?: Callback): void {
-    if (typeof options === 'function') (callback = options), (options = {});
+    if (typeof options === 'function') {
+      callback = options;
+      options = { force: false };
+    }
     options = Object.assign({}, { force: false }, options);
 
     if (this.s.state === STATE_CLOSED) {

package/src/sdam/topology.ts

@@ -466,26 +466,17 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
   }
 
   /** Close this topology */
-  close(callback: Callback): void;
   close(options: CloseOptions): void;
   close(options: CloseOptions, callback: Callback): void;
-  close(options?: CloseOptions | Callback, callback?: Callback): void {
-    if (typeof options === 'function') {
-      callback = options;
-      options = {};
-    }
-
-    if (typeof options === 'boolean') {
-      options = { force: options };
-    }
-    options = options ?? {};
+  close(options?: CloseOptions, callback?: Callback): void {
+    options = options ?? { force: false };
 
     if (this.s.state === STATE_CLOSED || this.s.state === STATE_CLOSING) {
       return callback?.();
     }
 
     const destroyedServers = Array.from(this.s.servers.values(), server => {
-      return promisify(destroyServer)(server, this, options as CloseOptions);
+      return promisify(destroyServer)(server, this, { force: !!options?.force });
     });
 
     Promise.all(destroyedServers)
@@ -583,26 +574,6 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
     processWaitQueue(this);
   }
 
-  // Sessions related methods
-
-  /**
-   * @returns Whether the topology should initiate selection to determine session support
-   */
-  shouldCheckForSessionSupport(): boolean {
-    if (this.description.type === TopologyType.Single) {
-      return !this.description.hasKnownServers;
-    }
-
-    return !this.description.hasDataBearingServers;
-  }
-
-  /**
-   * @returns Whether sessions are supported on the current topology
-   */
-  hasSessionSupport(): boolean {
-    return this.loadBalanced || this.description.logicalSessionTimeoutMinutes != null;
-  }
-
   /**
    * Update the internal TopologyDescription with a ServerDescription
    *
@@ -740,7 +711,7 @@ function destroyServer(
   options?: DestroyOptions,
   callback?: Callback
 ) {
-  options = options ?? {};
+  options = options ?? { force: false };
   for (const event of LOCAL_SERVER_EVENTS) {
     server.removeAllListeners(event);
   }

package/src/sessions.ts

@@ -307,7 +307,8 @@ export class ClientSession extends TypedEventEmitter<ClientSessionEvents> {
     if (
       !clusterTime.signature ||
       clusterTime.signature.hash?._bsontype !== 'Binary' ||
-      (typeof clusterTime.signature.keyId !== 'number' &&
+      (typeof clusterTime.signature.keyId !== 'bigint' &&
+        typeof clusterTime.signature.keyId !== 'number' &&
         clusterTime.signature.keyId?._bsontype !== 'Long') // apparently we decode the key to number?
     ) {
       throw new MongoInvalidArgumentError(

package/src/transactions.ts

@@ -18,7 +18,7 @@ export const TxnState = Object.freeze({
 } as const);
 
 /** @internal */
-export type TxnState = typeof TxnState[keyof typeof TxnState];
+export type TxnState = (typeof TxnState)[keyof typeof TxnState];
 
 const stateMachine: { [state in TxnState]: TxnState[] } = {
   [TxnState.NO_TRANSACTION]: [TxnState.NO_TRANSACTION, TxnState.STARTING_TRANSACTION],

package/src/utils.ts

@@ -20,7 +20,7 @@ import {
   MongoRuntimeError
 } from './error';
 import type { Explain } from './explain';
-import type { MongoClient } from './mongo_client';
+import type { MongoClient, MongoOptions } from './mongo_client';
 import type { CommandOperationOptions, OperationParent } from './operations/command';
 import type { Hint, OperationOptions } from './operations/operation';
 import { ReadConcern } from './read_concern';
@@ -29,7 +29,7 @@ import { ServerType } from './sdam/common';
 import type { Server } from './sdam/server';
 import type { Topology } from './sdam/topology';
 import type { ClientSession } from './sessions';
-import { W, WriteConcern, WriteConcernOptions } from './write_concern';
+import { WriteConcern } from './write_concern';
 
 /**
  * MongoDB Driver style callback
@@ -167,9 +167,6 @@ export function applyRetryableWrites<T extends HasRetryableWrites>(target: T, db
   return target;
 }
 
-interface HasWriteConcern {
-  writeConcern?: WriteConcernOptions | WriteConcern | W;
-}
 /**
  * Applies a write concern to a command based on well defined inheritance rules, optionally
  * detecting support for the write concern in the first place.
@@ -179,39 +176,6 @@ interface HasWriteConcern {
  * @param sources - sources where we can inherit default write concerns from
  * @param options - optional settings passed into a command for write concern overrides
  */
-export function applyWriteConcern<T extends HasWriteConcern>(
-  target: T,
-  sources: { db?: Db; collection?: Collection },
-  options?: OperationOptions & WriteConcernOptions
-): T {
-  options = options ?? {};
-  const db = sources.db;
-  const coll = sources.collection;
-
-  if (options.session && options.session.inTransaction()) {
-    // writeConcern is not allowed within a multi-statement transaction
-    if (target.writeConcern) {
-      delete target.writeConcern;
-    }
-
-    return target;
-  }
-
-  const writeConcern = WriteConcern.fromOptions(options);
-  if (writeConcern) {
-    return Object.assign(target, { writeConcern });
-  }
-
-  if (coll && coll.writeConcern) {
-    return Object.assign(target, { writeConcern: Object.assign({}, coll.writeConcern) });
-  }
-
-  if (db && db.writeConcern) {
-    return Object.assign(target, { writeConcern: Object.assign({}, db.writeConcern) });
-  }
-
-  return target;
-}
 
 /**
  * Checks if a given value is a Promise
@@ -483,40 +447,6 @@ export function eachAsync<T = Document>(
   }
 }
 
-/** @internal */
-export function eachAsyncSeries<T = any>(
-  arr: T[],
-  eachFn: (item: T, callback: (err?: AnyError) => void) => void,
-  callback: Callback
-): void {
-  arr = arr || [];
-
-  let idx = 0;
-  let awaiting = arr.length;
-  if (awaiting === 0) {
-    callback();
-    return;
-  }
-
-  function eachCallback(err?: AnyError) {
-    idx++;
-    awaiting--;
-    if (err) {
-      callback(err);
-      return;
-    }
-
-    if (idx === arr.length && awaiting <= 0) {
-      callback();
-      return;
-    }
-
-    eachFn(arr[idx], eachCallback);
-  }
-
-  eachFn(arr[idx], eachCallback);
-}
-
 /** @internal */
 export function arrayStrictEqual(arr: unknown[], arr2: unknown[]): boolean {
   if (!Array.isArray(arr) || !Array.isArray(arr2)) {
@@ -583,7 +513,10 @@ export function makeStateMachine(stateTable: StateTable): StateTransitionFunctio
   };
 }
 
-/** @public */
+/**
+ * @public
+ * @see https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.rst#hello-command
+ */
 export interface ClientMetadata {
   driver: {
     name: string;
@@ -596,7 +529,6 @@ export interface ClientMetadata {
     version: string;
   };
   platform: string;
-  version?: string;
   application?: {
     name: string;
   };
@@ -615,13 +547,21 @@ export interface ClientMetadataOptions {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const NODE_DRIVER_VERSION = require('../package.json').version;
 
-export function makeClientMetadata(options?: ClientMetadataOptions): ClientMetadata {
-  options = options ?? {};
+export function makeClientMetadata(
+  options: Pick<MongoOptions, 'appName' | 'driverInfo'>
+): ClientMetadata {
+  const name = options.driverInfo.name ? `nodejs|${options.driverInfo.name}` : 'nodejs';
+  const version = options.driverInfo.version
+    ? `${NODE_DRIVER_VERSION}|${options.driverInfo.version}`
+    : NODE_DRIVER_VERSION;
+  const platform = options.driverInfo.platform
+    ? `Node.js ${process.version}, ${os.endianness()}|${options.driverInfo.platform}`
+    : `Node.js ${process.version}, ${os.endianness()}`;
 
   const metadata: ClientMetadata = {
     driver: {
-      name: 'nodejs',
-      version: NODE_DRIVER_VERSION
+      name,
+      version
     },
     os: {
       type: os.type(),
@@ -629,30 +569,16 @@ export function makeClientMetadata(options?: ClientMetadataOptions): ClientMetad
       architecture: process.arch,
       version: os.release()
     },
-    platform: `Node.js ${process.version}, ${os.endianness()} (unified)`
+    platform
   };
 
-  // support optionally provided wrapping driver info
-  if (options.driverInfo) {
-    if (options.driverInfo.name) {
-      metadata.driver.name = `${metadata.driver.name}|${options.driverInfo.name}`;
-    }
-
-    if (options.driverInfo.version) {
-      metadata.version = `${metadata.driver.version}|${options.driverInfo.version}`;
-    }
-
-    if (options.driverInfo.platform) {
-      metadata.platform = `${metadata.platform}|${options.driverInfo.platform}`;
-    }
-  }
-
   if (options.appName) {
     // MongoDB requires the appName not exceed a byte length of 128
-    const buffer = Buffer.from(options.appName);
-    metadata.application = {
-      name: buffer.byteLength > 128 ? buffer.slice(0, 128).toString('utf8') : options.appName
-    };
+    const name =
+      Buffer.byteLength(options.appName, 'utf8') <= 128
+        ? options.appName
+        : Buffer.from(options.appName, 'utf8').subarray(0, 128).toString('utf8');
+    metadata.application = { name };
   }
 
   return metadata;

package/src/write_concern.ts

@@ -32,7 +32,7 @@ export const WRITE_CONCERN_KEYS = ['w', 'wtimeout', 'j', 'journal', 'fsync'];
  * requested from MongoDB for write operations.
  * @public
  *
- * @see https://docs.mongodb.com/manual/reference/write-concern/
+ * @see https://www.mongodb.com/docs/manual/reference/write-concern/
  */
 export class WriteConcern {
   /** request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags. */