Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve debug logging of Web cmdlet request and response #25479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iSazonov merged 1 commit into from
May 1, 2025
Merged

Improve debug logging of Web cmdlet request and response #25479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 36 additions & 30 deletions ...owerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,29 +567,10 @@ protected override void ProcessRecord()
FillRequestStream(request);
try
{
long requestContentLength = request.Content is null ? 0 : request.Content.Headers.ContentLength.Value;

string reqVerboseMsg = string.Format(
CultureInfo.CurrentCulture,
WebCmdletStrings.WebMethodInvocationVerboseMsg,
request.Version,
request.Method,
requestContentLength);

WriteVerbose(reqVerboseMsg);

_maximumRedirection = WebSession.MaximumRedirection;

using HttpResponseMessage response = GetResponse(client, request, handleRedirect);

string contentType = ContentHelper.GetContentType(response);
long? contentLength = response.Content.Headers.ContentLength;
string respVerboseMsg = contentLength is null
? string.Format(CultureInfo.CurrentCulture, WebCmdletStrings.WebResponseNoSizeVerboseMsg, response.Version, contentType)
: string.Format(CultureInfo.CurrentCulture, WebCmdletStrings.WebResponseVerboseMsg, response.Version, contentLength, contentType);

WriteVerbose(respVerboseMsg);

bool _isSuccess = response.IsSuccessStatusCode;

// Check if the Resume range was not satisfiable because the file already completed downloading.
Expand Down Expand Up @@ -638,6 +619,9 @@ protected override void ProcessRecord()
string detailMsg = string.Empty;
try
{
string contentType = ContentHelper.GetContentType(response);
long? contentLength = response.Content.Headers.ContentLength;

// We can't use ReadAsStringAsync because it doesn't have per read timeouts
TimeSpan perReadTimeout = ConvertTimeoutSecondsToTimeSpan(OperationTimeoutSeconds);
string characterSet = WebResponseHelper.GetCharacterSet(response);
Expand Down Expand Up @@ -1296,7 +1280,40 @@ internal virtual HttpResponseMessage GetResponse(HttpClient client, HttpRequestM
_cancelToken = new CancellationTokenSource();
try
{
long requestContentLength = request.Content is null ? 0 : request.Content.Headers.ContentLength.Value;

string reqVerboseMsg = string.Format(
CultureInfo.CurrentCulture,
WebCmdletStrings.WebMethodInvocationVerboseMsg,
request.Version,
request.Method,
requestContentLength);

WriteVerbose(reqVerboseMsg);

string reqDebugMsg = string.Format(
CultureInfo.CurrentCulture,
WebCmdletStrings.WebRequestDebugMsg,
request.ToString());

WriteDebug(reqDebugMsg);

response = client.SendAsync(currentRequest, HttpCompletionOption.ResponseHeadersRead, _cancelToken.Token).GetAwaiter().GetResult();

string contentType = ContentHelper.GetContentType(response);
long? contentLength = response.Content.Headers.ContentLength;
string respVerboseMsg = contentLength is null
? string.Format(CultureInfo.CurrentCulture, WebCmdletStrings.WebResponseNoSizeVerboseMsg, response.Version, contentType)
: string.Format(CultureInfo.CurrentCulture, WebCmdletStrings.WebResponseVerboseMsg, response.Version, contentLength, contentType);

WriteVerbose(respVerboseMsg);

string resDebugMsg = string.Format(
CultureInfo.CurrentCulture,
WebCmdletStrings.WebResponseDebugMsg,
response.ToString());

WriteDebug(resDebugMsg);
}
catch (TaskCanceledException ex)
{
Expand Down Expand Up @@ -1361,17 +1378,6 @@ internal virtual HttpResponseMessage GetResponse(HttpClient client, HttpRequestM
{
FillRequestStream(requestWithoutRange);

long requestContentLength = requestWithoutRange.Content is null ? 0 : requestWithoutRange.Content.Headers.ContentLength.Value;

string reqVerboseMsg = string.Format(
CultureInfo.CurrentCulture,
WebCmdletStrings.WebMethodInvocationVerboseMsg,
requestWithoutRange.Version,
requestWithoutRange.Method,
requestContentLength);

WriteVerbose(reqVerboseMsg);

response.Dispose();
response = GetResponse(client, requestWithoutRange, handleRedirect);
}
Expand Down
8 changes: 7 additions & 1 deletion src/Microsoft.PowerShell.Commands.Utility/resources/WebCmdletStrings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
</data>
<data name="InsecureRedirection" xml:space="preserve">
<value>Cannot follow an insecure redirection by default. Reissue the command specifying the -AllowInsecureRedirect switch. </value>
</data>
</data>
<data name="KeysWithDifferentCasingInJsonString" xml:space="preserve">
<value>Cannot convert the JSON string because it contains keys with different casing. Please use the -AsHashTable switch instead. The key that was attempted to be added to the existing key '{0}' was '{1}'.</value>
</data>
Expand Down Expand Up @@ -243,6 +243,12 @@
<data name="WebResponseVerboseMsg" xml:space="preserve">
<value>Received HTTP/{0} {1}-byte response of content type {2}</value>
</data>
<data name="WebRequestDebugMsg" xml:space="preserve">
<value>Request {0}</value>
</data>
<data name="WebResponseDebugMsg" xml:space="preserve">
<value>Response {0}</value>
</data>
<data name="WebResponseNoSizeVerboseMsg" xml:space="preserve">
<value>Received HTTP/{0} response of content type {1} of unknown size</value>
</data>
Expand Down
Loading