Private/Resolve-ErrorWebResponse.ps1
|
function Resolve-ErrorWebResponse { [CmdletBinding()] param ( $Exception, $StatusCode, [ValidateNotNullOrEmpty()] [System.Management.Automation.PSCmdlet] $Cmdlet = $PSCmdlet ) begin { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function started" Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] ParameterSetName: $($PsCmdlet.ParameterSetName)" Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] PSBoundParameters: $($PSBoundParameters | Out-String)" # Powershell v6+ populates the body of the response into the exception if ($Exception.ErrorDetails) { $responseBody = $Exception.ErrorDetails.Message } # Powershell v5.1- has the body of the response in a Stream in the Exception Response else { $readStream = New-Object -TypeName System.IO.StreamReader -ArgumentList ($Exception.Exception.Response.GetResponseStream()) $responseBody = $readStream.ReadToEnd() $readStream.Close() } $exception = "Invalid Server Response" $errorId = "InvalidResponse.Status$($StatusCode.value__)" $errorCategory = "InvalidResult" if ($responseBody) { # Clear the body in case it is not a JSON (but rather html) if ($responseBody -match "^[\s\t]*\<html\>") { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Content is HTML - replacing it with a generic json" $responseBody = '{"errorMessages": "Invalid server response. HTML returned."}' } Write-Verbose "[$($MyInvocation.MyCommand.Name)] Retrieved body of HTTP response for more information about the error (`$responseBody)" Write-Debug "[$($MyInvocation.MyCommand.Name)] Got the following error as `$responseBody" try { $responseObject = ConvertFrom-Json -InputObject $responseBody -ErrorAction Stop foreach ($_error in ($responseObject.errorMessages + $responseObject.errors)) { # $_error is a PSCustomObject - therefore can't be $false if (-not $_error.ToString()) { break } $writeErrorSplat = @{ Exception = $exception ErrorId = $errorId Category = $errorCategory Message = $_error TargetObject = $targetObject Cmdlet = $Cmdlet } WriteError @writeErrorSplat } } catch [ArgumentException] { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] `$responseBody could not be converted from JSON" $writeErrorSplat = @{ Exception = $exception ErrorId = $errorId Category = $errorCategory Message = $responseBody TargetObject = $targetObject Cmdlet = $Cmdlet } WriteError @writeErrorSplat } catch { $writeErrorSplat = @{ Exception = $exception ErrorId = $errorId Category = $errorCategory Message = "An unknown error ocurred." TargetObject = $targetObject Cmdlet = $Cmdlet } WriteError @writeErrorSplat } } else { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Response had no Body. Using `$StatusCode for generic error" $writeErrorSplat = @{ Exception = $exception ErrorId = $errorId Category = $errorCategory Message = "Server responsed with $StatusCode" Cmdlet = $Cmdlet } WriteError @writeErrorSplat } Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function ended" } } |