Skip to content

chore: update how a request handler method is identified #1058

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.

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

Merged
merged 2 commits into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ private LambdaHandlerProcessor() {
}

public static boolean isHandlerMethod(final ProceedingJoinPoint pjp) {
return "handleRequest".equals(pjp.getSignature().getName()) ||
// https://docs.aws.amazon.com/codeguru/latest/profiler-ug/lambda-custom.html
"requestHandler".equals(pjp.getSignature().getName());
return placedOnRequestHandler(pjp) || placedOnStreamHandler(pjp);
}

public static boolean placedOnRequestHandler(final ProceedingJoinPoint pjp) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,45 +1,66 @@
package software.amazon.lambda.powertools.core.internal;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestHandler;
import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.junit.jupiter.api.Test;

import java.io.InputStream;
import java.io.OutputStream;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

class LambdaHandlerProcessorTest {

@Test
void shouldTreatProfilerHandlerMethodAsValid() {
ProceedingJoinPoint pjpMock = mock(ProceedingJoinPoint.class);
Signature signature = mock(Signature.class);
when(signature.getName()).thenReturn("requestHandler");
when(pjpMock.getSignature()).thenReturn(signature);
void isHandlerMethod_shouldRecognizeRequestHandler() {
ProceedingJoinPoint pjpMock = mockRequestHandlerPjp();

assertThat(LambdaHandlerProcessor.isHandlerMethod(pjpMock))
.isTrue();
assertThat(LambdaHandlerProcessor.isHandlerMethod(pjpMock)).isTrue();
}

@Test
void shouldTreatDefaultHandlerMethodAsValid() {
ProceedingJoinPoint pjpMock = mock(ProceedingJoinPoint.class);
Signature signature = mock(Signature.class);
when(signature.getName()).thenReturn("handleRequest");
when(pjpMock.getSignature()).thenReturn(signature);
void isHandlerMethod_shouldRecognizeRequestStreamHandler() {
ProceedingJoinPoint pjpMock = mockRequestStreamHandlerPjp();

assertThat(LambdaHandlerProcessor.isHandlerMethod(pjpMock))
.isTrue();
assertThat(LambdaHandlerProcessor.isHandlerMethod(pjpMock)).isTrue();
}

@Test
void shouldNotTreatOtherMethodNamesAsValidHandlerMethod() {
ProceedingJoinPoint pjpMock = mock(ProceedingJoinPoint.class);
void placedOnRequestHandler_shouldRecognizeRequestHandler() {
ProceedingJoinPoint pjpMock = mockRequestHandlerPjp();

assertThat(LambdaHandlerProcessor.placedOnRequestHandler(pjpMock)).isTrue();
}

@Test
void placedOnStreamHandler_shouldRecognizeRequestStreamHandler() {
ProceedingJoinPoint pjpMock = mockRequestStreamHandlerPjp();

assertThat(LambdaHandlerProcessor.placedOnStreamHandler(pjpMock)).isTrue();
}

private static ProceedingJoinPoint mockRequestHandlerPjp() {
Signature signature = mock(Signature.class);
when(signature.getName()).thenReturn("handleRequestInvalid");
when(signature.getDeclaringType()).thenReturn(RequestHandler.class);
ProceedingJoinPoint pjpMock = mock(ProceedingJoinPoint.class);
Object[] args = {new Object(), mock(Context.class)};
when(pjpMock.getArgs()).thenReturn(args);
when(pjpMock.getSignature()).thenReturn(signature);
return pjpMock;
}

assertThat(LambdaHandlerProcessor.isHandlerMethod(pjpMock))
.isFalse();
private static ProceedingJoinPoint mockRequestStreamHandlerPjp() {
Signature signature = mock(Signature.class);
when(signature.getDeclaringType()).thenReturn(RequestStreamHandler.class);
ProceedingJoinPoint pjpMock = mock(ProceedingJoinPoint.class);
Object[] args = {mock(InputStream.class), mock(OutputStream.class), mock(Context.class)};
when(pjpMock.getArgs()).thenReturn(args);
when(pjpMock.getSignature()).thenReturn(signature);
return pjpMock;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isHandlerMethod;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnRequestHandler;

/**
Expand Down Expand Up @@ -58,7 +57,7 @@ public Object around(ProceedingJoinPoint pjp,
throw new IdempotencyConfigurationException("The annotated method doesn't return anything. Unable to perform idempotency on void return type");
}

boolean isHandler = (isHandlerMethod(pjp) && placedOnRequestHandler(pjp));
boolean isHandler = placedOnRequestHandler(pjp);
JsonNode payload = getPayload(pjp, method, isHandler);
if (payload == null) {
throw new IdempotencyConfigurationException("Unable to get payload from the method. Ensure there is at least one parameter or that you use @IdempotencyKey");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.extractContext;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isColdStart;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isHandlerMethod;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnRequestHandler;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnStreamHandler;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.serviceName;
import static software.amazon.lambda.powertools.metrics.MetricsUtils.hasDefaultDimension;
import static software.amazon.lambda.powertools.metrics.MetricsUtils.metricsLogger;
Expand All @@ -44,9 +42,7 @@ public Object around(ProceedingJoinPoint pjp,
Metrics metrics) throws Throwable {
Object[] proceedArgs = pjp.getArgs();

if (isHandlerMethod(pjp)
&& (placedOnRequestHandler(pjp)
|| placedOnStreamHandler(pjp))) {
if (isHandlerMethod(pjp)) {

MetricsLogger logger = metricsLogger();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isColdStart;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isHandlerMethod;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isSamLocal;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnRequestHandler;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnStreamHandler;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.serviceName;
import static software.amazon.lambda.powertools.tracing.TracingUtils.objectMapper;

Expand All @@ -48,7 +46,7 @@ public Object around(ProceedingJoinPoint pjp,
() -> "## " + pjp.getSignature().getName()));
segment.setNamespace(namespace(tracing));

if (placedOnHandlerMethod(pjp)) {
if (isHandlerMethod(pjp)) {
segment.putAnnotation("ColdStart", isColdStart());
segment.putAnnotation("Service", namespace(tracing));
}
Expand All @@ -62,7 +60,7 @@ public Object around(ProceedingJoinPoint pjp,
segment.putMetadata(namespace(tracing), pjp.getSignature().getName() + " response", null != objectMapper() ? objectMapper().writeValueAsString(methodReturn): methodReturn);
}

if (placedOnHandlerMethod(pjp)) {
if (isHandlerMethod(pjp)) {
coldStartDone();
}

Expand Down Expand Up @@ -116,11 +114,6 @@ private String namespace(Tracing powerToolsTracing) {
return powerToolsTracing.namespace().isEmpty() ? serviceName() : powerToolsTracing.namespace();
}

private boolean placedOnHandlerMethod(ProceedingJoinPoint pjp) {
return isHandlerMethod(pjp)
&& (placedOnRequestHandler(pjp) || placedOnStreamHandler(pjp));
}

private boolean environmentVariable(String key) {
return Boolean.parseBoolean(SystemWrapper.getenv(key));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@

import static com.networknt.schema.SpecVersion.VersionFlag.V201909;
import static java.nio.charset.StandardCharsets.UTF_8;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.isHandlerMethod;
import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnRequestHandler;
import static software.amazon.lambda.powertools.utilities.jmespath.Base64Function.decode;
import static software.amazon.lambda.powertools.utilities.jmespath.Base64GZipFunction.decompress;
Expand Down Expand Up @@ -55,8 +54,7 @@ public Object around(ProceedingJoinPoint pjp,
ValidationConfig.get().setSchemaVersion(validation.schemaVersion());
}

if (isHandlerMethod(pjp)
&& placedOnRequestHandler(pjp)) {
if (placedOnRequestHandler(pjp)) {
validationNeeded = true;

if (!validation.inboundSchema().isEmpty()) {
Expand Down