Skip to content

Commit 492f711

Browse files
fix(desktop): stable updates no longer show a nightly's release notes (#32832)
Co-authored-by: Claude Opus 5.5 <[email protected]>
1 parent 37452ee commit 492f711

3 files changed

Lines changed: 121 additions & 2 deletions

File tree

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

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
import * as NodeModule from "node:module";
2+
13
import { assert, describe, it } from "@effect/vitest";
24
import { DESKTOP_UPDATE_RESTART_MARKER_FILE } from "@t3tools/contracts";
5+
import { computeReleaseNotes } from "electron-updater/out/providers/GitHubProvider.js";
36
import * as Cause from "effect/Cause";
47
import * as Deferred from "effect/Deferred";
58
import * as Duration from "effect/Duration";
@@ -22,6 +25,57 @@ import * as DesktopUpdatePolicy from "./DesktopUpdatePolicy.ts";
2225
import * as DesktopUpdates from "./DesktopUpdates.ts";
2326
import { flushCallbacks, makeHarness } from "./updatesTestHarness.ts";
2427

28+
type ReleaseFeed = Parameters<typeof computeReleaseNotes>[2];
29+
type RunningVersion = Parameters<typeof computeReleaseNotes>[0];
30+
31+
// electron-updater's own dependencies, which apps/desktop does not declare.
32+
const requireFromUpdater = NodeModule.createRequire(
33+
NodeModule.createRequire(import.meta.url).resolve("electron-updater"),
34+
);
35+
const { parseXml } = requireFromUpdater("builder-util-runtime") as {
36+
parseXml: (xml: string) => ReleaseFeed;
37+
};
38+
const semver = requireFromUpdater("semver") as { parse: (version: string) => RunningVersion };
39+
40+
const releaseTitle = (version: string) =>
41+
version.includes("-nightly.")
42+
? `T3 Code Nightly ${version} (0123456789ab)`
43+
: `T3 Code v${version}`;
44+
45+
const releaseFeed = (...versions: ReadonlyArray<string>) =>
46+
parseXml(
47+
`<feed xmlns="http://www.w3.org/2005/Atom">${versions
48+
.map(
49+
(version) =>
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>`,
51+
)
52+
.join("")}</feed>`,
53+
);
54+
55+
/** The update info electron-updater's GitHub provider reports when /releases/latest names `version`. */
56+
const stableUpdateInfo = (
57+
feed: ReleaseFeed,
58+
version: string,
59+
runningVersion: string,
60+
fullChangelog: boolean,
61+
) => {
62+
const 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+
};
77+
};
78+
2579
describe("DesktopUpdates", () => {
2680
it.effect("updates Linux .deb installs and leaves other non-AppImage installs off", () =>
2781
Effect.gen(function* () {
@@ -109,6 +163,51 @@ describe("DesktopUpdates", () => {
109163
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
110164
});
111165

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 }) => {
186+
const harness = makeHarness();
187+
188+
return Effect.scoped(
189+
Effect.gen(function* () {
190+
const updates = yield* DesktopUpdates.DesktopUpdates;
191+
yield* updates.configure;
192+
193+
harness.emit(
194+
"update-available",
195+
stableUpdateInfo(
196+
releaseFeed(...feedVersions),
197+
"1.2.4",
198+
runningVersion,
199+
harness.fullChangelog(),
200+
),
201+
);
202+
yield* flushCallbacks;
203+
204+
const state = yield* updates.getState;
205+
assert.equal(state.availableVersion, "1.2.4");
206+
assert.deepEqual(state.releaseNotes, expected);
207+
}),
208+
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
209+
});
210+
112211
it.effect("preserves a queued installer when the feed has no update", () => {
113212
const harness = makeHarness();
114213

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

Lines changed: 6 additions & 2 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

@@ -939,7 +943,7 @@ export const make = Effect.gen(function* () {
939943

940944
const checkedAt = yield* currentIsoTimestamp;
941945
const { releaseNotes, omittedReleaseCount } = normalizeDesktopUpdateReleaseNotes(
942-
info.releaseNotes,
946+
releaseNotesOfOfferedVersion(info),
943947
info.version,
944948
state.channel,
945949
info.releaseDate,

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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,

0 commit comments

Comments
 (0)