refactor: Remove util dependency (#402)

Reduce the dependency on node's util by replacing 
the deprecate function and inspect symbol

NODE-2826

Author: nbbeeken

rollup.config.js

@@ -32,7 +32,7 @@ export default [
     plugins: [
       nodeResolve({ preferBuiltins: false }),
       commonjs(),
-      nodePolyfills(),
+      nodePolyfills({ include: ['buffer'] }),
       babel({
         babelHelpers: 'bundled',
         presets: [

src/objectid.ts

@@ -1,10 +1,6 @@
 import { Buffer } from 'buffer';
 import { ensureBuffer } from './ensure_buffer';
-import { randomBytes } from './parser/utils';
-
-declare const require: Function;
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { deprecate, inspect } = require('util');
+import { deprecate, randomBytes } from './parser/utils';
 
 // constants
 const PROCESS_UNIQUE = randomBytes(5);
@@ -366,12 +362,14 @@ Object.defineProperty(ObjectId, 'get_inc', {
   value: deprecate(() => ObjectId.getInc(), 'Please use the static `ObjectId.getInc()` instead')
 });
 
+const inspect = Symbol.for('nodejs.util.inspect.custom');
 /**
  * Converts to a string representation of this Id.
  *
  * @returns return the 24 character hex string representation.
  * @internal
  */
-Object.defineProperty(ObjectId.prototype, inspect.custom || 'inspect', ObjectId.prototype.toString);
+Object.defineProperty(ObjectId.prototype, inspect, ObjectId.prototype.toString);
+Object.defineProperty(ObjectId.prototype, 'inspect', ObjectId.prototype.toString);
 
 Object.defineProperty(ObjectId.prototype, '_bsontype', { value: 'ObjectID' });

src/parser/utils.ts

@@ -20,6 +20,7 @@ declare let window: any;
 declare let require: Function;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 declare let global: any;
+declare const self: unknown;
 
 export let randomBytes = insecureRandomBytes;
 if (typeof window !== 'undefined' && window.crypto && window.crypto.getRandomValues) {
@@ -73,3 +74,20 @@ export function isDate(d: unknown): d is Date {
 export function isObjectLike(candidate: unknown): candidate is Record<string, unknown> {
   return typeof candidate === 'object' && candidate !== null;
 }
+
+declare let console: { warn(...message: unknown[]): void };
+export function deprecate<T extends Function>(fn: T, message: string): T {
+  if (typeof window === 'undefined' || typeof self === 'undefined') {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    return require('util').deprecate(fn, message);
+  }
+  let warned = false;
+  function deprecated(this: unknown, ...args: unknown[]) {
+    if (!warned) {
+      console.warn(message);
+      warned = true;
+    }
+    return fn.apply(this, ...args);
+  }
+  return (deprecated as unknown) as T;
+}