Remove EXPIRES HTTP header from cache

This header conflicts and can cause confusion when 'Cache-Control + max-age' are set. And currently SCG always sets 'max-age' in 'Cache-Control' via 'SetMaxAgeHeaderAfterCacheExchangeMutator'.
spring-cloud · Sep 5, 2024 · d4143f8 · d4143f8
1 parent 3835adc
commit d4143f8
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 5 deletions.
diff --git a/...ain/java/org/springframework/cloud/gateway/filter/factory/cache/ResponseCacheManager.java b/...ain/java/org/springframework/cloud/gateway/filter/factory/cache/ResponseCacheManager.java
@@ -81,7 +81,7 @@ public ResponseCacheManager(CacheKeyGenerator cacheKeyGenerator, Cache cache, Du
 		this.ignoreNoCacheUpdate = isSkipNoCacheUpdateActive(requestOptions);
 		this.afterCacheExchangeMutators = List.of(new SetResponseHeadersAfterCacheExchangeMutator(),
 				new SetStatusCodeAfterCacheExchangeMutator(),
-				new RemoveHeadersAfterCacheExchangeMutator(HttpHeaders.PRAGMA),
+				new RemoveHeadersAfterCacheExchangeMutator(HttpHeaders.PRAGMA, HttpHeaders.EXPIRES),
 				new SetMaxAgeHeaderAfterCacheExchangeMutator(configuredTimeToLive, Clock.systemDefaultZone(),
 						ignoreNoCacheUpdate),
 				new SetCacheDirectivesByMaxAgeAfterCacheExchangeMutator());

diff --git a/...ework/cloud/gateway/filter/factory/cache/LocalResponseCacheGatewayFilterFactoryTests.java b/...ework/cloud/gateway/filter/factory/cache/LocalResponseCacheGatewayFilterFactoryTests.java
@@ -353,21 +353,30 @@ void shouldNotCacheWhenAuthorizationHeaderIsDifferent() {
 
 		@Test
 		void shouldNotReturnPragmaHeaderInNonCachedAndCachedResponses() {
+			shouldNotReturnHeader(HttpHeaders.PRAGMA);
+		}
+
+		@Test
+		void shouldNotReturnExpiresHeaderInNonCachedAndCachedResponses() {
+			shouldNotReturnHeader(HttpHeaders.EXPIRES);
+		}
+
+		private void shouldNotReturnHeader(String header) {
 			String uri = "/" + UUID.randomUUID() + "/cache/headers";
 
 			testClient.get()
 				.uri(uri)
 				.header("Host", "www.localresponsecache.org")
 				.exchange()
 				.expectHeader()
-				.doesNotExist(HttpHeaders.PRAGMA);
+				.doesNotExist(header);
 
 			testClient.get()
 				.uri(uri)
 				.header("Host", "www.localresponsecache.org")
 				.exchange()
 				.expectHeader()
-				.doesNotExist(HttpHeaders.PRAGMA);
+				.doesNotExist(header);
 		}
 
 		void assertNonVaryHeaderInContent(String uri, String varyHeader, String varyHeaderValue, String nonVaryHeader,

diff --git a/...ringframework/cloud/gateway/filter/factory/cache/LocalResponseCacheGlobalFilterTests.java b/...ringframework/cloud/gateway/filter/factory/cache/LocalResponseCacheGlobalFilterTests.java
@@ -126,21 +126,30 @@ void shouldGlobalCacheResponseWhenRouteDoesNotHaveFilter() {
 
 		@Test
 		void shouldNotReturnPragmaHeaderInNonCachedAndCachedResponses() {
+			shouldNotReturnHeader(HttpHeaders.PRAGMA);
+		}
+
+		@Test
+		void shouldNotReturnExpiresHeaderInNonCachedAndCachedResponses() {
+			shouldNotReturnHeader(HttpHeaders.EXPIRES);
+		}
+
+		private void shouldNotReturnHeader(String header) {
 			String uri = "/" + UUID.randomUUID() + "/global-cache/headers";
 
 			testClient.get()
 				.uri(uri)
 				.header("Host", "www.localresponsecache.org")
 				.exchange()
 				.expectHeader()
-				.doesNotExist(HttpHeaders.PRAGMA);
+				.doesNotExist(header);
 
 			testClient.get()
 				.uri(uri)
 				.header("Host", "www.localresponsecache.org")
 				.exchange()
 				.expectHeader()
-				.doesNotExist(HttpHeaders.PRAGMA);
+				.doesNotExist(header);
 		}
 
 		@EnableAutoConfiguration