Use WinGet API to improve Quick Fix results

build/rules/Microsoft.WindowsPackageManager.ComInterop.Additional.targets

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. See LICENSE in the project root for license information. -->
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+ <PropertyGroup>
+ <Native-Platform Condition="'$(Platform)' == 'Win32'">x86</Native-Platform>
+ <Native-Platform Condition="'$(Platform)' != 'Win32'">$(Platform)</Native-Platform>
+ </PropertyGroup>
+ <ItemGroup>
+ <Reference Include="$(WinGetPackageRoot)\lib\Microsoft.Management.Deployment.winmd">
+ <IsWinMDFile>true</IsWinMDFile>
+ </Reference>
+ </ItemGroup>
+ <Target Name="_FixWinGetWinmdPackaging" BeforeTargets="_ComputeAppxPackagePayload">
+ <ItemGroup>
+ <PackagingOutputs Include="$(WinGetPackageRoot)\lib\Microsoft.Management.Deployment.winmd">
+ <OutputGroup>CustomOutputGroupForPackaging</OutputGroup>
+ <ProjectName>$(ProjectName)</ProjectName>
+ <TargetPath>Microsoft.Management.Deployment.winmd</TargetPath>
+ </PackagingOutputs>
+ </ItemGroup>
+ </Target>
+</Project>

dep/nuget/packages.config

@@ -10,6 +10,7 @@
  <package id="Microsoft.UI.Xaml" version="2.8.4" targetFramework="native" />
  <package id="Microsoft.Web.WebView2" version="1.0.1661.34" targetFramework="native" />
  <package id="Microsoft.Windows.ImplementationLibrary" version="1.0.240122.1" targetFramework="native" developmentDependency="true" />
+ <package id="Microsoft.WindowsPackageManager.ComInterop" version="1.8.1911" targetFramework="native" developmentDependency="true" />
 
  <!-- Managed packages -->
  <package id="Appium.WebDriver" version="3.0.0.2" targetFramework="net45" />

src/cascadia/TerminalApp/SuggestionsControl.cpp

@@ -722,6 +722,20 @@ namespace winrt::TerminalApp::implementation
  // ever allow non-sendInput actions.
  DispatchCommandRequested.raise(*this, actionPaletteItem.Command());
 
+ if (const auto& sendInputCmd = actionPaletteItem.Command().ActionAndArgs().Args().try_as<SendInputArgs>())
+ {
+ if (til::starts_with(sendInputCmd.Input(), L"winget"))
+ {
+ TraceLoggingWrite(
+ g_hTerminalAppProvider,
+ "QuickFixSuggestionUsed",
+ TraceLoggingDescription("Event emitted when a winget suggestion from is used"),
+ TraceLoggingValue("SuggestionsUI", "Source"),
+ TraceLoggingKeyword(MICROSOFT_KEYWORD_MEASURES),
+ TelemetryPrivacyDataTag(PDT_ProductAndServiceUsage));
+ }
+ }
+
  TraceLoggingWrite(
  g_hTerminalAppProvider, // handle to TerminalApp tracelogging provider
  "SuggestionsControlDispatchedAction",

src/cascadia/TerminalApp/TerminalAppLib.vcxproj

@@ -25,6 +25,7 @@
  <PropertyGroup Label="NuGet Dependencies">
  <TerminalCppWinrt>true</TerminalCppWinrt>
  <TerminalMUX>true</TerminalMUX>
+ <TerminalWinGetInterop>true</TerminalWinGetInterop>
  </PropertyGroup>
  <Import Project="..\..\..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" />
  <Import Project="$(OpenConsoleDir)src\common.nugetversions.props" />
@@ -177,6 +178,7 @@
  <ClInclude Include="SuggestionsControl.h">
  <DependentUpon>SuggestionsControl.xaml</DependentUpon>
  </ClInclude>
+ <ClInclude Include="WindowsPackageManagerFactory.h" />
  </ItemGroup>
  <!-- ========================= Cpp Files ======================== -->
  <ItemGroup>
@@ -361,7 +363,7 @@
  </Midl>
  <Midl Include="FilteredCommand.idl" />
  <Midl Include="IPaneContent.idl" />
- <Midl Include="TerminalPaneContent.idl" >
+ <Midl Include="TerminalPaneContent.idl">
  <DependentUpon>TaskPaneContent.xaml</DependentUpon>
  <SubType>Code</SubType>
  </Midl>

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -26,6 +26,7 @@
 #include "LaunchPositionRequest.g.cpp"
 
 using namespace winrt;
+using namespace winrt::Microsoft::Management::Deployment;
 using namespace winrt::Microsoft::Terminal::Control;
 using namespace winrt::Microsoft::Terminal::Settings::Model;
 using namespace winrt::Microsoft::Terminal::TerminalConnection;
@@ -1557,7 +1558,7 @@ namespace winrt::TerminalApp::implementation
  }
 
  // Let's assume the user has bound the dead key "^" to a sendInput command that sends "b".
