Polish "Add support for customizing Spring Session's cookie serializer"

See gh-20961
This commit is contained in:
Andy Wilkinson 2020-04-29 20:38:39 +01:00
parent 32454b83b4
commit d65d951318
2 changed files with 39 additions and 15 deletions

View File

@ -110,8 +110,9 @@ public class SessionAutoConfiguration {
static class RememberMeServicesConfiguration {
@Bean
RememberMeServicesCookieSerializerCustomizer rememberMeServicesCookieSerializerCustomizer() {
return new RememberMeServicesCookieSerializerCustomizer();
CookieSerializerCustomizer rememberMeServicesCookieSerializerCustomizer() {
return (cookieSerializer) -> cookieSerializer
.setRememberMeRequestAttribute(SpringSessionRememberMeServices.REMEMBER_ME_LOGIN_ATTR);
}
}
@ -141,19 +142,6 @@ public class SessionAutoConfiguration {
}
/**
* Customization for {@link SpringSessionRememberMeServices} that is only instantiated
* when Spring Security is on the classpath.
*/
static class RememberMeServicesCookieSerializerCustomizer implements CookieSerializerCustomizer {
@Override
public void customize(DefaultCookieSerializer cookieSerializer) {
cookieSerializer.setRememberMeRequestAttribute(SpringSessionRememberMeServices.REMEMBER_ME_LOGIN_ATTR);
}
}
/**
* Condition to trigger the creation of a {@link DefaultCookieSerializer}. This kicks
* in if either no {@link HttpSessionIdResolver} and {@link CookieSerializer} beans

View File

@ -22,6 +22,7 @@ import java.util.EnumSet;
import javax.servlet.DispatcherType;
import org.junit.jupiter.api.Test;
import org.mockito.InOrder;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.web.ServerProperties;
@ -30,6 +31,7 @@ import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.session.MapSessionRepository;
import org.springframework.session.SessionRepository;
import org.springframework.session.config.annotation.web.http.EnableSpringHttpSession;
@ -42,6 +44,8 @@ import org.springframework.session.web.http.SessionRepositoryFilter;
import org.springframework.test.util.ReflectionTestUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
/**
@ -205,6 +209,16 @@ class SessionAutoConfigurationTests extends AbstractSessionAutoConfigurationTest
});
}
@Test
void cookieSerializerCustomization() {
this.contextRunner.withBean(CookieSerializerCustomization.class).run((context) -> {
CookieSerializerCustomization customization = context.getBean(CookieSerializerCustomization.class);
InOrder inOrder = inOrder(customization.customizer1, customization.customizer2);
inOrder.verify(customization.customizer1).customize(any());
inOrder.verify(customization.customizer2).customize(any());
});
}
@Configuration(proxyBeanMethods = false)
@EnableSpringHttpSession
static class SessionRepositoryConfiguration {
@ -276,4 +290,26 @@ class SessionAutoConfigurationTests extends AbstractSessionAutoConfigurationTest
}
@Configuration(proxyBeanMethods = false)
@EnableSpringHttpSession
static class CookieSerializerCustomization extends SessionRepositoryConfiguration {
private final CookieSerializerCustomizer customizer1 = mock(CookieSerializerCustomizer.class);
private final CookieSerializerCustomizer customizer2 = mock(CookieSerializerCustomizer.class);
@Bean
@Order(1)
CookieSerializerCustomizer customizer1() {
return this.customizer1;
}
@Bean
@Order(2)
CookieSerializerCustomizer customizer2() {
return this.customizer2;
}
}
}