Rename base classes from Common* to Base* to follow the consisten…

…t naming convention
turms-im · Jun 10, 2024 · afe4536 · afe4536
1 parent d32659a
commit afe4536
Show file tree

Hide file tree

Showing 24 changed files with 81 additions and 93 deletions.
diff --git a/turms-gateway/src/main/java/im/turms/gateway/infra/logging/ApiLoggingContext.java b/turms-gateway/src/main/java/im/turms/gateway/infra/logging/ApiLoggingContext.java
@@ -22,7 +22,7 @@
 import org.springframework.context.annotation.Configuration;
 
 import im.turms.server.common.access.client.dto.request.TurmsRequest;
-import im.turms.server.common.infra.logging.CommonApiLoggingContext;
+import im.turms.server.common.infra.logging.BaseApiLoggingContext;
 import im.turms.server.common.infra.property.TurmsPropertiesManager;
 import im.turms.server.common.infra.property.env.gateway.clientapi.ClientApiLoggingProperties;
 import im.turms.server.common.infra.property.env.service.env.clientapi.property.LoggingRequestProperties;
@@ -31,7 +31,7 @@
  * @author James Chen
  */
 @Configuration
-public class ApiLoggingContext extends CommonApiLoggingContext {
+public class ApiLoggingContext extends BaseApiLoggingContext {
 
     private final Map<TurmsRequest.KindCase, LoggingRequestProperties> typeToSupportedLoggingRequestProperties;
     private final Map<TurmsRequest.KindCase, LoggingRequestProperties> typeToSupportedLoggingNotificationsProperties;

diff --git a/turms-gateway/src/main/java/im/turms/gateway/storage/redis/RedisConfig.java b/turms-gateway/src/main/java/im/turms/gateway/storage/redis/RedisConfig.java
@@ -21,13 +21,13 @@
 
 import im.turms.server.common.infra.context.TurmsApplicationContext;
 import im.turms.server.common.infra.property.TurmsPropertiesManager;
-import im.turms.server.common.storage.redis.CommonRedisConfig;
+import im.turms.server.common.storage.redis.BaseRedisConfig;
 
 /**
  * @author James Chen
  */
 @Configuration
-public class RedisConfig extends CommonRedisConfig {
+public class RedisConfig extends BaseRedisConfig {
 
     protected RedisConfig(
             TurmsApplicationContext context,

diff --git a/...r-common/src/main/java/im/turms/server/common/access/admin/web/HttpRequestDispatcher.java b/...r-common/src/main/java/im/turms/server/common/access/admin/web/HttpRequestDispatcher.java
@@ -78,7 +78,7 @@
 import im.turms.server.common.infra.property.TurmsProperties;
 import im.turms.server.common.infra.property.TurmsPropertiesManager;
 import im.turms.server.common.infra.property.env.common.adminapi.AdminHttpProperties;
-import im.turms.server.common.infra.property.env.common.adminapi.CommonAdminApiProperties;
+import im.turms.server.common.infra.property.env.common.adminapi.BaseAdminApiProperties;
 import im.turms.server.common.infra.time.DurationConst;
 import im.turms.server.common.infra.tracing.TracingCloseableContext;
 import im.turms.server.common.infra.tracing.TracingContext;
@@ -143,7 +143,7 @@ public HttpRequestDispatcher(
         authenticator = new HttpRequestAuthenticator(adminService);
 
         TurmsProperties properties = propertiesManager.getLocalProperties();
-        CommonAdminApiProperties apiProperties = switch (node.getNodeType()) {
+        BaseAdminApiProperties apiProperties = switch (node.getNodeType()) {
             case AI_SERVING -> properties.getAiServing()
                     .getAdminApi();
             case GATEWAY -> properties.getGateway()
@@ -190,7 +190,7 @@ public HttpRequestDispatcher(
     // region Properties
     private void updateGlobalProperties(TurmsProperties properties) {
         NodeType nodeType = node.getNodeType();
-        CommonAdminApiProperties apiProperties = switch (nodeType) {
+        BaseAdminApiProperties apiProperties = switch (nodeType) {
             case AI_SERVING -> properties.getAiServing()
                     .getAdminApi();
             case GATEWAY -> properties.getGateway()

diff --git a/...nfra/logging/CommonApiLoggingContext.java → .../infra/logging/BaseApiLoggingContext.java b/...nfra/logging/CommonApiLoggingContext.java → .../infra/logging/BaseApiLoggingContext.java
@@ -32,7 +32,9 @@
 /**
  * @author James Chen
  */
-public abstract class CommonApiLoggingContext {
+public abstract class BaseApiLoggingContext {
+
+    public abstract boolean shouldLogNotification(TurmsRequest.KindCase requestType);
 
     protected Map<TurmsRequest.KindCase, LoggingRequestProperties> getSupportedLoggingRequestProperties(
             Set<LoggingCategoryProperties> includedCategories,
@@ -108,4 +110,4 @@ private Set<LoggingRequestProperties> getRequestProperties(
         return loggingRequests;
     }
 
-}
+}
diff --git a/...src/main/java/im/turms/server/common/infra/property/env/aiserving/AdminApiProperties.java b/...src/main/java/im/turms/server/common/infra/property/env/aiserving/AdminApiProperties.java
@@ -20,14 +20,14 @@
 import lombok.Builder;
 import lombok.Data;
 
-import im.turms.server.common.infra.property.env.common.adminapi.CommonAdminApiProperties;
+import im.turms.server.common.infra.property.env.common.adminapi.BaseAdminApiProperties;
 
 /**
  * @author James Chen
  */
 @Builder(toBuilder = true)
 @Data
-public class AdminApiProperties extends CommonAdminApiProperties {
+public class AdminApiProperties extends BaseAdminApiProperties {
 
     public AdminApiProperties() {
         http.setPort(5510);

diff --git a/.../common/CommonRateLimitingProperties.java → ...nv/common/BaseRateLimitingProperties.java b/.../common/CommonRateLimitingProperties.java → ...nv/common/BaseRateLimitingProperties.java
@@ -33,7 +33,7 @@
 @AllArgsConstructor
 @Data
 @NoArgsConstructor
-public abstract class CommonRateLimitingProperties {
+public abstract class BaseRateLimitingProperties {
 
     @Description("The maximum number of tokens that the bucket can hold")
     @GlobalProperty

diff --git a/...rty/env/common/CommonRedisProperties.java → ...perty/env/common/BaseRedisProperties.java b/...rty/env/common/CommonRedisProperties.java → ...perty/env/common/BaseRedisProperties.java
@@ -18,9 +18,9 @@
 package im.turms.server.common.infra.property.env.common;
 
 import lombok.AllArgsConstructor;
-import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
 import im.turms.server.common.storage.redis.RedisProperties;
@@ -30,10 +30,10 @@
  * @author James Chen
  */
 @AllArgsConstructor
-@Builder(toBuilder = true)
 @Data
 @NoArgsConstructor
-public class CommonRedisProperties {
+@SuperBuilder(toBuilder = true)
+public abstract class BaseRedisProperties {
 
     @NestedConfigurationProperty
     private transient RedisProperties session = new RedisProperties();

diff --git a/...urms/server/common/infra/property/env/common/adminapi/AdminApiRateLimitingProperties.java b/...urms/server/common/infra/property/env/common/adminapi/AdminApiRateLimitingProperties.java
@@ -17,12 +17,12 @@
 
 package im.turms.server.common.infra.property.env.common.adminapi;
 
-import im.turms.server.common.infra.property.env.common.CommonRateLimitingProperties;
+import im.turms.server.common.infra.property.env.common.BaseRateLimitingProperties;
 
 /**
  * @author James Chen
  */
-public class AdminApiRateLimitingProperties extends CommonRateLimitingProperties {
+public class AdminApiRateLimitingProperties extends BaseRateLimitingProperties {
 
     public AdminApiRateLimitingProperties() {
         setCapacity(50);

diff --git a/...on/adminapi/CommonAdminApiProperties.java → ...mmon/adminapi/BaseAdminApiProperties.java b/...on/adminapi/CommonAdminApiProperties.java → ...mmon/adminapi/BaseAdminApiProperties.java
@@ -27,7 +27,7 @@
  * @author James Chen
  */
 @Data
-public abstract class CommonAdminApiProperties {
+public abstract class BaseAdminApiProperties {
 
     @Description("Whether to enable the APIs for administrators")
     private boolean enabled = true;
@@ -49,4 +49,4 @@ public abstract class CommonAdminApiProperties {
     @NestedConfigurationProperty
     private LogProperties log = new LogProperties();
 
-}
+}
diff --git a/...api/CommonClientApiLoggingProperties.java → ...ntapi/BaseClientApiLoggingProperties.java b/...api/CommonClientApiLoggingProperties.java → ...ntapi/BaseClientApiLoggingProperties.java
@@ -33,7 +33,7 @@
  * @author James Chen
  */
 @Data
-public abstract class CommonClientApiLoggingProperties {
+public abstract class BaseClientApiLoggingProperties {
 
     private static final String DESC_STRATEGY_TO_GET_INCLUDED_REQUESTS =
             "Turms will get the requests to log from the union of "

diff --git a/...n/src/main/java/im/turms/server/common/infra/property/env/gateway/AdminApiProperties.java b/...n/src/main/java/im/turms/server/common/infra/property/env/gateway/AdminApiProperties.java
@@ -20,17 +20,17 @@
 import lombok.Builder;
 import lombok.Data;
 
-import im.turms.server.common.infra.property.env.common.adminapi.CommonAdminApiProperties;
+import im.turms.server.common.infra.property.env.common.adminapi.BaseAdminApiProperties;
 
 /**
  * @author James Chen
  */
 @Builder(toBuilder = true)
 @Data
-public class AdminApiProperties extends CommonAdminApiProperties {
+public class AdminApiProperties extends BaseAdminApiProperties {
 
     public AdminApiProperties() {
         http.setPort(9510);
     }
 
-}
+}
diff --git a/.../turms/server/common/infra/property/env/gateway/clientapi/ClientApiLoggingProperties.java b/.../turms/server/common/infra/property/env/gateway/clientapi/ClientApiLoggingProperties.java
@@ -23,7 +23,7 @@
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 
-import im.turms.server.common.infra.property.env.common.clientapi.CommonClientApiLoggingProperties;
+import im.turms.server.common.infra.property.env.common.clientapi.BaseClientApiLoggingProperties;
 
 /**
  * @author James Chen
@@ -33,7 +33,7 @@
 @Data
 @EqualsAndHashCode(callSuper = true)
 @NoArgsConstructor
-public class ClientApiLoggingProperties extends CommonClientApiLoggingProperties {
+public class ClientApiLoggingProperties extends BaseClientApiLoggingProperties {
 
     private float heartbeatSampleRate;
 

diff --git a/...s/server/common/infra/property/env/gateway/clientapi/ClientApiRateLimitingProperties.java b/...s/server/common/infra/property/env/gateway/clientapi/ClientApiRateLimitingProperties.java
@@ -19,11 +19,11 @@
 
 import lombok.NoArgsConstructor;
 
-import im.turms.server.common.infra.property.env.common.CommonRateLimitingProperties;
+import im.turms.server.common.infra.property.env.common.BaseRateLimitingProperties;
 
 /**
  * @author James Chen
  */
 @NoArgsConstructor
-public class ClientApiRateLimitingProperties extends CommonRateLimitingProperties {
+public class ClientApiRateLimitingProperties extends BaseRateLimitingProperties {
 }
diff --git a/...in/java/im/turms/server/common/infra/property/env/gateway/redis/TurmsRedisProperties.java b/...in/java/im/turms/server/common/infra/property/env/gateway/redis/TurmsRedisProperties.java
@@ -21,13 +21,13 @@
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 
-import im.turms.server.common.infra.property.env.common.CommonRedisProperties;
+import im.turms.server.common.infra.property.env.common.BaseRedisProperties;
 
 /**
  * @author James Chen
  */
 @Data
 @EqualsAndHashCode(callSuper = true)
 @NoArgsConstructor
-public class TurmsRedisProperties extends CommonRedisProperties {
+public class TurmsRedisProperties extends BaseRedisProperties {
 }
diff --git a/...va/im/turms/server/common/infra/property/env/service/env/adminapi/AdminApiProperties.java b/...va/im/turms/server/common/infra/property/env/service/env/adminapi/AdminApiProperties.java
@@ -23,7 +23,7 @@
 import lombok.Builder;
 import lombok.Data;
 
-import im.turms.server.common.infra.property.env.common.adminapi.CommonAdminApiProperties;
+import im.turms.server.common.infra.property.env.common.adminapi.BaseAdminApiProperties;
 import im.turms.server.common.infra.property.metadata.Description;
 import im.turms.server.common.infra.property.metadata.GlobalProperty;
 import im.turms.server.common.infra.property.metadata.MutableProperty;
@@ -34,7 +34,7 @@
 @AllArgsConstructor
 @Builder(toBuilder = true)
 @Data
-public class AdminApiProperties extends CommonAdminApiProperties {
+public class AdminApiProperties extends BaseAdminApiProperties {
 
     @Description("Whether to allow administrators to delete data without any filter. "
             + "Better false to prevent administrators from deleting all data by accident")

diff --git a/...ms/server/common/infra/property/env/service/env/clientapi/ClientApiLoggingProperties.java b/...ms/server/common/infra/property/env/service/env/clientapi/ClientApiLoggingProperties.java
@@ -21,13 +21,13 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
-import im.turms.server.common.infra.property.env.common.clientapi.CommonClientApiLoggingProperties;
+import im.turms.server.common.infra.property.env.common.clientapi.BaseClientApiLoggingProperties;
 
 /**
  * @author James Chen
  */
 @Builder(toBuilder = true)
 @Data
 @EqualsAndHashCode(callSuper = true)
-public class ClientApiLoggingProperties extends CommonClientApiLoggingProperties {
+public class ClientApiLoggingProperties extends BaseClientApiLoggingProperties {
 }
diff --git a/...ava/im/turms/server/common/infra/property/env/service/env/redis/TurmsRedisProperties.java b/...ava/im/turms/server/common/infra/property/env/service/env/redis/TurmsRedisProperties.java
@@ -23,7 +23,7 @@
 import lombok.NoArgsConstructor;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
-import im.turms.server.common.infra.property.env.common.CommonRedisProperties;
+import im.turms.server.common.infra.property.env.common.BaseRedisProperties;
 import im.turms.server.common.storage.redis.RedisProperties;
 
 /**
@@ -33,7 +33,7 @@
 @Data
 @EqualsAndHashCode(callSuper = true)
 @NoArgsConstructor
-public class TurmsRedisProperties extends CommonRedisProperties {
+public class TurmsRedisProperties extends BaseRedisProperties {
 
     @NestedConfigurationProperty
     private RedisProperties sequenceId = new RedisProperties();

diff --git a/...server-common/src/main/java/im/turms/server/common/infra/throttle/TokenBucketContext.java b/...server-common/src/main/java/im/turms/server/common/infra/throttle/TokenBucketContext.java
@@ -20,7 +20,7 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
-import im.turms.server.common.infra.property.env.common.CommonRateLimitingProperties;
+import im.turms.server.common.infra.property.env.common.BaseRateLimitingProperties;
 
 /**
  * @author James Chen
@@ -33,11 +33,11 @@ public class TokenBucketContext {
     int refillIntervalMillis;
     int initialTokens;
 
-    public TokenBucketContext(CommonRateLimitingProperties properties) {
+    public TokenBucketContext(BaseRateLimitingProperties properties) {
         updateRequestTokenBucket(properties);
     }
 
-    public void updateRequestTokenBucket(CommonRateLimitingProperties properties) {
+    public void updateRequestTokenBucket(BaseRateLimitingProperties properties) {
         capacity = properties.getCapacity();
         initialTokens = properties.getInitialTokens();
         tokensPerPeriod = properties.getTokensPerPeriod();

diff --git a/...mmon/storage/redis/CommonRedisConfig.java → ...common/storage/redis/BaseRedisConfig.java b/...mmon/storage/redis/CommonRedisConfig.java → ...common/storage/redis/BaseRedisConfig.java
@@ -26,7 +26,7 @@
 import im.turms.server.common.infra.collection.CollectionUtil;
 import im.turms.server.common.infra.context.JobShutdownOrder;
 import im.turms.server.common.infra.context.TurmsApplicationContext;
-import im.turms.server.common.infra.property.env.common.CommonRedisProperties;
+import im.turms.server.common.infra.property.env.common.BaseRedisProperties;
 import im.turms.server.common.storage.redis.codec.context.RedisCodecContext;
 import im.turms.server.common.storage.redis.codec.context.RedisCodecContextPool;
 
@@ -37,7 +37,7 @@
  * @see org.springframework.boot.autoconfigure.data.redis.RedisConnectionConfiguration
  * @see org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration
  */
-public abstract class CommonRedisConfig {
+public abstract class BaseRedisConfig {
 
     private final TurmsRedisClientManager sessionRedisClientManager;
     private final TurmsRedisClientManager locationRedisClientManager;
@@ -48,9 +48,9 @@ public abstract class CommonRedisConfig {
     private final List<TurmsRedisClientManager> registeredClientManagers = new LinkedList<>();
     private final List<TurmsRedisClient> registeredClients = new LinkedList<>();
 
-    protected CommonRedisConfig(
+    protected BaseRedisConfig(
             TurmsApplicationContext context,
-            CommonRedisProperties redisProperties,
+            BaseRedisProperties redisProperties,
             boolean treatUserIdAndDeviceTypeAsUniqueUser) {
         sessionRedisClientManager = newSessionRedisClientManager(redisProperties.getSession());
         locationRedisClientManager = newLocationRedisClientManager(redisProperties.getLocation(),
@@ -64,13 +64,14 @@ protected CommonRedisConfig(
         context.addShutdownHook(JobShutdownOrder.CLOSE_REDIS_CONNECTIONS, this::destroy);
     }
 
-    public static TurmsRedisClientManager newSessionRedisClientManager(RedisProperties properties) {
+    private static TurmsRedisClientManager newSessionRedisClientManager(
+            RedisProperties properties) {
         return new TurmsRedisClientManager(
                 properties,
                 RedisCodecContextPool.USER_SESSIONS_STATUS_CODEC_CONTEXT);
     }
 
-    public static TurmsRedisClientManager newLocationRedisClientManager(
+    private static TurmsRedisClientManager newLocationRedisClientManager(
             RedisProperties properties,
             boolean treatUserIdAndDeviceTypeAsUniqueUser) {
         RedisCodecContext codecContext = treatUserIdAndDeviceTypeAsUniqueUser
@@ -79,18 +80,12 @@ public static TurmsRedisClientManager newLocationRedisClientManager(
         return new TurmsRedisClientManager(properties, codecContext);
     }
 
-    public static TurmsRedisClient newIpBlocklistRedisClient(String uri) {
-        return new TurmsRedisClient(
-                uri,
-                RedisCodecContext.builder()
-                        .build());
+    private TurmsRedisClient newIpBlocklistRedisClient(String uri) {
+        return new TurmsRedisClient(uri, RedisCodecContext.DEFAULT);
     }
 
-    public static TurmsRedisClient newUserIdBlocklistRedisClient(String uri) {
-        return new TurmsRedisClient(
-                uri,
-                RedisCodecContext.builder()
-                        .build());
+    private TurmsRedisClient newUserIdBlocklistRedisClient(String uri) {
+        return new TurmsRedisClient(uri, RedisCodecContext.DEFAULT);
     }
 
     public void registerClientManagers(List<TurmsRedisClientManager> clientManagers) {