is_pinned_on__release: Add translations and move reads to the new column

Change-type: minor

src/balena.sbvr

@@ -864,7 +864,7 @@ Rule: It is necessary that each application that owns a release1 that has a stat
 Rule: It is necessary that each image that has a status that is equal to "success", has a push timestamp.
 Rule: It is necessary that each application that owns a release1 that has a status that is equal to "success" and has a commit1, owns at most one release2 that has a status that is equal to "success" and has a commit2 that is equal to the commit1.
 Rule: It is necessary that each application that owns a release1 that has a revision, owns at most one release2 that has a semver major that is of the release1 and has a semver minor that is of the release1 and has a semver patch that is of the release1 and has a semver prerelease that is of the release1 and has a variant that is of the release1 and has a revision that is of the release1.
-Rule: It is necessary that each release that should be running on a device, has a status that is equal to "success" and belongs to an application1 that the device belongs to.
+Rule: It is necessary that each release that is pinned to a device, has a status that is equal to "success" and belongs to an application1 that the device belongs to.
 Rule: It is necessary that each release that should be running on an application, has a status that is equal to "success" and belongs to the application.
 Rule: It is necessary that each application that owns a release that contains at least 2 images, has an application type that supports multicontainer.
 Rule: It is necessary that each release that should operate a device, has a status that is equal to "success".

src/features/ci-cd/hooks/app-update-trigger.ts

@@ -21,7 +21,7 @@ hooks.addPureHook('PATCH', 'resin', 'application', {
 							is_running__release: {
 								$ne: request.values.should_be_running__release,
 							},
-							should_be_running__release: null,
+							is_pinned_on__release: null,
 						},
 						wait: false,
 					});

src/features/ci-cd/hooks/device-update-trigger.ts

