8000 Update `Concise` ErrorView to not show line information for errors from script module functions by SteveL-MSFT · Pull Request #14912 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Update Concise ErrorView to not show line information for errors from script module functions #14912

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

Jump to bottom
Merged
iSazonov merged 2 commits into from
Mar 8, 2021
Merged

Update Concise ErrorView to not show line information for errors from script module functions #14912

iSazonov merged 2 commits into from
Mar 8, 2021

Conversation

@SteveL-MSFT
Copy link
Member
@SteveL-MSFT SteveL-MSFT commented Feb 27, 2021 •
edited
Loading

PR Summary

Currently, if a script module (like PowerShellGet v2) has an error, it shows internal information to the user which can be confusing. Change is to check if the invocation is from a .psm1 file and to not show the script line information. Developers of modules can still use Get-Error to get that information during development time.

Before:

PS> install-module lskjfd
Install-Package: /Users/steve/.local/share/powershell/Modules/PowerShellGet/2.2.5/PSModule.psm1:9711
Line |
9711 |  … talledPackages = PackageManagement\Install-Package @PSBoundParameters
     |                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | No match was found for the specified search criteria and module name 'lskjfd'. Try Get-PSRepository to see all available registered module repositories.

After:

PS> install-module lskjfd
Install-Package: No match was found for the specified search criteria and module name 'lskjfd'. Try Get-PSRepository to see all available registered module repositories.

(Note that the error record here is coming from Install-Package being used by Install-Module which is what gets returned by PowerShell)

PR Context

This was reported by users.

PR Checklist

@ghost ghost assigned iSazonov Feb 27, 2021
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Feb 27, 2021
iSazonov
iSazonov < 8000 /strong> approved these changes Feb 27, 2021
View reviewed changes
Copy link
Collaborator
@iSazonov iSazonov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with one minor comment.

@powercode
Copy link
Collaborator
powercode commented Feb 27, 2021

Can we have another view that maintains the current functionality?

It works well as it is now.

@SteveL-MSFT
Copy link
Member Author
SteveL-MSFT commented Feb 28, 2021

@powercode you can get the same (and more information) using Get-Error. It seems like a module should be an abstraction layer from the user. It could be configurable, but I also don't think we want tons of configuration that people don't use as I believe the current output of line information for a script module is really only useful to the author of the module.

@iSazonov
Copy link
Collaborator
iSazonov commented Feb 28, 2021

Maybe it makes sense to add this in docs - $error vs ConciseView vs GetError.

@SteveL-MSFT SteveL-MSFT mentioned this pull request Feb 28, 2021
Closed
@SteveL-MSFT
Copy link
Member Author
SteveL-MSFT commented Mar 1, 2021

Static analysis failure is unrelated to this PR and being invested separately

PaulHigin
PaulHigin approved these changes Mar 1, 2021
View reviewed changes
Copy link
Contributor
@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

8000

LGTM

@iSazonov
Copy link
Collaborator
iSazonov commented Mar 1, 2021

Static analysis failure is unrelated to this PR and being invested separately

We could only run markdown tests (1) if CL-Doc label is present and (2) in nightly build.

SteveL-MSFT and others added 2 commits March 5, 2021 13:52
@SteveL-MSFT
Update Concise ErrorView to not show line information for errors fr…
39c5363 
…om script modules
@SteveL-MSFT @iSazonov
Update src/System.Management.Automation/FormatAndOutput/DefaultFormat…
5fbae4a 
…ters/PowerShellCore_format_ps1xml.cs

Co-authored-by: Ilya <darpa@yandex.ru>
@SteveL-MSFT
Copy link
Member Author
SteveL-MSFT commented Mar 5, 2021

@iSazonov are you ok to merge this?

@iSazonov iSazonov closed this Mar 6, 2021
@iSazonov iSazonov reopened this Mar 6, 2021
@iSazonov
Copy link
Collaborator
iSazonov commented Mar 6, 2021

@SteveL-MSFT "PowerShell-CI-static-analysis (Secret Scan)" blocks merging :-( Could you please ask anybody in your team to look the issue?

@SteveL-MSFT SteveL-MSFT closed this Mar 8, 2021
@SteveL-MSFT SteveL-MSFT reopened this Mar 8, 2021
@iSazonov
Copy link
Collaborator
iSazonov commented Mar 8, 2021

The CI has the problem in all PRs.

@iSazonov iSazonov merged commit 597bfc9 into PowerShell:master Mar 8, 2021
@iSazonov iSazonov added this to the 7.2.0-preview.4 milestone Mar 8, 2021
@SydneyhSmith SydneyhSmith mentioned this pull request Mar 8, 2021
Closed
@JustinGrote
Copy link
Contributor
JustinGrote commented Mar 8, 2021

@iSazonov @SteveL-MSFT haven't had a chance to test but will this work for powershell modules that aren't a single .psm1 file? It's common for modules to be broken into "Private","Public", etc. folders and dot source in the files from there.

Maybe better to test for $myinvocation.mycommand.module.modulebase or something?

@iSazonov
Copy link
Collaborator
iSazonov commented Mar 9, 2021

@JustinGrote Could you please create a test for scenario you mean?

@JustinGrote
Copy link
Contributor
JustinGrote commented Mar 10, 2021

@iSazonov sure, fairly simple:

mymodule.psm1

. .\myfunction.ps1

myfunction.ps1

function myfunction {
  throw 'This should not have a line indicator in conciseview'
}

@SteveL-MSFT
Copy link
Member Author
SteveL-MSFT commented Mar 11, 2021

@JustinGrote that still shows line information as the ErrorRecord shows the ps1 as the source and I don't see a way to map it to the psm1

@SteveL-MSFT SteveL-MSFT deleted the module-error branch March 11, 2021 18:48
@JustinGrote
Copy link
Contributor
JustinGrote commented Mar 11, 2021

@SteveL-MSFT How about if $myinv.MyCommand.Module.ModuleBase is present?

@ghost
Copy link
ghost commented Mar 16, 2021

🎉v7.2.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov approved these changes

@JamesWTruher JamesWTruher Awaiting requested review from JamesWTruher

+1 more reviewer

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@iSazonov iSazonov

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log

Projects

None yet

Milestone

7.2.0-preview.4

Development

Successfully merging this pull request may close these issues.

5 participants

@SteveL-MSFT @powercode @iSazonov @JustinGrote @PaulHigin
0