feat(NODE-4925)!: remove deprecated options and types (#3513)

baileympearson · web-flow · commit 8f8ea453bd3c · 2023-01-05T15:06:02.000-05:00
diff --git a/etc/notes/CHANGES_5.0.0.md b/etc/notes/CHANGES_5.0.0.md
@@ -16,7 +16,50 @@ The following is a detailed collection of the changes in the major v5 release of
 
 ## Changes
 
-### salveOk options removed
+### `AddUserOptions.digestPassword` removed
+
+The `digestPassword` option has been removed from the add user helper.
+
+### Removal of Internal Types from Public API
+
+The following types are used internally the driver but were accidentally exported.  They have now been
+marked internal and are no longer exported.
+
+- ServerSelector
+- PipeOptions
+- ServerOptions
+
+### `DeleteOptions.single` Option Removed
+
+TODO - merge in Neal's removal of `collection.remove` and combine notes
+
+### Remove of `ObjectID` Type in Favor Of `ObjectId`
+
+For clarity the deprecated and duplicate export ObjectID has been removed. ObjectId matches the class name and is equal in every way to the capital "D" export.
+
+### Kerberos Option `gssapiCanonicalizeHostName` Removed
+
+`gssapiCanonicalizeHostName` has been removed in favor of the `CANONICALIZE_HOST_NAME` value.
+
+### `Projection` and `ProjectionOperations` Types Removed
+
+Both of these types were unused but exported.  These types have been removed.  Please
+use `Document` instead.
+
+### `CommandOperationOptions.fullResponse` Option Removed
+
+The `fullResponse` option on the `CommandOperationOptions` as unused in the driver and has been removed.
+
+### `BulkWriteOptions.keepGoing` Option Removed
+
+The `keepGoing` option on the `BulkWriteOptions` has been removed.  Please use the `ordered` option instead.
+
+### `WriteConcernError.err()` Removed
+
+The `err()` getter on the WriteConcernError class has been removed.  The `toJSON()` method can be in place
+of `err()`.
+
+### slaveOk options removed
 
 The deprecated `slaveOk` option and `slaveOk()` method on the `Collection` class have been removed. Please
 now use `secondaryOk` as the replacement for the option and the method.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -48,7 +48,7 @@
     "@aws-sdk/credential-providers": "^3.201.0",
     "@iarna/toml": "^2.2.5",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@microsoft/api-extractor": "^7.33.3",
+    "@microsoft/api-extractor": "^7.33.7",
     "@microsoft/tsdoc-config": "^0.16.2",
     "@mongodb-js/zstd": "^1.0.0",
     "@types/chai": "^4.3.3",
@@ -62,12 +62,12 @@
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.8",
     "@types/whatwg-url": "^11.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.40.0",
-    "@typescript-eslint/parser": "^5.40.0",
+    "@typescript-eslint/eslint-plugin": "^5.48.0",
+    "@typescript-eslint/parser": "^5.48.0",
     "chai": "^4.3.6",
     "chai-subset": "^1.6.0",
     "chalk": "^4.1.2",
-    "eslint": "^8.25.0",
+    "eslint": "^8.31.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.2.1",
@@ -87,8 +87,8 @@
     "source-map-support": "^0.5.21",
     "standard-version": "^9.5.0",
     "ts-node": "^10.9.1",
-    "tsd": "^0.24.1",
-    "typescript": "^4.8.4",
+    "tsd": "^0.25.0",
+    "typescript": "^4.9.4",
     "typescript-cached-transpile": "^0.0.6",
     "xml2js": "^0.4.23",
     "yargs": "^17.6.0"
diff --git a/src/bulk/common.ts b/src/bulk/common.ts
@@ -363,11 +363,6 @@ export class WriteConcernError {
     return this[kServerError].errInfo;
   }
 
-  /** @deprecated The `err` prop that contained a MongoServerError has been deprecated. */
-  get err(): WriteConcernErrorData {
-    return this[kServerError];
-  }
-
   toJSON(): WriteConcernErrorData {
     return this[kServerError];
   }
@@ -876,8 +871,6 @@ export interface BulkWriteOptions extends CommandOperationOptions {
   bypassDocumentValidation?: boolean;
   /** If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails. */
   ordered?: boolean;
-  /** @deprecated use `ordered` instead */
-  keepGoing?: boolean;
   /** Force server to assign _id values instead of driver. */
   forceServerObjectId?: boolean;
   /** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
diff --git a/src/change_stream.ts b/src/change_stream.ts
@@ -78,14 +78,6 @@ export type ResumeToken = unknown;
  */
 export type OperationTime = Timestamp;
 
-/**
- * @public
- * @deprecated This interface is unused and will be removed in the next major version of the driver.
- */
-export interface PipeOptions {
-  end?: boolean;
-}
-
 /**
  * Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.
  * @public
diff --git a/src/cmap/auth/gssapi.ts b/src/cmap/auth/gssapi.ts
@@ -26,8 +26,6 @@ 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;
diff --git a/src/cmap/auth/mongo_credentials.ts b/src/cmap/auth/mongo_credentials.ts
@@ -1,7 +1,6 @@
 // Resolves the default auth mechanism according to
 import type { Document } from '../../bson';
 import { MongoAPIError, MongoMissingCredentialsError } from '../../error';
-import { emitWarningOnce } from '../../utils';
 import { GSSAPICanonicalizationValue } from './gssapi';
 import { AUTH_MECHS_AUTH_SRC_EXTERNAL, AuthMechanism } from './providers';
 
@@ -91,14 +90,6 @@ export class MongoCredentials {
       }
     }
 
-    if ('gssapiCanonicalizeHostName' in this.mechanismProperties) {
-      emitWarningOnce(
-        'gssapiCanonicalizeHostName is deprecated. Please use CANONICALIZE_HOST_NAME instead.'
-      );
-      this.mechanismProperties.CANONICALIZE_HOST_NAME =
-        this.mechanismProperties.gssapiCanonicalizeHostName;
-    }
-
     Object.freeze(this.mechanismProperties);
     Object.freeze(this);
   }
diff --git a/src/collection.ts b/src/collection.ts
@@ -1652,10 +1652,6 @@ export class Collection<TSchema extends Document = Document> {
     options = options || { ordered: false };
     docs = !Array.isArray(docs) ? [docs] : docs;
 
-    if (options.keepGoing === true) {
-      options.ordered = false;
-    }
-
     return this.insertMany(docs, options, callback);
   }
 
diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,4 @@
 import { Admin } from './admin';
-import { ObjectId } from './bson';
 import { OrderedBulkOperation } from './bulk/ordered';
 import { UnorderedBulkOperation } from './bulk/unordered';
 import { ChangeStream } from './change_stream';
@@ -36,14 +35,8 @@ export {
   ObjectId,
   Timestamp
 } from './bson';
-export { ChangeStreamCursor } from './cursor/change_stream_cursor';
-/**
- * @public
- * @deprecated Please use `ObjectId`
- */
-export const ObjectID = ObjectId;
-
 export { AnyBulkWriteOperation, BulkWriteOptions, MongoBulkWriteError } from './bulk/common';
+export { ChangeStreamCursor } from './cursor/change_stream_cursor';
 export {
   MongoAPIError,
   MongoAWSError,
@@ -204,7 +197,6 @@ export type {
   ChangeStreamShardCollectionDocument,
   ChangeStreamUpdateDocument,
   OperationTime,
-  PipeOptions,
   ResumeOptions,
   ResumeToken,
   UpdateDescription
@@ -339,8 +331,6 @@ export type {
   OnlyFieldsOfType,
   OptionalId,
   OptionalUnlessRequiredId,
-  Projection,
-  ProjectionOperators,
   PropertyType,
   PullAllOperator,
   PullOperator,
diff --git a/src/mongo_types.ts b/src/mongo_types.ts
@@ -192,20 +192,6 @@ export type BSONType = typeof BSONType[keyof typeof BSONType];
 /** @public */
 export type BSONTypeAlias = keyof typeof BSONType;
 
-/**
- * @public
- * Projection is flexible to permit the wide array of aggregation operators
- * @deprecated since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export type Projection<TSchema extends Document = Document> = Document;
-
-/**
- * @public
- * @deprecated since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further
- */
-export type ProjectionOperators = Document;
-
 /** @public */
 export type IsAny<Type, ResultIfAny, ResultIfNotAny> = true extends false & Type
   ? ResultIfAny
diff --git a/src/operations/add_user.ts b/src/operations/add_user.ts
@@ -22,8 +22,6 @@ export interface RoleSpecification {
 
 /** @public */
 export interface AddUserOptions extends CommandOperationOptions {
-  /** @deprecated Please use db.command('createUser', ...) instead for this option */
-  digestPassword?: null;
   /** Roles associated with the created user */
   roles?: string | string[] | RoleSpecification | RoleSpecification[];
   /** Custom data associated with the user (only Mongodb 2.6 or higher) */
@@ -57,7 +55,9 @@ export class AddUserOperation extends CommandOperation<Document> {
     const options = this.options;
 
     // Error out if digestPassword set
-    if (options.digestPassword != null) {
+    // v5 removed the digestPassword option from AddUserOptions but we still want to throw
+    // an error when digestPassword is provided.
+    if ('digestPassword' in options && options.digestPassword != null) {
       return callback(
         new MongoInvalidArgumentError(
           'Option "digestPassword" not supported via addUser, use db.command(...) instead'
diff --git a/src/operations/command.ts b/src/operations/command.ts
@@ -36,8 +36,6 @@ export interface CommandOperationOptions
   extends OperationOptions,
     WriteConcernOptions,
     ExplainOptions {
-  /** @deprecated This option does nothing */
-  fullResponse?: boolean;
   /** Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported) */
   readConcern?: ReadConcernLike;
   /** Collation */
diff --git a/src/operations/delete.ts b/src/operations/delete.ts
@@ -18,9 +18,6 @@ export interface DeleteOptions extends CommandOperationOptions, WriteConcernOpti
   hint?: string | Document;
   /** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
   let?: Document;
-
-  /** @deprecated use `removeOne` or `removeMany` to implicitly specify the limit */
-  single?: boolean;
 }
 
 /** @public */
@@ -152,10 +149,6 @@ export function makeDeleteStatement(
     limit: typeof options.limit === 'number' ? options.limit : 0
   };
 
-  if (options.single === true) {
-    op.limit = 1;
-  }
-
   if (options.collation) {
     op.collation = options.collation;
   }
diff --git a/src/sdam/server.ts b/src/sdam/server.ts
@@ -75,7 +75,7 @@ const stateTransition = makeStateMachine({
 /** @internal */
 const kMonitor = Symbol('monitor');
 
-/** @public */
+/** @internal */
 export type ServerOptions = Omit<ConnectionPoolOptions, 'id' | 'generation' | 'hostAddress'> &
   MonitorOptions;
 
diff --git a/src/sdam/server_selection.ts b/src/sdam/server_selection.ts
@@ -11,7 +11,7 @@ const SMALLEST_MAX_STALENESS_SECONDS = 90;
 //  Minimum version to try writes on secondaries.
 export const MIN_SECONDARY_WRITE_WIRE_VERSION = 13;
 
-/** @public */
+/** @internal */
 export type ServerSelector = (
   topologyDescription: TopologyDescription,
   servers: ServerDescription[]
diff --git a/src/sdam/topology.ts b/src/sdam/topology.ts
@@ -127,7 +127,7 @@ export interface TopologyPrivate {
   detectSrvRecords: (event: SrvPollingEvent) => void;
 }
 
-/** @public */
+/** @internal */
 export interface TopologyOptions extends BSONSerializeOptions, ServerOptions {
   srvMaxHosts: number;
   srvServiceName: string;
diff --git a/test/integration/crud/crud_api.test.ts b/test/integration/crud/crud_api.test.ts
@@ -670,21 +670,7 @@ describe('CRUD API', function () {
         // Legacy update method
         // -------------------------------------------------
         const legacyRemove = function () {
-          db.collection('t4_1').insertMany(
-            [{ a: 1 }, { a: 1 }],
-            { writeConcern: { w: 1 } },
-            function (err, r) {
-              expect(err).to.not.exist;
-              test.equal(2, r.insertedCount);
-
-              db.collection('t4_1').remove({ a: 1 }, { single: true }, function (err, r) {
-                expect(err).to.not.exist;
-                test.equal(1, r.deletedCount);
-
-                deleteOne();
-              });
-            }
-          );
+          deleteOne();
         };
 
         //
diff --git a/test/integration/crud/remove.test.js b/test/integration/crud/remove.test.js
@@ -107,52 +107,6 @@ describe('Remove', function () {
     }
   });
 
-  it('should correctly remove only first document', {
-    metadata: {
-      requires: { topology: ['single', 'replicaset', 'sharded', 'ssl', 'heap', 'wiredtiger'] }
-    },
-
-    test: function (done) {
-      const self = this;
-      const client = self.configuration.newClient(self.configuration.writeConcernMax(), {
-        maxPoolSize: 1
-      });
-
-      client.connect(function (err, client) {
-        const db = client.db(self.configuration.db);
-        expect(err).to.not.exist;
-
-        db.createCollection('shouldCorrectlyRemoveOnlyFirstDocument', function (err) {
-          expect(err).to.not.exist;
-
-          const collection = db.collection('shouldCorrectlyRemoveOnlyFirstDocument');
-
-          collection.insert(
-            [{ a: 1 }, { a: 1 }, { a: 1 }, { a: 1 }],
-            { writeConcern: { w: 1 } },
-            function (err) {
-              expect(err).to.not.exist;
-
-              // Remove the first
-              collection.remove(
-                { a: 1 },
-                { writeConcern: { w: 1 }, single: true },
-                function (err, r) {
-                  expect(r).property('deletedCount').to.equal(1);
-
-                  collection.find({ a: 1 }).count(function (err, result) {
-                    expect(result).to.equal(3);
-                    client.close(done);
-                  });
-                }
-              );
-            }
-          );
-        });
-      });
-    }
-  });
-
   it('should not error on empty remove', {
     metadata: {
       requires: { topology: ['single', 'replicaset', 'sharded', 'ssl', 'heap', 'wiredtiger'] }
diff --git a/test/integration/node-specific/operation_example.test.js b/test/integration/node-specific/operation_example.test.js
@@ -2541,7 +2541,7 @@ describe('Operation Examples', function () {
                   { name: 'Sarah', title: 'Princess' },
                   { name: 'Gump', title: 'Gump' }
                 ],
-                { writeConcern: { w: 1 }, keepGoing: true },
+                { writeConcern: { w: 1 }, ordered: false },
                 function (err, result) {
                   expect(result).to.not.exist;
                   test.ok(err);
diff --git a/test/integration/node-specific/operation_promises_example.test.js b/test/integration/node-specific/operation_promises_example.test.js
@@ -1854,7 +1854,7 @@ describe('Operation (Promises)', function () {
                 { name: 'Sarah', title: 'Princess' },
                 { name: 'Gump', title: 'Gump' }
               ],
-              { writeConcern: { w: 1 }, keepGoing: true }
+              { writeConcern: { w: 1 }, ordered: false }
             );
           })
           .catch(function () {
diff --git a/test/manual/kerberos.test.js b/test/manual/kerberos.test.js
diff --git a/test/types/community/collection/findX.test-d.ts b/test/types/community/collection/findX.test-d.ts
diff --git a/test/types/mongodb.test-d.ts b/test/types/mongodb.test-d.ts
diff --git a/test/unit/bson.test.js b/test/unit/bson.test.js
diff --git a/test/unit/index.test.ts b/test/unit/index.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1652,10 +1652,6 @@ export class Collection<TSchema extends Document = Document> {`
`1652`	`1652`	`options = options \|\| { ordered: false };`
`1653`	`1653`	`docs = !Array.isArray(docs) ? [docs] : docs;`
`1654`	`1654`
`1655`		`- if (options.keepGoing === true) {`
`1656`		`- options.ordered = false;`
`1657`		`- }`
`1658`		`-`
`1659`	`1655`	`return this.insertMany(docs, options, callback);`
`1660`	`1656`	`}`
`1661`	`1657`