Skip to content

Commit 1fa62a9

Browse files
fix(desktop): stable notes survive a switch down from Nightly
Always requesting the full changelog dropped a Stable release's notes when it is offered below the running Nightly, because electron-updater's full changelog only lists versions above the running one. Stable is back on the single release-notes string, kept only when the feed entry it came from (its releaseName) names the offered version. AI-assisted; verified with the tests and tools listed above. Co-Authored-By: Claude Opus 5.5 <[email protected]>
1 parent f11e843 commit 1fa62a9

4 files changed

Lines changed: 83 additions & 52 deletions

File tree

‎apps/desktop/src/updates/DesktopUpdates.test.ts‎

Lines changed: 53 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -37,29 +37,43 @@ const { parseXml } = requireFromUpdater("builder-util-runtime") as {
3737
};
3838
const semver = requireFromUpdater("semver") as { parse: (version: string) => RunningVersion };
3939

40+
const releaseTitle = (version: string) =>
41+
version.includes("-nightly.")
42+
? `T3 Code Nightly ${version} (0123456789ab)`
43+
: `T3 Code v${version}`;
44+
4045
const releaseFeed = (...versions: ReadonlyArray<string>) =>
4146
parseXml(
4247
`<feed xmlns="http://www.w3.org/2005/Atom">${versions
4348
.map(
4449
(version) =>
45-
`<entry><link rel="alternate" type="text/html" href="https://github.com/pingdotgg/t3code/releases/tag/v${version}"/><title>v${version}</title><content type="html">&lt;ul&gt;&lt;li&gt;${version} change&lt;/li&gt;&lt;/ul&gt;</content></entry>`,
50+
`<entry><link rel="alternate" type="text/html" href="https://github.com/pingdotgg/t3code/releases/tag/v${version}"/><title>${releaseTitle(version)}</title><content type="html">&lt;ul&gt;&lt;li&gt;${version} change&lt;/li&gt;&lt;/ul&gt;</content></entry>`,
4651
)
4752
.join("")}</feed>`,
4853
);
4954

