Add support for configuring Spring Session SaveMode

vpavic · vpavic · commit 7a2dddf0f3d9 · 2019-07-15T06:37:06.000+02:00
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/HazelcastSessionConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/HazelcastSessionConfiguration.java
@@ -59,6 +59,7 @@ public void customize(SessionProperties sessionProperties,
 			}
 			setSessionMapName(hazelcastSessionProperties.getMapName());
 			setFlushMode(hazelcastSessionProperties.getFlushMode());
+			setSaveMode(hazelcastSessionProperties.getSaveMode());
 		}
 
 	}
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/HazelcastSessionProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/HazelcastSessionProperties.java
@@ -18,6 +18,7 @@
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.session.FlushMode;
+import org.springframework.session.SaveMode;
 
 /**
  * Configuration properties for Hazelcast backed Spring Session.
@@ -38,6 +39,11 @@ public class HazelcastSessionProperties {
 	 */
 	private FlushMode flushMode = FlushMode.ON_SAVE;
 
+	/**
+	 * Sessions save mode.
+	 */
+	private SaveMode saveMode = SaveMode.ON_SET_ATTRIBUTE;
+
 	public String getMapName() {
 		return this.mapName;
 	}
@@ -54,4 +60,12 @@ public void setFlushMode(FlushMode flushMode) {
 		this.flushMode = flushMode;
 	}
 
+	public SaveMode getSaveMode() {
+		return this.saveMode;
+	}
+
+	public void setSaveMode(SaveMode saveMode) {
+		this.saveMode = saveMode;
+	}
+
 }
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionConfiguration.java
@@ -67,6 +67,7 @@ void customize(SessionProperties sessionProperties, JdbcSessionProperties jdbcSe
 			}
 			setTableName(jdbcSessionProperties.getTableName());
 			setCleanupCron(jdbcSessionProperties.getCleanupCron());
+			setSaveMode(jdbcSessionProperties.getSaveMode());
 		}
 
 	}
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/JdbcSessionProperties.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2017 the original author or authors.
+ * Copyright 2012-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.jdbc.DataSourceInitializationMode;
+import org.springframework.session.SaveMode;
 
 /**
  * Configuration properties for JDBC backed Spring Session.
@@ -55,6 +56,11 @@ public class JdbcSessionProperties {
 	 */
 	private DataSourceInitializationMode initializeSchema = DataSourceInitializationMode.EMBEDDED;
 
+	/**
+	 * Sessions save mode.
+	 */
+	private SaveMode saveMode = SaveMode.ON_SET_ATTRIBUTE;
+
 	public String getSchema() {
 		return this.schema;
 	}
@@ -87,4 +93,12 @@ public void setInitializeSchema(DataSourceInitializationMode initializeSchema) {
 		this.initializeSchema = initializeSchema;
 	}
 
+	public SaveMode getSaveMode() {
+		return this.saveMode;
+	}
+
+	public void setSaveMode(SaveMode saveMode) {
+		this.saveMode = saveMode;
+	}
+
 }
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/RedisReactiveSessionConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/RedisReactiveSessionConfiguration.java
@@ -53,6 +53,7 @@ void customize(SessionProperties sessionProperties, RedisSessionProperties redis
 				setMaxInactiveIntervalInSeconds((int) timeout.getSeconds());
 			}
 			setRedisNamespace(redisSessionProperties.getNamespace());
+			setSaveMode(redisSessionProperties.getSaveMode());
 		}
 
 	}
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/RedisSessionConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/RedisSessionConfiguration.java
@@ -76,6 +76,7 @@ public void customize(SessionProperties sessionProperties, RedisSessionPropertie
 			setRedisNamespace(redisSessionProperties.getNamespace());
 			setFlushMode(redisSessionProperties.getFlushMode());
 			setCleanupCron(redisSessionProperties.getCleanupCron());
+			setSaveMode(redisSessionProperties.getSaveMode());
 		}
 
 	}
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/RedisSessionProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/RedisSessionProperties.java
@@ -18,6 +18,7 @@
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.session.FlushMode;
+import org.springframework.session.SaveMode;
 
 /**
  * Configuration properties for Redis backed Spring Session.
@@ -51,6 +52,11 @@ public class RedisSessionProperties {
 	 */
 	private String cleanupCron = DEFAULT_CLEANUP_CRON;
 
