100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Fix console API 500 errors (#2482)
Eric Bariaux35461ce1ac71
diff --git a/manager/src/main/java/org/openremote/manager/apps/AppResourceImpl.java b/manager/src/main/java/org/openremote/manager/apps/AppResourceImpl.javaindex ce2499879..a2a3d6903 100644--- a/manager/src/main/java/org/openremote/manager/apps/AppResourceImpl.java+++ b/manager/src/main/java/org/openremote/manager/apps/AppResourceImpl.java@@ -32,6 +32,7 @@ import jakarta.ws.rs.core.Response;import java.io.File;import java.io.IOException;import java.nio.file.Files;+import java.nio.file.Path;import java.util.Map;import java.util.stream.Collectors;@@ -56,17 +57,18 @@ public class AppResourceImpl extends WebResource implements AppResource {@Overridepublic Response getAppInfos(RequestParams requestParams) {- if (!Files.isDirectory(consoleAppService.consoleAppDocRoot)) {+ Path consoleAppDocRoot = consoleAppService.getConsoleAppDocRoot();+ if (consoleAppDocRoot == null || !Files.isDirectory(consoleAppDocRoot)) {return Response.status(Response.Status.INTERNAL_SERVER_ERROR)- .entity(String.format("%s is not a directory", consoleAppService.consoleAppDocRoot))+ .entity(String.format("%s is not a directory", consoleAppDocRoot)).type(MediaType.APPLICATION_JSON_TYPE).build();}if (consoleAppInfoMap == null) {try {- consoleAppInfoMap = Files.find(consoleAppService.consoleAppDocRoot,+ consoleAppInfoMap = Files.find(consoleAppDocRoot,2,(filePath, fileAttr) -> filePath.getFileName().toString().endsWith("info.json") && fileAttr.isRegularFile()).collect(Collectors.toMap(dir -> dir.getName(dir.getNameCount() - 2).toString(), dir -> {@@ -86,15 +88,16 @@ public class AppResourceImpl extends WebResource implements AppResource {@Overridepublic Response getConsoleConfig(RequestParams requestParams) {- if (!Files.isDirectory(consoleAppService.consoleAppDocRoot)) {+ Path consoleAppDocRoot = consoleAppService.getConsoleAppDocRoot();+ if (consoleAppDocRoot == null || !Files.isDirectory(consoleAppDocRoot)) {return Response.status(Response.Status.INTERNAL_SERVER_ERROR)- .entity(String.format("%s is not a directory", consoleAppService.consoleAppDocRoot))+ .entity(String.format("%s is not a directory", consoleAppDocRoot)).type(MediaType.APPLICATION_JSON_TYPE).build();}- if (!Files.exists(consoleAppService.consoleAppDocRoot.resolve("console_config.json"))) {+ if (!Files.exists(consoleAppDocRoot.resolve("console_config.json"))) {return Response.status(Response.Status.NOT_FOUND).build();@@ -102,7 +105,7 @@ public class AppResourceImpl extends WebResource implements AppResource {if (consoleConfig == null) {try {- consoleConfig = ValueUtil.JSON.readValue(new File(consoleAppService.consoleAppDocRoot.resolve("console_config.json").toString()), Object.class);+ consoleConfig = ValueUtil.JSON.readValue(new File(consoleAppDocRoot.resolve("console_config.json").toString()), Object.class);} catch (IOException e) {throw new WebApplicationException(e);}@@ -113,11 +116,12 @@ public class AppResourceImpl extends WebResource implements AppResource {@Deprecatedprotected ConsoleAppConfig getAppConfig(String realm) {try {- if (!Files.isDirectory(consoleAppService.consoleAppDocRoot)) {+ Path consoleAppDocRoot = consoleAppService.getConsoleAppDocRoot();+ if (consoleAppDocRoot == null || !Files.isDirectory(consoleAppDocRoot)) {return null;}- return Files.list(consoleAppService.consoleAppDocRoot)+ return Files.list(consoleAppDocRoot).filter(dir -> dir.getFileName().toString().startsWith(realm)).map(dir -> {try {diff --git a/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.java b/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.javaindex f1da2ec4b..76328ff4f 100644--- a/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.java+++ b/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.java@@ -44,7 +44,6 @@ public class ConsoleAppService implements ContainerService {@Overridepublic void init(Container container) throws Exception {-this.timerService = container.getService(TimerService.class);this.managerWebService = container.getService(ManagerWebService.class);this.identityService = container.getService(ManagerIdentityService.class);@@ -57,6 +56,7 @@ public class ConsoleAppService implements ContainerService {@Overridepublic void start(Container container) throws Exception {+ resolveConsoleAppDocRoot();}@Override@@ -74,6 +74,30 @@ public class ConsoleAppService implements ContainerService {.toArray(String[]::new);}+ public Path getConsoleAppDocRoot() {+ return resolveConsoleAppDocRoot();+ }++ private Path resolveConsoleAppDocRoot() {+ if (consoleAppDocRoot != null) {+ return consoleAppDocRoot;+ }++ Path customDocRoot = managerWebService.getCustomAppDocRoot();+ if (customDocRoot != null && Files.isDirectory(customDocRoot)) {+ consoleAppDocRoot = customDocRoot;+ return consoleAppDocRoot;+ }++ consoleAppDocRoot = managerWebService.getBuiltInAppDocRoot();+ if (consoleAppDocRoot == null) {+ LOG.warning("Console app doc root could not be resolved");+ } else if (!Files.isDirectory(consoleAppDocRoot) && customDocRoot != null) {+ LOG.warning("Custom app doc root does not exist, falling back to built-in: " + customDocRoot.toAbsolutePath());+ }+ return consoleAppDocRoot;+ }+@Overridepublic String toString() {return getClass().getSimpleName() + "{" +diff --git a/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovy b/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovyindex e5af4eb05..434f2b979 100644--- a/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovy+++ b/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovy@@ -13,6 +13,8 @@ import org.openremote.manager.rules.RulesServiceimport org.openremote.manager.rules.RulesetStorageServiceimport org.openremote.manager.rules.geofence.ORConsoleGeofenceAssetAdapterimport org.openremote.manager.setup.SetupService+import org.openremote.manager.apps.ConsoleAppService+import org.openremote.manager.web.ManagerWebServiceimport org.openremote.model.asset.Assetimport org.openremote.model.asset.AssetResourceimport org.openremote.model.asset.impl.ConsoleAsset@@ -37,11 +39,15 @@ import org.openremote.test.ManagerContainerTraitimport spock.lang.Specificationimport spock.util.concurrent.PollingConditions+import java.nio.charset.StandardCharsets+import java.nio.file.Files+import java.util.concurrent.CopyOnWriteArrayListimport java.util.concurrent.TimeUnitimport java.util.stream.IntStreamimport static org.openremote.model.Constants.KEYCLOAK_CLIENT_ID+import static org.openremote.model.Constants.MASTER_REALMimport static org.openremote.model.asset.AssetResource.Util.WRITE_ATTRIBUTE_HTTP_METHODimport static org.openremote.model.asset.AssetResource.Util.getWriteAttributeUrlimport static org.openremote.model.rules.RulesetStatus.DEPLOYED@@ -52,6 +58,112 @@ import static org.openremote.setup.integration.ManagerTestSetup.SMART_BUILDING_Lclass ConsoleTest extends Specification implements ManagerContainerTrait {+ def "Console config endpoint returns 404 when console_config.json is missing"() {+ given: "a custom app doc root without a console config file"+ def customAppDocRoot = Files.createTempDirectory("console-config-missing-")+ def container = startContainer(defaultConfig() << [(ManagerWebService.OR_CUSTOM_APP_DOCROOT): customAppDocRoot.toString()], defaultServices())+ def requestTarget = getClientApiTarget(serverUri(serverPort), MASTER_REALM).path("apps").path("consoleConfig")++ when: "requesting the console config"+ def response = requestTarget.request().get()++ then: "the endpoint should return 404"+ response.status == 404++ cleanup:+ if (response != null) {+ response.close()+ }+ Files.deleteIfExists(customAppDocRoot)+ }++ def "Console config endpoint returns 200 when console_config.json exists"() {+ given: "a custom app doc root with a console config file"+ def customAppDocRoot = Files.createTempDirectory("console-config-present-")+ def consoleConfigPath = customAppDocRoot.resolve("console_config.json")+ Files.write(consoleConfigPath, "{}".getBytes(StandardCharsets.UTF_8))++ def container = startContainer(defaultConfig() << [(ManagerWebService.OR_CUSTOM_APP_DOCROOT): customAppDocRoot.toString()], defaultServices())+ def requestTarget = getClientApiTarget(serverUri(serverPort), MASTER_REALM).path("apps").path("consoleConfig")++ when: "requesting the console config"+ def response = requestTarget.request().get()++ then: "the endpoint should return 200"+ response.status == 200++ cleanup:+ if (response != null) {+ response.close()+ }+ Files.deleteIfExists(consoleConfigPath)+ Files.deleteIfExists(customAppDocRoot)+ }++ def "Apps endpoint returns built-in and custom apps"() {+ given: "built-in and custom app doc roots with app folders"+ def builtInDocRoot = Files.createTempDirectory("apps-builtin-")+ def customDocRoot = Files.createTempDirectory("apps-custom-")+ Files.createDirectories(builtInDocRoot.resolve("appBuiltin"))+ Files.createDirectories(customDocRoot.resolve("appCustom"))++ def container = startContainer(defaultConfig() << [+ (ManagerWebService.OR_APP_DOCROOT) : builtInDocRoot.toString(),+ (ManagerWebService.OR_CUSTOM_APP_DOCROOT): customDocRoot.toString()+ ], defaultServices())+ def requestTarget = getClientApiTarget(serverUri(serverPort), MASTER_REALM).path("apps")++ when: "requesting the apps list"+ def response = requestTarget.request().get()++ then: "both apps are returned"+ response.status == 200+ def appList = parse(response.readEntity(String.class)).orElse([])+ appList.contains("appBuiltin")+ appList.contains("appCustom")++ cleanup:+ if (response != null) {+ response.close()+ }+ Files.deleteIfExists(builtInDocRoot.resolve("appBuiltin"))+ Files.deleteIfExists(builtInDocRoot)+ Files.deleteIfExists(customDocRoot.resolve("appCustom"))+ Files.deleteIfExists(customDocRoot)+ }++ def "Apps info endpoint returns info for custom apps"() {+ given: "a custom app doc root with an info.json file"+ def customDocRoot = Files.createTempDirectory("apps-info-custom-")+ def appDir = customDocRoot.resolve("appInfo")+ Files.createDirectories(appDir)+ Files.write(appDir.resolve("info.json"), "{\"name\":\"appInfo\"}".getBytes(StandardCharsets.UTF_8))++ def container = startContainer(defaultConfig() << [+ (ManagerWebService.OR_CUSTOM_APP_DOCROOT): customDocRoot.toString()+ ], defaultServices())+ def consoleAppService = container.getService(ConsoleAppService.class)+ consoleAppService.@consoleAppDocRoot = customDocRoot++ def requestTarget = getClientApiTarget(serverUri(serverPort), MASTER_REALM).path("apps").path("info")++ when: "requesting the apps info"+ def response = requestTarget.request().get()++ then: "the response includes the app info"+ response.status == 200+ def infoMap = parse(response.readEntity(String.class)).orElse([:])+ infoMap.containsKey("appInfo")++ cleanup:+ if (response != null) {+ response.close()+ }+ Files.deleteIfExists(appDir.resolve("info.json"))+ Files.deleteIfExists(appDir)+ Files.deleteIfExists(customDocRoot)+ }+def "Check full console behaviour"() {def notificationIds = new CopyOnWriteArrayList()def targetTypes = new CopyOnWriteArrayList()