Normalize v prefixes in the --version parameter of all commands

Change-type: patch

lib/commands/config/generate.ts

@@ -259,6 +259,8 @@ export default class ConfigGenerateCmd extends Command {
 		if (!options.fleet && options.deviceType) {
 			throw new ExpectedError(this.deviceTypeNotAllowedMessage);
 		}
+		const { normalizeOsVersion } = await import('../../utils/normalization');
+		options.version = normalizeOsVersion(options.version);
 		const { validateDevOptionAndWarn } = await import('../../utils/config');
 		await validateDevOptionAndWarn(options.dev, options.version);
 	}

lib/commands/device/os-update.ts

@@ -100,6 +100,8 @@ export default class DeviceOsUpdateCmd extends Command {
 		// Get target OS version
 		let targetOsVersion = options.version;
 		if (targetOsVersion != null) {
+			const { normalizeOsVersion } = await import('../../utils/normalization');
+			targetOsVersion = normalizeOsVersion(targetOsVersion);
 			if (!hupVersionInfo.versions.includes(targetOsVersion)) {
 				throw new ExpectedError(
 					`The provided version ${targetOsVersion} is not in the Host OS update targets for this device`,

lib/commands/os/configure.ts

@@ -216,9 +216,15 @@ export default class OsConfigureCmd extends Command {
 			configJson = JSON.parse(rawConfig);
 		}
 
-		const osVersion =
+		const { normalizeOsVersion } = await import('../../utils/normalization');
+		const osVersion = normalizeOsVersion(
 			options.version ||
-			(await getOsVersionFromImage(params.image, deviceTypeManifest, devInit));
+				(await getOsVersionFromImage(
+					params.image,
+					deviceTypeManifest,
+					devInit,
+				)),
+		);
 
 		const { validateDevOptionAndWarn } = await import('../../utils/config');
 		await validateDevOptionAndWarn(options.dev, osVersion);

lib/utils/cloud.ts

@@ -202,12 +202,8 @@ async function resolveOSVersion(
 	if (['menu', 'menu-esr'].includes(version)) {
 		return await selectOSVersionFromMenu(deviceType, version === 'menu-esr');
 	}
-	// Note that `version` may also be 'latest', 'recommended', 'default'
+	const { normalizeOsVersion } = await import('./normalization');
-	if (/^v?\d+\.\d+\.\d+/.test(version)) {
+	version = normalizeOsVersion(version);
-		if (version[0] === 'v') {
-			version = version.slice(1);
-		}
-	}
 	return version;
 }
 

lib/utils/config.ts

@@ -184,9 +184,9 @@ export async function validateDevOptionAndWarn(
  * option.
  */
 export async function validateSecureBootOptionAndWarn(
-	secureBoot?: boolean,
+	secureBoot: boolean,
-	slug?: string,
+	slug: string,
-	version?: string,
+	version: string,
 	logger?: import('./logger'),
 ) {
 	if (!secureBoot) {
@@ -202,7 +202,7 @@ export async function validateSecureBootOptionAndWarn(
 	const sdk = getBalenaSdk();
 	const [osRelease] = await sdk.models.os.getAllOsVersions(slug, {
 		$select: 'contract',
-		$filter: { raw_version: `${version.replace(/^v/, '')}` },
+		$filter: { raw_version: version },
 	});
 	if (!osRelease) {
 		throw new ExpectedError(`Error: No ${version} release for ${slug}`);

lib/utils/normalization.ts

@@ -81,3 +81,13 @@ export async function disambiguateReleaseParam(
 export async function lowercaseIfSlug(s: string) {
 	return s.includes('/') ? s.toLowerCase() : s;
 }
+
+export function normalizeOsVersion(version: string) {
+	// Note that `version` may also be 'latest', 'recommended', 'default'
+	if (/^v?\d+\.\d+\.\d+/.test(version)) {
+		if (version[0] === 'v') {
+			version = version.slice(1);
+		}
+	}
+	return version;
+}