Skip to content

feat: mvc sse session support session timeout configuration #719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
taobaorun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: mvc sse session support session timeout configuration #719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions .../main/java/io/modelcontextprotocol/server/transport/WebMvcSseServerTransportProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,11 @@ public class WebMvcSseServerTransportProvider implements McpServerTransportProvi

private KeepAliveScheduler keepAliveScheduler;

/**
* sse session timeout
*/
private final Duration sessionTimeout;

/**
* Constructs a new WebMvcSseServerTransportProvider instance.
* @param jsonMapper The McpJsonMapper to use for JSON serialization/deserialization
Expand All @@ -135,18 +140,20 @@ public class WebMvcSseServerTransportProvider implements McpServerTransportProvi
*/
private WebMvcSseServerTransportProvider(McpJsonMapper jsonMapper, String baseUrl, String messageEndpoint,
String sseEndpoint, Duration keepAliveInterval,
McpTransportContextExtractor<ServerRequest> contextExtractor) {
McpTransportContextExtractor<ServerRequest> contextExtractor, Duration sessionTimeout) {
Assert.notNull(jsonMapper, "McpJsonMapper must not be null");
Assert.notNull(baseUrl, "Message base URL must not be null");
Assert.notNull(messageEndpoint, "Message endpoint must not be null");
Assert.notNull(sseEndpoint, "SSE endpoint must not be null");
Assert.notNull(contextExtractor, "Context extractor must not be null");
Assert.notNull(sessionTimeout, "Session timeout must not be null");

this.jsonMapper = jsonMapper;
this.baseUrl = baseUrl;
this.messageEndpoint = messageEndpoint;
this.sseEndpoint = sseEndpoint;
this.contextExtractor = contextExtractor;
this.sessionTimeout = sessionTimeout;
this.routerFunction = RouterFunctions.route()
.GET(this.sseEndpoint, this::handleSseConnection)
.POST(this.messageEndpoint, this::handleMessage)
Expand Down Expand Up @@ -279,7 +286,7 @@ private ServerResponse handleSseConnection(ServerRequest request) {
this.sessions.remove(sessionId);
sseBuilder.error(e);
}
}, Duration.ZERO);
}, this.sessionTimeout);
}

/**
Expand Down Expand Up @@ -471,6 +478,8 @@ public static class Builder {

private Duration keepAliveInterval;

private Duration sessionTimeout = Duration.ZERO;

private McpTransportContextExtractor<ServerRequest> contextExtractor = (
serverRequest) -> McpTransportContext.EMPTY;

Expand Down Expand Up @@ -549,6 +558,11 @@ public Builder contextExtractor(McpTransportContextExtractor<ServerRequest> cont
return this;
}

public Builder sessionTimeout(Duration sessionTimeout) {
this.sessionTimeout = sessionTimeout;
return this;
}

/**
* Builds a new instance of WebMvcSseServerTransportProvider with the configured
* settings.
Expand All @@ -560,7 +574,7 @@ public WebMvcSseServerTransportProvider build() {
throw new IllegalStateException("MessageEndpoint must be set");
}
return new WebMvcSseServerTransportProvider(jsonMapper == null ? McpJsonMapper.getDefault() : jsonMapper,
baseUrl, messageEndpoint, sseEndpoint, keepAliveInterval, contextExtractor);
baseUrl, messageEndpoint, sseEndpoint, keepAliveInterval, contextExtractor, sessionTimeout);
}

}
Expand Down
6 changes: 5 additions & 1 deletion .../java/io/modelcontextprotocol/server/transport/WebMvcSseServerTransportProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
import org.springframework.web.servlet.function.RouterFunction;
import org.springframework.web.servlet.function.ServerResponse;

import java.time.Duration;
import java.util.concurrent.TimeUnit;

import static org.assertj.core.api.Assertions.assertThat;

/**
Expand Down Expand Up @@ -66,7 +69,7 @@ public void before() {
}

@Test
void validBaseUrl() {
void validBaseUrl() throws InterruptedException {
McpServer.async(mcpServerTransportProvider).serverInfo("test-server", "1.0.0").build();
try (var client = clientBuilder.clientInfo(new McpSchema.Implementation("Sample " + "client", "0.0.0"))
.build()) {
Expand Down Expand Up @@ -106,6 +109,7 @@ public WebMvcSseServerTransportProvider webMvcSseServerTransportProvider() {
.sseEndpoint(WebMvcSseServerTransportProvider.DEFAULT_SSE_ENDPOINT)
.jsonMapper(McpJsonMapper.getDefault())
.contextExtractor(req -> McpTransportContext.EMPTY)
.sessionTimeout(Duration.ofSeconds(1))
.build();
}

Expand Down