chore: increase linting strictness

Author: nbbeeken

.eslintrc.json

@@ -32,37 +32,6 @@
     "strict": ["error", "global"],
     "promise/no-native": "error",
 
-    // TBD
-    "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-this-alias": "off",
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/no-var-requires": "off",
-    "no-var": "off",
-    "prefer-const": "off",
-    "prefer-spread": "off",
-    "prefer-rest-params": "off"
-
-    // possible future options
-    // "@typescript-eslint/ban-types": 2,
-    // "@typescript-eslint/explicit-module-boundary-types": 2,
-    // "@typescript-eslint/no-empty-function": 2,
-    // "@typescript-eslint/no-explicit-any": 2,
-    // "@typescript-eslint/no-this-alias": 2,
-    // "@typescript-eslint/no-non-null-assertion": 2,
-    // "@typescript-eslint/no-var-requires": 2,
-    // "no-var": 2,
-    // "prefer-const": 2
-  },
-  "settings": {
-    "jsdoc": {
-      "check-types": false,
-      "mode": "typescript",
-      "tagNamePreference": {
-        "augments": "extends"
-      }
-    }
+    "@typescript-eslint/no-explicit-any": "off"
   }
 }

package-lock.json

@@ -92,7 +92,7 @@
     "build:docs": "npm run build:dts && typedoc",
     "check:bench": "node test/benchmarks/driverBench",
     "check:coverage": "nyc npm run check:test",
-    "check:lint": "eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
+    "check:lint": "tsc -v && tsc --noEmit && eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
     "check:test": "mocha --recursive test/functional test/unit",
     "check:ts": "tsc --noEmit",
     "check:atlas": "mocha --config \"test/manual/mocharc.json\" test/manual/atlas_connectivity.test.js",

package.json

