update this a bit more

doc/terminal-v2-roadmap.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This document outlines the roadmap towards delivering Windows Terminal 2.0 by Winter 2021.
+This document outlines the roadmap towards delivering Windows Terminal 2.0.
 
 ## Milestones
 
@@ -32,8 +32,8 @@ Below is the schedule for when milestones will be included in release builds of
 | 2021-07-14 | [1.10] in Windows Terminal Preview<br>[1.9] in Windows Terminal | [Windows Terminal Preview 1.10 Release](https://devblogs.microsoft.com/commandline/windows-terminal-preview-1-10-release/) |
 | 2021-08-31 | [1.11] in Windows Terminal Preview<br>[1.10] in Windows Terminal | [Windows Terminal Preview 1.11 Release](https://devblogs.microsoft.com/commandline/windows-terminal-preview-1-11-release/) |
 | 2021-10-31 | 1.12 in Windows Terminal Preview<br>1.11 in Windows Terminal | |
-| 2021-11-30 | 2.0 RC in Windows Terminal Preview<br>2.0 RC in Windows Terminal | |
-| 2021-12-31 | [2.0] in Windows Terminal Preview<br>[2.0] in Windows Terminal | |
+|  | 2.0 RC in Windows Terminal Preview<br>2.0 RC in Windows Terminal | |
+|  | [2.0] in Windows Terminal Preview<br>[2.0] in Windows Terminal | |
 
 ## Issue Triage & Prioritization
 
@@ -49,28 +49,32 @@ The following are a list of the key scenarios we're aiming to deliver for Termin
 
 > 👉 Note: There are many other features that don't fit within 2.0, but will be re-assessed and prioritized for 3.0, the plan for which will be published in 2021.
 
-| Priority\* | Scenario | Description/Notes |
-| ---------- | -------- | ----------------- |
-| 0 | Settings UI | A user interface that connects to settings.json. This provides a way for people to edit their settings without having to edit a JSON file.<br><br>Issue: [#1564]<br>Specs: [#6720], [#6904]<br>Implementation: [#7283], [#7370], [#8048] |
-| 0 | Command palette | A popup menu to list possible actions and commands.<br><br>Issues: [#5400], [#2046]<br>Spec: [#2193]<br>Implementation: [#6635] |
-| 1 | Tab tear-off | The ability to tear a tab out of the current window and spawn a new window or attach it to a separate window.<br><br>Issue: [#1256], [#5000]<br>Spec: [#2080], [#7240] |
-| 1 | Clickable links | Hyperlinking any links that appear in the text buffer. When clicking on the link, the link will open in your default browser.<br><br>Issue: [#574]<br>Implementation: [#7251] |
-| 1 | Default terminal | If a command-line application is spawned, it should open in Windows Terminal (if installed) or your preferred terminal<br><br>Issue: [#492]<br>Spec: [#2080], [#7414] |
-| 1 | Overall theme support | Tab coloring, title bar coloring, pane border coloring, pane border width, definition of what makes a theme<br><br>Issue: [#3327]<br>Spec: [#5772] |
-| 1 | Open profile elevated | Configure profiles to always open elevated (if Terminal was run unelevated)<br><br>Issue: [#5000], [#632]<br>Spec: [#8455] |
-| 1 | Open tab in existing window | Open new tabs in existing Terminal windows<br><br>Issue: [#5000], [#4472]<br>Spec: [#8135] |
-| 1 | Traditional opacity | Have a transparent background without the acrylic blur.<br><br>Issue: [#603] <br>**Current State**: Blocked on WinUI 3.0 |
-| 2 | SnapOnOutput, scroll lock | Pause output or scrolling on click.<br><br>Issue: [#980]<br>Spec: [#2529]<br>Implementation: [#6062] |
-| 2 | Infinite scrollback | Have an infinite history for the text buffer.<br><br>Issue: [#1410] |
-| 2 | Pane management | All issues listed out in the original issue. Some features include pane resizing with mouse, pane zooming, and opening a pane by prompting which profile to use.<br><br>Issue: [#1000] |
-| 2 | Theme marketplace | Marketplace for creation and distribution of themes.<br>Dependent on overall theming |
-| 2 | Jump list | Show profiles from task bar (on right click)/start menu.<br><br>Issue: [#576]<br>Implementation: [#7515] |
-| 2 | Open with multiple tabs | A setting that allows Windows Terminal to launch with a specific tab configuration (not using only command line arguments).<br><br>Issue: [#756] |
-| 3 | Open in Windows Terminal | Functionality to right click on a file or folder and select Open in Windows Terminal.<br><br>Issue: [#1060]<br>Implementation: [#6100] |
-| 3 | Session restoration | Launch Windows Terminal and the previous session is restored with the proper tab and pane configuration and starting directories.<br><br>Issues: [#961], [#960], [#766] |
-| 3 | Quake mode | Provide a quick launch terminal that appears and disappears when a hotkey is pressed.<br><br>Issue: [#653] |
-| 3 | Settings migration infrastructure | Migrate people's settings without breaking them. Hand-in-hand with settings UI. |
-| 3 | Pointer bindings | Provide settings that can be bound to the mouse.<br><br>Issue: [#1553] |
+| Priority\* | Scenario | Description/Notes | State |
+| ---------- | -------- | ----------------- | ----- |
+| 0 | Settings UI | A user interface that connects to settings.json. This provides a way for people to edit their settings without having to edit a JSON file.<br><br>Issue: [#1564]<br>Specs: [#6720], [#6904]<br>Implementation: [#7283], [#7370], [#8048] | ✔️ |
+| 0 | Command palette | A popup menu to list possible actions and commands.<br><br>Issues: [#5400], [#2046]<br>Spec: [#2193]<br>Implementation: [#6635] | ✔️ |
+| 1 | Tab tear-off | The ability to tear a tab out of the current window and spawn a new window or attach it to a separate window.<br><br>Issue: [#1256], [#5000]<br>Spec: [#2080], [#7240] | 📝 |
+| 1 | Clickable links | Hyperlinking any links that appear in the text buffer. When clicking on the link, the link will open in your default browser.<br><br>Issue: [#574]<br>Implementation: [#7251] | ✔️ |
+| 1 | Default terminal | If a command-line application is spawned, it should open in Windows Terminal (if installed) or your preferred terminal<br><br>Issue: [#492]<br>Spec: [#2080], [#7414] | ✔️ |
+| 1 | Overall theme support | Tab coloring, title bar coloring, pane border coloring, pane border width, definition of what makes a theme<br><br>Issue: [#3327]<br>Spec: [#5772] | 🦶 |
+| 1 | Open profile elevated | Configure profiles to always open elevated (if Terminal was run unelevated)<br><br>Issue: [#5000], [#632]<br>Spec: [#8455] | 📝 |
+| 1 | Open tab in existing window | Open new tabs in existing Terminal windows<br><br>Issue: [#5000], [#4472]<br>Spec: [#8135] | ✔️ |
+| 1 | Traditional opacity | Have a transparent background without the acrylic blur.<br><br>Issue: [#603] | ✔️ |
+| 2 | SnapOnOutput, scroll lock | Pause output or scrolling on click.<br><br>Issue: [#980]<br>Spec: [#2529]<br>Implementation: [#6062] | ✔️ |
+| 2 | Infinite scrollback | Have an infinite history for the text buffer.<br><br>Issue: [#1410] | 🦶 |
+| 2 | Pane management | All issues listed out in the original issue. Some features include pane resizing with mouse, pane zooming, and opening a pane by prompting which profile to use.<br><br>Issue: [#1000] | 📝 |
+| 2 | Theme marketplace | Marketplace for creation and distribution of themes.<br>Dependent on overall theming | 🦶 |
+| 2 | Jump list | Show profiles from task bar (on right click)/start menu.<br><br>Issue: [#576]<br>Implementation: [#7515] | ✔️ |
+| 2 | Open with multiple tabs | A setting that allows Windows Terminal to launch with a specific tab configuration (not using only command line arguments).<br><br>Issue: [#756] | ✔️ |
+| 3 | Open in Windows Terminal | Functionality to right click on a file or folder and select Open in Windows Terminal.<br><br>Issue: [#1060]<br>Implementation: [#6100] | ✔️ |
+| 3 | Session restoration | Launch Windows Terminal and the previous session is restored with the proper tab and pane configuration and starting directories.<br><br>Issues: [#961], [#960], [#766] | ✔️ |
+| 3 | Quake mode | Provide a quick launch terminal that appears and disappears when a hotkey is pressed.<br><br>Issue: [#653] | ✔️ |
+| 3 | Settings migration infrastructure | Migrate people's settings without breaking them. Hand-in-hand with settings UI. | 🦶 |
+| 3 | Pointer bindings | Provide settings that can be bound to the mouse.<br><br>Issue: [#1553] | 🦶 |
+
+* 📝: The feature is currently in progress
+* ✔️: The feature is complete and shipped in a Preview build
+* 🦶: The feature is at risk of being punted to a future release cycle (beyond 2.0)
 
 Feature Notes:
 

src/Terminal.wprp

@@ -13,6 +13,15 @@
     <EventProvider Id="EventProvider_TerminalRemoting" Name="d6f04aad-629f-539a-77c1-73f5c3e4aa7b" />
     <EventProvider Id="EventProvider_TerminalDirectX" Name="c93e739e-ae50-5a14-78e7-f171e947535d" />
     <EventProvider Id="EventProvider_TerminalUIA" Name="e7ebce59-2161-572d-b263-2f16a6afb9e5"/>
+    <!-- Console providers here -->
+    <EventProvider Id="EventProvider-Microsoft.Windows.Console.Launcher" Name="770aa552-671a-5e97-579b-151709ec0dbd"/>
+    <EventProvider Id="EventProvider-Microsoft.Windows.Console.Host" Name="fe1ff234-1f09-50a8-d38d-c44fab43e818"/>
+    <EventProvider Id="EventProvider-Microsoft.Windows.Console.Server" Name="1A541C01-589A-496E-85A7-A9E02170166D"/>
+    <EventProvider Id="EventProvider-Microsoft.Windows.Console.VirtualTerminal.Parser" Name="c9ba2a84-d3ca-5e19-2bd6-776a0910cb9d"/>
+    <EventProvider Id="EventProvider-Microsoft.Windows.Console.Render.VtEngine" Name="c9ba2a95-d3ca-5e19-2bd6-776a0910cb9d"/>
+    <EventProvider Id="EventProvider-Microsoft.Windows.Console.UIA" Name="e7ebce59-2161-572d-b263-2f16a6afb9e5"/>
+
+    <!-- Profile for General Terminal logging -->
     <Profile Id="Terminal.Verbose.File" Name="Terminal" Description="Terminal" LoggingMode="File" DetailLevel="Verbose">
       <Collectors>
         <EventCollectorId Value="EventCollector_Terminal">
@@ -32,5 +41,27 @@
     <Profile Id="Terminal.Light.File" Name="Terminal" Description="Terminal" Base="Terminal.Verbose.File" LoggingMode="File" DetailLevel="Light" />
     <Profile Id="Terminal.Verbose.Memory" Name="Terminal" Description="Terminal" Base="Terminal.Verbose.File" LoggingMode="Memory" DetailLevel="Verbose" />
     <Profile Id="Terminal.Light.Memory" Name="Terminal" Description="Terminal" Base="Terminal.Verbose.File" LoggingMode="Memory" DetailLevel="Light" />
+
+    <!-- Profile for DefTerm logging. Includes some conhost logging. -->
+    <Profile Id="DefTerm.Verbose.File" Name="DefTerm" Description="DefTerm" LoggingMode="File" DetailLevel="Verbose">
+      <Collectors>
+        <EventCollectorId Value="EventCollector_Terminal">
+          <EventProviders>
+            <EventProviderId Value="EventProvider_TerminalControl" />
+            <EventProviderId Value="EventProvider_TerminalConnection" />
+            <EventProviderId Value="EventProvider_TerminalSettingsModel" />
+            <EventProviderId Value="EventProvider_TerminalApp" />
+            <EventProviderId Value="EventProvider_TerminalWin32Host" />
+            <EventProviderId Value="EventProvider_TerminalRemoting" />
+            <EventProviderId Value="EventProvider-Microsoft.Windows.Console.Launcher" />
+            <EventProviderId Value="EventProvider-Microsoft.Windows.Console.Host" />
+            <EventProviderId Value="EventProvider-Microsoft.Windows.Console.Server" />
+          </EventProviders>
+        </EventCollectorId>
+      </Collectors>
+    </Profile>
+    <Profile Id="DefTerm.Light.File" Name="DefTerm" Description="DefTerm" Base="DefTerm.Verbose.File" LoggingMode="File" DetailLevel="Light" />
+    <Profile Id="DefTerm.Verbose.Memory" Name="DefTerm" Description="DefTerm" Base="DefTerm.Verbose.File" LoggingMode="Memory" DetailLevel="Verbose" />
+    <Profile Id="DefTerm.Light.Memory" Name="DefTerm" Description="DefTerm" Base="DefTerm.Verbose.File" LoggingMode="Memory" DetailLevel="Light" />
   </Profiles>
-</WindowsPerformanceRecorder>
+</WindowsPerformanceRecorder>

src/cascadia/TerminalConnection/ConptyConnection.cpp

@@ -372,6 +372,16 @@ namespace winrt::Microsoft::Terminal::TerminalConnection::implementation
         // window is expecting it to be on the first layout.
         else
         {
+#pragma warning(suppress : 26477 26485 26494 26482 26446) // We don't control TraceLoggingWrite
+            TraceLoggingWrite(
+                g_hTerminalConnectionProvider,
+                "ConPtyConnectedToDefterm",
+                TraceLoggingDescription("Event emitted when ConPTY connection is started, for a defterm session"),
+                TraceLoggingGuid(_guid, "SessionGuid", "The WT_SESSION's GUID"),
+                TraceLoggingWideString(_clientName.c_str(), "Client", "The attached client process"),
+                TraceLoggingKeyword(MICROSOFT_KEYWORD_MEASURES),
+                TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
+
             THROW_IF_FAILED(ConptyResizePseudoConsole(_hPC.get(), dimensions));
         }
 

src/cascadia/WindowsTerminal/AppHost.cpp

@@ -1323,14 +1323,23 @@ void AppHost::_WindowMoved()
 
         const auto root{ _logic.GetRoot() };
 
-        // This is basically DismissAllPopups which is also in
-        // TerminalSettingsEditor/Utils.h
-        // There isn't a good place that's shared between these two files, but
-        // it's only 5 LOC so whatever.
-        const auto popups{ Media::VisualTreeHelper::GetOpenPopupsForXamlRoot(root.XamlRoot()) };
-        for (const auto& p : popups)
+        try
         {
-            p.IsOpen(false);
+            // This is basically DismissAllPopups which is also in
+            // TerminalSettingsEditor/Utils.h
+            // There isn't a good place that's shared between these two files, but
+            // it's only 5 LOC so whatever.
+            const auto popups{ Media::VisualTreeHelper::GetOpenPopupsForXamlRoot(root.XamlRoot()) };
+            for (const auto& p : popups)
+            {
+                p.IsOpen(false);
+            }
+        }
+        catch (...)
+        {
+            // We purposely don't log here, because this is exceptionally noisy,
+            // especially on startup, when we're moving the window into place
+            // but might not have a real xamlRoot yet.
         }
     }
 }

src/host/srvinit.cpp

@@ -28,6 +28,8 @@
 #include "../inc/conint.h"
 #include "../propslib/DelegationConfig.hpp"
 
+#include "tracing.hpp"
+
 #if TIL_FEATURE_RECEIVEINCOMINGHANDOFF_ENABLED
 #include "ITerminalHandoff.h"
 #endif // TIL_FEATURE_RECEIVEINCOMINGHANDOFF_ENABLED
@@ -69,10 +71,20 @@ try
         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));
         }
     }
 
@@ -400,7 +412,16 @@ HRESULT ConsoleCreateIoThread(_In_ HANDLE Server,
                                               [[maybe_unused]] PCONSOLE_API_MSG connectMessage)
 try
 {
+    // Create a telemetry instance here - this singleton is responsible for
+    // setting up the g_hConhostV2EventTraceProvider, which is otherwise not
+    // initialized in the defterm handoff at this point.
+    (void)Telemetry::Instance();
+
 #if !TIL_FEATURE_RECEIVEINCOMINGHANDOFF_ENABLED
+    TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                      "SrvInit_ReceiveHandoff_Disabled",
+                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
     return HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED);
 #else // TIL_FEATURE_RECEIVEINCOMINGHANDOFF_ENABLED
     auto& g = ServiceLocator::LocateGlobals();
@@ -418,9 +439,19 @@ try
 
     if (!g.handoffTerminalClsid)
     {
+        TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                          "SrvInit_ReceiveHandoff_NoTerminal",
+                          TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                          TraceLoggingKeyword(TIL_KEYWORD_TRACE));
         return E_NOT_SET;
     }
 
+    TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                      "SrvInit_ReceiveHandoff",
+                      TraceLoggingGuid(g.handoffTerminalClsid.value(), "TerminalClsid"),
+                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+
     // Capture handle to the inbox process into a unique handle holder.
     g.handoffInboxConsoleHandle.reset(hostProcessHandle);
 
@@ -453,9 +484,19 @@ try
 
     RETURN_IF_WIN32_BOOL_FALSE(CreatePipe(outPipeTheirSide.addressof(), outPipeOurSide.addressof(), nullptr, 0));
 
+    TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                      "SrvInit_ReceiveHandoff_OpenedPipes",
+                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+
     wil::unique_handle clientProcess{ OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ | SYNCHRONIZE, TRUE, static_cast<DWORD>(connectMessage->Descriptor.Process)) };
     RETURN_LAST_ERROR_IF_NULL(clientProcess.get());
 
+    TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                      "SrvInit_ReceiveHandoff_OpenedClient",
+                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+
     wil::unique_handle refHandle;
     RETURN_IF_NTSTATUS_FAILED(DeviceHandle::CreateClientHandle(refHandle.addressof(),
                                                                Server,
@@ -466,7 +507,18 @@ try
 
     ::Microsoft::WRL::ComPtr<ITerminalHandoff> handoff;
 
+    TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                      "SrvInit_PrepareToCreateDelegationTerminal",
+                      TraceLoggingGuid(g.handoffTerminalClsid.value(), "TerminalClsid"),
+                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+
     RETURN_IF_FAILED(CoCreateInstance(g.handoffTerminalClsid.value(), nullptr, CLSCTX_LOCAL_SERVER, IID_PPV_ARGS(&handoff)));
+    TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                      "SrvInit_CreatedDelegationTerminal",
+                      TraceLoggingGuid(g.handoffTerminalClsid.value(), "TerminalClsid"),
+                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
 
     RETURN_IF_FAILED(handoff->EstablishPtyHandoff(inPipeTheirSide.get(),
                                                   outPipeTheirSide.get(),
@@ -475,6 +527,11 @@ try
                                                   serverProcess,
                                                   clientProcess.get()));
 
+    TraceLoggingWrite(g_hConhostV2EventTraceProvider,
+                      "SrvInit_DelegateToTerminalSucceeded",
+                      TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
+                      TraceLoggingKeyword(TIL_KEYWORD_TRACE));
+
     inPipeTheirSide.reset();
     outPipeTheirSide.reset();
     signalPipeTheirSide.reset();