Make Hazelcast session repository bean factory return type more specific

The declared return type of Hazelcast session repository bean factory method (i.e. HazelcastHttpSessionConfiguration#sessionRepository) was changed to SessionRepository<?> when support for Hazelcast 4 was added. This breaks Spring Boot's ability to auto-configure sessions endpoint, which is @ConditionalOnBean(FindByIndexNameSessionRepository.class), as the current return type is not specific enough to satisfy this condition.

This commit changes the return type of Hazelcast session repository bean factory method to FindByIndexNameSessionRepository<?>.

Closes: gh-1907

Author: vpavic

spring-session-hazelcast/src/main/java/org/springframework/session/hazelcast/config/annotation/web/http/HazelcastHttpSessionConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2020 the original author or authors.
+ * Copyright 2014-2021 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.
@@ -30,12 +30,12 @@
 import org.springframework.context.annotation.ImportAware;
 import org.springframework.core.annotation.AnnotationAttributes;
 import org.springframework.core.type.AnnotationMetadata;
+import org.springframework.session.FindByIndexNameSessionRepository;
 import org.springframework.session.FlushMode;
 import org.springframework.session.IndexResolver;
 import org.springframework.session.MapSession;
 import org.springframework.session.SaveMode;
 import org.springframework.session.Session;
-import org.springframework.session.SessionRepository;
 import org.springframework.session.config.SessionRepositoryCustomizer;
 import org.springframework.session.config.annotation.web.http.SpringHttpSessionConfiguration;
 import org.springframework.session.hazelcast.Hazelcast4IndexedSessionRepository;
@@ -85,7 +85,7 @@ public class HazelcastHttpSessionConfiguration extends SpringHttpSessionConfigur
 	}
 
 	@Bean
-	public SessionRepository<?> sessionRepository() {
+	public FindByIndexNameSessionRepository<?> sessionRepository() {
 		if (hazelcast4) {
 			return createHazelcast4IndexedSessionRepository();
 		}

spring-session-samples/spring-session-sample-boot-hazelcast/spring-session-sample-boot-hazelcast.gradle

@@ -3,6 +3,7 @@ apply plugin: 'io.spring.convention.spring-sample-boot'
 dependencies {
 	compile project(':spring-session-hazelcast')
 	compile "org.springframework.boot:spring-boot-starter-web"
+	compile "org.springframework.boot:spring-boot-starter-actuator"
 	compile "org.springframework.boot:spring-boot-starter-thymeleaf"
 	compile "org.springframework.boot:spring-boot-starter-security"
 	compile "com.hazelcast:hazelcast"

spring-session-samples/spring-session-sample-boot-hazelcast/src/integration-test/java/sample/BootTests.java

@@ -24,12 +24,17 @@
 import sample.pages.LoginPage;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.session.SessionsEndpoint;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.context.ApplicationContext;
+import org.springframework.session.hazelcast.HazelcastIndexedSessionRepository;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.htmlunit.webdriver.MockMvcHtmlUnitDriverBuilder;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 /**
  * @author Ellie Bahadori
  */
@@ -52,6 +57,12 @@ void tearDown() {
 		this.driver.quit();
 	}
 
+	@Test // gh-1905
+	void contextLoads(ApplicationContext context) {
+		assertThat(context.getBeansOfType(HazelcastIndexedSessionRepository.class)).hasSize(1);
+		assertThat(context.getBeansOfType(SessionsEndpoint.class)).hasSize(1);
+	}
+
 	@Test
 	void home() {
 		LoginPage login = HomePage.go(this.driver);

spring-session-samples/spring-session-sample-boot-hazelcast/src/main/resources/application.properties

@@ -1 +1,2 @@
+management.endpoints.web.exposure.include=sessions
 spring.security.user.password=password

spring-session-samples/spring-session-sample-boot-hazelcast4/spring-session-sample-boot-hazelcast4.gradle

@@ -4,6 +4,7 @@ dependencies {
 	compile project(':spring-session-hazelcast')
 	compile project(':hazelcast4')
 	compile "org.springframework.boot:spring-boot-starter-web"
+	compile "org.springframework.boot:spring-boot-starter-actuator"
 	compile "org.springframework.boot:spring-boot-starter-thymeleaf"
 	compile "org.springframework.boot:spring-boot-starter-security"
 	compile "com.hazelcast:hazelcast:4.2.2"

spring-session-samples/spring-session-sample-boot-hazelcast4/src/integration-test/java/sample/BootTests.java

@@ -24,12 +24,17 @@
 import sample.pages.LoginPage;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.session.SessionsEndpoint;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.context.ApplicationContext;
+import org.springframework.session.hazelcast.Hazelcast4IndexedSessionRepository;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.htmlunit.webdriver.MockMvcHtmlUnitDriverBuilder;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 @AutoConfigureMockMvc
 @SpringBootTest(webEnvironment = WebEnvironment.MOCK)
 class BootTests {
@@ -49,6 +54,12 @@ void tearDown() {
 		this.driver.quit();
 	}
 
+	@Test // gh-1905
+	void contextLoads(ApplicationContext context) {
+		assertThat(context.getBeansOfType(Hazelcast4IndexedSessionRepository.class)).hasSize(1);
+		assertThat(context.getBeansOfType(SessionsEndpoint.class)).hasSize(1);
+	}
+
 	@Test
 	void home() {
 		LoginPage login = HomePage.go(this.driver);

spring-session-samples/spring-session-sample-boot-hazelcast4/src/main/resources/application.properties

@@ -1 +1,2 @@
+management.endpoints.web.exposure.include=sessions
 spring.security.user.password=password