fix(shell-api): include bson constructor static methods MONGOSH-880 (#998)

Author: addaleax

packages/shell-api/src/shell-bson.spec.ts

@@ -116,6 +116,11 @@ describe('Shell BSON', () => {
       expect(s._bsontype).to.equal('ObjectID');
       expect(s.toHexString().slice(0, 8)).to.equal('12345678');
     });
+    it('can be created through createFromTime', () => {
+      const s = (shellBson.ObjectId as any).createFromTime(0x12345678);
+      expect(s._bsontype).to.equal('ObjectID');
+      expect(s.toHexString().slice(0, 8)).to.equal('12345678');
+    });
     it('has help and other metadata', async() => {
       const s = shellBson.ObjectId();
       expect((await toShellResult(s.help)).type).to.equal('Help');
@@ -584,4 +589,29 @@ describe('Shell BSON', () => {
       expect(input).to.deep.equal(output);
     });
   });
+
+  describe('BSON constructor properties', () => {
+    it('matches original BSON constructor properties', () => {
+      for (const key of Object.keys(bson)) {
+        if (!(key in shellBson) || bson[key] === shellBson[key]) {
+          continue;
+        }
+
+        const bsonProperties = Object.getOwnPropertyDescriptors(bson[key]);
+        const shellProperties = Object.getOwnPropertyDescriptors(shellBson[key]);
+        delete shellProperties.help; // Not expected from the original BSON.
+        delete bsonProperties.get_inc; // Deprecated.
+        delete shellProperties.length; // Function length can vary depending on the specific arguments in TS.
+        delete bsonProperties.length;
+        delete shellProperties.index; // ObjectId.index is a random number
+        delete bsonProperties.index; // ObjectId.index is a random number
+        try {
+          expect(shellProperties).to.deep.equal(bsonProperties);
+        } catch (err) {
+          err.message += ` (${key})`;
+          throw err;
+        }
+      }
+    });
+  });
 });

packages/shell-api/src/shell-bson.ts

@@ -1,6 +1,6 @@
 import { ALL_PLATFORMS, ALL_SERVER_VERSIONS, ALL_TOPOLOGIES, ServerVersions } from './enums';
 import Help from './help';
-import { BinaryType, bson as BSON } from '@mongosh/service-provider-core';
+import { BinaryType, Document, bson as BSON } from '@mongosh/service-provider-core';
 import { CommonErrors, MongoshInternalError, MongoshInvalidInputError } from '@mongosh/errors';
 import { assertArgsDefinedType } from './helpers';
 import { randomBytes } from 'crypto';
@@ -51,34 +51,34 @@ export default function constructShellBson(bson: typeof BSON, printWarning: (msg
   (bson.BSONSymbol as any).prototype.deprecated = true;
 
   const bsonPkg = {
-    DBRef: Object.assign(function(namespace: string, oid: any, db?: string): typeof bson.DBRef.prototype {
-      assertArgsDefinedType([namespace, oid, db], ['string', true, [undefined, 'string']], 'DBRef');
-      return new bson.DBRef(namespace, oid, db);
-    }, { prototype: bson.DBRef.prototype }),
+    DBRef: Object.assign(function DBRef(namespace: string, oid: any, db?: string, fields?: Document): typeof bson.DBRef.prototype {
+      assertArgsDefinedType([namespace, oid, db], ['string', true, [undefined, 'string'], [undefined, 'object']], 'DBRef');
+      return new bson.DBRef(namespace, oid, db, fields);
+    }, { ...bson.DBRef, prototype: bson.DBRef.prototype }),
     // DBPointer not available in the bson 1.x library, but depreciated since 1.6
     Map: bson.Map,
-    bsonsize: function(object: any): number {
+    bsonsize: function bsonsize(object: any): number {
       assertArgsDefinedType([object], ['object'], 'bsonsize');
       return bson.calculateObjectSize(object);
     },
-    MaxKey: Object.assign(function(): typeof bson.MaxKey.prototype {
+    MaxKey: Object.assign(function MaxKey(): typeof bson.MaxKey.prototype {
       return new bson.MaxKey();
-    }, { prototype: bson.MaxKey.prototype }),
-    MinKey: Object.assign(function(): typeof bson.MinKey.prototype {
+    }, { ...bson.MaxKey, prototype: bson.MaxKey.prototype }),
+    MinKey: Object.assign(function MinKey(): typeof bson.MinKey.prototype {
       return new bson.MinKey();
-    }, { prototype: bson.MinKey.prototype }),
-    ObjectId: Object.assign(function(id?: string | number | typeof bson.ObjectId.prototype | Buffer): typeof bson.ObjectId.prototype {
+    }, { ...bson.MinKey, prototype: bson.MinKey.prototype }),
+    ObjectId: Object.assign(function ObjectId(id?: string | number | typeof bson.ObjectId.prototype | Buffer): typeof bson.ObjectId.prototype {
       assertArgsDefinedType([id], [[undefined, 'string', 'number', 'object']], 'ObjectId');
       return new bson.ObjectId(id);
-    }, { prototype: bson.ObjectId.prototype }),
-    Timestamp: Object.assign(function(low?: number | typeof bson.Long.prototype, high?: number): typeof bson.Timestamp.prototype {
+    }, { ...bson.ObjectId, prototype: bson.ObjectId.prototype }),
+    Timestamp: Object.assign(function Timestamp(low?: number | typeof bson.Long.prototype, high?: number): typeof bson.Timestamp.prototype {
       assertArgsDefinedType([low, high], [['number', 'object', undefined], [undefined, 'number']], 'Timestamp');
       return new bson.Timestamp(low as number, high as number);
-    }, { prototype: bson.Timestamp.prototype }),
-    Code: Object.assign(function(c: string | Function = '', s?: any): typeof bson.Code.prototype {
+    }, { ...bson.Timestamp, prototype: bson.Timestamp.prototype }),
+    Code: Object.assign(function Code(c: string | Function = '', s?: any): typeof bson.Code.prototype {
       assertArgsDefinedType([c, s], [[undefined, 'string', 'function'], [undefined, 'object']], 'Code');
       return new bson.Code(c, s);
-    }, { prototype: bson.Code.prototype }),
+    }, { ...bson.Code, prototype: bson.Code.prototype }),
     NumberDecimal: Object.assign(function(s = '0'): any {
       assertArgsDefinedType([s], [['string', 'number']], 'NumberDecimal');
       if (typeof s === 'string') {