Fixes Stats Summary V5 apis to respond with RFC3339 date/time Format

CHANGELOG.md

@@ -67,6 +67,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - [#7570](https://github.com/apache/trafficcontrol/pull/7570) *Traffic Ops* Fixes `deliveryservice_request_comments` v5 apis to respond with `RFC3339` date/time Format.
 - [#7312](https://github.com/apache/trafficcontrol/issues/7312) *Docs* Changing docs for CDN locks for DELETE response structure v4 and v5. 
 - [#7572](https://github.com/apache/trafficcontrol/pull/7572) *Traffic Ops* Fixes Delivery Service Requests V5 apis docs with RFC3339 date/time Format
+- [#7544](https://github.com/apache/trafficcontrol/issues/7544) *Traffic Ops* Fixes stats_summary v5 apis to respond with RFC3339 date/time Format.
 - [#7542](https://github.com/apache/trafficcontrol/pull/7542) *Traffic Ops* Fixed `CDN Locks` documentation to reflect the correct RFC3339 timestamps.
 - [#6340](https://github.com/apache/trafficcontrol/issues/6340) *Traffic Ops* Fixed alert messages for POST and PUT invalidation job APIs.
 - [#7519] (https://github.com/apache/trafficcontrol/issues/7519) *Traffic Ops* Fixed TO API /servers/{id}/deliveryservices endpoint to responding with all DS's on cache that are directly assigned and inherited through topology.

docs/source/api/v5/stats_summary.rst

@@ -110,7 +110,7 @@ Summary Stats
 
 :statName:            Stat name summary stat represents
 :statValue:           Summary stat value
-:summaryTime:         Timestamp of summary, in :ref:`non-rfc-datetime`
+:summaryTime:         Timestamp of summary, in :rfc:`3339` format
 :statDate:            Date stat was taken, in ``YYYY-MM-DD`` format
 
 .. code-block:: http
@@ -134,31 +134,31 @@ Summary Stats
 			"deliveryServiceName": "all",
 			"statName": "daily_maxgbps",
 			"statValue": 5,
-			"summaryTime": "2019-11-19 00:04:06+00",
+			"summaryTime": "2019-11-19T03:37:33+05:30",
 			"statDate": "2019-11-19"
 		},
 		{
 			"cdnName": "CDN-in-a-Box",
 			"deliveryServiceName": "all",
 			"statName": "daily_maxgbps",
 			"statValue": 3,
-			"summaryTime": "2019-11-18 00:04:06+00",
+			"summaryTime": "2019-11-18T07:59:54+05:30",
 			"statDate": "2019-11-18"
 		},
 		{
 			"cdnName": "CDN-in-a-Box",
 			"deliveryServiceName": "all",
 			"statName": "daily_bytesserved",
 			"statValue": 1000,
-			"summaryTime": "2019-11-19 00:04:06+00",
+			"summaryTime": "2019-11-19T00:42:12+05:30",
 			"statDate": "2019-11-19"
 		}
 	]}
 
 Last Updated Summary Stat
 """""""""""""""""""""""""
 
-:summaryTime: Timestamp of the last updated summary, in :ref:`non-rfc-datetime`
+:summaryTime: Timestamp of the last updated summary, in :rfc:`3339` format
 
 .. code-block:: http
 	:caption: Response Example
@@ -176,7 +176,7 @@ Last Updated Summary Stat
 	Content-Length: 150
 
 	{ "response": {
-		"summaryTime": "2019-11-19 00:04:06+00"
+		"summaryTime": "2019-11-19T06:12:34+05:30"
 	}}
 
 ``POST``
@@ -201,7 +201,7 @@ Request Structure
 
 :statName:            Stat name summary stat represents
 :statValue:           Summary stat value
-:summaryTime:         Timestamp of summary, in :ref:`non-rfc-datetime`
+:summaryTime:         Timestamp of summary, in :rfc:`3339` format
 :statDate:            Date stat was taken, in ``YYYY-MM-DD`` format
 
 .. note:: ``statName``, ``statValue`` and ``summaryTime`` are required. If ``cdnName`` and ``deliveryServiceName`` are not given they will default to ``all``.
@@ -222,7 +222,7 @@ Request Structure
 		"deliveryServiceName": "all",
 		"statName": "daily_maxgbps",
 		"statValue": 10,
-		"summaryTime": "2019-12-05 00:03:57+00",
+		"summaryTime": "2019-12-05T09:55:07+05:30",
 		"statDate": "2019-12-05"
 	}
 

lib/go-tc/stats_summary.go

@@ -23,6 +23,7 @@ import (
 	"database/sql"
 	"encoding/json"
 	"errors"
+	"fmt"
 	"time"
 
 	"github.com/apache/trafficcontrol/lib/go-tc/tovalidate"
@@ -187,3 +188,149 @@ type StatsSummaryLastUpdatedAPIResponse struct {
 	Response StatsSummaryLastUpdated `json:"response"`
 	Alerts
 }
+
+// StatsSummaryV5 is an alias for the latest minor version for the major version 5.
+type StatsSummaryV5 StatsSummaryV50
+
+// StatsSummaryV50 is a summary of some kind of statistic for a CDN and/or
+// Delivery Service.
+type StatsSummaryV50 struct {
+	CDNName         *string    `json:"cdnName"  db:"cdn_name"`
+	DeliveryService *string    `json:"deliveryServiceName"  db:"deliveryservice_name"`
+	StatName        *string    `json:"statName"  db:"stat_name"`
+	StatValue       *float64   `json:"statValue"  db:"stat_value"`
+	SummaryTime     time.Time  `json:"summaryTime"  db:"summary_time"`
+	StatDate        *time.Time `json:"statDate"  db:"stat_date"`
+}
+
+// Validate implements the
+// github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api.ParseValidator
+// interface.
+func (ss StatsSummaryV5) Validate(tx *sql.Tx) error {
+	errs := tovalidate.ToErrors(validation.Errors{
+		"statName":  validation.Validate(ss.StatName, validation.Required),
+		"statValue": validation.Validate(ss.StatValue, validation.Required),
+	})
+	return util.JoinErrs(errs)
+}
+
+// UnmarshalJSON implements the encoding/json.Unmarshaler interface with a
+// customized decoding to force the date format on StatDate.
+func (ss *StatsSummaryV5) UnmarshalJSON(data []byte) error {
+	type Alias StatsSummaryV5
+	resp := struct {
+		SummaryTime string  `json:"summaryTime"`
+		StatDate    *string `json:"statDate"`
+		*Alias
+	}{
+		Alias: (*Alias)(ss),
+	}
+	err := json.Unmarshal(data, &resp)
+	if err != nil {
+		return err
+	}
+	if resp.StatDate != nil {
+		statDate, err := parseTimeV5(*resp.StatDate)
+		if err != nil {
+			return fmt.Errorf("invalid timestamp given for statDate: %v", err)
+		}
+		ss.StatDate = &statDate
+	}
+
+	ss.SummaryTime, err = parseTimeV5(resp.SummaryTime)
+	if err != nil {
+		return fmt.Errorf("invalid timestamp given for summaryTime: %v", err)
+	}
+	return nil
+}
+
+func parseTimeV5(ts string) (time.Time, error) {
+	rt, err := time.Parse(time.RFC3339, ts)
+	if err == nil {
+		return rt, err
+	}
+	return time.Parse(dateFormat, ts)
+}
+
+// MarshalJSON implements the encoding/json.Marshaler interface with a
+// customized encoding to force the date format on StatDate.
+func (ss StatsSummaryV5) MarshalJSON() ([]byte, error) {
+	type Alias StatsSummaryV5
+	resp := struct {
+		StatDate    *string `json:"statDate"`
+		SummaryTime string  `json:"summaryTime"`
+		Alias
+	}{
+		SummaryTime: ss.SummaryTime.Format(time.RFC3339),
+		Alias:       (Alias)(ss),
+	}
+	if ss.StatDate != nil {
+		resp.StatDate = util.Ptr(ss.StatDate.Format(dateFormat))
+	}
+	return json.Marshal(&resp)
+}
+
+// StatsSummaryResponseV5 is an alias for the latest minor version for the major version 5.
+type StatsSummaryResponseV5 StatsSummaryResponseV50
+
+// StatsSummaryResponseV50 is the structure of a response from Traffic Ops to
+// GET requests made to its /stats_summary V5 API endpoint.
+type StatsSummaryResponseV50 struct {
+	Response []StatsSummaryV5 `json:"response"`
+	Alerts
+}
+
+// StatsSummaryLastUpdatedV5 is an alias for the latest minor version for the major version 5.
+type StatsSummaryLastUpdatedV5 StatsSummaryLastUpdatedV50
+
+// StatsSummaryLastUpdatedV50 is the type of the `response` property of a response
+// from Traffic Ops to a GET request made to its /stats_summary endpoint when
+// the 'lastSummaryDate' query string parameter is passed as 'true'.
+type StatsSummaryLastUpdatedV50 struct {
+	SummaryTime *time.Time `json:"summaryTime"  db:"summary_time"`
+}
+
+// MarshalJSON implements the encoding/json.Marshaler interface with a
+// customized encoding to force the date format on SummaryTime.
+func (ss StatsSummaryLastUpdatedV5) MarshalJSON() ([]byte, error) {
+	resp := struct {
+		SummaryTime *string `json:"summaryTime"`
+	}{}
+	if ss.SummaryTime != nil {
+		resp.SummaryTime = util.Ptr(ss.SummaryTime.Format(time.RFC3339))
+	}
+	return json.Marshal(&resp)
+}
+
+// UnmarshalJSON implements the encoding/json.Unmarshaler interface with a
+// customized decoding to force the SummaryTime format.
+func (ss *StatsSummaryLastUpdatedV5) UnmarshalJSON(data []byte) error {
+	resp := struct {
+		SummaryTime *string `json:"summaryTime"`
+	}{}
+	err := json.Unmarshal(data, &resp)
+	if err != nil {
+		return err
+	}
+	if resp.SummaryTime != nil {
+		var summaryTime time.Time
+		summaryTime, err = time.Parse(time.RFC3339, *resp.SummaryTime)
+		if err == nil {
+			ss.SummaryTime = &summaryTime
+			return nil
+		}
+		return err
+	}
+	return nil
+}
+
+// StatsSummaryLastUpdatedAPIResponseV5 is an alias for the latest minor version for the major version 5.
+type StatsSummaryLastUpdatedAPIResponseV5 StatsSummaryLastUpdatedAPIResponseV50
+
+// StatsSummaryLastUpdatedAPIResponseV50 is the type of a response from Traffic
+// Ops to a request to its /stats_summary endpoint with the 'lastSummaryDate'
+// query string parameter set to 'true'.
+type StatsSummaryLastUpdatedAPIResponseV50 struct {
+	Response StatsSummaryLastUpdatedV5 `json:"response"`
+	Alerts
+}

traffic_ops/testing/api/v5/stats_summary_test.go

@@ -34,7 +34,7 @@ func TestStatsSummary(t *testing.T) {
 
 	CreateTestStatsSummaries(t)
 
-	methodTests := utils.TestCase[client.Session, client.RequestOptions, tc.StatsSummary]{
+	methodTests := utils.TestCase[client.Session, client.RequestOptions, tc.StatsSummaryV5]{
 		"GET": {
 			"OK when VALID request": {
 				ClientSession: TOSession,
@@ -115,7 +115,7 @@ func TestStatsSummary(t *testing.T) {
 func validateStatsSummaryFields(expectedResp map[string]interface{}) utils.CkReqFunc {
 	return func(t *testing.T, _ toclientlib.ReqInf, resp interface{}, _ tc.Alerts, _ error) {
 		assert.RequireNotNil(t, resp, "Expected Stats Summary response to not be nil.")
-		statsSummaryResp := resp.([]tc.StatsSummary)
+		statsSummaryResp := resp.([]tc.StatsSummaryV5)
 		for field, expected := range expectedResp {
 			for _, statsSummary := range statsSummaryResp {
 				switch field {
@@ -141,9 +141,10 @@ func validateStatsSummaryFields(expectedResp map[string]interface{}) utils.CkReq
 func validateStatsSummaryLastUpdatedField(expectedTime time.Time) utils.CkReqFunc {
 	return func(t *testing.T, _ toclientlib.ReqInf, resp interface{}, _ tc.Alerts, _ error) {
 		assert.RequireNotNil(t, resp, "Expected StatsSummaryLastUpdated response to not be nil.")
-		statsSummaryLastUpdated := resp.(tc.StatsSummaryLastUpdated)
+		statsSummaryLastUpdated := resp.(tc.StatsSummaryLastUpdatedV5)
 		assert.RequireNotNil(t, statsSummaryLastUpdated.SummaryTime, "Expected SummaryTime to not be nil.")
-		assert.Equal(t, expectedTime, *statsSummaryLastUpdated.SummaryTime, "Expected SummaryTime to be %v, but got %v", expectedTime, *statsSummaryLastUpdated.SummaryTime)
+		assert.Equal(t, true, expectedTime.Equal(*statsSummaryLastUpdated.SummaryTime), "Expected SummaryTime to be %v, but got %v", expectedTime, *statsSummaryLastUpdated.SummaryTime)
+
 	}
 }
 

traffic_ops/testing/api/v5/traffic_control_test.go

@@ -51,7 +51,7 @@ type TrafficControl struct {
 	ServiceCategories                                 []tc.ServiceCategoryV5                  `json:"serviceCategories"`
 	Statuses                                          []tc.StatusNullable                     `json:"statuses"`
 	StaticDNSEntries                                  []tc.StaticDNSEntry                     `json:"staticdnsentries"`
-	StatsSummaries                                    []tc.StatsSummary                       `json:"statsSummaries"`
+	StatsSummaries                                    []tc.StatsSummaryV5                     `json:"statsSummaries"`
 	Tenants                                           []tc.Tenant                             `json:"tenants"`
 	ServerCheckExtensions                             []tc.ServerCheckExtensionNullable       `json:"servercheck_extensions"`
 	Topologies                                        []tc.Topology                           `json:"topologies"`