Fixes Stats Summary V5 apis to respond with RFC3339 date/time Format by jagan-parthiban · Pull Request #7545 · apache/trafficcontrol

jagan-parthiban · 2023-05-28T13:54:08Z

Closes: #7544
Related: #5911

Documentation
Traffic Ops

What is the best way to verify this PR?

Make Api calls to stats_summary 5.0

Stats_Summary to Use RFC3339 Format

curl --request GET \
  --url https://localhost:8443/api/5.0/stats_summary


{
	"response": [
		{
			"statDate": "2023-03-09",
			"summaryTime": "2023-03-09T00:59:12+05:30",
			"cdnName": "cdn101",
			"deliveryServiceName": "all",
			"statName": "daily_maxgbps",
			"statValue": 101
		}
	]
}

If this is a bugfix, which Traffic Control versions contained the bug?

7.0.1

PR submission checklist

This PR has tests
This PR has documentation
This PR has a CHANGELOG.md entry
This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY (see the Apache Software Foundation's security guidelines for details)

codecov · 2023-05-31T19:20:02Z

Codecov Report

Merging #7545 (2c7b7d4) into master (f924716) will increase coverage by 2.68%.
The diff coverage is 16.99%.

@@             Coverage Diff              @@
##             master    #7545      +/-   ##
============================================
+ Coverage     27.51%   30.20%   +2.68%     
  Complexity       98       98              
============================================
  Files           686      793     +107     
  Lines         78851    83815    +4964     
  Branches         90      896     +806     
============================================
+ Hits          21697    25315    +3618     
- Misses        55090    56374    +1284     
- Partials       2064     2126      +62

Flag	Coverage Δ
golib_unit	`48.30% <0.00%> (-0.30%)`	⬇️
grove_unit	`4.60% <ø> (ø)`
t3c_unit	`5.28% <ø> (ø)`
traffic_monitor_unit	`21.28% <ø> (ø)`
traffic_ops_integration	`69.42% <100.00%> (ø)`
traffic_ops_unit	`23.09% <28.76%> (+0.02%)`	⬆️
traffic_portal_v2	`74.35% <ø> (?)`
traffic_stats_unit	`10.14% <ø> (ø)`
unit_tests	`27.32% <14.18%> (+3.13%)`	⬆️
v3	`57.79% <ø> (ø)`
v4	`79.18% <ø> (ø)`
v5	`78.63% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
lib/go-tc/stats_summary.go	`0.00% <0.00%> (ø)`
...s/traffic_ops_golang/trafficstats/stats_summary.go	`13.29% <28.76%> (+13.29%)`	⬆️
traffic_ops/v5-client/stats_summary.go	`82.35% <100.00%> (ø)`

... and 107 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

srijeet0406 · 2023-06-14T14:51:01Z

+	if resp.StatDate != nil {
+		statDate, err := parseTimeV5(*resp.StatDate)
+		if err != nil {
+			return errors.New("invalid timestamp given for statDate")


Could you add the error detail here?

srijeet0406 · 2023-06-14T14:51:11Z

+
+	ss.SummaryTime, err = parseTimeV5(resp.SummaryTime)
+	if err != nil {
+		return errors.New("invalid timestamp given for summaryTime")


Same comment here.

srijeet0406 · 2023-06-14T14:52:33Z

+		Alias:       (Alias)(ss),
+	}
+	if ss.StatDate != nil {
+		resp.StatDate = util.Ptr(ss.StatDate.Format(dateFormat))


Shouldn't this also be RFC3339?

RFC3339 will return date and time. but the expectation is only the date. So as used in the v4 function, in v5 aswell we are using dateFormat

const dateFormat = "2006-01-02"

srijeet0406 · 2023-06-16T21:41:33Z

Looks like the api tests are failing fir stats_summary.

jagan-parthiban · 2023-06-18T05:31:21Z

Looks like the api tests are failing fir stats_summary.

The integration and unit tests are passing. This looks like the newly added contract testing.

* Added current_time_epoch_ms and changes calculation for timestamp for ms * assigning current_time_epoch_ms to result.Time in Handler * updated CHANGELOG.md * Added check for elapsedTime. * Addressed review comments. * Added prevResult check back * pointer assignment for structure. * updated cache unite test with another check.

jagan-parthiban changed the title ~~Fixes Stats SUmmary V5 apis to respond with RFC3339 date/time Format~~ Fixes Stats Summary V5 apis to respond with RFC3339 date/time Format May 28, 2023

jagan-parthiban marked this pull request as ready for review May 30, 2023 13:01

ocket8888 added Traffic Ops related to Traffic Ops low impact affects only a small portion of a CDN, and cannot itself break one tech debt rework due to choosing easy/limited solution labels May 31, 2023

github-advanced-security AI found potential problems May 31, 2023

View reviewed changes

Comment thread traffic_ops/traffic_ops_golang/trafficstats/stats_summary.go Fixed

srijeet0406 suggested changes May 31, 2023

View reviewed changes

Comment thread lib/go-tc/stats_summary.go Outdated

Comment thread lib/go-tc/stats_summary.go

jagan-parthiban force-pushed the improve/rfc3339-stats-summary branch from ce04a0b to 313da4b Compare June 2, 2023 11:59

jagan-parthiban requested a review from srijeet0406 June 2, 2023 14:37

srijeet0406 reviewed Jun 2, 2023

View reviewed changes

Comment thread CHANGELOG.md

jagan-parthiban force-pushed the improve/rfc3339-stats-summary branch from 313da4b to 48fe3d4 Compare June 5, 2023 13:51

jagan-parthiban requested a review from srijeet0406 June 8, 2023 15:05

srijeet0406 reviewed Jun 14, 2023

View reviewed changes

jagan-parthiban force-pushed the improve/rfc3339-stats-summary branch 2 times, most recently from 58c4e99 to adb19bd Compare June 14, 2023 16:01

jagan-parthiban requested a review from srijeet0406 June 14, 2023 16:04

jagan-parthiban force-pushed the improve/rfc3339-stats-summary branch from b4cf7c5 to 088ef01 Compare June 18, 2023 04:56

jagan-parthiban and others added 10 commits July 3, 2023 17:24

Fixes apache#7544 Updated V5 APIs

58013db

Fixes apache#7544 Updated Integration testing based on RFC3339 Format

cf68b85

Fixes apache#7544 Added Unit test Cases wherever possible.

002d80f

CHANGELOG.md Update

db8a54b

Documentation Update

f1c71ea

Fixed PR review comments

09f8924

Fixed PR review comments for apache#7544

e79e87a

Fixed CHANGELOG.md for apache#7544

7a008a9

Fixed CHANGELOG.md for apache#7544

04f6f74

jagan-parthiban added 10 commits July 3, 2023 17:26

Fixed CHANGELOG.md for apache#7544

f87d693

Fixed PR review comments for apache#7544

bb287cc

Fixed PR Review comments

9f8fe05

Fixed CHANGELOG.md

6974d89

Update stats_summary lib

02c4a53

Updated statessummary file

a7e490a

Updated unit test cases

1676dc6

Temp changes to check GHA

33088b7

Temp changes to check GHA

789d98b

revert Temp changes to check GHA

200b082

jagan-parthiban force-pushed the improve/rfc3339-stats-summary branch from 71dc0a3 to 200b082 Compare July 3, 2023 11:57

jagan-parthiban added 3 commits July 3, 2023 17:30

Updated CHANGELOG.md

d057485

Updated GHA failing test case for testing.

9f3a6dd

Updated GHA failing test case.

2c7b7d4

srijeet0406 approved these changes Jul 5, 2023

View reviewed changes

srijeet0406 merged commit 2190cd2 into apache:master Jul 5, 2023

rimashah25 added this to the 8.0.0 milestone Jul 17, 2023

jagan-parthiban deleted the improve/rfc3339-stats-summary branch July 27, 2023 04:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

Fixes Stats Summary V5 apis to respond with RFC3339 date/time Format#7545
srijeet0406 merged 23 commits intoapache:masterfrom
jagan-parthiban:improve/rfc3339-stats-summary

jagan-parthiban commented May 28, 2023

Uh oh!

Uh oh!

codecov Bot commented May 31, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srijeet0406 Jun 14, 2023

Uh oh!

jagan-parthiban Jun 14, 2023

Uh oh!

srijeet0406 Jun 14, 2023

Uh oh!

jagan-parthiban Jun 14, 2023

Uh oh!

srijeet0406 Jun 14, 2023

Uh oh!

jagan-parthiban Jun 14, 2023

Uh oh!

srijeet0406 commented Jun 16, 2023

Uh oh!

jagan-parthiban commented Jun 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

jagan-parthiban commented May 28, 2023

What is the best way to verify this PR?

If this is a bugfix, which Traffic Control versions contained the bug?

PR submission checklist

Uh oh!

Uh oh!

codecov Bot commented May 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srijeet0406 Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

jagan-parthiban Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

srijeet0406 Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

jagan-parthiban Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

srijeet0406 Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

jagan-parthiban Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

srijeet0406 commented Jun 16, 2023

Uh oh!

jagan-parthiban commented Jun 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov Bot commented May 31, 2023 •

edited

Loading