+	/**
+	 * Sessions save mode.
+	 */
+	private SaveMode saveMode = SaveMode.ON_SET_ATTRIBUTE;
+
 	public String getNamespace() {
 		return this.namespace;
 	}
@@ -83,6 +89,14 @@ public void setConfigureAction(ConfigureAction configureAction) {
 		this.configureAction = configureAction;
 	}
 
+	public SaveMode getSaveMode() {
+		return this.saveMode;
+	}
+
+	public void setSaveMode(SaveMode saveMode) {
+		this.saveMode = saveMode;
+	}
+
 	/**
 	 * Strategies for configuring and validating Redis.
 	 */
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/ReactiveSessionAutoConfigurationRedisTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/ReactiveSessionAutoConfigurationRedisTests.java
@@ -25,6 +25,7 @@
 import org.springframework.boot.test.context.assertj.AssertableReactiveWebApplicationContext;
 import org.springframework.boot.test.context.runner.ContextConsumer;
 import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner;
+import org.springframework.session.SaveMode;
 import org.springframework.session.data.mongo.ReactiveMongoOperationsSessionRepository;
 import org.springframework.session.data.redis.ReactiveRedisOperationsSessionRepository;
 
@@ -47,31 +48,34 @@ void defaultConfig() {
 		this.contextRunner.withPropertyValues("spring.session.store-type=redis")
 				.withConfiguration(
 						AutoConfigurations.of(RedisAutoConfiguration.class, RedisReactiveAutoConfiguration.class))
-				.run(validateSpringSessionUsesRedis("spring:session:"));
+				.run(validateSpringSessionUsesRedis("spring:session:", SaveMode.ON_SET_ATTRIBUTE));
 	}
 
 	@Test
 	void defaultConfigWithUniqueStoreImplementation() {
 		this.contextRunner.withClassLoader(new FilteredClassLoader(ReactiveMongoOperationsSessionRepository.class))
 				.withConfiguration(
 						AutoConfigurations.of(RedisAutoConfiguration.class, RedisReactiveAutoConfiguration.class))
-				.run(validateSpringSessionUsesRedis("spring:session:"));
+				.run(validateSpringSessionUsesRedis("spring:session:", SaveMode.ON_SET_ATTRIBUTE));
 	}
 
 	@Test
 	void redisSessionStoreWithCustomizations() {
 		this.contextRunner
 				.withConfiguration(
 						AutoConfigurations.of(RedisAutoConfiguration.class, RedisReactiveAutoConfiguration.class))
-				.withPropertyValues("spring.session.store-type=redis", "spring.session.redis.namespace=foo")
-				.run(validateSpringSessionUsesRedis("foo:"));
+				.withPropertyValues("spring.session.store-type=redis", "spring.session.redis.namespace=foo",
+						"spring.session.redis.save-mode=on-get-attribute")
+				.run(validateSpringSessionUsesRedis("foo:", SaveMode.ON_GET_ATTRIBUTE));
 	}
 
-	private ContextConsumer<AssertableReactiveWebApplicationContext> validateSpringSessionUsesRedis(String namespace) {
+	private ContextConsumer<AssertableReactiveWebApplicationContext> validateSpringSessionUsesRedis(String namespace,
+			SaveMode saveMode) {
 		return (context) -> {
 			ReactiveRedisOperationsSessionRepository repository = validateSessionRepository(context,
 					ReactiveRedisOperationsSessionRepository.class);
 			assertThat(repository).hasFieldOrPropertyWithValue("namespace", namespace);
+			assertThat(repository).hasFieldOrPropertyWithValue("saveMode", saveMode);
 		};
 	}
 
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationHazelcastTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationHazelcastTests.java
@@ -27,6 +27,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.session.FlushMode;
+import org.springframework.session.SaveMode;
 import org.springframework.session.data.mongo.MongoOperationsSessionRepository;
 import org.springframework.session.data.redis.RedisOperationsSessionRepository;
 import org.springframework.session.hazelcast.HazelcastSessionRepository;
@@ -88,6 +89,16 @@ void customFlushMode() {
 				});
 	}
 
