GitHub-Spring
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Polish HeaderWebSessionIdResolver 

Use constant for default header name and make getHeaderName private.

Also switch HeaderWebSessionIdResolverTests to unit tests rather than
testing with DefaultWebSessionManager.

Issue: SPR-15917
pull/1518/head
Rob Winch 9 years ago committed by Rossen Stoyanchev
parent
dcdb0b416f
commit
167ddc7cfc
2 changed files with 93 additions and 128 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 24
      spring-web/src/main/java/org/springframework/web/server/session/HeaderWebSessionIdResolver.java
  2. 197
      spring-web/src/test/java/org/springframework/web/server/session/HeaderWebSessionIdResolverTests.java

24
spring-web/src/main/java/org/springframework/web/server/session/HeaderWebSessionIdResolver.java
Unescape View File

@ -26,18 +26,23 @@ import org.springframework.web.server.ServerWebExchange;
* Request and response header-based {@link WebSessionIdResolver}. * Request and response header-based {@link WebSessionIdResolver}.
* *
* @author Greg Turnquist * @author Greg Turnquist
* @author Rob Winch
* @since 5.0 * @since 5.0
*/ */
public class HeaderWebSessionIdResolver implements WebSessionIdResolver { public class HeaderWebSessionIdResolver implements WebSessionIdResolver {
private String headerName = "SESSION"; /**
* The default header name
*/
public static final String DEFAULT_HEADER_NAME = "SESSION";
private String headerName = DEFAULT_HEADER_NAME;
/** /**
* Set the name of the session header to use for the session id. * Set the name of the session header to use for the session id.
* The name is used to extract the session id from the request headers as * The name is used to extract the session id from the request headers as
* well to set the session id on the response headers. * well to set the session id on the response headers.
* <p>By default set to {@literal "SESSION"}. * <p>By default set to {@code DEFAULT_HEADER_NAME}
* @param headerName the header name * @param headerName the header name
*/ */
public void setHeaderName(String headerName) { public void setHeaderName(String headerName) {
@ -45,14 +50,6 @@ public class HeaderWebSessionIdResolver implements WebSessionIdResolver {
this.headerName = headerName; this.headerName = headerName;
} }
/**
* Return the configured header name.
*/
public String getHeaderName() {
return this.headerName;
}
@Override @Override
public List<String> resolveSessionIds(ServerWebExchange exchange) { public List<String> resolveSessionIds(ServerWebExchange exchange) {
HttpHeaders headers = exchange.getRequest().getHeaders(); HttpHeaders headers = exchange.getRequest().getHeaders();
@ -70,4 +67,11 @@ public class HeaderWebSessionIdResolver implements WebSessionIdResolver {
this.setSessionId(exchange, ""); this.setSessionId(exchange, "");
} }
/**
* Return the configured header name.
* @return the configured header name
*/
private String getHeaderName() {
return this.headerName;
}
} }

197
spring-web/src/test/java/org/springframework/web/server/session/HeaderWebSessionIdResolverTests.java
Unescape View File

@ -15,170 +15,131 @@
*/ */
package org.springframework.web.server.session; package org.springframework.web.server.session;
import java.time.Clock;
import java.time.Duration;
import java.time.Instant;
import java.time.ZoneId;
import java.util.UUID;
import org.junit.Before; import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import reactor.core.publisher.Mono;
import org.springframework.http.codec.ServerCodecConfigurer;
import org.springframework.mock.http.server.reactive.test.MockServerHttpRequest; import org.springframework.mock.http.server.reactive.test.MockServerHttpRequest;
import org.springframework.mock.http.server.reactive.test.MockServerHttpResponse;
import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebSession;
import org.springframework.web.server.adapter.DefaultServerWebExchange;
import org.springframework.web.server.i18n.AcceptHeaderLocaleContextResolver;
import static org.hamcrest.collection.IsCollectionWithSize.hasSize; import java.util.Arrays;
import static org.hamcrest.core.Is.is; import java.util.List;
import static org.hamcrest.core.IsCollectionContaining.hasItem;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;
/** /**
* Tests using {@link HeaderWebSessionIdResolver}. * Tests using {@link HeaderWebSessionIdResolver}.
* *
* @author Greg Turnquist * @author Greg Turnquist
* @author Rob Winch
*/ */
public class HeaderWebSessionIdResolverTests { public class HeaderWebSessionIdResolverTests {
private static final Clock CLOCK = Clock.system(ZoneId.of("GMT"));
private HeaderWebSessionIdResolver idResolver; private HeaderWebSessionIdResolver idResolver;
private DefaultWebSessionManager manager;
private ServerWebExchange exchange; private ServerWebExchange exchange;
@Before @Before
public void setUp() { public void setUp() {
this.idResolver = new HeaderWebSessionIdResolver(); this.idResolver = new HeaderWebSessionIdResolver();
this.manager = new DefaultWebSessionManager(); this.exchange = MockServerHttpRequest.get("/path").toExchange();
this.manager.setSessionIdResolver(this.idResolver); }
MockServerHttpRequest request = MockServerHttpRequest.get("/path").build(); @Test
MockServerHttpResponse response = new MockServerHttpResponse(); public void expireWhenValidThenSetsEmptyHeader() {
this.idResolver.expireSession(this.exchange);
this.exchange = new DefaultServerWebExchange(request, response, this.manager, assertEquals(Arrays.asList(""),
ServerCodecConfigurer.create(), new AcceptHeaderLocaleContextResolver()); this.exchange.getResponse().getHeaders().get(HeaderWebSessionIdResolver.DEFAULT_HEADER_NAME));
} }
@Test @Test
public void getSessionWithoutStarting() throws Exception { public void expireWhenMultipleInvocationThenSetsSingleEmptyHeader() {
WebSession session = this.manager.getSession(this.exchange).block(); this.idResolver.expireSession(this.exchange);
session.save();
this.idResolver.expireSession(this.exchange);
assertFalse(session.isStarted()); assertEquals(Arrays.asList(""),
assertFalse(session.isExpired()); this.exchange.getResponse().getHeaders().get(HeaderWebSessionIdResolver.DEFAULT_HEADER_NAME));
assertNull(this.manager.getSessionStore().retrieveSession(session.getId()).block());
} }
@Test @Test
public void startSessionExplicitly() throws Exception { public void expireWhenAfterSetSessionIdThenSetsEmptyHeader() {
WebSession session = this.manager.getSession(this.exchange).block(); this.idResolver.setSessionId(this.exchange, "123");
session.start();
session.save().block(); this.idResolver.expireSession(this.exchange);
assertThat(this.exchange.getResponse().getHeaders().containsKey("SESSION"), is(true)); assertEquals(Arrays.asList(""),
assertThat(this.exchange.getResponse().getHeaders().get("SESSION"), hasSize(1)); this.exchange.getResponse().getHeaders().get(HeaderWebSessionIdResolver.DEFAULT_HEADER_NAME));
assertThat(this.exchange.getResponse().getHeaders().get("SESSION"), hasItem(session.getId()));
} }
@Test @Test
public void startSessionImplicitly() throws Exception { public void setSessionIdWhenValidThenSetsHeader() {
WebSession session = this.manager.getSession(this.exchange).block(); String id = "123";
session.getAttributes().put("foo", "bar");
session.save(); this.idResolver.setSessionId(this.exchange, id);
assertNotNull(this.exchange.getResponse().getHeaders().get("SESSION")); assertEquals(Arrays.asList(id),
this.exchange.getResponse().getHeaders().get(HeaderWebSessionIdResolver.DEFAULT_HEADER_NAME));
} }
@Test @Test
public void existingSession() throws Exception { public void setSessionIdWhenMultipleThenSetsSingleHeader() {
UUID sessionId = UUID.randomUUID(); String id = "123";
DefaultWebSession existing = createDefaultWebSession(sessionId); this.idResolver.setSessionId(this.exchange, "overriddenByNextInvocation");
this.manager.getSessionStore().storeSession(existing);
this.idResolver.setSessionId(this.exchange, id);
this.exchange = this.exchange.mutate()
.request(this.exchange.getRequest().mutate() assertEquals(Arrays.asList(id),
.header("SESSION", sessionId.toString()) this.exchange.getResponse().getHeaders().get(HeaderWebSessionIdResolver.DEFAULT_HEADER_NAME));
.build())
.build();
WebSession actual = this.manager.getSession(this.exchange).block();
assertNotNull(actual);
assertEquals(existing.getId(), actual.getId());
} }
@Test @Test
public void existingSessionIsExpired() throws Exception { public void setSessionIdWhenCustomHeaderNameThenSetsHeader() {
UUID sessionId = UUID.randomUUID(); String headerName = "x-auth";
DefaultWebSession existing = createDefaultWebSession(sessionId); String id = "123";
existing.start(); this.idResolver.setHeaderName(headerName);
Instant lastAccessTime = Instant.now(CLOCK).minus(Duration.ofMinutes(31));
existing = new DefaultWebSession(existing, lastAccessTime, s -> Mono.empty()); this.idResolver.setSessionId(this.exchange, id);
this.manager.getSessionStore().storeSession(existing);
assertEquals(Arrays.asList(id),
this.exchange = this.exchange.mutate() this.exchange.getResponse().getHeaders().get(headerName));
.request(this.exchange.getRequest().mutate()
.header("SESSION", sessionId.toString())
.build())
.build();
WebSession actual = this.manager.getSession(this.exchange).block();
assertNotSame(existing, actual);
} }
@Test @Test(expected = IllegalArgumentException.class)
public void multipleSessionIds() throws Exception { public void setSessionIdWhenNullIdThenIllegalArgumentException() {
UUID sessionId = UUID.randomUUID(); String id = null;
DefaultWebSession existing = createDefaultWebSession(sessionId);
this.manager.getSessionStore().storeSession(existing); this.idResolver.setSessionId(this.exchange, id);
this.manager.getSessionStore().storeSession(createDefaultWebSession(UUID.randomUUID()));
this.manager.getSessionStore().storeSession(createDefaultWebSession(UUID.randomUUID()));
this.exchange = this.exchange.mutate()
.request(this.exchange.getRequest().mutate()
.header("SESSION", sessionId.toString())
.build())
.build();
WebSession actual = this.manager.getSession(this.exchange).block();
assertNotNull(actual);
assertEquals(existing.getId(), actual.getId());
} }
@Test @Test
public void alternateHeaderName() throws Exception { public void resolveSessionIdsWhenNoIdsThenEmpty() {
this.idResolver.setHeaderName("alternateHeaderName"); List<String> ids = this.idResolver.resolveSessionIds(this.exchange);
UUID sessionId = UUID.randomUUID(); assertTrue(ids.isEmpty());
DefaultWebSession existing = createDefaultWebSession(sessionId);
this.manager.getSessionStore().storeSession(existing);
this.exchange = this.exchange.mutate()
.request(this.exchange.getRequest().mutate()
.header("alternateHeaderName", sessionId.toString())
.build())
.build();
WebSession actual = this.manager.getSession(this.exchange).block();
assertNotNull(actual);
assertEquals(existing.getId(), actual.getId());
} }
private DefaultWebSession createDefaultWebSession(UUID sessionId) { @Test
return new DefaultWebSession(() -> sessionId, CLOCK, (s, session) -> Mono.empty(), s -> Mono.empty()); public void resolveSessionIdsWhenIdThenIdFound() {
String id = "123";
this.exchange = MockServerHttpRequest.get("/path")
.header(HeaderWebSessionIdResolver.DEFAULT_HEADER_NAME, id)
.toExchange();
List<String> ids = this.idResolver.resolveSessionIds(this.exchange);
assertEquals(Arrays.asList(id), ids);
} }
@Test
public void resolveSessionIdsWhenMultipleIdsThenIdsFound() {
String id1 = "123";
String id2 = "abc";
this.exchange = MockServerHttpRequest.get("/path")
.header(HeaderWebSessionIdResolver.DEFAULT_HEADER_NAME, id1, id2)
.toExchange();
List<String> ids = this.idResolver.resolveSessionIds(this.exchange);
assertEquals(Arrays.asList(id1, id2), ids);
}
} }

Write Preview
Loading…
Cancel
Save