feat: Add support for POWERTOOLS_LOGGER_LOG_EVENT #1510
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| /* | ||
| * Copyright 2023 Amazon.com, Inc. or its affiliates. | ||
| * Licensed under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package software.amazon.lambda.powertools.core.internal; | ||
|
|
||
| public final class EnvironmentVariables { | ||
| public static class LOGGER { | ||
| public final static String LOG_EVENT = "POWERTOOLS_LOGGER_LOG_EVENT"; | ||
|
There was a problem hiding this comment. we already have other files containing environment variables, do not introduce a new one please There was a problem hiding this comment. maybe that's something we should clean up in v2 by the way. |
||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,19 +14,6 @@ | |
|
|
||
| package software.amazon.lambda.powertools.logging.internal; | ||
|
|
||
| import com.amazonaws.services.lambda.runtime.Context; | ||
| import com.amazonaws.services.lambda.runtime.RequestHandler; | ||
| import com.amazonaws.services.lambda.runtime.RequestStreamHandler; | ||
|
|
@@ -37,21 +24,6 @@ | |
| import com.amazonaws.services.lambda.runtime.tests.annotations.Event; | ||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import org.apache.logging.log4j.Level; | ||
| import org.apache.logging.log4j.ThreadContext; | ||
| import org.json.JSONException; | ||
|
|
@@ -62,18 +34,32 @@ | |
| import org.mockito.MockedStatic; | ||
| import software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor; | ||
| import software.amazon.lambda.powertools.core.internal.SystemWrapper; | ||
| import software.amazon.lambda.powertools.logging.handlers.*; | ||
|
|
||
| import java.io.*; | ||
| import java.lang.reflect.InvocationTargetException; | ||
| import java.lang.reflect.Method; | ||
| import java.nio.channels.FileChannel; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
| import java.nio.file.StandardOpenOption; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static java.util.Collections.emptyMap; | ||
| import static java.util.Collections.singletonList; | ||
| import static java.util.stream.Collectors.joining; | ||
| import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.fail; | ||
| import static org.mockito.Mockito.mockStatic; | ||
| import static org.mockito.Mockito.when; | ||
| import static org.mockito.MockitoAnnotations.openMocks; | ||
| import static org.skyscreamer.jsonassert.JSONAssert.assertEquals; | ||
| import static software.amazon.lambda.powertools.core.internal.SystemWrapper.getProperty; | ||
| import static software.amazon.lambda.powertools.core.internal.SystemWrapper.getenv; | ||
|
|
||
| class LambdaLoggingAspectTest { | ||
|
|
||
|
|
@@ -89,6 +75,7 @@ void setUp() throws IllegalAccessException, IOException, NoSuchMethodException, | |
| openMocks(this); | ||
| ThreadContext.clearAll(); | ||
| writeStaticField(LambdaHandlerProcessor.class, "IS_COLD_START", null, true); | ||
| writeStaticField(LambdaLoggingAspect.class, "LOG_EVENT", Boolean.TRUE, true); | ||
| setupContext(); | ||
| requestHandler = new PowerLogToolEnabled(); | ||
| requestStreamHandler = new PowerLogToolEnabledForStream(); | ||
|
|
@@ -195,6 +182,23 @@ void shouldLogEventForHandler() throws IOException, JSONException { | |
| assertEquals(expectEvent, event, false); | ||
| } | ||
|
|
||
| /** | ||
| * If POWERTOOLS_LOGGER_LOG_EVENT was set to false, the handler should log anything, despite @Logging(logEvent=true) | ||
|
There was a problem hiding this comment. no, see my other comment There was a problem hiding this comment. python is the ref, not typescript |
||
| * @throws IOException | ||
| */ | ||
| @Test | ||
| void shouldNotLogEventForHandlerWhenEnvVariableSetToFalse() throws IOException, IllegalAccessException { | ||
| writeStaticField(LambdaLoggingAspect.class, "LOG_EVENT", Boolean.FALSE, true); | ||
|
|
||
| requestHandler = new PowerToolLogEventEnabled(); | ||
| S3EventNotification s3EventNotification = s3EventNotification(); | ||
|
|
||
| requestHandler.handleRequest(s3EventNotification, context); | ||
|
|
||
| String s = Files.lines(Paths.get("target/logfile.json")).collect(joining()); | ||
| assertThat(s).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldLogEventForHandlerWithOverriddenObjectMapper() throws IOException, JSONException { | ||
| RequestHandler<S3EventNotification, Object> handler = new PowerToolLogEventEnabledWithCustomMapper(); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -119,6 +119,15 @@ | |
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-surefire-plugin</artifactId> | ||
| <configuration> | ||
| <environmentVariables> | ||
| <POWERTOOLS_LOGGER_LOG_EVENT>true</POWERTOOLS_LOGGER_LOG_EVENT> | ||
| </environmentVariables> | ||
| </configuration> | ||
| </plugin> | ||
| <plugin> | ||
| <groupId>dev.aspectj</groupId> | ||
| <artifactId>aspectj-maven-plugin</artifactId> | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry to say that but can we avoid this reformatting? will be a mess with v2...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No big deal