@@ -7,8 +7,8 @@ import type { MongoClient } from './mongo_client';
 
 /** @public */
 export class Instrumentation extends EventEmitter {
-  $MongoClient: any;
-  $prototypeConnect: any;
+  $MongoClient?: typeof MongoClient;
+  $prototypeConnect?: typeof MongoClient['connect'];
 
   /** @event */
   static readonly STARTED = 'started' as const;
@@ -21,13 +21,14 @@ export class Instrumentation extends EventEmitter {
     super();
   }
 
-  instrument(MongoClient: any, callback: Callback) {
+  instrument(mongoClientClass: typeof MongoClient, callback?: Callback): void {
     // store a reference to the original functions
-    this.$MongoClient = MongoClient;
-    const $prototypeConnect = (this.$prototypeConnect = MongoClient.prototype.connect);
+    this.$MongoClient = mongoClientClass;
+    const $prototypeConnect = (this.$prototypeConnect = mongoClientClass.prototype.connect);
 
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
     const instrumentation = this;
-    MongoClient.prototype.connect = function (this: MongoClient, callback: Callback) {
+    mongoClientClass.prototype.connect = function (this: MongoClient, callback: Callback) {
       // override monitorCommands to be switched on
       this.s.options = { ...(this.s.options ?? {}), monitorCommands: true };
 
@@ -42,12 +43,14 @@ export class Instrumentation extends EventEmitter {
       );
 
       return $prototypeConnect.call(this, callback);
-    };
+    } as MongoClient['connect'];
 
     if (typeof callback === 'function') callback(undefined, this);
   }
 
-  uninstrument() {
-    this.$MongoClient.prototype.connect = this.$prototypeConnect;
+  uninstrument(): void {
+    if (this.$MongoClient) {
+      this.$MongoClient.prototype.connect = this.$prototypeConnect as any;
+    }
   }
 }

src/apm.ts

@@ -25,6 +25,7 @@ export {
 
 /** @public */
 export interface Document {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [key: string]: any;
 }
 

src/bson.ts

@@ -209,6 +209,7 @@ export class ChangeStream extends EventEmitter {
       this.topology = parent.s.topology;
     } else if (parent instanceof MongoClient) {
       this.type = CHANGE_DOMAIN_TYPES.CLUSTER;
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       this.topology = parent.topology!;
     } else {
       throw new TypeError(
@@ -406,16 +407,16 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     }
   }
 
-  set resumeToken(token) {
+  set resumeToken(token: ResumeToken) {
     this._resumeToken = token;
     this.emit(ChangeStream.RESUME_TOKEN_CHANGED, token);
   }
 
-  get resumeToken() {
+  get resumeToken(): ResumeToken {
     return this._resumeToken;
   }
 
-  get resumeOptions() {
+  get resumeOptions(): Document {
     const result: Document = {};
     for (const optionName of CURSOR_OPTIONS) {
       if (Reflect.has(this.options, optionName)) {
@@ -438,7 +439,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     return result;
   }
 
-  cacheResumeToken(resumeToken: ResumeToken) {
+  cacheResumeToken(resumeToken: ResumeToken): void {
     if (this.bufferedCount() === 0 && this.cursorState.postBatchResumeToken) {
       this.resumeToken = this.cursorState.postBatchResumeToken;
     } else {
@@ -447,7 +448,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     this.hasReceived = true;
   }
 
-  _processBatch(batchName: string, response?: Document) {
+  _processBatch(batchName: string, response?: Document): void {
     const cursor = response?.cursor || {};
     if (cursor.postBatchResumeToken) {
       this.cursorState.postBatchResumeToken = cursor.postBatchResumeToken;
@@ -458,7 +459,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     }
   }
 
-  _initializeCursor(callback: Callback) {
+  _initializeCursor(callback: Callback): void {
     super._initializeCursor((err, response) => {
       if (err || response == null) {
         callback(err, response);
@@ -482,7 +483,7 @@ export class ChangeStreamCursor extends Cursor<AggregateOperation, ChangeStreamC
     });
   }
 
-  _getMore(callback: Callback) {
+  _getMore(callback: Callback): void {
     super._getMore((err, response) => {
       if (err) {
         callback(err);
@@ -644,7 +645,7 @@ function processError(changeStream: ChangeStream, error?: AnyError, callback?: C
     changeStream.closed = true;
   }
 
-  if (cursor && isResumableError(error, maxWireVersion(cursor.server))) {
+  if (cursor && isResumableError(error as MongoError, maxWireVersion(cursor.server))) {
     changeStream.cursor = undefined;
 
     // stop listening to all events from old cursor

src/change_stream.ts

@@ -45,7 +45,7 @@ import {
   EstimatedDocumentCountOperation,
   EstimatedDocumentCountOptions
 } from './operations/estimated_document_count';
-import { FindOperation, FindOptions } from './operations/find';
+import { FindOperation, FindOptions, Sort } from './operations/find';
 import { FindOneOperation } from './operations/find_one';
 import {
   FindAndModifyOperation,
@@ -126,7 +126,7 @@ export interface CollectionOptions
 
 /** @internal */
 export interface CollectionPrivate {
-  pkFactory: PkFactory | typeof ObjectId;
+  pkFactory: PkFactory;
   db: Db;
   topology: Topology;
   options: any;
@@ -186,7 +186,9 @@ export class Collection implements OperationParent {
       options,
       topology: db.s.topology,
       namespace: new MongoDBNamespace(db.databaseName, name),
-      pkFactory: db.options?.pkFactory ? db.options.pkFactory : ObjectId,
+      pkFactory: db.options?.pkFactory
+        ? db.options.pkFactory
+        : ((ObjectId as unknown) as PkFactory), // TODO: remove when bson is typed
       readPreference: ReadPreference.fromOptions(options),
       readConcern: ReadConcern.fromOptions(options),
       writeConcern: WriteConcern.fromOptions(options),
@@ -213,23 +215,21 @@ export class Collection implements OperationParent {
 
   /**
    * The name of the database this collection belongs to
-   * @readonly
    */
   get dbName(): string {
     return this.s.namespace.db;
   }
 
   /**
    * The name of this collection
-   * @readonly
    */
   get collectionName(): string {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     return this.s.namespace.collection!;
   }
 
   /**
    * The namespace of this collection, in the format `${this.dbName}.${this.collectionName}`
-   * @readonly
    */
   get namespace(): string {
     return this.s.namespace.toString();
@@ -238,7 +238,6 @@ export class Collection implements OperationParent {
   /**
    * The current readConcern of the collection. If not explicitly defined for
    * this collection, will be inherited from the parent DB
-   * @readonly
    */
   get readConcern(): ReadConcern | undefined {
     if (this.s.readConcern == null) {
@@ -250,7 +249,6 @@ export class Collection implements OperationParent {
   /**
    * The current readPreference of the collection. If not explicitly defined for
    * this collection, will be inherited from the parent DB
-   * @readonly
    */
   get readPreference(): ReadPreference | undefined {
     if (this.s.readPreference == null) {
@@ -263,7 +261,6 @@ export class Collection implements OperationParent {
   /**
    * The current writeConcern of the collection. If not explicitly defined for
    * this collection, will be inherited from the parent DB
-   * @readonly
    */
   get writeConcern(): WriteConcern | undefined {
     if (this.s.writeConcern == null) {
@@ -1445,7 +1442,7 @@ export class Collection implements OperationParent {
     callback?: Callback<Document | Document[]>
   ): Promise<Document | Document[]> | void {
     if ('function' === typeof options) (callback = options), (options = {});
-    // Out must allways be defined (make sure we don't break weirdly on pre 1.8+ servers)
+    // Out must always be defined (make sure we don't break weirdly on pre 1.8+ servers)
     if (options?.out == null) {
       throw new Error(
         'the out option parameter must be defined, see mongodb docs for possible values'
@@ -1652,16 +1649,30 @@ export class Collection implements OperationParent {
    * @param options - Optional settings for the command
    * @param callback - An optional callback, a Promise will be returned if none is provided
    */
+  findAndRemove(query: Document, callback: Callback): void;
+  findAndRemove(query: Document, sort: Sort, callback: Callback): void;
+  findAndRemove(query: Document, options: FindAndModifyOptions, callback: Callback): void;
   findAndRemove(
     query: Document,
-    sort: Document,
+    sort: Sort,
     options: FindAndModifyOptions,
     callback: Callback
-  ): Promise<Document> | void {
-    const args = Array.prototype.slice.call(arguments, 1);
-    callback = typeof args[args.length - 1] === 'function' ? args.pop() : undefined;
-    sort = args.length ? args.shift() || [] : [];
-    options = args.length ? args.shift() || {} : {};
+  ): void;
+  findAndRemove(query: Document): Promise<Document>;
+  findAndRemove(query: Document, sort: Sort): Promise<Document>;
+  findAndRemove(query: Document, sort: Sort, options: FindAndModifyOptions): Promise<Document>;
+  findAndRemove(
+    query: Document,
+    ...args: any[]
+  ): // TODO: Use labeled tuples when api-extractor supports TS 4.0
+  /*sort?: Sort | FindAndModifyOptions | Callback<Document>, */
+  /*options?: FindAndModifyOptions | Callback<Document>, */
+  /*callback?: Callback<Document>*/
+  Promise<Document> | void {
+    const callback =
+      typeof args[args.length - 1] === 'function' ? (args.pop() as Callback) : undefined;
+    const sort = (args.length ? args.shift() || [] : []) as Sort;
+    const options = (args.length ? args.shift() || {} : {}) as FindAndModifyOptions;
 
     // Add the remove option
     options.remove = true;
@@ -1687,26 +1698,23 @@ export class Collection implements OperationParent {
    * @param callback - An optional callback, a Promise will be returned if none is provided
    */
   group(
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     keys: any,
-    condition: any,
-    initial: any,
-    reduce: any,
-    finalize: any,
-    command: any,
-    options: any,
-    callback: Callback
-  ) {
-    const args = Array.prototype.slice.call(arguments, 3);
-    callback = typeof args[args.length - 1] === 'function' ? args.pop() : undefined;
-    reduce = args.length ? args.shift() : null;
-    finalize = args.length ? args.shift() : null;
-    command = args.length ? args.shift() : null;
-    options = args.length ? args.shift() || {} : {};
+    condition: Document,
+    initial: Document,
+    // TODO: Use labeled tuples when api-extractor supports TS 4.0
+    ...args: [/*reduce?:*/ any, /*finalize?:*/ any, /*command?:*/ any, /*callback?:*/ Callback]
+  ): Promise<Document> | void {
+    const callback = typeof args[args.length - 1] === 'function' ? args.pop() : undefined;
+    let reduce = args.length ? args.shift() : undefined;
+    let finalize = args.length ? args.shift() : undefined;
+    let command = args.length ? args.shift() : undefined;
+    const options = args.length ? args.shift() || {} : {};
 
     // Make sure we are backward compatible
     if (!(typeof finalize === 'function')) {
       command = finalize;
-      finalize = null;
+      finalize = undefined;
     }
 
     if (
@@ -1751,7 +1759,7 @@ export class Collection implements OperationParent {
    *
    * @param query - Query object to locate the object to modify.
    * @param sort - If multiple docs match, choose the first one in the specified sort order as the object to manipulate.
-   * @param doc - The fields/vals to be updated.
+   * @param doc - The fields/values to be updated.
    * @param options - Optional settings for the command
    * @param callback - An optional callback, a Promise will be returned if none is provided
    */