From d2a5a9ba8638e712a4b286ce6775158c89615b08 Mon Sep 17 00:00:00 2001
From: Lucian Buzzo <lucian.buzzo@gmail.com>
Date: Thu, 25 Nov 2021 17:03:38 +0000
Subject: [PATCH] Set the correct target state when using Compose "image" field

Fixes #2394

When pushing to a device in local mode, if a service is not external, and uses
an `image` field, that value should be used for tags and target state, otherwise
it won't match the image name generated on the device by balenaEngine.

Change-type: patch
Signed-off-by: Lucian Buzzo <lucian.buzzo@gmail.com>
---
 lib/utils/device/deploy.ts | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/lib/utils/device/deploy.ts b/lib/utils/device/deploy.ts
index ce09e81d..526e501c 100644
--- a/lib/utils/device/deploy.ts
+++ b/lib/utils/device/deploy.ts
@@ -34,6 +34,7 @@ import {
 	loadProject,
 	makeBuildTasks,
 	tarDirectory,
+	makeImageName,
 } from '../compose_ts';
 import Logger = require('../logger');
 import { DeviceAPI, DeviceInfo } from './api';
@@ -44,6 +45,7 @@ import { stripIndent } from '../lazy';
 
 const LOCAL_APPNAME = 'localapp';
 const LOCAL_RELEASEHASH = 'localrelease';
+const LOCAL_PROJECT_NAME = 'local_image';
 
 // Define the logger here so the debug output
 // can be used everywhere
@@ -375,7 +377,11 @@ async function performBuilds(
 				// We can be sure that localImage.name is set here, because of the failure code above
 				const image = docker.getImage(localImage.name!);
 				await image.tag({
-					repo: generateImageName(localImage.serviceName),
+					repo: makeImageName(
+						LOCAL_PROJECT_NAME,
+						localImage.serviceName,
+						'latest',
+					),
 					force: true,
 				});
 				imagesToRemove.push(localImage.name!);
@@ -533,7 +539,7 @@ async function assignDockerBuildOpts(
 					'io.resin.local.image': '1',
 					'io.resin.local.service': task.serviceName,
 				},
-				t: generateImageName(task.serviceName),
+				t: getImageNameFromTask(task),
 				nocache: opts.nocache,
 				forcerm: true,
 				pull: opts.pull,
@@ -550,8 +556,10 @@ async function assignDockerBuildOpts(
 	);
 }
 
-function generateImageName(serviceName: string): string {
-	return `local_image_${serviceName}:latest`;
+function getImageNameFromTask(task: BuildTask): string {
+	return !task.external && task.tag
+		? task.tag
+		: makeImageName(LOCAL_PROJECT_NAME, task.serviceName, 'latest');
 }
 
 export function generateTargetState(
@@ -587,6 +595,8 @@ export function generateTargetState(
 			contract = keyedBuildTasks[name].contract;
 		}
 
+		const task = keyedBuildTasks[name];
+
 		services[idx] = {
 			...defaults,
 			...opts,
@@ -595,7 +605,7 @@ export function generateTargetState(
 				imageId: idx,
 				serviceName: name,
 				serviceId: idx,
-				image: generateImageName(name),
+				image: getImageNameFromTask(task),
 				running: true,
 			},
 		};