Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Handle WebServerNamespace in CachingOperationInvoker

Browse Source 
Fixes gh-28882
This commit is contained in:
Madhura Bhave
2021-12-16 16:43:58 -08:00
parent d9d161cd6b
commit 4cc8012bfa
5 changed files with 105 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InvocationContext.java
View File

@@ -98,7 +98,6 @@ public class InvocationContext {
@Deprecated
public org.springframework.boot.actuate.endpoint.http.ApiVersion getApiVersion() {
ApiVersion version = resolveArgument(ApiVersion.class);
System.out.println(version);
return (version != null) ? org.springframework.boot.actuate.endpoint.http.ApiVersion.valueOf(version.name())
: org.springframework.boot.actuate.endpoint.http.ApiVersion.LATEST;
}

41
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/invoker/cache/CachingOperationInvoker.java vendored
View File

@@ -18,6 +18,7 @@ package org.springframework.boot.actuate.endpoint.invoker.cache;
import java.security.Principal;
import java.time.Duration;
import java.util.Arrays;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
@@ -28,7 +29,11 @@ import reactor.core.publisher.Mono;
import org.springframework.boot.actuate.endpoint.ApiVersion;
import org.springframework.boot.actuate.endpoint.InvocationContext;
import org.springframework.boot.actuate.endpoint.SecurityContext;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvoker;
import org.springframework.boot.actuate.endpoint.invoke.OperationParameter;
import org.springframework.boot.actuate.endpoint.invoke.OperationParameters;
import org.springframework.boot.actuate.endpoint.web.WebServerNamespace;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.ConcurrentReferenceHashMap;
@@ -85,9 +90,7 @@ public class CachingOperationInvoker implements OperationInvoker {
if (this.cachedResponses.size() > CACHE_CLEANUP_THRESHOLD) {
cleanExpiredCachedResponses(accessTime);
}
ApiVersion contextApiVersion = context.resolveArgument(ApiVersion.class);
Principal principal = context.resolveArgument(Principal.class);
CacheKey cacheKey = new CacheKey(contextApiVersion, principal);
CacheKey cacheKey = getCacheKey(context);
CachedResponse cached = this.cachedResponses.get(cacheKey);
if (cached == null || cached.isStale(accessTime, this.timeToLive)) {
Object response = this.invoker.invoke(context);
@@ -97,6 +100,13 @@ public class CachingOperationInvoker implements OperationInvoker {
return cached.getResponse();
}
private CacheKey getCacheKey(InvocationContext context) {
ApiVersion contextApiVersion = context.resolveArgument(ApiVersion.class);
Principal principal = context.resolveArgument(Principal.class);
WebServerNamespace serverNamespace = context.resolveArgument(WebServerNamespace.class);
return new CacheKey(contextApiVersion, principal, serverNamespace);
}
private void cleanExpiredCachedResponses(long accessTime) {
try {
Iterator<Entry<CacheKey, CachedResponse>> iterator = this.cachedResponses.entrySet().iterator();
@@ -126,6 +136,15 @@ public class CachingOperationInvoker implements OperationInvoker {
return new CachedResponse(response, accessTime);
}
static boolean isApplicable(OperationParameters parameters) {
for (OperationParameter parameter : parameters) {
if (parameter.isMandatory() && !CacheKey.containsType(parameter.getType())) {
return false;
}
}
return true;
}
/**
* A cached response that encapsulates the response itself and the time at which it
* was created.
@@ -174,13 +193,23 @@ public class CachingOperationInvoker implements OperationInvoker {
private static final class CacheKey {
public static final Class<?>[] CACHEABLE_TYPES = new Class[] { ApiVersion.class, SecurityContext.class,
WebServerNamespace.class };
private final ApiVersion apiVersion;
private final Principal principal;
private CacheKey(ApiVersion apiVersion, Principal principal) {
private final WebServerNamespace serverNamespace;
private CacheKey(ApiVersion apiVersion, Principal principal, WebServerNamespace serverNamespace) {
this.principal = principal;
this.apiVersion = apiVersion;
this.serverNamespace = serverNamespace;
}
public static boolean containsType(Class<?> type) {
return Arrays.stream(CacheKey.CACHEABLE_TYPES).anyMatch((c) -> c.isAssignableFrom(type));
}
@Override
@@ -193,7 +222,8 @@ public class CachingOperationInvoker implements OperationInvoker {
}
CacheKey other = (CacheKey) obj;
return this.apiVersion.equals(other.apiVersion)
&& ObjectUtils.nullSafeEquals(this.principal, other.principal);
&& ObjectUtils.nullSafeEquals(this.principal, other.principal)
&& ObjectUtils.nullSafeEquals(this.serverNamespace, other.serverNamespace);
}
@Override
@@ -202,6 +232,7 @@ public class CachingOperationInvoker implements OperationInvoker {
int result = 1;
result = prime * result + this.apiVersion.hashCode();
result = prime * result + ObjectUtils.nullSafeHashCode(this.principal);
result = prime * result + ObjectUtils.nullSafeHashCode(this.serverNamespace);
return result;
}

15
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/invoker/cache/CachingOperationInvokerAdvisor.java vendored
View File

@@ -18,13 +18,10 @@ package org.springframework.boot.actuate.endpoint.invoker.cache;
import java.util.function.Function;
import org.springframework.boot.actuate.endpoint.ApiVersion;
import org.springframework.boot.actuate.endpoint.EndpointId;
import org.springframework.boot.actuate.endpoint.OperationType;
import org.springframework.boot.actuate.endpoint.SecurityContext;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvoker;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvokerAdvisor;
import org.springframework.boot.actuate.endpoint.invoke.OperationParameter;
import org.springframework.boot.actuate.endpoint.invoke.OperationParameters;
/**
@@ -44,7 +41,7 @@ public class CachingOperationInvokerAdvisor implements OperationInvokerAdvisor {
@Override
public OperationInvoker apply(EndpointId endpointId, OperationType operationType, OperationParameters parameters,
OperationInvoker invoker) {
if (operationType == OperationType.READ && !hasMandatoryParameter(parameters)) {
if (operationType == OperationType.READ && CachingOperationInvoker.isApplicable(parameters)) {
Long timeToLive = this.endpointIdTimeToLive.apply(endpointId);
if (timeToLive != null && timeToLive > 0) {
return new CachingOperationInvoker(invoker, timeToLive);
@@ -53,14 +50,4 @@ public class CachingOperationInvokerAdvisor implements OperationInvokerAdvisor {
return invoker;
}
private boolean hasMandatoryParameter(OperationParameters parameters) {
for (OperationParameter parameter : parameters) {
if (parameter.isMandatory() && !ApiVersion.class.isAssignableFrom(parameter.getType())
&& !SecurityContext.class.isAssignableFrom(parameter.getType())) {
return true;
}
}
return false;
}
}