mongodb 4.2.1 → 4.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "4.2.1",
+  "version": "4.4.0",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -32,54 +32,55 @@
     "email": "dbx-node@mongodb.com"
   },
   "dependencies": {
-    "bson": "^4.6.0",
+    "bson": "^4.6.1",
     "denque": "^2.0.1",
-    "mongodb-connection-string-url": "^2.2.0"
+    "mongodb-connection-string-url": "^2.4.1",
+    "socks": "^2.6.1"
   },
   "devDependencies": {
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@microsoft/api-extractor": "^7.18.19",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@microsoft/api-extractor": "^7.19.4",
     "@microsoft/tsdoc-config": "^0.15.2",
-    "@types/chai": "^4.2.22",
+    "@types/chai": "^4.3.0",
     "@types/chai-subset": "^1.3.3",
     "@types/kerberos": "^1.1.1",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^16.11.8",
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^17.0.13",
     "@types/saslprep": "^1.0.1",
     "@types/semver": "^7.3.9",
-    "@types/sinon": "^10.0.6",
+    "@types/sinon": "^10.0.9",
     "@types/whatwg-url": "^8.2.1",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "^5.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
     "bluebird": "^3.7.2",
-    "chai": "^4.3.4",
+    "chai": "^4.3.6",
     "chai-subset": "^1.6.0",
     "chalk": "^4.1.2",
-    "co": "4.6.0",
-    "downlevel-dts": "^0.7.0",
-    "eslint": "^8.2.0",
+    "downlevel-dts": "^0.8.0",
+    "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "eslint-plugin-tsdoc": "^0.2.14",
     "js-yaml": "^4.1.0",
     "lodash.camelcase": "^4.3.0",
-    "mocha": "^9.1.3",
+    "mocha": "^9.2.0",
     "mocha-sinon": "^2.1.2",
-    "mongodb-mock-server": "^2.0.1",
     "nyc": "^15.1.0",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.1",
     "rimraf": "^3.0.2",
     "semver": "^7.3.5",
-    "sinon": "^12.0.1",
+    "sinon": "^13.0.0",
     "sinon-chai": "^3.7.0",
-    "source-map-support": "^0.5.20",
+    "source-map-support": "^0.5.21",
     "standard-version": "^9.3.2",
     "ts-node": "^10.4.0",
-    "tsd": "^0.19.0",
-    "typescript": "^4.5.2",
+    "tsd": "^0.19.1",
+    "typescript": "^4.5.5",
     "typescript-cached-transpile": "^0.0.6",
     "xml2js": "^0.4.23",
-    "yargs": "^17.2.1"
+    "yargs": "^17.3.1"
   },
   "license": "Apache-2.0",
   "engines": {
@@ -94,27 +95,29 @@
   },
   "scripts": {
     "build:evergreen": "node .evergreen/generate_evergreen_tasks.js",
-    "build:ts": "rimraf lib && ./node_modules/typescript/bin/tsc",
+    "build:ts": "rimraf lib && node ./node_modules/typescript/bin/tsc",
     "build:dts": "npm run build:ts && api-extractor run && rimraf 'lib/**/*.d.ts*' && downlevel-dts mongodb.d.ts mongodb.ts34.d.ts",
     "build:docs": "typedoc",
     "check:bench": "node test/benchmarks/driverBench",
     "check:coverage": "nyc npm run test:all",
+    "check:integration-coverage": "nyc npm run check:test",
     "check:lint": "npm run build:dts && npm run check:dts && npm run check:eslint && npm run check:tsd",
     "check:eslint": "eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
     "check:tsd": "tsd --version && tsd",
-    "check:dts": "./node_modules/typescript/bin/tsc --noEmit mongodb.d.ts && tsd",
-    "check:test": "mocha --file test/tools/runner --recursive test/functional test/integration",
-    "check:unit": "mocha --recursive test/unit/",
-    "check:ts": "./node_modules/typescript/bin/tsc -v && ./node_modules/typescript/bin/tsc --noEmit",
-    "check:atlas": "mocha --config \"test/manual/mocharc.json\" test/manual/atlas_connectivity.test.js",
-    "check:adl": "mocha --file test/tools/runner test/manual/data_lake.test.js",
-    "check:aws": "mocha --file test/tools/runner test/functional/mongodb_aws.test.js",
-    "check:ocsp": "mocha --config \"test/manual/mocharc.json\" test/manual/ocsp_support.test.js",
-    "check:kerberos": "mocha --config \"test/manual/mocharc.json\" test/manual/kerberos.test.js",
-    "check:tls": "mocha --config \"test/manual/mocharc.json\" test/manual/tls_support.test.js",
-    "check:ldap": "mocha --config \"test/manual/mocharc.json\" test/manual/ldap.test.js",
-    "check:csfle": "mocha --file test/tools/runner test/functional/client_side_encryption",
-    "check:snappy": "mocha --file test/tools/runner test/functional/unit_snappy.test.js",
+    "check:dts": "node ./node_modules/typescript/bin/tsc --noEmit mongodb.d.ts && tsd",
+    "check:test": "mocha --config test/mocha_mongodb.json test/integration",
+    "check:unit": "mocha test/unit",
+    "check:ts": "node ./node_modules/typescript/bin/tsc -v && node ./node_modules/typescript/bin/tsc --noEmit",
+    "check:atlas": "mocha --config test/manual/mocharc.json test/manual/atlas_connectivity.test.js",
+    "check:adl": "mocha --config test/mocha_mongodb.json test/manual/atlas-data-lake-testing",
+    "check:aws": "mocha --config test/mocha_mongodb.json test/integration/auth/mongodb_aws.test.js",
+    "check:ocsp": "mocha --config test/manual/mocharc.json test/manual/ocsp_support.test.js",
+    "check:kerberos": "mocha --config test/manual/mocharc.json test/manual/kerberos.test.js",
+    "check:tls": "mocha --config test/manual/mocharc.json test/manual/tls_support.test.js",
+    "check:ldap": "mocha --config test/manual/mocharc.json test/manual/ldap.test.js",
+    "check:socks5": "mocha --config test/manual/mocharc.json test/manual/socks5.test.ts",
+    "check:csfle": "mocha --config test/mocha_mongodb.json test/integration/client-side-encryption",
+    "check:snappy": "mocha test/unit/assorted/snappy.test.js",
     "prepare": "node etc/prepare.js",
     "release": "standard-version -i HISTORY.md",
     "test": "npm run check:lint && npm run test:all",

package/src/admin.ts

@@ -1,20 +1,20 @@
+import type { Document } from './bson';
+import type { Db } from './db';
 import { AddUserOperation, AddUserOptions } from './operations/add_user';
-import { RemoveUserOperation, RemoveUserOptions } from './operations/remove_user';
-import {
-  ValidateCollectionOperation,
-  ValidateCollectionOptions
-} from './operations/validate_collection';
+import type { CommandOperationOptions } from './operations/command';
+import { executeOperation } from './operations/execute_operation';
 import {
   ListDatabasesOperation,
   ListDatabasesOptions,
   ListDatabasesResult
 } from './operations/list_databases';
-import { executeOperation } from './operations/execute_operation';
+import { RemoveUserOperation, RemoveUserOptions } from './operations/remove_user';
 import { RunCommandOperation, RunCommandOptions } from './operations/run_command';
+import {
+  ValidateCollectionOperation,
+  ValidateCollectionOptions
+} from './operations/validate_collection';
 import { Callback, getTopology } from './utils';
-import type { Document } from './bson';
-import type { CommandOperationOptions } from './operations/command';
-import type { Db } from './db';
 
 /** @internal */
 export interface AdminPrivate {

package/src/bson.ts

@@ -1,11 +1,14 @@
 import type {
-  serialize as serializeFn,
+  calculateObjectSize as calculateObjectSizeFn,
   deserialize as deserializeFn,
-  calculateObjectSize as calculateObjectSizeFn
+  DeserializeOptions,
+  serialize as serializeFn,
+  SerializeOptions
 } from 'bson';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 let BSON = require('bson');
+
 try {
   // Ensure you always wrap an optional require in the try block NODE-3199
   BSON = require('bson-ext');
@@ -19,25 +22,23 @@ export const serialize = BSON.serialize as typeof serializeFn;
 export const calculateObjectSize = BSON.calculateObjectSize as typeof calculateObjectSizeFn;
 
 export {
-  Long,
   Binary,
-  ObjectId,
-  Timestamp,
+  BSONRegExp,
+  BSONSymbol,
   Code,
-  MinKey,
-  MaxKey,
+  DBRef,
   Decimal128,
-  Int32,
+  Document,
   Double,
-  DBRef,
-  BSONRegExp,
-  BSONSymbol,
+  Int32,
+  Long,
   Map,
-  Document
+  MaxKey,
+  MinKey,
+  ObjectId,
+  Timestamp
 } from 'bson';
 
-import type { DeserializeOptions, SerializeOptions } from 'bson';
-
 /**
  * BSON Serialization options.
  * @public
@@ -55,6 +56,9 @@ export interface BSONSerializeOptions
     > {
   /** Return BSON filled buffers from operations */
   raw?: boolean;
+
+  /** Enable utf8 validation when deserializing BSON documents.  Defaults to true. */
+  enableUtf8Validation?: boolean;
 }
 
 export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSerializeOptions {
@@ -66,7 +70,8 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
     serializeFunctions,
     ignoreUndefined,
     bsonRegExp,
-    raw
+    raw,
+    enableUtf8Validation
   } = options;
   return {
     fieldsAsRaw,
@@ -76,7 +81,8 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
     serializeFunctions,
     ignoreUndefined,
     bsonRegExp,
-    raw
+    raw,
+    enableUtf8Validation
   };
 }
 
@@ -99,6 +105,8 @@ export function resolveBSONOptions(
     ignoreUndefined: options?.ignoreUndefined ?? parentOptions?.ignoreUndefined ?? false,
     bsonRegExp: options?.bsonRegExp ?? parentOptions?.bsonRegExp ?? false,
     serializeFunctions: options?.serializeFunctions ?? parentOptions?.serializeFunctions ?? false,
-    fieldsAsRaw: options?.fieldsAsRaw ?? parentOptions?.fieldsAsRaw ?? {}
+    fieldsAsRaw: options?.fieldsAsRaw ?? parentOptions?.fieldsAsRaw ?? {},
+    enableUtf8Validation:
+      options?.enableUtf8Validation ?? parentOptions?.enableUtf8Validation ?? true
   };
 }

