Fix NPE with EnableHazelcastHttpSession and add tests

This fixes the NPE caused by setting maxInactiveIntervalInSeconds = "" on the EnableHazelcastHttpSession annotation. This is a basic scenario that was not covered by integration tests. Tests configuring Hazelcast with an XML file (probably the most common method in the wild) covering the failing scenario and more have been added.
saiya · Nov 9, 2015 · c701e18 · c701e18
1 parent 7186878
commit c701e18
Show file tree

Hide file tree

Showing 5 changed files with 312 additions and 1 deletion.
diff --git a/...ssion/hazelcast/config/annotation/web/http/HazelcastHttpSessionConfigurationXmlTests.java b/...ssion/hazelcast/config/annotation/web/http/HazelcastHttpSessionConfigurationXmlTests.java
@@ -0,0 +1,197 @@
+/*
+ * Copyright 2002-2015 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.session.hazelcast.config.annotation.web.http;
+
+import static org.fest.assertions.Assertions.assertThat;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.session.ExpiringSession;
+import org.springframework.session.SessionRepository;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.util.SocketUtils;
+
+import com.hazelcast.config.ClasspathXmlConfig;
+import com.hazelcast.config.Config;
+import com.hazelcast.config.NetworkConfig;
+import com.hazelcast.core.Hazelcast;
+import com.hazelcast.core.HazelcastInstance;
+
+/**
+ * Test the different configuration options for the
+ * {@link EnableHazelcastHttpSession} annotation.
+ * 
+ * @author Tommy Ludwig
+ */
+public class HazelcastHttpSessionConfigurationXmlTests<S extends ExpiringSession> {
+
+	@RunWith(SpringJUnit4ClassRunner.class)
+	@ContextConfiguration
+	@WebAppConfiguration
+	public static class CustomXmlInactiveIntervalTest<S extends ExpiringSession> {
+
+		@Autowired
+		private SessionRepository<S> repository;
+
+		@Autowired
+		private HazelcastInstance hazelcast;
+
+		@Test
+		public void saveSessionTest() throws InterruptedException {
+
+			S sessionToSave = repository.createSession();
+
+			assertThat(sessionToSave.getMaxInactiveIntervalInSeconds())
+					.isEqualTo(150);
+
+			repository.save(sessionToSave);
+
+			S session = repository.getSession(sessionToSave.getId());
+
+			assertThat(session.getId()).isEqualTo(sessionToSave.getId());
+			assertThat(session.getMaxInactiveIntervalInSeconds())
+					.isEqualTo(150);
+		}
+
+		@Test
+		public void checkUnderlyingMapSettingsTest() {
+			assertThat(
+					hazelcast.getConfig()
+							.getMapConfig("spring:session:sessions")
+							.getMaxIdleSeconds())
+					.isEqualTo(150);
+		}
+
+		@Configuration
+		@EnableHazelcastHttpSession(maxInactiveIntervalInSeconds = "")
+		static class HazelcastSessionXmlConfigCustomIdle {
+
+			@Bean
+			public HazelcastInstance embeddedHazelcast() {
+				Config hazelcastConfig = new ClasspathXmlConfig(
+						"org/springframework/session/hazelcast/config/annotation/web/http/hazelcast-custom-idle-time.xml");
+				NetworkConfig netConfig = new NetworkConfig();
+				netConfig.setPort(SocketUtils.findAvailableTcpPort());
+				hazelcastConfig.setNetworkConfig(netConfig);
+				return Hazelcast.newHazelcastInstance(hazelcastConfig);
+			}
+		}
+	}
+
+	@RunWith(SpringJUnit4ClassRunner.class)
+	@ContextConfiguration
+	@WebAppConfiguration
+	public static class CustomXmlMapNameTest<S extends ExpiringSession> {
+
+		@Autowired
+		private SessionRepository<S> repository;
+
+		@Autowired
+		private HazelcastInstance hazelcast;
+
+		@Test
+		public void saveSessionTest() throws InterruptedException {
+
+			S sessionToSave = repository.createSession();
+
+			repository.save(sessionToSave);
+
+			S session = repository.getSession(sessionToSave.getId());
+
+			assertThat(session.getId()).isEqualTo(sessionToSave.getId());
+			assertThat(session.getMaxInactiveIntervalInSeconds()).isEqualTo(1800);
+		}
+
+		@Test
+		public void checkUnderlyingMapSettingsTest() {
+			assertThat(
+					hazelcast.getConfig()
+							.getMapConfig("my-sessions")
+							.getMaxIdleSeconds())
+					.isEqualTo(1800);
+		}
+
+		@Configuration
+		@EnableHazelcastHttpSession(sessionMapName = "my-sessions")
+		static class HazelcastSessionXmlConfigCustomMapName {
+
+			@Bean
+			public HazelcastInstance embeddedHazelcast() {
+				Config hazelcastConfig = new ClasspathXmlConfig(
+						"org/springframework/session/hazelcast/config/annotation/web/http/hazelcast-custom-map-name.xml");
+				NetworkConfig netConfig = new NetworkConfig();
+				netConfig.setPort(SocketUtils.findAvailableTcpPort());
+				hazelcastConfig.setNetworkConfig(netConfig);
+				return Hazelcast.newHazelcastInstance(hazelcastConfig);
+			}
+		}
+	}
+
+	@RunWith(SpringJUnit4ClassRunner.class)
+	@ContextConfiguration
+	@WebAppConfiguration
+	public static class CustomXmlMapNameAndIdleTest<S extends ExpiringSession> {
+
+		@Autowired
+		private SessionRepository<S> repository;
+
+		@Autowired
+		private HazelcastInstance hazelcast;
+
+		@Test
+		public void saveSessionTest() throws InterruptedException {
+
+			S sessionToSave = repository.createSession();
+
+			repository.save(sessionToSave);
+
+			S session = repository.getSession(sessionToSave.getId());
+
+			assertThat(session.getId()).isEqualTo(sessionToSave.getId());
+			assertThat(session.getMaxInactiveIntervalInSeconds()).isEqualTo(1200);
+		}
+
+		@Test
+		public void checkUnderlyingMapSettingsTest() {
+			assertThat(
+					hazelcast.getConfig()
+							.getMapConfig("test-sessions")
+							.getMaxIdleSeconds())
+					.isEqualTo(1200);
+		}
+
+		@Configuration
+		@EnableHazelcastHttpSession(sessionMapName = "test-sessions", maxInactiveIntervalInSeconds = "1200")
+		static class HazelcastSessionXmlConfigCustomMapNameAndIdle {
+
+			@Bean
+			public HazelcastInstance embeddedHazelcast() {
+				Config hazelcastConfig = new ClasspathXmlConfig(
+						"org/springframework/session/hazelcast/config/annotation/web/http/hazelcast-custom-idle-time-map-name.xml");
+				NetworkConfig netConfig = new NetworkConfig();
+				netConfig.setPort(SocketUtils.findAvailableTcpPort());
+				hazelcastConfig.setNetworkConfig(netConfig);
+				return Hazelcast.newHazelcastInstance(hazelcastConfig);
+			}
+		}
+	}
+
+}
diff --git a/...ework/session/hazelcast/config/annotation/web/http/HazelcastHttpSessionConfiguration.java b/...ework/session/hazelcast/config/annotation/web/http/HazelcastHttpSessionConfiguration.java
@@ -89,14 +89,17 @@ public SessionEntryListener sessionListener(ApplicationEventPublisher eventPubli
 
 	/**
 	 * Make a {@link MapConfig} for the given sessionMapName if one does not exist.
-	 * Ensure that maxIdleSeconds is set to maxInactiveIntervalInSeconds for proper session expiration.
+	 * Set Hazelcast's maxIdleSeconds to maxInactiveIntervalInSeconds if set (not "").
+	 * Otherwise get the externally configured maxIdleSeconds for the distributed sessions map.
 	 *
 	 * @param hazelcastInstance the {@link HazelcastInstance} to configure
 	 */
 	private void configureSessionMap(HazelcastInstance hazelcastInstance) {
 		MapConfig sessionMapConfig = hazelcastInstance.getConfig().getMapConfig(sessionMapName);
 		if (this.maxInactiveIntervalInSeconds != null) {
 			sessionMapConfig.setMaxIdleSeconds(this.maxInactiveIntervalInSeconds);
+		} else {
+			this.maxInactiveIntervalInSeconds = sessionMapConfig.getMaxIdleSeconds();
 		}
 	}
 

diff --git a/...work/session/hazelcast/config/annotation/web/http/hazelcast-custom-idle-time-map-name.xml b/...work/session/hazelcast/config/annotation/web/http/hazelcast-custom-idle-time-map-name.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hazelcast
+	xsi:schemaLocation="http://www.hazelcast.com/schema/config hazelcast-config-3.5.xsd"
+	xmlns="http://www.hazelcast.com/schema/config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<group>
+		<name>spring-session-it-test-idle-time-map-name</name>
+		<password>test-pass</password>
+	</group>
+	<network>
+		<port auto-increment="true" port-count="100">5701</port>
+		<outbound-ports>
+			<ports>0</ports>
+		</outbound-ports>
+		<join>
+			<multicast enabled="false">
+			</multicast>
+			<tcp-ip enabled="true">
+				<interface>127.0.0.1</interface>
+				<member-list>
+					<member>127.0.0.1</member>
+				</member-list>
+			</tcp-ip>
+			<aws enabled="false">
+			</aws>
+		</join>
+	</network>
+	<map name="test-sessions">
+		<in-memory-format>BINARY</in-memory-format>
+		<backup-count>1</backup-count>
+		<async-backup-count>0</async-backup-count>
+		<time-to-live-seconds>0</time-to-live-seconds>
+		<max-idle-seconds>300</max-idle-seconds>
+		<merge-policy>com.hazelcast.map.merge.PutIfAbsentMapMergePolicy
+		</merge-policy>
+	</map>
+
+</hazelcast>
diff --git a/...ringframework/session/hazelcast/config/annotation/web/http/hazelcast-custom-idle-time.xml b/...ringframework/session/hazelcast/config/annotation/web/http/hazelcast-custom-idle-time.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hazelcast
+	xsi:schemaLocation="http://www.hazelcast.com/schema/config hazelcast-config-3.5.xsd"
+	xmlns="http://www.hazelcast.com/schema/config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<group>
+		<name>spring-session-it-test-idle-time</name>
+		<password>test-pass</password>
+	</group>
+	<network>
+		<port auto-increment="true" port-count="100">5701</port>
+		<outbound-ports>
+			<ports>0</ports>
+		</outbound-ports>
+		<join>
+			<multicast enabled="false">
+			</multicast>
+			<tcp-ip enabled="true">
+				<interface>127.0.0.1</interface>
+				<member-list>
+					<member>127.0.0.1</member>
+				</member-list>
+			</tcp-ip>
+			<aws enabled="false">
+			</aws>
+		</join>
+	</network>
+	<map name="spring:session:sessions">
+		<in-memory-format>BINARY</in-memory-format>
+		<backup-count>1</backup-count>
+		<async-backup-count>0</async-backup-count>
+		<time-to-live-seconds>0</time-to-live-seconds>
+		<max-idle-seconds>150</max-idle-seconds>
+		<merge-policy>com.hazelcast.map.merge.PutIfAbsentMapMergePolicy
+		</merge-policy>
+	</map>
+
+</hazelcast>
diff --git a/...pringframework/session/hazelcast/config/annotation/web/http/hazelcast-custom-map-name.xml b/...pringframework/session/hazelcast/config/annotation/web/http/hazelcast-custom-map-name.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<hazelcast
+	xsi:schemaLocation="http://www.hazelcast.com/schema/config hazelcast-config-3.5.xsd"
+	xmlns="http://www.hazelcast.com/schema/config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<group>
+		<name>spring-session-it-test-map-name</name>
+		<password>test-pass</password>
+	</group>
+	<network>
+		<port auto-increment="true" port-count="100">5701</port>
+		<outbound-ports>
+			<ports>0</ports>
+		</outbound-ports>
+		<join>
+			<multicast enabled="false">
+			</multicast>
+			<tcp-ip enabled="true">
+				<interface>127.0.0.1</interface>
+				<member-list>
+					<member>127.0.0.1</member>
+				</member-list>
+			</tcp-ip>
+			<aws enabled="false">
+			</aws>
+		</join>
+	</network>
+	<map name="my-sessions">
+		<in-memory-format>BINARY</in-memory-format>
+		<backup-count>1</backup-count>
+		<async-backup-count>0</async-backup-count>
+		<time-to-live-seconds>0</time-to-live-seconds>
+		<max-idle-seconds>0</max-idle-seconds>
+		<merge-policy>com.hazelcast.map.merge.PutIfAbsentMapMergePolicy
+		</merge-policy>
+	</map>
+
+</hazelcast>