feat(NODE-7328): Add ignoreUndefined option to EJSON APIs

[ShtibsDev]

• Introduced ignoreUndefined option to EJSON.stringify to omit undefined values from the output.
• Updated tests to cover various scenarios for the new option, including nested objects and arrays.
• Ensured compatibility with existing options like relaxed and replacer functions.

Description

Introduced ignoreUndefined option to EJSON.stringify to omit undefined values from the output.

Summary of Changes

• Introduced ignoreUndefined option to EJSON.stringify to omit undefined values from the output.
• Updated tests to cover various scenarios for the new option, including nested objects and arrays.

Notes for Reviewers

Currently, the EJSON.stringify can't emulate mongo's behavior in case ignoreUndefined is set in the MongoClient constructor.

By adding this option, the EJSON.stringify becomes more flexible and allows this behavior.

What is the motivation for this change?

Codebases using MongoClient's ignoreUndefined currently have no way to stringify objects with the same behaviour without manually removing undefined properties via a recursive function.

This new option will allow stringifying object while both keeping the EJSON behavior and the undefined omitting behaviour.

Release Highlight

EJSON now supports ignoreUndefined

serialize supports an option, ignoreUndefined, which instructs the serializer to skip any keys whose values are undefined.

This option has been added to EJSON:

> EJSON.stringify({ a: undefined }, { ignoreUndefined: true });
'{}'
> EJSON.stringify({ a: undefined }, { ignoreUndefined: false });
'{"a":null}'
> EJSON.serialize({ a: undefined }, { ignoreUndefined: true });
{}
> EJSON.serialize({ a: undefined }, { ignoreUndefined: false });
{ a: null }

This option defaults to false.

Double check the following

• Lint is passing (npm run check:lint)
• 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

[baileympearson]

Hi @ShtibsDev - thanks for this contribution! We agree that this makes sense.

I left a few small comments.