Skip to content

feature: Exclude graphql paths by default #129

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
merged 1 commit into from
Aug 27, 2024
Merged

feature: Exclude graphql paths by default #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion ...rc/main/java/com/getyourguide/openapi/validation/api/selector/DefaultTrafficSelector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ public class DefaultTrafficSelector implements TrafficSelector {

private final double sampleRate;
private final Set<String> excludedPaths;
private final Set<String> defaultExcludedPaths;
private final List<ExcludedHeader> excludedHeaders;
private final Boolean shouldFailOnRequestViolation;
private final Boolean shouldFailOnResponseViolation;
Expand All @@ -28,6 +29,7 @@ public DefaultTrafficSelector(
Boolean shouldFailOnResponseViolation
) {
this.sampleRate = sampleRate;
this.defaultExcludedPaths = Set.of("/graphql", "/graphiql");
this.excludedPaths = excludedPaths != null ? excludedPaths : Set.of();
this.excludedHeaders = excludedHeaders != null ? excludedHeaders : Collections.emptyList();
this.shouldFailOnRequestViolation = shouldFailOnRequestViolation != null ? shouldFailOnRequestViolation : false;
Expand Down Expand Up @@ -82,7 +84,8 @@ private boolean isRequestExcludedByHeader(RequestMetaData request) {
}

private boolean isRequestExcludedByPath(RequestMetaData request) {
return excludedPaths.contains(request.getUri().getPath());
var path = request.getUri().getPath();
return defaultExcludedPaths.contains(path) || excludedPaths.contains(path);
}

private static boolean methodEquals(String method, String expectedMethod) {
Expand Down
18 changes: 17 additions & 1 deletion ...est/java/com/getyourguide/openapi/validation/api/selector/DefaultTrafficSelectorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,18 @@ public void testIsExcludedByHeaderPattern() {

assertHeaderIsExcluded(true, "x-is-bot", "true");
assertHeaderIsExcluded(false, "x-is-bot", "truebot");
}

@Test
public void testIsExcludedByPath() {
// Default exclusions
assertPathIsExcluded(true, "/graphql");
assertPathIsExcluded(true, "/graphiql");

assertPathIsExcluded(false, "/v1/path");
}

private void assertHeaderIsExcluded(boolean expectedExclusion, String headerName, String headerValue) {

var request = new RequestMetaData(
"GET",
URI.create("https://api.example.com/v1/path"),
Expand All @@ -48,6 +55,15 @@ private void assertHeaderIsExcluded(boolean expectedExclusion, String headerName
assertEquals(!expectedExclusion, trafficSelector.shouldRequestBeValidated(request));
}

private void assertPathIsExcluded(boolean expectedExclusion, String path) {
var request = new RequestMetaData(
"GET",
URI.create("https://api.example.com" + path),
Map.of("Content-Type", "application/json")
);
assertEquals(!expectedExclusion, trafficSelector.shouldRequestBeValidated(request));
}

private Map<String, String> toCaseInsensitiveMap(Map<String, String> map) {
var newMap = new TreeMap<String, String>(String.CASE_INSENSITIVE_ORDER);
newMap.putAll(map);
Expand Down
Loading