Include the newer Microsoft.PowerShell.ThreadJob module - fixes #19742 #19744

kilasuit · 2023-06-05T16:29:00Z

PR Summary

Fixes #19742 by updating the package reference file for modules pulled from the gallery to also include the renamed Microsoft.PowerShell.ThreadJob module

PR Context

PR Checklist

[ x] PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
[ x] Summarized changes
[ x] Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
[ x] 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
- [x ] None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- [ x] Not Applicable
- OR
- Documentation needed
  - Issue filed:
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
- [ x] 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:

…Shell#19742

kilasuit · 2023-06-05T16:30:37Z

Raised this in this way as to allow for discussion on whether we should remove the currently shipped ThreadJob module or not cc @PaulHigin as I am a little concerned that doing so would have potential to break existing use if anyone is module qualifying to ThreadJob\Start-ThreadJob (including within this repo - which I'll have a look into shortly)

kilasuit · 2023-06-05T17:44:28Z

looking into the failures now

ThomasNieto · 2023-06-05T19:01:42Z

Doing a quick search on GitHub there are no references to the module qualified ThreadJob\Start-ThreadJob.

pull-request-quantifier-deprecated · 2023-06-05T19:02:13Z

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

Quantification details

Label      : Extra Small
Size       : +25 -0
Percentile : 10%

Total files changed: 4

Change summary by file extension:
.csproj : +1 -0
.json : +24 -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 detected.
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.

kilasuit · 2023-06-05T20:28:57Z

The test failure is one that I've seen come up before and has nothing to do with this PR Set/New/Remove-Service cmdlet tests.Remove-Service can accept a ServiceController as pipeline input

kilasuit · 2023-06-06T00:11:57Z

I think there will need to be a minor update to docs for this PR

kasini3000 · 2023-06-06T05:45:19Z

this pr renamed module from ThreadJob to Microsoft.PowerShell.ThreadJob?

Will this cause duplicate command names In multiple versions of pwsh ?
What mechanism is there to ensure that 【Microsoft. PowerShell. ThreadJob】 will be used before 【ThreadJob】when automatically importing module?

What are the differences between the two modules?
Why are the two modules forked? Why not update on ThreadJob?
Is there an RFC design specification?

TravisEz13 · 2023-06-06T19:43:45Z

tools/packaging/boms/mac.json

+    "FileType": "NonProduct"
+  },
+  {
+    "Pattern": "Modules/Microsoft.PowerShell.ThreadJob/Microsoft.PowerShell.ThreadJob.pdb",


We should avoid shipping the pdb. Can we file an issue in the threadjob repo

Issue filed in the PowerShell/ThreadJob repo
Looking into the repo and it's structure to see if can get a better understanding and potentially raise a PR myself for this

See PR: PowerShell/ThreadJob#29

adityapatwardhan · 2023-06-06T19:46:58Z

Maintainers would like the Committee to review this breaking change of renaming the module from ThreadJob to Microsoft.PowerShell.ThreadJob.

adityapatwardhan · 2023-06-06T19:47:52Z

src/Modules/PSGalleryModules.csproj

    <PackageReference Include="ThreadJob" Version="2.0.3" />
+    <PackageReference Include="Microsoft.PowerShell.ThreadJob" Version="2.1.0" />


We should not have both of them as the cmdlet names are same and autoloading might load a different module on different runs.

Maybe a Module Alias feature would help resolve this issue and others like it?

@JosephColvin I've raised about exactly that possible enhancement in #19745 but that won't come in anytime soon I wouldn't think.

kilasuit · 2023-06-18T16:57:33Z

Currently waiting on this PR in the ThreadJob repo PowerShell/ThreadJob#29 so can then push update to this PR to resolve the conversation above by @adityapatwardhan

daxian-dbw · 2023-06-19T17:48:44Z

Still waiting on the committee to make a conclusion.

JamesWTruher · 2023-06-28T21:28:47Z

The @PowerShell/powershell-committee discussed this (6/28/23) and suggest that proper way to achieve this is as follows:

Create a new version of the ThreadJob module which proxies to the new Microsoft.PowerShell.ThreadJob module
- the proxy should include a warning message that the ThreadJob module will be deprecated and removed in PS 7.6
Include the new Microsoft.PowerShell.ThreadJob in the release

By taking step 1, we can avoid a breaking change and provide users a glide path to get off the old ThreadJob module which we would want to remove in PS7.6 (our next LTS after 7.4)

Implementation note:
The release YAML will need updating for the Microsoft.PowerShell.ThreadJob module for proper authorization

A new issue should be opened to track the removal of the ThreadJob module in PS7.6.

kilasuit · 2023-06-29T11:56:02Z

@JamesWTruher - Just so that I am clear from the above

Currently we are waiting on a new ThreadJob release -> then can update this PR with that version number & inc the Microsoft.PowerShell.ThreadJob as currently proposed & all's good for the time being?

JamesWTruher · 2023-06-29T23:19:47Z

@JamesWTruher - Just so that I am clear from the above

Currently we are waiting on a new ThreadJob release -> then can update this PR with that version number & inc the Microsoft.PowerShell.ThreadJob as currently proposed & all's good for the time being?

sort of.

We want to be sure that the current ThreadJob module is updated with a deprecation notice (and create a proxy from ThreadJob\Start-ThreadJob to the Microsoft.PowerShell.ThreadJob\Start-ThreadJob cmdlet.

But essentially, we will ship the old ThreadJob module and the new Microsoft.PowerShell.ThreadJob module. If you must have the old behavior, you would be able to achieve this via: Import-Module -RequiredVersion x -Name ThreadJob but just typing Start-ThreadJob will auto-load the new Microsoft.PowerShell.ThreadJob module (which is why this is still technically a breaking change).

explicitly importing the new ThreadJob module should result in a warning message with the "this is going away, so you should use the Microsoft.PowerShell.ThreadJob module"

kilasuit · 2023-06-30T16:47:49Z

Thanks for clarifying @JamesWTruher that was how I understood it from your comment 🙂

ghost · 2023-07-08T02:00:57Z

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

daxian-dbw · 2023-07-10T19:18:44Z

@JamesWTruher A few questions:

but just typing Start-ThreadJob will auto-load the new Microsoft.PowerShell.ThreadJob module

How would we guarantee Microsoft.PowerShell.ThreadJob will be the one loaded when just typing Start-ThreadJob?
Who will be working on the proxy ThreadJob module? Is this PR blocked until the new proxy ThreadJob module is released? If so, I would rather to have this PR closed for now given that we don't have an ETA.

JamesWTruher · 2023-07-10T19:23:20Z

@JamesWTruher A few questions:

but just typing Start-ThreadJob will auto-load the new Microsoft.PowerShell.ThreadJob module

How would we guarantee Microsoft.PowerShell.ThreadJob will be the one loaded when just typing Start-ThreadJob?

Who will be working on the proxy ThreadJob module? Is this PR blocked until the new proxy ThreadJob module is released? If so, I would rather to have this PR closed for now given that we don't have an ETA.

Currently, autoloading loads the first module found, and Microsoft.PowerShell.ThreadJob will be found before ThreadJob
@SteveL-MSFT will have a more informed answer for this

SteveL-MSFT · 2023-07-10T19:25:01Z

Yes, this PR is blocked until someone can develop the ThreadJob proxy module (could be part of this PR as it's just a script module).

daxian-dbw · 2023-07-10T19:29:01Z

The proxy module shouldn't be developed in this PR, as the code should be in a different repo.
If this PR is blocked on that, then I will close this PR for now. Does it sound good to both of you?

JosephColvin · 2023-07-10T19:33:00Z

James, PowerShell will auto load Microsoft.PowerShell.ThreadJob because of the alphabetical order being above ThreadJob (M > T), correct? Joseph Colvin IT Coordinator Warwick Public School<https://www.warwick.k12.nd.us/> “So you never know who you touch. You never know how or when you'll have an impact, or how important your example can be to someone else" ― Denzel Washington, A Hand to Guide Me "When men speak ill of you, live so as nobody may believe them." ― Plato “time, man....time is an illusion. The river flows at an uneven rate but we all drift along in it without noticing until we look back.” – John Gieser Save a tree, think before you print. ***@***.***?anonymous&ep=signature> Book time to meet with ***@***.***?anonymous&ep=signature>

…

________________________________

SteveL-MSFT · 2023-07-10T19:46:44Z

The proxy module shouldn't be developed in this PR, as the code should be in a different repo. If this PR is blocked on that, then I will close this PR for now. Does it sound good to both of you?

The proxy module is really only relevant as part of PS7 due to the breaking change of ThreadJob being included in PS7 prior to renaming to Microsoft.PowerShell.ThreadJob. It's really only to provide compat for one (or two) release and provide a warning message then we can remove it.

If the issue being fixed is critical, we could also consider releasing a new version of Microsoft.PowerShell.ThreadJob as ThreadJob just to be included in PS7.

daxian-dbw · 2023-07-10T19:54:50Z

But ThreadJob is a published module in PowerShell Gallery (v2.0.3 now). If we are going to have a proxy module for it, we'd better release it to PowerShell Gallery too, maybe as v2.1, so as to formally deliver the message that this module is deprecating and Microsoft.PowerShell.ThreadJob should be one to use going forward.

Once the proxy module is published, PowerShell just need to pull it during the build, and then it's time to include Microsoft.PowerShell.ThreadJob module.

SteveL-MSFT · 2023-07-10T21:11:04Z

@daxian-dbw I agree it would make sense to have the ThreadJob module on PSGallery also indicate being deprecated and using Microsoft.PowerShell.ThreadJob instead. In that case, I would also agree that proxy module would be done outside of this PR and repo since it's published to PSGallery. It would make sense to have that proxy developed in https://github.com/powershell/threadjob

GitHub
GitHub - PowerShell/ThreadJob
Contribute to PowerShell/ThreadJob development by creating an account on GitHub.

daxian-dbw · 2023-07-10T22:03:27Z

Opened PowerShell/ThreadJob#30 to track the proxy module work. I will close this PR for now.

Include the newer Microsoft.PowerShell.ThreadJob module - fixes Power…

17c5130

…Shell#19742

kilasuit requested review from TravisEz13, adityapatwardhan, anmenaga and daxian-dbw as code owners June 5, 2023 16:29

ghost assigned adityapatwardhan Jun 5, 2023

kilasuit changed the title ~~Include the newer Microsoft.PowerShell.ThreadJob module - fixes #19742~~ Include the newer Microsoft.PowerShell.ThreadJob module - fix #19742 Jun 5, 2023

kilasuit changed the title ~~Include the newer Microsoft.PowerShell.ThreadJob module - fix #19742~~ Include the newer Microsoft.PowerShell.ThreadJob module - fixes #19742 Jun 5, 2023

pull-request-quantifier-deprecated bot added the Extra Small label Jun 5, 2023

kilasuit added 2 commits June 5, 2023 18:02

add Microsoft.PowerShell.ThreadJob to windows.json to fix test

6713922

updated mac & linux bom files

ac90143

add missing entries

54f4531

kilasuit added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label Jun 6, 2023

TravisEz13 reviewed Jun 6, 2023

View reviewed changes

adityapatwardhan added Breaking-Change breaking change that may affect users Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Jun 6, 2023

adityapatwardhan reviewed Jun 6, 2023

View reviewed changes

kilasuit mentioned this pull request Jun 6, 2023

Release should not include pdb file PowerShell/ThreadJob#28

Closed

3 tasks

JamesWTruher added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Jun 28, 2023

JamesWTruher removed the Extra Small label Jun 28, 2023

ghost added the Review - Needed The PR is being reviewed label Jul 8, 2023

ghost removed the Review - Needed The PR is being reviewed label Jul 10, 2023

daxian-dbw mentioned this pull request Jul 10, 2023

Release a proxy module of ThreadJob that points to Microsoft.PowerShell.ThreadJob PowerShell/ThreadJob#30

Closed

3 tasks

daxian-dbw closed this Jul 10, 2023

Luiz-Monad mentioned this pull request Mar 12, 2025

Populate Runspace & Debugger properties PaulHigin/PSThreadJob#55

Open

		<PackageReference Include="ThreadJob" Version="2.0.3" />
		<PackageReference Include="Microsoft.PowerShell.ThreadJob" Version="2.1.0" />

Include the newer Microsoft.PowerShell.ThreadJob module - fixes #19742 #19744

Include the newer Microsoft.PowerShell.ThreadJob module - fixes #19742 #19744

Uh oh!

Conversation

kilasuit commented Jun 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

kilasuit commented Jun 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kilasuit commented Jun 5, 2023

Uh oh!

ThomasNieto commented Jun 5, 2023

Uh oh!

pull-request-quantifier-deprecated bot commented Jun 5, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

kilasuit commented Jun 5, 2023

Uh oh!

kilasuit commented Jun 6, 2023

Uh oh!

kasini3000 commented Jun 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TravisEz13 Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

kilasuit Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

PaulHigin Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

adityapatwardhan commented Jun 6, 2023

Uh oh!

adityapatwardhan Jun 6, 2023

Choose a reason for hiding this comment

Uh oh!

JosephColvin Jun 7, 2023

Choose a reason for hiding this comment

Uh oh!

kilasuit Jun 13, 2023

Choose a reason for hiding this comment

Uh oh!

kilasuit commented Jun 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daxian-dbw commented Jun 19, 2023

Uh oh!

JamesWTruher commented Jun 28, 2023

Uh oh!

kilasuit commented Jun 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JamesWTruher commented Jun 29, 2023

Uh oh!

kilasuit commented Jun 30, 2023

Uh oh!

ghost commented Jul 8, 2023

Uh oh!

daxian-dbw commented Jul 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JamesWTruher commented Jul 10, 2023

Uh oh!

SteveL-MSFT commented Jul 10, 2023

Uh oh!

daxian-dbw commented Jul 10, 2023

Uh oh!

JosephColvin commented Jul 10, 2023 via email • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SteveL-MSFT commented Jul 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daxian-dbw commented Jul 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

kilasuit commented Jun 5, 2023 •

edited

Loading

kilasuit commented Jun 5, 2023 •

edited

Loading

kasini3000 commented Jun 6, 2023 •

edited

Loading

kilasuit commented Jun 18, 2023 •

edited

Loading

kilasuit commented Jun 29, 2023 •

edited

Loading

daxian-dbw commented Jul 10, 2023 •

edited

Loading

JosephColvin commented Jul 10, 2023 via email •

edited

Loading

SteveL-MSFT commented Jul 10, 2023 •

edited

Loading

daxian-dbw commented Jul 10, 2023 •

edited

Loading

SteveL-MSFT commented Jul 10, 2023 •

edited by unfurl-links bot

Loading