Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support incremental configuration synchronization client #5288

Open
wants to merge 20 commits into
base: master
Choose a base branch
from
Open

feat: support incremental configuration synchronization client #5288

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
4e8a699
init
jackie-coming Oct 31, 2024
26a0e1b
init config
jackie-coming Nov 18, 2024
2dd9352
code review
jackie-coming Nov 18, 2024
b13968c
add test
jackie-coming Nov 20, 2024
24bda1d
add test
jackie-coming Nov 21, 2024
cf5145f
add test
jackie-coming Nov 26, 2024
8cafda2
code format
jackie-coming Nov 27, 2024
72676c0
code format
jackie-coming Nov 27, 2024
065a092
feat: support incremental configuration synchronization client
jackie-coming Oct 31, 2024
e69f098
Merge remote-tracking branch 'origin/feautre/IncrementalSync' into fe…
jackie-coming Nov 27, 2024
a6a412a
code format
jackie-coming Nov 27, 2024
07bb41c
feat: support incremental configuration synchronization client
jackie-coming Nov 27, 2024
a4b356c
code format
jackie-coming Dec 8, 2024
5e37f55
update pom version
jackie-coming Dec 14, 2024
8512776
code format
jackie-coming Dec 20, 2024
5a76da9
code format
jackie-coming Dec 21, 2024
a4a2d05
code format
jackie-coming Dec 21, 2024
04f50ac
Merge branch 'master' into feautre/IncrementalSync
nobodyiam Dec 28, 2024
1b20e4e
update flag
jackie-coming Dec 29, 2024
4f06613
Merge remote-tracking branch 'origin/feautre/IncrementalSync' into fe…
jackie-coming Dec 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/config/BizConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,11 @@ public boolean isConfigServiceCacheKeyIgnoreCase() {
return getBooleanProperty("config-service.cache.key.ignore-case", false);
}

public boolean isConfigServiceChangeCacheEnabled() {
return getBooleanProperty("config-service.change.cache.enabled", false);
jackie-coming marked this conversation as resolved.
Show resolved Hide resolved
}


