From e352784feda2ceb5f09b6e25d9eecfe4404f5233 Mon Sep 17 00:00:00 2001 From: Phil Constantinou Date: Thu, 2 Jan 2025 12:50:29 -0800 Subject: [PATCH 1/6] Add Z only if needed. --- pgtype/timestamp.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pgtype/timestamp.go b/pgtype/timestamp.go index ff2739d6..0676bfe2 100644 --- a/pgtype/timestamp.go +++ b/pgtype/timestamp.go @@ -104,8 +104,13 @@ func (ts *Timestamp) UnmarshalJSON(b []byte) error { case "-infinity": *ts = Timestamp{Valid: true, InfinityModifier: -Infinity} default: + tss := *s // PostgreSQL uses ISO 8601 wihout timezone for to_json function and casting from a string to timestampt - tim, err := time.Parse(time.RFC3339Nano, *s+"Z") + if !strings.HasSuffix(tss, "Z") { + tss = tss + "Z" + } + + tim, err := time.Parse(time.RFC3339Nano, tss) if err != nil { return err } From 52e28586299a0f2091bdf903db062278b7e8ecf9 Mon Sep 17 00:00:00 2001 From: Phil Constantinou Date: Thu, 2 Jan 2025 13:36:33 -0800 Subject: [PATCH 2/6] Added unit test and fixed typo --- pgtype/timestamp.go | 2 +- pgtype/timestamp_test.go | 20 +++++++++++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/pgtype/timestamp.go b/pgtype/timestamp.go index 0676bfe2..f19344be 100644 --- a/pgtype/timestamp.go +++ b/pgtype/timestamp.go @@ -105,7 +105,7 @@ func (ts *Timestamp) UnmarshalJSON(b []byte) error { *ts = Timestamp{Valid: true, InfinityModifier: -Infinity} default: tss := *s - // PostgreSQL uses ISO 8601 wihout timezone for to_json function and casting from a string to timestampt + // PostgreSQL uses ISO 8601 without timezone for to_json function and casting from a string to timestampt if !strings.HasSuffix(tss, "Z") { tss = tss + "Z" } diff --git a/pgtype/timestamp_test.go b/pgtype/timestamp_test.go index 345da819..89b68d5e 100644 --- a/pgtype/timestamp_test.go +++ b/pgtype/timestamp_test.go @@ -2,12 +2,14 @@ package pgtype_test import ( "context" + "encoding/json" "testing" "time" pgx "github.com/jackc/pgx/v5" "github.com/jackc/pgx/v5/pgtype" "github.com/jackc/pgx/v5/pgxtest" + "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) @@ -100,12 +102,22 @@ func TestTimestampCodecDecodeTextInvalid(t *testing.T) { } func TestTimestampMarshalJSON(t *testing.T) { + + tsStruct := struct { + TS pgtype.Timestamp `json:"ts"` + }{} + + tm := time.Date(2012, 3, 29, 10, 5, 45, 0, time.UTC) + var pgt pgtype.Timestamp + _ = pgt.Scan(tm) + successfulTests := []struct { source pgtype.Timestamp result string }{ {source: pgtype.Timestamp{}, result: "null"}, - {source: pgtype.Timestamp{Time: time.Date(2012, 3, 29, 10, 5, 45, 0, time.UTC), Valid: true}, result: "\"2012-03-29T10:05:45Z\""}, + {source: pgtype.Timestamp{Time: tm, Valid: true}, result: "\"2012-03-29T10:05:45Z\""}, + {source: pgt, result: "\"2012-03-29T10:05:45Z\""}, {source: pgtype.Timestamp{Time: time.Date(2012, 3, 29, 10, 5, 45, 555*1000*1000, time.UTC), Valid: true}, result: "\"2012-03-29T10:05:45.555Z\""}, {source: pgtype.Timestamp{InfinityModifier: pgtype.Infinity, Valid: true}, result: "\"infinity\""}, {source: pgtype.Timestamp{InfinityModifier: pgtype.NegativeInfinity, Valid: true}, result: "\"-infinity\""}, @@ -119,6 +131,12 @@ func TestTimestampMarshalJSON(t *testing.T) { if string(r) != tt.result { t.Errorf("%d: expected %v to convert to %v, but it was %v", i, tt.source, tt.result, string(r)) } + tsStruct.TS = tt.source + b, err := json.Marshal(tsStruct) + assert.NoErrorf(t, err, "failed to marshal %v %s", tt.source, err) + t2 := tsStruct + err = json.Unmarshal(b, &t2) + assert.NoErrorf(t, err, "failed to unmarshal %v with %s", tt.source, err) } } From cdc672cf3fbc877d874e67a5ab733e4c51a610e8 Mon Sep 17 00:00:00 2001 From: Phil Constantinou Date: Sun, 5 Jan 2025 13:05:51 -0800 Subject: [PATCH 3/6] Make JSON output confirm to ISO8601 timestamp without a timezone --- pgtype/timestamp.go | 16 ++++++++-------- pgtype/timestamp_test.go | 7 ++++--- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/pgtype/timestamp.go b/pgtype/timestamp.go index f19344be..e6e2cc65 100644 --- a/pgtype/timestamp.go +++ b/pgtype/timestamp.go @@ -12,6 +12,7 @@ import ( ) const pgTimestampFormat = "2006-01-02 15:04:05.999999999" +const jsonISO8601 = "2006-01-02T15:04:05.999999999" type TimestampScanner interface { ScanTimestamp(v Timestamp) error @@ -76,7 +77,7 @@ func (ts Timestamp) MarshalJSON() ([]byte, error) { switch ts.InfinityModifier { case Finite: - s = ts.Time.Format(time.RFC3339Nano) + s = ts.Time.Format(jsonISO8601) case Infinity: s = "infinity" case NegativeInfinity: @@ -106,16 +107,15 @@ func (ts *Timestamp) UnmarshalJSON(b []byte) error { default: tss := *s // PostgreSQL uses ISO 8601 without timezone for to_json function and casting from a string to timestampt - if !strings.HasSuffix(tss, "Z") { - tss = tss + "Z" - } tim, err := time.Parse(time.RFC3339Nano, tss) - if err != nil { - return err + if err == nil { + *ts = Timestamp{Time: tim, Valid: true} + } + tim, err = time.Parse(jsonISO8601, tss) + if err == nil { + *ts = Timestamp{Time: tim, Valid: true} } - - *ts = Timestamp{Time: tim, Valid: true} } return nil diff --git a/pgtype/timestamp_test.go b/pgtype/timestamp_test.go index 89b68d5e..bfcdf023 100644 --- a/pgtype/timestamp_test.go +++ b/pgtype/timestamp_test.go @@ -116,9 +116,9 @@ func TestTimestampMarshalJSON(t *testing.T) { result string }{ {source: pgtype.Timestamp{}, result: "null"}, - {source: pgtype.Timestamp{Time: tm, Valid: true}, result: "\"2012-03-29T10:05:45Z\""}, - {source: pgt, result: "\"2012-03-29T10:05:45Z\""}, - {source: pgtype.Timestamp{Time: time.Date(2012, 3, 29, 10, 5, 45, 555*1000*1000, time.UTC), Valid: true}, result: "\"2012-03-29T10:05:45.555Z\""}, + {source: pgtype.Timestamp{Time: tm, Valid: true}, result: `"2012-03-29T10:05:45"`}, + {source: pgt, result: `"2012-03-29T10:05:45"`}, + {source: pgtype.Timestamp{Time: time.Date(2012, 3, 29, 10, 5, 45, 555*1000*1000, time.UTC), Valid: true}, result: `"2012-03-29T10:05:45.555"`}, {source: pgtype.Timestamp{InfinityModifier: pgtype.Infinity, Valid: true}, result: "\"infinity\""}, {source: pgtype.Timestamp{InfinityModifier: pgtype.NegativeInfinity, Valid: true}, result: "\"-infinity\""}, } @@ -137,6 +137,7 @@ func TestTimestampMarshalJSON(t *testing.T) { t2 := tsStruct err = json.Unmarshal(b, &t2) assert.NoErrorf(t, err, "failed to unmarshal %v with %s", tt.source, err) + assert.True(t, tsStruct.TS.Time.Unix() == t2.TS.Time.Unix()) } } From 42d3d00734b2c3aba2d960f8d3c344b494350812 Mon Sep 17 00:00:00 2001 From: Phil Constantinou Date: Sun, 5 Jan 2025 19:19:17 -0800 Subject: [PATCH 4/6] Parse as a UTC time --- pgtype/timestamp.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pgtype/timestamp.go b/pgtype/timestamp.go index e6e2cc65..89718221 100644 --- a/pgtype/timestamp.go +++ b/pgtype/timestamp.go @@ -112,7 +112,7 @@ func (ts *Timestamp) UnmarshalJSON(b []byte) error { if err == nil { *ts = Timestamp{Time: tim, Valid: true} } - tim, err = time.Parse(jsonISO8601, tss) + tim, err = time.ParseInLocation(jsonISO8601, tss, time.UTC) if err == nil { *ts = Timestamp{Time: tim, Valid: true} } From 5424d3c8734c0360c048876a1981d6f287b7b7f0 Mon Sep 17 00:00:00 2001 From: Phil Constantinou Date: Sun, 5 Jan 2025 19:45:45 -0800 Subject: [PATCH 5/6] Return error and make sure they are unit tested --- pgtype/timestamp.go | 8 ++++++-- pgtype/timestamp_test.go | 12 ++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/pgtype/timestamp.go b/pgtype/timestamp.go index 89718221..c31f2ac5 100644 --- a/pgtype/timestamp.go +++ b/pgtype/timestamp.go @@ -105,19 +105,23 @@ func (ts *Timestamp) UnmarshalJSON(b []byte) error { case "-infinity": *ts = Timestamp{Valid: true, InfinityModifier: -Infinity} default: + // Parse time with or without timezonr tss := *s // PostgreSQL uses ISO 8601 without timezone for to_json function and casting from a string to timestampt - tim, err := time.Parse(time.RFC3339Nano, tss) if err == nil { *ts = Timestamp{Time: tim, Valid: true} + return nil } tim, err = time.ParseInLocation(jsonISO8601, tss, time.UTC) if err == nil { *ts = Timestamp{Time: tim, Valid: true} + return nil } + ts.Valid = false + return fmt.Errorf("cannot unmarshal %s to timestamp with layout %s or %s (%w)", + *s, time.RFC3339Nano, jsonISO8601, err) } - return nil } diff --git a/pgtype/timestamp_test.go b/pgtype/timestamp_test.go index bfcdf023..f913c127 100644 --- a/pgtype/timestamp_test.go +++ b/pgtype/timestamp_test.go @@ -141,6 +141,18 @@ func TestTimestampMarshalJSON(t *testing.T) { } } +func TestTimestampUnmarshalJSONErrors(t *testing.T) { + tsStruct := struct { + TS pgtype.Timestamp `json:"ts"` + }{} + goodJson1 := []byte(`{"ts":"2012-03-29T10:05:45"}`) + assert.NoError(t, json.Unmarshal(goodJson1, &tsStruct)) + goodJson2 := []byte(`{"ts":"2012-03-29T10:05:45Z"}`) + assert.NoError(t, json.Unmarshal(goodJson2, &tsStruct)) + badJson := []byte(`{"ts":"2012-03-29"}`) + assert.Error(t, json.Unmarshal(badJson, &tsStruct)) +} + func TestTimestampUnmarshalJSON(t *testing.T) { successfulTests := []struct { source string From 3c640a44b6ad28b9c14ea232dcce769e634cbe26 Mon Sep 17 00:00:00 2001 From: Phil Constantinou Date: Mon, 6 Jan 2025 09:24:55 -0800 Subject: [PATCH 6/6] Making the tests a little cleaner and clear --- pgtype/timestamp_test.go | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/pgtype/timestamp_test.go b/pgtype/timestamp_test.go index f913c127..bd8c7132 100644 --- a/pgtype/timestamp_test.go +++ b/pgtype/timestamp_test.go @@ -108,6 +108,7 @@ func TestTimestampMarshalJSON(t *testing.T) { }{} tm := time.Date(2012, 3, 29, 10, 5, 45, 0, time.UTC) + tsString := "\"" + tm.Format("2006-01-02T15:04:05") + "\"" // `"2012-03-29T10:05:45"` var pgt pgtype.Timestamp _ = pgt.Scan(tm) @@ -116,9 +117,9 @@ func TestTimestampMarshalJSON(t *testing.T) { result string }{ {source: pgtype.Timestamp{}, result: "null"}, - {source: pgtype.Timestamp{Time: tm, Valid: true}, result: `"2012-03-29T10:05:45"`}, - {source: pgt, result: `"2012-03-29T10:05:45"`}, - {source: pgtype.Timestamp{Time: time.Date(2012, 3, 29, 10, 5, 45, 555*1000*1000, time.UTC), Valid: true}, result: `"2012-03-29T10:05:45.555"`}, + {source: pgtype.Timestamp{Time: tm, Valid: true}, result: tsString}, + {source: pgt, result: tsString}, + {source: pgtype.Timestamp{Time: tm.Add(time.Second * 555 / 1000), Valid: true}, result: `"2012-03-29T10:05:45.555"`}, {source: pgtype.Timestamp{InfinityModifier: pgtype.Infinity, Valid: true}, result: "\"infinity\""}, {source: pgtype.Timestamp{InfinityModifier: pgtype.NegativeInfinity, Valid: true}, result: "\"-infinity\""}, } @@ -128,13 +129,14 @@ func TestTimestampMarshalJSON(t *testing.T) { t.Errorf("%d: %v", i, err) } - if string(r) != tt.result { + if !assert.Equal(t, tt.result, string(r)) { t.Errorf("%d: expected %v to convert to %v, but it was %v", i, tt.source, tt.result, string(r)) } tsStruct.TS = tt.source b, err := json.Marshal(tsStruct) assert.NoErrorf(t, err, "failed to marshal %v %s", tt.source, err) t2 := tsStruct + t2.TS = pgtype.Timestamp{} // Clear out the value so that we can compare after unmarshalling err = json.Unmarshal(b, &t2) assert.NoErrorf(t, err, "failed to unmarshal %v with %s", tt.source, err) assert.True(t, tsStruct.TS.Time.Unix() == t2.TS.Time.Unix())