Skip to content

Update flush mode related Spring Session configuration properties #17278

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

Closed
wants to merge 3 commits into from
Closed

Update flush mode related Spring Session configuration properties #17278

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
ac6d7c4
Start building against snapshots for Spring Session Corn-M3
vpavic Jun 20, 2019
4b5cc0b
Disable flush mode property mapping for reactive Redis session
vpavic Jun 20, 2019
b9bd5db
Migrate Spring Session config to new flush mode enum
vpavic Jul 1, 2019
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
2 changes: 1 addition & 1 deletion ...in/java/org/springframework/boot/autoconfigure/session/HazelcastSessionConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public void customize(SessionProperties sessionProperties,
setMaxInactiveIntervalInSeconds((int) timeout.getSeconds());
}
setSessionMapName(hazelcastSessionProperties.getMapName());
setHazelcastFlushMode(hazelcastSessionProperties.getFlushMode());
setFlushMode(hazelcastSessionProperties.getFlushMode());
}

}
Expand Down
10 changes: 5 additions & 5 deletions .../main/java/org/springframework/boot/autoconfigure/session/HazelcastSessionProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -17,7 +17,7 @@
package org.springframework.boot.autoconfigure.session;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.session.hazelcast.HazelcastFlushMode;
import org.springframework.session.FlushMode;

/**
* Configuration properties for Hazelcast backed Spring Session.
Expand All @@ -36,7 +36,7 @@ public class HazelcastSessionProperties {
/**
* Sessions flush mode.
*/
private HazelcastFlushMode flushMode = HazelcastFlushMode.ON_SAVE;
private FlushMode flushMode = FlushMode.ON_SAVE;

public String getMapName() {
return this.mapName;
Expand All @@ -46,11 +46,11 @@ public void setMapName(String mapName) {
this.mapName = mapName;
}

public HazelcastFlushMode getFlushMode() {
public FlushMode getFlushMode() {
return this.flushMode;
}

public void setFlushMode(HazelcastFlushMode flushMode) {
public void setFlushMode(FlushMode flushMode) {
this.flushMode = flushMode;
}

Expand Down
1 change: 0 additions & 1 deletion ...ava/org/springframework/boot/autoconfigure/session/RedisReactiveSessionConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ public void customize(SessionProperties sessionProperties, RedisSessionPropertie
setMaxInactiveIntervalInSeconds((int) timeout.getSeconds());
}
setRedisNamespace(redisSessionProperties.getNamespace());
setRedisFlushMode(redisSessionProperties.getFlushMode());
}

}
Expand Down
2 changes: 1 addition & 1 deletion ...c/main/java/org/springframework/boot/autoconfigure/session/RedisSessionConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public void customize(SessionProperties sessionProperties, RedisSessionPropertie
setMaxInactiveIntervalInSeconds((int) timeout.getSeconds());
}
setRedisNamespace(redisSessionProperties.getNamespace());
setRedisFlushMode(redisSessionProperties.getFlushMode());
setFlushMode(redisSessionProperties.getFlushMode());
setCleanupCron(redisSessionProperties.getCleanupCron());
}

Expand Down
8 changes: 4 additions & 4 deletions .../src/main/java/org/springframework/boot/autoconfigure/session/RedisSessionProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package org.springframework.boot.autoconfigure.session;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.session.data.redis.RedisFlushMode;
import org.springframework.session.FlushMode;

/**
* Configuration properties for Redis backed Spring Session.
Expand All @@ -38,7 +38,7 @@ public class RedisSessionProperties {
/**
* Sessions flush mode.
*/
private RedisFlushMode flushMode = RedisFlushMode.ON_SAVE;
private FlushMode flushMode = FlushMode.ON_SAVE;

