Skip to content

Log response payload for better troubleshooting #320

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

Merged
sungkkim merged 4 commits into from
Oct 23, 2020
Merged

Log response payload for better troubleshooting #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c27eca7
Merge pull request #1 from aws-cloudformation/master
sungkkim Oct 22, 2020
532eb16
Log full handler response payload
sungkkim Oct 22, 2020
ff61b52
Merge log statements
sungkkim Oct 22, 2020
c1a2c63
Overload writeResponse for backwards compatibility
sungkkim Oct 23, 2020
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
26 changes: 24 additions & 2 deletions src/main/java/software/amazon/cloudformation/AbstractWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ public void processRequest(final InputStream inputStream, final OutputStream out
} finally {
// A response will be output on all paths, though CloudFormation will
// not block on invoking the handlers, but rather listen for callbacks
writeResponse(outputStream, handlerResponse);
writeResponse(outputStream, handlerResponse, request);
publishExceptionCodeAndCountMetrics(request == null ? null : request.getAction(), handlerResponse.getErrorCode());
}
}
Expand Down Expand Up @@ -372,7 +372,9 @@ public void processRequest(final InputStream inputStream, final OutputStream out

}

protected void writeResponse(final OutputStream outputStream, final ProgressEvent<ResourceT, CallbackT> response)
protected void writeResponse(final OutputStream outputStream,
Copy link

@wbingli wbingli Oct 22, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

This seems a break change for the generated code. I would suggest you do following to keep backward compatible. And also update the code generate to use new method. In such way, it won't break old code if still use old plugin, but it just won't have additional logging data.

After updated the plugin tool, it can then benefit with new feature.

protected void writeResponse(final OutputStream outputStream,final ProgressEvent<ResourceT, CallbackT> response) {
 this(outputStream, response, null);
}

final ProgressEvent<ResourceT, CallbackT> response,
final HandlerRequest<ResourceT, CallbackT> request)
throws IOException {
if (response.getResourceModel() != null) {
// strip write only properties on final results, we will need the intact model
Expand All @@ -383,10 +385,21 @@ protected void writeResponse(final OutputStream outputStream, final ProgressEven
}

String output = this.serializer.serialize(response);
if (response.getStatus() != OperationStatus.IN_PROGRESS) {
// if status is not IN_PROGRESS, it means the response has been sanitized
final String logicalResourceId = getLogicalResourceId(request);
final String stackId = getStackId(request);
this.log(String.format("StackId=%s LogicalResourceId=%s Response=%s", stackId, logicalResourceId, output));
}
outputStream.write(output.getBytes(StandardCharsets.UTF_8));
outputStream.flush();
}

protected void writeResponse(final OutputStream outputStream, final ProgressEvent<ResourceT, CallbackT> response)
throws IOException {
this.writeResponse(outputStream, response, null);
}

protected ResourceT sanitizeModel(final ResourceT model) throws IOException {
// strip write only properties on final results, we will need the intact model
// while provisioning
Expand Down Expand Up @@ -570,6 +583,15 @@ protected String getStackId(final HandlerRequest<ResourceT, CallbackT> request)
return null;
}

@VisibleForTesting
protected String getLogicalResourceId(final HandlerRequest<ResourceT, CallbackT> request) {
if (request != null && request.getRequestData() != null) {
return request.getRequestData().getLogicalResourceId();
}

return null;
}

private void replaceInMap(final Map<String, String> targetMap, final Map<String, String> sourceMap) {
if (targetMap == null) {
return;
Expand Down
12 changes: 11 additions & 1 deletion src/test/java/software/amazon/cloudformation/WrapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public void invokeHandler_nullResponse_returnsFailure(final String requestDataPa
}

verify(providerEventsLogger).refreshClient();
verify(providerEventsLogger, times(2)).publishLogEvent(any());
verify(providerEventsLogger, times(3)).publishLogEvent(any());
verifyNoMoreInteractions(providerEventsLogger);

// verify output response
Expand Down Expand Up @@ -1029,4 +1029,14 @@ public void getStackId_setAndGetStackId() {
assertThat(stackId).isNotNull();
assertThat(stackId).isEqualTo("AWSStackId");
}

@Test
public void getLogicalResourceId_setAndGetLogicalResourceId() {
final HandlerRequest<TestModel, TestContext> request = new HandlerRequest<>();
final RequestData<TestModel> requestData = new RequestData<>();
requestData.setLogicalResourceId("MyResource");
request.setRequestData(requestData);

assertThat(wrapper.getLogicalResourceId(request)).isEqualTo("MyResource");
}
}