Add tests from v6.7.0 covering find cursor utf8 validation behavior

Author: baileympearson

test/integration/node-specific/bson-options/utf8_validation.test.ts

@@ -3,8 +3,11 @@ import * as sinon from 'sinon';
 
 import {
   BSON,
+  BSONError,
+  Collection,
   type MongoClient,
   MongoDBResponse,
+  MongoError,
   MongoServerError,
   OpMsgResponse
 } from '../../../mongodb';
@@ -153,3 +156,156 @@ describe('class MongoDBResponse', () => {
     }
   );
 });
+
+describe('utf8 validation with cursors', function () {
+  let client: MongoClient;
+  let collection: Collection;
+
+  beforeEach(async function () {
+    client = this.configuration.newClient();
+    await client.connect();
+    const db = client.db("test");
+    collection = db.collection("invalidutf8");
+  });
+
+  afterEach(async function () {
+    await client.close();
+  });
+
+  context('when utf-8 validation is explicitly disabled', function () {
+    it('documents can be read using a for-await loop without errors', async function () {
+      for await (const doc of collection.find({}, { enableUtf8Validation: false }));
+    });
+    it('documents can be read using next() without errors', async function () {
+      const cursor = collection.find({}, { enableUtf8Validation: false });
+
+      while (await cursor.hasNext()) {
+        await cursor.next();
+      }
+    });
+
+    it('documents can be read using toArray() without errors', async function () {
+      const cursor = collection.find({}, { enableUtf8Validation: false });
+      await cursor.toArray();
+    });
+
+    it('documents can be read using .stream() without errors', async function () {
+      const cursor = collection.find({}, { enableUtf8Validation: false });
+      await cursor.stream().toArray();
+    });
+
+    it('documents can be read with tryNext() without error', async function () {
+      const cursor = collection.find({}, { enableUtf8Validation: false });
+
+      while (await cursor.hasNext()) {
+        await cursor.tryNext();
+      }
+    })
+  })
+
+  async function expectReject(fn: () => Promise<void>, options?: { regex?: RegExp, errorClass }) {
+    const regex = options?.regex ?? /.*/;
+    const errorClass = options?.errorClass ?? MongoError;
+    try {
+      await fn();
+      expect.fail('expected the provided callback function to reject, but it did not.');
+    } catch (error) {
+      expect(error).to.match(regex);
+      expect(error).to.be.instanceOf(errorClass);
+    }
+  }
+
+  context('when utf-8 validation is explicitly enabled', function () {
+    it('a for-await loop throw a BSON error', async function () {
+      await expectReject(async () => {
+        for await (const doc of collection.find({}, { enableUtf8Validation: true }));
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ })
+    });
+    it('next() throws a BSON error', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({}, { enableUtf8Validation: true });
+
+        while (await cursor.hasNext()) {
+          await cursor.next();
+        }
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+    });
+
+    it('toArray() throws a BSON error', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({}, { enableUtf8Validation: true });
+        await cursor.toArray();
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+
+    });
+
+    it('.stream() throws a BSONError', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({}, { enableUtf8Validation: true });
+        await cursor.stream().toArray();
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+    });
+
+    it('tryNext() throws a BSONError', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({}, { enableUtf8Validation: true });
+
+        while (await cursor.hasNext()) {
+          await cursor.tryNext();
+        }
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+
+    })
+  })
+
+  context('utf-8 validation defaults to enabled', function () {
+    it('a for-await loop throw a BSON error', async function () {
+      await expectReject(async () => {
+        for await (const doc of collection.find({}));
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ })
+    });
+    it('next() throws a BSON error', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({});
+
+        while (await cursor.hasNext()) {
+          await cursor.next();
+        }
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+    });
+
+    it('toArray() throws a BSON error', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({});
+        await cursor.toArray();
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+
+    });
+
+    it('.stream() throws a BSONError', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({});
+        await cursor.stream().toArray();
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+    });
+
+    it('tryNext() throws a BSONError', async function () {
+      await expectReject(async () => {
+        const cursor = collection.find({});
+
+        while (await cursor.hasNext()) {
+          await cursor.tryNext();
+        }
+      }, { errorClass: BSONError, regex: /Invalid UTF-8 string in BSON document/ }
+      );
+
+    })
+  })
+})