/**
* The configure action to apply when no user defined ConfigureRedisAction bean is
Expand All @@ -59,11 +59,11 @@ public void setNamespace(String namespace) {
this.namespace = namespace;
}

public RedisFlushMode getFlushMode() {
public FlushMode getFlushMode() {
return this.flushMode;
}

public void setFlushMode(RedisFlushMode flushMode) {
public void setFlushMode(FlushMode flushMode) {
this.flushMode = flushMode;
}

Expand Down
14 changes: 5 additions & 9 deletions ...pringframework/boot/autoconfigure/session/ReactiveSessionAutoConfigurationRedisTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner;
import org.springframework.session.data.mongo.ReactiveMongoOperationsSessionRepository;
import org.springframework.session.data.redis.ReactiveRedisOperationsSessionRepository;
import org.springframework.session.data.redis.RedisFlushMode;

import static org.assertj.core.api.Assertions.assertThat;

Expand All @@ -48,34 +47,31 @@ void defaultConfig() {
this.contextRunner.withPropertyValues("spring.session.store-type=redis")
.withConfiguration(
AutoConfigurations.of(RedisAutoConfiguration.class, RedisReactiveAutoConfiguration.class))
.run(validateSpringSessionUsesRedis("spring:session:", RedisFlushMode.ON_SAVE));
.run(validateSpringSessionUsesRedis("spring:session:"));
}

@Test
void defaultConfigWithUniqueStoreImplementation() {
this.contextRunner.withClassLoader(new FilteredClassLoader(ReactiveMongoOperationsSessionRepository.class))
.withConfiguration(
AutoConfigurations.of(RedisAutoConfiguration.class, RedisReactiveAutoConfiguration.class))
.run(validateSpringSessionUsesRedis("spring:session:", RedisFlushMode.ON_SAVE));
.run(validateSpringSessionUsesRedis("spring:session:"));
}

@Test
void redisSessionStoreWithCustomizations() {
this.contextRunner
.withConfiguration(
AutoConfigurations.of(RedisAutoConfiguration.class, RedisReactiveAutoConfiguration.class))
.withPropertyValues("spring.session.store-type=redis", "spring.session.redis.namespace=foo",
"spring.session.redis.flush-mode=immediate")
.run(validateSpringSessionUsesRedis("foo:", RedisFlushMode.IMMEDIATE));
.withPropertyValues("spring.session.store-type=redis", "spring.session.redis.namespace=foo")
.run(validateSpringSessionUsesRedis("foo:"));
}

private ContextConsumer<AssertableReactiveWebApplicationContext> validateSpringSessionUsesRedis(String namespace,
RedisFlushMode flushMode) {
private ContextConsumer<AssertableReactiveWebApplicationContext> validateSpringSessionUsesRedis(String namespace) {
return (context) -> {
ReactiveRedisOperationsSessionRepository repository = validateSessionRepository(context,
ReactiveRedisOperationsSessionRepository.class);
assertThat(repository).hasFieldOrPropertyWithValue("namespace", namespace);
assertThat(repository).hasFieldOrPropertyWithValue("redisFlushMode", flushMode);
};
}

Expand Down
5 changes: 2 additions & 3 deletions ...rg/springframework/boot/autoconfigure/session/SessionAutoConfigurationHazelcastTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.session.FlushMode;
import org.springframework.session.data.mongo.MongoOperationsSessionRepository;
import org.springframework.session.data.redis.RedisOperationsSessionRepository;
import org.springframework.session.hazelcast.HazelcastFlushMode;
import org.springframework.session.hazelcast.HazelcastSessionRepository;
import org.springframework.session.jdbc.JdbcOperationsSessionRepository;

Expand Down Expand Up @@ -84,8 +84,7 @@ void customFlushMode() {
"spring.session.hazelcast.flush-mode=immediate").run((context) -> {
HazelcastSessionRepository repository = validateSessionRepository(context,
HazelcastSessionRepository.class);
assertThat(repository).hasFieldOrPropertyWithValue("hazelcastFlushMode",
HazelcastFlushMode.IMMEDIATE);
assertThat(repository).hasFieldOrPropertyWithValue("flushMode", FlushMode.IMMEDIATE);
});
}

Expand Down
12 changes: 6 additions & 6 deletions ...va/org/springframework/boot/autoconfigure/session/SessionAutoConfigurationRedisTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
import org.springframework.boot.testsupport.testcontainers.RedisContainer;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.session.FlushMode;
import org.springframework.session.data.mongo.MongoOperationsSessionRepository;
import org.springframework.session.data.redis.RedisFlushMode;
import org.springframework.session.data.redis.RedisOperationsSessionRepository;
import org.springframework.session.data.redis.config.ConfigureNotifyKeyspaceEventsAction;
import org.springframework.session.data.redis.config.ConfigureRedisAction;
Expand Down Expand Up @@ -64,7 +64,7 @@ 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:", RedisFlushMode.ON_SAVE,
.run(validateSpringSessionUsesRedis("spring:session:event:0:created:", FlushMode.ON_SAVE,
"0 * * * * *"));
}

Expand All @@ -75,7 +75,7 @@ void defaultConfigWithUniqueStoreImplementation() {
JdbcOperationsSessionRepository.class, MongoOperationsSessionRepository.class))
.withConfiguration(AutoConfigurations.of(RedisAutoConfiguration.class))
.withPropertyValues("spring.redis.port=" + redis.getFirstMappedPort())
.run(validateSpringSessionUsesRedis("spring:session:event:0:created:", RedisFlushMode.ON_SAVE,
.run(validateSpringSessionUsesRedis("spring:session:event:0:created:", FlushMode.ON_SAVE,
"0 * * * * *"));
}

Expand All @@ -85,7 +85,7 @@ void redisSessionStoreWithCustomizations() {
.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.redis.port=" + redis.getFirstMappedPort())
.run(validateSpringSessionUsesRedis("foo:event:0:created:", RedisFlushMode.IMMEDIATE, "0 0 12 * * *"));
.run(validateSpringSessionUsesRedis("foo:event:0:created:", FlushMode.IMMEDIATE, "0 0 12 * * *"));
}

@Test
Expand Down Expand Up @@ -116,12 +116,12 @@ void redisSessionWithCustomConfigureRedisActionBean() {
}

private ContextConsumer<AssertableWebApplicationContext> validateSpringSessionUsesRedis(
String sessionCreatedChannelPrefix, RedisFlushMode flushMode, String cleanupCron) {
String sessionCreatedChannelPrefix, FlushMode flushMode, String cleanupCron) {
return (context) -> {
RedisOperationsSessionRepository repository = validateSessionRepository(context,
RedisOperationsSessionRepository.class);
assertThat(repository.getSessionCreatedChannelPrefix()).isEqualTo(sessionCreatedChannelPrefix);
assertThat(repository).hasFieldOrPropertyWithValue("redisFlushMode", flushMode);
assertThat(repository).hasFieldOrPropertyWithValue("flushMode", flushMode);
SpringBootRedisHttpSessionConfiguration configuration = context
.getBean(SpringBootRedisHttpSessionConfiguration.class);
assertThat(configuration).hasFieldOrPropertyWithValue("cleanupCron", cleanupCron);
Expand Down
2 changes: 1 addition & 1 deletion spring-boot-project/spring-boot-dependencies/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@
<spring-restdocs.version>2.0.3.RELEASE</spring-restdocs.version>
<spring-retry.version>1.2.4.RELEASE</spring-retry.version>
<spring-security.version>5.2.0.M3</spring-security.version>
<spring-session-bom.version>Corn-M2</spring-session-bom.version>
<spring-session-bom.version>Corn-BUILD-SNAPSHOT</spring-session-bom.version>
<spring-ws.version>3.0.7.RELEASE</spring-ws.version>
<sqlite-jdbc.version>3.27.2</sqlite-jdbc.version>
<statsd-client.version>3.1.0</statsd-client.version>
Expand Down