feat(NODE-4890)!: make all thrown errors into BSONErrors

[nbbeeken]

Description

What is changing?

Unlike the driver our BSON error classes diverged making filtering for BSONTypeError vs BSONError misaligned with our error expectations. We now have one error class, which we can make future subclasses of, and it offers a method isBSONError that will return true for the current class or any future subclass regardless of cross environment instantiation.

What is the motivation for this change?

A BSONError can be thrown from deep within a library that relies on BSON, having one error super class for the library helps with programmatic filtering of an error's origin.

Hypothetical example: A collection in our Db has an issue with UTF-8 data

let documentCount = 0;
const cursor = collection.find({}, { utf8Validation: true });
try {
  for await (const doc of cursor) documentCount += 1;
} catch (error) {
  if (BSONError.isBSONError(error)) {
    console.log(`Found the troublemaker UTF-8!: ${documentCount} ${error.message}`);
    return documentCount;
  }
  throw error;
}

Double check the following

• Ran npm run lint script
• Self-review completed using the steps outlined here
• PR title follows the correct format: type(NODE-xxxx)[!]: description
  • Example: feat(NODE-1234)!: rewriting everything in coffeescript
• Changes are covered by tests
• TODO Update migration guide