+	@Test
+	void customSaveMode() {
+		this.contextRunner.withPropertyValues("spring.session.store-type=hazelcast",
+				"spring.session.hazelcast.save-mode=on-get-attribute").run((context) -> {
+					HazelcastSessionRepository repository = validateSessionRepository(context,
+							HazelcastSessionRepository.class);
+					assertThat(repository).hasFieldOrPropertyWithValue("saveMode", SaveMode.ON_GET_ATTRIBUTE);
+				});
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	static class HazelcastConfiguration {
 
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationJdbcTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationJdbcTests.java
@@ -30,6 +30,7 @@
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.jdbc.BadSqlGrammarException;
 import org.springframework.jdbc.core.JdbcOperations;
+import org.springframework.session.SaveMode;
 import org.springframework.session.data.mongo.MongoOperationsSessionRepository;
 import org.springframework.session.data.redis.RedisOperationsSessionRepository;
 import org.springframework.session.hazelcast.HazelcastSessionRepository;
@@ -129,4 +130,17 @@ void customCleanupCron() {
 				});
 	}
 
+	@Test
+	void customSaveMode() {
+		this.contextRunner
+				.withPropertyValues("spring.session.store-type=jdbc", "spring.session.jdbc.save-mode=on-get-attribute")
+				.run((context) -> {
+					assertThat(context.getBean(JdbcSessionProperties.class).getSaveMode())
+							.isEqualTo(SaveMode.ON_GET_ATTRIBUTE);
+					SpringBootJdbcHttpSessionConfiguration configuration = context
+							.getBean(SpringBootJdbcHttpSessionConfiguration.class);
+					assertThat(configuration).hasFieldOrPropertyWithValue("saveMode", SaveMode.ON_GET_ATTRIBUTE);
+				});
+	}
+
 }
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationRedisTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationRedisTests.java
@@ -33,6 +33,7 @@
 import org.springframework.data.redis.connection.RedisConnection;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.session.FlushMode;
+import org.springframework.session.SaveMode;
 import org.springframework.session.data.mongo.MongoOperationsSessionRepository;
 import org.springframework.session.data.redis.RedisOperationsSessionRepository;
 import org.springframework.session.data.redis.config.ConfigureNotifyKeyspaceEventsAction;
@@ -64,8 +65,8 @@ void defaultConfig() {
 				.withPropertyValues("spring.session.store-type=redis",
 						"spring.redis.port=" + redis.getFirstMappedPort())
 				.withConfiguration(AutoConfigurations.of(RedisAutoConfiguration.class))
-				.run(validateSpringSessionUsesRedis("spring:session:event:0:created:", FlushMode.ON_SAVE,
-						"0 * * * * *"));
+				.run(validateSpringSessionUsesRedis("spring:session:event:0:created:", FlushMode.ON_SAVE, "0 * * * * *",
+						SaveMode.ON_SET_ATTRIBUTE));
 	}
 
 	@Test
@@ -75,17 +76,19 @@ void defaultConfigWithUniqueStoreImplementation() {
 						JdbcOperationsSessionRepository.class, MongoOperationsSessionRepository.class))
 				.withConfiguration(AutoConfigurations.of(RedisAutoConfiguration.class))
 				.withPropertyValues("spring.redis.port=" + redis.getFirstMappedPort())