int checkInt(int value, int min, int max, int defaultValue) {
if (value >= min && value <= max) {
return value;
Expand Down
4 changes: 3 additions & 1 deletion apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/repository/ReleaseRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,15 @@ Release findFirstByAppIdAndClusterNameAndNamespaceNameAndIsAbandonedFalseOrderBy

Release findByIdAndIsAbandonedFalse(long id);

Release findByReleaseKey(String releaseKey);

List<Release> findByAppIdAndClusterNameAndNamespaceNameOrderByIdDesc(String appId, String clusterName, String namespaceName, Pageable page);

List<Release> findByAppIdAndClusterNameAndNamespaceNameAndIsAbandonedFalseOrderByIdDesc(String appId, String clusterName, String namespaceName, Pageable page);

List<Release> findByAppIdAndClusterNameAndNamespaceNameAndIsAbandonedFalseAndIdBetweenOrderByIdDesc(String appId, String clusterName, String namespaceName, long fromId, long toId);

List<Release> findByReleaseKeyIn(Set<String> releaseKey);
List<Release> findByReleaseKeyIn(Set<String> releaseKeys);

List<Release> findByIdIn(Set<Long> releaseIds);

Expand Down
4 changes: 4 additions & 0 deletions apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/service/ReleaseService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ public List<Release> findByReleaseKeys(Set<String> releaseKeys) {
return releaseRepository.findByReleaseKeyIn(releaseKeys);
}

public Release findByReleaseKey(String releaseKey) {
return releaseRepository.findByReleaseKey(releaseKey);
}

public Release findLatestActiveRelease(Namespace namespace) {
return findLatestActiveRelease(namespace.getAppId(),
namespace.getClusterName(), namespace.getNamespaceName());
Expand Down
6 changes: 5 additions & 1 deletion ...rc/main/java/com/ctrip/framework/apollo/configservice/ConfigServiceAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import com.ctrip.framework.apollo.configservice.service.ReleaseMessageServiceWithCache;
import com.ctrip.framework.apollo.configservice.service.config.ConfigService;
import com.ctrip.framework.apollo.configservice.service.config.ConfigServiceWithCache;
import com.ctrip.framework.apollo.configservice.service.config.ConfigServiceWithChangeCache;
import com.ctrip.framework.apollo.configservice.service.config.DefaultConfigService;
import com.ctrip.framework.apollo.configservice.util.AccessKeyUtil;
import io.micrometer.core.instrument.MeterRegistry;
Expand Down Expand Up @@ -73,9 +74,12 @@ public ConfigService configService() {
return new ConfigServiceWithCache(releaseService, releaseMessageService,
grayReleaseRulesHolder(), bizConfig, meterRegistry);
}
if(bizConfig.isConfigServiceChangeCacheEnabled()){
return new ConfigServiceWithChangeCache(releaseService, releaseMessageService,
grayReleaseRulesHolder(), bizConfig, meterRegistry);
}
return new DefaultConfigService(releaseService, grayReleaseRulesHolder());
}

@Bean
public static NoOpPasswordEncoder passwordEncoder() {
return (NoOpPasswordEncoder) NoOpPasswordEncoder.getInstance();
Expand Down
55 changes: 50 additions & 5 deletions ...e/src/main/java/com/ctrip/framework/apollo/configservice/controller/ConfigController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*/
package com.ctrip.framework.apollo.configservice.controller;

import com.ctrip.framework.apollo.biz.config.BizConfig;
import com.ctrip.framework.apollo.biz.entity.Release;
import com.ctrip.framework.apollo.common.entity.AppNamespace;
import com.ctrip.framework.apollo.common.utils.WebUtils;
Expand All @@ -26,10 +27,13 @@
import com.ctrip.framework.apollo.core.ConfigConsts;
import com.ctrip.framework.apollo.core.dto.ApolloConfig;
import com.ctrip.framework.apollo.core.dto.ApolloNotificationMessages;
import com.ctrip.framework.apollo.core.dto.ConfigurationChange;
import com.ctrip.framework.apollo.core.enums.ConfigSyncType;
import com.ctrip.framework.apollo.tracer.Tracer;
import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import org.springframework.web.bind.annotation.GetMapping;
Expand All @@ -42,6 +46,9 @@
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
Expand All @@ -59,6 +66,8 @@ public class ConfigController {
private final NamespaceUtil namespaceUtil;
private final InstanceConfigAuditUtil instanceConfigAuditUtil;
private final Gson gson;
private final BizConfig bizConfig;


private static final Type configurationTypeReference = new TypeToken<Map<String, String>>() {
}.getType();
Expand All @@ -68,12 +77,14 @@ public ConfigController(
final AppNamespaceServiceWithCache appNamespaceService,
final NamespaceUtil namespaceUtil,
final InstanceConfigAuditUtil instanceConfigAuditUtil,
final Gson gson) {
final Gson gson,
final BizConfig bizConfig) {
this.configService = configService;
this.appNamespaceService = appNamespaceService;
this.namespaceUtil = namespaceUtil;
this.instanceConfigAuditUtil = instanceConfigAuditUtil;
this.gson = gson;
this.bizConfig=bizConfig;
}

@GetMapping(value = "/{appId}/{clusterName}/{namespace:.+}")
Expand Down Expand Up @@ -132,10 +143,10 @@ public ApolloConfig queryConfig(@PathVariable String appId, @PathVariable String

auditReleases(appId, clusterName, dataCenter, clientIp, releases);

String mergedReleaseKey = releases.stream().map(Release::getReleaseKey)
String latestMergedReleaseKey = releases.stream().map(Release::getReleaseKey)
.collect(Collectors.joining(ConfigConsts.CLUSTER_NAMESPACE_SEPARATOR));

if (mergedReleaseKey.equals(clientSideReleaseKey)) {
if (latestMergedReleaseKey.equals(clientSideReleaseKey)) {
// Client side configuration is the same with server side, return 304
response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
Tracer.logEvent("Apollo.Config.NotModified",
Expand All @@ -144,8 +155,42 @@ public ApolloConfig queryConfig(@PathVariable String appId, @PathVariable String
}

ApolloConfig apolloConfig = new ApolloConfig(appId, appClusterNameLoaded, originalNamespace,
mergedReleaseKey);
apolloConfig.setConfigurations(mergeReleaseConfigurations(releases));
latestMergedReleaseKey);

Map<String, String> latestConfigurations=mergeReleaseConfigurations(releases);

if(bizConfig.isConfigServiceChangeCacheEnabled()){
LinkedHashSet<String> clientSideReleaseKeys = Sets.newLinkedHashSet(
Arrays.stream(clientSideReleaseKey.split("\\+")).collect(Collectors.toList()));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Ensure robust handling of clientSideReleaseKey

Consider adding validation to handle cases where clientSideReleaseKey might be null or empty to prevent potential NullPointerException or unexpected behavior when the client does not provide a releaseKey.

Suggested change:

Add a null or empty check before processing clientSideReleaseKey:

if (Strings.isNullOrEmpty(clientSideReleaseKey)) {
  // Handle the case appropriately, e.g., initialize to a default value or skip incremental sync
}


Map<String, Release> historyReleases = configService.findReleasesByReleaseKeys(
clientSideReleaseKeys);
//find history releases
if (historyReleases != null) {
//order by clientSideReleaseKeys
List<Release> historyReleasesWithOrder = new ArrayList<>();
for (String item : clientSideReleaseKeys) {
Release release = historyReleases.get(item);
if(release!=null){
historyReleasesWithOrder.add(release);
}
}

Map<String, String> historyConfigurations = mergeReleaseConfigurations
(historyReleasesWithOrder);

List<ConfigurationChange> configurationChanges = configService.calcConfigurationChanges
(latestConfigurations, historyConfigurations);

apolloConfig.setConfigurationChanges(configurationChanges);

apolloConfig.setConfigSyncType(ConfigSyncType.INCREMENTALSYNC.getValue());
return apolloConfig;
}

}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Handle empty or null historyReleases gracefully

Currently, the code checks if historyReleases != null, but does not handle the case where historyReleases is empty. This could lead to scenarios where incremental synchronization is attempted without any historical releases, potentially causing incorrect behavior.

Suggested solution:

Modify the condition to check for empty historyReleases and handle accordingly:

if (historyReleases != null && !historyReleases.isEmpty()) {
  // Existing logic
} else {
  // Fallback to full synchronization or handle the situation appropriately
  apolloConfig.setConfigurations(latestConfigurations);
}


apolloConfig.setConfigurations(latestConfigurations);

Tracer.logEvent("Apollo.Config.Found", assembleKey(appId, appClusterNameLoaded,
originalNamespace, dataCenter));
Expand Down
54 changes: 54 additions & 0 deletions ...n/java/com/ctrip/framework/apollo/configservice/service/config/AbstractConfigService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,17 @@
import com.ctrip.framework.apollo.core.ConfigConsts;
import com.ctrip.framework.apollo.core.dto.ApolloNotificationMessages;

import com.ctrip.framework.apollo.core.dto.ConfigurationChange;
import com.ctrip.framework.apollo.core.enums.ConfigurationChangeType;
import com.google.common.base.Strings;

import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
* @author Jason Song([email protected])
Expand Down Expand Up @@ -93,6 +101,52 @@ private Release findRelease(String clientAppId, String clientIp, String clientLa
return release;
}

public List<ConfigurationChange> calcConfigurationChanges(
Map<String, String> latestReleaseConfigurations, Map<String, String> historyConfigurations) {
if (latestReleaseConfigurations == null) {
latestReleaseConfigurations = new HashMap<>();
}

if (historyConfigurations == null) {
historyConfigurations = new HashMap<>();
}

Set<String> previousKeys = historyConfigurations.keySet();
Set<String> currentKeys = latestReleaseConfigurations.keySet();

Set<String> commonKeys = Sets.intersection(previousKeys, currentKeys);
Set<String> newKeys = Sets.difference(currentKeys, commonKeys);
Set<String> removedKeys = Sets.difference(previousKeys, commonKeys);

List<ConfigurationChange> changes = Lists.newArrayList();

for (String newKey : newKeys) {
changes.add(new ConfigurationChange(newKey, latestReleaseConfigurations.get(newKey),
ConfigurationChangeType.ADDED));
}

for (String removedKey : removedKeys) {
changes.add(new ConfigurationChange(removedKey, null, ConfigurationChangeType.DELETED));
}

for (String commonKey : commonKeys) {
String previousValue = historyConfigurations.get(commonKey);
String currentValue = latestReleaseConfigurations.get(commonKey);
if (com.google.common.base.Objects.equal(previousValue, currentValue)) {
continue;
}
changes.add(
new ConfigurationChange(commonKey, currentValue, ConfigurationChangeType.MODIFIED));
}

return changes;
}

@Override
public Map<String, Release> findReleasesByReleaseKeys(Set<String> releaseKeys){
return null;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Implement or document the null return behavior.

The current implementation returns null without explanation, which could lead to NullPointerException in calling code. Consider:

  1. Implementing the method with proper functionality
  2. Or, if null return is intentional, document why using JavaDoc
  3. Or, if this is an abstract method, make it abstract to force implementation in subclasses

Example improvement:

@Override
public Map<String, Release> findReleasesByReleaseKeys(Set<String> releaseKeys) {
    // Option 1: Implement the method
    throw new UnsupportedOperationException("Not implemented in abstract class");
    
    // Option 2: If null is intentional, document why
    /**
     * {@inheritDoc}
     * @return null as this base implementation doesn't support release key lookup
     */
    return null;
    
    // Option 3: Make it abstract
    // public abstract Map<String, Release> findReleasesByReleaseKeys(Set<String> releaseKeys);
}


/**
* Find active release by id
*/
Expand Down
2 changes: 1 addition & 1 deletion .../src/main/java/com/ctrip/framework/apollo/configservice/service/config/ConfigService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* @author Jason Song([email protected])
*/
public interface ConfigService extends ReleaseMessageListener {
public interface ConfigService extends ReleaseMessageListener, IncrementalSyncConfigService {

/**
* Load config
Expand Down
4 changes: 2 additions & 2 deletions .../java/com/ctrip/framework/apollo/configservice/service/config/ConfigServiceWithCache.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ public class ConfigServiceWithCache extends AbstractConfigService {
private static final String TRACER_EVENT_CACHE_GET = "ConfigCache.Get";
private static final String TRACER_EVENT_CACHE_GET_ID = "ConfigCache.GetById";

private final ReleaseService releaseService;
protected final ReleaseService releaseService;
private final ReleaseMessageService releaseMessageService;
private final BizConfig bizConfig;
protected final BizConfig bizConfig;
private final MeterRegistry meterRegistry;

private LoadingCache<String, ConfigCacheEntry> configCache;
Expand Down
Loading
Loading