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

Fix invalid RFC 3339 in TimeTagToAny (unreleased new feature) #540

Merged
merged 1 commit into from
May 26, 2024

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented May 23, 2024

Description

TimeTagToAny is an unreleased new option that was added by PR 496:

Unfortunately, TimeTagToAny can produce strings that are not valid RFC 3339 timestamps through its use of (time.Time).Format, whose signature does not allow it to return errors.

PR Was Proposed and Welcomed in Currently Open Issue

  • This PR was proposed and welcomed by maintainer(s) in issue #___
  • Closes or Updates Issue #___

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

  • Include unit tests that cover the new code
  • Pass all unit tests
  • Pass all lint checks in CI (goimports, 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.

TimeTagToAny can produce strings that are not valid RFC 3339 timestamps through its use
of (time.Time).Format, whose signature does not allow it to return errors.

Signed-off-by: Ben Luddy <[email protected]>
@benluddy benluddy marked this pull request as ready for review May 23, 2024 17:08
@benluddy
Copy link
Contributor Author

I discovered this case while exercising the new options from #496. I think we want to avoid producing invalid RFC 3339 here as the stdlib Time's MarshalText and MarshalJSON implementations now do.

@fxamacker fxamacker changed the title Don't produce invalid RFC 3339 using TimeTagToAny. Fix invalid RFC 3339 in TimeTagToAny (unreleased new feature) May 26, 2024
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.

LGTM! 👍 Thanks for catching this bug in the new feature before v2.7.0 is released!

@fxamacker fxamacker merged commit 842ac3e into fxamacker:master May 26, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants