stats: Improved sequencing documentation for server-side stats events and added tests. #7885
Conversation
…s to verify the order of server-side events.
RyanBlaney
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7885 +/- ##
==========================================
+ Coverage 81.84% 82.09% +0.24%
==========================================
Files 377 377
Lines 38120 38180 +60
==========================================
+ Hits 31201 31344 +143
+ Misses 5603 5538 -65
+ Partials 1316 1298 -18
|
arjan-bal
changed the title
stats/stats_test.go
Outdated
| func (s *testServer) UnaryCall( | ||
| ctx context.Context, | ||
| in *testpb.SimpleRequest, | ||
| ) (*testpb.SimpleResponse, error) { |
There was a problem hiding this comment.
grpc-go follows the Google style guide. Based on this section in the style guide:
The signature of a function or method declaration should remain on a single line to avoid indentation confusion.
Please revert the changes made to wrap function definationations and calls throughout the PR.
There was a problem hiding this comment.
Got it! I'll disable my autoformatter going forward or reconfigure it to follow the Google style guide.
stats/stats_test.go
Outdated
| @@ -786,8 +884,14 @@ func checkConnEnd(t *testing.T, d *gotData) { | |||
| st.IsClient() // TODO remove this. | |||
| } | |||
|
|
|||
| type event struct { | |||
| eventType string | |||
| timestamp time.Time | |||
There was a problem hiding this comment.
What is the use of storing a timestamp? I believe we're only interested in the ordering of the events and not the absolute times they were emitted.
There was a problem hiding this comment.
The timestamp was included for debugging purposes in case of test failures, since it could help identify delays or other issues. If you feel this isn’t valuable, I can to remove it for simplicity.
|
I have fixed the wrapping errors for formatting and I removed the timestamps from the event structs. Thank you for your feedback @arjan-bal, is there anything else you need me to do? |
…. Added a server stats Server Stream RPC test.
arjan-bal
requested review from
purnesh42H and
arjan-bal
and removed request for
arjan-bal
stats/stats.go
Outdated
| @@ -36,7 +36,49 @@ type RPCStats interface { | |||
| IsClient() bool | |||
| } | |||
|
|
|||
| // InHeader contain stats when the header is received. | |||
| // First event in the server side event sequence. | |||
There was a problem hiding this comment.
nix the extra space. Applicable everywhere. If you want to move the sentence to new line, you need to put a blank line in between. If you want bullets, you can use markdown style "-"
| @@ -98,31 +140,6 @@ func (s *InPayload) IsClient() bool { return s.Client } | |||
|
|
|||
| func (s *InPayload) isRPCStats() {} | |||
|
|
|||
| // InHeader contains stats when a header is received. | |||
| type InHeader struct { | |||
There was a problem hiding this comment.
@RyanBlaney we should just edit the documentation in current struct instead of deleting it entirely and re-creating. Also, restrict the documentation to struct instead of writing the whole sequence. Mentioning that it is the first event on server side after rpc is received is fine.
There was a problem hiding this comment.
I'll get right to it! Thank you!
stats/stats_test.go
Outdated
| @@ -136,7 +197,14 @@ func (s *testServer) UnaryCall(ctx context.Context, in *testpb.SimpleRequest) (* | |||
|
|
|||
| func (s *testServer) FullDuplexCall(stream testgrpc.TestService_FullDuplexCallServer) error { | |||
| if err := stream.SendHeader(testHeaderMetadata); err != nil { | |||
| return status.Errorf(status.Code(err), "%v.SendHeader(%v) = %v, want %v", stream, testHeaderMetadata, err, nil) | |||
| return status.Errorf( | |||
There was a problem hiding this comment.
golang doesn't restrict columns for code. Having it in one is fine.
| @@ -81,6 +83,55 @@ var ( | |||
| } | |||
| // The id for which the service handler should return error. | |||
| errorID int32 = 32202 | |||
|
|
|||
| // Server Stats | |||
There was a problem hiding this comment.
Please fix the documentation everywhere. Remove extra spaces at start and end etc.
There was a problem hiding this comment.
Everything should be resolved now. Thank you for your help!
…der of the InHeader and Begin structs to their original place in the stats.go file.
|
I added a note for the StartServer function in the stats_test.go. It uses a few deprecated opts, so if you want me to resolve these issues I can do that. Also there is a TODO that got left for testing the OutHeader. If you need me to test that I can do that as well. |
Response to Issue #7824
RELEASE NOTES: