-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: dispatch OPTIONS requests (#10011)
- Loading branch information
Showing
10 changed files
with
397 additions
and
10 deletions.
There are no files selected for viewing
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
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
127 changes: 127 additions & 0 deletions
127
...ck/src/main/java/io/micronaut/http/server/tck/tests/filter/options/OptionsFilterTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /* | ||
| * Copyright 2017-2023 original authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.micronaut.http.server.tck.tests.filter.options; | ||
|
|
||
| import io.micronaut.context.annotation.Requires; | ||
| import io.micronaut.core.util.StringUtils; | ||
| import io.micronaut.http.HttpHeaders; | ||
| import io.micronaut.http.HttpMethod; | ||
| import io.micronaut.http.HttpRequest; | ||
| import io.micronaut.http.HttpStatus; | ||
| import io.micronaut.http.annotation.*; | ||
| import io.micronaut.http.tck.AssertionUtils; | ||
| import io.micronaut.http.tck.HttpResponseAssertion; | ||
| import io.micronaut.http.tck.ServerUnderTest; | ||
| import io.micronaut.http.tck.TestScenario; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.function.BiConsumer; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.*; | ||
|
|
||
| @SuppressWarnings({ | ||
| "java:S5960", // We're allowed assertions, as these are used in tests only | ||
| "checkstyle:MissingJavadocType", | ||
| "checkstyle:DesignForExtension" | ||
| }) | ||
| public class OptionsFilterTest { | ||
| private static final String SPEC_NAME = "OptionsFilterTest"; | ||
|
|
||
| @Test | ||
| public void optionsByDefaultResponds405() throws IOException { | ||
| TestScenario.builder() | ||
| .specName(SPEC_NAME) | ||
| .request(HttpRequest.OPTIONS("/foo/bar")) | ||
| .assertion(AssertionUtils.assertThrowsStatus(HttpStatus.METHOD_NOT_ALLOWED)) | ||
| .run(); | ||
| } | ||
|
|
||
| @Test | ||
| public void getTest() throws IOException { | ||
| assertion(HttpRequest.GET("/foo/bar"), | ||
| (server, request) -> | ||
| AssertionUtils.assertDoesNotThrow(server, request, HttpResponseAssertion.builder() | ||
| .status(HttpStatus.OK) | ||
| .build())); | ||
| } | ||
|
|
||
| @Test | ||
| public void optionsRoute() throws IOException { | ||
| assertion(HttpRequest.OPTIONS("/options/route"), | ||
| (server, request) -> | ||
| AssertionUtils.assertThrows(server, request, HttpResponseAssertion.builder() | ||
| .status(HttpStatus.I_AM_A_TEAPOT) | ||
| .build())); | ||
| } | ||
|
|
||
| @Test | ||
| public void postTest() throws IOException { | ||
| assertion(HttpRequest.POST("/foo/bar", Collections.emptyMap()), | ||
| (server, request) -> | ||
| AssertionUtils.assertDoesNotThrow(server, request, HttpResponseAssertion.builder() | ||
| .status(HttpStatus.CREATED) | ||
| .build())); | ||
| } | ||
|
|
||
| @Test | ||
| public void optionsTest() throws IOException { | ||
| assertion(HttpRequest.OPTIONS("/foo/bar"), | ||
| (server, request) -> | ||
| AssertionUtils.assertDoesNotThrow(server, request, HttpResponseAssertion.builder() | ||
| .status(HttpStatus.OK) | ||
| .assertResponse(httpResponse -> { | ||
| assertNotNull(httpResponse.getHeaders().get(HttpHeaders.ALLOW)); | ||
| assertNotNull(httpResponse.getHeaders().getAll(HttpHeaders.ALLOW)); | ||
| assertEquals(4, httpResponse.getHeaders().getAll(HttpHeaders.ALLOW).size()); | ||
| assertTrue(httpResponse.getHeaders().getAll(HttpHeaders.ALLOW).stream().anyMatch(v -> v.equals(HttpMethod.GET.toString()))); | ||
| assertTrue(httpResponse.getHeaders().getAll(HttpHeaders.ALLOW).stream().anyMatch(v -> v.equals(HttpMethod.POST.toString()))); | ||
| assertTrue(httpResponse.getHeaders().getAll(HttpHeaders.ALLOW).stream().anyMatch(v -> v.equals(HttpMethod.OPTIONS.toString()))); | ||
| assertTrue(httpResponse.getHeaders().getAll(HttpHeaders.ALLOW).stream().anyMatch(v -> v.equals(HttpMethod.HEAD.toString()))); | ||
| }) | ||
| .build())); | ||
| } | ||
|
|
||
| private static void assertion(HttpRequest<?> request, BiConsumer<ServerUnderTest, HttpRequest<?>> assertion) throws IOException { | ||
| TestScenario.builder() | ||
| .specName(SPEC_NAME) | ||
| .configuration(Collections.singletonMap("micronaut.server.dispatch-options-requests", StringUtils.TRUE)) | ||
| .request(request) | ||
| .assertion(assertion) | ||
| .run(); | ||
| } | ||
|
|
||
| @Controller | ||
| @Requires(property = "spec.name", value = SPEC_NAME) | ||
| public static class MyController { | ||
| @Get("/foo/{id}") | ||
| @Status(HttpStatus.OK) | ||
| public void fooGet(String id) { | ||
| } | ||
|
|
||
| @Post("/foo/{id}") | ||
| @Status(HttpStatus.CREATED) | ||
| public void fooPost(String id) { | ||
| } | ||
|
|
||
| @Options("/options/route") | ||
| @Status(HttpStatus.I_AM_A_TEAPOT) | ||
| public void optionsRoute() { | ||
| } | ||
|
|
||
| } | ||
| } |
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
93 changes: 93 additions & 0 deletions
93
http-server/src/main/java/io/micronaut/http/server/OptionsFilter.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| /* | ||
| * Copyright 2017-2023 original authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.micronaut.http.server; | ||
|
|
||
| import io.micronaut.context.annotation.Requires; | ||
| import io.micronaut.core.annotation.Internal; | ||
| import io.micronaut.core.annotation.Nullable; | ||
| import io.micronaut.core.order.Ordered; | ||
| import io.micronaut.core.util.StringUtils; | ||
| import io.micronaut.http.*; | ||
| import io.micronaut.http.annotation.RequestFilter; | ||
| import io.micronaut.http.annotation.ServerFilter; | ||
| import io.micronaut.http.server.cors.CorsUtil; | ||
| import io.micronaut.web.router.Router; | ||
| import io.micronaut.web.router.UriRouteMatch; | ||
| import io.micronaut.web.router.RouteMatch; | ||
|
|
||
| import static io.micronaut.http.annotation.Filter.MATCH_ALL_PATTERN; | ||
| import static io.micronaut.http.server.cors.CorsFilter.CORS_FILTER_ORDER; | ||
|
|
||
| /** | ||
| * This Filter intercepts HTTP OPTIONS requests which are not CORS Preflight requests. | ||
| * It responds with a NO_CONTENT(204) response, and it populates the Allow HTTP Header with the supported HTTP methods for the request URI. | ||
| * @author Sergio del Amo | ||
| * @since 4.2.0 | ||
| */ | ||
| @Requires(property = OptionsFilter.PREFIX, value = StringUtils.TRUE, defaultValue = StringUtils.FALSE) | ||
| @ServerFilter(MATCH_ALL_PATTERN) | ||
| @Internal | ||
| public final class OptionsFilter implements Ordered { | ||
|
|
||
| @SuppressWarnings("WeakerAccess") | ||
| public static final String PREFIX = HttpServerConfiguration.PREFIX + ".dispatch-options-requests"; | ||
|
|
||
| private final Router router; | ||
|
|
||
| /** | ||
| * | ||
| * @param router Router | ||
| */ | ||
| public OptionsFilter(Router router) { | ||
| this.router = router; | ||
| } | ||
|
|
||
| @RequestFilter | ||
| @Nullable | ||
| @Internal | ||
| public HttpResponse<?> filterRequest(HttpRequest<?> request) { | ||
| if (request.getMethod() != HttpMethod.OPTIONS) { | ||
| return null; // proceed | ||
| } | ||
| if (CorsUtil.isPreflightRequest(request)) { | ||
| return null; // proceed | ||
| } | ||
| if (hasOptionsRouteMatch(request)) { | ||
| return null; // proceed | ||
| } | ||
| MutableHttpResponse<?> mutableHttpResponse = HttpResponse.status(HttpStatus.OK); | ||
| router.findAny(request.getUri().toString(), request) | ||
| .map(UriRouteMatch::getHttpMethod) | ||
| .map(HttpMethod::toString) | ||
| .forEach(allow -> mutableHttpResponse.header(HttpHeaders.ALLOW, allow)); | ||
| mutableHttpResponse.header(HttpHeaders.ALLOW, HttpMethod.OPTIONS.toString()); | ||
| return mutableHttpResponse; | ||
| } | ||
|
|
||
| private boolean hasOptionsRouteMatch(HttpRequest<?> request) { | ||
| return request.getAttribute(HttpAttributes.ROUTE_MATCH, RouteMatch.class).map(routeMatch -> { | ||
| if (routeMatch instanceof UriRouteMatch<?, ?> uriRouteMatch) { | ||
| return uriRouteMatch.getHttpMethod() == HttpMethod.OPTIONS; | ||
| } | ||
| return true; | ||
| }).orElse(false); | ||
| } | ||
|
|
||
| @Override | ||
| public int getOrder() { | ||
| return CORS_FILTER_ORDER + 10; | ||
| } | ||
| } |
Oops, something went wrong.