From 52930d2458a4df8e6542beb01b23c52776c063f6 Mon Sep 17 00:00:00 2001
From: spencergibb <spencer@gibb.us>
Date: Mon, 14 Sep 2020 16:52:28 -0400
Subject: [PATCH] Don't refresh routes on management context events.

Previously, the RouteRefreshListener reset the routes cache on all ContextRefreshedEvents. If actuator is run on a seperate port, to ContextRefreshedEvents are published. This adds a check to only reset the cache if the event does not come from the management context.

Fixes gh-1928
---
 .../gateway/route/RouteRefreshListener.java   | 11 +++++--
 .../route/RouteRefreshListenerTests.java      | 29 +++++++++++++++++++
 2 files changed, 38 insertions(+), 2 deletions(-)

diff --git a/spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/route/RouteRefreshListener.java b/spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/route/RouteRefreshListener.java
index 4625ad41..5841a53c 100644
--- a/spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/route/RouteRefreshListener.java
+++ b/spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/route/RouteRefreshListener.java
@@ -16,6 +16,7 @@
 
 package org.springframework.cloud.gateway.route;
 
+import org.springframework.boot.web.context.WebServerApplicationContext;
 import org.springframework.cloud.client.discovery.event.HeartbeatEvent;
 import org.springframework.cloud.client.discovery.event.HeartbeatMonitor;
 import org.springframework.cloud.client.discovery.event.InstanceRegisteredEvent;
@@ -43,8 +44,14 @@ public class RouteRefreshListener implements ApplicationListener<ApplicationEven
 
 	@Override
 	public void onApplicationEvent(ApplicationEvent event) {
-		if (event instanceof ContextRefreshedEvent
-				|| event instanceof RefreshScopeRefreshedEvent
+		if (event instanceof ContextRefreshedEvent) {
+			ContextRefreshedEvent refreshedEvent = (ContextRefreshedEvent) event;
+			if (!WebServerApplicationContext.hasServerNamespace(
+					refreshedEvent.getApplicationContext(), "management")) {
+				reset();
+			}
+		}
+		else if (event instanceof RefreshScopeRefreshedEvent
 				|| event instanceof InstanceRegisteredEvent) {
 			reset();
 		}
diff --git a/spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/route/RouteRefreshListenerTests.java b/spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/route/RouteRefreshListenerTests.java
index a23ac451..6e94b548 100644
--- a/spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/route/RouteRefreshListenerTests.java
+++ b/spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/route/RouteRefreshListenerTests.java
@@ -18,19 +18,48 @@ package org.springframework.cloud.gateway.route;
 
 import org.junit.Test;
 
+import org.springframework.boot.web.context.WebServerApplicationContext;
 import org.springframework.cloud.client.discovery.event.HeartbeatEvent;
 import org.springframework.cloud.client.discovery.event.InstanceRegisteredEvent;
 import org.springframework.cloud.client.discovery.event.ParentHeartbeatEvent;
 import org.springframework.cloud.gateway.event.RefreshRoutesEvent;
+import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.context.event.ContextRefreshedEvent;
 
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoInteractions;
+import static org.mockito.Mockito.when;
 
 public class RouteRefreshListenerTests {
 
+	@Test
+	public void onContextRefreshedEventManagement() {
+		ApplicationEventPublisher publisher = mock(ApplicationEventPublisher.class);
+		RouteRefreshListener listener = new RouteRefreshListener(publisher);
+
+		WebServerApplicationContext applicationContext = mock(
+				WebServerApplicationContext.class);
+		when(applicationContext.getServerNamespace()).thenReturn("management");
+		listener.onApplicationEvent(new ContextRefreshedEvent(applicationContext));
+
+		verifyNoInteractions(publisher);
+	}
+
+	@Test
+	public void onContextRefreshedEvent() {
+		ApplicationEventPublisher publisher = mock(ApplicationEventPublisher.class);
+		RouteRefreshListener listener = new RouteRefreshListener(publisher);
+
+		listener.onApplicationEvent(
+				new ContextRefreshedEvent(mock(ApplicationContext.class)));
+
+		verify(publisher).publishEvent(any(RefreshRoutesEvent.class));
+	}
+
 	@Test
 	public void onInstanceRegisteredEvent() {
 		ApplicationEventPublisher publisher = mock(ApplicationEventPublisher.class);