Add route-specific CORS configuration for MVC - #4172
Open
celikfatih wants to merge 1 commit into
Open
Conversation
Resolves spring-cloudgh-3302 Signed-off-by: celikfatih <celikfatih@protonmail.com>
celikfatih
force-pushed
the
feature/3302-mvc-cors-support
branch
from
August 21, 2026 13:01
8b6d525 to
1cae098
Compare
ryanjbaxter
reviewed
Aug 21, 2026
| @Bean | ||
| @ConditionalOnMissingBean | ||
| @ConditionalOnProperty(prefix = GatewayMvcProperties.PREFIX, name = "cors.enabled", matchIfMissing = true) | ||
| public CorsFilter corsFilter(GatewayMvcProperties properties) { |
Contributor
There was a problem hiding this comment.
I wonder if we want to be mindful of the filter chain order. By default this will register as LOWEST_PRECEDENCE. If Spring Security is used it would reject any cors request before it even gets to the filter
| public static CorsConfigurationSource build(GatewayMvcProperties properties) { | ||
| UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser()); | ||
|
|
||
| if (!CollectionUtils.isEmpty(properties.getRoutes())) { |
Contributor
There was a problem hiding this comment.
What about routes not created via properties?
| public static String extractPathPattern(RouteProperties route) { | ||
| if (!CollectionUtils.isEmpty(route.getPredicates())) { | ||
| for (PredicateProperties predicate : route.getPredicates()) { | ||
| if ("Path".equalsIgnoreCase(predicate.getName()) && !CollectionUtils.isEmpty(route.getPredicates()) |
Contributor
There was a problem hiding this comment.
!CollectionUtils.isEmpty(route.getPredicates() isn't this checked above?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Resolves gh-3302
What this PR does / why we need it:
Currently, Spring Cloud Gateway MVC lacks the ability to define CORS configurations on a per-route basis via route metadata, a feature that exists in the WebFlux implementation. This PR introduces route-specific CORS configuration support for the MVC module.
How it was implemented:
GatewayCorsConfigurationSourceBuilderto extract CORS configurations from route metadata and construct anUrlBasedCorsConfigurationSource.CorsPerRouteMvcTests) usingHttpbinTestcontainersto verify actual and pre-flight requests, including edge cases like Double CORS mitigation (usingRemoveResponseHeader), wildcard origins (allowedOriginPatterns), and custom headers.Backward Compatibility:
The feature uses
@ConditionalOnProperty(prefix = GatewayMvcProperties.PREFIX + ".cors", name = "enabled", matchIfMissing = true). It acts as a transparent "no-op" unless CORS metadata is explicitly defined on a route, ensuring zero disruption to existing applications while providing a global kill-switch if needed.Checklist:
./mvnw spring-javaformat:apply)@authortags