50-
/** The notes electron-updater's GitHub provider reports when /releases/latest names `offeredVersion`. */
51-
const stableReleaseNotes = (
55+
/** The update info electron-updater's GitHub provider reports when /releases/latest names `version`. */
56+
const stableUpdateInfo = (
5257
feed: ReleaseFeed,
53-
offeredVersion: string,
58+
version: string,
5459
runningVersion: string,
5560
fullChangelog: boolean,
5661
) => {
57-
const entries = feed.getElements("entry");
5862
const latestRelease =
59-
entries.find((entry) =>
60-
entry.element("link").attribute("href").endsWith(`/tag/v${offeredVersion}`),
61-
) ?? feed.element("entry");
62-
return computeReleaseNotes(semver.parse(runningVersion), fullChangelog, feed, latestRelease);
63+
feed
64+
.getElements("entry")
65+
.find((entry) => entry.element("link").attribute("href").endsWith(`/tag/v${version}`)) ??
66+
feed.element("entry");
67+
return {
68+
version,
69+
releaseName: latestRelease.elementValueOrEmpty("title"),
70+
releaseNotes: computeReleaseNotes(
71+
semver.parse(runningVersion),
72+
fullChangelog,
73+
feed,
74+
latestRelease,
75+
),
76+
};
6377
};
6478

6579
describe("DesktopUpdates", () => {
@@ -149,46 +163,47 @@ describe("DesktopUpdates", () => {
149163
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
150164
});
151165

152-
it.effect("shows no notes for a Stable release missing from the releases feed", () => {
166+
it.effect.each([
167+
{
168+
name: "shows no notes for a Stable release missing from the releases feed",
169+
runningVersion: "1.2.3",
170+
feedVersions: ["1.2.5-nightly.20261102.1", "1.2.5-nightly.20261101.1"],
171+
expected: [],
172+
},
173+
{
174+
name: "shows a Stable release's own notes from the releases feed",
175+
runningVersion: "1.2.3",
176+
feedVersions: ["1.2.5-nightly.20261102.1", "1.2.4", "1.2.4-nightly.20261030.1"],
177+
expected: [{ version: "1.2.4", items: ["1.2.4 change"], totalItems: 1 }],
178+
},
179+
{
180+
name: "shows a Stable release's notes when switching down from a newer Nightly",
181+
runningVersion: "1.2.5-nightly.20261027.1",
182+
feedVersions: ["1.2.5-nightly.20261102.1", "1.2.4"],
183+
expected: [{ version: "1.2.4", items: ["1.2.4 change"], totalItems: 1 }],
184+
},
185+
])("$name", ({ runningVersion, feedVersions, expected }) => {
153186
const harness = makeHarness();
154-
const feed = releaseFeed("1.2.5-nightly.20261102.1", "1.2.5-nightly.20261101.1");
155187

156188
return Effect.scoped(
157189
Effect.gen(function* () {
158190
const updates = yield* DesktopUpdates.DesktopUpdates;
159191
yield* updates.configure;
160192

161-
harness.emit("update-available", {
162-
version: "1.2.4",
163-
releaseNotes: stableReleaseNotes(feed, "1.2.4", "1.2.3", harness.fullChangelog()),
164-
});
193+
harness.emit(
194+
"update-available",
195+
stableUpdateInfo(
196+
releaseFeed(...feedVersions),
197+
"1.2.4",
198+
runningVersion,
199+
harness.fullChangelog(),
200+
),
201+
);
165202
yield* flushCallbacks;
166203

167204
const state = yield* updates.getState;
168205
assert.equal(state.availableVersion, "1.2.4");
169-
assert.deepEqual(state.releaseNotes, [], "Stable release shows a Nightly's notes");
170-
}),
171-
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
172-
});
173-
174-
it.effect("shows a Stable release's own notes from the releases feed", () => {
175-
const harness = makeHarness();
176-
const feed = releaseFeed("1.2.5-nightly.20261102.1", "1.2.4", "1.2.4-nightly.20261030.1");
177-
178-
return Effect.scoped(
179-
Effect.gen(function* () {
180-
const updates = yield* DesktopUpdates.DesktopUpdates;
181-
yield* updates.configure;
182-
183-
harness.emit("update-available", {
184-
version: "1.2.4",
185-
releaseNotes: stableReleaseNotes(feed, "1.2.4", "1.2.3", harness.fullChangelog()),
186-
});
187-
yield* flushCallbacks;
188-
189-
assert.deepEqual((yield* updates.getState).releaseNotes, [
190-
{ version: "1.2.4", items: ["1.2.4 change"], totalItems: 1 },
191-
]);
206+
assert.deepEqual(state.releaseNotes, expected);
192207
}),
193208
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
194209
});

‎apps/desktop/src/updates/DesktopUpdates.ts‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ import * as ElectronWindow from "../electron/ElectronWindow.ts";
3636
import * as IpcChannels from "../ipc/channels.ts";
3737
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
3838
import * as DesktopUpdatePolicy from "./DesktopUpdatePolicy.ts";
39-
import { normalizeDesktopUpdateReleaseNotes } from "./releaseNotes.ts";
39+
import {
40+
normalizeDesktopUpdateReleaseNotes,
41+
releaseNotesOfOfferedVersion,
42+
} from "./releaseNotes.ts";
4043
import { desktopUpdateChannelOf } from "@t3tools/shared/cliRelease";
4144
import { compareSemverVersions } from "@t3tools/shared/semver";
4245
import {
@@ -72,6 +75,7 @@ const UpdateInfo = Schema.Struct({
7275
version: Schema.String,
7376
// Malformed notes must not block update-state decoding; normalizeDesktopUpdateReleaseNotes validates separately.
7477
releaseNotes: Schema.optional(Schema.Unknown),
78+
releaseName: Schema.optional(Schema.NullOr(Schema.String)),
7579
releaseDate: Schema.optional(Schema.String),
7680
});
7781

@@ -520,7 +524,12 @@ export const make = Effect.gen(function* () {
520524
// An older build can lack migrations this one ran. Only a guarded track switch's own check
521525
// may offer one.
522526
yield* electronUpdater.setAllowDowngrade(false);
523-
yield* logUpdaterInfo("using update channel", { channel, allowPrerelease: allowsPrerelease });
527+
yield* electronUpdater.setFullChangelog(allowsPrerelease);
528+
yield* logUpdaterInfo("using update channel", {
529+
channel,
530+
allowPrerelease: allowsPrerelease,
531+
fullChangelog: allowsPrerelease,
532+
});
524533
});
525534

526535
const checkForUpdates = Effect.fn("desktop.updates.checkForUpdates")(function* (
@@ -934,7 +943,7 @@ export const make = Effect.gen(function* () {
934943

935944
const checkedAt = yield* currentIsoTimestamp;
936945
const { releaseNotes, omittedReleaseCount } = normalizeDesktopUpdateReleaseNotes(
937-
info.releaseNotes,
946+
releaseNotesOfOfferedVersion(info),
938947
info.version,
939948
state.channel,
940949
info.releaseDate,
@@ -1154,9 +1163,6 @@ export const make = Effect.gen(function* () {
11541163

11551164
yield* electronUpdater.setAutoDownload(false);
11561165
yield* electronUpdater.setAutoInstallOnAppQuit(false);
1157-
// Without it, a release missing from the feed's first page gets the newest entry's notes,
1158-
// untagged. Tagged notes let normalizeDesktopUpdateReleaseNotes drop other channels.
1159-
yield* electronUpdater.setFullChangelog(true);
11601166
yield* applyAutoUpdaterChannel(settings.updateChannel);
11611167
yield* electronUpdater.setDisableDifferentialDownload(
11621168
isArm64HostRunningIntelBuild(environment.runtimeInfo),

‎apps/desktop/src/updates/releaseNotes.test.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,6 @@ describe("normalizeDesktopUpdateReleaseNotes", () => {
188188
[
189189
{ version: "0.0.42", note: "- Stable change" },
190190
{ version: "0.0.42-nightly.20260915.1710", note: "- Nightly change" },
191-
{ version: "0.0.42-preview.20260914.1683", note: "- Maintainer test build" },
192191
],
193192
"0.0.42",
194193
"latest",

‎apps/desktop/src/updates/releaseNotes.ts‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import type { DesktopUpdateChannel, DesktopUpdateReleaseNote } from "@t3tools/contracts";
22

3-
import { cliReleaseChannelOf, desktopUpdateChannelOf } from "@t3tools/shared/cliRelease";
3+
import { desktopUpdateChannelOf } from "@t3tools/shared/cliRelease";
44

55
interface ElectronReleaseNoteInfo {
66
readonly version: string;
@@ -171,6 +171,22 @@ interface NormalizedDesktopUpdateReleaseNotes {
171171
readonly omittedReleaseCount: number;
172172
}
173173

174+
const escapeRegExp = (value: string) => value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
175+
176+
/**
177+
* Untagged notes come from the feed entry named by releaseName, which is the newest entry when the
178+
* offered release is not on the feed's first page. Keep them only when that entry is the offered one.
179+
*/
180+
export function releaseNotesOfOfferedVersion(info: {
181+
readonly version: string;
182+
readonly releaseNotes?: unknown;
183+
readonly releaseName?: string | null | undefined;
184+
}): unknown {
185+
if (typeof info.releaseNotes !== "string" || !info.releaseName) return info.releaseNotes;
186+
const namesVersion = new RegExp(`(?:^|[^\\w.-])v?${escapeRegExp(info.version)}(?![\\w.-])`);
187+
return namesVersion.test(info.releaseName) ? info.releaseNotes : undefined;
188+
}
189+
174190
/** fullChangelog includes all greater semvers, so preview cuts sort above nightlies of the same base version. */
175191
export function normalizeDesktopUpdateReleaseNotes(
176192
releaseNotes: unknown,
@@ -184,12 +200,7 @@ export function normalizeDesktopUpdateReleaseNotes(
184200
: Array.isArray(releaseNotes)
185201
? releaseNotes.filter(isElectronReleaseNoteInfo)
186202
: []
187-
).filter(
188-
// Preview builds read as Stable but are never offered, and their feed notes are a warning.
189-
(entry) =>
190-
desktopUpdateChannelOf(entry.version) === channel &&
191-
cliReleaseChannelOf(entry.version) !== "preview",
192-
);
203+
).filter((entry) => desktopUpdateChannelOf(entry.version) === channel);
193204

194205
const normalizedNotes = rawNotes.flatMap((entry) => {
195206
const note = extractReleaseNoteItems(entry.note);

0 commit comments

Comments
 (0)