- // If the user presses the two keys "^a" it'll produce "bâ", despite us marking the key event as handled.
+ // If the user presses the two keys "^a" it'll produce "bâ", despite us marking the key event as handled.
  // The following is used to manually "consume" such dead keys and clear them from the keyboard state.
  _ClearKeyboardState(vkey, scanCode);
  e.Handled(true);
@@ -3001,18 +3002,82 @@ namespace winrt::TerminalApp::implementation
  ShowWindowChanged.raise(*this, args);
  }
 
- winrt::fire_and_forget TerminalPage::_SearchMissingCommandHandler(const IInspectable /*sender*/, const Microsoft::Terminal::Control::SearchMissingCommandEventArgs args)
+ Windows::Foundation::IAsyncOperation<IVectorView<MatchResult>> TerminalPage::_FindPackageAsync(hstring query)
  {
- assert(!Dispatcher().HasThreadAccess());
+ const PackageManager packageManager = WindowsPackageManagerFactory::CreatePackageManager();
+ PackageCatalogReference catalogRef{
+ packageManager.GetPredefinedPackageCatalog(PredefinedPackageCatalog::OpenWindowsCatalog)
+ };
+ catalogRef.PackageCatalogBackgroundUpdateInterval(std::chrono::hours(24));
+
+ ConnectResult connectResult{ nullptr };
+ for (int retries = 0;;)
+ {
+ connectResult = catalogRef.Connect();
+ if (connectResult.Status() == ConnectResultStatus::Ok)
+ {
+ break;
+ }
+
+ if (++retries == 3)
+ {
+ co_return nullptr;
+ }
+ }
+
+ PackageCatalog catalog = connectResult.PackageCatalog();
+ // clang-format off
+ static constexpr std::array<WinGetSearchParams, 3> searches{ {
+ { .Field = PackageMatchField::Command, .MatchOption = PackageFieldMatchOption::StartsWithCaseInsensitive },
+ { .Field = PackageMatchField::Name, .MatchOption = PackageFieldMatchOption::ContainsCaseInsensitive },
+ { .Field = PackageMatchField::Moniker, .MatchOption = PackageFieldMatchOption::ContainsCaseInsensitive } } };
+ // clang-format on
+
+ PackageMatchFilter filter = WindowsPackageManagerFactory::CreatePackageMatchFilter();
+ filter.Value(query);
+
+ FindPackagesOptions options = WindowsPackageManagerFactory::CreateFindPackagesOptions();
+ options.Filters().Append(filter);
+ options.ResultLimit(20);
+
+ IVectorView<MatchResult> pkgList;
+ for (const auto& search : searches)
+ {
+ filter.Field(search.Field);
+ filter.Option(search.MatchOption);
 
+ const auto result = co_await catalog.FindPackagesAsync(options);
+ pkgList = result.Matches();
+ if (pkgList.Size() > 0)
+ {
+ break;
+ }
+ }
+ co_return pkgList;
+ }
+
+ Windows::Foundation::IAsyncAction TerminalPage::_SearchMissingCommandHandler(const IInspectable /*sender*/, const Microsoft::Terminal::Control::SearchMissingCommandEventArgs args)
+ {
  if (!Feature_QuickFix::IsEnabled())
  {
  co_return;
  }
+ co_await winrt::resume_background();
+
+ // no packages were found, nothing to suggest
+ const auto pkgList = co_await _FindPackageAsync(args.MissingCommand());
+ if (!pkgList || pkgList.Size() == 0)
+ {
+ co_return;
+ }
 
  std::vector<hstring> suggestions;
- suggestions.reserve(1);
- suggestions.emplace_back(fmt::format(FMT_COMPILE(L"winget install {}"), args.MissingCommand()));
+ suggestions.reserve(pkgList.Size());
+ for (const auto& pkg : pkgList)
+ {
+ // --id and --source ensure we don't collide with another package catalog
+ suggestions.emplace_back(fmt::format(FMT_COMPILE(L"winget install --id {} -s winget"), pkg.CatalogPackage().Id()));
+ }
 
  co_await wil::resume_foreground(Dispatcher());
 
@@ -5006,6 +5071,14 @@ namespace winrt::TerminalApp::implementation
  {
  ctrl.ClearQuickFix();
  }
+
+ TraceLoggingWrite(
+ g_hTerminalAppProvider,
+ "QuickFixSuggestionUsed",
+ TraceLoggingDescription("Event emitted when a winget suggestion from is used"),
+ TraceLoggingValue("QuickFixMenu", "Source"),
+ TraceLoggingKeyword(MICROSOFT_KEYWORD_MEASURES),
+ TelemetryPrivacyDataTag(PDT_ProductAndServiceUsage));
  }
  };
  };
