Skip to content

Fix ConciseView to handle custom ParserError ErrorRecords #19239

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
daxian-dbw merged 8 commits into from
Mar 1, 2023
+23 −3
Merged

Fix ConciseView to handle custom ParserError ErrorRecords #19239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
94e10e0
Fix `ConciseView` to handle custom `ParserError` ErrorRecords
SteveL-MSFT Feb 27, 2023
6e4efb3
Fix how to check that the error is a parse error
SteveL-MSFT Feb 27, 2023
ca50296
Revert unneeded change to pass in original error to get concise message
SteveL-MSFT Feb 28, 2023
411da6b
add some comments explaining checks
SteveL-MSFT Feb 28, 2023
f554b74
Update src/System.Management.Automation/FormatAndOutput/DefaultFormat…
SteveL-MSFT Feb 28, 2023
1e6339e
Update src/System.Management.Automation/FormatAndOutput/DefaultFormat…
SteveL-MSFT Feb 28, 2023
5bef8de
add space separating code and comment
SteveL-MSFT Feb 28, 2023
0008479
Update src/System.Management.Automation/FormatAndOutput/DefaultFormat…
SteveL-MSFT Mar 1, 2023
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
9 changes: 7 additions & 2 deletions ...m.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1075,6 +1075,8 @@ private static IEnumerable<FormatViewDefinition> ViewsOf_System_Management_Autom
")
.AddScriptBlockExpressionBinding(@"
Set-StrictMode -Off
$ErrorActionPreference = 'Stop'
trap { 'Error found in error view definition: ' + $_.Exception.Message }
$newline = [Environment]::Newline

$resetColor = ''
Expand Down Expand Up @@ -1105,8 +1107,11 @@ function Get-ConciseViewPositionMessage {
$message = ''
$prefix = ''

# Don't show line information if script module
if (($myinv -and $myinv.ScriptName -or $myinv.ScriptLineNumber -gt 1 -or $err.CategoryInfo.Category -eq 'ParserError') -and !($myinv.ScriptName.EndsWith('.psm1', [System.StringComparison]::OrdinalIgnoreCase))) {
# The checks here determine if we show line detailed error information:
# - check if `ParserError` and comes from PowerShell which eventually results in a ParseException, but during this execution it's an ErrorRecord
# - check if invocation is a script or multiple lines in the console
# - check that it's not a script module as expectation is that users don't want to see the line of error within a module
if ((($err.CategoryInfo.Category -eq 'ParserError' -and $err.Exception -is 'System.Management.Automation.ParentContainsErrorRecordException') -or $myinv.ScriptName -or $myinv.ScriptLineNumber -gt 1) -and $myinv.ScriptName -notmatch '\.psm1$') {
$useTargetObject = $false

# Handle case where there is a TargetObject and we can show the error at the target rather than the script source
Expand Down
17 changes: 16 additions & 1 deletion test/powershell/engine/Formatting/ErrorView.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Describe 'Tests for $ErrorView' -Tag CI {
}

It "Error shows if `$PSModuleAutoLoadingPreference is set to 'none'" {
$e = & "$PSHOME/pwsh" -noprofile -command '$PSModuleAutoLoadingPreference = ""none""; cmdletThatDoesntExist' 2>&1 | Out-String
$e = & "$PSHOME/pwsh" -noprofile -command '$PSModuleAutoLoadingPreference = "none"; cmdletThatDoesntExist' 2>&1 | Out-String
$e | Should -BeLike "*cmdletThatDoesntExist*"
}

Expand Down Expand Up @@ -151,6 +151,21 @@ Describe 'Tests for $ErrorView' -Tag CI {
$e | Should -Not -BeNullOrEmpty
$e | Should -Not -BeLike "*Line*"
}

It 'Parser error shows line information' {
$testScript = '$psstyle.outputrendering = "plaintext"; 1 ++ 1'
$e = & "$PSHOME/pwsh" -noprofile -command $testScript 2>&1 | Out-String
$e | Should -Not -BeNullOrEmpty
$e = $e.Split([Environment]::NewLine)
$e[0] | Should -BeLike "ParserError:*"
$e[1] | Should -BeLike "Line *" -Because ($e | Out-String)
$e[2] | Should -BeLike "*|*1 ++ 1*"
}

It 'Faux remote parser error shows concise message' {
start-job { [cmdletbinding()]param() $e = [System.Management.Automation.ErrorRecord]::new([System.Exception]::new('hello'), 1, 'ParserError', $null); $pscmdlet.ThrowTerminatingError($e) } | Wait-Job | Receive-Job -ErrorVariable e -ErrorAction SilentlyContinue
$e | Out-String | Should -BeLike '*ParserError*'
}
}

Context 'NormalView tests' {
Expand Down