Use WinGet API to improve Quick Fix results

[carlos-zamora]

Summary of the Pull Request

Improves Quick Fix's suggestions to use WinGet API and actually query winget for packages based on the missing command.

To interact with the WinGet API, we need the Microsoft.WindowsPackageManager.ComInterop NuGet package. Microsoft.WindowsPackageManager.ComInterop.Additional.targets is used to copy over the winmd into CascadiaPackage. The build variable TerminalWinGetInterop is used to import the package properly.

WindowsPackageManagerFactory is used as a centralized way to generate the winget objects. Long-term, we may need to do manual activation for elevated sessions, which this class can easily be extended to support. In the meantime, we'll just use the normal winrt::create_instance on all sessions.

In TerminalPage, we conduct the search asynchronously when a missing command was found. Search results are limited to 20 packages. We try to retrieve packages with the following filters set, then fallback into the next step:

1. PackageMatchField::Command, PackageFieldMatchOption::StartsWithCaseInsensitive
2. PackageMatchField::Name, PackageFieldMatchOption::ContainsCaseInsensitive
3. PackageMatchField::Moniker, PackageFieldMatchOption::ContainsCaseInsensitive

This aligns with the Microsoft.WinGet.CommandNotFound PowerShell module (link to relevant code).

Closes #17378
Closes #17631
Support for elevated sessions tracked in #17677

References

• https://github.com/microsoft/winget-cli/blob/master/src/Microsoft.Management.Deployment/PackageManager.idl: winget object documentation

Validation Steps Performed

• unelevated sessions --> winget query performed and presented
• elevated sessions --> nothing happens (got rid of winget install {} suggestion)

[carlos-zamora]

Now that we're adding --source, there's a greater chance that the string is too long. Unfortunately, we can't set the TextTrimming property on these MenuFlyoutItems, so I went ahead and did a workaround:

• suggestions UI: we get a text preview in the commandline, so I think we're fine here
• quick fix menu: I added a tooltip so the user can get the full string

It's annoying because we're just plain clipping the text and we can't configure it. Looks like the only way is to retemplate the MenuFlyout (or maybe retemplate the MenuFlyoutItem?).

Here's what it looks like:

I'll switch to the shorthand of --source and --id to help alleviate some issues, but regardless, this is definitely a case users may hit 🫤

[DHowett]

This hangs the UI pretty significantly while it's querying - gotta move that work off the main thread!

[lhecker]

This hangs the UI pretty significantly while it's querying - gotta move that work off the main thread!

It's already off the main thread, isn't it?

terminal/src/cascadia/TerminalApp/TerminalPage.cpp

Lines 3046 to 3053 in a0f2d88

	Windows::Foundation::IAsyncAction TerminalPage::_SearchMissingCommandHandler(const IInspectable /*sender*/, const Microsoft::Terminal::Control::SearchMissingCommandEventArgs args)
	{
	assert(!Dispatcher().HasThreadAccess());
	if (!Feature_QuickFix::IsEnabled())
	{
	co_return;
	}

If I'm correct about that, I think it's the console lock that's being held by the terminal during VT parsing. The UI thread tries to acquire the console lock regularly for info. In that case we just need to go to a different background thread instead, just not the VT parser one. 😅 (We could also add debouncing, but... eh. That may be too much for this limited purpose.)

[carlos-zamora]

Ah! We were on the ConptyConnection Output Thread.

[carlos-zamora]

The newest change now includes the bufferRow in the event args so that we can fix #17631. Unfortunately, we can't reliably get the position of the prompt. Instead, we'll be placing the button right by the error message (which we capture on the way up).

[zadjii-msft]

okay a minor thought: In 1.22 I added Description's to Commands. If the package catalog gives us a description, we could totally stick that in the teaching tip 👀

Similarly, IMO, we don't need --source winget in the Name of the Command. It's clearer to just say winget install Foo and have the rest of the args in the preview text (but that's just my opinion)

[zadjii-msft]

📝: weird to me that this isn't just in their nuget package

[JohnMcPMS]

We are working on improving this facet.

[zadjii-msft]

we need this for WindowsTerminal.exe in addition to TerminalApp? Is this cause the dependency doesn't get rolled up?

[carlos-zamora]

Correct. Just tested it without it. The QF menu won't appear.

[zadjii-msft]

📝: it's so gross that we have to write this ourselves

[JohnMcPMS]

Agreed, which is why the nuget package is soon going to include a DLL that handles this part (exposes the activation factory so that one can just use WinRT language projections as normal).

[carlos-zamora]

okay a minor thought: In 1.22 I added Description's to Commands. If the package catalog gives us a description, we could totally stick that in the teaching tip 👀

Similarly, IMO, we don't need --source winget in the Name of the Command. It's clearer to just say winget install Foo and have the rest of the args in the preview text (but that's just my opinion)

Opened #17755. I like the idea and it should be pretty straightforward to do, but it's a bit bigger of a change than I'd like for this PR.

[zadjii-msft]

whoops didn't ✅

[lhecker]

LGTM. I'd approve, but I'll wait a bit for you to read my comments. :)

[DHowett]

Let's go!