Support JSON and YAML expansion in config

Author: adrienlauer

CHANGELOG.md

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed</artifactId>
-        <version>3.12.1-SNAPSHOT</version>
+        <version>3.13.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-cli</artifactId>

cli/pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed</artifactId>
-        <version>3.12.1-SNAPSHOT</version>
+        <version>3.13.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-core</artifactId>

core/pom.xml

@@ -0,0 +1,56 @@
+/*
+ * Copyright © 2013-2021, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.seed.core.internal.configuration;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import org.seedstack.coffig.TreeNode;
+import org.seedstack.coffig.node.MapNode;
+import org.seedstack.coffig.node.NamedNode;
+import org.seedstack.coffig.node.ValueNode;
+import org.seedstack.coffig.provider.JacksonProvider;
+import org.seedstack.coffig.spi.ConfigurationProcessor;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class JsonConfigProcessor implements ConfigurationProcessor {
+    private final ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory());
+
+    @Override
+    public void process(MapNode configuration) {
+        Map<MapNode, List<String>> toParse = new HashMap<>();
+
+        configuration.walk()
+                .filter(node -> node instanceof MapNode)
+                .map(MapNode.class::cast)
+                .forEach(mapNode -> mapNode.namedNodes()
+                        .filter(this::isJsonOrYamlFormatted)
+                        .forEach(namedNode -> toParse.computeIfAbsent(mapNode, k -> new ArrayList<>())
+                                .add(namedNode.name()))
+                );
+
+        // Replace the value with the parsed JSON/YAML
+        toParse.forEach((parent, list) -> list.forEach(key -> {
+            TreeNode toChange = parent.remove(key);
+            String newKey = key.substring(0, key.length() - 5);
+
+            try {
+                parent.set(newKey, JacksonProvider.buildTreeFromString(yamlMapper, toChange.value()));
+            } catch (Exception e) {
+                parent.set(newKey, new ValueNode(TreeNode.formatNodeError(e)));
+            }
+        }));
+    }
+
+    private boolean isJsonOrYamlFormatted(NamedNode namedNode) {
+        return namedNode.name().endsWith("|json") || namedNode.name().endsWith("|yaml");
+    }
+}

core/src/main/java/org/seedstack/seed/core/internal/configuration/JsonConfigProcessor.java

@@ -2,3 +2,4 @@ org.seedstack.seed.core.internal.configuration.SystemPropertiesProcessor
 org.seedstack.seed.core.internal.configuration.RemovalProcessor
 org.seedstack.seed.core.internal.configuration.ProfileProcessor
 org.seedstack.seed.core.internal.configuration.SecureConfigurationProcessor
+org.seedstack.seed.core.internal.configuration.JsonConfigProcessor

core/src/main/resources/META-INF/services/org.seedstack.coffig.spi.ConfigurationProcessor

@@ -20,7 +20,9 @@
 import org.seedstack.coffig.Coffig;
 import org.seedstack.coffig.Config;
 import org.seedstack.coffig.SingleValue;
+import org.seedstack.coffig.TreeNode;
 import org.seedstack.coffig.internal.ConfigurationException;
+import org.seedstack.coffig.node.MapNode;
 import org.seedstack.seed.Application;
 import org.seedstack.seed.ApplicationConfig;
 import org.seedstack.seed.Bind;
@@ -176,6 +178,12 @@ public void configuration_functions() {
         assertThat(configuration.get(String.class, "functions.randomUuid")).isNotEmpty();
     }
 
+    @Test
+    public void json_expansion() {
+        Coffig configuration = injector.getInstance(Application.class).getConfiguration();
+        assertThat(configuration.get(String.class, "jsonVal.key1")).isEqualTo("val1");
+    }
+
     @Test
     public void applicationInjection() {
         assertThat(application).isNotNull();

core/src/test/java/org/seedstack/seed/core/ConfigurationIT.java

@@ -82,6 +82,8 @@ functions:
   availableTcpPort: $availableTcpPort('port1')
   availableUdpPort: $availableUdpPort('port2')
   randomUuid: $randomUuid()
+jsonVal|json: '{ "key1": "val1" }'
+
 arrayOfMapContainer:
   basicProperty: customId
   arrayOfMaps:

core/src/test/resources/application.yaml

@@ -19,14 +19,14 @@
 
     <groupId>org.seedstack.seed</groupId>
     <artifactId>seed</artifactId>
-    <version>3.12.1-SNAPSHOT</version>
+    <version>3.13.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <properties>
         <nuun-kernel.version>1.0.M11</nuun-kernel.version>
         <javassist.version>3.27.0-GA</javassist.version>
         <shed.version>1.1.6</shed.version>
-        <coffig.version>3.1.7</coffig.version>
+        <coffig.version>3.1.8-SNAPSHOT</coffig.version>
         <commons-cli.version>1.4</commons-cli.version>
         <guice.version>5.0.1</guice.version>
         <guava.version>30.1.1-jre</guava.version>

pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed-rest</artifactId>
-        <version>3.12.1-SNAPSHOT</version>
+        <version>3.13.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-rest-core</artifactId>

rest/core/pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed-rest</artifactId>
-        <version>3.12.1-SNAPSHOT</version>
+        <version>3.13.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-rest-jersey2</artifactId>