Skip to content

Commit 6a9eb77

Browse files
vpavicmhalbritter
vpavic
authored and
mhalbritter
committed
Provide an Actuator endpoint for non-indexed session repositories
At present, Actuator sessions endpoint is supported only on a Servlet stack and also requires an indexed session repository. With Spring Session moving to non-indexed session repositories as a default for some session stores, this means that sessions endpoint won't be available unless users opt into a (non-default) indexed session repository. This commit updates SessionEndpoint so that it is able to work with a non-indexed session repository. In such setup, it exposes operations for fetching session by id and deleting the session. Additionally, this also adds support for reactive stack by introducing ReactiveSessionEndpoint and its auto-configuration support. See gh-32046
1 parent a09cc22 commit 6a9eb77

File tree

10 files changed

+477
-49
lines changed

10 files changed

+477
-49
lines changed

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/session/SessionsEndpointAutoConfiguration.java

+33-6
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,24 @@
1616

1717
package org.springframework.boot.actuate.autoconfigure.session;
1818

19+
import org.springframework.beans.factory.ObjectProvider;
1920
import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint;
21+
import org.springframework.boot.actuate.session.ReactiveSessionsEndpoint;
2022
import org.springframework.boot.actuate.session.SessionsEndpoint;
2123
import org.springframework.boot.autoconfigure.AutoConfiguration;
2224
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
2325
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
2426
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
2527
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
28+
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
29+
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
2630
import org.springframework.boot.autoconfigure.session.SessionAutoConfiguration;
2731
import org.springframework.context.annotation.Bean;
32+
import org.springframework.context.annotation.Configuration;
2833
import org.springframework.session.FindByIndexNameSessionRepository;
34+
import org.springframework.session.ReactiveSessionRepository;
2935
import org.springframework.session.Session;
36+
import org.springframework.session.SessionRepository;
3037

