Use feature markers during terminal-by-default handoff

.github/actions/spelling/expect/expect.txt

@@ -1082,6 +1082,7 @@ ICore
 IData
 IDCANCEL
 IDD
+IDefault
 IDesktop
 IDevice
 IDictionary

src/cascadia/CascadiaPackage/Package-Dev.appxmanifest

@@ -100,6 +100,7 @@
                 <com:ProxyStub Id="DEC4804D-56D1-4F73-9FBE-6828E7C85C56" DisplayName="OpenConsoleHandoffProxy" Path="OpenConsoleProxy.dll"/>
                 <com:Interface Id="E686C757-9A35-4A1C-B3CE-0BCC8B5C69F4" ProxyStubClsid="DEC4804D-56D1-4F73-9FBE-6828E7C85C56"/>
                 <com:Interface Id="59D55CCE-FC8A-48B4-ACE8-0A9286C6557F" ProxyStubClsid="DEC4804D-56D1-4F73-9FBE-6828E7C85C56"/>
+                <com:Interface Id="746E6BC0-AB05-4E38-AB14-71E86763141F" ProxyStubClsid="DEC4804D-56D1-4F73-9FBE-6828E7C85C56"/>
             </com:ComInterface>
         </com:Extension>
         <com:Extension Category="windows.comServer">

src/cascadia/CascadiaPackage/Package-Pre.appxmanifest

@@ -189,6 +189,7 @@
                 <com:ProxyStub Id="1833E661-CC81-4DD0-87C6-C2F74BD39EFA" DisplayName="OpenConsoleHandoffProxy" Path="OpenConsoleProxy.dll"/>
                 <com:Interface Id="E686C757-9A35-4A1C-B3CE-0BCC8B5C69F4" ProxyStubClsid="1833E661-CC81-4DD0-87C6-C2F74BD39EFA"/>
                 <com:Interface Id="59D55CCE-FC8A-48B4-ACE8-0A9286C6557F" ProxyStubClsid="1833E661-CC81-4DD0-87C6-C2F74BD39EFA"/>
+                <com:Interface Id="746E6BC0-AB05-4E38-AB14-71E86763141F" ProxyStubClsid="1833E661-CC81-4DD0-87C6-C2F74BD39EFA"/>
             </com:ComInterface>
         </com:Extension>
         <com:Extension Category="windows.comServer">

src/cascadia/CascadiaPackage/Package.appxmanifest

@@ -189,6 +189,7 @@
                 <com:ProxyStub Id="3171DE52-6EFA-4AEF-8A9F-D02BD67E7A4F" DisplayName="OpenConsoleHandoffProxy" Path="OpenConsoleProxy.dll"/>
                 <com:Interface Id="E686C757-9A35-4A1C-B3CE-0BCC8B5C69F4" ProxyStubClsid="3171DE52-6EFA-4AEF-8A9F-D02BD67E7A4F"/>
                 <com:Interface Id="59D55CCE-FC8A-48B4-ACE8-0A9286C6557F" ProxyStubClsid="3171DE52-6EFA-4AEF-8A9F-D02BD67E7A4F"/>
+                <com:Interface Id="746E6BC0-AB05-4E38-AB14-71E86763141F" ProxyStubClsid="3171DE52-6EFA-4AEF-8A9F-D02BD67E7A4F"/>
             </com:ComInterface>
         </com:Extension>
         <com:Extension Category="windows.comServer">

src/cascadia/TerminalSettingsEditor/Launch.xaml

@@ -93,7 +93,7 @@
 
                                     <Grid.RowDefinitions>
                                         <!--  profile name  -->
-                                        <RowDefinition Height="*" />
+                                        <RowDefinition Height="20" />
                                         <!--  author and version  -->
                                         <RowDefinition Height="*" />
                                     </Grid.RowDefinitions>
@@ -109,20 +109,25 @@
                                     <TextBlock Grid.Row="0"
                                                Grid.Column="1"
                                                Grid.ColumnSpan="2"
+                                               Height="20"
                                                AutomationProperties.AccessibilityView="Raw"
                                                Text="{x:Bind Name}" />
 
                                     <TextBlock Grid.Row="1"
                                                Grid.Column="1"
