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.

Sign up for GitHub

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: properly (un)marshal custom time type #4

Closed
wants to merge 1 commit into from
Closed

fix: properly (un)marshal custom time type #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions client/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
package client

import "time"
import (
"fmt"
"strings"
"time"
)

// DateTime is a bridge between a swagger doc "date-time" and a Golang time.Time type
type DateTime = time.Time
type DateTime struct {
time.Time
}

func (dt *DateTime) UnmarshalJSON(b []byte) error {
s := strings.Trim(string(b), "\"")
if s == "null" {
dt.Time = time.Time{}
return nil
}
parsedTime, err := time.Parse(time.DateOnly, s)
Copy link
Member

Choose a reason for hiding this comment

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

Isn't using only time.DateOnly pretty rigid? Right now I believe we only use this for PR "days" but in the future, if we use other "date-time" formats, which should follow the very general internet date/time format, this will force any date-time to always just be "days"?

Copy link
Author

Choose a reason for hiding this comment

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

The parsing that I implemented doesn't account for time. I should have renamed the type to Date here.
If we go forward with the patching, I think it might be better to have 2 separate struct types - Date & DateTime.

if err != nil {
return err
}
dt.Time = parsedTime
return nil
}

func (dt *DateTime) MarshalJSON() ([]byte, error) {
if dt.Time.IsZero() {
return []byte("null"), nil
}
return []byte(fmt.Sprintf("\"%s\"", dt.Time.Format(time.DateOnly))), nil
}