UseUsingScopeModifierInNewRunspaces: Fix ArgumentException when the same variable name is used in 2 different sessions. (#1493)

* UseUsingScopeModifierInNewRunspaces: Fix ArgumentException when the same variable name is used in 2 different sessions.

* use .add method to fix full .net build

Co-authored-by: Christoph Bergmeister <[email protected]>

Author: bergmeister

Rules/UseUsingScopeModifierInNewRunspaces.cs

@@ -116,7 +116,7 @@ private class SyntaxCompatibilityVisitor : AstVisitor
             private static readonly IEnumerable<string> s_invokeCommandCmdletNamesAndAliases =
                 Helper.Instance.CmdletNameAndAliases("Invoke-Command");
 
-            private readonly Dictionary<string, Dictionary<string, VariableExpressionAst>> _varsDeclaredPerSession;
+            private readonly Dictionary<string, HashSet<string>> _varsDeclaredPerSession;
 
             private readonly List<DiagnosticRecord> _diagnosticAccumulator;
 
@@ -127,7 +127,7 @@ private class SyntaxCompatibilityVisitor : AstVisitor
             public SyntaxCompatibilityVisitor(UseUsingScopeModifierInNewRunspaces rule, string analyzedScriptPath)
             {
                 _diagnosticAccumulator = new List<DiagnosticRecord>();
-                _varsDeclaredPerSession = new Dictionary<string, Dictionary<string, VariableExpressionAst>>();
+                _varsDeclaredPerSession = new Dictionary<string, HashSet<string>>();
                 _rule = rule;
                 _analyzedFilePath = analyzedScriptPath;
             }
@@ -183,15 +183,15 @@ public override AstVisitAction VisitScriptBlockExpression(ScriptBlockExpressionA
                         return AstVisitAction.Continue;
                     }
 
-                    IReadOnlyDictionary<string, VariableExpressionAst> varsInLocalAssignments = FindVarsInAssignmentAsts(scriptBlockExpressionAst);
+                    HashSet<string> varsInLocalAssignments = FindVarsInAssignmentAsts(scriptBlockExpressionAst);
                     if (varsInLocalAssignments != null)
                     {
                         AddAssignedVarsToSession(sessionName, varsInLocalAssignments);
                     }
 
                     GenerateDiagnosticRecords(
                         FindNonAssignedNonUsingVarAsts(
-                            scriptBlockExpressionAst, 
+                            scriptBlockExpressionAst,
                             GetAssignedVarsInSession(sessionName)));
 
                     return AstVisitAction.SkipChildren;
@@ -205,10 +205,10 @@ public override AstVisitAction VisitScriptBlockExpression(ScriptBlockExpressionA
             /// Example: `$foo = "foo"` ==> the VariableExpressionAst for $foo is returned
             /// </summary>
             /// <param name="ast"></param>
-            private static IReadOnlyDictionary<string, VariableExpressionAst> FindVarsInAssignmentAsts(Ast ast)
+            private static HashSet<string> FindVarsInAssignmentAsts(Ast ast)
             {
-                Dictionary<string, VariableExpressionAst> variableDictionary =
-                    new Dictionary<string, VariableExpressionAst>();
+                HashSet<string> variableDictionary =
+                    new HashSet<string>();
 
                 // Find all variables that are assigned within this ast
                 foreach (AssignmentStatementAst statementAst in ast.FindAll(IsAssignmentStatementAst, true))
@@ -217,11 +217,11 @@ private static IReadOnlyDictionary<string, VariableExpressionAst> FindVarsInAssi
                     {
                         string variableName = string.Format(variable.VariablePath.UserPath,
                             StringComparer.OrdinalIgnoreCase);
-                        variableDictionary.Add(variableName, variable);
+                        variableDictionary.Add(variableName);
                     }
                 };
 
-                return new ReadOnlyDictionary<string, VariableExpressionAst>(variableDictionary);
+                return variableDictionary;
             }
 
             /// <summary>
@@ -264,14 +264,14 @@ private static bool IsAssignmentStatementAst(Ast ast)
             /// <param name="ast"></param>
             /// <param name="varsInAssignments"></param>
             private static IEnumerable<VariableExpressionAst> FindNonAssignedNonUsingVarAsts(
-                Ast ast, IReadOnlyDictionary<string, VariableExpressionAst> varsInAssignments)
+                Ast ast, HashSet<string> varsInAssignments)
             {
                 // Find all variables that are not locally assigned, and don't have $using: scope modifier
                 foreach (VariableExpressionAst variable in ast.FindAll(IsNonUsingNonSpecialVariableExpressionAst, true))
                 {
                     var varName = string.Format(variable.VariablePath.UserPath, StringComparer.OrdinalIgnoreCase);
 
-                    if (varsInAssignments.ContainsKey(varName))
+                    if (varsInAssignments.Contains(varName))
                     {
                         yield break;    
                     }
@@ -368,7 +368,7 @@ private static bool TryGetSessionNameFromInvokeCommand(CommandAst invokeCommandA
             /// GetAssignedVarsInSession: Retrieves all previously declared vars for a given session (as in Invoke-Command -Session $session).
             /// </summary>
             /// <param name="sessionName"></param>
-            private IReadOnlyDictionary<string,VariableExpressionAst> GetAssignedVarsInSession(string sessionName)
+            private HashSet<string> GetAssignedVarsInSession(string sessionName)
             {
                 return _varsDeclaredPerSession[sessionName];
             }
@@ -378,16 +378,19 @@ private IReadOnlyDictionary<string,VariableExpressionAst> GetAssignedVarsInSessi
             /// </summary>
             /// <param name="sessionName"></param>
             /// <param name="variablesToAdd"></param>
-            private void AddAssignedVarsToSession(string sessionName, IReadOnlyDictionary<string, VariableExpressionAst> variablesToAdd)
+            private void AddAssignedVarsToSession(string sessionName, HashSet<string> variablesToAdd)
             {
                 if (!_varsDeclaredPerSession.ContainsKey(sessionName))
                 {
-                    _varsDeclaredPerSession.Add(sessionName, new Dictionary<string, VariableExpressionAst>());
+                    _varsDeclaredPerSession.Add(sessionName, new HashSet<string>());
                 }
 
                 foreach (var item in variablesToAdd)
                 {
-                    _varsDeclaredPerSession[sessionName].Add(item.Key, item.Value);
+                    if (!_varsDeclaredPerSession[sessionName].Contains(item))
+                    {
+                        _varsDeclaredPerSession[sessionName].Add(item);
+                    }
                 }
             }
 

Tests/Rules/UseUsingScopeModifierInNewRunspaces.tests.ps1

@@ -274,6 +274,27 @@ Describe "UseUsingScopeModifierInNewRunspaces" {
                         }
                     }'
                 }
+                # Issue 1492: https://github.com/PowerShell/PSScriptAnalyzer/issues/1492
+                @{
+                    Description = 'Does not throw when the same variable name is used in two different sessions'
+                    ScriptBlock = @'
+function Get-One{
+
+    Invoke-Command -Session $sourceRemoteSession {
+        $a = $sccmModule
+        foo $a
+    }
+}
+
+function Get-Two{
+
+    Invoke-Command -Session $sourceRemoteSession {
+        $a = $sccmModule
+        foo $a
+    }
+}
+'@
+                }
             )
         }