Skip to content
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

Add encoding option to specify how omitempty fields are encoded #453

Merged
merged 2 commits into from
Jan 7, 2024

Conversation

dinhxuanvu
Copy link
Contributor

@dinhxuanvu dinhxuanvu commented Dec 19, 2023

Description

The current behavior in the library is to omits if field value would encode as empty JSON value. This behavior is different from the bahavior in golang encoding/json which omits if field value is an empty Go value (defined as false, 0, a nil pointer, a nil interface value, and any empty array, slice, map, or string). The OmitEmptyMode = 1 is added to encoding option so that cbor would decode omitempty fields similarly to encoding/json in go.

PR Was Proposed and Welcomed in Currently Open Issue

Checklist (for code PR only, ignore for docs PR)

  • Include unit tests that cover the new code
  • Pass all unit tests
  • Pass all 18 ci linters (golint, gosec, staticcheck, etc.)
  • Sign each commit with your real name and email.
    Last line of each commit message should be in this format:
    Signed-off-by: Firstname Lastname [email protected]
  • Certify the Developer's Certificate of Origin 1.1
    (see next section).

Certify the Developer's Certificate of Origin 1.1

  • By marking this item as completed, I certify
    the Developer Certificate of Origin 1.1.
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

The current behavior in the library is to omits if field value
would encode as empty JSON value. This behavior is different from
the bahavior in golang encoding/json which omits if field value
is an empty Go value (defined as false, 0, a nil pointer, a nil
interface value, and any empty array, slice, map, or string).
The OmitEmptyMode = 1 is added to encoding option so that cbor
would decode omitempty fields similarly to encoding/json in go.

Signed-off-by: Vu Dinh <[email protected]>
@fxamacker fxamacker added the enhancement New feature or request label Dec 20, 2023
@fxamacker fxamacker added this to the v2.6.0 milestone Dec 20, 2023
Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dinhxuanvu Thanks for opening this PR! 👍

I left some feedback for your consideration and will try to include this PR in v2.6.0 if possible.

Thanks again!

encode.go Outdated Show resolved Hide resolved
encode.go Show resolved Hide resolved
encode_test.go Outdated Show resolved Hide resolved
encode_test.go Outdated Show resolved Hide resolved
encode_test.go Outdated Show resolved Hide resolved
encode.go Outdated Show resolved Hide resolved
@dinhxuanvu
Copy link
Contributor Author

@fxamacker Thanks so much for the feedbacks. All are addressed! PTAL

Signed-off-by: Vu Dinh <[email protected]>
@dinhxuanvu
Copy link
Contributor Author

Force-pushed to fix a small fix with lint (variable name).

@fxamacker
Copy link
Owner

@dinhxuanvu Thanks for opening issue and contributing this PR! 👍

I'd like to include this in v2.6 and will take a closer look this weekend!

Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dinhxuanvu Thanks for updating the PR! LGTM! 👍

@fxamacker fxamacker merged commit 0cf56c3 into fxamacker:master Jan 7, 2024
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants