It doesn't seem possible to fix this with parametersets without making a breaking change.
If there's no default parameterset set then the parameter binding can't resolve the parameterset in scenarios like Write-Progress -Activity "Something" -Id 1 -Completed.
If it's set to the current parameterset then it will prompt for an Activity value for Write-Progress -Completed.
If it's set to the new parameterset then it will prompt for a Completed value for Write-Progress -Activity "Something"

It seems like the only option left is to keep the current parameterset and simply make Activity optional, then if no value is provided either provide a default value, or throw an error unless it's a Completed progress record.

I'll queue this up for discussion on Cmdlets WG

This script example seems to work?

[cmdletbinding(DefaultParameterSetName='two')]
param(
	[parameter(ParameterSetName='one', mandatory=$true)]
	[parameter(ParameterSetName='two', mandatory=$false)]
	[string]$activity,

	[parameter(ParameterSetName='two')]
	[switch]$completed
)

$activity
$completed

That's not an accurate example though. Completed still needs to exist in the old parameter set so we don't break backwards compatibility with scripts like Write-Progress -Activity bla -SecondsRemaining 0 -Completed.

This example is more accurate:

function Write-Progress2
{
    [CmdletBinding(DefaultParameterSetName = "two")]
    Param
    (
	    [parameter(ParameterSetName='one', mandatory=$true)]
	    [parameter(ParameterSetName='two', mandatory=$false)]
	    [string]$activity,

        [parameter(ParameterSetName='one', Mandatory = $false)]
	    [parameter(ParameterSetName='two', Mandatory = $false)]
	    [switch]$completed
    )
    $PSCmdlet.ParameterSetName
}

but by making parameter set "two" the default set and the "completed" switch optional we allow people to call it without any parameters at all: Write-Progress2. We can fix that by making the switch mandatory but then calling it with Write-Progress2 -Activity bla will default to set 2 and prompt for a value for the "completed" parameter.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@PowerShell/wg-powershell-cmdlets reviewed this. We agreed to make -Activity not mandatory and allow null/empty value. We understand that new scripts using this will cause older PowerShell to prompt to fill in this parameter, but proper documentation can alleviate this.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

The Cmdlet working group has reviewed this and we recognize the benefit of the requested behavior, and we have seen other scenarios where omitting activity and status is useful.
However, we believe a more elegant change is to add an overloaded constructor for ProgressRecord to allow only activityId.
Further, the Write-Progress cmdlet should be updated to make activity a non-mandatory parameter and call the appropriate constructor,
with a runtime check in set_Activity when the Completed parameter is used and produce an error if Completed is not used and activity is not provided

with a runtime check in set_Activity when the Completed parameter is used and produce an error if Completed is not used and activity is not provided

I don't understand where you want this check. I can't find set_Activity anywhere in the solution. Do you mean inside the cmdlet code itself?
Also, I feel like this comment was forgotten: #18474 (comment) basically the suggested approach will cause problems in remoting scenarios from old -> new and custom hosts may have expectations that Activity is not null.

@MartinGC94 you are correct, when we discussed this in the WG, I had forgotten about the remoting scenario. Let me bring it up to the WG one more time. Sorry about this.

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

The WG hasn't changed our mind about our earlier opinion, but we believe that the serialization of the progress record could be altered so it ensures that a space would be provided during the serialization process instead of changing the default value of the parameter. It looks like this could be done around line 486 in System.Management.Automation/engine/ProgressRecord.cs.

I've applied the WG suggestions with a slight modification: I added the runtime check to ProcessRecord instead of the setter for Activity because parameters can be bound in any order so we can't know for certain if the Completed parameter is set when binding Activity.

This PR has 28 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Label      : Extra Small
Size       : +23 -5
Percentile : 11.2%

Total files changed: 3

Change summary by file extension:
.cs : +22 -4
.ps1 : +1 -1

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes