Bdog 1512 truncate update #142
Merged
Conversation
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
…eserve backward compatibile auditing behaviour
This will help if we support an 'omitRequest/ResponseBodyInAudit' functionality. Also send ResponseData rather than reuse HttpResponse, which ensures we only provide a String (truncated) body rather than a Source.
…o respect auditing enabled)
colin-lamed
force-pushed
the
BDOG-1512-truncate_update
branch
from
35f318b
to
9132c8d
Compare
colin-lamed
commented
Mar 31, 2022
| responseF = auditedResponseF | ||
| ) | ||
| ) | ||
|
|
||
| hookDataF.onComplete { | ||
| case Success(hookData) => executeHooksWithHookData(hookData) | ||
| case Failure(e) => // this is unlikely, but we want best attempt at auditing | ||
| executeHooksWithHookData(None) | ||
| executeHooksWithHookData(Body.Omitted) |
There was a problem hiding this comment.
This is the only place we use Omitted currently. The intention of Omitted is if clients decide there's no reason to include the payload in audits. Should we add an Unavailable state to distinguish? Or is Body.Partial(None) sufficient?
There was a problem hiding this comment.
👍 I'm generally in favour of enumerating as many of these states as we can think of. Consumers are free to map them to a smaller set of states if they're not valuable to them.
tomwadeson
previously approved these changes
Apr 1, 2022
colin-lamed
force-pushed
the
BDOG-1512-truncate_update
branch
from
a0e29cf
to
4429996
Compare
tomwadeson
previously approved these changes
Apr 19, 2022
tomwadeson
approved these changes
Apr 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Introduces
Bodyto wrap the request/response payloads for auditing. This allows us to identify when the payload has been truncated. It also introduces anOmittedstate in case in the future we want to support excluding request or response payloads in audits.With a change to the Hook data, we require a major version bump - and the changes are reflected in
play-auditingandbootstrap-play. Taken the opportunity to tidy up the rest of the hook data (align request and response)