@@ -5027,6 +5100,7 @@ namespace winrt::TerminalApp::implementation
 
  item.Text(qf);
  item.Click(makeCallback(qf));
+ ToolTipService::SetToolTip(item, box_value(qf));
  menu.Items().Append(item);
  }
  }

src/cascadia/TerminalApp/TerminalPage.h

@@ -13,6 +13,8 @@
 #include "LaunchPositionRequest.g.h"
 #include "Toast.h"
 
+#include "WindowsPackageManagerFactory.h"
+
 #define DECLARE_ACTION_HANDLER(action) void _Handle##action(const IInspectable& sender, const Microsoft::Terminal::Settings::Model::ActionEventArgs& args);
 
 namespace TerminalAppLocalTests
@@ -87,6 +89,12 @@ namespace winrt::TerminalApp::implementation
  til::property<winrt::Microsoft::Terminal::Settings::Model::LaunchPosition> Position;
  };
 
+ struct WinGetSearchParams
+ {
+ winrt::Microsoft::Management::Deployment::PackageMatchField Field;
+ winrt::Microsoft::Management::Deployment::PackageFieldMatchOption MatchOption;
+ };
+
  struct TerminalPage : TerminalPageT<TerminalPage>
  {
  public:
@@ -530,7 +538,8 @@ namespace winrt::TerminalApp::implementation
  void _OpenSuggestions(const Microsoft::Terminal::Control::TermControl& sender, Windows::Foundation::Collections::IVector<winrt::Microsoft::Terminal::Settings::Model::Command> commandsCollection, winrt::TerminalApp::SuggestionsMode mode, winrt::hstring filterText);
 
  void _ShowWindowChangedHandler(const IInspectable sender, const winrt::Microsoft::Terminal::Control::ShowWindowArgs args);
- winrt::fire_and_forget _SearchMissingCommandHandler(const IInspectable sender, const winrt::Microsoft::Terminal::Control::SearchMissingCommandEventArgs args);
+ Windows::Foundation::IAsyncAction _SearchMissingCommandHandler(const IInspectable sender, const winrt::Microsoft::Terminal::Control::SearchMissingCommandEventArgs args);
+ Windows::Foundation::IAsyncOperation<Windows::Foundation::Collections::IVectorView<winrt::Microsoft::Management::Deployment::MatchResult>> _FindPackageAsync(hstring query);
 
  winrt::fire_and_forget _windowPropertyChanged(const IInspectable& sender, const winrt::Windows::UI::Xaml::Data::PropertyChangedEventArgs& args);
 

src/cascadia/TerminalApp/WindowsPackageManagerFactory.h

@@ -0,0 +1,61 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+//
+// Module Name:
+// - WindowsPackageManagerFactory.h
+//
+// Abstract:
+// - This factory is designed to create production-level instances of WinGet objects.
+// Elevated sessions require manual activation of WinGet objects and are not currently supported,
+// while non-elevated sessions can use the standard WinRT activation system.
+// Author:
+// - Carlos Zamora (carlos-zamora) 23-Jul-2024
+
+#pragma once
+
+#include <winrt/Microsoft.Management.Deployment.h>
+
+namespace winrt::TerminalApp::implementation
+{
+ struct WindowsPackageManagerFactory
+ {
+ public:
+ static winrt::Microsoft::Management::Deployment::PackageManager CreatePackageManager()
+ {
+ return winrt::create_instance<winrt::Microsoft::Management::Deployment::PackageManager>(PackageManagerGuid, CLSCTX_ALL);
+ }
+
+ static winrt::Microsoft::Management::Deployment::FindPackagesOptions CreateFindPackagesOptions()
+ {
+ return winrt::create_instance<winrt::Microsoft::Management::Deployment::FindPackagesOptions>(FindPackageOptionsGuid, CLSCTX_ALL);
+ }
+
+ static winrt::Microsoft::Management::Deployment::CreateCompositePackageCatalogOptions CreateCreateCompositePackageCatalogOptions()
+ {
+ return winrt::create_instance<winrt::Microsoft::Management::Deployment::CreateCompositePackageCatalogOptions>(CreateCompositePackageCatalogOptionsGuid, CLSCTX_ALL);
+ }
+
+ static winrt::Microsoft::Management::Deployment::InstallOptions CreateInstallOptions()
+ {
+ return winrt::create_instance<winrt::Microsoft::Management::Deployment::InstallOptions>(InstallOptionsGuid, CLSCTX_ALL);
+ }
+
+ static winrt::Microsoft::Management::Deployment::UninstallOptions CreateUninstallOptions()
+ {
+ return winrt::create_instance<winrt::Microsoft::Management::Deployment::UninstallOptions>(UninstallOptionsGuid, CLSCTX_ALL);
+ }
+
+ static winrt::Microsoft::Management::Deployment::PackageMatchFilter CreatePackageMatchFilter()
+ {
+ return winrt::create_instance<winrt::Microsoft::Management::Deployment::PackageMatchFilter>(PackageMatchFilterGuid, CLSCTX_ALL);
+ }
+
+ private:
+ static constexpr winrt::guid PackageManagerGuid{ 0xC53A4F16, 0x787E, 0x42A4, { 0xB3, 0x04, 0x29, 0xEF, 0xFB, 0x4B, 0xF5, 0x97 } };
+ static constexpr winrt::guid FindPackageOptionsGuid{ 0x572DED96, 0x9C60, 0x4526, { 0x8F, 0x92, 0xEE, 0x7D, 0x91, 0xD3, 0x8C, 0x1A } };
+ static constexpr winrt::guid CreateCompositePackageCatalogOptionsGuid{ 0x526534B8, 0x7E46, 0x47C8, { 0x84, 0x16, 0xB1, 0x68, 0x5C, 0x32, 0x7D, 0x37 } };
+ static constexpr winrt::guid InstallOptionsGuid{ 0x1095F097, 0xEB96, 0x453B, { 0xB4, 0xE6, 0x16, 0x13, 0x63, 0x7F, 0x3B, 0x14 } };
+ static constexpr winrt::guid UninstallOptionsGuid{ 0xE1D9A11E, 0x9F85, 0x4D87, { 0x9C, 0x17, 0x2B, 0x93, 0x14, 0x3A, 0xDB, 0x8D } };
+ static constexpr winrt::guid PackageMatchFilterGuid{ 0xD02C9DAF, 0x99DC, 0x429C, { 0xB5, 0x03, 0x4E, 0x50, 0x4E, 0x4A, 0xB0, 0x00 } };
+ };
+}

src/cascadia/TerminalControl/ControlCore.cpp

@@ -128,7 +128,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
  auto pfnCompletionsChanged = [=](auto&& menuJson, auto&& replaceLength) { _terminalCompletionsChanged(menuJson, replaceLength); };
  _terminal->CompletionsChangedCallback(pfnCompletionsChanged);
 
- auto pfnSearchMissingCommand = [this](auto&& PH1) { _terminalSearchMissingCommand(std::forward<decltype(PH1)>(PH1)); };
+ auto pfnSearchMissingCommand = [this](auto&& PH1, auto&& PH2) { _terminalSearchMissingCommand(std::forward<decltype(PH1)>(PH1), std::forward<decltype(PH2)>(PH2)); };
  _terminal->SetSearchMissingCommandCallback(pfnSearchMissingCommand);
 
  auto pfnClearQuickFix = [this] { ClearQuickFix(); };
@@ -1633,9 +1633,9 @@ namespace winrt::Microsoft::Terminal::Control::implementation
  _midiAudio.PlayNote(reinterpret_cast<HWND>(_owningHwnd), noteNumber, velocity, std::chrono::duration_cast<std::chrono::milliseconds>(duration));
  }
 
