Add support for upgrading the CommandNotFound module #32766

carlos-zamora · 2024-05-07T21:23:06Z

Summary of the Pull Request

CommandNotFound PowerShell module changes
- Removes the CommandNotFound source code since that'll soon be moved to another repository
Microsoft.WinGet.Client PowerShell module changes
- Enforces a version requirement for the Microsoft.WinGet.Client. Upgrading to 1.8.1133 allows support for ARM64.
ARM64 support
- Removes any logic checking for ARM64, since that works now when upgrading the Microsoft.WinGet.Client module.
- Settings UI was updated to remove these checks since they're no longer necessary.
PowerShell profile changes
- GUID f45873b3-b655-43a6-b217-97c00aa0db58 is now used in the PowerShell profile comment to denote that the module was installed/enabled
- GUID 34de4b3d-13a8-4540-b76d-b9e8d3851756 (the old one) is used to detect that an upgrade is available (and we upgrade to the one above appropriately)

Related Issues

#30818

PR Checklist

Localization: All end user facing strings can be localized
Dev docs: Added/updated
New binaries: Added on the required places
- JSON for signing for new binaries
- WXS for installer for new binaries and localization folder
- YML for CI pipeline for new test projects
- YML for signed pipeline
Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Validation Steps Performed

Validated each ps1 script by running it locally
PSGallery has been updated with Microsoft.WinGet.CommandNotFound module

Based on some work by @snickler

carlos-zamora · 2024-05-07T21:27:13Z

Looking through #30818, looks like we still need the ARM64 check due to...

There's no PowerShell 7.4 MSI installer for arm64, so arm64 isn't currently supported.

Also need to look into...

It doesn't work with PowerShell installed from MSIX or from the Microsoft Store, since we depend on powershellgallery.com/packages/Microsoft.WinGet.Client/1.6.3133.0 which doesn't work for those cases.

... to see if the updated Microsoft.WinGet.Client module works in those cases.

snickler · 2024-05-08T16:18:49Z

Looking through #30818, looks like we still need the ARM64 check due to...

There's no PowerShell 7.4 MSI installer for arm64, so arm64 isn't currently supported.

Also need to look into...

It doesn't work with PowerShell installed from MSIX or from the Microsoft Store, since we depend on powershellgallery.com/packages/Microsoft.WinGet.Client/1.6.3133.0 which doesn't work for those cases.

... to see if the updated Microsoft.WinGet.Client module works in those cases.

For the 7.4 installer for arm64, I wonder if we can just have it open "ms-windows-store://pdp/?ProductId=9mz1snwt0n5d" which would bring it right to the store installer.

The PowerShell module will work in MSIX Store Installer due to the changes made in the 1.8 release that fixed the COM crashing.

…t in EnableModule.ps1

carlos-zamora · 2024-05-08T20:08:43Z

@jaimecbernardo Added in the UpgradeModule.ps1 script and made it a part of Product.wxs. Pulling you in to figure out the installer bits 😊

jaimecbernardo · 2024-05-09T09:13:03Z

I've added a couple of commits to have this run CI and be able to build well:

Fix XAML style.
Remove the CmdNotFound project from .sln too.

jaimecbernardo · 2024-05-09T09:13:52Z

Thanks for the contribution and the changes 😄
I think everything for the installer is in place. I'll build an installer and test the scenarios to see if it's good.

jaimecbernardo · 2024-05-09T14:19:04Z

src/settings-ui/Settings.UI/Assets/Settings/Scripts/EnableModule.ps1

-  Add-Content -Path $PROFILE  -Value "`r`nImport-Module `"$scriptPath\WinGetCommandNotFound.psd1`""
-  Add-Content -Path $PROFILE  -Value "#34de4b3d-13a8-4540-b76d-b9e8d3851756"  
+  Add-Content -Path $PROFILE  -Value "`r`n#f45873b3-b655-43a6-b217-97c00aa0db58 PowerToys CommandNotFound module"
+  Add-Content -Path $PROFILE  -Value "`r`nImport-Module -Name Microsoft.WinGet.CommandNotFound`""


@carlos-zamora , have you tested this? (when the module is not installed and you install from scratch?)

jaimecbernardo · 2024-05-09T14:27:35Z

The upgradeModule.ps1 seems to be running from the installer but not doing anything at first look.
@carlos-zamora , tried to run the script directly and got this

Shouldn't the Upgrade-Module references be Update-Module instead?

snickler · 2024-05-09T14:58:03Z

Ah yes it should be Update-Module instead Jeremy Sinclair Windows Development MVP Avalonia MVP [signatureImage] [signatureImage]

…

________________________________

jaimecbernardo · 2024-05-09T16:36:45Z

Current status: Figuring out why the script seems to do nothing when running from the installer.

snickler · 2024-05-09T16:59:35Z

Current status: Figuring out why the script seems to do nothing when running from the installer.

Hmmmm a good thing to try is commenting out the starting portions of the script that run Test-Path against $PROFILE. If it continues on and does something, then it could mean there's potentially an issue with the instance failing to set the variable that points to the PowerShell profile script?

jaimecbernardo · 2024-05-10T12:51:00Z

Figured it out, we were not passing the install folder as an argument to the custom action 😅 .
Regarding the new "Microsoft.WinGet.CommandNotFound", it's getting shipped with WinGet, is that what's happening @carlos-zamora ?

carlos-zamora · 2024-05-10T16:39:56Z

Regarding the new "Microsoft.WinGet.CommandNotFound", it's getting shipped with WinGet, is that what's happening @carlos-zamora ?

