device os-update: Add support for updates that require takeover

package.json

@@ -198,6 +198,7 @@
     "balena-config-json": "^4.2.0",
     "balena-device-init": "^7.0.1",
     "balena-errors": "^4.7.3",
+    "balena-hup-action-utils": "^6.2.0-build-ui-takeover-test-570b5b071b6ce6fe12ffdf4194a616f1203147aa-1",
     "balena-image-fs": "^7.0.6",
     "balena-preload": "^16.0.0",
     "balena-sdk": "^20.3.0",

src/commands/device/os-update.ts

@@ -20,6 +20,7 @@ import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
 import type { Device } from 'balena-sdk';
 import { ExpectedError } from '../../errors';
+import { getExpandedProp } from '../../utils/pine';
 
 export default class DeviceOsUpdateCmd extends Command {
 	public static description = stripIndent`
@@ -68,15 +69,19 @@ export default class DeviceOsUpdateCmd extends Command {
 		const sdk = getBalenaSdk();
 
 		// Get device info
-		const { uuid, is_of__device_type, os_version, os_variant } =
-			(await sdk.models.device.get(params.uuid, {
-				$select: ['uuid', 'os_version', 'os_variant'],
-				$expand: {
-					is_of__device_type: {
-						$select: 'slug',
-					},
+		const {
+			// uuid,
+			is_of__device_type,
+			os_version,
+			os_variant,
+		} = (await sdk.models.device.get(params.uuid, {
+			$select: ['uuid', 'os_version', 'os_variant'],
+			$expand: {
+				is_of__device_type: {
+					$select: 'slug',
 				},
-			})) as DeviceWithDeviceType;
+			},
+		})) as DeviceWithDeviceType;
 
 		// Get current device OS version
 		const currentOsVersion = sdk.models.device.getOsVersion({
@@ -115,6 +120,10 @@ export default class DeviceOsUpdateCmd extends Command {
 			);
 		}
 
+		const { HUPActionHelper, actionsConfig } = await import(
+			'balena-hup-action-utils'
+		);
+		const hupActionHelper = new HUPActionHelper(actionsConfig);
 		// Get target OS version
 		let targetOsVersion = options.version;
 		if (targetOsVersion != null) {
@@ -129,35 +138,58 @@ export default class DeviceOsUpdateCmd extends Command {
 			targetOsVersion = await getCliForm().ask({
 				message: 'Target OS version',
 				type: 'list',
-				choices: hupVersionInfo.versions.map((version) => ({
-					name:
-						hupVersionInfo.recommended === version
-							? `${version} (recommended)`
-							: version,
-					value: version,
-				})),
+				choices: hupVersionInfo.versions.map((version) => {
+					const takeoverRequired =
+						hupActionHelper.getHUPActionType(
+							getExpandedProp(is_of__device_type, 'slug')!,
+							currentOsVersion,
+							version,
+						) === 'takeover';
+
+					return {
+						name: `${
+							hupVersionInfo.recommended === version
+								? `${version} (recommended)`
+								: version
+						}${takeoverRequired ? ' WARNING: No rollback mechanism' : ''}`,
+						value: version,
+					};
+				}),
 			});
 		}
 
+		const takeoverRequired =
+			hupActionHelper.getHUPActionType(
+				getExpandedProp(is_of__device_type, 'slug')!,
+				currentOsVersion,
+				targetOsVersion,
+			) === 'takeover';
 		const patterns = await import('../../utils/patterns');
+		// Warn the user if the update requires a takeover
+		if (takeoverRequired) {
+			await patterns.confirm(
+				options.yes || false,
+				'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
+			);
+		}
 		// Confirm and start update
 		await patterns.confirm(
 			options.yes || false,
 			'Host OS updates require a device restart when they complete. Are you sure you want to proceed?',
 		);
 
-		await sdk.models.device
-			.startOsUpdate(uuid, targetOsVersion, {
-				runDetached: true,
-			})
-			.then(() => {
-				console.log(
-					`The balena OS update has started. You can keep track of the progress via the dashboard.\n` +
-						`To open the dashboard page related to a device via the CLI, you can use \`balena device UUID --view\``,
-				);
-			})
-			.catch((error) => {
-				console.error(`Failed to start OS update for device ${uuid}:`, error);
-			});
+		// await sdk.models.device
+		// 	.startOsUpdate(uuid, targetOsVersion, {
+		// 		runDetached: true,
+		// 	})
+		// 	.then(() => {
+		// 		console.log(
+		// 			`The balena OS update has started. You can keep track of the progress via the dashboard.\n` +
+		// 				`To open the dashboard page related to a device via the CLI, you can use \`balena device UUID --view\``,
+		// 		);
+		// 	})
+		// 	.catch((error) => {
+		// 		console.error(`Failed to start OS update for device ${uuid}:`, error);
+		// 	});
 	}
 }