3138
/**
3239
* {@link EnableAutoConfiguration Auto-configuration} for {@link SessionsEndpoint}.
@@ -35,15 +42,35 @@
3542
* @since 2.0.0
3643
*/
3744
@AutoConfiguration(after = SessionAutoConfiguration.class)
38-
@ConditionalOnClass(FindByIndexNameSessionRepository.class)
45+
@ConditionalOnClass(Session.class)
3946
@ConditionalOnAvailableEndpoint(endpoint = SessionsEndpoint.class)
4047
public class SessionsEndpointAutoConfiguration {
4148

42-
@Bean
43-
@ConditionalOnBean(FindByIndexNameSessionRepository.class)
44-
@ConditionalOnMissingBean
45-
public SessionsEndpoint sessionEndpoint(FindByIndexNameSessionRepository<? extends Session> sessionRepository) {
46-
return new SessionsEndpoint(sessionRepository);
49+
@Configuration(proxyBeanMethods = false)
50+
@ConditionalOnWebApplication(type = Type.SERVLET)
51+
@ConditionalOnBean(SessionRepository.class)
52+
static class ServletSessionEndpointConfiguration {
53+
54+
@Bean
55+
@ConditionalOnMissingBean
56+
SessionsEndpoint sessionEndpoint(SessionRepository<? extends Session> sessionRepository,
57+
ObjectProvider<FindByIndexNameSessionRepository<? extends Session>> indexedSessionRepository) {
58+
return new SessionsEndpoint(sessionRepository, indexedSessionRepository.getIfAvailable());
59+
}
60+
61+
}
62+
63+
@Configuration(proxyBeanMethods = false)
64+
@ConditionalOnWebApplication(type = Type.REACTIVE)
65+
@ConditionalOnBean(ReactiveSessionRepository.class)
66+
static class ReactiveSessionEndpointConfiguration {
67+
68+
@Bean
69+
@ConditionalOnMissingBean
70+
ReactiveSessionsEndpoint sessionsEndpoint(ReactiveSessionRepository<? extends Session> sessionRepository) {
71+
return new ReactiveSessionsEndpoint(sessionRepository);
72+
}
73+
4774
}
4875

4976
}

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/SessionsEndpointDocumentationTests.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ static class TestConfiguration {
125125

126126
@Bean
127127
SessionsEndpoint endpoint(FindByIndexNameSessionRepository<?> sessionRepository) {
128-
return new SessionsEndpoint(sessionRepository);
128+
return new SessionsEndpoint(sessionRepository, sessionRepository);
129129
}
130130

131131
}

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/session/SessionsEndpointAutoConfigurationTests.java

+88-23
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2023 the original author or authors.
2+
* Copyright 2012-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,14 +16,19 @@
1616

1717
package org.springframework.boot.actuate.autoconfigure.session;
1818

19+
import org.junit.jupiter.api.Nested;
1920
import org.junit.jupiter.api.Test;
2021

22+
import org.springframework.boot.actuate.session.ReactiveSessionsEndpoint;
2123
import org.springframework.boot.actuate.session.SessionsEndpoint;
2224
import org.springframework.boot.autoconfigure.AutoConfigurations;
23-
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
25+
import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner;
26+
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
2427
import org.springframework.context.annotation.Bean;
2528
import org.springframework.context.annotation.Configuration;
2629
import org.springframework.session.FindByIndexNameSessionRepository;
30+
import org.springframework.session.ReactiveSessionRepository;
31+
import org.springframework.session.SessionRepository;
2732

2833
import static org.assertj.core.api.Assertions.assertThat;
2934
import static org.mockito.Mockito.mock;
@@ -35,33 +40,93 @@
3540
*/
3641
class SessionsEndpointAutoConfigurationTests {
3742

38-
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
39-
.withConfiguration(AutoConfigurations.of(SessionsEndpointAutoConfiguration.class))
40-
.withUserConfiguration(SessionConfiguration.class);
43+
@Nested
44+
class ServletSessionEndpointConfigurationTests {
4145

42-
@Test
43-
void runShouldHaveEndpointBean() {
44-
this.contextRunner.withPropertyValues("management.endpoints.web.exposure.include=sessions")
45-
.run((context) -> assertThat(context).hasSingleBean(SessionsEndpoint.class));
46-
}
46+
private final WebApplicationContextRunner contextRunner = new WebApplicationContextRunner()
47+
.withConfiguration(AutoConfigurations.of(SessionsEndpointAutoConfiguration.class))
48+
.withUserConfiguration(IndexedSessionRepositoryConfiguration.class);
4749

48-
@Test
49-
void runWhenNotExposedShouldNotHaveEndpointBean() {
50-
this.contextRunner.run((context) -> assertThat(context).doesNotHaveBean(SessionsEndpoint.class));
51-
}
50+
@Test
51+
void runShouldHaveEndpointBean() {
52+
this.contextRunner.withPropertyValues("management.endpoints.web.exposure.include=sessions")
53+
.run((context) -> assertThat(context).hasSingleBean(SessionsEndpoint.class));
54+
}
55+
56+
@Test
57+
void runWhenNoIndexedSessionRepositoryShouldHaveEndpointBean() {
58+
new WebApplicationContextRunner()
59+
.withConfiguration(AutoConfigurations.of(SessionsEndpointAutoConfiguration.class))
60+
.withUserConfiguration(SessionRepositoryConfiguration.class)
61+
.withPropertyValues("management.endpoints.web.exposure.include=sessions")
62+
.run((context) -> assertThat(context).hasSingleBean(SessionsEndpoint.class));
63+
}
64+
65+
@Test
66+
void runWhenNotExposedShouldNotHaveEndpointBean() {
67+
this.contextRunner.run((context) -> assertThat(context).doesNotHaveBean(SessionsEndpoint.class));
68+
}
69+
70+
@Test
71+
void runWhenEnabledPropertyIsFalseShouldNotHaveEndpointBean() {
72+
this.contextRunner.withPropertyValues("management.endpoint.sessions.enabled:false")
73+
.run((context) -> assertThat(context).doesNotHaveBean(SessionsEndpoint.class));
74+
}
75+
76+
@Configuration(proxyBeanMethods = false)
77+
static class IndexedSessionRepositoryConfiguration {
78+
79+
@Bean
80+
FindByIndexNameSessionRepository<?> sessionRepository() {
81+
return mock(FindByIndexNameSessionRepository.class);
82+
}
83+
84+
}
85+
86+
@Configuration(proxyBeanMethods = false)
87+
static class SessionRepositoryConfiguration {
88+
89+
@Bean
90+
SessionRepository<?> sessionRepository() {
91+
return mock(SessionRepository.class);
92+
}
93+
94+
}
5295

53-
@Test
54-
void runWhenEnabledPropertyIsFalseShouldNotHaveEndpointBean() {
55-
this.contextRunner.withPropertyValues("management.endpoint.sessions.enabled:false")
56-
.run((context) -> assertThat(context).doesNotHaveBean(SessionsEndpoint.class));
5796
}
5897

59-
@Configuration(proxyBeanMethods = false)
60-
static class SessionConfiguration {
98+
@Nested
99+
class ReactiveSessionEndpointConfigurationTests {
100+
101+
private final ReactiveWebApplicationContextRunner contextRunner = new ReactiveWebApplicationContextRunner()
102+
.withConfiguration(AutoConfigurations.of(SessionsEndpointAutoConfiguration.class))
103+
.withUserConfiguration(ReactiveSessionRepositoryConfiguration.class);
104+
105+
@Test
106+
void runShouldHaveEndpointBean() {
107+
this.contextRunner.withPropertyValues("management.endpoints.web.exposure.include=sessions")
108+
.run((context) -> assertThat(context).hasSingleBean(ReactiveSessionsEndpoint.class));
109+
}
110+
111+
@Test
112+
void runWhenNotExposedShouldNotHaveEndpointBean() {
113+
this.contextRunner.run((context) -> assertThat(context).doesNotHaveBean(ReactiveSessionsEndpoint.class));
114+
}
115+
116+
@Test
117+
void runWhenEnabledPropertyIsFalseShouldNotHaveEndpointBean() {
118+
this.contextRunner.withPropertyValues("management.endpoint.sessions.enabled:false")
119+
.run((context) -> assertThat(context).doesNotHaveBean(ReactiveSessionsEndpoint.class));
120+
}
121+
122+
@Configuration(proxyBeanMethods = false)
123+
static class ReactiveSessionRepositoryConfiguration {
124+
125+
@Bean
126+
ReactiveSessionRepository<?> sessionRepository() {
127+
return mock(ReactiveSessionRepository.class);
128+
}
61129

62-
@Bean
63-
FindByIndexNameSessionRepository<?> sessionRepository() {
64-
return mock(FindByIndexNameSessionRepository.class);
65130
}
66131

67132
}

‎spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/session/ReactiveSessionsEndpoint.java

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.session;
18+
19+
import reactor.core.publisher.Mono;
20+
21+
import org.springframework.boot.actuate.endpoint.annotation.DeleteOperation;
22+
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
23+
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
24+
import org.springframework.boot.actuate.endpoint.annotation.Selector;
25+
import org.springframework.session.ReactiveSessionRepository;
26+
import org.springframework.session.Session;
27+
import org.springframework.util.Assert;
28+
29+
/**
30+
* {@link Endpoint @Endpoint} to expose information about HTTP {@link Session}s on a
31+
* reactive stack.
32+
*
33+
* @author Vedran Pavic
34+
* @since 3.0.0
35+
*/
36+
@Endpoint(id = "sessions")
37+
public class ReactiveSessionsEndpoint {
38+
39+
private final ReactiveSessionRepository<? extends Session> sessionRepository;
40+
41+
/**
42+
* Create a new {@link ReactiveSessionsEndpoint} instance.
43+
* @param sessionRepository the session repository
44+
*/
45+
public ReactiveSessionsEndpoint(ReactiveSessionRepository<? extends Session> sessionRepository) {
46+
Assert.notNull(sessionRepository, "ReactiveSessionRepository must not be null");
47+
this.sessionRepository = sessionRepository;
48+
}
49+
50+
@ReadOperation
51+
public Mono<SessionDescriptor> getSession(@Selector String sessionId) {
52+
return this.sessionRepository.findById(sessionId).map(SessionDescriptor::new);
53+
}
54+
55+
@DeleteOperation
56+
public Mono<Void> deleteSession(@Selector String sessionId) {
57+
return this.sessionRepository.deleteById(sessionId);
58+
}
59+
60+
}

‎spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/session/SessionDescriptor.java

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.session;
18+
19+
import java.time.Instant;
20+
import java.util.Set;
21+
22+
import org.springframework.session.Session;
23+
24+
/**
25+
* A description of user's {@link Session session} exposed by {@code sessions} endpoint.
26+
* Primarily intended for serialization to JSON.
27+
*
28+
* @author Vedran Pavic
29+
* @since 3.0.0
30+
*/
31+
public final class SessionDescriptor {
32+
33+
private final String id;
34+
35+
private final Set<String> attributeNames;
36+
37+
private final Instant creationTime;
38+
39+
private final Instant lastAccessedTime;
40+
41+
private final long maxInactiveInterval;
42+
43+
private final boolean expired;
44+
45+
SessionDescriptor(Session session) {
46+
this.id = session.getId();
47+
this.attributeNames = session.getAttributeNames();
48+
this.creationTime = session.getCreationTime();
49+
this.lastAccessedTime = session.getLastAccessedTime();
50+
this.maxInactiveInterval = session.getMaxInactiveInterval().getSeconds();
51+
this.expired = session.isExpired();
52+
}
53+
54+
public String getId() {
55+
return this.id;
56+
}
57+
58+
public Set<String> getAttributeNames() {
59+
return this.attributeNames;
60+
}
61+
62+
public Instant getCreationTime() {
63+
return this.creationTime;
64+
}
65+
66+
public Instant getLastAccessedTime() {
67+
return this.lastAccessedTime;
68+
}
69+
70+
public long getMaxInactiveInterval() {
71+
return this.maxInactiveInterval;
72+
}
73+
74+
public boolean isExpired() {
75+
return this.expired;
76+
}
77+
78+
}

0 commit comments

Comments
 (0)