-
Notifications
You must be signed in to change notification settings - Fork 312
Guard parsed-body instrumentation from raw Spring HttpMessageConverters #9613
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
93 changes: 93 additions & 0 deletions
93
...vy/datadog/trace/instrumentation/springweb/HttpMessageConverterInstrumentationTest.groovy
This file contains hidden or 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,93 @@ | ||
package datadog.trace.instrumentation.springweb | ||
|
||
import datadog.trace.agent.test.InstrumentationSpecification | ||
import datadog.trace.api.gateway.Flow | ||
import datadog.trace.api.gateway.RequestContext | ||
import datadog.trace.api.gateway.RequestContextSlot | ||
import datadog.trace.bootstrap.instrumentation.api.AgentTracer | ||
import datadog.trace.bootstrap.instrumentation.api.TagContext | ||
import org.springframework.http.MediaType | ||
import org.springframework.http.converter.ByteArrayHttpMessageConverter | ||
import org.springframework.http.converter.FormHttpMessageConverter | ||
import org.springframework.http.converter.StringHttpMessageConverter | ||
import org.springframework.mock.http.MockHttpInputMessage | ||
import org.springframework.util.MultiValueMap | ||
|
||
import java.nio.charset.StandardCharsets | ||
import java.util.function.BiFunction | ||
|
||
import static datadog.trace.api.gateway.Events.EVENTS | ||
|
||
class HttpMessageConverterInstrumentationTest extends InstrumentationSpecification { | ||
|
||
def scope | ||
def ss = AgentTracer.get().getSubscriptionService(RequestContextSlot.APPSEC) | ||
List<Object> publishedBodies = [] | ||
|
||
def setup() { | ||
publishedBodies.clear() | ||
TagContext ctx = new TagContext().withRequestContextDataAppSec(new Object()) | ||
def span = AgentTracer.startSpan('test-span', ctx) | ||
scope = AgentTracer.activateSpan(span) | ||
|
||
ss.registerCallback(EVENTS.requestBodyProcessed(), { RequestContext reqCtx, Object body -> | ||
publishedBodies << body | ||
Flow.ResultFlow.empty() | ||
} as BiFunction<RequestContext, Object, Flow<Void>>) | ||
} | ||
|
||
def cleanup() { | ||
ss.reset() | ||
scope?.close() | ||
} | ||
|
||
void 'string http message converter does not publish parsed body event'() { | ||
given: | ||
def converter = new StringHttpMessageConverter() | ||
def raw = '{"value":"example"}' | ||
def message = new MockHttpInputMessage(raw.getBytes(StandardCharsets.UTF_8)) | ||
message.headers.contentType = MediaType.APPLICATION_JSON | ||
|
||
when: | ||
def result = converter.read(String, message) | ||
|
||
then: | ||
result == raw | ||
publishedBodies.isEmpty() | ||
} | ||
|
||
void 'byte array http message converter does not publish parsed body event'() { | ||
given: | ||
def converter = new ByteArrayHttpMessageConverter() | ||
def raw = '{"value":"bytes"}'.getBytes(StandardCharsets.UTF_8) | ||
def message = new MockHttpInputMessage(raw) | ||
message.headers.contentType = MediaType.APPLICATION_JSON | ||
|
||
when: | ||
def result = converter.read(byte[].class, message) | ||
|
||
then: | ||
Arrays.equals(result, raw) | ||
publishedBodies.isEmpty() | ||
} | ||
|
||
void 'form converter continues to publish parsed body event'() { | ||
given: | ||
def converter = new FormHttpMessageConverter() | ||
def raw = 'value=object&another=value2' | ||
def message = new MockHttpInputMessage(raw.getBytes(StandardCharsets.UTF_8)) | ||
message.headers.contentType = MediaType.APPLICATION_FORM_URLENCODED | ||
|
||
when: | ||
def result = converter.read(MultiValueMap, message) | ||
|
||
then: | ||
result instanceof MultiValueMap | ||
result.getFirst('value') == 'object' | ||
result.getFirst('another') == 'value2' | ||
publishedBodies.size() == 1 | ||
def published = publishedBodies[0] as MultiValueMap | ||
published.getFirst('value') == 'object' | ||
published.getFirst('another') == 'value2' | ||
} | ||
} |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
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.
I'll rather drop a
TODO
here saying that those are candidates to being deserialized before being set to the WAF once we implement that feature.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.
Maybe it's useful also to try to list all possible types that this method receives, in case we need to add others for the block list.
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.
Thanks for the advise Manu, I improved the comment