Fix Base64 encoding mismatch for complex keys in OpenAPI

Co-authored-by: nobodyiam <[email protected]>

Author: Copilot

apollo-adminservice/src/test/java/com/ctrip/framework/apollo/adminservice/controller/ItemControllerTest.java

@@ -24,6 +24,8 @@
 import com.ctrip.framework.apollo.biz.service.ItemService;
 import com.ctrip.framework.apollo.common.dto.*;
 
+import java.nio.charset.StandardCharsets;
+import java.util.Base64;
 import java.util.List;
 import java.util.Objects;
 import org.junit.Assert;
@@ -175,4 +177,74 @@ public void testSearch() {
     assertThat(itemInfoDTOS.getContent().toString())
         .isEqualTo(response.getBody().getContent().toString());
   }
+
+  @Test
+  @Sql(scripts = "/controller/test-itemset.sql", executionPhase = ExecutionPhase.BEFORE_TEST_METHOD)
+  @Sql(scripts = "/controller/cleanup.sql", executionPhase = ExecutionPhase.AFTER_TEST_METHOD)
+  public void testGetByEncodedKey() {
+    this.testCreate();
+
+    String appId = "someAppId";
+    AppDTO app = restTemplate.getForObject(appBaseUrl(), AppDTO.class, appId);
+    assert app != null;
+    ClusterDTO cluster =
+        restTemplate.getForObject(clusterBaseUrl(), ClusterDTO.class, app.getAppId(), "default");
+    assert cluster != null;
+    NamespaceDTO namespace = restTemplate.getForObject(namespaceBaseUrl(), NamespaceDTO.class,
+        app.getAppId(), cluster.getName(), "application");
+
+    String itemKey = "test-key";
+    
+    // Test with URL-safe Base64 encoding without padding
+    String encodedKey = Base64.getUrlEncoder().withoutPadding()
+        .encodeToString(itemKey.getBytes(StandardCharsets.UTF_8));
+    
+    String getByEncodedKeyUrl = url(
+        "/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/encodedItems/{key}");
+    assert namespace != null;
+    ResponseEntity<ItemDTO> response = restTemplate.getForEntity(getByEncodedKeyUrl, ItemDTO.class,
+        app.getAppId(), cluster.getName(), namespace.getNamespaceName(), encodedKey);
+    
+    Assert.assertEquals(HttpStatus.OK, response.getStatusCode());
+    Assert.assertEquals(itemKey, Objects.requireNonNull(response.getBody()).getKey());
+  }
+
+  @Test
+  @Sql(scripts = "/controller/test-itemset.sql", executionPhase = ExecutionPhase.BEFORE_TEST_METHOD)
+  @Sql(scripts = "/controller/cleanup.sql", executionPhase = ExecutionPhase.AFTER_TEST_METHOD)
+  public void testGetByEncodedKeyWithComplexKey() {
+    String appId = "someAppId";
+    AppDTO app = restTemplate.getForObject(appBaseUrl(), AppDTO.class, appId);
+    assert app != null;
+    ClusterDTO cluster =
+        restTemplate.getForObject(clusterBaseUrl(), ClusterDTO.class, app.getAppId(), "default");
+    assert cluster != null;
+    NamespaceDTO namespace = restTemplate.getForObject(namespaceBaseUrl(), NamespaceDTO.class,
+        app.getAppId(), cluster.getName(), "application");
+
+    // Create an item with a complex key containing special characters
+    String complexKey = "wonfu.soa.circuit-breaker.enable.gitea-svc@/api/v1/fetchWorkflows";
+    String itemValue = "test-value";
+    ItemDTO item = new ItemDTO(complexKey, itemValue, "", 1);
+    assert namespace != null;
+    item.setNamespaceId(namespace.getId());
+    item.setDataChangeLastModifiedBy("apollo");
+
+    ResponseEntity<ItemDTO> createResponse = restTemplate.postForEntity(itemBaseUrl(), item,
+        ItemDTO.class, app.getAppId(), cluster.getName(), namespace.getNamespaceName());
+    Assert.assertEquals(HttpStatus.OK, createResponse.getStatusCode());
+    
+    // Now retrieve it using the encoded key
+    String encodedKey = Base64.getUrlEncoder().withoutPadding()
+        .encodeToString(complexKey.getBytes(StandardCharsets.UTF_8));
+    
+    String getByEncodedKeyUrl = url(
+        "/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/encodedItems/{key}");
+    ResponseEntity<ItemDTO> response = restTemplate.getForEntity(getByEncodedKeyUrl, ItemDTO.class,
+        app.getAppId(), cluster.getName(), namespace.getNamespaceName(), encodedKey);
+    
+    Assert.assertEquals(HttpStatus.OK, response.getStatusCode());
+    Assert.assertEquals(complexKey, Objects.requireNonNull(response.getBody()).getKey());
+    Assert.assertEquals(itemValue, response.getBody().getValue());
+  }
 }

apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/ItemController.java

@@ -78,7 +78,7 @@ public OpenItemDTO getItemByEncodedKey(@PathVariable String appId, @PathVariable
       @PathVariable String clusterName, @PathVariable String namespaceName,
       @PathVariable String key) {
     return this.getItem(appId, env, clusterName, namespaceName,
-        new String(Base64.getDecoder().decode(key.getBytes(StandardCharsets.UTF_8))));
+        new String(Base64.getUrlDecoder().decode(key.getBytes(StandardCharsets.UTF_8))));
   }
 
   @PreAuthorize(
@@ -158,7 +158,7 @@ public void updateItemByEncodedKey(@PathVariable String appId, @PathVariable Str
       @PathVariable String key, @RequestBody OpenItemDTO item,
       @RequestParam(defaultValue = "false") boolean createIfNotExists) {
     this.updateItem(appId, env, clusterName, namespaceName,
-        new String(Base64.getDecoder().decode(key.getBytes(StandardCharsets.UTF_8))), item,
+        new String(Base64.getUrlDecoder().decode(key.getBytes(StandardCharsets.UTF_8))), item,
         createIfNotExists);
   }
 
@@ -191,7 +191,7 @@ public void deleteItemByEncodedKey(@PathVariable String appId, @PathVariable Str
       @PathVariable String clusterName, @PathVariable String namespaceName,
       @PathVariable String key, @RequestParam String operator) {
     this.deleteItem(appId, env, clusterName, namespaceName,
-        new String(Base64.getDecoder().decode(key.getBytes(StandardCharsets.UTF_8))), operator);
+        new String(Base64.getUrlDecoder().decode(key.getBytes(StandardCharsets.UTF_8))), operator);
   }
 
   @GetMapping(value = "/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items")

apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/api/AdminServiceAPI.java

@@ -218,7 +218,7 @@ public ItemDTO loadItemByEncodeKey(Env env, String appId, String clusterName,
       return restTemplate.get(env,
           "apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/encodedItems/{key}",
           ItemDTO.class, appId, clusterName, namespaceName,
-          new String(Base64.getEncoder().encode(key.getBytes(StandardCharsets.UTF_8))));
+          new String(Base64.getUrlEncoder().withoutPadding().encode(key.getBytes(StandardCharsets.UTF_8))));
     }
 
     public ItemDTO loadItemById(Env env, long itemId) {