GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add `-StrictMode` to `Invoke-Command` to allow specifying strict mode when invoking command locally by Thomas-Yu · Pull Request #16545 · PowerShell/PowerShell

Conversation

@Thomas-Yu

@Thomas-Yu Thomas-Yu commented Dec 3, 2021 •
edited by daxian-dbw
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

PR Summary

Fix #2692

Add -StrictMode to Invoke-Command to allow specifying strict mode when invoking command locally.
The -StrictMode parameter sets the provided version to the process. Once the process completes, the StrictMode version is set back to what it was before the Invoke-Command.

It does not support asynchronous jobs on remote machines. Applying a StrictMode version for a remote session is not a trivial change. The StrictMode version would have to be communicated to the target so that it can be applied to the Runspace in the remote session.

In addition to the implementation, an Invoke-Command test file was created with -StrictMode tests.

PR Context

This pull request was opened in response to the "Invoke-Command should support -StrictMode #2692" issue. Now, Invoke-Command supports a -StrictMode parameter.
StrictMode establishes and enforces coding rules in expressions, scripts, and script blocks. This can be useful for running scripts with basic best-practice coding rules. Even though this is not an implementation for async jobs, there are still many useful applications for StrictMode in local processes.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
  • Breaking changes
    • None
    • OR
    • Experimental feature(s) needed
      • Experimental feature name(s):
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed
      • Issue filed: Add Documentation for Invoke-Command StrictModeVersion Parameter MicrosoftDocs/PowerShell-Docs#8459
  • Testing - New and feature
    • N/A or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
  • Tooling
    • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
    • OR
    • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
      • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
        (which runs in a different PS Host).
        • Issue filed:
      • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
        • Issue filed:
      • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
        • Issue filed:
      • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
        • Issue filed:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@Thomas-Yu
Thomas-Yu requested a review from Paul Higinbotham (PaulHigin) as a code owner December 3, 2021 01:35
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Small label Dec 3, 2021
@ghost ghost assigned Dongbo Wang (daxian-dbw) Dec 3, 2021
@ghost

Deleted user (ghost) commented Dec 3, 2021 •
edited by ghost
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

CLA assistant check
All CLA requirements met.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iSazonov Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 11, 2021
anamnavi
Anam Navied (anamnavi) reviewed Dec 13, 2021
View reviewed changes

@anamnavi Anam Navied (anamnavi) left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall!

I left some feedback on how you can just use the StrictModeVersion property (instead of creating a field since you don't have any additional logic for this property's setter method and can just use the default setter with the property. Paul Higinbotham (@PaulHigin) if using the Property instead of additionally creating a field isn't recommended practice in PowerShell project specifically please let me know.

EDIT: since older PowerShell classes use field backing it's up to the author to make this change if they wish but not neccessary.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

anamnavi
Anam Navied (anamnavi) approved these changes Dec 14, 2021
View reviewed changes
@anamnavi
Anam Navied (anamnavi) self-requested a review December 15, 2021 16:20
PaulHigin
Paul Higinbotham (PaulHigin) suggested changes Dec 15, 2021
View reviewed changes

@PaulHigin Paul Higinbotham (PaulHigin) left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I didn't notice that these comments were not yet submitted.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 15, 2021
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added Extra Large and removed Extra Small labels Dec 15, 2021
PaulHigin
Paul Higinbotham (PaulHigin) suggested changes Dec 15, 2021
View reviewed changes
Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 15, 2021
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added Small and removed Extra Large labels Dec 21, 2021
@Thomas-Yu
Thomas-Yu force-pushed the StrictMode-for-Invoke-Command branch from a453e4d to a734fc5 Compare December 22, 2021 22:58
@ghost ghost added the Review - Needed The PR is being reviewed label Dec 30, 2021
@ghost

Deleted user (ghost) commented Dec 30, 2021

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

PaulHigin
Paul Higinbotham (PaulHigin) suggested changes Jan 3, 2022
View reviewed changes
Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Invoke-Command.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Invoke-Command.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Invoke-Command.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Invoke-Command.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed labels Jan 3, 2022
PaulHigin
Paul Higinbotham (PaulHigin) suggested changes Jan 3, 2022
View reviewed changes
Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 3, 2022
PaulHigin
Paul Higinbotham (PaulHigin) approved these changes Jan 3, 2022
View reviewed changes

@PaulHigin Paul Higinbotham (PaulHigin) left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Thomas-Yu Thanks for your contribution!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
daxian-dbw
Dongbo Wang (daxian-dbw) requested changes Jan 3, 2022
View reviewed changes
Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 3, 2022
daxian-dbw
Dongbo Wang (daxian-dbw) reviewed Jan 3, 2022
View reviewed changes
Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Invoke-Command.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

@Thomas-Yu
Changed field
d353c9d
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 11, 2022
@Thomas-Yu
.
792a425
daxian-dbw
Dongbo Wang (daxian-dbw) requested changes Jan 11, 2022
View reviewed changes
Comment thread src/System.Management.Automation/engine/InternalCommands.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 11, 2022
PaulHigin
Paul Higinbotham (PaulHigin) approved these changes Jan 11, 2022
View reviewed changes

@PaulHigin Paul Higinbotham (PaulHigin) left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my part I am good with these changes.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/System.Management.Automation/engine/InternalCommands.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@Thomas-Yu
Revert internalcommands.cs changes
7d7e665
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 11, 2022
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added Small and removed Medium labels Jan 11, 2022
Thomas-Yu added 3 commits January 11, 2022 15:17
@Thomas-Yu
syntax
ef9086b
@Thomas-Yu
accepts off
ca47c60
@Thomas-Yu
syntax
1edfaed
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Jan 12, 2022

Copy link
Copy Markdown

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


Quantification details

Label      : Small
Size       : +78 -12
Percentile : 36%

Total files changed: 3

Change summary by file extension:
.cs : +60 -12
.ps1 : +18 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

PaulHigin
Paul Higinbotham (PaulHigin) suggested changes Jan 12, 2022
View reviewed changes
Comment thread src/System.Management.Automation/engine/remoting/commands/InvokeCommandCommand.cs
}
}