@@ -11,7 +11,7 @@ hooks.addPureHook('PATCH', 'resin', 'device', {
 		// * target release changed
 		// * device name changed - so a user can restart their service and it will pick up the change
 		if (
-			(request.values.should_be_running__release !== undefined ||
+			(request.values.is_pinned_on__release !== undefined ||
 				request.values.belongs_to__application != null ||
 				request.values.device_name != null) &&
 			affectedIds.length !== 0

src/features/ci-cd/hooks/service-installs.ts

@@ -189,7 +189,7 @@ hooks.addPureHook('PATCH', 'resin', 'application', {
 				api,
 				{
 					belongs_to__application: { $in: affectedIds },
-					should_be_running__release: null,
+					is_pinned_on__release: null,
 				},
 				{
 					id: request.values.should_be_running__release,
@@ -236,14 +236,14 @@ hooks.addPureHook('PATCH', 'resin', 'device', {
 	POSTRUN: async ({ api, request }) => {
 		const affectedIds = request.affectedIds!;
 		if (
-			request.values.should_be_running__release !== undefined &&
+			request.values.is_pinned_on__release !== undefined &&
 			affectedIds.length !== 0
 		) {
 			// If the device was preloaded, and then pinned, service_installs do not exist
 			// for this device+release combination. We need to create these
-			if (request.values.should_be_running__release != null) {
+			if (request.values.is_pinned_on__release != null) {
 				await createReleaseServiceInstalls(api, affectedIds, {
-					id: request.values.should_be_running__release,
+					id: request.values.is_pinned_on__release,
 				});
 			} else {
 				const devices = (await api.get({

src/features/device-state/routes/state-get-v2.ts

@@ -202,7 +202,7 @@ const stateQuery = _.once(() =>
 				device_environment_variable: {
 					$select: ['name', 'value'],
 				},
-				should_be_running__release: releaseExpand,
+				is_pinned_on__release: releaseExpand,
 				service_install: {
 					$select: ['id'],
 					$expand: {

src/features/device-state/routes/state-get-v3.ts

@@ -226,7 +226,7 @@ const deviceExpand: Expand = {
 	device_environment_variable: {
 		$select: ['name', 'value'],
 	},
-	should_be_running__release: releaseExpand,
+	is_pinned_on__release: releaseExpand,
 	service_install: {
 		$select: ['id'],
 		$expand: {
@@ -320,7 +320,7 @@ const getStateV3 = async (req: Request, uuid: string): Promise<StateV3> => {
 				'io.balena.image.store': 'root',
 			},
 		),
-		...getAppState(device, 'should_be_running__release', config),
+		...getAppState(device, 'is_pinned_on__release', config),
 	};
 
 	const state: StateV3 = {
@@ -365,15 +365,15 @@ const getDevice = getStateDelayingEmpty(
 const getAppState = (
 	device: AnyObject,
 	targetReleaseField:
-		| 'should_be_running__release'
+		| 'is_pinned_on__release'
 		| 'should_be_managed_by__release'
 		| 'should_be_operated_by__release',
 	config: Dictionary<string>,
 	defaultLabels?: Dictionary<string>,
 ): StateV3[string]['apps'] | null => {
 	let application: AnyObject;
 	let release: AnyObject | undefined;
-	if (targetReleaseField === 'should_be_running__release') {
+	if (targetReleaseField === 'is_pinned_on__release') {
 		application = device.belongs_to__application[0];
 		release = getReleaseForDevice(device);
 	} else {

src/features/device-state/routes/state-patch-v2.ts

@@ -7,7 +7,7 @@ import {
 } from '../../../infra/error-handling/index.js';
 import { sbvrUtils, errors } from '@balena/pinejs';
 import { getIP } from '../../../lib/utils.js';
-import type { ImageInstall } from '../../../balena-model.js';
+import type { Device, ImageInstall } from '../../../balena-model.js';
 import type { PickDeferred } from '@balena/abstract-sql-to-typescript';
 import {
 	shouldUpdateMetrics,
@@ -141,9 +141,10 @@ export const statePatchV2: RequestHandler = async (req, res) => {
 		if (local != null) {
 			const { apps } = local;
 
-			let deviceBody: Pick<LocalBody, (typeof v2ValidPatchFields)[number]> & {
-				is_running__release?: number | null;
-			} = _.pick(local, v2ValidPatchFields);
+			let deviceBody: Pick<LocalBody, (typeof v2ValidPatchFields)[number]> &
+				Partial<
+					Pick<Device['Write'], 'is_running__release' | 'is_pinned_on__release'>
+				> = _.pick(local, v2ValidPatchFields);
 			let metricsBody: Pick<LocalBody, (typeof metricsPatchFields)[number]> =
 				_.pick(local, metricsPatchFields);
 			limitMetricNumbers(metricsBody);
@@ -157,6 +158,9 @@ export const statePatchV2: RequestHandler = async (req, res) => {
 				metricsBody = {};
 			}
 
+			if (local.should_be_running__release !== undefined) {
+				deviceBody.is_pinned_on__release = local.should_be_running__release;
+			}
 			if (local.name != null) {
 				deviceBody.device_name = local.name;
 			}

src/features/device-state/state-get-utils.ts

@@ -65,8 +65,8 @@ export const getConfig = (
 export const getReleaseForDevice = (
 	device: AnyObject,
 ): AnyObject | undefined => {
-	if (device.should_be_running__release[0] != null) {
-		return device.should_be_running__release[0];
+	if (device.is_pinned_on__release[0] != null) {
+		return device.is_pinned_on__release[0];
 	}
 	return device.belongs_to__application[0]?.should_be_running__release[0];
 };

src/features/device-state/state-patch-utils.ts

@@ -32,13 +32,7 @@ export const v3ValidPatchFields: Array<
 
 export const v2ValidPatchFields: Array<
 	Exclude<keyof NonNullable<StatePatchV2Body['local']>, 'apps'>
-> = [
-	...v3ValidPatchFields,
-	'should_be_running__release',
-	'device_name',
-	'note',
-	'download_progress',
-];
+> = [...v3ValidPatchFields, 'device_name', 'note', 'download_progress'];
 
 const SHORT_TEXT_LENGTH = 255;
 const ADDRESS_DELIMITER = ' ';

src/features/devices/hooks/defaults-validation.ts

@@ -31,12 +31,12 @@ hooks.addPureHook('POST', 'resin', 'device', {
 		}
 
 		// TODO[device management next step]: Drop this after re-migrating all data on step 2:
-		if (request.values.should_be_running__release !== undefined) {
+		if (request.values.is_pinned_on__release !== undefined) {
 			// Add an async boundary so that value updates,
 			// and doesn't remove the properties that we add.
 			await null;
-			request.values.is_pinned_on__release =
-				request.values.should_be_running__release;
+			request.values.should_be_running__release =
+				request.values.is_pinned_on__release;
 		}
 	},
 });
@@ -69,9 +69,9 @@ hooks.addPureHook('PATCH', 'resin', 'device', {
 		// build has been targeted, instead of pointing to a build of the wrong application
 		if (
 			request.values.belongs_to__application != null &&
-			request.values.should_be_running__release === undefined
+			request.values.is_pinned_on__release === undefined
 		) {
-			request.values.should_be_running__release = null;
+			request.values.is_pinned_on__release = null;
 		}
 
 		if (request.values.is_connected_to_vpn != null) {
@@ -84,12 +84,12 @@ hooks.addPureHook('PATCH', 'resin', 'device', {
 		}
 
 		// TODO[device management next step]: Drop this after re-migrating all data on step 2:
-		if (request.values.should_be_running__release !== undefined) {
+		if (request.values.is_pinned_on__release !== undefined) {
 			// Add an async boundary so that value updates,
 			// and doesn't remove the properties that we add.
 			await null;
-			request.values.is_pinned_on__release =
-				request.values.should_be_running__release;
+			request.values.should_be_running__release =
+				request.values.is_pinned_on__release;
 		}
 	},
 });

src/features/releases/hooks/restrict-release-deletion.ts

@@ -40,7 +40,7 @@ hooks.addPureHook('DELETE', 'resin', 'release', {
 				$top: 1,
 				$select: 'id',
 				$filter: {
-					should_be_running__release: { $in: affectedIds },
+					is_pinned_on__release: { $in: affectedIds },
 				},
 			},
 		})) as Array<PickExpanded<Device['Read'], 'id'>>;

src/lib/auth.ts

@@ -95,7 +95,7 @@ export const DEVICE_API_KEY_PERMISSIONS = [
 		`device/any(d:${matchesNonFrozenDeviceActor('d')})`,
 	),
 	'resin.application_config_variable.read?application/canAccess()',
-	'resin.release.read?should_be_running_on__device/canAccess() or belongs_to__application/canAccess()',
+	'resin.release.read?is_pinned_to__device/canAccess() or belongs_to__application/canAccess()',
 	'resin.release_tag.read?release/canAccess()',
 	'resin.device_environment_variable.read?device/canAccess()',
 	...writePerms(

src/translations/v6/hooks.ts

@@ -16,6 +16,18 @@ const addReadOnlyHook = (
 	});
 };
 
+const translatePropertyTo =
+	(currentModelField: string, newerModelField: string) =>
+	async ({ request }: sbvrUtils.HookArgs) => {
+		if (Object.hasOwn(request.values, currentModelField)) {
+			// Add an async boundary so that other sync hooks can use
+			// the untranslated values.
+			await null;
+			request.values[newerModelField] = request.values[currentModelField];
+			delete request.values[currentModelField];
+		}
+	};
+
 const translateDeviceTypeTo =
 	(toField: string) =>
 	async ({ request, api }: sbvrUtils.HookArgs) => {
@@ -48,6 +60,12 @@ addReadOnlyHook(['PUT', 'POST', 'PATCH'], 'application', {
 		}
 	},
 });
+addReadOnlyHook(['PUT', 'POST', 'PATCH'], 'device', {
+	POSTPARSE: translatePropertyTo(
+		'should_be_running__release',
+		'is_pinned_on__release',
+	),
+});
 addReadOnlyHook(['PUT', 'POST', 'PATCH'], 'device', {
 	async POSTPARSE({ request }) {
 		// Dependent device properties were removed so we block trying to set them

src/translations/v6/v6.ts

@@ -96,6 +96,7 @@ export const getV6Translations = (abstractSqlModel = v6AbstractSqlModel) => {
 			'is managed by-device': ['Cast', ['Null'], 'Integer'],
 			'logs channel': ['Cast', ['Null'], 'Short Text'],
 			'vpn address': ['Cast', ['Null'], 'Short Text'],
+			'should be running-release': 'is pinned on-release',
 			// We are redefining the overall_status rather than translating it, so that:
 			// • the v6 overall_status performances does not degrades from the additional FROMs
 			// • the behavior does not change if we later add new statuses in the v7 one

test/14_release-pinning.ts

@@ -17,6 +17,10 @@ import type { Application, DeviceType, Release } from '../src/balena-model.js';
 
 export default () => {
 	versions.test((version, pineTest) => {
+		const pinnedOnReleaseField = versions.gt(version, 'v6')
+			? 'is_pinned_on__release'
+			: 'should_be_running__release';
+
 		describe(`Tracking latest release`, () => {
 			let fx: fixtures.Fixtures;
 			let admin: UserObjectParam;
@@ -85,7 +89,7 @@ export default () => {
 				await supertest(admin)
 					.patch(`/${version}/device(${device.id})`)
 					.send({
-						should_be_running__release: pinnedRelease.id,
+						[pinnedOnReleaseField]: pinnedRelease.id,
 					})
 					.expect(200);
 
@@ -106,7 +110,7 @@ export default () => {
 				await supertest(admin)
 					.patch(`/${version}/device(${device.id})`)
 					.send({
-						should_be_running__release: null,
+						[pinnedOnReleaseField]: null,
 					})
 					.expect(200);
 			});
@@ -464,7 +468,7 @@ export default () => {
 					await supertest(device4)
 						.patch(`/${version}/device(${device4.id})`)
 						.send({
-							should_be_running__release: app3ReleaseId,
+							[pinnedOnReleaseField]: app3ReleaseId,
 						})
 						.expect(200);
 
@@ -491,7 +495,7 @@ export default () => {
 							await supertest(device4)
 								.patch(`/${version}/device(${device4.id})`)
 								.send({
-									should_be_running__release: app3ReleaseId,
+									[pinnedOnReleaseField]: app3ReleaseId,
 								})
 								.expect(200);
 						},
@@ -579,7 +583,7 @@ export default () => {
 				it('should not be able to delete a release if a device is pinned to it', async function () {
 					await supertest(admin)
 						.patch(`/${version}/device(${device4.id})`)
-						.send({ should_be_running__release: app4ReleaseId });
+						.send({ [pinnedOnReleaseField]: app4ReleaseId });
 					await supertest(admin)
 						.delete(`/${version}/release(${app4ReleaseId})`)
 						.expect(