feat(NODE-4847): Add config error handling to logging

[aditi-khare-mongoDB]

Description

Essentially, these changes ensure that the logger does not crash the user's application at runtime, at any point after options are parsed.

During options parsing, if the argument passed in is of incorrect type we want to throw for client options, but not for an incorrect environment option (set to default in this case).

What is changing?

To ensure we don't crash the user's application through the logger, unless there is an invalid type client option passed in to the MongoClient / ConnectionString.

Invalid argument types are checked through the transform function for an element of the OPTIONS array. The OPTIONS array is used in parseOptions (which is called by MongoClient and ConnectionString), so it resolves the argument types for both classes.

See all unit tests defined under config error handling in Kickoff Document,

Is there new documentation needed for these changes?

After NODE-5672 (Release Logger)

What is the motivation for this change?

This ticket is a subtask of NODE-4816 (Add Error Handling to the Logger).

Double check the following

• Ran npm run check: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
• New TODOs have a related JIRA ticket

[alenakhineika]

(housekeeping): double check the checkboxes in the pr description

[alenakhineika]

Could we be more specific in the PR title and description, and maybe AC to the ticket about what we expect from this PR? The current description is mostly about the parent ticket and also "Most of the mongodbLogPath stream error handling must be done at runtime, so is in a different subtask.". It is unclear what we are aiming to handle as part of this PR. Can we keep the link to the parent ticket in the What is the motivation for this change? section and put into Description and What is changing? more relevant to the current PR details? From the code, I see only changes made to ConnectionString options to validate those for incorrect values. Based on the kick-off doc, the same edge cases should be already handled by MongoClient.parseOptions() for MongoClientOptions. But I don't see the logic described in "Logging Error Handling Mini Design".

[aditi-khare-mongoDB]

Updated the PR description and Logging Mini Design!

[alenakhineika]

The failing test is reported in NODE-5852 and the flaky test in NODE-5789.