test: limit it statements to one assertion and use contexts for organization

Author: Grace Chong

src/cmap/commands.ts

@@ -839,7 +839,9 @@ export class BinMsg {
     const promoteBuffers = options.promoteBuffers ?? this.opts.promoteBuffers;
     const bsonRegExp = options.bsonRegExp ?? this.opts.bsonRegExp;
     if (options.validation && Object.keys(options.validation.utf8)[0] !== 'writeErrors') {
-      throw new Error('Can only toggle validation settings for writeErrors key');
+      throw new MongoInvalidArgumentError(
+        'Can only toggle validation settings for writeErrors key'
+      );
     }
     const validation = options.validation ?? { utf8: { writeErrors: false } };
 

test/unit/commands.test.ts

@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { BinMsg, MessageHeader } from '../../src/cmap/commands';
+import { BinMsg, MessageHeader, OpResponseOptions } from '../../src/cmap/commands';
 import { BSONError } from 'bson';
 import * as BSON from '../../src/bson';
 
@@ -11,16 +11,10 @@ const msgHeader: MessageHeader = {
 };
 
 // when top-level key writeErrors contains an error message that has invalid utf8
-const msgBodyInvalidUtf8WriteErrors = Buffer.from(
-  '0000000000ca020000106e00000000000477726974654572726f727300a50200000330009d02000010696e646578000000000010636f646500f82a0000036b65795061747465726e000f0000001074657874000100000000036b657956616c756500610100000274657874005201000064e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e298830000026572726d736700f1000000453131303030206475706c6963617465206b6579206572726f7220636f6c6c656374696f6e3a20626967646174612e7465737420696e6465783a20746578745f3120647570206b65793a207b20746578743a202264e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e2982e2e2e22207d000000016f6b00000000000000f03f00',
-  'hex'
-);
-
-const badutf8inputtodeserialize = Buffer.from(
-  'ca020000106e00000000000477726974654572726f727300a50200000330009d02000010696e646578000000000010636f646500f82a0000036b65795061747465726e000f0000001074657874000100000000036b657956616c756500610100000274657874005201000064e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e298830000026572726d736700f1000000453131303030206475706c6963617465206b6579206572726f7220636f6c6c656374696f6e3a20626967646174612e7465737420696e6465783a20746578745f3120647570206b65793a207b20746578743a202264e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e2982e2e2e22207d000000016f6b00000000000000f03f00',
-  'hex'
-);
-
+const invalidUtf8ErrorMsg =
+  '0000000000ca020000106e00000000000477726974654572726f727300a50200000330009d02000010696e646578000000000010636f646500f82a0000036b65795061747465726e000f0000001074657874000100000000036b657956616c756500610100000274657874005201000064e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e298830000026572726d736700f1000000453131303030206475706c6963617465206b6579206572726f7220636f6c6c656374696f6e3a20626967646174612e7465737420696e6465783a20746578745f3120647570206b65793a207b20746578743a202264e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e2982e2e2e22207d000000016f6b00000000000000f03f00';
+const msgBodyInvalidUtf8WriteErrors = Buffer.from(invalidUtf8ErrorMsg, 'hex');
+const invalidUtf8ErrorMsgDeserializeInput = Buffer.from(invalidUtf8ErrorMsg.substring(10), 'hex');
 const invalidUtf8InWriteErrorsJSON = {
   n: 0,
   writeErrors: [
@@ -41,17 +35,11 @@ const invalidUtf8InWriteErrorsJSON = {
 };
 
 // when another top-level key besides writeErrors has invalid utf8
-const nKeyWithInvalidUtf8 = Buffer.from(
-  'cc020000026e0005000000f09f98ff000477726974654572726f727300a60200000330009e02000010696e646578000000000010636f646500f82a0000036b65795061747465726e000f0000001074657874000100000000036b657956616c756500610100000274657874005201000064e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e298830000026572726d736700f2000000453131303030206475706c6963617465206b6579206572726f7220636f6c6c656374696f6e3a20626967646174612e7465737420696e6465783a20746578745f3120647570206b65793a207b20746578743a202264e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883efbfbd2e2e2e22207d000000106f6b000100000000',
-  'hex'
-);
-
-const msgBodyNKeyWithInvalidUtf8 = Buffer.from(
-  '0000000000cc020000026e0005000000f09f98ff000477726974654572726f727300a60200000330009e02000010696e646578000000000010636f646500f82a0000036b65795061747465726e000f0000001074657874000100000000036b657956616c756500610100000274657874005201000064e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e298830000026572726d736700f2000000453131303030206475706c6963617465206b6579206572726f7220636f6c6c656374696f6e3a20626967646174612e7465737420696e6465783a20746578745f3120647570206b65793a207b20746578743a202264e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883efbfbd2e2e2e22207d000000106f6b000100000000',
-  'hex'
-);
-
-const invalidUtf8InOtherKeyJSON = {
+const nKeyWithInvalidUtf8 =
+  '0000000000cc020000026e0005000000f09f98ff000477726974654572726f727300a60200000330009e02000010696e646578000000000010636f646500f82a0000036b65795061747465726e000f0000001074657874000100000000036b657956616c756500610100000274657874005201000064e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e298830000026572726d736700f2000000453131303030206475706c6963617465206b6579206572726f7220636f6c6c656374696f6e3a20626967646174612e7465737420696e6465783a20746578745f3120647570206b65793a207b20746578743a202264e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883e29883efbfbd2e2e2e22207d000000106f6b000100000000';
+const nKeyWithInvalidUtf8DeserializeInput = Buffer.from(nKeyWithInvalidUtf8.substring(10), 'hex');
+const msgBodyNKeyWithInvalidUtf8 = Buffer.from(nKeyWithInvalidUtf8, 'hex');
+const invalidUtf8InNKeyJSON = {
   n: '��',
   writeErrors: [
     {
@@ -71,30 +59,35 @@ const invalidUtf8InOtherKeyJSON = {
 };
 
 describe('BinMsg', function () {
-  it('should throw error if trying to toggle validation settings for keys other than writeErrors', function () {
+  context('when validation is disabled for writeErrors', function () {
     const binMsgInvalidUtf8ErrorMsg = new BinMsg(
       Buffer.alloc(0),
       msgHeader,
       msgBodyInvalidUtf8WriteErrors
     );
-    expect(() => binMsgInvalidUtf8ErrorMsg.parse({ validation: { utf8: { n: false } } })).to.throw(
-      Error,
-      'Can only toggle validation settings for writeErrors key'
-    );
+    const options: OpResponseOptions = { validation: { utf8: { writeErrors: false } } };
+
+    it('contains replacement characters for invalid utf8 in writeError object', function () {
+      expect(BSON.deserialize(invalidUtf8ErrorMsgDeserializeInput, options)).to.deep.equals(
+        invalidUtf8InWriteErrorsJSON
+      );
+    });
+
+    it('should not throw invalid utf8 error', function () {
+      expect(() => binMsgInvalidUtf8ErrorMsg.parse(options)).to.not.throw();
+    });
   });
 
-  it('should not throw invalid utf8 error when validation disabled for writeErrors', function () {
+  it('should throw error if trying to toggle validation settings for keys other than writeErrors', function () {
     const binMsgInvalidUtf8ErrorMsg = new BinMsg(
       Buffer.alloc(0),
       msgHeader,
       msgBodyInvalidUtf8WriteErrors
     );
-    expect(() =>
-      binMsgInvalidUtf8ErrorMsg.parse({ validation: { utf8: { writeErrors: false } } })
-    ).to.not.throw();
-    expect(
-      BSON.deserialize(badutf8inputtodeserialize, { validation: { utf8: { writeErrors: false } } })
-    ).to.deep.equals(invalidUtf8InWriteErrorsJSON);
+    expect(() => binMsgInvalidUtf8ErrorMsg.parse({ validation: { utf8: { n: false } } })).to.throw(
+      Error,
+      'Can only toggle validation settings for writeErrors key'
+    );
   });
 
   it('should by default disable validation for writeErrors if no validation specified', function () {
@@ -112,6 +105,28 @@ describe('BinMsg', function () {
     expect(() => binMsgInvalidUtf8ErrorMsg.parse(options)).to.not.throw();
   });
 
+  context(
+    'when another key has invalid utf8 and validation is enabled for writeErrors',
+    function () {
+      const binMsgAnotherKeyWithInvalidUtf8 = new BinMsg(
+        Buffer.alloc(0),
+        msgHeader,
+        msgBodyNKeyWithInvalidUtf8
+      );
+      const option: OpResponseOptions = { validation: { utf8: { writeErrors: true } } };
+
+      it('should not throw invalid utf8 error', function () {
+        expect(() => binMsgAnotherKeyWithInvalidUtf8.parse(option)).to.not.throw();
+      });
+
+      it('contains replacement characters for invalid utf8 key', function () {
+        expect(BSON.deserialize(nKeyWithInvalidUtf8DeserializeInput, option)).to.deep.equals(
+          invalidUtf8InNKeyJSON
+        );
+      });
+    }
+  );
+
   it('should throw invalid utf8 error when validation enabled for writeErrors', function () {
     const binMsgInvalidUtf8ErrorMsg = new BinMsg(
       Buffer.alloc(0),
@@ -123,22 +138,6 @@ describe('BinMsg', function () {
     ).to.throw(BSONError, 'Invalid UTF-8 string in BSON document');
   });
 
-  it('should not throw when another key has invalid utf8 and writeErrors is validated', function () {
-    const binMsgAnotherKeyWithInvalidUtf8 = new BinMsg(
-      Buffer.alloc(0),
-      msgHeader,
-      msgBodyNKeyWithInvalidUtf8
-    );
-    expect(() =>
-      binMsgAnotherKeyWithInvalidUtf8.parse({ validation: { utf8: { writeErrors: true } } })
-    ).to.not.throw();
-    expect(
-      BSON.deserialize(nKeyWithInvalidUtf8, {
-        validation: { utf8: { writeErrors: true } }
-      })
-    ).to.deep.equals(invalidUtf8InOtherKeyJSON);
-  });
-
   it('should throw error when another key has invalid utf8 and writeErrors is not validated', function () {
     const binMsgAnotherKeyWithInvalidUtf8 = new BinMsg(
       Buffer.alloc(0),