PSUseToExportFieldsInManifest throw System.InvalidOperationException: Collection was modified; enumeration operation may not execute.

[LaurentDardenne]

Steps to reproduce

1..30|% {$res=Invoke-ScriptAnalyzer -path 'C:\Program Files\WindowsPowerShell\Modules\PSScriptAnalyzer\1.16.1\PSScriptAnalyzer.psd1' -ExcludeRule PSMissingModuleManifestField }

Expected behavior

No error.

Actual behavior

Invoke-ScriptAnalyzer : La collection a été modifiée ; l'opération d'énumération peut ne pas s'exécuter.
At line:1 char:15
+ ... .30|% {$res=Invoke-ScriptAnalyzer -path 'C:\Program Files\WindowsPowe ...
+                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (C:\Program File...ptAnalyzer.psd1:String) [Invoke-ScriptAnalyzer], Cm
   dletInvocationException
    + FullyQualifiedErrorId : RULE_ERROR,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerComm
   and

Environment data

$psversiontable
Name                           Value
----                           -----
PSVersion                      5.1.14409.1012
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0, 5.0, 5.1.14409.1012}
BuildVersion                   10.0.14409.1012
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1


 (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.16.1
1.16.0
1.15.0
1.12.0
1.11.1

See also the issue #900

[bergmeister]

Similar to your other issue, I cannot repro. Let's take this one aside and try to boil down the issue of the other one.

[kalgiz]

I was able to reproduce, but the error does not always occur.

[LaurentDardenne]

@kalgiz
"but the error does not always occur."
I agree, this error is erratic.
When executing the same code several times in a row, once the first error is triggered the behavior is degraded :

Line of code executed immediately after the first (1..30 | ...) :

[bergmeister]

I have tried again but it still does not happen on my machine (neither with the released version or the development branch). This sounds like a race condition where a list is modified in a non-thread safe manner. Some background: When PSSA analyses one file, it spawns a Thread for each rule.
@LaurentDardenne Can you please provide more error details using e.g. $error[0] | select *
@kalgiz If you build in debug mode, then Invoke-ScriptAnalyzer will have an -AttachAndDebug switch that automatically attaches you the debugger in Visual Studio, and the default exceptions settings should cause it to break at the line where the exception happens (if not you can change the exception settings to break on any exception).

[LaurentDardenne]

With Windows Seven sp1 Fr ( Microsoft Windows [version 6.1.7601] )

$Error[0]|select *

writeErrorStream              : True
Exception                     : System.Management.Automation.CmdletInvocationException: La collection a été modifiée;
                                l'opération d'énumération peut ne pas s'exécuter. --->
                                System.InvalidOperationException: La collection a été modifiée; l'opération
                                d'énumération peut ne pas s'exécuter.
                                   à System.ThrowHelper.ThrowInvalidOperationException(ExceptionResource resource)
                                   à System.Collections.Generic.List`1.Enumerator.MoveNextRare()
                                   à
                                Microsoft.PowerShell.Commands.ModuleCmdletBase.UpdateCommandCollection(Collection`1
                                list, List`1 patterns)
                                   à Microsoft.PowerShell.Commands.ModuleCmdletBase.LoadModuleManifest(String
                                moduleManifestPath, ExternalScriptInfo scriptInfo, Hashtable data, Hashtable
                                localizedData, ManifestProcessingFlags manifestProcessingFlags, Version
                                minimumVersion, Version maximumVersion, Version requiredVersion, Nullable`1
                                requiredModuleGuid, ImportModuleOptions& options, Boolean& containedErrors)
                                   à Microsoft.PowerShell.Commands.TestModuleManifestCommand.ProcessRecord()
                                   à System.Management.Automation.CommandProcessor.ProcessRecord()
                                   --- Fin de la trace de la pile d'exception interne ---
                                   à System.Management.Automation.Runspaces.PipelineBase.Invoke(IEnumerable input)
                                   à
                                System.Management.Automation.PowerShell.Worker.ConstructPipelineAndDoWork(Runspace rs,
                                Boolean performSyncInvoke)
                                   à System.Management.Automation.PowerShell.Worker.CreateRunspaceIfNeededAndDoWork(Run
                                space rsToUse, Boolean isSync)
                                   à System.Management.Automation.PowerShell.CoreInvokeHelper[TInput,TOutput](PSDataCol
                                lection`1 input, PSDataCollection`1 output, PSInvocationSettings settings)
                                   à
                                System.Management.Automation.PowerShell.CoreInvoke[TInput,TOutput](PSDataCollection`1
                                input, PSDataCollection`1 output, PSInvocationSettings settings)
                                   à System.Management.Automation.PowerShell.Invoke(IEnumerable input,
                                PSInvocationSettings settings)
                                   à Microsoft.Windows.PowerShell.ScriptAnalyzer.Helper.GetModuleManifest(String
                                filePath, IEnumerable`1& errorRecord)
                                   à Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.UseToExportFieldsInManife
                                st.<AnalyzeScript>d__3.MoveNext()
                                   à System.Collections.Generic.List`1..ctor(IEnumerable`1 collection)
                                   à System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)
                                   à Microsoft.Windows.PowerShell.ScriptAnalyzer.ScriptAnalyzer.<>c__DisplayClass78_0.<
                                AnalyzeSyntaxTree>b__1()
TargetObject                  : C:\Program
                                Files\WindowsPowerShell\Modules\PSScriptAnalyzer\1.16.1\PSScriptAnalyzer.psd1
FullyQualifiedErrorId         : RULE_ERROR,Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands.InvokeScriptAnalyzerCom
                                mand
InvocationInfo                : System.Management.Automation.InvocationInfo
ErrorCategory_Category        : 7
ErrorCategory_Activity        : Invoke-ScriptAnalyzer
ErrorCategory_Reason          : CmdletInvocationException
ErrorCategory_TargetName      : C:\Program
                                Files\WindowsPowerShell\Modules\PSScriptAnalyzer\1.16.1\PSScriptAnalyzer.psd1
ErrorCategory_TargetType      : String
ErrorCategory_Message         : InvalidOperation: (C:\Program File...ptAnalyzer.psd1:String) [Invoke-ScriptAnalyzer],
                                CmdletInvocationException
SerializeExtendedInfo         : False
ErrorDetails_ScriptStackTrace : at <ScriptBlock>, <No file>: line 1
                                at <ScriptBlock>, <No file>: line 1
PSMessageDetails              :
CategoryInfo                  : InvalidOperation: (C:\Program File...ptAnalyzer.psd1:String) [Invoke-ScriptAnalyzer],
                                CmdletInvocationException
ErrorDetails                  :
ScriptStackTrace              : at <ScriptBlock>, <No file>: line 1
                                at <ScriptBlock>, <No file>: line 1
PipelineIterationInfo         : {0, 1}


Export-Clixml -InputObject $Error -Depth 5 -Path c:\temp\Issue902.txt

Issue902.txt

[bergmeister]

By looking at the stack trace, it seems to come from here but the help on this method says that it is executed synchronously. Therefore this does not make sense to me assuming there is no bug in the Invoke() method of PowerShell. This Helper class has shown bad behaviour in the past, see this issue, therefore it could be possibly related to that.
Can you give some details about your machine spec (i.e. do you have a rather fast or slow system so that I can size an Azure machine appropriately with the hope of being able to repro)? Did this only occur on Win7 or also Win10?

[LaurentDardenne]

Therefore this does not make sense to me assuming there is no bug in the Invoke() method of PowerShell.

May be a side effect around Dispose() ?
My machine is a Core2 Duo, we can consider it as 'slow'.

With my tests, the problem is triggered more often with this form :

1..30|% { ... call PSSA }

In use it is random.
I have not tested with Win10, I can confirm with Windows 2016.

[bergmeister]

Update: I can finally reproduce now with a Standard D2s v3 (2 vcpus, 8 GB memory) Azure VM (WinServer 2016). I get the error also for another ps.Invoke() call in AvoidUsingDeprecatedManifestFields in addition to the one that we found before in the Helper class. I get the issue also with PowerShell Core 6.0.2. Implementing the using pattern instead of the manual call to dispose does not fix it, therefore this rather looks like a problem of thread safety of the Invoke() method.