feat: Provide a new configfiles API to return the raw content of configuration files directly

Author: Shawyeok

CHANGES.md

@@ -5,7 +5,7 @@ Release Notes.
 Apollo 2.5.0
 
 ------------------
-* 
+* [Feature: Provide a new configfiles API to return the raw content of configuration files directly](https://github.com/apolloconfig/apollo/pull/5336)
 
 ------------------
 All issues and pull requests are [here](https://github.com/apolloconfig/apollo/milestone/16?closed=1)

apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/controller/ConfigFileController.java

@@ -25,6 +25,7 @@
 import com.ctrip.framework.apollo.configservice.util.WatchKeysUtil;
 import com.ctrip.framework.apollo.core.ConfigConsts;
 import com.ctrip.framework.apollo.core.dto.ApolloConfig;
+import com.ctrip.framework.apollo.core.enums.ConfigFileFormat;
 import com.ctrip.framework.apollo.core.utils.PropertiesUtil;
 import com.ctrip.framework.apollo.tracer.Tracer;
 import com.google.common.base.Joiner;
@@ -67,8 +68,10 @@ public class ConfigFileController implements ReleaseMessageListener {
   private static final Joiner STRING_JOINER = Joiner.on(ConfigConsts.CLUSTER_NAMESPACE_SEPARATOR);
   private static final long MAX_CACHE_SIZE = 50 * 1024 * 1024; // 50MB
   private static final long EXPIRE_AFTER_WRITE = 30;
-  private final HttpHeaders propertiesResponseHeaders;
+  private final HttpHeaders plainTextResponseHeaders;
   private final HttpHeaders jsonResponseHeaders;
+  private final HttpHeaders yamlResponseHeaders;
+  private final HttpHeaders xmlResponseHeaders;
   private final ResponseEntity<String> NOT_FOUND_RESPONSE;
   private Cache<String, String> localCache;
   private final Multimap<String, String>
@@ -106,10 +109,14 @@ public ConfigFileController(
           logger.debug("removed cache key: {}", cacheKey);
         })
         .build();
-    propertiesResponseHeaders = new HttpHeaders();
-    propertiesResponseHeaders.add("Content-Type", "text/plain;charset=UTF-8");
+    plainTextResponseHeaders = new HttpHeaders();
+    plainTextResponseHeaders.add("Content-Type", "text/plain;charset=UTF-8");
     jsonResponseHeaders = new HttpHeaders();
     jsonResponseHeaders.add("Content-Type", "application/json;charset=UTF-8");
+    yamlResponseHeaders = new HttpHeaders();
+    yamlResponseHeaders.add("Content-Type", "application/yaml;charset=UTF-8");
+    xmlResponseHeaders = new HttpHeaders();
+    xmlResponseHeaders.add("Content-Type", "application/xml;charset=UTF-8");
     NOT_FOUND_RESPONSE = new ResponseEntity<>(HttpStatus.NOT_FOUND);
     this.configController = configController;
     this.namespaceUtil = namespaceUtil;
@@ -136,7 +143,7 @@ public ResponseEntity<String> queryConfigAsProperties(@PathVariable String appId
       return NOT_FOUND_RESPONSE;
     }
 
-    return new ResponseEntity<>(result, propertiesResponseHeaders, HttpStatus.OK);
+    return new ResponseEntity<>(result, plainTextResponseHeaders, HttpStatus.OK);
   }
 
   @GetMapping(value = "/json/{appId}/{clusterName}/{namespace:.+}")
@@ -160,6 +167,44 @@ public ResponseEntity<String> queryConfigAsJson(@PathVariable String appId,
     return new ResponseEntity<>(result, jsonResponseHeaders, HttpStatus.OK);
   }
 
+  @GetMapping(value = "/raw/{appId}/{clusterName}/{namespace:.+}")
+  public ResponseEntity<String> queryConfigAsRaw(@PathVariable String appId,
+                                                 @PathVariable String clusterName,
+                                                 @PathVariable String namespace,
+                                                 @RequestParam(value = "dataCenter", required = false) String dataCenter,
+                                                 @RequestParam(value = "ip", required = false) String clientIp,
+                                                 @RequestParam(value = "label", required = false) String clientLabel,
+                                                 HttpServletRequest request,
+                                                 HttpServletResponse response) throws IOException {
+
+    String result =
+        queryConfig(ConfigFileOutputFormat.RAW, appId, clusterName, namespace, dataCenter,
+            clientIp, clientLabel, request, response);
+
+    if (result == null) {
+      return NOT_FOUND_RESPONSE;
+    }
+
+    ConfigFileFormat format = determineNamespaceFormat(namespace);
+    HttpHeaders responseHeaders;
+    switch (format) {
+      case JSON:
+        responseHeaders = jsonResponseHeaders;
+        break;
+      case YML:
+      case YAML:
+        responseHeaders = yamlResponseHeaders;
+        break;
+      case XML:
+        responseHeaders = xmlResponseHeaders;
+        break;
+      default:
+        responseHeaders = plainTextResponseHeaders;
+        break;
+    }
+    return new ResponseEntity<>(result, responseHeaders, HttpStatus.OK);
+  }
+
   String queryConfig(ConfigFileOutputFormat outputFormat, String appId, String clusterName,
                      String namespace, String dataCenter, String clientIp, String clientLabel,
                      HttpServletRequest request,
@@ -247,11 +292,24 @@ private String loadConfig(ConfigFileOutputFormat outputFormat, String appId, Str
       case JSON:
         result = GSON.toJson(apolloConfig.getConfigurations());
         break;
+      case RAW:
+        result = getRawConfigContent(apolloConfig);
+        break;
     }
 
     return result;
   }
 
+  private String getRawConfigContent(ApolloConfig apolloConfig) throws IOException {
+    ConfigFileFormat format = determineNamespaceFormat(apolloConfig.getNamespaceName());
+      if (format == ConfigFileFormat.Properties) {
+          Properties properties = new Properties();
+          properties.putAll(apolloConfig.getConfigurations());
+          return PropertiesUtil.toString(properties);
+      }
+    return apolloConfig.getConfigurations().get("content");
+  }
+
   String assembleCacheKey(ConfigFileOutputFormat outputFormat, String appId, String clusterName,
                           String namespace,
                           String dataCenter) {
@@ -263,6 +321,17 @@ String assembleCacheKey(ConfigFileOutputFormat outputFormat, String appId, Strin
     return STRING_JOINER.join(keyParts);
   }
 
+  ConfigFileFormat determineNamespaceFormat(String namespaceName) {
+    String lowerCase = namespaceName.toLowerCase();
+    for (ConfigFileFormat format : ConfigFileFormat.values()) {
+      if (lowerCase.endsWith("." + format.getValue())) {
+        return format;
+      }
+    }
+
+    return ConfigFileFormat.Properties;
+  }
+
   @Override
   public void handleMessage(ReleaseMessage message, String channel) {
     logger.info("message received - channel: {}, message: {}", channel, message);
@@ -286,7 +355,7 @@ public void handleMessage(ReleaseMessage message, String channel) {
   }
 
   enum ConfigFileOutputFormat {
-    PROPERTIES("properties"), JSON("json");
+    PROPERTIES("properties"), JSON("json"), RAW("raw");
 
     private String value;
 

apollo-configservice/src/test/java/com/ctrip/framework/apollo/configservice/controller/ConfigFileControllerTest.java

@@ -46,6 +46,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.startsWith;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
@@ -93,7 +94,7 @@ public void setUp() throws Exception {
     someClientIp = "10.1.1.1";
     someClientLabel = "myLabel";
 
-    when(namespaceUtil.filterNamespaceName(someNamespace)).thenReturn(someNamespace);
+    when(namespaceUtil.filterNamespaceName(startsWith(someNamespace))).thenReturn(someNamespace);
     when(namespaceUtil.normalizeNamespace(someAppId, someNamespace)).thenReturn(someNamespace);
     when(grayReleaseRulesHolder.hasGrayReleaseRule(anyString(), anyString(), anyString(),
         anyString())).thenReturn(false);
@@ -190,6 +191,35 @@ public void testQueryConfigAsJson() throws Exception {
     assertEquals(configurations, GSON.fromJson(response.getBody(), responseType));
   }
 
+  @Test
+  public void testQueryConfigAsRaw() throws Exception {
+    String someKey = "someKey";
+    String someValue = "someValue";
+
+    String someWatchKey = "someWatchKey";
+    Set<String> watchKeys = Sets.newHashSet(someWatchKey);
+
+    ApolloConfig someApolloConfig = mock(ApolloConfig.class);
+    when(configController
+        .queryConfig(someAppId, someClusterName, someNamespace, someDataCenter, "-1", someClientIp, someClientLabel,null,
+                someRequest, someResponse)).thenReturn(someApolloConfig);
+    when(someApolloConfig.getNamespaceName()).thenReturn(someNamespace + ".json");
+    String jsonContent = GSON.toJson(ImmutableMap.of(someKey, someValue));
+    when(someApolloConfig.getConfigurations()).thenReturn(ImmutableMap.of("content", jsonContent));
+    when(watchKeysUtil
+            .assembleAllWatchKeys(someAppId, someClusterName, someNamespace, someDataCenter))
+            .thenReturn(watchKeys);
+
+    ResponseEntity<String> response =
+        configFileController
+            .queryConfigAsRaw(someAppId, someClusterName, someNamespace + ".json", someDataCenter,
+                  someClientIp, someClientLabel, someRequest, someResponse);
+
+    assertEquals(HttpStatus.OK, response.getStatusCode());
+    assertEquals("application/json;charset=UTF-8", response.getHeaders().getContentType().toString());
+    assertEquals(jsonContent, response.getBody());
+  }
+
   @Test
   public void testQueryConfigWithGrayRelease() throws Exception {
     String someKey = "someKey";

docs/en/client/other-language-client-user-guide.md

@@ -34,7 +34,7 @@ Since the cache has a delay of at most one second, if you need to work with conf
 
 The Http interface returns JSON format, UTF-8 encoding, which contains all the configuration items in the corresponding namespace.
 
-Return content Sample is as follows.
+If the namespace is of type `properties`, the return content sample is as follows:
 
 ```json
 {
@@ -43,6 +43,15 @@ Return content Sample is as follows.
 }
 ```
 
+If the namespace is not of type `properties`, the return content sample is as follows:
+```json
+{
+    "content": "{\"portal.elastic.document.type\":\"biz\",\"portal.elastic.cluster.name\":\"hermes-es-fws\"}"
+}
+```
+
+> You can get the raw configuration content without escaping via `{config_server_url}/configfiles/raw/{appId}/{clusterName}/{namespaceName}?ip={clientIp}`.
+
 > The configuration in the form of properties can be obtained via `{config_server_url}/configfiles/{appId}/{clusterName}/{namespaceName}?ip={clientIp}`
 
 ### 1.2.3 Testing

docs/zh/client/other-language-client-user-guide.md

@@ -31,14 +31,23 @@
 ### 1.2.2 Http接口返回格式
 该Http接口返回的是JSON格式、UTF-8编码，包含了对应namespace中所有的配置项。
 
-返回内容Sample如下：
+若是properties类型的namespace，返回内容Sample如下：
 ```json
 {
     "portal.elastic.document.type":"biz",
     "portal.elastic.cluster.name":"hermes-es-fws"
 }
 ```
 
+若不是properties类型的namespace，返回内容Sample如下（content是namespace的内容）：
+```json
+{
+    "content": "{\"portal.elastic.document.type\":\"biz\",\"portal.elastic.cluster.name\":\"hermes-es-fws\"}"
+}
+```
+
+> 通过`{config_server_url}/configfiles/raw/{appId}/{clusterName}/{namespaceName}?ip={clientIp}`可以获取到原始的配置内容，不会进行转义。
+
 > 通过`{config_server_url}/configfiles/{appId}/{clusterName}/{namespaceName}?ip={clientIp}`可以获取到properties形式的配置
 
 ### 1.2.3 测试