Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 52/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- csharp, powershell
调研方向
Start by reading Helper.GetExportedFunction and its callers, ProvideCommentHelp and AvoidReservedCharInCmdlet; the issue names these entry points and the cross-thread call to CommandInfo.ResolveParameter. Reproduce with the minimal Probe.psm1 fixture and repeated fresh pwsh runs. Done means Invoke-ScriptAnalyzer completes consistently and returns the expected findings across repeated runs.
由索引模型根据 Issue 内容生成。
描述
Summary
Invoke-ScriptAnalyzer fails intermittently on a file that calls Export-ModuleMember -Function .... The whole call fails with a RULE_ERROR. Usually the exception is a NullReferenceException in System.Management.Automation.CommandInfo.ResolveParameter. Less often it is an InvalidOperationException from PSLocalEventManager.SubscribeEvent ("You cannot have more than one dynamic module in each dynamic assembly in this version of the runtime.").
Environment
- PSScriptAnalyzer 1.25.0
- PowerShell 7.6.5 (pwsh)
- Windows 11 Enterprise (x64)
- Each run is a fresh
pwsh -NoProfile -NonInteractiveprocess. No profile, no other modules.
Minimal repro
-
Create a folder with one file,
Probe.psm1:function Get-Probe { 'probe' } Export-ModuleMember -Function Get-Probe -
Run the analyzer in a fresh process, several times:
$fixture = '<path to the folder>' $child = @" `$ErrorActionPreference = 'Stop' try { Import-Module PSScriptAnalyzer -Force `$r = @(Invoke-ScriptAnalyzer -Path '$fixture' -Recurse) "OK count=`$(`$r.Count)" } catch { "EXC: `$(`$_.Exception.GetType().FullName): `$(`$_.Exception.Message)"; exit 3 } "@ 1..15 | ForEach-Object { pwsh -NoProfile -NonInteractive -Command $child }
A second fixture adds a class file beside the module (ProbeBox.ps1: class ProbeBox { [NoSuchProbeType] $Value }). It fails at a similar rate. The class file is not needed to trigger the fault.
Expected
Every run completes and returns the same findings (here: 1 finding).
Actual
Some runs fail. The whole Invoke-ScriptAnalyzer call ends with FullyQualifiedErrorId: RULE_ERROR,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCommand.
Stack, variant 1 (most frequent; the rule frame is ProvideCommentHelp or
AvoidReservedCharInCmdlet):
System.NullReferenceException: Object reference not set to an instance of an object.
at System.Management.Automation.CommandInfo.ResolveParameter(String name)
at Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper.GetExportedFunction(Ast ast)
at Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.AvoidReservedCharInCmdlet.AnalyzeScript(Ast ast, String fileName)+MoveNext()
at System.Collections.Generic.List`1..ctor(IEnumerable`1 collection)
at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)
at Microsoft.Windows.PowerShell.ScriptAnalyzer.ScriptAnalyzer.<>c__DisplayClass84_1.<AnalyzeSyntaxTree>b__2()
Stack, variant 2:
System.InvalidOperationException: You cannot have more than one dynamic module in each dynamic assembly in this version of the runtime.
at System.Reflection.Emit.RuntimeAssemblyBuilder.DefineDynamicModuleCore(String name)
at System.Management.Automation.PSLocalEventManager.ProcessNewSubscriber(PSEventSubscriber subscriber, Object source, String eventName, String sourceIdentifier, PSObject data, Boolean supportEvent, Boolean forwardEvent)
at System.Management.Automation.PSLocalEventManager.SubscribeEvent(Object source, String eventName, String sourceIdentifier, PSObject data, PSEventReceivedEventHandler handlerDelegate, Boolean supportEvent, Boolean forwardEvent, Int32 maxTriggerCount)
at System.Management.Automation.PSLocalEventManager.SubscribeEvent(Object source, String eventName, String sourceIdentifier, PSObject data, PSEventReceivedEventHandler handlerDelegate, Boolean supportEvent, Boolean forwardEvent, Boolean shouldQueueAndProcessInExecutionThread, Int32 maxTriggerCount)
at System.Management.Automation.CommandInfo.GetMergedCommandParameterMetadataSafely()
at System.Management.Automation.CommandInfo.ResolveParameter(String name)
at Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper.GetExportedFunction(Ast ast)
at Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.ProvideCommentHelp.AnalyzeScript(Ast ast, String fileName)+MoveNext()
at System.Collections.Generic.List`1..ctor(IEnumerable`1 collection)
at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)
at Microsoft.Windows.PowerShell.ScriptAnalyzer.ScriptAnalyzer.<>c__DisplayClass84_1.<AnalyzeSyntaxTree>b__2()
Frequency
| Target | Runs | Failed |
|---|---|---|
Minimal module above (Export-ModuleMember -Function) |
15 | 6 (4 NullReferenceException, 2 InvalidOperationException) |
| Minimal module plus a class file | 30 | 8 |
A real multi-file module (one Export-ModuleMember call), -Recurse |
25 | 4 |
The same module, signed or unsigned, fails at about the same rate.
Analysis
- The analyzer runs the rules for one file in parallel, one task per rule.
ProvideCommentHelp(PSProvideCommentHelp) andAvoidReservedCharInCmdlet(PSReservedCmdletChar) both callHelper.GetExportedFunction. In 1.25.0 no other caller exists.GetExportedFunctioncallsCommandInfo.ResolveParameteron the cachedExport-ModuleMemberCmdletInfo. That object belongs to a runspace of the analyzer's own pool. The call comes from the rule's thread pool thread.- PowerShell sends such a cross-thread call through a one-shot engine event (
GetMergedCommandParameterMetadataSafely). That path does not support two concurrent callers. So one rule gets a null result (variant 1), or the two subscriptions collide (variant 2).
A possible fix: resolve the Export-ModuleMember parameter metadata once, on the runspace thread, or serialize GetExportedFunction across rules.
Workaround
Run the two rules in their own passes, so that nothing else uses the analyzer's runspace at the same time:
$isolated = 'PSProvideCommentHelp', 'PSReservedCmdletChar'
$r = @(Invoke-ScriptAnalyzer -Path $path -Recurse -ExcludeRule $isolated)
foreach ($rule in $isolated) {
# Keep only that rule's findings: each pass reports the parse diagnostics again.
$r += @(Invoke-ScriptAnalyzer -Path $path -Recurse -IncludeRule $rule |
Where-Object RuleName -eq $rule)
}
With the workaround: 0 failures in 40 runs of the minimal module, 0 in 30 runs of the module with a class file, and 0 in 15 runs over three real modules. The findings are the same as those of a complete single pass.
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 423
- 平均合并
- 17 小时 27 分钟
- 30 天内合并 PR
- 14
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
PowerShell/PSScriptAnalyzer 的其他 Issue
-
Up-for-Grabs
难度 1/5 1-3 小时 新手友好度 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 32/100
PowerShell/PSScriptAnalyzer#2222 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 48/100
PowerShell/PSScriptAnalyzer#2220 ·
维护者通常 1 天内回复
-
Resolution - Answered
难度 3/5 1-2 天 新手友好度 55/100
PowerShell/PSScriptAnalyzer#2219 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 72/100
PowerShell/PSScriptAnalyzer#2218 · 1 个 reaction · 已指派 2 人 ·
维护者通常 1 天内回复
查看 PowerShell/PSScriptAnalyzer 的全部 Issue
相似的 Issue
-
area: core priority: low type: bug
难度 2/5 1-3 小时 新手友好度 74/100
RicoSuter/Namotion.Interceptor#863 ·
维护者通常 1 天内回复
-
area-cli
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
0.3.0
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
BrighterCommand/Brighter#4683 ·
维护者通常 1 天内回复