Skip to content

fix update scoped routes order problem #3900

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix update scoped routes order problem #3900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b223ad
fix update scoped routes order problem
JoeCqupt Aug 28, 2025
db315be
add unit test
JoeCqupt Aug 29, 2025
ea1af81
update
JoeCqupt Aug 29, 2025
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
10 changes: 5 additions & 5 deletions ...c/main/java/org/springframework/cloud/gateway/config/GatewayMetricsAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.metrics.autoconfigure.CompositeMeterRegistryAutoConfiguration;
import org.springframework.boot.metrics.autoconfigure.MetricsAutoConfiguration;
import org.springframework.boot.observation.autoconfigure.ObservationAutoConfiguration;
import org.springframework.boot.tracing.autoconfigure.MicrometerTracingAutoConfiguration;
import org.springframework.boot.tracing.autoconfigure.TracingProperties;
import org.springframework.boot.micrometer.metrics.autoconfigure.CompositeMeterRegistryAutoConfiguration;
import org.springframework.boot.micrometer.metrics.autoconfigure.MetricsAutoConfiguration;
import org.springframework.boot.micrometer.observation.autoconfigure.ObservationAutoConfiguration;
import org.springframework.boot.micrometer.tracing.autoconfigure.MicrometerTracingAutoConfiguration;
import org.springframework.boot.micrometer.tracing.autoconfigure.TracingProperties;
import org.springframework.boot.webflux.autoconfigure.HttpHandlerAutoConfiguration;
import org.springframework.cloud.gateway.filter.GatewayMetricsFilter;
import org.springframework.cloud.gateway.filter.headers.observation.GatewayObservationConvention;
Expand Down
6 changes: 6 additions & 0 deletions ...er-webflux/src/main/java/org/springframework/cloud/gateway/route/CachingRouteLocator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package org.springframework.cloud.gateway.route;

import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
Expand Down Expand Up @@ -88,8 +90,12 @@ public void onApplicationEvent(RefreshRoutesEvent event) {
final Mono<List<Route>> scopedRoutes = fetch(event.getMetadata()).collect(Collectors.toList())
.onErrorResume(s -> Mono.just(List.of()));

Map<String, Long> routeIdToIdxMap = new HashMap<>();
getRoutes().index().subscribe(t -> routeIdToIdxMap.put(t.getT2().getId(), t.getT1()));

scopedRoutes.subscribe(scopedRoutesList -> {
updateCache(Flux.concat(Flux.fromIterable(scopedRoutesList), getNonScopedRoutes(event))
.sort(Comparator.comparing(r -> routeIdToIdxMap.getOrDefault(r.getId(), Long.MIN_VALUE)))
.sort(AnnotationAwareOrderComparator.INSTANCE));
}, this::handleRefreshError);
}
Expand Down
4 changes: 2 additions & 2 deletions ...src/test/java/org/springframework/cloud/gateway/config/GatewayAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.ssl.SslBundleRegistrar;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.metrics.autoconfigure.MetricsAutoConfiguration;
import org.springframework.boot.metrics.autoconfigure.export.simple.SimpleMetricsExportAutoConfiguration;
import org.springframework.boot.micrometer.metrics.autoconfigure.MetricsAutoConfiguration;
import org.springframework.boot.micrometer.metrics.autoconfigure.export.simple.SimpleMetricsExportAutoConfiguration;
import org.springframework.boot.security.autoconfigure.reactive.ReactiveSecurityAutoConfiguration;
import org.springframework.boot.security.oauth2.client.autoconfigure.reactive.ReactiveOAuth2ClientAutoConfiguration;
import org.springframework.boot.ssl.DefaultSslBundleRegistry;
Expand Down
29 changes: 29 additions & 0 deletions ...bflux/src/test/java/org/springframework/cloud/gateway/route/CachingRouteLocatorTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
package org.springframework.cloud.gateway.route;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

Expand Down Expand Up @@ -117,6 +119,23 @@ else if (i == 2) {

}

@Test
public void updateScopedRoutes() {
Map<String, Object> metadata = Map.of("metadata-key1", "metadata-value1");
int order = 0;
Route route1 = route(1, order, Collections.EMPTY_MAP);
Route route2 = route(2, order, metadata);
CachingRouteLocator locator = new CachingRouteLocator(() -> Flux.just(route1, route2));

List<Route> routes = locator.getRoutes().collectList().block();
assertThat(routes).containsExactly(route1, route2);

RefreshRoutesEvent event = new RefreshRoutesEvent(this, metadata);
locator.onApplicationEvent(event);
routes = locator.getRoutes().collectList().block();
assertThat(routes).containsExactly(route1, route2);
}

private void waitUntilRefreshFinished(CachingRouteLocator locator, List<RefreshRoutesResultEvent> resultEvents)
throws InterruptedException {
CountDownLatch cdl = new CountDownLatch(1);
Expand All @@ -129,6 +148,16 @@ private void waitUntilRefreshFinished(CachingRouteLocator locator, List<RefreshR
assertThat(cdl.await(5, TimeUnit.SECONDS)).isTrue();
}

Route route(int id, int order, Map<String, Object> metadata) {
return Route.async()
.id(String.valueOf(id))
.uri("http://localhost/" + id)
.order(order)
.predicate(exchange -> true)
.metadata(metadata)
.build();
}

Route route(int id) {
return Route.async()
.id(String.valueOf(id))
Expand Down
Loading