Merge branch 'master' into feautre/IncrementalSync

.github/workflows/build.yml

@@ -37,11 +37,12 @@ jobs:
       with:
         java-version: ${{ matrix.jdk }}
     - name: Cache Maven packages
-      uses: actions/cache@v1
+      uses: actions/cache@v4
       with:
-        path: ~/.m2
-        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-        restore-keys: ${{ runner.os }}-m2
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+        restore-keys: |
+          ${{ runner.os }}-maven-
     - name: JDK 8
       if: matrix.jdk == '8'
       run: mvn -B clean package jacoco:report -Dmaven.gitcommitid.skip=true

CHANGES.md

@@ -22,6 +22,10 @@ Apollo 2.4.0
 * [Fix: ensure clusters order in envClusters open api](https://github.com/apolloconfig/apollo/pull/5277)
 * [Fix: bump xstream from 1.4.20 to 1.4.21 to fix CVE-2024-47072](https://github.com/apolloconfig/apollo/pull/5280)
 * [Feature: highlight diffs for properties](https://github.com/apolloconfig/apollo/pull/5282)
+* [Feature: Add rate limiting function to ConsumerToken](https://github.com/apolloconfig/apollo/pull/5267)
+* [Feature: add JSON formatting function in apollo-portal](https://github.com/apolloconfig/apollo/pull/5287)
+* [Fix: add missing url patterns for AdminServiceAuthenticationFilter](https://github.com/apolloconfig/apollo/pull/5291)
+* [Fix: support java.time.Instant serialization with gson](https://github.com/apolloconfig/apollo/pull/5298)
 
 ------------------
 All issues and pull requests are [here](https://github.com/apolloconfig/apollo/milestone/15?closed=1)

apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/AdminServiceAutoConfiguration.java

@@ -36,12 +36,15 @@ public FilterRegistrationBean<AdminServiceAuthenticationFilter> adminServiceAuth
     FilterRegistrationBean<AdminServiceAuthenticationFilter> filterRegistrationBean = new FilterRegistrationBean<>();
 
     filterRegistrationBean.setFilter(new AdminServiceAuthenticationFilter(bizConfig));
+    filterRegistrationBean.addUrlPatterns("/apollo/audit/*");
     filterRegistrationBean.addUrlPatterns("/apps/*");
     filterRegistrationBean.addUrlPatterns("/appnamespaces/*");
     filterRegistrationBean.addUrlPatterns("/instances/*");
     filterRegistrationBean.addUrlPatterns("/items/*");
+    filterRegistrationBean.addUrlPatterns("/items-search/*");
     filterRegistrationBean.addUrlPatterns("/namespaces/*");
     filterRegistrationBean.addUrlPatterns("/releases/*");
+    filterRegistrationBean.addUrlPatterns("/server/*");
 
     return filterRegistrationBean;
   }

apollo-audit/apollo-audit-impl/src/main/java/com/ctrip/framework/apollo/audit/component/ApolloAuditLogApiJpaImpl.java

@@ -95,7 +95,7 @@ public void appendDataInfluence(String entityName, String entityId, String field
   @Override
   public void appendDataInfluences(List<Object> entities, Class<?> beanDefinition) {
     String tableName = ApolloAuditUtil.getApolloAuditLogTableName(beanDefinition);
-    if (Objects.isNull(tableName) || tableName.equals("")) {
+    if (Objects.isNull(tableName) || Objects.equals(tableName, "")) {
       return;
     }
     List<Field> dataInfluenceFields = ApolloAuditUtil.getAnnotatedFields(

apollo-audit/apollo-audit-impl/src/main/java/com/ctrip/framework/apollo/audit/component/ApolloAuditLogApiNoOpImpl.java

@@ -21,6 +21,7 @@
 import com.ctrip.framework.apollo.audit.dto.ApolloAuditLogDataInfluenceDTO;
 import com.ctrip.framework.apollo.audit.dto.ApolloAuditLogDetailsDTO;
 import com.ctrip.framework.apollo.audit.dto.ApolloAuditLogDTO;
+import java.util.Collections;
 import java.util.Date;
 import java.util.List;
 
@@ -50,28 +51,28 @@ public void appendDataInfluences(List<Object> entities, Class<?> beanDefinition)
 
   @Override
   public List<ApolloAuditLogDTO> queryLogs(int page, int size) {
-    return null;
+    return Collections.emptyList();
   }
 
   @Override
   public List<ApolloAuditLogDTO> queryLogsByOpName(String opName, Date startDate,
       Date endDate, int page, int size) {
-    return null;
+    return Collections.emptyList();
   }
 
   @Override
   public List<ApolloAuditLogDetailsDTO> queryTraceDetails(String traceId) {
-    return null;
+    return Collections.emptyList();
   }
 
   @Override
   public List<ApolloAuditLogDataInfluenceDTO> queryDataInfluencesByField(String entityName,
       String entityId, String fieldName, int page, int size) {
-    return null;
+    return Collections.emptyList();
   }
 
   @Override
   public List<ApolloAuditLogDTO> searchLogByNameOrTypeOrOperator(String query, int page, int size) {
-    return null;
+    return Collections.emptyList();
   }
 }

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Audit.java

@@ -79,6 +79,7 @@ public void setOpName(String opName) {
     this.opName = opName;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("entityName", entityName).add("entityId", entityId)
         .add("opName", opName).add("comment", comment).toString();

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Cluster.java

@@ -78,6 +78,7 @@ public void setComment(String comment) {
     this.comment = comment;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("name", name).add("appId", appId)
         .add("parentClusterId", parentClusterId).add("comment", comment).toString();

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Item.java

@@ -99,6 +99,7 @@ public void setType(int type) {
     this.type = type;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("namespaceId", namespaceId).add("key", key)
             .add("type", type).add("value", value)

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Namespace.java

@@ -74,6 +74,7 @@ public void setNamespaceName(String namespaceName) {
     this.namespaceName = namespaceName;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("appId", appId).add("clusterName", clusterName)
         .add("namespaceName", namespaceName).toString();

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Privilege.java

@@ -64,6 +64,7 @@ public void setPrivilType(String privilType) {
     this.privilType = privilType;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("namespaceId", namespaceId).add("privilType", privilType)
         .add("name", name).toString();

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Release.java

@@ -123,6 +123,7 @@ public void setAbandoned(boolean abandoned) {
     isAbandoned = abandoned;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("name", name).add("appId", appId).add("clusterName", clusterName)
         .add("namespaceName", namespaceName).add("configurations", configurations)

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/ReleaseHistory.java

@@ -121,6 +121,7 @@ public void setOperationContext(String operationContext) {
     this.operationContext = operationContext;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("appId", appId).add("clusterName", clusterName)
         .add("namespaceName", namespaceName).add("branchName", branchName)

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/ServerConfig.java

@@ -77,7 +77,8 @@ public void setCluster(String cluster) {
     this.cluster = cluster;
   }
 
+  @Override
   public String toString() {
-    return toStringHelper().add("key", key).add("value", value).add("comment", comment).toString();
+    return toStringHelper().add("key", key).add("value", value).add("cluster", cluster).add("comment", comment).toString();
   }
 }

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/registry/DatabaseServiceRegistryImpl.java

@@ -37,11 +37,13 @@ static ServiceRegistry convert(ServiceInstance instance) {
     return serviceRegistry;
   }
 
+  @Override
   public void register(ServiceInstance instance) {
     ServiceRegistry serviceRegistry = convert(instance);
     this.serviceRegistryService.saveIfNotExistByServiceNameAndUri(serviceRegistry);
   }
 
+  @Override
   public void deregister(ServiceInstance instance) {
     ServiceRegistry serviceRegistry = convert(instance);
     this.serviceRegistryService.delete(serviceRegistry);

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/registry/configuration/support/ApolloServiceRegistryProperties.java

@@ -97,6 +97,7 @@ public void setEnabled(boolean enabled) {
     this.enabled = enabled;
   }
 
+  @Override
   public String getServiceName() {
     return serviceName;
   }

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/utils/ReleaseMessageKeyGenerator.java

@@ -21,6 +21,7 @@
 
 import com.ctrip.framework.apollo.core.ConfigConsts;
 import com.google.common.base.Splitter;
+import java.util.Collections;
 import java.util.List;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -42,7 +43,7 @@ public static List<String> messageToList(String message) {
     //message should be appId+cluster+namespace
     if (keys.size() != 3) {
       logger.error("message format invalid - {}", message);
-      return null;
+      return Collections.emptyList();
     }
     return keys;
   }

apollo-biz/src/test/java/com/ctrip/framework/apollo/biz/utils/ReleaseKeyGeneratorTest.java

@@ -23,8 +23,6 @@
 
 import java.util.List;
 import org.junit.Test;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.util.Set;
 import java.util.concurrent.CountDownLatch;
@@ -33,7 +31,6 @@
 import java.util.concurrent.TimeUnit;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNull;
 
 /**
  * @author Jason Song([email protected])
@@ -80,7 +77,8 @@ public void testMessageToList() {
 
     message = "appId+cluster";
     keys = ReleaseMessageKeyGenerator.messageToList(message);
-    assertNull(keys);
+    assert keys != null;
+    assertEquals(0, keys.size());
   }
 
   private Runnable generateReleaseKeysTask(Namespace namespace, Set<String> releaseKeys,

apollo-common/src/main/java/com/ctrip/framework/apollo/common/controller/HttpMessageConverterConfiguration.java

@@ -19,6 +19,11 @@
 import com.google.common.collect.Lists;
 import com.google.gson.GsonBuilder;
 
+import com.google.gson.JsonDeserializer;
+import com.google.gson.JsonNull;
+import com.google.gson.JsonPrimitive;
+import com.google.gson.JsonSerializer;
+import java.time.Instant;
 import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -37,9 +42,23 @@
 public class HttpMessageConverterConfiguration {
   @Bean
   public HttpMessageConverters messageConverters() {
+    // Custom Gson TypeAdapter for Instant
+    JsonSerializer<Instant> instantJsonSerializer = (src, typeOfSrc, context) ->
+        src == null ? JsonNull.INSTANCE : new JsonPrimitive(src.toString()); // Serialize Instant as ISO-8601 string
+
+    JsonDeserializer<Instant> instantJsonDeserializer = (json, typeOfT, context) -> {
+      if (json == null || json.isJsonNull()) {
+        return null;
+      }
+      return Instant.parse(json.getAsString()); // Deserialize from ISO-8601 string
+    };
+
     GsonHttpMessageConverter gsonHttpMessageConverter = new GsonHttpMessageConverter();
     gsonHttpMessageConverter.setGson(
-            new GsonBuilder().setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ").create());
+            new GsonBuilder().setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ")
+                .registerTypeAdapter(Instant.class, instantJsonSerializer)
+                .registerTypeAdapter(Instant.class, instantJsonDeserializer)
+                .create());
     final List<HttpMessageConverter<?>> converters = Lists.newArrayList(
             new ByteArrayHttpMessageConverter(), new StringHttpMessageConverter(),
             new AllEncompassingFormHttpMessageConverter(), gsonHttpMessageConverter);

apollo-common/src/main/java/com/ctrip/framework/apollo/common/datasource/ApolloDataSourceScriptDatabaseInitializerFactory.java

@@ -20,6 +20,7 @@
 import java.security.CodeSource;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import javax.sql.DataSource;
 import org.springframework.boot.jdbc.DataSourceBuilder;
@@ -101,7 +102,7 @@ private static List<String> resolveLocations(Collection<String> locations,
   private static Collection<String> convertRepositoryLocations(Collection<String> locations,
       DataSource dataSource) {
     if (CollectionUtils.isEmpty(locations)) {
-      return null;
+      return Collections.emptyList();
     }
     String repositoryDir = findRepositoryDirectory();
     String suffix = findSuffix(dataSource);

apollo-common/src/main/java/com/ctrip/framework/apollo/common/entity/App.java

@@ -111,6 +111,7 @@ public void setOwnerName(String ownerName) {
     this.ownerName = ownerName;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("name", name).add("appId", appId)
         .add("orgId", orgId)

apollo-common/src/main/java/com/ctrip/framework/apollo/common/entity/AppNamespace.java

@@ -107,6 +107,7 @@ public void setFormat(String format) {
     this.format = format;
   }
 
+  @Override
   public String toString() {
     return toStringHelper().add("name", name).add("appId", appId).add("comment", comment)
         .add("format", format).add("isPublic", isPublic).toString();

apollo-common/src/main/java/com/ctrip/framework/apollo/common/entity/BaseEntity.java

@@ -149,6 +149,7 @@ protected ToStringHelper toStringHelper() {
         .add("dataChangeLastModifiedTime", dataChangeLastModifiedTime);
   }
 
+  @Override
   public String toString(){
     return toStringHelper().toString();
   }

apollo-common/src/main/java/com/ctrip/framework/apollo/common/exception/BadRequestException.java

@@ -37,6 +37,10 @@ public static BadRequestException orgIdIsBlank() {
     return new BadRequestException("orgId can not be blank");
   }
 
+  public static BadRequestException rateLimitIsInvalid() {
+    return new BadRequestException("rate limit must be greater than 1");
+  }
+
   public static BadRequestException itemAlreadyExists(String itemKey) {
     return new BadRequestException("item already exists for itemKey:%s", itemKey);
   }

apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/entity/ConsumerToken.java

@@ -18,6 +18,7 @@
 
 import com.ctrip.framework.apollo.common.entity.BaseEntity;
 
+import javax.validation.constraints.PositiveOrZero;
 import org.hibernate.annotations.SQLDelete;
 import org.hibernate.annotations.Where;
 
@@ -41,6 +42,10 @@ public class ConsumerToken extends BaseEntity {
   @Column(name = "`Token`", nullable = false)
   private String token;
 
+  @PositiveOrZero
+  @Column(name = "`RateLimit`", nullable = false)
+  private Integer rateLimit;
+
   @Column(name = "`Expires`", nullable = false)
   private Date expires;
 
@@ -60,6 +65,14 @@ public void setToken(String token) {
     this.token = token;
   }
 
+  public Integer getRateLimit() {
+    return rateLimit;
+  }
+
+  public void setRateLimit(Integer rateLimit) {
+    this.rateLimit = rateLimit;
+  }
+
   public Date getExpires() {
     return expires;
   }
@@ -71,6 +84,7 @@ public void setExpires(Date expires) {
   @Override
   public String toString() {
     return toStringHelper().add("consumerId", consumerId).add("token", token)
+        .add("rateLimit", rateLimit)
         .add("expires", expires).toString();
   }
 }