Refactor how connection restarting is handled #14548

zadjii-msft · 2022-12-13T19:33:19Z

Admittedly, this is a lot of annoying plumbing.

We didn't love that a connection could transition back in the state diagram, from Closed -> Start. That felt wrong. To remedy this, we're going to allow the ControlCore to re-create connections, all on its own. This builds on a lot of work that was originally done for Process Model v2 (#5000), and was originally slated to be merged in #12938.

Basically, all the properties for a Connection are stashed already in a ConnectionState object. We're gonna take that, and stash the info in the ControlCore. When the control wants to restart the connection, it just uses that to rebuild a new one.

Cleanup from #14060

Closes #14327

…in review

…arting-attempt-1-backport

DHowett

Okay, some big questions. I don't love how we're becoming more stringly-typed but perhaps it offers us some heretofore unobserved opportunities...

src/cascadia/TerminalControl/TermControl.idl

src/cascadia/TerminalControl/TermControl.h

src/cascadia/TerminalControl/ControlCore.h

src/cascadia/TerminalApp/TerminalPage.cpp

DHowett · 2022-12-13T22:24:45Z

src/cascadia/TerminalApp/TerminalPage.cpp

+            if (auto conpty{ existingConnection.try_as<ConptyConnection>() })
+            {
+                connectionInfo = TerminalConnection::ConnectionInformation(winrt::name_of<TerminalConnection::ConptyConnection>(),
+                                                                           conpty.ToSettings());


It feels like ConptyConnection (or, any connection) should be able to produce a fully-formed ConnectionInformation itself, without the consumer needing to know about its classname

That... might? be able to be done. Not sure it's immediately relevant here (in the defterm context). But I guess it could be ConptyConnection::CreateConnectionInfo(settings...) -> ConnectionInfo, and have it fill in its own name.

DHowett · 2022-12-13T22:26:41Z

src/cascadia/TerminalApp/TerminalPage.cpp

@@ -2721,10 +2744,15 @@ namespace winrt::TerminalApp::implementation
            if (bothAltsPressed)
            {
                std::tie(connection, debugConnection) = OpenDebugTapConnection(connection);
+                // Debug Tap connections aren't really restartable. The


so what happens if you do restart one?

You can restart the underlying connection, but not the debugtap-ness of it. The debug spew just stops, but the real pane gets restarted.

src/cascadia/TerminalConnection/ConptyConnection.cpp

src/cascadia/TerminalControl/ControlCore.cpp

…arting-attempt-1-backport

src/cascadia/TerminalControl/ControlCore.cpp

src/cascadia/TerminalConnection/ConnectionInformation.cpp

src/cascadia/TerminalApp/TerminalPage.cpp

…arting-attempt-1-backport

DHowett

14/15

DHowett · 2023-04-20T17:16:56Z

src/cascadia/TerminalControl/TermControl.h

@@ -35,6 +35,9 @@ namespace winrt::Microsoft::Terminal::Control::implementation
        winrt::fire_and_forget UpdateControlSettings(Control::IControlSettings settings, Control::IControlAppearance unfocusedAppearance);
        IControlSettings Settings() const;

+        TerminalConnection::ConnectionInformation ConnectionInfo();


I don't totally understand why TerminalPage can't just make a totally new connection out of nothing - I find it so weird that TermControl now has a Connection (which we gave it) and a ConnectionInfo (which we used to make the Connection, and then also gave it). How would a public user of TermControl's public API even know what to do with all of these members?

I don't love the pattern of storing effectively random app data on random other classes, you know? We did the same for Profile (and pushed it all the way down to the Core)...

DHowett · 2023-04-20T17:19:21Z

src/cascadia/TerminalControl/ControlCore.cpp

+                    // connection's settings. This'll cause conpty to restart
+                    // the connection at the current place in the buffer.
+                    _ConnectionInfo.Settings().Insert(L"inheritCursor", Windows::Foundation::PropertyValue::CreateBoolean(true));
+                    auto c = TerminalConnection::ConnectionInformation::CreateConnection(_ConnectionInfo);


okay, I see, but I still don't love it. "Sometimes the connection comes from the app and sometimes TermControl spontaneously ~~creates life and seeds it onto an empty planet~~ makes its own connection".

DHowett · 2023-04-20T17:21:49Z

src/cascadia/TerminalControl/ControlCore.cpp

-            if (ch == Enter)
+            // If we have a connection info with which to try and re-create the
+            // connection, then let's try doing that on Enter
+            if (_ConnectionInfo != nullptr)


I guess this puts us in a really weird position, where ConptyConnection is responsible for printing out the "press ^D to restart" message, but TermControl is ultimately responsible for handling it.

But at the same time, this means that users of other connections (#4661) won't be told that ^D/Enter are options... but they MIGHT be? If they can be reconstructed via ConnectionInfo?

DHowett · 2023-04-20T17:22:25Z

src/cascadia/TerminalControl/ControlCore.cpp

+    {
+        if (_connection)
+        {
+            _connectionOutputEventRevoker.revoke();


overwriting _connectionStateChangedRevoker later should revoke it automatically, without you needing to check this

DHowett · 2023-04-20T17:24:06Z

src/cascadia/TerminalConnection/ConptyConnection.cpp

+    // Starting Directory - alas, we don't know that for a defterm connection.
+    // The Core might be able to fill it in, if the client app ever tells the
+    // Terminal.
+    Windows::Foundation::Collections::ValueSet ConptyConnection::GetDeftermSettings()


for my own understanding
We have to use this in the magical scenario where we got a connection created out of nowhere and we had no way to inform TerminalPage what settings it started with?

zadjii-msft · 2023-04-26T19:17:58Z

Closed in favor of #15240

A different take on #14548. > We didn't love that a connection could transition back in the state diagram, from Closed -> Start. That felt wrong. To remedy this, we're going to allow the ControlCore to... ASK the app to restart its connection. This is a much more sensible approach, than leaving the ConnectionInfo in the core and having the core do the restart itself. That's mental. Cleanup from #14060 Closes #14327 Obsoletes #14548

sotteson1 and others added 22 commits September 22, 2022 00:32

Add support to close a failed pain with ctrl+D

21cf69d

Implement ctrl+D as an event that Pane watches

5606291

Fix a couple of typos from the last cleanup

6de50b0

Fix formatting issues

d902eb8

Add support for restarting terminal with Enter

092957f

Add comment to line setting PSEUDOCONSOLE_INHERIT_CURSOR

27096e6

Keep track of rows/cols in connection even when disconnected

ec7dfc5

Fix analysis error

82b6876

Add comment to help with localization.

62888a5

Update message to use Ctrl+D instead of ^D

899f009

Merge branch 'main' into ctrl-d-support

52c59ed

Merge remote-tracking branch 'origin/main' into ctrl-d-support

0c190c2

there's not a better way to name that message

7febffe

this is a backport of a lot of tearout ConnectionInfo code currently …

3da6613

…in review

Merge remote-tracking branch 'origin/main' into dev/migrie/b/cxn-rest…

9cc8d61

…arting-attempt-1-backport

Merge remote-tracking branch 'origin/main' into dev/migrie/b/cxn-rest…

08c6033

…arting-attempt-1-backport

Okay, the control can restart a connection now

24c745f

This works for defterm connections

5bcf0fc

After all, why shouldn't debug tap connections be restartable?

ddb8042

cleanup for review

b0c3e36

yea of course I didn't save

ca8c794

I don't even recall touching this file

beb7b1a

This comment has been minimized.

Sign in to view

zadjii-msft mentioned this pull request Dec 13, 2022

Add an action for immediately restarting a connection #14549

Closed

spel

b0aae07

DHowett reviewed Dec 13, 2022

View reviewed changes

DHowett added the Automerge-Not-Compatible label Dec 17, 2022

zadjii-msft added this to the Terminal v1.17 milestone Jan 10, 2023

zadjii-msft added 2 commits January 19, 2023 11:12

oh no I added changes before I committed the merge. Butts

4ac6bf5

Merge remote-tracking branch 'origin/main' into dev/migrie/b/cxn-rest…

c814d9e

…arting-attempt-1-backport

zadjii-msft assigned DHowett Jan 19, 2023

lhecker approved these changes Jan 20, 2023

View reviewed changes

src/cascadia/TerminalControl/ControlCore.cpp Outdated Show resolved Hide resolved

src/cascadia/TerminalConnection/ConnectionInformation.cpp Outdated Show resolved Hide resolved

zadjii-msft added 2 commits January 29, 2023 06:42

Merge branch 'main' into dev/migrie/b/cxn-restarting-attempt-1-backport

75c9657

good nits

871f60c

carlos-zamora reviewed Feb 2, 2023

View reviewed changes

zadjii-msft added 3 commits February 5, 2023 15:41

Merge remote-tracking branch 'origin/main' into dev/migrie/b/cxn-rest…

c15a520

…arting-attempt-1-backport

pr nits

b2f9ee0

Merge remote-tracking branch 'origin/main' into dev/migrie/b/cxn-rest…

13b1516

…arting-attempt-1-backport

zadjii-msft mentioned this pull request Apr 5, 2023

Terminal hangs when exiting a debug tap session #14898

Closed

Merge remote-tracking branch 'origin/main' into dev/migrie/b/cxn-rest…

4291e88

…arting-attempt-1-backport

zadjii-msft modified the milestones: Terminal v1.17, Terminal v1.18 Apr 17, 2023

Merge remote-tracking branch 'origin/main' into dev/migrie/b/cxn-rest…

2aad178

…arting-attempt-1-backport

zadjii-msft removed the Automerge-Not-Compatible label Apr 20, 2023

DHowett requested changes Apr 20, 2023

View reviewed changes

microsoft-github-policy-service bot added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Apr 20, 2023

zadjii-msft mentioned this pull request Apr 26, 2023

(A better) Refactoring of how connection restarting is handled #15240

Merged

zadjii-msft closed this Apr 26, 2023

microsoft-github-policy-service bot added Needs-Attention The core contributors need to come back around and look at this ASAP. and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Apr 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor how connection restarting is handled #14548

Refactor how connection restarting is handled #14548

zadjii-msft commented Dec 13, 2022

This comment has been minimized.

DHowett left a comment

DHowett Dec 13, 2022

zadjii-msft Jan 18, 2023

DHowett Dec 13, 2022

zadjii-msft Jan 18, 2023

DHowett left a comment

DHowett Apr 20, 2023

DHowett Apr 20, 2023

DHowett Apr 20, 2023

DHowett Apr 20, 2023

DHowett Apr 20, 2023

DHowett Apr 20, 2023

zadjii-msft commented Apr 26, 2023

Refactor how connection restarting is handled #14548

Refactor how connection restarting is handled #14548

Conversation

zadjii-msft commented Dec 13, 2022

This comment has been minimized.

DHowett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zadjii-msft commented Apr 26, 2023