Public Access
Let the desktop client replace itself, and give the repository one version
Packaging for Windows, and the updater that only exists once something is
packaged. Velopack, win-x64, fed from the project's own forge — never from the
deployment a client signs in to, which is ADR 0011 rule 2 carried over
unchanged and is why the feed address is a constant in the code rather than a
setting. See docs/adr/0012-desktop-distribution-and-updates.md.
**Nothing is ever installed while somebody is using it.** A newer build is found
on a six-hourly pass, downloaded in the background, and then waits — for a
restart the user presses, or for the next launch they were going to do anyway.
That is a policy rather than caution: this application argues at length that
locking keeps shells running, because a lock that destroyed work would stop
being used, and a restart does not keep them. Having taught that, it owes the
user the choice at the one moment it stops being true, and the sentence saying
so counts the shells it would close.
**The version is now derived from the v* tag**, by MinVer, for everything. There
was no version before this — no property anywhere, so every assembly reported
the SDK's 1.0.0 and the API served that string as its serverVersion to every
client that asked. The tag was already the version of record for the container
image; this makes it the version of record full stop. MinVer's failure mode is
answering plausibly rather than failing, and here a wrong version is a client
that never updates, so it is guarded twice: fetch-depth 0 on every checkout, and
a step that fails a tag build when the tag and the computed version disagree.
**The pack id is DodoSSH.Desktop and not DodoSSH**, which is the one decision
here that would have destroyed data. Velopack installs to %LOCALAPPDATA%\<packId>
and removes that whole directory on uninstall, and %LOCALAPPDATA%\DodoSSH is
where ClientPaths keeps the encrypted cache, the outbox of changes not yet
pushed, and the device key. The obvious id would have had the uninstaller
silently delete work the server has never seen — the thing the application
refuses to do without a counted confirmation. Velopack's own advice to move user
data to roaming %APPDATA% is declined for the reason ClientPaths already gives.
**Releases are cut by a person, and CI gains no job that could.** The tempting
argument is that a forge write token is not a signing key. It does not survive
contact with what the token does: Velopack clients trust their feed and do not
verify a package signature when they apply one, so whoever can write a release
can ship an update every install runs. That is the capability ADR 0011 rule 1
puts on a machine which is not a runner, reached through a different door. The
mechanical objection — vpk needs Windows and the runners are Linux — is the
smaller of the two and is recorded beside it, because somebody will fix one and
believe they are done.
Unsigned for now, deliberately and with the cost stated where a user reads it:
SmartScreen warns once per person, on Setup.exe, because Mark-of-the-Web is
applied by the browser that downloaded it. In-app updates are fetched by the
application and applied from a local file, and never trip it.
The banner is a fourth row of the window rather than an overlay. Anything drawn
in the terminal's rectangle is sliced by the native child window that composites
above it — the defect this window has shipped once — and a sibling row is the
arrangement TitleBar and StatusBar already prove works.
----
Three defects surfaced on the way, none of them in the feature being built.
**A settings key absent from the file came back as the CLR default, not the
declared one.** The JSON source generator builds a record through a synthesised
parameterised constructor and assigns every property from its argument array, so
a property initializer runs and is then overwritten by a default for anything the
file did not contain. A settings.json of {} read back a font size of 0, clamped
up to the 8px floor rather than the 13px the renderer draws at. It could not bite
while there was one setting, because that setting was written on every save and
so was never absent; adding a second would have turned automatic update checks
off for every existing profile, silently, the opposite of the documented default.
Reflection-based deserialisation of the same JSON answers correctly, which is why
every way of checking it by hand agrees except the one that ships. The defaults
now live on the constructor parameters, which is the only place the generator
reads them from.
**Declaring a RuntimeIdentifier on the desktop head broke the server's image
build.** It is the obvious way to let a self-contained publish restore under
locked mode, and it writes a net10.0/win-x64 target into the lock file of every
project the head references transitively — including DodoSSH.Contracts and
DodoSSH.Crypto, which the API builds too. The Dockerfile restores those with no
RID and fails NU1004. Found by running docker build rather than by reading. The
RID stays out of the committed state; the two commands that need one ask for it
unlocked, and the release script puts the lock files back.
**A Docker ARG named VERSION silently sets MSBuild's Version.** An ARG is an
environment variable for the rest of the stage, MSBuild reads environment
variables as properties, and property names are case-insensitive. With the
workflow passing main-<short sha> on a main build the publish died with
NETSDK1018 pointing at DodoSSH.Contracts, a project nobody had touched. The build
stage's argument is ASSEMBLY_VERSION now, empty except on a tag build.
All three are in docs/platform-flags.md, which is where the next person will look.
----
Verified: the whole solution builds and restores locked; 289 shell, 93 layout and
54 session tests pass, including the regression test for the settings defect and
a measurement of the banner at the window's minimum width. vpk pack runs end to
end and reports "Verified VelopackApp.Run()" against Program.Main. The API image
builds correctly both as a main build and as a tag build, carrying 1.0.0 and
0.1.0 respectively.
Not verified, and it needs a published release to be: installing, updating and
uninstalling on a real machine. That is Phase 15 of docs/manual-checks.md, and
the pack id and the WebView2 profile fix are reasoned and commented but only
proved by walking it. Two things to watch at the first upload — the reverse
proxy's body-size limit for a 64 MB asset, and whether vpk upload gitea is happy
with Gitea 1.27.1.
This commit is contained in:
@@ -5,6 +5,35 @@
|
||||
<ApplicationManifest>app.manifest</ApplicationManifest>
|
||||
<AvaloniaUseCompiledBindingsByDefault>true</AvaloniaUseCompiledBindingsByDefault>
|
||||
|
||||
<!--
|
||||
The project is named for its layer and the executable is named for the product. Users see the
|
||||
executable — in Task Manager, in a shortcut's target, in the SmartScreen dialog an unsigned
|
||||
installer raises — and DodoSSH.Client.App.exe reads as an implementation detail leaking out.
|
||||
|
||||
Safe to change now and not later: it becomes the main executable recorded in every Velopack
|
||||
package, and changing it after a release means the updater looks for an executable that is no
|
||||
longer there. Nothing else depends on the name — no avares://DodoSSH.Client.App URI exists, the
|
||||
window icon is the assembly-relative /Assets/dodossh.ico, and WindowsDeviceKeyStore names its
|
||||
CNG key with a literal.
|
||||
-->
|
||||
<AssemblyName>DodoSSH</AssemblyName>
|
||||
|
||||
<!--
|
||||
No RuntimeIdentifiers here, and that is the considered answer rather than an omission.
|
||||
|
||||
Declaring win-x64 is the obvious way to let a self-contained publish restore, and it was tried:
|
||||
it works, and it also writes a net10.0/win-x64 target into the lock file of every project this
|
||||
one references transitively — which includes DodoSSH.Contracts and DodoSSH.Crypto, which the
|
||||
server builds too. The API's Dockerfile then restores those projects with no RID and locked
|
||||
mode, and fails NU1004 on a lock file that has grown a runtime identifier the server knows
|
||||
nothing about. The desktop head's packaging would have broken the server's image build.
|
||||
|
||||
So the RID stays out of the committed state entirely, and the publish that needs one asks for
|
||||
it unlocked — see scripts/release-windows.ps1 and the CI step that proves the same thing. The
|
||||
locked restore that gates every ordinary build is untouched, which is the property worth
|
||||
keeping. See docs/platform-flags.md.
|
||||
-->
|
||||
|
||||
<!--
|
||||
The icon on the executable itself — what Explorer, the Start menu and a pinned taskbar button
|
||||
draw, all of which read it from the PE resource and never start the process. Window.Icon in
|
||||
@@ -31,6 +60,33 @@
|
||||
<AvaloniaResource Include="Assets/dodossh.ico" />
|
||||
</ItemGroup>
|
||||
|
||||
<!--
|
||||
Two native symbol files, and they are the reason a self-contained publish weighed 227 MB.
|
||||
|
||||
Measured on a win-x64 publish: libSkiaSharp.pdb is 80.1 MB and libHarfBuzzSharp.pdb is 19.9 MB, so
|
||||
the two of them are 100 MB of debug symbols for third-party native code nobody here will ever step
|
||||
through. Dropping them takes the publish to about 127 MB, which is most of what a first install
|
||||
costs somebody on a slow connection.
|
||||
|
||||
Our own symbols stay, and the distinction is the point rather than a compromise. All fifteen managed
|
||||
PDBs together are 0.93 MB, and with them present an Exception.ToString() carries file names and line
|
||||
numbers — which for a self-hosted product is the whole diagnostic channel, because the way a fault
|
||||
gets reported is a user pasting a stack into an issue.
|
||||
|
||||
Named one by one instead of matched by a pattern. A rule like "drop every .pdb whose assembly is
|
||||
native" would be shorter and would silently start dropping ours the day a managed library ships a
|
||||
file this heuristic misreads, and a build that quietly stops carrying line numbers is not a thing
|
||||
anybody notices until they need them.
|
||||
-->
|
||||
<Target Name="DropNativeSymbolsFromPublish" AfterTargets="ComputeResolvedFilesToPublishList">
|
||||
<ItemGroup>
|
||||
<ResolvedFileToPublish
|
||||
Remove="@(ResolvedFileToPublish)"
|
||||
Condition="'%(Filename)%(Extension)' == 'libSkiaSharp.pdb'
|
||||
or '%(Filename)%(Extension)' == 'libHarfBuzzSharp.pdb'" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Avalonia" />
|
||||
<PackageReference Include="Avalonia.Desktop" />
|
||||
@@ -38,6 +94,14 @@
|
||||
<PackageReference Include="Avalonia.Fonts.Inter" />
|
||||
<PackageReference Include="Avalonia.Controls.WebView" />
|
||||
<PackageReference Include="CommunityToolkit.Mvvm" />
|
||||
<!--
|
||||
Here and in no other project. The Android head must never reference it — that head's
|
||||
distribution is settled by ADR 0011 and has no updater — and DodoSSH.Client.Shell is shared
|
||||
between the two heads, so the one file that names Velopack lives in Platform/ beside
|
||||
WindowsDeviceKeyStore, which is the same shape of thing: a Windows-only implementation of an
|
||||
interface declared in DodoSSH.Client.Session.
|
||||
-->
|
||||
<PackageReference Include="Velopack" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
Reference in New Issue
Block a user