rename helper and add docs comments

Author: HanaPearlman

src/bson.ts

@@ -70,9 +70,12 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
   };
 }
 
-// Merge the given BSONSerializeOptions, preferring options over parentOptions, and substituting
-// defaults for values not set.
-export function inheritOrDefaultBSONSerializableOptions(
+/**
+ * Merge the given BSONSerializeOptions, preferring options over parentOptions, and substituting
+ * defaults for values not set.
+ * @internal
+ */
+export function inheritBSONOptions(
   options?: BSONSerializeOptions,
   parentOptions?: BSONSerializeOptions
 ): BSONSerializeOptions {

src/operations/bulk_write.ts

@@ -1,6 +1,6 @@
 import { applyRetryableWrites, applyWriteConcern, Callback } from '../utils';
 import { OperationBase } from './operation';
-import { inheritOrDefaultBSONSerializableOptions } from '../bson';
+import { inheritBSONOptions } from '../bson';
 import { WriteConcern } from '../write_concern';
 import type { Collection } from '../collection';
 import type {
@@ -27,13 +27,13 @@ export class BulkWriteOperation extends OperationBase<BulkWriteOptions, BulkWrit
     this.operations = operations;
 
     // Assign BSON serialize options to OperationBase, preferring options over collection options
-    Object.assign(this, inheritOrDefaultBSONSerializableOptions(options, collection.s));
+    Object.assign(this, inheritBSONOptions(options, collection.s));
   }
 
   execute(server: Server, callback: Callback<BulkWriteResult>): void {
     const coll = this.collection;
     const operations = this.operations;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     // Create the bulk operation
     const bulk: BulkOperationBase =

src/operations/command.ts

@@ -7,7 +7,7 @@ import { commandSupportsReadConcern } from '../sessions';
 import { MongoError } from '../error';
 import type { Logger } from '../logger';
 import type { Server } from '../sdam/server';
-import { BSONSerializeOptions, Document, inheritOrDefaultBSONSerializableOptions } from '../bson';
+import { BSONSerializeOptions, Document, inheritBSONOptions } from '../bson';
 import type { CollationOptions } from '../cmap/wire_protocol/write_command';
 import type { ReadConcernLike } from './../read_concern';
 
@@ -101,10 +101,9 @@ export abstract class CommandOperation<
     }
 
     // Assign BSON serialize options to OperationBase, preferring options over parent options.
-    // base accounts for the fact that Collection stores bson options in s, while other parents,
+    // Here, we account for the fact that Collection stores bson options in s, while other parents,
     // like Db, stores bson options in s.options
-    const base = Object.assign({}, parent?.s.options, parent?.s);
-    Object.assign(this, inheritOrDefaultBSONSerializableOptions(options, base));
+    Object.assign(this, inheritBSONOptions(options, { ...parent?.s.options, ...parent?.s }));
   }
 
   abstract execute(server: Server, callback: Callback<TResult>): void;

src/operations/delete.ts

@@ -65,7 +65,7 @@ export class DeleteOneOperation extends CommandOperation<DeleteOptions, DeleteRe
   execute(server: Server, callback: Callback<DeleteResult>): void {
     const coll = this.collection;
     const filter = this.filter;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     options.single = true;
     removeDocuments(server, coll, filter, options, (err, r) => {
@@ -99,7 +99,7 @@ export class DeleteManyOperation extends CommandOperation<DeleteOptions, DeleteR
   execute(server: Server, callback: Callback<DeleteResult>): void {
     const coll = this.collection;
     const filter = this.filter;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     // a user can pass `single: true` in to `deleteMany` to remove a single document, theoretically
     if (typeof options.single !== 'boolean') {

src/operations/find_and_modify.ts

@@ -71,7 +71,7 @@ export class FindAndModifyOperation extends CommandOperation<FindAndModifyOption
     const query = this.query;
     const sort = formattedOrderClause(this.sort);
     const doc = this.doc;
-    let options = Object.assign({}, this.options, this.bsonOptions);
+    let options = { ...this.options, ...this.bsonOptions };
 
     // Create findAndModify command object
     const cmd: Document = {

src/operations/find_one.ts

@@ -1,6 +1,6 @@
 import { OperationBase } from './operation';
 import type { Callback } from '../utils';
-import { Document, inheritOrDefaultBSONSerializableOptions } from '../bson';
+import { Document, inheritBSONOptions } from '../bson';
 import type { Collection } from '../collection';
 import type { FindOptions } from './find';
 import { MongoError } from '../error';
@@ -18,13 +18,13 @@ export class FindOneOperation extends OperationBase<FindOptions, Document> {
     this.query = query;
 
     // Assign BSON serialize options to OperationBase, preferring options over collection options
-    Object.assign(this, inheritOrDefaultBSONSerializableOptions(options, collection.s));
+    Object.assign(this, inheritBSONOptions(options, collection.s));
   }
 
   execute(server: Server, callback: Callback<Document>): void {
     const coll = this.collection;
     const query = this.query;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     try {
       const cursor = coll.find(query, options).limit(-1).batchSize(1);

src/operations/insert.ts

@@ -65,7 +65,7 @@ export class InsertOneOperation extends CommandOperation<InsertOneOptions, Inser
   execute(server: Server, callback: Callback<InsertOneResult>): void {
     const coll = this.collection;
     const doc = this.doc;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     if (Array.isArray(doc)) {
       return callback(

src/operations/insert_many.ts

@@ -4,7 +4,7 @@ import { MongoError } from '../error';
 import { prepareDocs } from './common_functions';
 import type { Callback } from '../utils';
 import type { Collection } from '../collection';
-import { ObjectId, Document, inheritOrDefaultBSONSerializableOptions } from '../bson';
+import { ObjectId, Document, inheritBSONOptions } from '../bson';
 import type { BulkWriteResult, BulkWriteOptions } from '../bulk/common';
 import type { Server } from '../sdam/server';
 
@@ -32,13 +32,13 @@ export class InsertManyOperation extends OperationBase<BulkWriteOptions, InsertM
     this.docs = docs;
 
     // Assign BSON serialize options to OperationBase, preferring options over collection options
-    Object.assign(this, inheritOrDefaultBSONSerializableOptions(options, collection.s));
+    Object.assign(this, inheritBSONOptions(options, collection.s));
   }
 
   execute(server: Server, callback: Callback<InsertManyResult>): void {
     const coll = this.collection;
     let docs = this.docs;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     if (!Array.isArray(docs)) {
       return callback(

src/operations/replace_one.ts

@@ -50,7 +50,7 @@ export class ReplaceOneOperation extends CommandOperation<ReplaceOptions, Update
     const coll = this.collection;
     const filter = this.filter;
     const replacement = this.replacement;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     // Set single document update
     options.multi = false;

src/operations/update.ts

@@ -86,7 +86,7 @@ export class UpdateOneOperation extends CommandOperation<UpdateOptions, UpdateRe
     const coll = this.collection;
     const filter = this.filter;
     const update = this.update;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     // Set single document update
     options.multi = false;
@@ -128,7 +128,7 @@ export class UpdateManyOperation extends CommandOperation<UpdateOptions, UpdateR
     const coll = this.collection;
     const filter = this.filter;
     const update = this.update;
-    const options = Object.assign({}, this.options, this.bsonOptions);
+    const options = { ...this.options, ...this.bsonOptions };
 
     // Set single document update
     options.multi = true;

test/functional/insert.test.js

@@ -1903,8 +1903,6 @@ describe('Insert', function () {
   });
 
   it('shouldCorrectlyInheritPromoteLongFalseNativeBSONWithGetMore', {
-    // Add a tag that our runner can trigger on
-    // in this case we are setting that node needs to be higher than 0.10.X to run
     metadata: {
       requires: { topology: ['single', 'replicaset', 'sharded', 'ssl', 'heap', 'wiredtiger'] }
     },