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

Jump to bottom

Handle ApiVersion in CachingOperationInvoker #18961

Closed
wants to merge 1 commit into from
Closed

Handle ApiVersion in CachingOperationInvoker #18961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 7 additions & 3 deletions ...java/org/springframework/boot/actuate/endpoint/invoker/cache/CachingOperationInvoker.java
View file
Open in desktop
Expand Up @@ -19,11 +19,13 @@
import java.time.Duration;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;

import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

import org.springframework.boot.actuate.endpoint.InvocationContext;
import org.springframework.boot.actuate.endpoint.http.ApiVersion;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvoker;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
Expand All @@ -46,7 +48,7 @@ public class CachingOperationInvoker implements OperationInvoker {

private final long timeToLive;

private volatile CachedResponse cachedResponse;
private final Map<ApiVersion, CachedResponse> cachedResponses;

/**
* Create a new instance with the target {@link OperationInvoker} to use to compute
Expand All @@ -58,6 +60,7 @@ public class CachingOperationInvoker implements OperationInvoker {
Assert.isTrue(timeToLive > 0, "TimeToLive must be strictly positive");
this.invoker = invoker;
this.timeToLive = timeToLive;
this.cachedResponses = new ConcurrentHashMap<>();
}

/**
Expand All @@ -74,11 +77,12 @@ public Object invoke(InvocationContext context) {
return this.invoker.invoke(context);
}
long accessTime = System.currentTimeMillis();
CachedResponse cached = this.cachedResponse;
ApiVersion contextApiVersion = context.getApiVersion();
CachedResponse cached = this.cachedResponses.get(contextApiVersion);
if (cached == null || cached.isStale(accessTime, this.timeToLive)) {
Object response = this.invoker.invoke(context);
cached = createCachedResponse(response, accessTime);
this.cachedResponse = cached;
this.cachedResponses.put(contextApiVersion, cached);
}
return cached.getResponse();
}
Expand Down
4 changes: 3 additions & 1 deletion ...g/springframework/boot/actuate/endpoint/invoker/cache/CachingOperationInvokerAdvisor.java
View file
Open in desktop
Expand Up @@ -21,6 +21,7 @@
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.http.ApiVersion;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvoker;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvokerAdvisor;
import org.springframework.boot.actuate.endpoint.invoke.OperationParameter;
Expand Down Expand Up @@ -54,7 +55,8 @@ public OperationInvoker apply(EndpointId endpointId, OperationType operationType

private boolean hasMandatoryParameter(OperationParameters parameters) {
for (OperationParameter parameter : parameters) {
if (parameter.isMandatory() && !SecurityContext.class.isAssignableFrom(parameter.getType())) {
if (parameter.isMandatory() && !ApiVersion.class.isAssignableFrom(parameter.getType())
&& !SecurityContext.class.isAssignableFrom(parameter.getType())) {
return true;
}
}
Expand Down
12 changes: 12 additions & 0 deletions ...ingframework/boot/actuate/endpoint/invoker/cache/CachingOperationInvokerAdvisorTests.java
View file
Open in desktop
Expand Up @@ -27,6 +27,7 @@
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.http.ApiVersion;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvoker;
import org.springframework.boot.actuate.endpoint.invoke.OperationParameters;
import org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod;
Expand Down Expand Up @@ -117,6 +118,13 @@ void applyWithSecurityContextShouldAddAdvise() {
assertAdviseIsApplied(parameters);
}

@Test
void applyWithApiVersionShouldAddAdvise() {
OperationParameters parameters = getParameters("getWithApiVersion", ApiVersion.class, String.class);
given(this.timeToLive.apply(any())).willReturn(100L);
assertAdviseIsApplied(parameters);
}

private void assertAdviseIsApplied(OperationParameters parameters) {
OperationInvoker advised = this.advisor.apply(EndpointId.of("foo"), OperationType.READ, parameters,
this.invoker);
Expand Down Expand Up @@ -152,6 +160,10 @@ String getWithSecurityContext(SecurityContext securityContext, @Nullable String
return "";
}

String getWithApiVersion(ApiVersion apiVersion, @Nullable String bar) {
return "";
}

}

}
21 changes: 21 additions & 0 deletions ...org/springframework/boot/actuate/endpoint/invoker/cache/CachingOperationInvokerTests.java
View file
Open in desktop
Expand Up @@ -28,6 +28,7 @@

import org.springframework.boot.actuate.endpoint.InvocationContext;
import org.springframework.boot.actuate.endpoint.SecurityContext;
import org.springframework.boot.actuate.endpoint.http.ApiVersion;
import org.springframework.boot.actuate.endpoint.invoke.MissingParametersException;
import org.springframework.boot.actuate.endpoint.invoke.OperationInvoker;

Expand Down Expand Up @@ -152,6 +153,26 @@ void targetInvokedWhenCacheExpires() throws InterruptedException {
verify(target, times(2)).invoke(context);
}

@Test
void targetInvokedWithDifferentApiVersion() {
OperationInvoker target = mock(OperationInvoker.class);
Object expectedV2 = new Object();
Object expectedV3 = new Object();
InvocationContext contextV2 = new InvocationContext(ApiVersion.V2, mock(SecurityContext.class),
Collections.emptyMap());
InvocationContext contextV3 = new InvocationContext(ApiVersion.V3, mock(SecurityContext.class),
Collections.emptyMap());
given(target.invoke(contextV2)).willReturn(expectedV2);
given(target.invoke(contextV3)).willReturn(expectedV3);
CachingOperationInvoker invoker = new CachingOperationInvoker(target, 500L);
Object response = invoker.invoke(contextV2);
assertThat(response).isSameAs(expectedV2);
verify(target, times(1)).invoke(contextV2);
Object cachedResponse = invoker.invoke(contextV3);
assertThat(cachedResponse).isNotSameAs(response);
verify(target, times(1)).invoke(contextV3);
}

private static class MonoOperationInvoker implements OperationInvoker {

static int invocations;
Expand Down