Public Access
jaap-jan
d07b336868
The WebView sat inside the Hosts grid, so navigating to Files or the keychain hid every open terminal and the strip that named them. A connection you had opened was invisible from four of the five screens. The window now has two surfaces rather than one: a nav rail that says which page you are on, and a terminal strip that is always there and switches the whole content area to a shell. Screen keeps meaning "which page" and never becomes a sixth kind of page, which is why this is two properties instead of one enum with a terminal member in it. Every screen lives inside one wrapper panel that collapses when a terminal is showing. That is not tidiness — the WebView hosts a Win32 child window that composites above everything Avalonia draws, so a screen left visible over its rectangle is a screen sliced in half, and this window has shipped that defect once already. One decision point, IsTerminalShowing, and a nested panel rather than five compound bindings nobody would remember to extend. The focus choreography is the part no test in this repo can see. Every reveal path now focuses in the same turn the WebView appeared, so all three of them post at DispatcherPriority.Loaded and let the native control re-push its bounds first. Going the other way had a real bug: the screen-changed branch called a bare Focus() where it had to release the keyboard from the native child, so switching from a terminal to Files silently ate the first keystrokes. Rare before this commit and the primary gesture after it. The tab strip grew a cross inside each tab, a plus that opens the quick-connect palette, and middle-click close. Nested buttons are correct here: Avalonia handles a left press on the cross and deliberately does not handle other buttons, which is exactly what lets middle-click bubble up from the cross as well as the tab. The test is PointerUpdateKind rather than IsMiddleButtonPressed, because the latter reports button state and is also true for a left press made while the middle button happens to be held. The handler is on the tab and not the strip, so the background closes nothing by construction. Plus opens the palette rather than a flyout, since a menu dropping into the WebView's rectangle may or may not composite above a child HWND and this repo does not make rendering claims it has not photographed. Everything a user reads now says keychain. The wire, the database and the cryptographic spec still say vault, deliberately: renaming those is a migration and a protocol change for a word. That split is written down rather than left to be rediscovered as an inconsistency. Four things that were squeezed into the keychain's category rail, or into nothing at all, now have screens. Pinned host keys get one, with fingerprints never truncated and a filter that matches them, because comparing what you have against what the operator published is the whole workflow; the approved date is read out of the item's UUIDv7 rather than added as a column, and says so, since it means first approval and not last use. Keys can be generated in the client, which needed the openssh-key-v1 container written by hand — there is no BCL or NSec helper, and the PKCS#8 route is unverified in the SSH library this uses. The armour carries no passphrase: encrypting it needs bcrypt_pbkdf, which is Blowfish with a swizzle, in a project whose crypto is otherwise entirely libsodium, for a protection the key's own remarks argue is redundant inside a vault. Generation fills the existing editor and stops, so SAVE stays the one thing that writes. ~/.ssh/config can be imported behind a preview that is ticked per row and writes nothing until the button; IdentityFile records the path and imports the key material only on an explicit opt-in, because reading somebody's private key into a vault is precisely the act this product exists to make deliberate. Match blocks and ProxyJump are reported rather than obeyed — one cannot be evaluated statically and the other has nothing behind it to route with, and a preview that implied otherwise would be worse than one that admits it. Files can be dragged in all four directions that are honestly available. Remote to Explorer does not ship and is not pretended to: the shell wants the bytes during the drop, which needs a virtual file and a native COM data object, outside what Avalonia offers. Note for the next person that Avalonia 12 replaced the drag model outright — DataObject and DataFormats are no-op stubs and IDataObject is not in the reference assembly, so every tutorial written for 11 does not compile here. Hosts can be grouped, flat and never nested. A parent id merged as a scalar lets two offline clients each re-parent A under B and B under A, producing a cycle inside an encrypted payload that no server can police and every reader would have to detect for ever. Membership lives in that payload rather than in the one plaintext concession ADR 0001 allows, whose test is that the relay cannot function without it — nothing on the server reads a group, so what plaintext would hand over is a clustering of the estate for nothing. The plaintext column reserved for it is dropped, provably always null, and the server now refuses a client that sends one; it was never populated, was copied on apply, and was not cleared on delete, so a group id would have outlived the host it described. Snippets insert through xterm rather than through the pump, because xterm is the only thing that knows whether the remote has bracketed paste on, and that is what makes a shell treat embedded newlines as text instead of as execute. The host process moves opaque bytes and never parses output, so it would have to guess, and guessing wrong runs every line. Running is off by default and the copy says the text goes into whatever is there — the terminal has no notion of being at a prompt, and may be in vi or at a password prompt with echo off, so the Enter the user presses themselves is the entire safety property. Connections and keychain changes are recorded as synced encrypted items, which is what makes them auditable by a team later and costs the server knowledge of connection rate and timing from row counts alone. ADR 0001 already concedes it cannot hide that class of metadata; the trade is now written into it rather than left implicit. A connection entry is written once, at close, which is what makes a synced log tractable: nothing to merge, one outbox row, no chance of colliding with itself. Live sessions come from memory, not from the log. The write is void by contract and posts to a bounded channel, because putting an encrypt-and-write on the teardown path of every session is how closing the application comes to take four seconds. A ticket opened before a lock still closes afterwards, since a shell outlives the vault. The activity log hooks the one generic repository every kind writes through, so it cannot miss a caller — which is also why the log kinds themselves declare they are not audited, or the first entry would write an entry about writing an entry. It records the names of the fields that changed and never their values; a log with an old password in it would be a plaintext credential store with no vault around it. Retention is 90 days or 5,000 entries, whichever bites first, pruned on the sync loop rather than on a second timer. That log traffic then broke the status line, which is worth recording because the fix is a shape and not a patch: background sync counted its own log rows as pushed items, so the quiet rule stopped being quiet and every action's message was overwritten a second later by a sync report. The report now separates log rows from user items and the rule reads the latter. S3 buckets appear as a remote in the file browser, behind the same interface an SFTP session implements, so the queue and both panes did not have to learn what they are talking to. Uploads go through a pipe, because the queue wants to write and the SDK wants to read; memory is then bounded by the part size instead of buffering a file to disk twice. Finally, the Windows device key store moved out of the session project, which was the one thing keeping it from being portable — everything else in it is platform-neutral, and a Windows CNG dependency in the middle of the vault code meant a second head could not reference it without dragging Windows along. The seam that made the move free was already there. docs/android-port.md is the audit behind that: what ports, what does not, in order of cost, the four decisions taken, and an inventory of every screen and state the interface has to carry, written so a design can be made from it directly. dotnet build, dotnet test and dotnet format --verify-no-changes are all clean: 1240 tests at zero warnings, including the end-to-end suite against real containers. The manual checks that headless Avalonia cannot make — the drag from Explorer, a generated key against a real host, twelve tabs at the minimum window width — are listed in docs/manual-checks.md and are still outstanding.
235 lines
10 KiB
C#
235 lines
10 KiB
C#
using System.Globalization;
|
|
using Avalonia;
|
|
using Avalonia.Controls;
|
|
using Avalonia.Headless;
|
|
using Avalonia.Threading;
|
|
using Avalonia.VisualTree;
|
|
|
|
namespace DodoSSH.Client.App.Layout.Tests;
|
|
|
|
/// <summary>
|
|
/// Lays out real XAML at a real size and reports anything a user could not click.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// The defect this exists for is a control arranged past the edge of its container. It is invisible to every
|
|
/// other suite here — no other test loads a <c>.axaml</c> — and this window has shipped it once, when the
|
|
/// setup screens rendered sliced with their buttons unreachable at the default width.
|
|
/// </para>
|
|
/// <para>
|
|
/// A control inside a <see cref="ScrollViewer"/> is exempt, and that exemption is load-bearing rather than a
|
|
/// convenience: a list longer than its viewport is the normal case, and treating a row scrolled out of sight
|
|
/// as a defect would make this harness cry wolf on every populated list. What is left after the exemption is
|
|
/// the class of thing that has no way to come back into view.
|
|
/// </para>
|
|
/// </remarks>
|
|
internal static class LayoutHarness
|
|
{
|
|
/// <summary>The window's own declared minimum, which is the size that has to work.</summary>
|
|
/// <remarks>
|
|
/// Taken from <c>MainWindow.axaml</c>'s <c>MinWidth</c>/<c>MinHeight</c> by hand. A test asserts these
|
|
/// two constants still match the XAML, so the harness cannot quietly start measuring a window larger
|
|
/// than the one a user is allowed to drag to.
|
|
/// </remarks>
|
|
internal const double MinimumWidth = 880;
|
|
|
|
/// <inheritdoc cref="MinimumWidth" />
|
|
internal const double MinimumHeight = 560;
|
|
|
|
/// <summary>The host sidebar's fixed width, from the hosts screen's <c>ColumnDefinitions</c>.</summary>
|
|
internal const double HostSidebarWidth = 268;
|
|
|
|
/// <summary>The nav rail's fixed width, from <c>NavRail.axaml</c>.</summary>
|
|
internal const double NavRailWidth = 54;
|
|
|
|
/// <summary>
|
|
/// What the titlebar, the tab strip and the status bar take off the window before any screen gets a
|
|
/// pixel.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// All three are fixed heights declared in their own markup — 38, 34 and 24 — rather than shapes that
|
|
/// grow with their contents, which is what makes stating them here honest. Three tests hold the three
|
|
/// controls to those numbers, so the budget below cannot drift away from what the window actually
|
|
/// leaves.
|
|
/// </remarks>
|
|
internal const double TitleBarHeight = 38;
|
|
|
|
/// <inheritdoc cref="TitleBarHeight" />
|
|
internal const double StatusBarHeight = 24;
|
|
|
|
/// <summary>
|
|
/// <inheritdoc cref="TitleBarHeight" path="/summary" />
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// It comes off every screen, not just the hosts screen, which is the layout consequence of the strip
|
|
/// spanning the window. The strip does not collapse when there are no tabs — a row of chrome that came
|
|
/// and went would move every screen up and down by 34 pixels each time the last tab closed — so this is
|
|
/// a fixed cost rather than a conditional one, and the budget can be a constant.
|
|
/// </remarks>
|
|
internal const double TerminalTabsHeight = 34;
|
|
|
|
/// <summary>
|
|
/// What a setup card leaves its contents: its maximum width, less the padding on both sides.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// From <c>Border.card</c> in <c>App.axaml</c> — <c>MaxWidth</c> 520 and <c>Padding</c> 24 — because the
|
|
/// cards themselves live inside <c>MainWindow.axaml</c>, which cannot be laid out here at all. Measuring
|
|
/// a card's contents at the size the card gives them is the closest this harness can get to the unlock
|
|
/// screen, and it is the half that has something to blow: the frame is fixed and the contents are not.
|
|
/// </remarks>
|
|
internal const double CardContentWidth = 520 - (2 * 24);
|
|
|
|
/// <inheritdoc cref="CardContentWidth" />
|
|
/// <remarks>
|
|
/// Measured against <see cref="ContentHeight"/> and not against <see cref="ScreenHeight"/>, which is a
|
|
/// distinction the tab strip introduced and which is worth stating: a setup card is shown while the
|
|
/// vault is <em>not</em> open, and the strip lives inside the unlocked half of the window. So the card
|
|
/// gets the whole area between the titlebar and the status bar, and taking the strip off its budget
|
|
/// would have this harness fail a card that fits.
|
|
/// </remarks>
|
|
internal static double CardContentHeight => ContentHeight - (2 * 24);
|
|
|
|
/// <summary>Everything between the titlebar and the status bar, at the window's minimum.</summary>
|
|
internal static double ContentHeight => MinimumHeight - TitleBarHeight - StatusBarHeight;
|
|
|
|
/// <summary>The height a screen actually gets at the window's minimum.</summary>
|
|
/// <remarks>
|
|
/// Less than <see cref="ContentHeight"/> by the tab strip, which spans every screen and does not
|
|
/// collapse when there are no tabs.
|
|
/// </remarks>
|
|
internal static double ScreenHeight => ContentHeight - TerminalTabsHeight;
|
|
|
|
/// <summary>The width a full-width screen gets, once the nav rail has taken its column.</summary>
|
|
internal static double ScreenWidth => MinimumWidth - NavRailWidth;
|
|
|
|
private static readonly HeadlessUnitTestSession Session =
|
|
HeadlessUnitTestSession.GetOrStartForAssembly(typeof(LayoutHarness).Assembly);
|
|
|
|
/// <summary>
|
|
/// Runs one body on Avalonia's dispatcher thread.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Everything that touches a control has to happen here. The session owns the thread and the
|
|
/// application, so this is also what serialises the suite — Avalonia's platform is process-global and
|
|
/// two tests laying out windows at once would share one dispatcher.
|
|
/// </remarks>
|
|
internal static Task OnTheUiThreadAsync(Action body, CancellationToken cancellationToken) =>
|
|
Session.Dispatch(body, cancellationToken);
|
|
|
|
/// <summary>Shows a window at a given size and lets layout finish.</summary>
|
|
internal static void Settle(Window window, double width, double height)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(window);
|
|
|
|
window.Width = width;
|
|
window.Height = height;
|
|
|
|
// None, because a headless window still reserves space for decorations it does not draw, and the
|
|
// budget being measured is the client area the application actually gets.
|
|
window.WindowDecorations = WindowDecorations.None;
|
|
|
|
window.Show();
|
|
|
|
// Show() queues layout rather than performing it. Without this the tree is measured but not
|
|
// arranged, and every Bounds read below would be a zero rectangle — which would make this harness
|
|
// report the whole window as unreachable, or worse, report nothing at all.
|
|
Dispatcher.UIThread.RunJobs();
|
|
window.UpdateLayout();
|
|
}
|
|
|
|
/// <summary>Wraps a control in a host window sized to the application's minimum.</summary>
|
|
internal static Window HostAtMinimumSize(Control content, double width, double height)
|
|
{
|
|
var window = new Window { Content = content };
|
|
Settle(window, width, height);
|
|
return window;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Every interactive control that is laid out where it cannot be used, described for a failure message.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns descriptions rather than controls because the value of this harness is entirely in what it
|
|
/// says when it fails: "something is clipped" sends the reader back to a 500-line XAML file, while
|
|
/// "Button 'Save' at 8,486 486x32 falls outside 820x520" names the control and the edge it crossed.
|
|
/// </remarks>
|
|
internal static IReadOnlyList<string> Unreachable(Window window)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(window);
|
|
|
|
var client = new Rect(window.ClientSize);
|
|
var found = new List<string>();
|
|
|
|
foreach (var control in window.GetVisualDescendants().OfType<Control>())
|
|
{
|
|
if (Fault(control, client, window) is { } fault)
|
|
{
|
|
found.Add(fault);
|
|
}
|
|
}
|
|
|
|
return found;
|
|
}
|
|
|
|
private static string? Fault(Control control, Rect client, Visual window)
|
|
{
|
|
if (!IsInteractive(control) || !control.IsEffectivelyVisible || IsScrollable(control))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
if (control.TranslatePoint(default, window) is not { } origin)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
var box = new Rect(origin, control.Bounds.Size);
|
|
|
|
// Zero size is a defect for a control the theme gives a height to and a normal state for one sized by
|
|
// its content: an empty list is zero pixels tall and correct, a squashed button is neither. Learned
|
|
// from this firing on KeyList in a vault with no keys in it.
|
|
if (control is not ListBox && (box.Width <= 0 || box.Height <= 0))
|
|
{
|
|
return Describe(control, box, client, "was arranged with no size");
|
|
}
|
|
|
|
return client.Contains(box) ? null : Describe(control, box, client, "falls outside the window");
|
|
}
|
|
|
|
/// <remarks>
|
|
/// The controls a user has to be able to reach. A clipped <see cref="TextBlock"/> is a cosmetic problem
|
|
/// and a clipped <see cref="Button"/> is a dead end, so only the second kind is worth failing a build
|
|
/// over — and keeping the list short is what stops this harness from becoming a pixel-diff nobody
|
|
/// trusts.
|
|
/// </remarks>
|
|
private static bool IsInteractive(Control control) =>
|
|
control is Button or TextBox or CheckBox or ComboBox or NumericUpDown or ListBox;
|
|
|
|
private static bool IsScrollable(Control control) =>
|
|
control.GetVisualAncestors().OfType<ScrollViewer>().Any();
|
|
|
|
private static string Describe(Control control, Rect box, Rect client, string fault)
|
|
{
|
|
var name = control.Name is { Length: > 0 } named ? $" '{named}'" : Label(control);
|
|
|
|
return string.Create(
|
|
CultureInfo.InvariantCulture,
|
|
$"{control.GetType().Name}{name} {fault}: {Format(box)} is not inside {Format(client)}");
|
|
}
|
|
|
|
/// <remarks>
|
|
/// A button's caption, because "Save" identifies the control to a reader far better than its position
|
|
/// in a visual tree does.
|
|
/// </remarks>
|
|
private static string Label(Control control) => control switch
|
|
{
|
|
Button { Content: string caption } => $" '{caption}'",
|
|
TextBox { PlaceholderText: { Length: > 0 } placeholder } => $" (placeholder '{placeholder}')",
|
|
_ => string.Empty,
|
|
};
|
|
|
|
private static string Format(Rect rect) => string.Create(
|
|
CultureInfo.InvariantCulture,
|
|
$"{rect.X:0.#},{rect.Y:0.#} {rect.Width:0.#}x{rect.Height:0.#}");
|
|
}
|