package/src/bulk/common.ts

@@ -1,39 +1,39 @@
-import { PromiseProvider } from '../promise_provider';
 import {
+  BSONSerializeOptions,
+  Document,
   Long,
   ObjectId,
-  Document,
-  BSONSerializeOptions,
   resolveBSONOptions,
   Timestamp
 } from '../bson';
+import type { Collection } from '../collection';
 import {
-  MongoWriteConcernError,
   AnyError,
+  MongoBatchReExecutionError,
   MONGODB_ERROR_CODES,
-  MongoServerError,
   MongoInvalidArgumentError,
-  MongoBatchReExecutionError
+  MongoServerError,
+  MongoWriteConcernError
 } from '../error';
+import type { Filter, OneOrMore, OptionalId, UpdateFilter, WithoutId } from '../mongo_types';
+import type { CollationOptions, CommandOperationOptions } from '../operations/command';
+import { DeleteOperation, DeleteStatement, makeDeleteStatement } from '../operations/delete';
+import { executeOperation } from '../operations/execute_operation';
+import { InsertOperation } from '../operations/insert';
+import type { Hint } from '../operations/operation';
+import { makeUpdateStatement, UpdateOperation, UpdateStatement } from '../operations/update';
+import { PromiseProvider } from '../promise_provider';
+import type { Topology } from '../sdam/topology';
 import {
   applyRetryableWrites,
+  Callback,
   executeLegacyOperation,
+  getTopology,
   hasAtomicOperators,
-  Callback,
   MongoDBNamespace,
-  getTopology,
   resolveOptions
 } from '../utils';
