Add device service fks

src/balena-model.ts

@@ -602,6 +602,21 @@ export interface Service {
 		service_install?: Array<ServiceInstall['Read']>;
 		is_installed_on__device?: Array<ServiceInstall['Read']>;
 		is_built_by__image?: Array<Image['Read']>;
+		is_of__device__installs__application__has__service_name__has__name?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__device__installs__service__has__name?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__device__installs__service_environment_variable?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__service_install__has__name?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__device_service_environment_variable?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
 	};
 	Write: {
 		created_at: Types['Date Time']['Write'];
@@ -780,6 +795,21 @@ export interface Device {
 		installs__image?: Array<ImageInstall['Read']>;
 		installs__application__has__service_name?: Array<ServiceInstall['Read']>;
 		installs__service?: Array<ServiceInstall['Read']>;
+		is_of__device__installs__application__has__service_name__has__name?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__device__installs__service__has__name?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__device__installs__service_environment_variable?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__service_install__has__name?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
+		is_of__device_service_environment_variable?: Array<
+			DeviceServiceEnvironmentVariable['Read']
+		>;
 	};
 	Write: {
 		created_at: Types['Date Time']['Write'];
@@ -954,12 +984,19 @@ export interface DeviceServiceEnvironmentVariable {
 		name: Types['Short Text']['Read'];
 		id: Types['Serial']['Read'];
 		value: Types['Text']['Read'];
+		service: { __id: Service['Read']['id'] } | [Service['Read']] | [] | null;
+		device: { __id: Device['Read']['id'] } | [Device['Read']] | [] | null;
 		device__installs__application__has__service_name:
 			| { __id: ServiceInstall['Read']['id'] }
 			| [ServiceInstall['Read']];
 		device__installs__service:
 			| { __id: ServiceInstall['Read']['id'] }
 			| [ServiceInstall['Read']];
+		application__has__service_name:
+			| { __id: Service['Read']['id'] }
+			| [Service['Read']]
+			| []
+			| null;
 	};
 	Write: {
 		created_at: Types['Date Time']['Write'];
@@ -968,6 +1005,8 @@ export interface DeviceServiceEnvironmentVariable {
 		name: Types['Short Text']['Write'];
 		id: Types['Serial']['Write'];
 		value: Types['Text']['Write'];
+		service: Service['Write']['id'] | null;
+		device: Device['Write']['id'] | null;
 	};
 }
 

src/balena.sbvr

@@ -812,6 +812,10 @@ Fact type: image environment variable has value
 
 Fact type: device service environment variable has value
 	Necessity: each device service environment variable has exactly one value.
+Fact type: device service environment variable has service
+	Necessity: each device service environment variable has at most one service.
+Fact type: device service environment variable has device
+	Necessity: each device service environment variable has at most one device.
 
 
 -- application tag

src/features/service-install/hooks/backfill-device-service-environment-variable.ts

@@ -0,0 +1,35 @@
+import { hooks, errors, type sbvrUtils } from '@balena/pinejs';
+
+async function backfillDeviceAndService({
+	request,
+	api,
+}: sbvrUtils.HookArgs<'resin'>) {
+	const { service_install: siId } = request.values;
+
+	if (siId == null) {
+		return;
+	}
+
+	const si = await api.get({
+		resource: 'service_install',
+		id: siId,
+		options: {
+			$select: ['device', 'service'],
+		},
+	});
+
+	if (si == null) {
+		throw new errors.UnauthorizedError();
+	}
+
+	request.values.device = si.device.__id;
+	request.values.service = si.service.__id;
+}
+
+hooks.addPureHook('POST', 'resin', 'device_service_environment_variable', {
+	POSTPARSE: backfillDeviceAndService,
+});
+
+hooks.addPureHook('PATCH', 'resin', 'device_service_environment_variable', {
+	POSTPARSE: backfillDeviceAndService,
+});

src/features/service-install/hooks/index.ts

@@ -0,0 +1 @@
+import './backfill-device-service-environment-variable.js';

src/hooks.ts

@@ -11,6 +11,7 @@ import './features/device-urls/hooks.js';
 import './features/hostapp/hooks/index.js';
 import './features/organizations/hooks/index.js';
 import './features/releases/hooks/index.js';
+import './features/service-install/hooks/index.js';
 import './features/supervisor-app/hooks/index.js';
 import './features/tags/hooks.js';
 import './features/vars-schema/hooks/index.js';

src/migrations/00095-add-device-service-fks-to-device-service-environment-variable.sql

@@ -0,0 +1,40 @@
+ALTER TABLE "device service environment variable"
+ADD COLUMN IF NOT EXISTS "device" INTEGER NULL;
+
+ALTER TABLE "device service environment variable"
+ADD COLUMN IF NOT EXISTS "service" INTEGER NULL;
+
+CREATE UNIQUE INDEX IF NOT EXISTS "device service environment variable_device_service_name_key"
+ON "device service environment variable" ("device", "service", "name");
+
+DO $$
+BEGIN
+	IF NOT EXISTS (
+		SELECT 1
+		FROM information_schema.table_constraints AS tc
+		JOIN information_schema.key_column_usage AS kcu ON tc.constraint_name = kcu.constraint_name
+		WHERE tc.constraint_type = 'FOREIGN KEY'
+			AND tc.table_schema = CURRENT_SCHEMA()
+			AND tc.table_name = 'device service environment variable'
+			AND kcu.column_name = 'device'
+	) THEN
+		ALTER TABLE "device service environment variable"
+		ADD CONSTRAINT "device service environment variable_device_fkey" 
+		FOREIGN KEY ("device") REFERENCES "device" ("id");
+	END IF;
+
+	IF NOT EXISTS (
+		SELECT 1
+		FROM information_schema.table_constraints AS tc
+		JOIN information_schema.key_column_usage AS kcu ON tc.constraint_name = kcu.constraint_name
+		WHERE tc.constraint_type = 'FOREIGN KEY'
+			AND tc.table_schema = CURRENT_SCHEMA()
+			AND tc.table_name = 'device service environment variable'
+			AND kcu.column_name = 'service'
+	) THEN
+		ALTER TABLE "device service environment variable"
+		ADD CONSTRAINT "device service environment variable_service_fkey" 
+		FOREIGN KEY ("service") REFERENCES "service" ("id");
+	END IF;
+END;
+$$;

test/25_service-installs.ts

@@ -7,6 +7,7 @@ import * as fixtures from './test-lib/fixtures.js';
 
 import { assertExists, expectToEventually } from './test-lib/common.js';
 import * as config from '../src/lib/config.js';
+import { supertest } from './test-lib/supertest.js';
 
 export default () => {
 	versions.test((version, pineTest) => {
@@ -40,6 +41,7 @@ export default () => {
 					ctx.app1Service2 = fx.services.app1Service2;
 					ctx.app1Service3 = fx.services.app1Service3;
 					ctx.app2Service1 = fx.services.app2Service1;
+					ctx.app2Service2 = fx.services.app2Service2;
 
 					config.TEST_MOCK_ONLY.ASYNC_TASK_CREATE_SERVICE_INSTALLS_ENABLED =
 						isServiceInstallEnabled;
@@ -169,6 +171,109 @@ export default () => {
 						);
 					});
 				});
+
+				it('should be able to use service_install to create a device_service_environment_variable', async () => {
+					const { body: serviceInstall } = await pineUser
+						.get({
+							resource: 'service_install',
+							id: {
+								device: ctx.device.id,
+								installs__service: ctx.app2Service1.id,
+							},
+						})
+						.expect(200);
+					assertExists(serviceInstall);
+
+					const { body: deviceServiceEnvVar } = await pineUser
+						.post({
+							resource: 'device_service_environment_variable',
+							body: {
+								service_install: serviceInstall.id,
+								name: 'test',
+								value: '123',
+							},
+						})
+						.expect(201);
+					assertExists(deviceServiceEnvVar);
+
+					const {
+						body: {
+							d: [dbDeviceServiceEnvVar],
+						},
+					} = await supertest(ctx.admin)
+						.get(
+							`/resin/device_service_environment_variable(${deviceServiceEnvVar.id})?$select=device,service`,
+						)
+						.expect(200);
+
+					expect(dbDeviceServiceEnvVar.device.__id).to.equal(ctx.device.id);
+					expect(dbDeviceServiceEnvVar.service.__id).to.equal(
+						ctx.app2Service1.id,
+					);
+				});
+
+				it('should be able to update device_service_environment_variable service_install', async () => {
+					const { body: serviceInstallService1 } = await pineUser
+						.get({
+							resource: 'service_install',
+							id: {
+								device: ctx.device.id,
+								installs__service: ctx.app2Service1.id,
+							},
+						})
+						.expect(200);
+					assertExists(serviceInstallService1);
+
+					const { body: serviceInstallService2 } = await pineUser
+						.get({
+							resource: 'service_install',
+							id: {
+								device: ctx.device.id,
+								installs__service: ctx.app2Service2.id,
+							},
+						})
+						.expect(200);
+					assertExists(serviceInstallService2);
+
+					const {
+						body: [deviceServiceEnvVar],
+					} = await pineUser
+						.get({
+							resource: 'device_service_environment_variable',
+							options: {
+								$filter: {
+									service_install: serviceInstallService1.id,
+								},
+							},
+						})
+						.expect(200);
+					assertExists(deviceServiceEnvVar);
+
+					await pineUser
+						.patch({
+							resource: 'device_service_environment_variable',
+							id: deviceServiceEnvVar.id,
+							body: {
+								service_install: serviceInstallService2.id,
+							},
+						})
+						.expect(200);
+
+					const {
+						body: {
+							d: [dbDeviceServiceEnvVar],
+						},
+					} = await supertest(ctx.admin)
+						.get(
+							`/resin/device_service_environment_variable(${deviceServiceEnvVar.id})?$select=device,service`,
+						)
+						.expect(200);
+
+					expect(dbDeviceServiceEnvVar.device.__id).to.equal(ctx.device.id);
+					expect(dbDeviceServiceEnvVar.service.__id).to.equal(
+						ctx.app2Service2.id,
+					);
+				});
 			});
 		});
 	});

test/fixtures/25-service-installs/images.json

@@ -34,5 +34,14 @@
 		"project_type": "Dockerfile.template",
 		"build_log": "This is also the build log",
 		"status": "success"
+	},
+	"image5": {
+		"user": "admin",
+		"service": "app2Service2",
+		"releases": [ "app2release1" ],
+		"image_size": 2048,
+		"project_type": "Dockerfile.template",
+		"build_log": "This is also the build log",
+		"status": "success"
 	}
 }

test/fixtures/25-service-installs/services.json

@@ -18,5 +18,10 @@
 		"user": "admin",
 		"application": "app2",
 		"service_name": "app2Service1"
+	},
+	"app2Service2": {
+		"user": "admin",
+		"application": "app2",
+		"service_name": "app2Service2"
 	}
 }