import type {
EnvironmentId,
ServerConfig,
ServerInstallation,
ServerSelfUpdateCapability,
} from "@t3tools/contracts";
import type { ServerUpdateState } from "@t3tools/client-runtime/state/server";
import { compareSemverVersions, parseSemver } from "@t3tools/shared/semver";
import * as Schema from "effect/Schema";
import { APP_VERSION } from "./branding";
import { getLocalStorageItem, setLocalStorageItem } from "./hooks/useLocalStorage";
export interface VersionMismatch {
readonly clientVersion: string;
readonly serverVersion: string;
readonly hint: string;
}
const VERSION_MISMATCH_DISMISSALS_STORAGE_KEY = "t3code:version-mismatch-dismissals:v1";
const dismissedServerUpdateFailures = new WeakSet<ServerUpdateState>();
export function isServerUpdateFailureDismissed(state: ServerUpdateState): boolean {
return state.status === "failed" && dismissedServerUpdateFailures.has(state);
}
export function dismissServerUpdateFailure(state: ServerUpdateState): void {
if (state.status === "failed") dismissedServerUpdateFailures.add(state);
}
const VersionMismatchDismissalsSchema = Schema.Struct({
keys: Schema.Array(Schema.String),
});
type VersionMismatchDismissals = typeof VersionMismatchDismissalsSchema.Type;
function normalizeVersion(version: string | null | undefined): string | null {
const trimmed = version?.trim();
return trimmed && trimmed.length > 0 ? trimmed : null;
}
function versionCore(version: string): string {
return version.replace(/[-+].*$/, "");
}
export function resolveVersionMismatch(
serverVersion: string | null | undefined,
clientVersion: string = APP_VERSION,
): VersionMismatch | null {
const normalizedClientVersion = normalizeVersion(clientVersion);
const normalizedServerVersion = normalizeVersion(serverVersion);
if (!normalizedClientVersion || !normalizedServerVersion) {
return null;
}
const clientCore = versionCore(normalizedClientVersion);
const serverCore = versionCore(normalizedServerVersion);
const compareNightlyBuilds =
parseSemver(normalizedClientVersion)?.prerelease[0] === "nightly" &&
parseSemver(normalizedServerVersion)?.prerelease[0] === "nightly";
const serverIsBehind =
parseSemver(clientCore) && parseSemver(serverCore)
? compareSemverVersions(
compareNightlyBuilds ? normalizedServerVersion : serverCore,
compareNightlyBuilds ? normalizedClientVersion : clientCore,
) < 0
: normalizedServerVersion !== normalizedClientVersion;
if (!serverIsBehind) {
return null;
}
return {
clientVersion: normalizedClientVersion,
serverVersion: normalizedServerVersion,
hint: "Version mismatch. Try syncing the client and server to the same T3 Code version.",
};
}
export function resolveServerConfigVersionMismatch(
serverConfig: Pick<ServerConfig, "environment"> | null | undefined,
): VersionMismatch | null {
return resolveVersionMismatch(serverConfig?.environment.serverVersion);
}
export function resolveServerSelfUpdateCapability(
serverConfig: Pick<ServerConfig, "environment"> | null | undefined,
): ServerSelfUpdateCapability | null {
return serverConfig?.environment.capabilities.serverSelfUpdate ?? null;
}
export function supportsDesktopAppUpdate(
serverConfig: Pick<ServerConfig, "environment"> | null | undefined,
): boolean {
return serverConfig?.environment.capabilities.desktopAppUpdate === true;
}
export function manualServerUpdateCommand(
targetVersion: string,
installation?: ServerInstallation,
): string {
if (installation?.kind === "npm-global") {
const prefix = `'${installation.prefix.replaceAll("'", "'\\''")}'`;
return `npm install --global --prefix ${prefix} t3@${targetVersion}`;
}
const runner =
installation?.kind === "pnpm-dlx" ? "pnpm dlx" : installation?.kind === "bunx" ? "bunx" : "npx";
return `${runner} t3@${targetVersion}`;
}
export function buildVersionMismatchDismissalKey(
environmentId: EnvironmentId,
mismatch: Pick<VersionMismatch, "clientVersion" | "serverVersion">,
): string {
return `${environmentId}:${mismatch.clientVersion}:${mismatch.serverVersion}`;
}
function readVersionMismatchDismissals(): VersionMismatchDismissals {
try {
return (
getLocalStorageItem(
VERSION_MISMATCH_DISMISSALS_STORAGE_KEY,
VersionMismatchDismissalsSchema,
) ?? { keys: [] }
);
} catch (error) {
console.error("Could not read version-mismatch dismissals.", error);
return { keys: [] };
}
}
function writeVersionMismatchDismissals(document: VersionMismatchDismissals): void {
try {
setLocalStorageItem(
VERSION_MISMATCH_DISMISSALS_STORAGE_KEY,
document,
VersionMismatchDismissalsSchema,
);
} catch (error) {
console.error("Could not persist version-mismatch dismissals.", error);
}
}
export function isVersionMismatchDismissed(dismissalKey: string | null | undefined): boolean {
if (!dismissalKey) {
return false;
}
return readVersionMismatchDismissals().keys.includes(dismissalKey);
}
export function dismissVersionMismatch(dismissalKey: string | null | undefined): void {
if (!dismissalKey) {
return;
}
const document = readVersionMismatchDismissals();
if (document.keys.includes(dismissalKey)) {
return;
}
writeVersionMismatchDismissals({
keys: [...document.keys, dismissalKey],
});
}