-				.run(validateSpringSessionUsesRedis("spring:session:event:0:created:", FlushMode.ON_SAVE,
-						"0 * * * * *"));
+				.run(validateSpringSessionUsesRedis("spring:session:event:0:created:", FlushMode.ON_SAVE, "0 * * * * *",
+						SaveMode.ON_SET_ATTRIBUTE));
 	}
 
 	@Test
 	void redisSessionStoreWithCustomizations() {
 		this.contextRunner.withConfiguration(AutoConfigurations.of(RedisAutoConfiguration.class))
 				.withPropertyValues("spring.session.store-type=redis", "spring.session.redis.namespace=foo",
-						"spring.session.redis.flush-mode=immediate", "spring.session.redis.cleanup-cron=0 0 12 * * *",
+						"spring.session.redis.flush-mode=immediate", "spring.session.redis.save-mode=on-get-attribute",
+						"spring.session.redis.cleanup-cron=0 0 12 * * *",
 						"spring.redis.port=" + redis.getFirstMappedPort())
-				.run(validateSpringSessionUsesRedis("foo:event:0:created:", FlushMode.IMMEDIATE, "0 0 12 * * *"));
+				.run(validateSpringSessionUsesRedis("foo:event:0:created:", FlushMode.IMMEDIATE, "0 0 12 * * *",
+						SaveMode.ON_GET_ATTRIBUTE));
 	}
 
 	@Test
@@ -116,7 +119,7 @@ void redisSessionWithCustomConfigureRedisActionBean() {
 	}
 
 	private ContextConsumer<AssertableWebApplicationContext> validateSpringSessionUsesRedis(
-			String sessionCreatedChannelPrefix, FlushMode flushMode, String cleanupCron) {
+			String sessionCreatedChannelPrefix, FlushMode flushMode, String cleanupCron, SaveMode saveMode) {
 		return (context) -> {
 			RedisOperationsSessionRepository repository = validateSessionRepository(context,
 					RedisOperationsSessionRepository.class);
@@ -125,6 +128,7 @@ private ContextConsumer<AssertableWebApplicationContext> validateSpringSessionUs
 			SpringBootRedisHttpSessionConfiguration configuration = context
 					.getBean(SpringBootRedisHttpSessionConfiguration.class);
 			assertThat(configuration).hasFieldOrPropertyWithValue("cleanupCron", cleanupCron);
+			assertThat(repository).hasFieldOrPropertyWithValue("saveMode", saveMode);
 		};
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,7 @@ public void customize(SessionProperties sessionProperties,`
`59`	`59`	`}`
`60`	`60`	`setSessionMapName(hazelcastSessionProperties.getMapName());`
`61`	`61`	`setFlushMode(hazelcastSessionProperties.getFlushMode());`
	`62`	`+ setSaveMode(hazelcastSessionProperties.getSaveMode());`
`62`	`63`	`}`
`63`	`64`
`64`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ void customize(SessionProperties sessionProperties, JdbcSessionProperties jdbcSe`
`67`	`67`	`}`
`68`	`68`	`setTableName(jdbcSessionProperties.getTableName());`
`69`	`69`	`setCleanupCron(jdbcSessionProperties.getCleanupCron());`
	`70`	`+ setSaveMode(jdbcSessionProperties.getSaveMode());`
`70`	`71`	`}`
`71`	`72`
`72`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ void customize(SessionProperties sessionProperties, RedisSessionProperties redis`
`53`	`53`	`setMaxInactiveIntervalInSeconds((int) timeout.getSeconds());`
`54`	`54`	`}`
`55`	`55`	`setRedisNamespace(redisSessionProperties.getNamespace());`
	`56`	`+ setSaveMode(redisSessionProperties.getSaveMode());`
`56`	`57`	`}`
`57`	`58`
`58`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ public void customize(SessionProperties sessionProperties, RedisSessionPropertie`
`76`	`76`	`setRedisNamespace(redisSessionProperties.getNamespace());`
`77`	`77`	`setFlushMode(redisSessionProperties.getFlushMode());`
`78`	`78`	`setCleanupCron(redisSessionProperties.getCleanupCron());`
	`79`	`+ setSaveMode(redisSessionProperties.getSaveMode());`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`}`