- void ControlCore::_terminalSearchMissingCommand(std::wstring_view missingCommand)
+ void ControlCore::_terminalSearchMissingCommand(std::wstring_view missingCommand, const til::CoordType& bufferRow)
  {
- SearchMissingCommand.raise(*this, make<implementation::SearchMissingCommandEventArgs>(hstring{ missingCommand }));
+ SearchMissingCommand.raise(*this, make<implementation::SearchMissingCommandEventArgs>(hstring{ missingCommand }, bufferRow));
  }
 
  void ControlCore::ClearQuickFix()

src/cascadia/TerminalControl/ControlCore.h

@@ -389,7 +389,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
  void _terminalPlayMidiNote(const int noteNumber,
  const int velocity,
  const std::chrono::microseconds duration);
- void _terminalSearchMissingCommand(std::wstring_view missingCommand);
+ void _terminalSearchMissingCommand(std::wstring_view missingCommand, const til::CoordType& bufferRow);
 
  winrt::fire_and_forget _terminalCompletionsChanged(std::wstring_view menuJson, unsigned int replaceLength);
 

src/cascadia/TerminalControl/EventArgs.h

@@ -216,10 +216,12 @@ namespace winrt::Microsoft::Terminal::Control::implementation
  struct SearchMissingCommandEventArgs : public SearchMissingCommandEventArgsT<SearchMissingCommandEventArgs>
  {
  public:
- SearchMissingCommandEventArgs(const winrt::hstring& missingCommand) :
- MissingCommand(missingCommand) {}
+ SearchMissingCommandEventArgs(const winrt::hstring& missingCommand, const til::CoordType& bufferRow) :
+ MissingCommand(missingCommand),
+ BufferRow(bufferRow) {}
 
  til::property<winrt::hstring> MissingCommand;
+ til::property<til::CoordType> BufferRow;
  };
 }
 

