Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)

Abierto
  • ¿Algo no está bien?
#2,229 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
csharp, powershell
Área
developer-experience, testing-qa

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Issue - Bug

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 -NonInteractive process. No profile, no other modules.

Minimal repro

  1. Create a folder with one file, Probe.psm1:

    function Get-Probe { 'probe' }
Export-ModuleMember -Function Get-Probe

  2. 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) and AvoidReservedCharInCmdlet (PSReservedCmdletChar) both call Helper.GetExportedFunction. In 1.25.0 no other caller exists.
  • GetExportedFunction calls CommandInfo.ResolveParameter on the cached Export-ModuleMember CmdletInfo. 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.

Lenguaje dominante
C#
Estrellas
2.2k
Forks
423
Merge medio
17 h 27 min
PR fusionados (30 d)
14

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PowerShell/PSScriptAnalyzer

Todos los issues de PowerShell/PSScriptAnalyzer

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.