chore: add lint rule to prevent import from bson in driver src (#4285)

Author: baileympearson

.eslintrc.json

@@ -266,6 +266,12 @@
             "patterns": [
               "**/../lib/**",
               "mongodb-mock-server"
+            ],
+            "paths": [
+              {
+                "name": "bson",
+                "message": "Import from the driver's bson.ts file instead."
+              }
             ]
           }
         ]

src/beta.ts

@@ -1,4 +1,4 @@
-import { type Document } from 'bson';
+import { type Document } from './bson';
 
 export * from './index';
 

src/bson.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-restricted-imports */
 import { BSON, type DeserializeOptions, type SerializeOptions } from 'bson';
 
 export {
@@ -12,6 +13,7 @@ export {
   DBRef,
   Decimal128,
   deserialize,
+  type DeserializeOptions,
   Document,
   Double,
   EJSON,
@@ -21,6 +23,7 @@ export {
   MaxKey,
   MinKey,
   ObjectId,
+  type ObjectIdLike,
   serialize,
   Timestamp,
   UUID

src/cmap/auth/mongodb_oidc.ts

@@ -1,5 +1,4 @@
-import type { Document } from 'bson';
-
+import type { Document } from '../../bson';
 import { MongoInvalidArgumentError, MongoMissingCredentialsError } from '../../error';
 import type { HandshakeDocument } from '../connect';
 import type { Connection } from '../connection';

src/cmap/auth/mongodb_oidc/callback_workflow.ts

@@ -1,6 +1,6 @@
-import { type Document } from 'bson';
 import { setTimeout } from 'timers/promises';
 
+import { type Document } from '../../../bson';
 import { MongoMissingCredentialsError } from '../../../error';
 import { ns } from '../../../utils';
 import type { Connection } from '../../connection';

src/cmap/auth/mongodb_oidc/command_builders.ts

@@ -1,5 +1,4 @@
-import { Binary, BSON, type Document } from 'bson';
-
+import { Binary, BSON, type Document } from '../../../bson';
 import { type MongoCredentials } from '../mongo_credentials';
 import { AuthMechanism } from '../providers';
 

src/cmap/auth/mongodb_oidc/human_callback_workflow.ts

@@ -1,5 +1,4 @@
-import { BSON } from 'bson';
-
+import { BSON } from '../../../bson';
 import { MONGODB_ERROR_CODES, MongoError, MongoOIDCError } from '../../../error';
 import { Timeout, TimeoutError } from '../../../timeout';
 import { type Connection } from '../../connection';

src/cmap/auth/mongodb_oidc/machine_workflow.ts

@@ -1,6 +1,6 @@
-import { type Document } from 'bson';
 import { setTimeout } from 'timers/promises';
 
+import { type Document } from '../../../bson';
 import { ns } from '../../../utils';
 import type { Connection } from '../../connection';
 import type { MongoCredentials } from '../mongo_credentials';

src/cmap/connection.ts

@@ -1,8 +1,13 @@
-import { type DeserializeOptions } from 'bson';
 import { type Readable, Transform, type TransformCallback } from 'stream';
 import { clearTimeout, setTimeout } from 'timers';
 
-import { type BSONSerializeOptions, deserialize, type Document, type ObjectId } from '../bson';
+import {
+  type BSONSerializeOptions,
+  deserialize,
+  type DeserializeOptions,
+  type Document,
+  type ObjectId
+} from '../bson';
 import { type AutoEncrypter } from '../client-side-encryption/auto_encrypter';
 import {
   CLOSE,

src/cmap/wire_protocol/on_demand/document.ts

@@ -1,11 +1,10 @@
-import { type DeserializeOptions } from 'bson';
-
 import {
   Binary,
   type BSONElement,
   BSONError,
   BSONType,
   deserialize,
+  type DeserializeOptions,
   getBigInt64LE,
   getFloat64LE,
   getInt32LE,

src/cmap/wire_protocol/responses.ts

@@ -1,9 +1,8 @@
-import { type DeserializeOptions } from 'bson';
-
 import {
   type BSONElement,
   type BSONSerializeOptions,
   BSONType,
+  type DeserializeOptions,
   type Document,
   Long,
   parseToElementsToArray,

src/cursor/client_bulk_write_cursor.ts

@@ -1,5 +1,4 @@
-import { type Document } from 'bson';
-
+import { type Document } from '../bson';
 import { type ClientBulkWriteCursorResponse } from '../cmap/wire_protocol/responses';
 import type { MongoClient } from '../mongo_client';
 import { ClientBulkWriteOperation } from '../operations/client_bulk_write/client_bulk_write';

src/mongo_types.ts

@@ -1,15 +1,16 @@
-import type { BSONType, ObjectIdLike } from 'bson';
 import { EventEmitter } from 'events';
 
 import type {
   Binary,
   BSONRegExp,
+  BSONType,
   Decimal128,
   Document,
   Double,
   Int32,
   Long,
   ObjectId,
+  ObjectIdLike,
   Timestamp
 } from './bson';
 import { type CommandStartedEvent } from './cmap/command_monitoring_events';

src/operations/search_indexes/create.ts

@@ -1,5 +1,4 @@
-import type { Document } from 'bson';
-
+import type { Document } from '../../bson';
 import type { Collection } from '../../collection';
 import type { Server } from '../../sdam/server';
 import type { ClientSession } from '../../sessions';

src/operations/search_indexes/drop.ts

@@ -1,5 +1,4 @@
-import type { Document } from 'bson';
-
+import type { Document } from '../../bson';
 import type { Collection } from '../../collection';
 import { MONGODB_ERROR_CODES, MongoServerError } from '../../error';
 import type { Server } from '../../sdam/server';

src/operations/search_indexes/update.ts

@@ -1,5 +1,4 @@
-import type { Document } from 'bson';
-
+import type { Document } from '../../bson';
 import type { Collection } from '../../collection';
 import type { Server } from '../../sdam/server';
 import type { ClientSession } from '../../sessions';