src/cascadia/TerminalControl/EventArgs.idl

@@ -130,5 +130,6 @@ namespace Microsoft.Terminal.Control
  runtimeclass SearchMissingCommandEventArgs
  {
  String MissingCommand { get; };
+ Int32 BufferRow { get; };
  }
 }

src/cascadia/TerminalControl/TermControl.cpp

@@ -4033,18 +4033,17 @@ namespace winrt::Microsoft::Terminal::Control::implementation
  const auto rd = get_self<ControlCore>(_core)->GetRenderData();
  rd->LockConsole();
  const auto viewportBufferPosition = rd->GetViewport();
- const auto cursorBufferPosition = rd->GetCursorPosition();
  rd->UnlockConsole();
- if (cursorBufferPosition.y < viewportBufferPosition.Top() || cursorBufferPosition.y > viewportBufferPosition.BottomInclusive())
+ if (_quickFixBufferPos < viewportBufferPosition.Top() || _quickFixBufferPos > viewportBufferPosition.BottomInclusive())
  {
  quickFixBtn.Visibility(Visibility::Collapsed);
  return;
  }
 
  // draw the button in the gutter
- const auto& cursorPosInDips = CursorPositionInDips();
+ const auto& quickFixBtnPosInDips = _toPosInDips({ 0, _quickFixBufferPos });
  Controls::Canvas::SetLeft(quickFixBtn, -termPadding.Left);
- Controls::Canvas::SetTop(quickFixBtn, cursorPosInDips.Y - termPadding.Top);
+ Controls::Canvas::SetTop(quickFixBtn, quickFixBtnPosInDips.y - termPadding.Top);
  quickFixBtn.Visibility(Visibility::Visible);
 
  if (auto automationPeer{ FrameworkElementAutomationPeer::FromElement(*this) })
@@ -4059,6 +4058,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
 
  void TermControl::_bubbleSearchMissingCommand(const IInspectable& /*sender*/, const Control::SearchMissingCommandEventArgs& args)
  {
+ _quickFixBufferPos = args.BufferRow();
  SearchMissingCommand.raise(*this, args);
  }
 

src/cascadia/TerminalControl/TermControl.h

@@ -270,6 +270,7 @@ namespace winrt::Microsoft::Terminal::Control::implementation
  bool _initializedTerminal{ false };
  bool _quickFixButtonCollapsible{ false };
  bool _quickFixesAvailable{ false };
+ til::CoordType _quickFixBufferPos{};
 
  std::shared_ptr<ThrottledFuncLeading> _playWarningBell;
 

src/cascadia/TerminalCore/Terminal.cpp

@@ -1231,7 +1231,7 @@ void Microsoft::Terminal::Core::Terminal::CompletionsChangedCallback(std::functi
  _pfnCompletionsChanged.swap(pfn);
 }
 
-void Microsoft::Terminal::Core::Terminal::SetSearchMissingCommandCallback(std::function<void(std::wstring_view)> pfn) noexcept
+void Microsoft::Terminal::Core::Terminal::SetSearchMissingCommandCallback(std::function<void(std::wstring_view, const til::CoordType)> pfn) noexcept
 {
  _pfnSearchMissingCommand.swap(pfn);
 }