Fix the common parameter -ProgressAction for advanced functions (#24591)

cmkb3 · daxian-dbw · web-flow · commit b502098e3ade · 2025-06-03T09:43:38.000-07:00
Co-authored-by: Dongbo Wang &lt;dongbow@microsoft.com&gt;
diff --git a/docs/community/working-group-definitions.md b/docs/community/working-group-definitions.md
@@ -30,7 +30,7 @@ The PowerShell developer experience includes the **development of modules** (in
 as well as the experience of **hosting PowerShell and its APIs** in other applications and language runtimes.
 Special consideration should be given to topics like **backwards compatibility** with Windows PowerShell
 (e.g. with **PowerShell Standard**) and **integration with related developer tools**
-(e.g. .NET CLI or the PowerShell extension for VS Code).
+(e.g. .NET CLI or the PowerShell extension for Visual Studio Code).
 
 ### Members
 
diff --git a/src/System.Management.Automation/engine/SpecialVariables.cs b/src/System.Management.Automation/engine/SpecialVariables.cs
@@ -341,6 +341,7 @@ internal static class SpecialVariables
             SpecialVariables.WarningPreference,
             SpecialVariables.InformationPreference,
             SpecialVariables.ConfirmPreference,
+            SpecialVariables.ProgressPreference,
         };
 
         internal static readonly Type[] PreferenceVariableTypes =
@@ -352,6 +353,7 @@ internal static class SpecialVariables
             /* WarningPreference */                       typeof(ActionPreference),
             /* InformationPreference */                   typeof(ActionPreference),
             /* ConfirmPreference */                       typeof(ConfirmImpact),
+            /* ProgressPreference */                      typeof(ActionPreference),
         };
 
         // The following variables are created in every session w/ AllScope.  We avoid creating local slots when we
diff --git a/src/System.Management.Automation/engine/parser/Compiler.cs b/src/System.Management.Automation/engine/parser/Compiler.cs
@@ -833,6 +833,14 @@ internal class Compiler : ICustomAstVisitor2
 
         static Compiler()
         {
+            Diagnostics.Assert(SpecialVariables.AutomaticVariables.Length == (int)AutomaticVariable.NumberOfAutomaticVariables
+                && SpecialVariables.AutomaticVariableTypes.Length == (int)AutomaticVariable.NumberOfAutomaticVariables,
+                "The 'AutomaticVariable' enum length does not match both 'AutomaticVariables' and 'AutomaticVariableTypes' length.");
+
+            Diagnostics.Assert(Enum.GetNames(typeof(PreferenceVariable)).Length == SpecialVariables.PreferenceVariables.Length
+                && Enum.GetNames(typeof(PreferenceVariable)).Length == SpecialVariables.PreferenceVariableTypes.Length,
+                "The 'PreferenceVariable' enum length does not match both 'PreferenceVariables' and 'PreferenceVariableTypes' length.");
+
             s_functionContext = Expression.Parameter(typeof(FunctionContext), "funcContext");
             s_executionContextParameter = Expression.Variable(typeof(ExecutionContext), "context");
 
diff --git a/test/powershell/Language/Scripting/CommonParameters.Tests.ps1 b/test/powershell/Language/Scripting/CommonParameters.Tests.ps1
@@ -147,6 +147,44 @@ Describe "Common parameters support for script cmdlets" -Tags "CI" {
         }
     }
 
+    Context "ProgressAction" {
+        It "Ignores progress actions on advanced script function with no variables" {
+            $ps.AddScript(
+@'
+function test-function {
+    [CmdletBinding()]param()
+
+    Write-Progress "progress foo"
+}
+test-function -ProgressAction Ignore
+'@).Invoke()
+
+            $ps.Streams.Progress.Count | Should -Be 0
+            $ps.Streams.Error | ForEach-Object {
+                Write-Error -ErrorRecord $_ -ErrorAction Stop
+            }
+        }
+
+        It "Ignores progress actions on advanced script function with variables" {
+            $ps.AddScript(
+@'
+function test-function {
+    [CmdletBinding()]param([string]$path)
+
+    switch($false) { default { "echo $path" } }
+
+    Write-Progress "progress foo"
+}
+test-function -ProgressAction Ignore
+'@).Invoke()
+
+            $ps.Streams.Progress.Count | Should -Be 0
+            $ps.Streams.Error | ForEach-Object {
+                Write-Error -ErrorRecord $_ -ErrorAction Stop
+            }
+        }
+    }
+
     Context "SupportShouldprocess" {
         $script = '
                 function get-foo
