Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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
- フォーク
- 419
- 平均マージ
- 17時間 27分
- マージ済み PR(30日)
- 14
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
PowerShell/PSScriptAnalyzer#2218 · リアクション 1 件 · 担当者 2 名 ·
メンテナーはふだん 1 日以内に返信
PowerShell/PSScriptAnalyzer の issue をすべて見る
似ている issue
-
Importer: an empty or non-numeric Error cell is imported as 0 instead of missing対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
Open-Systems-Pharmacology/OSPSuite.Core#3049 ·
メンテナーはふだん 1 日以内に返信
-
needs attention public-client untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
AzureAD/microsoft-authentication-library-for-dotnet#6242 ·
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 90/100
criticalmanufacturing/cli#882 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
Dome-Works/DOME#129 ·
メンテナーはふだん 1 日以内に返信
-
bug sev:L
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
Systemorph/MeshWeaver#7480 ·
メンテナーはふだん 1 日以内に返信