Public Access
Say how far a connection has got while it is still being made
The connecting card set its status string once, when the tab was created, and never touched it again. Every connection therefore looked identical from the outside: one three seconds into a key exchange, one waiting out a fifteen-second timeout against a machine that is asleep, and one that had hung all drew the same "connecting…". The card now draws the five steps of getting there, each lit at the moment the handshake reports reaching it, over an amber track that fills as they finish. ◆ NOTHING ON THE LIST IS INVENTED. Every row changes state because a layer below it said so, at the instant the thing it names actually began. That is the whole reason it is worth showing, and it is why most of this commit is plumbing rather than XAML: there was no progress reporting anywhere in the stack to hook a step list onto, and a card animating plausible progress would have been indistinguishable from one that had stopped receiving any. SshConnectionPhase names four phases and deliberately not more. SSH.NET runs the entire handshake inside one ConnectAsync and raises exactly one event from the middle of it — HostKeyReceived, once the key exchange has produced a key to show — so that event is the only interior moment there is to report. Everything before it is Reaching and everything after it is Authenticating. A fifth phase in that assembly would have to be a timer, so there is not one. OpeningShell is reported by TerminalWorkspace instead, because that is where it happens: the factory's work ends with an authenticated connection, and asking for a pseudo-terminal on one is a separate round trip. The SFTP path passes null — a second connection opened behind an already-open shell has nobody watching a step list for it. The card's fifth step, "Starting the terminal", is the renderer wait and lives in the shell rather than in the SSH assembly, which has never heard of a renderer. On the first connection after a cold start it is a real wait with a real failure mode of its own — a missing WebView2 runtime — so a list that began at "reaching the host" would leave the one wait most likely to hang unnamed. Amber for the step in flight, and that follows the palette's rule rather than bending it. Green is what is true and purple is what you can press; a step still happening is neither, and it is exactly the caveat-worth-reading that amber exists for. Steps behind it go green as they become true. Nothing animates, which is the argument TransfersScreen.axaml already makes for its own track, reaching a screen with far more reason to want a spinner: a spinner is furniture invented to fill a state nobody measured, and these states are measured, so the track fills to what has finished and then waits there. A refusal keeps the step it stopped on, in red, with the ones behind it still green. That is the half a progress bar could not do, and it is the difference between "that host is not there" and "that host is there and would not have me" — a question the reason sentence alone frequently does not settle. The strip's dot goes amber while a tab is connecting, on both heads. It was grey, and so is a tab whose shell has exited: the two states in that strip with the least in common, one worth waiting for and one over. PhoneShell's own comment already recorded half of this — the dot stopped being green before anything had answered — and this is the other half. Progress is raised inline rather than through System.Progress<T>, which captures whatever synchronisation context it was constructed on and posts to it. That reads like a convenience and is really a second place the marshalling decision gets made: silently, differently under a test with no context, and out of order with respect to the failure that follows a phase. The shell marshals once, in one handler, through a new optional post parameter on MainWindowViewModel — the same seam TransfersViewModel already uses, and for the reason its own remark gives. The three Dispatcher.UIThread.Post calls that predate it are the ones this suite's comments record as out of reach; they are left alone rather than swept in here. Both heads draw the list. They differ in one place: Phone.axaml's mono class sets a colour and a size along with the family, so the caption rule names its own family instead of composing the two and asking two rules for one Foreground. The desktop's mono sets the family alone, which is why ConnectingCard does compose them. Each head also gains SHOW LOGS beside the button that gives up — the step list is this attempt and the log is every other one, which is what a connection taking too long actually raises. Seven tests, and the two that matter most run against the container rather than a fake: a real handshake reports its phases in order, and a host-key refusal never claims to have authenticated. A fake asserting what it was written to assert would have established nothing about either. The rest cover the tab advancing while the connection is gated, the step a refusal stops on, and a phase reported after the user has given up on the tab. 1,861 tests, none failing. The Android head's layout is not verified by anything. It compiles, and compiled bindings mean every new binding path resolves, but that project is not in DodoSSH.slnx, there is no test project for it and no device here — so unlike the desktop card, whose shapes the layout harness measures, these rows have not been drawn. Vertical fit is reasoned, not observed.
This commit is contained in:
@@ -139,8 +139,15 @@ internal sealed class FakeConnectionFactory(long bytesPerShell = long.MaxValue,
|
||||
/// <inheritdoc />
|
||||
public Task<ISshConnection> ConnectAsync(
|
||||
SshConnectionRequest request,
|
||||
IProgress<SshConnectionPhase>? progress,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
// The real factory's own order, so that a test watching this fake is watching the same sequence a
|
||||
// real handshake produces. It cannot report CheckingHostKey — there is no key exchange here to
|
||||
// produce a key — and inventing one would make this the only place that phase came from.
|
||||
progress?.Report(SshConnectionPhase.Reaching);
|
||||
progress?.Report(SshConnectionPhase.Authenticating);
|
||||
|
||||
var connection = new FakeConnection(request, bytesPerShell, blockShellReads);
|
||||
Connections.Add(connection);
|
||||
|
||||
@@ -250,3 +257,15 @@ internal sealed class RecordingTransport : ITerminalTransport
|
||||
TerminalFrame.TryRead(frame, out var actual, out _, out _)
|
||||
&& actual == (byte)opcode);
|
||||
}
|
||||
|
||||
/// <summary>An <see cref="IProgress{T}"/> that runs its callback on the thread that reported.</summary>
|
||||
/// <remarks>
|
||||
/// <c>System.Progress<T></c> would post to a captured synchronisation context, or to the thread pool
|
||||
/// when there is none — which is what a test has here — so a list it appended to would be asserted on before
|
||||
/// it had been written. This is the same reason the shell does not use it either; see
|
||||
/// <c>VaultViewModel.ReporterFor</c>.
|
||||
/// </remarks>
|
||||
internal sealed class DelegateProgress<T>(Action<T> report) : IProgress<T>
|
||||
{
|
||||
public void Report(T value) => report(value);
|
||||
}
|
||||
|
||||
@@ -72,12 +72,12 @@ public sealed class TerminalWorkspaceTests
|
||||
workspace.LiveSessionCount.ShouldBe(0);
|
||||
|
||||
await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
workspace.LiveSessionCount.ShouldBe(1);
|
||||
|
||||
await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
workspace.LiveSessionCount.ShouldBe(2);
|
||||
}
|
||||
@@ -98,11 +98,63 @@ public sealed class TerminalWorkspaceTests
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
await WaitUntilAsync(() => workspace.LiveSessionCount == 0);
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <see cref="SshConnectionPhase.OpeningShell"/> is the one phase no connection factory can report,
|
||||
/// because by the time it happens the factory has handed back a connection and gone. If this layer did
|
||||
/// not report it the card's last step would light only when the whole session opened, which is the one
|
||||
/// moment the card is already being taken down — a step nobody would ever see lit.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Asserted as the whole sequence rather than as "contains OpeningShell", because the order is the part
|
||||
/// that matters: a step list is only readable if what it is told arrives in the order it draws.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
[Fact]
|
||||
public async Task OpeningASession_ReportsTheShellPhaseTheFactoryCannot()
|
||||
{
|
||||
var connections = new FakeConnectionFactory();
|
||||
var reported = new List<SshConnectionPhase>();
|
||||
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
await workspace.OpenSessionAsync(
|
||||
Request(),
|
||||
TerminalSize.Default,
|
||||
new DelegateProgress<SshConnectionPhase>(reported.Add),
|
||||
TestContext.Current.CancellationToken);
|
||||
|
||||
reported.ShouldBe(
|
||||
[
|
||||
SshConnectionPhase.Reaching,
|
||||
SshConnectionPhase.Authenticating,
|
||||
SshConnectionPhase.OpeningShell,
|
||||
],
|
||||
"the factory's own phases, then the one this layer performs itself");
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// Nobody watching is the ordinary case — every caller but the connecting card passes null — so it is
|
||||
/// worth one test that the null is a null and not a null reference.
|
||||
/// </remarks>
|
||||
[Fact]
|
||||
public async Task OpeningASession_WorksWithNobodyWatchingItsPhases()
|
||||
{
|
||||
var connections = new FakeConnectionFactory();
|
||||
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
workspace.IsSessionLive(sessionId).ShouldBeTrue();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ClosingASessionEndsItAndDisposesItsConnection()
|
||||
{
|
||||
@@ -111,7 +163,7 @@ public sealed class TerminalWorkspaceTests
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
await workspace.CloseSessionAsync(sessionId);
|
||||
|
||||
@@ -138,9 +190,9 @@ public sealed class TerminalWorkspaceTests
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
var first = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
var second = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
workspace.IsSessionLive(first).ShouldBeTrue();
|
||||
workspace.IsSessionLive(second).ShouldBeTrue();
|
||||
@@ -166,7 +218,7 @@ public sealed class TerminalWorkspaceTests
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
var facts = workspace.GetSessionFacts(sessionId).ShouldNotBeNull();
|
||||
var connection = connections.Connections.ShouldHaveSingleItem();
|
||||
@@ -199,7 +251,7 @@ public sealed class TerminalWorkspaceTests
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
(await workspace.PasteAsync(
|
||||
sessionId, "uptime", execute: false, TestContext.Current.CancellationToken))
|
||||
@@ -245,7 +297,7 @@ public sealed class TerminalWorkspaceTests
|
||||
};
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
await WaitUntilAsync(() =>
|
||||
{
|
||||
@@ -283,7 +335,7 @@ public sealed class TerminalWorkspaceTests
|
||||
};
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
await workspace.CloseSessionAsync(sessionId);
|
||||
|
||||
@@ -309,9 +361,9 @@ public sealed class TerminalWorkspaceTests
|
||||
workspace.SessionEnded += (_, _) => Interlocked.Increment(ref announcements);
|
||||
|
||||
await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
await workspace.DisposeAsync();
|
||||
|
||||
@@ -355,7 +407,7 @@ public sealed class TerminalWorkspaceTests
|
||||
using var first = await ConnectRendererAsync(workspace);
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
// The session's own opening frame, sent as soon as the pump starts running. Not a replay, and not
|
||||
// what this test is about — read and discarded so it cannot be confused for one below.
|
||||
@@ -422,7 +474,7 @@ public sealed class TerminalWorkspaceTests
|
||||
await using var workspace = CreateWorkspace(connections);
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
// The up-arrow, as a PTY expects it. Three bytes, and all three matter.
|
||||
byte[] upArrow = [0x1B, (byte)'[', (byte)'A'];
|
||||
@@ -444,7 +496,7 @@ public sealed class TerminalWorkspaceTests
|
||||
await using var workspace = CreateWorkspace(new FakeConnectionFactory());
|
||||
|
||||
var sessionId = await workspace.OpenSessionAsync(
|
||||
Request(), TerminalSize.Default, TestContext.Current.CancellationToken);
|
||||
Request(), TerminalSize.Default, progress: null, TestContext.Current.CancellationToken);
|
||||
|
||||
await workspace.CloseSessionAsync(sessionId);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user