+                                               Height="20"
                                                AutomationProperties.AccessibilityView="Raw"
                                                Style="{ThemeResource SecondaryTextBlockStyle}"
-                                               Text="{x:Bind Author}" />
+                                               Text="{x:Bind Author}"
+                                               Visibility="{x:Bind local:Converters.StringNotEmptyToVisibility(Author)}" />
 
                                     <TextBlock Grid.Row="1"
                                                Grid.Column="2"
+                                               Height="20"
                                                AutomationProperties.AccessibilityView="Raw"
                                                Style="{ThemeResource SecondaryTextBlockStyle}"
-                                               Text="{x:Bind Version}" />
+                                               Text="{x:Bind Version}"
+                                               Visibility="{x:Bind local:Converters.StringNotEmptyToVisibility(Version)}" />
 
                                 </Grid>
                             </DataTemplate>

src/cascadia/TerminalSettingsModel/CascadiaSettings.cpp

@@ -14,6 +14,7 @@
 
 #include <shellapi.h>
 #include <shlwapi.h>
+#include <til/latch.h>
 
 using namespace winrt::Microsoft::Terminal;
 using namespace winrt::Microsoft::Terminal::Settings;
@@ -1120,12 +1121,27 @@ void CascadiaSettings::CurrentDefaultTerminal(const Model::DefaultTerminal& term
 // but in the future it might be worthwhile to change the code to use list indices instead.
 void CascadiaSettings::_refreshDefaultTerminals()
 {
-    if (!_defaultTerminals)
+    if (_defaultTerminals)
     {
-        auto [defaultTerminals, defaultTerminal] = DefaultTerminal::Available();
-        _defaultTerminals = winrt::single_threaded_observable_vector(std::move(defaultTerminals));
-        _currentDefaultTerminal = std::move(defaultTerminal);
+        return;
     }
+
+    // This is an extract of extractValueFromTaskWithoutMainThreadAwait
+    // as DefaultTerminal::Available creates the exact same issue.
+    std::pair<std::vector<Model::DefaultTerminal>, Model::DefaultTerminal> result{ {}, nullptr };
+    til::latch latch{ 1 };
+
+    std::ignore = [&]() -> winrt::fire_and_forget {
+        const auto cleanup = wil::scope_exit([&]() {
+            latch.count_down();
+        });
+        co_await winrt::resume_background();
+        result = DefaultTerminal::Available();
+    }();
+
+    latch.wait();
+    _defaultTerminals = winrt::single_threaded_observable_vector(std::move(result.first));
+    _currentDefaultTerminal = std::move(result.second);
 }
 
 void CascadiaSettings::ExportFile(winrt::hstring path, winrt::hstring content)

src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp

@@ -61,9 +61,11 @@ static auto extractValueFromTaskWithoutMainThreadAwait(TTask&& task) -> decltype
     til::latch latch{ 1 };
 
     const auto _ = [&]() -> winrt::fire_and_forget {
+        const auto cleanup = wil::scope_exit([&]() {
+            latch.count_down();
+        });
         co_await winrt::resume_background();
         finalVal.emplace(co_await task);
-        latch.count_down();
     }();
 
     latch.wait();

src/cascadia/TerminalSettingsModel/DefaultTerminal.cpp

@@ -17,13 +17,21 @@ DefaultTerminal::DefaultTerminal(DelegationConfig::DelegationPackage&& pkg) :
 
 winrt::hstring DefaultTerminal::Name() const
 {
-    return _pkg.terminal.name.empty() ? winrt::hstring{ RS_(L"InboxWindowsConsoleName") } : winrt::hstring{ _pkg.terminal.name };
+    switch (_pkg.pair.kind)
+    {
+    case DelegationConfig::DelegationPairKind::Default:
+        return RS_(L"DefaultWindowsConsoleName");
+    case DelegationConfig::DelegationPairKind::Conhost:
+        return RS_(L"InboxWindowsConsoleName");
+    default:
+        return winrt::hstring{ _pkg.info.name };
+    }
 }
 
 winrt::hstring DefaultTerminal::Version() const
 {
     // If there's no version information... return empty string instead.
-    const auto& version = _pkg.terminal.version;
+    const auto& version = _pkg.info.version;
     if (DelegationConfig::PkgVersion{} == version)
     {
         return winrt::hstring{};
@@ -36,12 +44,20 @@ winrt::hstring DefaultTerminal::Version() const
 
 winrt::hstring DefaultTerminal::Author() const
 {
-    return _pkg.terminal.author.empty() ? winrt::hstring{ RS_(L"InboxWindowsConsoleAuthor") } : winrt::hstring{ _pkg.terminal.author };
+    switch (_pkg.pair.kind)
+    {
+    case DelegationConfig::DelegationPairKind::Default:
+        return {}; // The "Let Windows decide" option has no author.
+    case DelegationConfig::DelegationPairKind::Conhost:
+        return RS_(L"InboxWindowsConsoleAuthor");
+    default:
+        return winrt::hstring{ _pkg.info.author };
+    }
 }
 
 winrt::hstring DefaultTerminal::Icon() const
 {
-    return _pkg.terminal.logo.empty() ? winrt::hstring{ L"\uE756" } : winrt::hstring{ _pkg.terminal.logo };
+    return _pkg.info.logo.empty() ? winrt::hstring{ L"\uE756" } : winrt::hstring{ _pkg.info.logo };
 }
 
 std::pair<std::vector<Model::DefaultTerminal>, Model::DefaultTerminal> DefaultTerminal::Available()
@@ -76,11 +92,9 @@ std::pair<std::vector<Model::DefaultTerminal>, Model::DefaultTerminal> DefaultTe
 bool DefaultTerminal::HasCurrent()
 {
     std::vector<DelegationConfig::DelegationPackage> allPackages;
-    DelegationConfig::DelegationPackage currentPackage;
+    DelegationConfig::DelegationPackage currentPackage{ DelegationConfig::DefaultDelegationPair };
     LOG_IF_FAILED(DelegationConfig::s_GetAvailablePackages(allPackages, currentPackage));
-
-    // Good old conhost has a hardcoded GUID of {00000000-0000-0000-0000-000000000000}.
-    return currentPackage.terminal.clsid != CLSID{};
+    return !currentPackage.pair.IsDefault();
 }
 
 void DefaultTerminal::Current(const Model::DefaultTerminal& term)

src/cascadia/TerminalSettingsModel/Resources/en-US/Resources.resw

@@ -493,6 +493,10 @@
     <value>Clear scrollback</value>
     <comment>A command to clear the part of the buffer above the viewport</comment>
   </data>
+  <data name="DefaultWindowsConsoleName" xml:space="preserve">
+    <value>Let Windows decide</value>
+    <comment>This is the default option if a user doesn't choose to override Microsoft's choice of a Terminal.</comment>
+  </data>
   <data name="InboxWindowsConsoleAuthor" xml:space="preserve">
     <value>Microsoft Corporation</value>
     <comment>Paired with `InboxWindowsConsoleName`, this is the application author... which is us: Microsoft.</comment>

src/host/exe/CConsoleHandoff.h

@@ -29,7 +29,7 @@ Author(s):
 using namespace Microsoft::WRL;
 
 struct __declspec(uuid(__CLSID_CConsoleHandoff))
-    CConsoleHandoff : public RuntimeClass<RuntimeClassFlags<ClassicCom>, IConsoleHandoff>
+    CConsoleHandoff : public RuntimeClass<RuntimeClassFlags<ClassicCom>, IConsoleHandoff, IDefaultTerminalMarker>
 {
 #pragma region IConsoleHandoff
     STDMETHODIMP EstablishHandoff(HANDLE server,

src/host/exe/exemain.cpp

@@ -265,8 +265,7 @@ int CALLBACK wWinMain(
     {
         // Only try to register as a handoff target if we are NOT a part of Windows.
 #if TIL_FEATURE_RECEIVEINCOMINGHANDOFF_ENABLED
-        auto defAppEnabled = false;
-        if (args.ShouldRunAsComServer() && SUCCEEDED(Microsoft::Console::Internal::DefaultApp::CheckDefaultAppPolicy(defAppEnabled)) && defAppEnabled)
+        if (args.ShouldRunAsComServer() && Microsoft::Console::Internal::DefaultApp::CheckDefaultAppPolicy())
         {
             try
             {

src/host/globals.h

@@ -22,8 +22,8 @@ Revision History:
 #include "ConsoleArguments.hpp"
 #include "ApiRoutines.h"
 
+#include "../propslib/DelegationConfig.hpp"
 #include "../renderer/base/Renderer.hpp"
-
 #include "../server/DeviceComm.h"
 #include "../server/ConDrvDeviceComm.h"
 
@@ -71,10 +71,10 @@ class Globals
 
     bool handoffTarget = false;
 
-    std::optional<CLSID> handoffConsoleClsid;
-    std::optional<CLSID> handoffTerminalClsid;
+    DelegationConfig::DelegationPair delegationPair;
     wil::unique_hfile handoffInboxConsoleHandle;
     wil::unique_threadpool_wait handoffInboxConsoleExitWait;
+    bool defaultTerminalMarkerCheckRequired = false;
 
 #ifdef UNIT_TESTING
     void EnableConptyModeForTests(std::unique_ptr<Microsoft::Console::Render::VtEngine> vtRenderEngine);

src/host/proxy/IConsoleHandoff.idl

@@ -31,3 +31,9 @@ typedef const CONSOLE_PORTABLE_ATTACH_MSG* PCCONSOLE_PORTABLE_ATTACH_MSG;
                              [out, system_handle(sh_process)] HANDLE* process);
 };
 
+[
+    object,
+    uuid(746E6BC0-AB05-4E38-AB14-71E86763141F)
+] interface IDefaultTerminalMarker : IUnknown
+{
+};

src/host/srvinit.cpp

@@ -26,7 +26,6 @@
 #include "../renderer/base/renderer.hpp"
 
 #include "../inc/conint.h"
-#include "../propslib/DelegationConfig.hpp"
 
 #include "tracing.hpp"
 
@@ -64,28 +63,28 @@ try
 
     // Check if this conhost is allowed to delegate its activities to another.
     // If so, look up the registered default console handler.
-    auto isEnabled = false;
-    if (SUCCEEDED(Microsoft::Console::Internal::DefaultApp::CheckDefaultAppPolicy(isEnabled)) && isEnabled)
+    if (Globals.delegationPair.IsUndecided() && Microsoft::Console::Internal::DefaultApp::CheckDefaultAppPolicy())
     {
-        IID delegationClsid;
-        if (SUCCEEDED(DelegationConfig::s_GetDefaultConsoleId(delegationClsid)))
-        {
-            Globals.handoffConsoleClsid = delegationClsid;
-            TraceLoggingWrite(g_hConhostV2EventTraceProvider,
-                              "SrvInit_FoundDelegationConsole",
-                              TraceLoggingGuid(Globals.handoffConsoleClsid.value(), "ConsoleClsid"),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
-                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
-        }
-        if (SUCCEEDED(DelegationConfig::s_GetDefaultTerminalId(delegationClsid)))
-        {
-            Globals.handoffTerminalClsid = delegationClsid;
-            TraceLoggingWrite(g_hConhostV2EventTraceProvider,
-                              "SrvInit_FoundDelegationTerminal",
-                              TraceLoggingGuid(Globals.handoffTerminalClsid.value(), "TerminalClsid"),
-                              TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
-                              TraceLoggingKeyword(TIL_KEYWORD_TRACE));
-        }
+        Globals.delegationPair = DelegationConfig::s_GetDelegationPair();
+
+        TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                          "SrvInit_FoundDelegationConsole",
+                          TraceLoggingGuid(Globals.delegationPair.console, "ConsoleClsid"),
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+        TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                          "SrvInit_FoundDelegationTerminal",
+                          TraceLoggingGuid(Globals.delegationPair.terminal, "TerminalClsid"),
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+    }
+    // If we looked up the registered defterm pair, and it was left as the default (missing or {0}),
+    // AND velocity is enabled for DxD, then we switch the delegation pair to Terminal and
+    // mark that we should check that class for the marker interface later.
+    if (Globals.delegationPair.IsDefault() && Microsoft::Console::Internal::DefaultApp::CheckShouldTerminalBeDefault())
+    {
+        Globals.delegationPair = DelegationConfig::TerminalDelegationPair;
+        Globals.defaultTerminalMarkerCheckRequired = true;
     }
 
     // Create the accessibility notifier early in the startup process.
@@ -427,28 +426,18 @@ try
     auto& g = ServiceLocator::LocateGlobals();
     g.handoffTarget = true;
 
-    IID delegationClsid;
-    if (SUCCEEDED(DelegationConfig::s_GetDefaultConsoleId(delegationClsid)))
-    {
-        g.handoffConsoleClsid = delegationClsid;
-    }
-    if (SUCCEEDED(DelegationConfig::s_GetDefaultTerminalId(delegationClsid)))
-    {
-        g.handoffTerminalClsid = delegationClsid;
-    }
-
-    if (!g.handoffTerminalClsid)
+    g.delegationPair = DelegationConfig::s_GetDelegationPair();
+    // We've been handed off to (we're OpenConsole, not conhost).
+    // If we get here and there's not a custom defterm set, then it must be because
+    // conhost defaulted to us for DxD. Set up Terminal as the thing to handoff too.
+    if (!g.delegationPair.IsCustom())
     {
-        TraceLoggingWrite(g_hConhostV2EventTraceProvider,
-                          "SrvInit_ReceiveHandoff_NoTerminal",
-                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
-                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
-        return E_NOT_SET;
+        g.delegationPair = DelegationConfig::TerminalDelegationPair;
     }
 
     TraceLoggingWrite(g_hConhostV2EventTraceProvider,
                       "SrvInit_ReceiveHandoff",
-                      TraceLoggingGuid(g.handoffTerminalClsid.value(), "TerminalClsid"),
+                      TraceLoggingGuid(g.delegationPair.terminal, "TerminalClsid"),
                       TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
                       TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
@@ -509,14 +498,14 @@ try
 
     TraceLoggingWrite(g_hConhostV2EventTraceProvider,
                       "SrvInit_PrepareToCreateDelegationTerminal",
-                      TraceLoggingGuid(g.handoffTerminalClsid.value(), "TerminalClsid"),
+                      TraceLoggingGuid(g.delegationPair.terminal, "TerminalClsid"),
                       TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
                       TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
-    RETURN_IF_FAILED(CoCreateInstance(g.handoffTerminalClsid.value(), nullptr, CLSCTX_LOCAL_SERVER, IID_PPV_ARGS(&handoff)));
+    RETURN_IF_FAILED(CoCreateInstance(g.delegationPair.terminal, nullptr, CLSCTX_LOCAL_SERVER, IID_PPV_ARGS(&handoff)));
     TraceLoggingWrite(g_hConhostV2EventTraceProvider,
                       "SrvInit_CreatedDelegationTerminal",
-                      TraceLoggingGuid(g.handoffTerminalClsid.value(), "TerminalClsid"),
+                      TraceLoggingGuid(g.delegationPair.terminal, "TerminalClsid"),
                       TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
                       TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 

src/inc/conint.h

@@ -47,7 +47,7 @@ namespace Microsoft::Console::Internal
 
     namespace DefaultApp
     {
-        [[nodiscard]] HRESULT CheckDefaultAppPolicy(bool& isEnabled) noexcept;
-        [[nodiscard]] HRESULT CheckShouldTerminalBeDefault(bool& isEnabled) noexcept;
+        [[nodiscard]] bool CheckDefaultAppPolicy() noexcept;
+        [[nodiscard]] bool CheckShouldTerminalBeDefault() noexcept;
     }
 }

src/internal/stubs.cpp

@@ -30,19 +30,17 @@ void EdpPolicy::AuditClipboard(const std::wstring_view /*destinationName*/) noex
     return S_FALSE;
 }
 
-[[nodiscard]] HRESULT DefaultApp::CheckDefaultAppPolicy(bool& isEnabled) noexcept
+[[nodiscard]] bool DefaultApp::CheckDefaultAppPolicy() noexcept
 {
     // True so propsheet will show configuration options but be sure that
     // the open one won't attempt handoff from double click of OpenConsole.exe
-    isEnabled = true;
-    return S_OK;
+    return true;
 }
 
-[[nodiscard]] HRESULT DefaultApp::CheckShouldTerminalBeDefault(bool& isEnabled) noexcept
+[[nodiscard]] bool DefaultApp::CheckShouldTerminalBeDefault() noexcept
 {
     // False since setting Terminal as the default app is an OS feature and probably
     // should not be done in the open source conhost. We can always decide to turn it
     // on in the future though.
-    isEnabled = false;
-    return S_OK;
+    return false;
 }