transport: prevent deadlock in transport Close when GoAway write hangs

[aranjans]

Fixes #7606.

Couple of recent changes worth noting here:

• Send GOAWAY to server on Client Transport Shutdown #7015 added logic to send a GOAWAY frame on client transport shutdown. Unfortunately the handler responsible for writing the GOAWAY frame was holding on to the client transport mutex when attempting to write the GOAWAY frame.
• transport: add timeout for writing GOAWAY on http2Client.Close() #7371 introduced a timeout in the client transport shutdown handler to wait for loopyWriter to exit (after enqueueing the above GOAWAY frame on the controlbuf). This was done to ensure that the client transport shutdown can complete in the face of a hanging network connection that blocks forever when attempting to write the above GOAWAY frame

Description of the deadlock:

• During client transport shutdown, after enqueueing the GOAWAY frame on the controlbuf, http2Client.Close calls http2Client.GetGoAwayReason to fetch the last GOAWAY's debug message, and the latter attempts to grab http2Client.mu.
• http2Client.outgoingGoAwayHandler holds http2Client.mu when it is attempting to write the GOAWAY frame. So, if the underlying network connection is hanging, this method will not release the mutex, and therefore http2Client.GetGoAwayReason will not be able to grab the same mutex, and thereby http2Client.Close will deadlock.

RELEASE NOTES:

• transport: prevent deadlock in client transport shutdown when writing the GOAWAY frame hangs.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.96%. Comparing base (1418e5e) to head (4eaf6ab).
Report is 22 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7662      +/-   ##
==========================================
+ Coverage   81.89%   81.96%   +0.06%     
==========================================
  Files         361      361              
  Lines       27818    27823       +5     
==========================================
+ Hits        22782    22805      +23     
+ Misses       3847     3833      -14     
+ Partials     1189     1185       -4     

Files with missing lines	Coverage Δ
internal/transport/http2_client.go	92.12% <100.00%> (+0.50%)	⬆️

... and 28 files with indirect coverage changes

[purnesh42H]

Is there an existing issue filed which needs to be linked?

[aranjans]

@purnesh42H yes, added it in description.

[easwars]

Some general comments here:

• Can you please use bullet points in the PR description to make it more readable. Also, use backticks wherever appropriate to highlight code symbols
• The release note (and the PR title) needs to be more descriptive. Saying that a deadlock is happening due to http2Client.mu does not provide any useful information for the user.

[purnesh42H]

lgtm