-
Notifications
You must be signed in to change notification settings - Fork 260
feat(NODE-7328): Add ignoreUndefined option to EJSON serialization #853
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ShtibsDev
wants to merge
1
commit into
mongodb:main
Choose a base branch
from
ShtibsDev:feature/ignore-undefined-stringify
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+70
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -574,6 +574,70 @@ describe('Extended JSON', function () { | |
| expect(result).to.deep.equal({ a: 1 }); | ||
| }); | ||
|
|
||
| describe('ignoreUndefined option', () => { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The changes you've made implicitly add support for |
||
| it('should convert undefined to null by default', () => { | ||
| const doc = { a: 1, b: undefined, c: 'test' }; | ||
| const serialized = EJSON.stringify(doc); | ||
| expect(serialized).to.equal('{"a":1,"b":null,"c":"test"}'); | ||
| }); | ||
|
|
||
| it('should omit undefined values when ignoreUndefined is true', () => { | ||
| const doc = { a: 1, b: undefined, c: 'test' }; | ||
| const serialized = EJSON.stringify(doc, { ignoreUndefined: true }); | ||
| expect(serialized).to.equal('{"a":1,"c":"test"}'); | ||
| }); | ||
|
|
||
| it('should handle nested undefined values with ignoreUndefined: true', () => { | ||
| const doc = { a: 1, nested: { b: undefined, c: 2 }, d: 'test' }; | ||
| const serialized = EJSON.stringify(doc, { ignoreUndefined: true }); | ||
| expect(serialized).to.equal('{"a":1,"nested":{"c":2},"d":"test"}'); | ||
| }); | ||
|
|
||
| it('should handle nested undefined values without ignoreUndefined (default behavior)', () => { | ||
| const doc = { a: 1, nested: { b: undefined, c: 2 }, d: 'test' }; | ||
| const serialized = EJSON.stringify(doc); | ||
| expect(serialized).to.equal('{"a":1,"nested":{"b":null,"c":2},"d":"test"}'); | ||
| }); | ||
|
|
||
| it('should handle undefined in arrays with ignoreUndefined: true', () => { | ||
| const doc = { arr: [1, undefined, 3] }; | ||
| const serialized = EJSON.stringify(doc, { ignoreUndefined: true }); | ||
| // JSON.stringify converts undefined array elements to null | ||
| expect(serialized).to.equal('{"arr":[1,null,3]}'); | ||
| }); | ||
|
|
||
| it('should handle undefined in arrays without ignoreUndefined (default behavior)', () => { | ||
| const doc = { arr: [1, undefined, 3] }; | ||
| const serialized = EJSON.stringify(doc); | ||
| expect(serialized).to.equal('{"arr":[1,null,3]}'); | ||
| }); | ||
|
|
||
| it('should handle object with all undefined values with ignoreUndefined: true', () => { | ||
| const doc = { a: undefined, b: undefined }; | ||
| const serialized = EJSON.stringify(doc, { ignoreUndefined: true }); | ||
| expect(serialized).to.equal('{}'); | ||
| }); | ||
|
|
||
| it('should work with other options like relaxed', () => { | ||
| const doc = { a: new Int32(10), b: undefined, c: new Double(3.14) }; | ||
| const serialized = EJSON.stringify(doc, { ignoreUndefined: true, relaxed: false }); | ||
| expect(serialized).to.equal('{"a":{"$numberInt":"10"},"c":{"$numberDouble":"3.14"}}'); | ||
| }); | ||
|
|
||
| it('should work with replacer function', () => { | ||
| const doc = { a: 1, b: undefined, c: 2 }; | ||
| const replacer = (key: string, value: unknown) => (key === 'a' ? 100 : value); | ||
| const serialized = EJSON.stringify(doc, replacer, 0, { ignoreUndefined: true }); | ||
| expect(serialized).to.equal('{"a":100,"c":2}'); | ||
| }); | ||
|
|
||
| it('should work with space parameter', () => { | ||
| const doc = { a: 1, b: undefined }; | ||
| const serialized = EJSON.stringify(doc, undefined, 2, { ignoreUndefined: true }); | ||
| expect(serialized).to.equal('{\n "a": 1\n}'); | ||
| }); | ||
| }); | ||
|
|
||
| it(`throws if Symbol.for('@@mdb.bson.version') is the wrong version in EJSON.stringify`, () => { | ||
| expect(() => | ||
| EJSON.stringify({ | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This option is only relevant to serialization, but EJSONOptions are shared for both serialization and deserialization.
What would you think about creating a separate interface for serialization?