Implemented instance type (#712)

ekharkunov · web-flow · commit b6dab53e99a2 · 2025-11-13T11:48:01.000+03:00
* Implement instance type configuration. Implement handling of 'mappings not found' error.

* Updated configs

* Review fixes. Added separate exceptions for not supported version and not supported platform
diff --git a/server/configs/application-dev.yml b/server/configs/application-dev.yml
diff --git a/server/configs/application-local-dev-android.yml b/server/configs/application-local-dev-android.yml
@@ -1 +1,4 @@
-extender.gradle.enabled: true
+extender:
+    instance-type: BUILDER_ONLY
+    gradle:
+        enabled: true
diff --git a/server/configs/application-local-dev-app.yml b/server/configs/application-local-dev-app.yml
@@ -1,4 +1,5 @@
 extender:
+    instance-type: FRONTEND_ONLY
     remote-builder:
         enabled: true
         platforms:
diff --git a/server/configs/application-local-dev.yml b/server/configs/application-local-dev.yml
@@ -1,4 +1,5 @@
 extender:
+    instance-type: BUILDER_ONLY
     # sdk.location: /usr/local/extender/sdk
     cache:
         enabled: true
diff --git a/server/configs/application-standalone-dev.yml b/server/configs/application-standalone-dev.yml
@@ -2,6 +2,7 @@ server:
     port: 9010
 
 extender:
+    instance-type: MIXED
     sdk:
         location: /usr/local/extender/sdk
         cache-clear-on-exit: false
diff --git a/server/configs/application-test-app.yml b/server/configs/application-test-app.yml
@@ -1,4 +1,5 @@
 extender:
+    instance-type: FRONTEND_ONLY
     remote-builder:
         enabled: true
         platforms:
diff --git a/server/src/main/java/com/defold/extender/ExtenderController.java b/server/src/main/java/com/defold/extender/ExtenderController.java
@@ -16,6 +16,7 @@
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.IOUtils;
 import org.eclipse.jetty.io.EofException;
+import org.json.simple.JSONObject;
 import org.json.simple.parser.ParseException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -46,9 +47,14 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-
 @RestController
 public class ExtenderController {
+    public enum InstanceType {
+        MIXED,
+        FRONTEND_ONLY,
+        BUILDER_ONLY
+    };
+
     private static final Logger LOGGER = LoggerFactory.getLogger(ExtenderController.class);
 
     private static final String LATEST = "latest";
@@ -65,6 +71,8 @@ public class ExtenderController {
 
     private final RemoteEngineBuilder remoteEngineBuilder;
     private Map<String, RemoteInstanceConfig> remoteBuilderPlatformMappings;
+    @Value("${extender.instance-type:MIXED}")
+    private InstanceType instanceType;
     private final boolean remoteBuilderEnabled;
 
     private static long maxPackageSize = 1024*1024*1024;
@@ -148,7 +156,7 @@ public void buildEngineAsync(HttpServletRequest _request,
                             HttpServletResponse response,
                             @PathVariable("platform") String platform,
                             @PathVariable("sdkVersion") String sdkVersionString)
-            throws ExtenderException, IOException, ParseException {
+            throws ExtenderException, IOException, ParseException, VersionNotSupportedException, PlatformNotSupportedException {
 
         boolean isMultipart = JakartaServletFileUpload.isMultipartContent(_request);
         if (!isMultipart) {
@@ -198,17 +206,33 @@ public void buildEngineAsync(HttpServletRequest _request,
             // Regardless of success/fail status, we want to cache the uploaded files
             DataCacheService.DataCacheServiceInfo uploadResultInfo = dataCacheService.cacheFiles(uploadDirectory);
             metricsWriter.measureCacheUpload(uploadResultInfo.cachedFileSize.longValue(), uploadResultInfo.cachedFileCount.intValue());
-            
-            String[] buildEnvDescription = ExtenderUtil.getSdksForPlatform(platform, defoldSdkService.getPlatformSdkMappings(sdkVersion));
-            // Build engine locally or on remote builder
-            if (remoteBuilderEnabled && isRemotePlatform(buildEnvDescription[0], buildEnvDescription[1])) {
-                LOGGER.info("Building engine on remote builder");
-                RemoteInstanceConfig remoteInstanceConfig = getRemoteBuilderConfig(buildEnvDescription[0], buildEnvDescription[1]);
-                this.remoteEngineBuilder.buildAsync(remoteInstanceConfig, uploadDirectory, platform, sdkVersion, jobDirectory, buildDirectory, metricsWriter);
-            } else {
+
+            if (instanceType.equals(InstanceType.BUILDER_ONLY)) {
                 asyncBuilder.asyncBuildEngine(metricsWriter, platform, sdkVersion, jobDirectory, uploadDirectory, buildDirectory);
+            } else {
+                String[] buildEnvDescription = null;
+                try {
+                    JSONObject mappings = defoldSdkService.getPlatformSdkMappings(sdkVersion);
+                    buildEnvDescription = ExtenderUtil.getSdksForPlatform(platform, mappings);
+                } catch(ExtenderException exc) {
+                    if (instanceType.equals(InstanceType.FRONTEND_ONLY)) {
+                        LOGGER.error("Unsupported engine version {}", sdkVersion);
+                        throw new VersionNotSupportedException(sdkVersion);
+                    }
+                }
+                // Build engine locally or on remote builder
+                if (remoteBuilderEnabled && buildEnvDescription != null && isRemotePlatform(buildEnvDescription[0], buildEnvDescription[1])) {
+                    LOGGER.info("Building engine on remote builder");
+                    RemoteInstanceConfig remoteInstanceConfig = getRemoteBuilderConfig(buildEnvDescription[0], buildEnvDescription[1]);
+                    this.remoteEngineBuilder.buildAsync(remoteInstanceConfig, uploadDirectory, platform, sdkVersion, jobDirectory, buildDirectory, metricsWriter);
+                } else if (instanceType.equals(InstanceType.MIXED)) {
+                    asyncBuilder.asyncBuildEngine(metricsWriter, platform, sdkVersion, jobDirectory, uploadDirectory, buildDirectory);
+                } else {
+                    // no remote builder was found and current instance can't build
+                    LOGGER.error("Unsupported build platform {}", platform);
+                    throw new PlatformNotSupportedException(platform);
+                }
             }
-
             response.getWriter().write(jobDirectory.getName());
             response.getWriter().flush();
             response.getWriter().close();
@@ -218,6 +242,8 @@ public void buildEngineAsync(HttpServletRequest _request,
             throw new ExtenderException(e, "Client closed connection prematurely, build aborted");
         } catch(FileUploadException e) {
             throw new ExtenderException(e, "Bad request: " + e.getMessage());
+        } catch(VersionNotSupportedException|PlatformNotSupportedException exc) {
+            throw exc;
         } catch(Exception e) {
             LOGGER.error(String.format("Exception while building or sending response - SDK: %s", sdkVersion));
             throw e;
diff --git a/server/src/main/java/com/defold/extender/PlatformNotSupportedException.java b/server/src/main/java/com/defold/extender/PlatformNotSupportedException.java
@@ -0,0 +1,13 @@
+package com.defold.extender;
+
+public class PlatformNotSupportedException extends ExtenderException {
+    private static String ERROR_MESSAGE = "Platform %s is not supported on the current server. Please, check build server address. If error will persist - create task here https://github.com/defold/extender/issues";
+
+    public PlatformNotSupportedException(String platform) {
+        super(String.format(ERROR_MESSAGE, platform));
+    }
+
+    public PlatformNotSupportedException(Exception e, String platform) {
+        super(e, String.format(ERROR_MESSAGE, platform));
+    }
+}
diff --git a/server/src/main/java/com/defold/extender/VersionNotSupportedException.java b/server/src/main/java/com/defold/extender/VersionNotSupportedException.java
@@ -0,0 +1,13 @@
+package com.defold.extender;
+
+public class VersionNotSupportedException extends ExtenderException {
+    private static String ERROR_MESSAGE = "Engine version %s is not supported on the current server. Please, use latest stable version. https://github.com/defold/defold/releases/latest";
+
+    public VersionNotSupportedException(String version) {
+        super(String.format(ERROR_MESSAGE, version));
+    }
+
+    public VersionNotSupportedException(Exception e, String version) {
+        super(e, String.format(ERROR_MESSAGE, version));
+    }
+}
diff --git a/server/src/main/java/com/defold/extender/services/DefoldSdkService.java b/server/src/main/java/com/defold/extender/services/DefoldSdkService.java
@@ -356,7 +356,9 @@ private JSONObject getRemotePlatformSdkMappings(String hash) throws IOException,
         try {
             JSONObject result = operation.get();
             if (result == null) {
-                throw new ExtenderException(String.format("Cannot find or parse platform sdks mappings for hash: %s", hash));
+                String msg = String.format("Cannot find or parse platform sdks mappings for hash: %s", hash);
+                LOGGER.error(msg);
+                throw new ExtenderException(msg);
             }
             return result;
         } catch (InterruptedException|ExecutionException exc) {
diff --git a/server/src/main/resources/application.yml b/server/src/main/resources/application.yml
@@ -50,6 +50,9 @@ extender:
         location: /tmp/results
         cleanup-period: 20000
         lifetime: 1200000
+    # see ExtenderController.InstanceType enum
+    # FRONTEND_ONLY, BUILDER_ONLY, MIXED
+    instance-type: MIXED
 
 spring:
     application:
diff --git a/server/src/test/java/com/defold/extender/IntegrationTest.java b/server/src/test/java/com/defold/extender/IntegrationTest.java
@@ -9,6 +9,7 @@
 import org.jf.dexlib2.iface.DexFile;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
@@ -575,4 +576,19 @@ public void buildEngineWithDynamicLibs(TestConfiguration configuration) throws I
             assertNotNull(zipFile.getEntry(getDynamicLibName(configuration.platform, "dynamic_specific2")));
         }
     }
+
+    @Test
+    public void testUnsupportedVersion() throws IOException, ExtenderClientException {
+        TestConfiguration configuration = new TestConfiguration(new DefoldVersion("non-exist", new Version(2, 10, 1), new String[]{ "x86_64-linux" }) , "x86_64-linux");
+        List<ExtenderResource> sourceFiles = Lists.newArrayList(
+            new FileExtenderResource("test-data/AndroidManifest.xml", "AndroidManifest.xml"),
+            new FileExtenderResource("test-data/ext2/ext.manifest"),
+            new FileExtenderResource("test-data/ext2/src/test_ext.cpp"),
+            new FileExtenderResource(String.format("test-data/ext2/lib/%s/%s", configuration.platform, getLibName(configuration.platform, "alib"))),
+            new FileExtenderResource(String.format("test-data/ext2/lib/%s/%s", configuration.platform, getLibName(configuration.platform, "blib")))
+        );
+
+        ExtenderClientException exc = assertThrows(ExtenderClientException.class, () -> doBuild(sourceFiles, configuration));
+        assertTrue(exc.getMessage().contains("Unsupported engine version"));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`extender:`
	`2`	`+ instance-type: FRONTEND_ONLY`
`2`	`3`	`remote-builder:`
`3`	`4`	`enabled: true`
`4`	`5`	`platforms:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`extender:`
	`2`	`+ instance-type: BUILDER_ONLY`
`2`	`3`	`# sdk.location: /usr/local/extender/sdk`
`3`	`4`	`cache:`
`4`	`5`	`enabled: true`