Bump to v3.1.1: tray tooltip 'starting up' could get stuck after first launch

Bug: if v3.1 installed via auto-update on a profile with StartMinimised
on, the tray icon's hover tooltip got stuck at the initial "RemSound -
starting up" string. The snapshot tick was running and SetTooltip was
being called every second with the live state, but Windows shell kept
showing the original cached text on hover. The fix-by-workaround was a
hide-then-re-show cycle which forced the shell to rebuild the icon
registration with the latest NotifyIcon.Text.

Root cause: NotifyIcon.Text values set BEFORE the icon's first
NIM_ADD (i.e. while Visible=false) become the shell's "initial"
tooltip when the icon eventually appears. Subsequent NIM_MODIFY calls
from text changes DO propagate, but the shell tends to keep showing
the original text on hover - presumably a tooltip-cache eviction
quirk. In the resume-after-update-with-StartMinimised flow, the
window briefly shows then BeginInvokes a Minimize that flips
Visible=true before the snapshot timer has had a chance to fire, so
the shell registers with the stale "starting up" string.

Fix: drop the hard-coded "starting up" initial text from the
controller ctor entirely. The controller now takes a Func<string>
buildTooltip callback from MainForm and calls it in Minimize() right
before flipping Visible=true, so the shell's NIM_ADD sees current
live state instead of a stale string. The 1 Hz snapshot tick keeps
working for ongoing live updates while the icon is visible.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Ednunp
2026-05-28 14:43:06 +01:00
co-authored by Claude Opus 4.7
parent 752c12b579
commit aa099eb555
5 changed files with 67 additions and 62 deletions
+21 -8
View File
@@ -37,6 +37,7 @@ internal sealed class MainFormTrayController : IDisposable
private readonly Action toggleReceiving;
private readonly Func<IReadOnlyList<string>> getRecentProfilePaths;
private readonly Action<string> switchToProfile;
private readonly Func<string> buildTooltip;
private readonly Action exit;
private readonly ToolStripMenuItem sendingItem;
@@ -51,6 +52,7 @@ internal sealed class MainFormTrayController : IDisposable
Action toggleReceiving,
Func<IReadOnlyList<string>> getRecentProfilePaths,
Action<string> switchToProfile,
Func<string> buildTooltip,
Action exit)
{
this.owner = owner;
@@ -60,16 +62,20 @@ internal sealed class MainFormTrayController : IDisposable
this.toggleReceiving = toggleReceiving;
this.getRecentProfilePaths = getRecentProfilePaths;
this.switchToProfile = switchToProfile;
this.buildTooltip = buildTooltip;
this.exit = exit;
// Initial tooltip text — deliberately NOT just "RemSound" because some screen
// readers (NVDA in particular) read tray icons as "<process name>, <tooltip>",
// which with a single-word "RemSound" tooltip on a "RemSound" process renders as
// "RemSound RemSound" until the first snapshot tick (~1s after launch) overwrites
// it. Picking a sensible startup-state string avoids the duplicate read entirely;
// the snapshot tick refreshes this with live peer / send / receive info from then
// on.
trayIcon.Text = "RemSound — starting up";
// We deliberately don't bake any "starting up" / "running" string into the icon
// here. The tooltip is computed fresh from buildTooltip() at the moment the icon
// first becomes visible (in Minimize) and refreshed every second from MainForm's
// snapshot tick after that. The reason: Windows' shell caches the tooltip text
// it sees at NIM_ADD time and is reluctant to refresh hover text for the same
// icon ID. Setting an "initial" string here meant that on a slow / minimised-at-
// launch flow (e.g. the resume-after-update path with StartMinimised on), the
// shell registered the icon with the stale string and kept showing it until the
// user hid + re-showed the icon. By computing the right text once, just before
// we set Visible = true for the first time, the shell sees the live state from
// NIM_ADD onward.
trayIcon.Icon = SystemIcons.Application;
trayIcon.Visible = false;
trayIcon.DoubleClick += (_, _) => Restore();
@@ -182,6 +188,13 @@ internal sealed class MainFormTrayController : IDisposable
public void Minimize()
{
owner.Hide();
// Refresh the tooltip BEFORE showing the icon so the shell's NIM_ADD call carries
// the current live state (peer count, send / receive routing, recording timer),
// not a stale "starting up" string set earlier. The shell tends to cache hover
// text from NIM_ADD time and is slow to update on subsequent NIM_MODIFY calls —
// computing the right text now means the first hover already reads correctly.
try { SetTooltip(buildTooltip()); }
catch { /* harmless — fall through to the snapshot-tick refresh */ }
trayIcon.Visible = true;
}