Files
openclaw/src/infra/update-channels.test.ts
Mark e070519f43 fix(updater): exclude prerelease tags from stable git channel (#86559)
Preserve legacy numeric stable git tags while excluding named semver prerelease tags from stable git channel detection and status display.

Thanks @goldmar.
2026-05-26 21:11:38 +01:00

287 lines
8.6 KiB
TypeScript

import { describe, expect, it } from "vitest";
import {
channelToNpmTag,
formatUpdateChannelLabel,
isBetaTag,
isPrereleaseTag,
isStableTag,
normalizeUpdateChannel,
resolveEffectiveUpdateChannel,
resolveRegistryUpdateChannel,
resolveUpdateChannelDisplay,
type UpdateChannel,
type UpdateChannelSource,
} from "./update-channels.js";
describe("update-channels tag detection", () => {
it.each([
{ tag: "v2026.2.24-beta.1", beta: true },
{ tag: "v2026.2.24.beta.1", beta: true },
{ tag: "v2026.2.24-BETA-1", beta: true },
{ tag: "v2026.2.24-alpha.1", beta: false },
{ tag: "v2026.2.24-next.1", beta: false },
{ tag: "v2026.2.24-1", beta: false },
{ tag: "v2026.2.24-alphabeta.1", beta: false },
{ tag: "v2026.2.24", beta: false },
])("classifies $tag", ({ tag, beta }) => {
expect(isBetaTag(tag)).toBe(beta);
});
it.each([
{ tag: "v2026.2.24-alpha.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-beta.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-rc.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-preview.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-dev.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-next.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-canary.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-nightly.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-experimental.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-custom.1", prerelease: true, stable: false },
{ tag: "v2026.2.24-1", prerelease: false, stable: true },
{ tag: "v1.0.1-1", prerelease: false, stable: true },
{ tag: "v2026.2.24-alphabeta.1", prerelease: true, stable: false },
{ tag: "v2026.2.24", prerelease: false, stable: true },
])("stable/prerelease classification for $tag", ({ tag, prerelease, stable }) => {
expect(isPrereleaseTag(tag)).toBe(prerelease);
expect(isStableTag(tag)).toBe(stable);
});
});
describe("normalizeUpdateChannel", () => {
it.each([
{ value: "stable", expected: "stable" },
{ value: " BETA ", expected: "beta" },
{ value: "Dev", expected: "dev" },
{ value: "", expected: null },
{ value: " nightly ", expected: null },
{ value: null, expected: null },
{ value: undefined, expected: null },
] satisfies Array<{ value: string | null | undefined; expected: UpdateChannel | null }>)(
"normalizes %j",
({ value, expected }) => {
expect(normalizeUpdateChannel(value)).toBe(expected);
},
);
});
describe("channelToNpmTag", () => {
it.each([
{ channel: "stable", expected: "latest" },
{ channel: "beta", expected: "beta" },
{ channel: "dev", expected: "dev" },
] satisfies Array<{ channel: UpdateChannel; expected: string }>)(
"maps $channel to $expected",
({ channel, expected }) => {
expect(channelToNpmTag(channel)).toBe(expected);
},
);
});
describe("resolveEffectiveUpdateChannel", () => {
it.each([
{
name: "prefers config over git metadata",
params: {
configChannel: "beta",
installKind: "git" as const,
git: { tag: "v2026.2.24", branch: "feature/test" },
},
expected: { channel: "beta", source: "config" },
},
{
name: "uses installed beta version over stale stable config",
params: {
configChannel: "stable",
currentVersion: "2026.5.2-beta.1",
installKind: "package" as const,
},
expected: { channel: "beta", source: "installed-version" },
},
{
name: "uses beta git tag",
params: {
installKind: "git" as const,
git: { tag: "v2026.2.24-beta.1" },
},
expected: { channel: "beta", source: "git-tag" },
},
{
name: "treats non-beta git tag as stable",
params: {
installKind: "git" as const,
git: { tag: "v2026.2.24" },
},
expected: { channel: "stable", source: "git-tag" },
},
{
name: "treats non-beta prerelease git tag as dev",
params: {
installKind: "git" as const,
git: { tag: "v2026.5.25-alpha.1" },
},
expected: { channel: "dev", source: "git-tag" },
},
{
name: "preserves legacy numeric stable git tags",
params: {
installKind: "git" as const,
git: { tag: "v1.0.1-1" },
},
expected: { channel: "stable", source: "git-tag" },
},
{
name: "uses non-HEAD git branch as dev",
params: {
installKind: "git" as const,
git: { branch: "feature/test" },
},
expected: { channel: "dev", source: "git-branch" },
},
{
name: "falls back for detached HEAD git installs",
params: {
installKind: "git" as const,
git: { branch: "HEAD" },
},
expected: { channel: "dev", source: "default" },
},
{
name: "defaults package installs to stable",
params: { installKind: "package" as const },
expected: { channel: "stable", source: "default" },
},
{
name: "defaults unknown installs to stable",
params: { installKind: "unknown" as const },
expected: { channel: "stable", source: "default" },
},
] satisfies Array<{
name: string;
params: Parameters<typeof resolveEffectiveUpdateChannel>[0];
expected: { channel: UpdateChannel; source: UpdateChannelSource };
}>)("$name", ({ params, expected }) => {
expect(resolveEffectiveUpdateChannel(params)).toEqual(expected);
});
});
describe("formatUpdateChannelLabel", () => {
it.each([
{
name: "formats config labels",
params: { channel: "beta", source: "config" as const },
expected: "beta (config)",
},
{
name: "formats git tag labels with tag",
params: {
channel: "stable",
source: "git-tag" as const,
gitTag: "v2026.2.24",
},
expected: "stable (v2026.2.24)",
},
{
name: "formats git tag labels without tag",
params: { channel: "stable", source: "git-tag" as const },
expected: "stable (tag)",
},
{
name: "formats git branch labels with branch",
params: {
channel: "dev",
source: "git-branch" as const,
gitBranch: "feature/test",
},
expected: "dev (feature/test)",
},
{
name: "formats git branch labels without branch",
params: { channel: "dev", source: "git-branch" as const },
expected: "dev (branch)",
},
{
name: "formats installed-version labels",
params: { channel: "beta", source: "installed-version" as const },
expected: "beta (installed version)",
},
{
name: "formats default labels",
params: { channel: "stable", source: "default" as const },
expected: "stable (default)",
},
] satisfies Array<{
name: string;
params: Parameters<typeof formatUpdateChannelLabel>[0];
expected: string;
}>)("$name", ({ params, expected }) => {
expect(formatUpdateChannelLabel(params)).toBe(expected);
});
});
describe("resolveUpdateChannelDisplay", () => {
it("labels stale stable config on a beta install from the installed version", () => {
expect(
resolveUpdateChannelDisplay({
configChannel: "stable",
currentVersion: "2026.5.2-beta.1",
installKind: "package",
}),
).toEqual({
channel: "beta",
source: "installed-version",
label: "beta (installed version)",
});
});
it("includes the derived label for git branches", () => {
expect(
resolveUpdateChannelDisplay({
installKind: "git",
gitBranch: "feature/test",
}),
).toEqual({
channel: "dev",
source: "git-branch",
label: "dev (feature/test)",
});
});
it("prefers git tag precedence over branch metadata in the derived label", () => {
expect(
resolveUpdateChannelDisplay({
installKind: "git",
gitTag: "v2026.2.24-beta.1",
gitBranch: "feature/test",
}),
).toEqual({
channel: "beta",
source: "git-tag",
label: "beta (v2026.2.24-beta.1)",
});
});
it("does not synthesize git metadata when both tag and branch are missing", () => {
expect(
resolveUpdateChannelDisplay({
installKind: "package",
}),
).toEqual({
channel: "stable",
source: "default",
label: "stable (default)",
});
});
});
describe("resolveRegistryUpdateChannel", () => {
it("queries beta when the installed version is beta even if config is stale stable", () => {
expect(
resolveRegistryUpdateChannel({
configChannel: "stable",
currentVersion: "2026.5.2-beta.1",
}),
).toBe("beta");
});
});