-import { executeOperation } from '../operations/execute_operation';
-import { InsertOperation } from '../operations/insert';
-import { UpdateOperation, UpdateStatement, makeUpdateStatement } from '../operations/update';
-import { DeleteOperation, DeleteStatement, makeDeleteStatement } from '../operations/delete';
 import { WriteConcern } from '../write_concern';
-import type { Collection } from '../collection';
-import type { Topology } from '../sdam/topology';
-import type { CommandOperationOptions, CollationOptions } from '../operations/command';
-import type { Hint } from '../operations/operation';
-import type { Filter, OneOrMore, OptionalId, UpdateFilter } from '../mongo_types';
 
 /** @internal */
 const kServerError = Symbol('serverError');
@@ -79,7 +79,7 @@ export interface ReplaceOneModel<TSchema extends Document = Document> {
   /** The filter to limit the replaced document. */
   filter: Filter<TSchema>;
   /** The document with which to replace the matched document. */
-  replacement: TSchema;
+  replacement: WithoutId<TSchema>;
   /** Specifies a collation. */
   collation?: CollationOptions;
   /** The index to use. If specified, then the query system will only consider plans using the hinted index. */
@@ -940,7 +940,7 @@ export abstract class BulkOperationBase {
 
     const topology = getTopology(collection);
     options = options == null ? {} : options;
-    // TODO Bring from driver information in isMaster
+    // TODO Bring from driver information in hello
     // Get the namespace for the write operations
     const namespace = collection.s.namespace;
     // Used to mark operation as executed
@@ -950,16 +950,15 @@ export abstract class BulkOperationBase {
     const currentOp = undefined;
 
     // Set max byte size
-    const isMaster = topology.lastIsMaster();
+    const hello = topology.lastHello();
 
     // If we have autoEncryption on, batch-splitting must be done on 2mb chunks, but single documents
     // over 2mb are still allowed
     const usingAutoEncryption = !!(topology.s.options && topology.s.options.autoEncrypter);
     const maxBsonObjectSize =
-      isMaster && isMaster.maxBsonObjectSize ? isMaster.maxBsonObjectSize : 1024 * 1024 * 16;
+      hello && hello.maxBsonObjectSize ? hello.maxBsonObjectSize : 1024 * 1024 * 16;
     const maxBatchSizeBytes = usingAutoEncryption ? 1024 * 1024 * 2 : maxBsonObjectSize;
-    const maxWriteBatchSize =
-      isMaster && isMaster.maxWriteBatchSize ? isMaster.maxWriteBatchSize : 1000;
+    const maxWriteBatchSize = hello && hello.maxWriteBatchSize ? hello.maxWriteBatchSize : 1000;
 
     // Calculates the largest possible size of an Array key, represented as a BSON string
     // element. This calculation:

package/src/bulk/ordered.ts

@@ -1,10 +1,10 @@
-import * as BSON from '../bson';
-import { BulkOperationBase, Batch, BatchType, BulkWriteOptions } from './common';
 import type { Document } from '../bson';
+import * as BSON from '../bson';
 import type { Collection } from '../collection';
-import type { UpdateStatement } from '../operations/update';
-import type { DeleteStatement } from '../operations/delete';
 import { MongoInvalidArgumentError } from '../error';
+import type { DeleteStatement } from '../operations/delete';
+import type { UpdateStatement } from '../operations/update';
+import { Batch, BatchType, BulkOperationBase, BulkWriteOptions } from './common';
 
 /** @public */
 export class OrderedBulkOperation extends BulkOperationBase {

package/src/bulk/unordered.ts

@@ -1,11 +1,11 @@
-import * as BSON from '../bson';
-import { BulkOperationBase, Batch, BatchType, BulkWriteOptions, BulkWriteResult } from './common';
-import type { Callback } from '../utils';
 import type { Document } from '../bson';
+import * as BSON from '../bson';
 import type { Collection } from '../collection';
-import type { UpdateStatement } from '../operations/update';
-import type { DeleteStatement } from '../operations/delete';
 import { MongoInvalidArgumentError } from '../error';
+import type { DeleteStatement } from '../operations/delete';
+import type { UpdateStatement } from '../operations/update';
+import type { Callback } from '../utils';
+import { Batch, BatchType, BulkOperationBase, BulkWriteOptions, BulkWriteResult } from './common';
 
 /** @public */
 export class UnorderedBulkOperation extends BulkOperationBase {

package/src/change_stream.ts

@@ -1,39 +1,40 @@
 import Denque = require('denque');
+import type { Readable } from 'stream';
+
+import type { Document, Timestamp } from './bson';
+import { Collection } from './collection';
+import {
+  AbstractCursor,
+  AbstractCursorEvents,
+  AbstractCursorOptions,
+  CursorStreamOptions
+} from './cursor/abstract_cursor';
+import { Db } from './db';
 import {
-  MongoError,
   AnyError,
   isResumableError,
-  MongoRuntimeError,
   MongoAPIError,
-  MongoChangeStreamError
+  MongoChangeStreamError,
+  MongoError,
+  MongoRuntimeError
 } from './error';
+import { MongoClient } from './mongo_client';
+import { InferIdType, Nullable, TypedEventEmitter } from './mongo_types';
 import { AggregateOperation, AggregateOptions } from './operations/aggregate';
+import type { CollationOptions, OperationParent } from './operations/command';
+import { executeOperation, ExecutionResult } from './operations/execute_operation';
+import type { ReadPreference } from './read_preference';
+import type { Topology } from './sdam/topology';
+import type { ClientSession } from './sessions';
 import {
-  maxWireVersion,
   calculateDurationInMs,
-  now,
+  Callback,
+  getTopology,
+  maxWireVersion,
   maybePromise,
   MongoDBNamespace,
-  Callback,
-  getTopology
+  now
 } from './utils';
-import type { ReadPreference } from './read_preference';
-import type { Timestamp, Document } from './bson';
-import type { Topology } from './sdam/topology';
-import type { OperationParent, CollationOptions } from './operations/command';
-import { MongoClient } from './mongo_client';
-import { Db } from './db';
-import { Collection } from './collection';
-import type { Readable } from 'stream';
-import {
-  AbstractCursor,
-  AbstractCursorEvents,
-  AbstractCursorOptions,
-  CursorStreamOptions
-} from './cursor/abstract_cursor';
-import type { ClientSession } from './sessions';
-import { executeOperation, ExecutionResult } from './operations/execute_operation';
-import { InferIdType, Nullable, TypedEventEmitter } from './mongo_types';
 
 /** @internal */
 const kResumeQueue = Symbol('resumeQueue');
@@ -70,7 +71,7 @@ export interface ResumeOptions {
 }
 
 /**
- * Represents the logical starting point for a new or resuming {@link https://docs.mongodb.com/master/changeStreams/#change-stream-resume-token| Change Stream} on the server.
+ * Represents the logical starting point for a new or resuming {@link https://docs.mongodb.com/manual/changeStreams/#std-label-change-stream-resume| Change Stream} on the server.
  * @public
  */
 export type ResumeToken = unknown;
@@ -97,9 +98,9 @@ export interface ChangeStreamOptions extends AggregateOptions {
   fullDocument?: string;
   /** The maximum amount of time for the server to wait on new documents to satisfy a change stream query. */
   maxAwaitTimeMS?: number;
-  /** Allows you to start a changeStream after a specified event. See {@link https://docs.mongodb.com/master/changeStreams/#resumeafter-for-change-streams|ChangeStream documentation}. */
+  /** Allows you to start a changeStream after a specified event. See {@link https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams|ChangeStream documentation}. */
   resumeAfter?: ResumeToken;
-  /** Similar to resumeAfter, but will allow you to start after an invalidated event. See {@link https://docs.mongodb.com/master/changeStreams/#startafter-for-change-streams|ChangeStream documentation}. */
+  /** Similar to resumeAfter, but will allow you to start after an invalidated event. See {@link https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams|ChangeStream documentation}. */
   startAfter?: ResumeToken;
   /** Will start the changeStream after the specified operationTime. */
   startAtOperationTime?: OperationTime;
@@ -143,7 +144,7 @@ export interface ChangeStreamDocument<TSchema extends Document = Document> {
    * this will contain all the components of the shard key in order,
    * followed by the _id if the _id isn’t part of the shard key.
    */
-  documentKey?: InferIdType<TSchema>;
+  documentKey?: { _id: InferIdType<TSchema> };
 
   /**
    * Only present for ops of type ‘update’.

package/src/cmap/auth/auth_provider.ts

@@ -1,9 +1,9 @@
 import type { Document } from '../../bson';
+import { MongoRuntimeError } from '../../error';
+import type { Callback, ClientMetadataOptions } from '../../utils';
+import type { HandshakeDocument } from '../connect';
 import type { Connection, ConnectionOptions } from '../connection';
 import type { MongoCredentials } from './mongo_credentials';
-import type { HandshakeDocument } from '../connect';
-import type { ClientMetadataOptions, Callback } from '../../utils';
-import { MongoRuntimeError } from '../../error';
 
 export type AuthContextOptions = ConnectionOptions & ClientMetadataOptions;
 

package/src/cmap/auth/gssapi.ts

@@ -1,23 +1,39 @@
-import { AuthProvider, AuthContext } from './auth_provider';
+import * as dns from 'dns';
+
+import type { Document } from '../../bson';
+import { Kerberos, KerberosClient } from '../../deps';
 import {
-  MongoRuntimeError,
+  MongoError,
   MongoInvalidArgumentError,
   MongoMissingCredentialsError,
-  MongoError,
-  MongoMissingDependencyError
+  MongoMissingDependencyError,
+  MongoRuntimeError
 } from '../../error';
-import { Kerberos, KerberosClient } from '../../deps';
 import { Callback, ns } from '../../utils';
-import type { Document } from '../../bson';
+import { AuthContext, AuthProvider } from './auth_provider';
+
+/** @public */
+export const GSSAPICanonicalizationValue = Object.freeze({
+  on: true,
+  off: false,
+  none: 'none',
+  forward: 'forward',
+  forwardAndReverse: 'forwardAndReverse'
+} as const);
+
+/** @public */
+export type GSSAPICanonicalizationValue =
+  typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue];
 
 type MechanismProperties = {
+  /** @deprecated use `CANONICALIZE_HOST_NAME` instead */
   gssapiCanonicalizeHostName?: boolean;
+  CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue;
+  SERVICE_HOST?: string;
   SERVICE_NAME?: string;
   SERVICE_REALM?: string;
 };
 
-import * as dns from 'dns';
-
 export class GSSAPI extends AuthProvider {
   auth(authContext: AuthContext, callback: Callback): void {
     const { connection, credentials } = authContext;
@@ -70,6 +86,7 @@ export class GSSAPI extends AuthProvider {
     });
   }
 }
+
 function makeKerberosClient(authContext: AuthContext, callback: Callback<KerberosClient>): void {
   const { hostAddress } = authContext.options;
   const { credentials } = authContext;
@@ -89,7 +106,7 @@ function makeKerberosClient(authContext: AuthContext, callback: Callback<Kerbero
 
   const serviceName = mechanismProperties.SERVICE_NAME ?? 'mongodb';
 
-  performGssapiCanonicalizeHostName(
+  performGSSAPICanonicalizeHostName(
     hostAddress.host,
     mechanismProperties,
     (err?: Error | MongoError, host?: string) => {
@@ -100,7 +117,8 @@ function makeKerberosClient(authContext: AuthContext, callback: Callback<Kerbero
         Object.assign(initOptions, { user: username, password: password });
       }
 
-      let spn = `${serviceName}${process.platform === 'win32' ? '/' : '@'}${host}`;
+      const spnHost = mechanismProperties.SERVICE_HOST ?? host;
+      let spn = `${serviceName}${process.platform === 'win32' ? '/' : '@'}${spnHost}`;
       if ('SERVICE_REALM' in mechanismProperties) {
         spn = `${spn}@${mechanismProperties.SERVICE_REALM}`;
       }
@@ -169,19 +187,52 @@ function finalize(
   });
 }
 
-function performGssapiCanonicalizeHostName(
+export function performGSSAPICanonicalizeHostName(
   host: string,
   mechanismProperties: MechanismProperties,
   callback: Callback<string>
 ): void {
-  if (!mechanismProperties.gssapiCanonicalizeHostName) return callback(undefined, host);
+  const mode = mechanismProperties.CANONICALIZE_HOST_NAME;
+  if (!mode || mode === GSSAPICanonicalizationValue.none) {
+    return callback(undefined, host);
+  }
+
+  // If forward and reverse or true
+  if (
+    mode === GSSAPICanonicalizationValue.on ||
+    mode === GSSAPICanonicalizationValue.forwardAndReverse
+  ) {
+    // Perform the lookup of the ip address.
+    dns.lookup(host, (error, address) => {
+      // No ip found, return the error.
+      if (error) return callback(error);
+
+      // Perform a reverse ptr lookup on the ip address.
+      dns.resolvePtr(address, (err, results) => {
+        // This can error as ptr records may not exist for all ips. In this case
+        // fallback to a cname lookup as dns.lookup() does not return the
+        // cname.
+        if (err) {
+          return resolveCname(host, callback);
+        }
+        // If the ptr did not error but had no results, return the host.
+        callback(undefined, results.length > 0 ? results[0] : host);
+      });
+    });
+  } else {
+    // The case for forward is just to resolve the cname as dns.lookup()
+    // will not return it.
+    resolveCname(host, callback);
+  }
+}
 
+export function resolveCname(host: string, callback: Callback<string>): void {
   // Attempt to resolve the host name
   dns.resolveCname(host, (err, r) => {
-    if (err) return callback(err);
+    if (err) return callback(undefined, host);
 
     // Get the first resolve host id
-    if (Array.isArray(r) && r.length > 0) {
+    if (r.length > 0) {
       return callback(undefined, r[0]);
     }