1387 lines
38 KiB
TypeScript
1387 lines
38 KiB
TypeScript
import * as crypto from 'crypto';
|
||
import type { SrvRecord } from 'dns';
|
||
import { URL } from 'url';
|
||
|
||
import { Document, ObjectId, resolveBSONOptions } from './bson';
|
||
import type { Connection } from './cmap/connection';
|
||
import { MAX_SUPPORTED_WIRE_VERSION } from './cmap/wire_protocol/constants';
|
||
import type { Collection } from './collection';
|
||
import { LEGACY_HELLO_COMMAND } from './constants';
|
||
import type { AbstractCursor } from './cursor/abstract_cursor';
|
||
import type { FindCursor } from './cursor/find_cursor';
|
||
import type { Db } from './db';
|
||
import {
|
||
AnyError,
|
||
MongoCompatibilityError,
|
||
MongoInvalidArgumentError,
|
||
MongoNotConnectedError,
|
||
MongoParseError,
|
||
MongoRuntimeError
|
||
} from './error';
|
||
import type { Explain } from './explain';
|
||
import type { MongoClient } from './mongo_client';
|
||
import type { CommandOperationOptions, OperationParent } from './operations/command';
|
||
import type { Hint, OperationOptions } from './operations/operation';
|
||
import { PromiseProvider } from './promise_provider';
|
||
import { ReadConcern } from './read_concern';
|
||
import { ReadPreference } from './read_preference';
|
||
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';
|
||
|
||
/**
|
||
* MongoDB Driver style callback
|
||
* @public
|
||
*/
|
||
export type Callback<T = any> = (error?: AnyError, result?: T) => void;
|
||
|
||
export const MAX_JS_INT = Number.MAX_SAFE_INTEGER + 1;
|
||
|
||
export type AnyOptions = Document;
|
||
|
||
/**
|
||
* Throws if collectionName is not a valid mongodb collection namespace.
|
||
* @internal
|
||
*/
|
||
export function checkCollectionName(collectionName: string): void {
|
||
if ('string' !== typeof collectionName) {
|
||
throw new MongoInvalidArgumentError('Collection name must be a String');
|
||
}
|
||
|
||
if (!collectionName || collectionName.indexOf('..') !== -1) {
|
||
throw new MongoInvalidArgumentError('Collection names cannot be empty');
|
||
}
|
||
|
||
if (
|
||
collectionName.indexOf('$') !== -1 &&
|
||
collectionName.match(/((^\$cmd)|(oplog\.\$main))/) == null
|
||
) {
|
||
// TODO(NODE-3483): Use MongoNamespace static method
|
||
throw new MongoInvalidArgumentError("Collection names must not contain '$'");
|
||
}
|
||
|
||
if (collectionName.match(/^\.|\.$/) != null) {
|
||
// TODO(NODE-3483): Use MongoNamespace static method
|
||
throw new MongoInvalidArgumentError("Collection names must not start or end with '.'");
|
||
}
|
||
|
||
// Validate that we are not passing 0x00 in the collection name
|
||
if (collectionName.indexOf('\x00') !== -1) {
|
||
// TODO(NODE-3483): Use MongoNamespace static method
|
||
throw new MongoInvalidArgumentError('Collection names cannot contain a null character');
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Ensure Hint field is in a shape we expect:
|
||
* - object of index names mapping to 1 or -1
|
||
* - just an index name
|
||
* @internal
|
||
*/
|
||
export function normalizeHintField(hint?: Hint): Hint | undefined {
|
||
let finalHint = undefined;
|
||
|
||
if (typeof hint === 'string') {
|
||
finalHint = hint;
|
||
} else if (Array.isArray(hint)) {
|
||
finalHint = {};
|
||
|
||
hint.forEach(param => {
|
||
finalHint[param] = 1;
|
||
});
|
||
} else if (hint != null && typeof hint === 'object') {
|
||
finalHint = {} as Document;
|
||
for (const name in hint) {
|
||
finalHint[name] = hint[name];
|
||
}
|
||
}
|
||
|
||
return finalHint;
|
||
}
|
||
|
||
const TO_STRING = (object: unknown) => Object.prototype.toString.call(object);
|
||
/**
|
||
* Checks if arg is an Object:
|
||
* - **NOTE**: the check is based on the `[Symbol.toStringTag]() === 'Object'`
|
||
* @internal
|
||
*/
|
||
|
||
export function isObject(arg: unknown): arg is object {
|
||
return '[object Object]' === TO_STRING(arg);
|
||
}
|
||
|
||
/** @internal */
|
||
export function mergeOptions<T, S>(target: T, source: S): T & S {
|
||
return { ...target, ...source };
|
||
}
|
||
|
||
/** @internal */
|
||
export function filterOptions(options: AnyOptions, names: ReadonlyArray<string>): AnyOptions {
|
||
const filterOptions: AnyOptions = {};
|
||
|
||
for (const name in options) {
|
||
if (names.includes(name)) {
|
||
filterOptions[name] = options[name];
|
||
}
|
||
}
|
||
|
||
// Filtered options
|
||
return filterOptions;
|
||
}
|
||
|
||
interface HasRetryableWrites {
|
||
retryWrites?: boolean;
|
||
}
|
||
/**
|
||
* Applies retryWrites: true to a command if retryWrites is set on the command's database.
|
||
* @internal
|
||
*
|
||
* @param target - The target command to which we will apply retryWrites.
|
||
* @param db - The database from which we can inherit a retryWrites value.
|
||
*/
|
||
export function applyRetryableWrites<T extends HasRetryableWrites>(target: T, db?: Db): T {
|
||
if (db && db.s.options?.retryWrites) {
|
||
target.retryWrites = true;
|
||
}
|
||
|
||
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.
|
||
* @internal
|
||
*
|
||
* @param target - the target command we will be applying the write concern to
|
||
* @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
|
||
*
|
||
* @typeParam T - The resolution type of the possible promise
|
||
* @param value - An object that could be a promise
|
||
* @returns true if the provided value is a Promise
|
||
*/
|
||
export function isPromiseLike<T = any>(value?: PromiseLike<T> | void): value is Promise<T> {
|
||
return !!value && typeof value.then === 'function';
|
||
}
|
||
|
||
/**
|
||
* Applies collation to a given command.
|
||
* @internal
|
||
*
|
||
* @param command - the command on which to apply collation
|
||
* @param target - target of command
|
||
* @param options - options containing collation settings
|
||
*/
|
||
export function decorateWithCollation(
|
||
command: Document,
|
||
target: MongoClient | Db | Collection,
|
||
options: AnyOptions
|
||
): void {
|
||
const capabilities = getTopology(target).capabilities;
|
||
if (options.collation && typeof options.collation === 'object') {
|
||
if (capabilities && capabilities.commandsTakeCollation) {
|
||
command.collation = options.collation;
|
||
} else {
|
||
throw new MongoCompatibilityError(`Current topology does not support collation`);
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Applies a read concern to a given command.
|
||
* @internal
|
||
*
|
||
* @param command - the command on which to apply the read concern
|
||
* @param coll - the parent collection of the operation calling this method
|
||
*/
|
||
export function decorateWithReadConcern(
|
||
command: Document,
|
||
coll: { s: { readConcern?: ReadConcern } },
|
||
options?: OperationOptions
|
||
): void {
|
||
if (options && options.session && options.session.inTransaction()) {
|
||
return;
|
||
}
|
||
const readConcern = Object.assign({}, command.readConcern || {});
|
||
if (coll.s.readConcern) {
|
||
Object.assign(readConcern, coll.s.readConcern);
|
||
}
|
||
|
||
if (Object.keys(readConcern).length > 0) {
|
||
Object.assign(command, { readConcern: readConcern });
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Applies an explain to a given command.
|
||
* @internal
|
||
*
|
||
* @param command - the command on which to apply the explain
|
||
* @param options - the options containing the explain verbosity
|
||
*/
|
||
export function decorateWithExplain(command: Document, explain: Explain): Document {
|
||
if (command.explain) {
|
||
return command;
|
||
}
|
||
|
||
return { explain: command, verbosity: explain.verbosity };
|
||
}
|
||
|
||
/**
|
||
* @internal
|
||
*/
|
||
export type TopologyProvider =
|
||
| MongoClient
|
||
| ClientSession
|
||
| FindCursor
|
||
| AbstractCursor
|
||
| Collection<any>
|
||
| Db;
|
||
|
||
/**
|
||
* A helper function to get the topology from a given provider. Throws
|
||
* if the topology cannot be found.
|
||
* @throws MongoNotConnectedError
|
||
* @internal
|
||
*/
|
||
export function getTopology(provider: TopologyProvider): Topology {
|
||
// MongoClient or ClientSession or AbstractCursor
|
||
if ('topology' in provider && provider.topology) {
|
||
return provider.topology;
|
||
} else if ('s' in provider && 'client' in provider.s && provider.s.client.topology) {
|
||
return provider.s.client.topology;
|
||
} else if ('s' in provider && 'db' in provider.s && provider.s.db.s.client.topology) {
|
||
return provider.s.db.s.client.topology;
|
||
}
|
||
|
||
throw new MongoNotConnectedError('MongoClient must be connected to perform this operation');
|
||
}
|
||
|
||
/**
|
||
* Default message handler for generating deprecation warnings.
|
||
* @internal
|
||
*
|
||
* @param name - function name
|
||
* @param option - option name
|
||
* @returns warning message
|
||
*/
|
||
export function defaultMsgHandler(name: string, option: string): string {
|
||
return `${name} option [${option}] is deprecated and will be removed in a later version.`;
|
||
}
|
||
|
||
export interface DeprecateOptionsConfig {
|
||
/** function name */
|
||
name: string;
|
||
/** options to deprecate */
|
||
deprecatedOptions: string[];
|
||
/** index of options object in function arguments array */
|
||
optionsIndex: number;
|
||
/** optional custom message handler to generate warnings */
|
||
msgHandler?(this: void, name: string, option: string): string;
|
||
}
|
||
|
||
/**
|
||
* Deprecates a given function's options.
|
||
* @internal
|
||
*
|
||
* @param this - the bound class if this is a method
|
||
* @param config - configuration for deprecation
|
||
* @param fn - the target function of deprecation
|
||
* @returns modified function that warns once per deprecated option, and executes original function
|
||
*/
|
||
export function deprecateOptions(
|
||
this: unknown,
|
||
config: DeprecateOptionsConfig,
|
||
fn: (...args: any[]) => any
|
||
): any {
|
||
if ((process as any).noDeprecation === true) {
|
||
return fn;
|
||
}
|
||
|
||
const msgHandler = config.msgHandler ? config.msgHandler : defaultMsgHandler;
|
||
|
||
const optionsWarned = new Set();
|
||
function deprecated(this: any, ...args: any[]) {
|
||
const options = args[config.optionsIndex] as AnyOptions;
|
||
|
||
// ensure options is a valid, non-empty object, otherwise short-circuit
|
||
if (!isObject(options) || Object.keys(options).length === 0) {
|
||
return fn.bind(this)(...args); // call the function, no change
|
||
}
|
||
|
||
// interrupt the function call with a warning
|
||
for (const deprecatedOption of config.deprecatedOptions) {
|
||
if (deprecatedOption in options && !optionsWarned.has(deprecatedOption)) {
|
||
optionsWarned.add(deprecatedOption);
|
||
const msg = msgHandler(config.name, deprecatedOption);
|
||
emitWarning(msg);
|
||
if (this && 'getLogger' in this) {
|
||
const logger = this.getLogger();
|
||
if (logger) {
|
||
logger.warn(msg);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
return fn.bind(this)(...args);
|
||
}
|
||
|
||
// These lines copied from https://github.com/nodejs/node/blob/25e5ae41688676a5fd29b2e2e7602168eee4ceb5/lib/internal/util.js#L73-L80
|
||
// The wrapper will keep the same prototype as fn to maintain prototype chain
|
||
Object.setPrototypeOf(deprecated, fn);
|
||
if (fn.prototype) {
|
||
// Setting this (rather than using Object.setPrototype, as above) ensures
|
||
// that calling the unwrapped constructor gives an instanceof the wrapped
|
||
// constructor.
|
||
deprecated.prototype = fn.prototype;
|
||
}
|
||
|
||
return deprecated;
|
||
}
|
||
|
||
/** @internal */
|
||
export function ns(ns: string): MongoDBNamespace {
|
||
return MongoDBNamespace.fromString(ns);
|
||
}
|
||
|
||
/** @public */
|
||
export class MongoDBNamespace {
|
||
db: string;
|
||
collection: string | undefined;
|
||
/**
|
||
* Create a namespace object
|
||
*
|
||
* @param db - database name
|
||
* @param collection - collection name
|
||
*/
|
||
constructor(db: string, collection?: string) {
|
||
this.db = db;
|
||
this.collection = collection === '' ? undefined : collection;
|
||
}
|
||
|
||
toString(): string {
|
||
return this.collection ? `${this.db}.${this.collection}` : this.db;
|
||
}
|
||
|
||
withCollection(collection: string): MongoDBNamespace {
|
||
return new MongoDBNamespace(this.db, collection);
|
||
}
|
||
|
||
static fromString(namespace?: string): MongoDBNamespace {
|
||
if (typeof namespace !== 'string' || namespace === '') {
|
||
// TODO(NODE-3483): Replace with MongoNamespaceError
|
||
throw new MongoRuntimeError(`Cannot parse namespace from "${namespace}"`);
|
||
}
|
||
|
||
const [db, ...collectionParts] = namespace.split('.');
|
||
const collection = collectionParts.join('.');
|
||
return new MongoDBNamespace(db, collection === '' ? undefined : collection);
|
||
}
|
||
}
|
||
|
||
/** @internal */
|
||
export function* makeCounter(seed = 0): Generator<number> {
|
||
let count = seed;
|
||
while (true) {
|
||
const newCount = count;
|
||
count += 1;
|
||
yield newCount;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Helper for handling legacy callback support.
|
||
*/
|
||
export function maybeCallback<T>(promiseFn: () => Promise<T>, callback: null): Promise<T>;
|
||
export function maybeCallback<T>(
|
||
promiseFn: () => Promise<T>,
|
||
callback?: Callback<T>
|
||
): Promise<T> | void;
|
||
export function maybeCallback<T>(
|
||
promiseFn: () => Promise<T>,
|
||
callback?: Callback<T> | null
|
||
): Promise<T> | void {
|
||
const PromiseConstructor = PromiseProvider.get();
|
||
|
||
const promise = promiseFn();
|
||
if (callback == null) {
|
||
if (PromiseConstructor == null) {
|
||
return promise;
|
||
} else {
|
||
return new PromiseConstructor((resolve, reject) => {
|
||
promise.then(resolve, reject);
|
||
});
|
||
}
|
||
}
|
||
|
||
promise.then(
|
||
result => callback(undefined, result),
|
||
error => callback(error)
|
||
);
|
||
return;
|
||
}
|
||
|
||
/** @internal */
|
||
export function databaseNamespace(ns: string): string {
|
||
return ns.split('.')[0];
|
||
}
|
||
|
||
/**
|
||
* Synchronously Generate a UUIDv4
|
||
* @internal
|
||
*/
|
||
export function uuidV4(): Buffer {
|
||
const result = crypto.randomBytes(16);
|
||
result[6] = (result[6] & 0x0f) | 0x40;
|
||
result[8] = (result[8] & 0x3f) | 0x80;
|
||
return result;
|
||
}
|
||
|
||
/**
|
||
* A helper function for determining `maxWireVersion` between legacy and new topology instances
|
||
* @internal
|
||
*/
|
||
export function maxWireVersion(topologyOrServer?: Connection | Topology | Server): number {
|
||
if (topologyOrServer) {
|
||
if (topologyOrServer.loadBalanced) {
|
||
// Since we do not have a monitor, we assume the load balanced server is always
|
||
// pointed at the latest mongodb version. There is a risk that for on-prem
|
||
// deployments that don't upgrade immediately that this could alert to the
|
||
// application that a feature is available that is actually not.
|
||
return MAX_SUPPORTED_WIRE_VERSION;
|
||
}
|
||
if (topologyOrServer.hello) {
|
||
return topologyOrServer.hello.maxWireVersion;
|
||
}
|
||
|
||
if ('lastHello' in topologyOrServer && typeof topologyOrServer.lastHello === 'function') {
|
||
const lastHello = topologyOrServer.lastHello();
|
||
if (lastHello) {
|
||
return lastHello.maxWireVersion;
|
||
}
|
||
}
|
||
|
||
if (
|
||
topologyOrServer.description &&
|
||
'maxWireVersion' in topologyOrServer.description &&
|
||
topologyOrServer.description.maxWireVersion != null
|
||
) {
|
||
return topologyOrServer.description.maxWireVersion;
|
||
}
|
||
}
|
||
|
||
return 0;
|
||
}
|
||
|
||
/**
|
||
* Applies the function `eachFn` to each item in `arr`, in parallel.
|
||
* @internal
|
||
*
|
||
* @param arr - An array of items to asynchronously iterate over
|
||
* @param eachFn - A function to call on each item of the array. The callback signature is `(item, callback)`, where the callback indicates iteration is complete.
|
||
* @param callback - The callback called after every item has been iterated
|
||
*/
|
||
export function eachAsync<T = Document>(
|
||
arr: T[],
|
||
eachFn: (item: T, callback: (err?: AnyError) => void) => void,
|
||
callback: Callback
|
||
): void {
|
||
arr = arr || [];
|
||
|
||
let idx = 0;
|
||
let awaiting = 0;
|
||
for (idx = 0; idx < arr.length; ++idx) {
|
||
awaiting++;
|
||
eachFn(arr[idx], eachCallback);
|
||
}
|
||
|
||
if (awaiting === 0) {
|
||
callback();
|
||
return;
|
||
}
|
||
|
||
function eachCallback(err?: AnyError) {
|
||
awaiting--;
|
||
if (err) {
|
||
callback(err);
|
||
return;
|
||
}
|
||
|
||
if (idx === arr.length && awaiting <= 0) {
|
||
callback();
|
||
}
|
||
}
|
||
}
|
||
|
||
/** @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)) {
|
||
return false;
|
||
}
|
||
|
||
return arr.length === arr2.length && arr.every((elt, idx) => elt === arr2[idx]);
|
||
}
|
||
|
||
/** @internal */
|
||
export function errorStrictEqual(lhs?: AnyError | null, rhs?: AnyError | null): boolean {
|
||
if (lhs === rhs) {
|
||
return true;
|
||
}
|
||
|
||
if (!lhs || !rhs) {
|
||
return lhs === rhs;
|
||
}
|
||
|
||
if ((lhs == null && rhs != null) || (lhs != null && rhs == null)) {
|
||
return false;
|
||
}
|
||
|
||
if (lhs.constructor.name !== rhs.constructor.name) {
|
||
return false;
|
||
}
|
||
|
||
if (lhs.message !== rhs.message) {
|
||
return false;
|
||
}
|
||
|
||
return true;
|
||
}
|
||
|
||
interface StateTable {
|
||
[key: string]: string[];
|
||
}
|
||
interface ObjectWithState {
|
||
s: { state: string };
|
||
emit(event: 'stateChanged', state: string, newState: string): void;
|
||
}
|
||
interface StateTransitionFunction {
|
||
(target: ObjectWithState, newState: string): void;
|
||
}
|
||
|
||
/** @public */
|
||
export type EventEmitterWithState = {
|
||
/** @internal */
|
||
stateChanged(previous: string, current: string): void;
|
||
};
|
||
|
||
/** @internal */
|
||
export function makeStateMachine(stateTable: StateTable): StateTransitionFunction {
|
||
return function stateTransition(target, newState) {
|
||
const legalStates = stateTable[target.s.state];
|
||
if (legalStates && legalStates.indexOf(newState) < 0) {
|
||
throw new MongoRuntimeError(
|
||
`illegal state transition from [${target.s.state}] => [${newState}], allowed: [${legalStates}]`
|
||
);
|
||
}
|
||
|
||
target.emit('stateChanged', target.s.state, newState);
|
||
target.s.state = newState;
|
||
};
|
||
}
|
||
|
||
/** @internal */
|
||
export function now(): number {
|
||
const hrtime = process.hrtime();
|
||
return Math.floor(hrtime[0] * 1000 + hrtime[1] / 1000000);
|
||
}
|
||
|
||
/** @internal */
|
||
export function calculateDurationInMs(started: number): number {
|
||
if (typeof started !== 'number') {
|
||
throw new MongoInvalidArgumentError('Numeric value required to calculate duration');
|
||
}
|
||
|
||
const elapsed = now() - started;
|
||
return elapsed < 0 ? 0 : elapsed;
|
||
}
|
||
|
||
/** @internal */
|
||
export function hasAtomicOperators(doc: Document | Document[]): boolean {
|
||
if (Array.isArray(doc)) {
|
||
for (const document of doc) {
|
||
if (hasAtomicOperators(document)) {
|
||
return true;
|
||
}
|
||
}
|
||
return false;
|
||
}
|
||
|
||
const keys = Object.keys(doc);
|
||
return keys.length > 0 && keys[0][0] === '$';
|
||
}
|
||
|
||
/**
|
||
* Merge inherited properties from parent into options, prioritizing values from options,
|
||
* then values from parent.
|
||
* @internal
|
||
*/
|
||
export function resolveOptions<T extends CommandOperationOptions>(
|
||
parent: OperationParent | undefined,
|
||
options?: T
|
||
): T {
|
||
const result: T = Object.assign({}, options, resolveBSONOptions(options, parent));
|
||
|
||
// Users cannot pass a readConcern/writeConcern to operations in a transaction
|
||
const session = options?.session;
|
||
if (!session?.inTransaction()) {
|
||
const readConcern = ReadConcern.fromOptions(options) ?? parent?.readConcern;
|
||
if (readConcern) {
|
||
result.readConcern = readConcern;
|
||
}
|
||
|
||
const writeConcern = WriteConcern.fromOptions(options) ?? parent?.writeConcern;
|
||
if (writeConcern) {
|
||
result.writeConcern = writeConcern;
|
||
}
|
||
}
|
||
|
||
const readPreference = ReadPreference.fromOptions(options) ?? parent?.readPreference;
|
||
if (readPreference) {
|
||
result.readPreference = readPreference;
|
||
}
|
||
|
||
return result;
|
||
}
|
||
|
||
export function isSuperset(set: Set<any> | any[], subset: Set<any> | any[]): boolean {
|
||
set = Array.isArray(set) ? new Set(set) : set;
|
||
subset = Array.isArray(subset) ? new Set(subset) : subset;
|
||
for (const elem of subset) {
|
||
if (!set.has(elem)) {
|
||
return false;
|
||
}
|
||
}
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Checks if the document is a Hello request
|
||
* @internal
|
||
*/
|
||
export function isHello(doc: Document): boolean {
|
||
return doc[LEGACY_HELLO_COMMAND] || doc.hello ? true : false;
|
||
}
|
||
|
||
/** Returns the items that are uniquely in setA */
|
||
export function setDifference<T>(setA: Iterable<T>, setB: Iterable<T>): Set<T> {
|
||
const difference = new Set<T>(setA);
|
||
for (const elem of setB) {
|
||
difference.delete(elem);
|
||
}
|
||
return difference;
|
||
}
|
||
|
||
const HAS_OWN = (object: unknown, prop: string) =>
|
||
Object.prototype.hasOwnProperty.call(object, prop);
|
||
|
||
export function isRecord<T extends readonly string[]>(
|
||
value: unknown,
|
||
requiredKeys: T
|
||
): value is Record<T[number], any>;
|
||
export function isRecord(value: unknown): value is Record<string, any>;
|
||
export function isRecord(
|
||
value: unknown,
|
||
requiredKeys: string[] | undefined = undefined
|
||
): value is Record<string, any> {
|
||
if (!isObject(value)) {
|
||
return false;
|
||
}
|
||
|
||
const ctor = (value as any).constructor;
|
||
if (ctor && ctor.prototype) {
|
||
if (!isObject(ctor.prototype)) {
|
||
return false;
|
||
}
|
||
|
||
// Check to see if some method exists from the Object exists
|
||
if (!HAS_OWN(ctor.prototype, 'isPrototypeOf')) {
|
||
return false;
|
||
}
|
||
}
|
||
|
||
if (requiredKeys) {
|
||
const keys = Object.keys(value as Record<string, any>);
|
||
return isSuperset(keys, requiredKeys);
|
||
}
|
||
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* Make a deep copy of an object
|
||
*
|
||
* NOTE: This is not meant to be the perfect implementation of a deep copy,
|
||
* but instead something that is good enough for the purposes of
|
||
* command monitoring.
|
||
*/
|
||
export function deepCopy<T>(value: T): T {
|
||
if (value == null) {
|
||
return value;
|
||
} else if (Array.isArray(value)) {
|
||
return value.map(item => deepCopy(item)) as unknown as T;
|
||
} else if (isRecord(value)) {
|
||
const res = {} as any;
|
||
for (const key in value) {
|
||
res[key] = deepCopy(value[key]);
|
||
}
|
||
return res;
|
||
}
|
||
|
||
const ctor = (value as any).constructor;
|
||
if (ctor) {
|
||
switch (ctor.name.toLowerCase()) {
|
||
case 'date':
|
||
return new ctor(Number(value));
|
||
case 'map':
|
||
return new Map(value as any) as unknown as T;
|
||
case 'set':
|
||
return new Set(value as any) as unknown as T;
|
||
case 'buffer':
|
||
return Buffer.from(value as unknown as Buffer) as unknown as T;
|
||
}
|
||
}
|
||
|
||
return value;
|
||
}
|
||
|
||
type ListNode<T> = {
|
||
value: T;
|
||
next: ListNode<T> | HeadNode<T>;
|
||
prev: ListNode<T> | HeadNode<T>;
|
||
};
|
||
|
||
type HeadNode<T> = {
|
||
value: null;
|
||
next: ListNode<T>;
|
||
prev: ListNode<T>;
|
||
};
|
||
|
||
/**
|
||
* When a list is empty the head is a reference with pointers to itself
|
||
* So this type represents that self referential state
|
||
*/
|
||
type EmptyNode = {
|
||
value: null;
|
||
next: EmptyNode;
|
||
prev: EmptyNode;
|
||
};
|
||
|
||
/**
|
||
* A sequential list of items in a circularly linked list
|
||
* @remarks
|
||
* The head node is special, it is always defined and has a value of null.
|
||
* It is never "included" in the list, in that, it is not returned by pop/shift or yielded by the iterator.
|
||
* The circular linkage and always defined head node are to reduce checks for null next/prev references to zero.
|
||
* New nodes are declared as object literals with keys always in the same order: next, prev, value.
|
||
* @internal
|
||
*/
|
||
export class List<T = unknown> {
|
||
private readonly head: HeadNode<T> | EmptyNode;
|
||
private count: number;
|
||
|
||
get length() {
|
||
return this.count;
|
||
}
|
||
|
||
get [Symbol.toStringTag]() {
|
||
return 'List' as const;
|
||
}
|
||
|
||
constructor() {
|
||
this.count = 0;
|
||
|
||
// this is carefully crafted:
|
||
// declaring a complete and consistently key ordered
|
||
// object is beneficial to the runtime optimizations
|
||
this.head = {
|
||
next: null,
|
||
prev: null,
|
||
value: null
|
||
} as unknown as EmptyNode;
|
||
this.head.next = this.head;
|
||
this.head.prev = this.head;
|
||
}
|
||
|
||
toArray() {
|
||
return Array.from(this);
|
||
}
|
||
|
||
toString() {
|
||
return `head <=> ${this.toArray().join(' <=> ')} <=> head`;
|
||
}
|
||
|
||
*[Symbol.iterator](): Generator<T, void, void> {
|
||
for (const node of this.nodes()) {
|
||
yield node.value;
|
||
}
|
||
}
|
||
|
||
private *nodes(): Generator<ListNode<T>, void, void> {
|
||
let ptr: HeadNode<T> | ListNode<T> | EmptyNode = this.head.next;
|
||
while (ptr !== this.head) {
|
||
// Save next before yielding so that we make removing within iteration safe
|
||
const { next } = ptr as ListNode<T>;
|
||
yield ptr as ListNode<T>;
|
||
ptr = next;
|
||
}
|
||
}
|
||
|
||
/** Insert at end of list */
|
||
push(value: T) {
|
||
this.count += 1;
|
||
const newNode: ListNode<T> = {
|
||
next: this.head as HeadNode<T>,
|
||
prev: this.head.prev as ListNode<T>,
|
||
value
|
||
};
|
||
this.head.prev.next = newNode;
|
||
this.head.prev = newNode;
|
||
}
|
||
|
||
/** Inserts every item inside an iterable instead of the iterable itself */
|
||
pushMany(iterable: Iterable<T>) {
|
||
for (const value of iterable) {
|
||
this.push(value);
|
||
}
|
||
}
|
||
|
||
/** Insert at front of list */
|
||
unshift(value: T) {
|
||
this.count += 1;
|
||
const newNode: ListNode<T> = {
|
||
next: this.head.next as ListNode<T>,
|
||
prev: this.head as HeadNode<T>,
|
||
value
|
||
};
|
||
this.head.next.prev = newNode;
|
||
this.head.next = newNode;
|
||
}
|
||
|
||
private remove(node: ListNode<T> | EmptyNode): T | null {
|
||
if (node === this.head || this.length === 0) {
|
||
return null;
|
||
}
|
||
|
||
this.count -= 1;
|
||
|
||
const prevNode = node.prev;
|
||
const nextNode = node.next;
|
||
prevNode.next = nextNode;
|
||
nextNode.prev = prevNode;
|
||
|
||
return node.value;
|
||
}
|
||
|
||
/** Removes the first node at the front of the list */
|
||
shift(): T | null {
|
||
return this.remove(this.head.next);
|
||
}
|
||
|
||
/** Removes the last node at the end of the list */
|
||
pop(): T | null {
|
||
return this.remove(this.head.prev);
|
||
}
|
||
|
||
/** Iterates through the list and removes nodes where filter returns true */
|
||
prune(filter: (value: T) => boolean) {
|
||
for (const node of this.nodes()) {
|
||
if (filter(node.value)) {
|
||
this.remove(node);
|
||
}
|
||
}
|
||
}
|
||
|
||
clear() {
|
||
this.count = 0;
|
||
this.head.next = this.head as EmptyNode;
|
||
this.head.prev = this.head as EmptyNode;
|
||
}
|
||
|
||
/** Returns the first item in the list, does not remove */
|
||
first(): T | null {
|
||
// If the list is empty, value will be the head's null
|
||
return this.head.next.value;
|
||
}
|
||
|
||
/** Returns the last item in the list, does not remove */
|
||
last(): T | null {
|
||
// If the list is empty, value will be the head's null
|
||
return this.head.prev.value;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* A pool of Buffers which allow you to read them as if they were one
|
||
* @internal
|
||
*/
|
||
export class BufferPool {
|
||
private buffers: List<Buffer>;
|
||
private totalByteLength: number;
|
||
|
||
constructor() {
|
||
this.buffers = new List();
|
||
this.totalByteLength = 0;
|
||
}
|
||
|
||
get length(): number {
|
||
return this.totalByteLength;
|
||
}
|
||
|
||
/** Adds a buffer to the internal buffer pool list */
|
||
append(buffer: Buffer): void {
|
||
this.buffers.push(buffer);
|
||
this.totalByteLength += buffer.length;
|
||
}
|
||
|
||
/**
|
||
* If BufferPool contains 4 bytes or more construct an int32 from the leading bytes,
|
||
* otherwise return null. Size can be negative, caller should error check.
|
||
*/
|
||
getInt32(): number | null {
|
||
if (this.totalByteLength < 4) {
|
||
return null;
|
||
}
|
||
const firstBuffer = this.buffers.first();
|
||
if (firstBuffer != null && firstBuffer.byteLength >= 4) {
|
||
return firstBuffer.readInt32LE(0);
|
||
}
|
||
|
||
// Unlikely case: an int32 is split across buffers.
|
||
// Use read and put the returned buffer back on top
|
||
const top4Bytes = this.read(4);
|
||
const value = top4Bytes.readInt32LE(0);
|
||
|
||
// Put it back.
|
||
this.totalByteLength += 4;
|
||
this.buffers.unshift(top4Bytes);
|
||
|
||
return value;
|
||
}
|
||
|
||
/** Reads the requested number of bytes, optionally consuming them */
|
||
read(size: number): Buffer {
|
||
if (typeof size !== 'number' || size < 0) {
|
||
throw new MongoInvalidArgumentError('Argument "size" must be a non-negative number');
|
||
}
|
||
|
||
// oversized request returns empty buffer
|
||
if (size > this.totalByteLength) {
|
||
return Buffer.alloc(0);
|
||
}
|
||
|
||
// We know we have enough, we just don't know how it is spread across chunks
|
||
// TODO(NODE-4732): alloc API should change based on raw option
|
||
const result = Buffer.allocUnsafe(size);
|
||
|
||
for (let bytesRead = 0; bytesRead < size; ) {
|
||
const buffer = this.buffers.shift();
|
||
if (buffer == null) {
|
||
break;
|
||
}
|
||
const bytesRemaining = size - bytesRead;
|
||
const bytesReadable = Math.min(bytesRemaining, buffer.byteLength);
|
||
const bytes = buffer.subarray(0, bytesReadable);
|
||
|
||
result.set(bytes, bytesRead);
|
||
|
||
bytesRead += bytesReadable;
|
||
this.totalByteLength -= bytesReadable;
|
||
if (bytesReadable < buffer.byteLength) {
|
||
this.buffers.unshift(buffer.subarray(bytesReadable));
|
||
}
|
||
}
|
||
|
||
return result;
|
||
}
|
||
}
|
||
|
||
/** @public */
|
||
export class HostAddress {
|
||
host: string | undefined = undefined;
|
||
port: number | undefined = undefined;
|
||
socketPath: string | undefined = undefined;
|
||
isIPv6 = false;
|
||
|
||
constructor(hostString: string) {
|
||
const escapedHost = hostString.split(' ').join('%20'); // escape spaces, for socket path hosts
|
||
|
||
if (escapedHost.endsWith('.sock')) {
|
||
// heuristically determine if we're working with a domain socket
|
||
this.socketPath = decodeURIComponent(escapedHost);
|
||
return;
|
||
}
|
||
|
||
const urlString = `iLoveJS://${escapedHost}`;
|
||
let url;
|
||
try {
|
||
url = new URL(urlString);
|
||
} catch (urlError) {
|
||
const runtimeError = new MongoRuntimeError(`Unable to parse ${escapedHost} with URL`);
|
||
runtimeError.cause = urlError;
|
||
throw runtimeError;
|
||
}
|
||
|
||
const hostname = url.hostname;
|
||
const port = url.port;
|
||
|
||
let normalized = decodeURIComponent(hostname).toLowerCase();
|
||
if (normalized.startsWith('[') && normalized.endsWith(']')) {
|
||
this.isIPv6 = true;
|
||
normalized = normalized.substring(1, hostname.length - 1);
|
||
}
|
||
|
||
this.host = normalized.toLowerCase();
|
||
|
||
if (typeof port === 'number') {
|
||
this.port = port;
|
||
} else if (typeof port === 'string' && port !== '') {
|
||
this.port = Number.parseInt(port, 10);
|
||
} else {
|
||
this.port = 27017;
|
||
}
|
||
|
||
if (this.port === 0) {
|
||
throw new MongoParseError('Invalid port (zero) with hostname');
|
||
}
|
||
Object.freeze(this);
|
||
}
|
||
|
||
[Symbol.for('nodejs.util.inspect.custom')](): string {
|
||
return this.inspect();
|
||
}
|
||
|
||
inspect(): string {
|
||
return `new HostAddress('${this.toString()}')`;
|
||
}
|
||
|
||
toString(): string {
|
||
if (typeof this.host === 'string') {
|
||
if (this.isIPv6) {
|
||
return `[${this.host}]:${this.port}`;
|
||
}
|
||
return `${this.host}:${this.port}`;
|
||
}
|
||
return `${this.socketPath}`;
|
||
}
|
||
|
||
static fromString(this: void, s: string): HostAddress {
|
||
return new HostAddress(s);
|
||
}
|
||
|
||
static fromHostPort(host: string, port: number): HostAddress {
|
||
if (host.includes(':')) {
|
||
host = `[${host}]`; // IPv6 address
|
||
}
|
||
return HostAddress.fromString(`${host}:${port}`);
|
||
}
|
||
|
||
static fromSrvRecord({ name, port }: SrvRecord): HostAddress {
|
||
return HostAddress.fromHostPort(name, port);
|
||
}
|
||
}
|
||
|
||
export const DEFAULT_PK_FACTORY = {
|
||
// We prefer not to rely on ObjectId having a createPk method
|
||
createPk(): ObjectId {
|
||
return new ObjectId();
|
||
}
|
||
};
|
||
|
||
/**
|
||
* When the driver used emitWarning the code will be equal to this.
|
||
* @public
|
||
*
|
||
* @example
|
||
* ```ts
|
||
* process.on('warning', (warning) => {
|
||
* if (warning.code === MONGODB_WARNING_CODE) console.error('Ah an important warning! :)')
|
||
* })
|
||
* ```
|
||
*/
|
||
export const MONGODB_WARNING_CODE = 'MONGODB DRIVER' as const;
|
||
|
||
/** @internal */
|
||
export function emitWarning(message: string): void {
|
||
return process.emitWarning(message, { code: MONGODB_WARNING_CODE } as any);
|
||
}
|
||
|
||
const emittedWarnings = new Set();
|
||
/**
|
||
* Will emit a warning once for the duration of the application.
|
||
* Uses the message to identify if it has already been emitted
|
||
* so using string interpolation can cause multiple emits
|
||
* @internal
|
||
*/
|
||
export function emitWarningOnce(message: string): void {
|
||
if (!emittedWarnings.has(message)) {
|
||
emittedWarnings.add(message);
|
||
return emitWarning(message);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Takes a JS object and joins the values into a string separated by ', '
|
||
*/
|
||
export function enumToString(en: Record<string, unknown>): string {
|
||
return Object.values(en).join(', ');
|
||
}
|
||
|
||
/**
|
||
* Determine if a server supports retryable writes.
|
||
*
|
||
* @internal
|
||
*/
|
||
export function supportsRetryableWrites(server?: Server): boolean {
|
||
if (!server) {
|
||
return false;
|
||
}
|
||
|
||
if (server.loadBalanced) {
|
||
// Loadbalanced topologies will always support retry writes
|
||
return true;
|
||
}
|
||
|
||
if (server.description.logicalSessionTimeoutMinutes != null) {
|
||
// that supports sessions
|
||
if (server.description.type !== ServerType.Standalone) {
|
||
// and that is not a standalone
|
||
return true;
|
||
}
|
||
}
|
||
|
||
return false;
|
||
}
|
||
|
||
export function parsePackageVersion({ version }: { version: string }): {
|
||
major: number;
|
||
minor: number;
|
||
patch: number;
|
||
} {
|
||
const [major, minor, patch] = version.split('.').map((n: string) => Number.parseInt(n, 10));
|
||
return { major, minor, patch };
|
||
}
|
||
|
||
/**
|
||
* Fisher–Yates Shuffle
|
||
*
|
||
* Reference: https://bost.ocks.org/mike/shuffle/
|
||
* @param sequence - items to be shuffled
|
||
* @param limit - Defaults to `0`. If nonzero shuffle will slice the randomized array e.g, `.slice(0, limit)` otherwise will return the entire randomized array.
|
||
*/
|
||
export function shuffle<T>(sequence: Iterable<T>, limit = 0): Array<T> {
|
||
const items = Array.from(sequence); // shallow copy in order to never shuffle the input
|
||
|
||
if (limit > items.length) {
|
||
throw new MongoRuntimeError('Limit must be less than the number of items');
|
||
}
|
||
|
||
let remainingItemsToShuffle = items.length;
|
||
const lowerBound = limit % items.length === 0 ? 1 : items.length - limit;
|
||
while (remainingItemsToShuffle > lowerBound) {
|
||
// Pick a remaining element
|
||
const randomIndex = Math.floor(Math.random() * remainingItemsToShuffle);
|
||
remainingItemsToShuffle -= 1;
|
||
|
||
// And swap it with the current element
|
||
const swapHold = items[remainingItemsToShuffle];
|
||
items[remainingItemsToShuffle] = items[randomIndex];
|
||
items[randomIndex] = swapHold;
|
||
}
|
||
|
||
return limit % items.length === 0 ? items : items.slice(lowerBound);
|
||
}
|
||
|
||
// TODO: this should be codified in command construction
|
||
// @see https://github.com/mongodb/specifications/blob/master/source/read-write-concern/read-write-concern.rst#read-concern
|
||
export function commandSupportsReadConcern(command: Document, options?: Document): boolean {
|
||
if (command.aggregate || command.count || command.distinct || command.find || command.geoNear) {
|
||
return true;
|
||
}
|
||
|
||
if (
|
||
command.mapReduce &&
|
||
options &&
|
||
options.out &&
|
||
(options.out.inline === 1 || options.out === 'inline')
|
||
) {
|
||
return true;
|
||
}
|
||
|
||
return false;
|
||
}
|
||
|
||
/** A utility function to get the instance of mongodb-client-encryption, if it exists. */
|
||
export function getMongoDBClientEncryption(): {
|
||
extension: (mdb: unknown) => {
|
||
AutoEncrypter: any;
|
||
ClientEncryption: any;
|
||
};
|
||
} | null {
|
||
let mongodbClientEncryption = null;
|
||
|
||
// NOTE(NODE-4254): This is to get around the circular dependency between
|
||
// mongodb-client-encryption and the driver in the test scenarios.
|
||
if (
|
||
typeof process.env.MONGODB_CLIENT_ENCRYPTION_OVERRIDE === 'string' &&
|
||
process.env.MONGODB_CLIENT_ENCRYPTION_OVERRIDE.length > 0
|
||
) {
|
||
try {
|
||
// NOTE(NODE-3199): Ensure you always wrap an optional require literally in the try block
|
||
// Cannot be moved to helper utility function, bundlers search and replace the actual require call
|
||
// in a way that makes this line throw at bundle time, not runtime, catching here will make bundling succeed
|
||
mongodbClientEncryption = require(process.env.MONGODB_CLIENT_ENCRYPTION_OVERRIDE);
|
||
} catch {
|
||
// ignore
|
||
}
|
||
} else {
|
||
try {
|
||
// NOTE(NODE-3199): Ensure you always wrap an optional require literally in the try block
|
||
// Cannot be moved to helper utility function, bundlers search and replace the actual require call
|
||
// in a way that makes this line throw at bundle time, not runtime, catching here will make bundling succeed
|
||
mongodbClientEncryption = require('mongodb-client-encryption');
|
||
} catch {
|
||
// ignore
|
||
}
|
||
}
|
||
|
||
return mongodbClientEncryption;
|
||
}
|
||
|
||
/**
|
||
* Compare objectIds. `null` is always less
|
||
* - `+1 = oid1 is greater than oid2`
|
||
* - `-1 = oid1 is less than oid2`
|
||
* - `+0 = oid1 is equal oid2`
|
||
*/
|
||
export function compareObjectId(oid1?: ObjectId | null, oid2?: ObjectId | null): 0 | 1 | -1 {
|
||
if (oid1 == null && oid2 == null) {
|
||
return 0;
|
||
}
|
||
|
||
if (oid1 == null) {
|
||
return -1;
|
||
}
|
||
|
||
if (oid2 == null) {
|
||
return 1;
|
||
}
|
||
|
||
return oid1.id.compare(oid2.id);
|
||
}
|
||
|
||
export function parseInteger(value: unknown): number | null {
|
||
if (typeof value === 'number') return Math.trunc(value);
|
||
const parsedValue = Number.parseInt(String(value), 10);
|
||
|
||
return Number.isNaN(parsedValue) ? null : parsedValue;
|
||
}
|
||
|
||
export function parseUnsignedInteger(value: unknown): number | null {
|
||
const parsedInt = parseInteger(value);
|
||
|
||
return parsedInt != null && parsedInt >= 0 ? parsedInt : null;
|
||
}
|
||
|
||
/**
|
||
* Determines whether a provided address matches the provided parent domain.
|
||
*
|
||
* If a DNS server were to become compromised SRV records would still need to
|
||
* advertise addresses that are under the same domain as the srvHost.
|
||
*
|
||
* @param address - The address to check against a domain
|
||
* @param srvHost - The domain to check the provided address against
|
||
* @returns Whether the provided address matches the parent domain
|
||
*/
|
||
export function matchesParentDomain(address: string, srvHost: string): boolean {
|
||
// Remove trailing dot if exists on either the resolved address or the srv hostname
|
||
const normalizedAddress = address.endsWith('.') ? address.slice(0, address.length - 1) : address;
|
||
const normalizedSrvHost = srvHost.endsWith('.') ? srvHost.slice(0, srvHost.length - 1) : srvHost;
|
||
|
||
const allCharacterBeforeFirstDot = /^.*?\./;
|
||
// Remove all characters before first dot
|
||
// Add leading dot back to string so
|
||
// an srvHostDomain = '.trusted.site'
|
||
// will not satisfy an addressDomain that endsWith '.fake-trusted.site'
|
||
const addressDomain = `.${normalizedAddress.replace(allCharacterBeforeFirstDot, '')}`;
|
||
const srvHostDomain = `.${normalizedSrvHost.replace(allCharacterBeforeFirstDot, '')}`;
|
||
|
||
return addressDomain.endsWith(srvHostDomain);
|
||
}
|