private sealed class ArgumentToPSVersionTransformationAttribute : ArgumentToVersionTransformationAttribute

@PaulHigin Paul Higinbotham (PaulHigin) Jan 12, 2022

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thomas-Yu , Dongbo Wang (@daxian-dbw) For the record, I don't think it was necessary to split the attribute/conversion classes into two separate implementations. Soon,Set-StrictMode will also take the off value for strict mode version, which means merging these two classes back together. In the mean time, there was no harm in having one set of attribute/conversion implementations. Now when Set-StrictMode is updated to also support off this work will have to be refactored yet again.

Thomas-Yu Please create an Issue in PowerShell repo that adds off to the Set-StrictMode -Version parameter. The committee would like to see it work the same as for Invoke-Command here for consistency, although it is not necessary to include the changes in this PR.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jan 12, 2022
daxian-dbw
Dongbo Wang (daxian-dbw) approved these changes Jan 12, 2022
View reviewed changes

@daxian-dbw Dongbo Wang (daxian-dbw) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thomas-Yu Thank you for your contribution!
Some of my comments may have resulted in contradictions throughout the review, sorry about that and thanks for your patience!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Thomas-Yu reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@Thomas-Yu Thomas-Yu mentioned this pull request Jan 12, 2022
Set-StrictMode -Version should support "off" as a parameter #16736
Closed
@daxian-dbw

Dongbo Wang (daxian-dbw) commented Jan 12, 2022

Copy link
Copy Markdown
Member

Paul Higinbotham (@PaulHigin), the issue #16736 has been opened by Thomas-Yu per your ask. I will merge this PR once you approve it.

PaulHigin reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

PaulHigin
Paul Higinbotham (PaulHigin) approved these changes Jan 12, 2022
View reviewed changes
@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit ed6e058 into PowerShell:master Jan 12, 2022
@daxian-dbw Dongbo Wang (daxian-dbw) changed the title Invoke-Command supports a StrictModeVersion parameter, includes Invoke-Command StrictModeVersion tests Add -StrictMode to Invoke-Command to allow specifying strict mode when invoking command locally Jan 12, 2022
@daxian-dbw Dongbo Wang (daxian-dbw) changed the title Add -StrictMode to Invoke-Command to allow specifying strict mode when invoking command locally Add -StrictMode to Invoke-Command to allow specifying strict mode when invoking command locally Jan 12, 2022
TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
@Thomas-Yu @TrapGodBrim
Add -StrictMode to Invoke-Command to allow specifying strict mode…
cfdedeb
… when invoking command locally (PowerShell#16545)
@ghost

Deleted user (ghost) commented Feb 24, 2022

Copy link
Copy Markdown

🎉v7.3.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

  • Release Notes
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@sdwheeler Sean Wheeler (sdwheeler) mentioned this pull request Mar 3, 2022
Add -StrictMode to Invoke-Command to allow specifying strict mode when invoking command locally MicrosoftDocs/PowerShell-Docs#8617
Closed
2 tasks done
Steve Lee (SteveL-MSFT) added a commit that referenced this pull request Sep 6, 2022
@SteveL-MSFT
Revert "Add -StrictMode to Invoke-Command to allow specifying str…
ac4460e
…ict mode when invoking command locally (#16545)"

This reverts commit ed6e058.
@SteveL-MSFT Steve Lee (SteveL-MSFT) mentioned this pull request Sep 6, 2022
Revert "Add -StrictMode to Invoke-Command to allow specifying strict mode when invoking command locally" #18040
Merged
github-actions Bot pushed a commit that referenced this pull request Sep 12, 2022
@SteveL-MSFT
Revert "Add -StrictMode to Invoke-Command to allow specifying str…
3669a9b
…ict mode when invoking command locally (#16545)"

This reverts commit ed6e058.
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@Thomas-Yu
Add -StrictMode to Invoke-Command to allow specifying strict mode…
f6b1c84
… when invoking command locally (PowerShell#16545)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw Dongbo Wang (daxian-dbw) daxian-dbw approved these changes
@anamnavi Anam Navied (anamnavi) Awaiting requested review from anamnavi
+1 more reviewer
@PaulHigin Paul Higinbotham (PaulHigin) PaulHigin approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@daxian-dbw Dongbo Wang (daxian-dbw)

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Small Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Invoke-Command should support -StrictMode

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@Thomas-Yu @PaulHigin @daxian-dbw @anamnavi @iSazonov
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.