No, actually. The module source code is moving into its own repo. From there, it'll be built/signed, then published to PSGallery.

jaimecbernardo · 2024-05-13T09:41:07Z

Regarding the new "Microsoft.WinGet.CommandNotFound", it's getting shipped with WinGet, is that what's happening @carlos-zamora ?

No, actually. The module source code is moving into its own repo. From there, it'll be built/signed, then published to PSGallery.

So, how will the module get to be installed from PSGallery? I think that's still missing from this PR, if I'm interpreting it correctly.

carlos-zamora · 2024-05-13T23:59:02Z

Regarding the new "Microsoft.WinGet.CommandNotFound", it's getting shipped with WinGet, is that what's happening @carlos-zamora ?

No, actually. The module source code is moving into its own repo. From there, it'll be built/signed, then published to PSGallery.

So, how will the module get to be installed from PSGallery? I think that's still missing from this PR, if I'm interpreting it correctly.

Oops! Good catch! Updated!

src/settings-ui/Settings.UI/Assets/Settings/Scripts/EnableModule.ps1

jaimecbernardo · 2024-05-14T11:17:12Z

We're going for building the release candidate later today. Were these changes intended for this release?

carlos-zamora · 2024-05-15T16:09:40Z

We're going for building the release candidate later today. Were these changes intended for this release?

Yes! Final changes were made to the CommandNotFound module in the other repo and the pipeline successfully ran and output the signed module. I'm uploading it to the PSGallery today. Reviews would be appreciated to get this into the release 😊. Sorry it's coming in so close to the deadline!

stefansjfw

Change looks good to me.

I tested upgrade scenario, clean install and uninstall on win11 on x64. Also, tested on Win10 Arm64 device. Everything works as expected

[CommandNotFound] Add support for upgrading the module

37c7bdc

upgrade module as a part of upgrade installation; actually set conten…

f8bc3c4

…t in EnableModule.ps1

jaimecbernardo added 2 commits May 9, 2024 10:06

Fix XAML style to pass CI

ac711ad

Remove CmdNotFound project from sln as well

6af04fc

jaimecbernardo added 5 commits May 9, 2024 10:39

Remove CmdNotFound psd1 file from installer

e9dc905

More installer fixes

ab07e6d

UpgradeCommandNotFound runs after InstallFiles

6510fbf

Fix NOTICE.md

3a2aef6

Fix custom action condition

1461173

jaimecbernardo reviewed May 9, 2024

View reviewed changes

Pass install folder to the custom action

b376cd4

Upgrade-Module --> Update-Module

0d735ad

actually install the module

5bc20ce

github-advanced-security bot found potential problems May 14, 2024

View reviewed changes

src/settings-ui/Settings.UI/Assets/Settings/Scripts/EnableModule.ps1 Fixed Show fixed Hide fixed

src/settings-ui/Settings.UI/Assets/Settings/Scripts/EnableModule.ps1 Fixed Show fixed Hide fixed

This comment has been minimized.

Sign in to view

spell

01f9ad7

verify updated scripts work; make necessary changes

986c46b

carlos-zamora marked this pull request as ready for review May 16, 2024 07:12

Merge branch 'main' into dev/cazamor/cmdNotFound-upgrade

0211228

stefansjfw approved these changes May 16, 2024

View reviewed changes

jaimecbernardo merged commit e1832a0 into main May 16, 2024
16 checks passed

carlos-zamora deleted the dev/cazamor/cmdNotFound-upgrade branch May 16, 2024 21:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for upgrading the CommandNotFound module #32766

Add support for upgrading the CommandNotFound module #32766

carlos-zamora commented May 7, 2024 •

edited

carlos-zamora commented May 7, 2024

snickler commented May 8, 2024

carlos-zamora commented May 8, 2024

jaimecbernardo commented May 9, 2024

jaimecbernardo commented May 9, 2024

jaimecbernardo May 9, 2024

jaimecbernardo commented May 9, 2024

snickler commented May 9, 2024 via email •

edited by microsoft-github-policy-service bot

jaimecbernardo commented May 9, 2024

snickler commented May 9, 2024

jaimecbernardo commented May 10, 2024

carlos-zamora commented May 10, 2024

jaimecbernardo commented May 13, 2024

carlos-zamora commented May 13, 2024

This comment has been minimized.

jaimecbernardo commented May 14, 2024

carlos-zamora commented May 15, 2024

stefansjfw left a comment

Add support for upgrading the CommandNotFound module #32766

Add support for upgrading the CommandNotFound module #32766

Conversation

carlos-zamora commented May 7, 2024 • edited

Summary of the Pull Request

Related Issues

PR Checklist

Validation Steps Performed

carlos-zamora commented May 7, 2024

snickler commented May 8, 2024

carlos-zamora commented May 8, 2024

jaimecbernardo commented May 9, 2024

jaimecbernardo commented May 9, 2024

jaimecbernardo May 9, 2024

Choose a reason for hiding this comment

jaimecbernardo commented May 9, 2024

snickler commented May 9, 2024 via email • edited by microsoft-github-policy-service bot

jaimecbernardo commented May 9, 2024

snickler commented May 9, 2024

jaimecbernardo commented May 10, 2024

carlos-zamora commented May 10, 2024

jaimecbernardo commented May 13, 2024

carlos-zamora commented May 13, 2024

This comment has been minimized.

jaimecbernardo commented May 14, 2024

carlos-zamora commented May 15, 2024

stefansjfw left a comment

Choose a reason for hiding this comment

carlos-zamora commented May 7, 2024 •

edited

snickler commented May 9, 2024 via email •

edited by microsoft-github-policy-service bot