fix(NODE-4281): ensure that the driver always uses Node.js timers (#3275)

Ensure that the driver always uses the Node.js timers API, rather
than the global one, in case they diverge. This affects Compass,
where the `setTimeout(...).unref()` usage currently results in
uncaught exceptions because `setTimeout()` returns a number in
browsers.

This change adds `import ... from 'timers';` where necessary and
adds a linter rule to prevent regressions. If this is not
an acceptable solution, we can go back to the drawing board,
but this seems like a good solution that doesn’t add too much
overhead when writing driver code.

Author: addaleax

.eslintrc.json

@@ -38,6 +38,21 @@
         "property": "only"
       }
     ],
+    "no-restricted-globals": [
+      "error",
+      {
+        "name": "setTimeout",
+        "message": "Use `import { setTimeout } from 'timers';` instead"
+      },
+      {
+        "name": "setImmediate",
+        "message": "Use `import { setImmediate } from 'timers';` instead"
+      },
+      {
+        "name": "setInterval",
+        "message": "Use `import { setInterval } from 'timers';` instead"
+      }
+    ],
     "prettier/prettier": "error",
     "tsdoc/syntax": "warn",
     "no-console": "error",

src/change_stream.ts

@@ -1,5 +1,6 @@
 import Denque = require('denque');
 import type { Readable } from 'stream';
+import { setTimeout } from 'timers';
 
 import type { Document, Long, Timestamp } from './bson';
 import { Collection } from './collection';

src/cmap/connection.ts

@@ -1,3 +1,5 @@
+import { setTimeout } from 'timers';
+
 import { BSONSerializeOptions, Document, Long, ObjectId, pluckBSONSerializeOptions } from '../bson';
 import {
   CLOSE,

src/cmap/connection_pool.ts

@@ -1,4 +1,6 @@
 import Denque = require('denque');
+import { setTimeout } from 'timers';
+
 import type { ObjectId } from '../bson';
 import {
   APM_EVENTS,

src/sdam/monitor.ts

@@ -1,3 +1,5 @@
+import { setTimeout } from 'timers';
+
 import { Document, Long } from '../bson';
 import { connect } from '../cmap/connect';
 import { Connection, ConnectionOptions } from '../cmap/connection';

src/sdam/srv_polling.ts

@@ -1,4 +1,5 @@
 import * as dns from 'dns';
+import { setTimeout } from 'timers';
 
 import { MongoRuntimeError } from '../error';
 import { Logger, LoggerOptions } from '../logger';

src/sdam/topology.ts

@@ -1,4 +1,6 @@
 import Denque = require('denque');
+import { setTimeout } from 'timers';
+
 import type { BSONSerializeOptions, Document } from '../bson';
 import { deserialize, serialize } from '../bson';
 import type { MongoCredentials } from '../cmap/auth/mongo_credentials';

src/utils.ts

@@ -1,6 +1,7 @@
 import * as crypto from 'crypto';
 import type { SrvRecord } from 'dns';
 import * as os from 'os';
+import { setTimeout } from 'timers';
 import { URL } from 'url';
 
 import { Document, ObjectId, resolveBSONOptions } from './bson';

test/integration/change-streams/change_stream.test.ts

@@ -2,6 +2,7 @@ import { strict as assert } from 'assert';
 import { expect } from 'chai';
 import { on, once } from 'events';
 import { PassThrough } from 'stream';
+import { setTimeout } from 'timers';
 import { promisify } from 'util';
 
 import {

test/integration/change-streams/change_streams.prose.test.ts

@@ -1,5 +1,6 @@
 import { expect } from 'chai';
 import * as sinon from 'sinon';
+import { setTimeout } from 'timers';
 
 import {
   ChangeStream,