Introduce AppSec::Instrumentation::Gateway::Argument #2648
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
github-actions
bot
added
appsec
ivoanjo
reviewed
Feb 24, 2023
GustavoCaso
force-pushed
the
appsec-add-gateway-result-object
branch
4 times, most recently
from
9b9987d
to
da2e304
Compare
- Replace contrib Rack::Request and Rack::Response with Gateway::Request and Gateway::Response
GustavoCaso
force-pushed
the
appsec-add-gateway-result-object
branch
from
da2e304
to
c8a200f
Compare
GustavoCaso
changed the title
GustavoCaso
force-pushed
the
appsec-add-gateway-result-object
branch
from
9a64baa
to
f55473c
Compare
lloeki
approved these changes
Feb 27, 2023
| module Rails | ||
| module Gateway | ||
| # Gateway Request argument. Normalized extration of data from ActionDispatch::Request | ||
| class Request < Instrumentation::Gateway::Argument |
There was a problem hiding this comment.
Would it make sense to inherit from Contrib::Rack::Gateway::Request?
There was a problem hiding this comment.
At first, I thought about, but since I saw we use the Rack::RequestBody directly in the Sinatra contrib folder I thought it would be ok.
I'm happy to change it.
GustavoCaso
force-pushed
the
appsec-add-gateway-result-object
branch
2 times, most recently
from
20abc18
to
9043bcd
Compare
Codecov Report
@@ Coverage Diff @@
## master #2648 +/- ##
==========================================
- Coverage 98.08% 98.08% -0.01%
==========================================
Files 1160 1166 +6
Lines 63676 63832 +156
Branches 2849 2849
==========================================
+ Hits 62457 62608 +151
- Misses 1219 1224 +5
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Merged
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.
This PR introduces
AppSec::Instrumentation::Gateway::Argumentclass.This class is the expected object to be provided when passing information to
Gateway#pushEach contrib integration can define their own
Argumentobjects. The idea is to encapsulate all the logic regarding argument handling inside those classes. This helps with encapsulation and ease of testing each argument individually.For now, the parent class
AppSec::Instrumentation::Gateway::Argumenthas no method defined, as there isn't any shared logic among the types of arguments. This could change in the future.The different classes added in this PR are:
Datadog::AppSec::Instrumentation::Gateway::UserDatadog::AppSec::Contrib::Rack::Gateway::RequestDatadog::AppSec::Contrib::Rack::Gateway::ResponseDatadog::AppSec::Contrib::Sinatra::Gateway::RequestDatadog::AppSec::Contrib::Sinatra::Gateway::RouteParamsDatadog::AppSec::Contrib::Rails::Gateway::RequestAppSec::Instrumentation::Gateway::Useris a particular case since it is framework agnostic and currently is only used inkit/identity.rbFor that reason, the definition of the class is inside
lib/datadog/appsec/instrumentation/gateway/argument.rband not in anycontribfolder.