Fix module import performance regression #2336
Conversation
Require internal flag to add parameter help for built-in Should-operators. Only used by command ref-script in docs-repo and increased import time by 3-4sec in inline build. See pester#2335
|
Ideally we'd use external help (and markdown as source?), but that requires cleanup here and docs-repo (incl. Alt3.Docusaurus.PowerShell module) so need to discuss it first. That should also improve speed of |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
src/Main.ps1
Outdated
| $ParameterAttribute.HelpMessage = 'The name of the assertion/operator' | ||
| $AttributeCollection.Add($ParameterAttribute) | ||
|
|
||
| $ValidateSetAttribute = & $SafeCommands['New-Object']System.Management.Automation.ValidateSetAttribute($script:AssertionOperators.Keys) |
Check notice
Code scanning / PSScriptAnalyzer
The built-in *-Object-cmdlets are slow compared to alternatives in .NET. To fix a violation of this rule, consider using an alternative like `foreach/for`-keyword etc.`.
src/Main.ps1
Outdated
| $ValidateSetAttribute = & $SafeCommands['New-Object']System.Management.Automation.ValidateSetAttribute($script:AssertionOperators.Keys) | ||
| $AttributeCollection.Add($ValidateSetAttribute) | ||
|
|
||
| $RuntimeParameter = & $SafeCommands['New-Object'] System.Management.Automation.RuntimeDefinedParameter($ParameterName, [string], $AttributeCollection) |
Check notice
Code scanning / PSScriptAnalyzer
The built-in *-Object-cmdlets are slow compared to alternatives in .NET. To fix a violation of this rule, consider using an alternative like `foreach/for`-keyword etc.`.
src/Main.ps1
Outdated
| ) | ||
| DynamicParam { | ||
| $ParameterName = 'OperatorName' | ||
| $RuntimeParameterDictionary = & $SafeCommands['New-Object'] System.Management.Automation.RuntimeDefinedParameterDictionary |
Check notice
Code scanning / PSScriptAnalyzer
The built-in *-Object-cmdlets are slow compared to alternatives in .NET. To fix a violation of this rule, consider using an alternative like `foreach/for`-keyword etc.`.
src/Main.ps1
Outdated
| DynamicParam { | ||
| $ParameterName = 'OperatorName' | ||
| $RuntimeParameterDictionary = & $SafeCommands['New-Object'] System.Management.Automation.RuntimeDefinedParameterDictionary | ||
| $AttributeCollection = & $SafeCommands['New-Object'] System.Collections.ObjectModel.Collection[System.Attribute] |
Check notice
Code scanning / PSScriptAnalyzer
The built-in *-Object-cmdlets are slow compared to alternatives in .NET. To fix a violation of this rule, consider using an alternative like `foreach/for`-keyword etc.`.
src/Main.ps1
Outdated
| $ParameterName = 'OperatorName' | ||
| $RuntimeParameterDictionary = & $SafeCommands['New-Object'] System.Management.Automation.RuntimeDefinedParameterDictionary | ||
| $AttributeCollection = & $SafeCommands['New-Object'] System.Collections.ObjectModel.Collection[System.Attribute] | ||
| $ParameterAttribute = & $SafeCommands['New-Object'] System.Management.Automation.ParameterAttribute |
Check notice
Code scanning / PSScriptAnalyzer
The built-in *-Object-cmdlets are slow compared to alternatives in .NET. To fix a violation of this rule, consider using an alternative like `foreach/for`-keyword etc.`.
PR Summary
Fix module import perf regression in 5.4.0 (went from <1 sec to 4sec) caused by slow
Get-Helpcalls introduced in #2170.Affected inline-builds (releases) primarily because
Get-Helpreparses the whole command source (17k+ lines psm1 when inline) to get comment-based help. See #2335This PR replaces the code with an internal function to set the help-message.
PR also includes a minor update to help-text for operator-specific parameters.
Fix #2335
PR Checklist
Create Pull Requestto mark it as a draft. PR can be markedReady for reviewwhen it's ready.