Add ability for client to resume session (#1029)
This commit is contained in:
Stephen Halter
GitHub
parent
979befdd14
commit
7f25ae9d2a
2 changed files with 433 additions and 3 deletions
|
|
@ -2,7 +2,11 @@
|
|||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Primitives;
|
||||
using ModelContextProtocol.Client;
|
||||
using ModelContextProtocol.Protocol;
|
||||
using ModelContextProtocol.Server;
|
||||
using System.Collections.Concurrent;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
namespace ModelContextProtocol.AspNetCore.Tests;
|
||||
|
||||
|
|
@ -188,4 +192,95 @@ public class MapMcpStreamableHttpTests(ITestOutputHelper outputHelper) : MapMcpT
|
|||
Assert.True(protocolVersionHeaderValues.Count > 1);
|
||||
Assert.All(protocolVersionHeaderValues, v => Assert.Equal("2025-03-26", v));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CanResumeSessionWithMapMcpAndRunSessionHandler()
|
||||
{
|
||||
Assert.SkipWhen(Stateless, "Session resumption relies on server-side session tracking.");
|
||||
|
||||
var runSessionCount = 0;
|
||||
var serverTcs = new TaskCompletionSource<McpServer>(TaskCreationOptions.RunContinuationsAsynchronously);
|
||||
|
||||
Builder.Services.AddMcpServer(options =>
|
||||
{
|
||||
options.ServerInfo = new Implementation
|
||||
{
|
||||
Name = "ResumeServer",
|
||||
Version = "1.0.0",
|
||||
};
|
||||
}).WithHttpTransport(opts =>
|
||||
{
|
||||
ConfigureStateless(opts);
|
||||
opts.RunSessionHandler = async (context, server, cancellationToken) =>
|
||||
{
|
||||
Interlocked.Increment(ref runSessionCount);
|
||||
serverTcs.TrySetResult(server);
|
||||
await server.RunAsync(cancellationToken);
|
||||
};
|
||||
}).WithTools<EchoHttpContextUserTools>();
|
||||
|
||||
await using var app = Builder.Build();
|
||||
app.MapMcp();
|
||||
await app.StartAsync(TestContext.Current.CancellationToken);
|
||||
|
||||
ServerCapabilities? serverCapabilities = null;
|
||||
Implementation? serverInfo = null;
|
||||
string? serverInstructions = null;
|
||||
string? negotiatedProtocolVersion = null;
|
||||
string? resumedSessionId = null;
|
||||
|
||||
await using var initialTransport = new HttpClientTransport(new()
|
||||
{
|
||||
Endpoint = new("http://localhost:5000/"),
|
||||
TransportMode = HttpTransportMode.StreamableHttp,
|
||||
OwnsSession = false,
|
||||
}, HttpClient, LoggerFactory);
|
||||
|
||||
await using (var initialClient = await McpClient.CreateAsync(initialTransport, loggerFactory: LoggerFactory, cancellationToken: TestContext.Current.CancellationToken))
|
||||
{
|
||||
resumedSessionId = initialClient.SessionId ?? throw new InvalidOperationException("SessionId not negotiated.");
|
||||
serverCapabilities = initialClient.ServerCapabilities;
|
||||
serverInfo = initialClient.ServerInfo;
|
||||
serverInstructions = initialClient.ServerInstructions;
|
||||
negotiatedProtocolVersion = initialClient.NegotiatedProtocolVersion;
|
||||
|
||||
await initialClient.ListToolsAsync(cancellationToken: TestContext.Current.CancellationToken);
|
||||
}
|
||||
|
||||
Assert.NotNull(serverCapabilities);
|
||||
Assert.NotNull(serverInfo);
|
||||
Assert.False(string.IsNullOrEmpty(resumedSessionId));
|
||||
|
||||
await serverTcs.Task.WaitAsync(TimeSpan.FromSeconds(5), TestContext.Current.CancellationToken);
|
||||
|
||||
await using var resumeTransport = new HttpClientTransport(new()
|
||||
{
|
||||
Endpoint = new("http://localhost:5000/"),
|
||||
TransportMode = HttpTransportMode.StreamableHttp,
|
||||
KnownSessionId = resumedSessionId!,
|
||||
}, HttpClient, LoggerFactory);
|
||||
|
||||
var resumeOptions = new ResumeClientSessionOptions
|
||||
{
|
||||
ServerCapabilities = serverCapabilities!,
|
||||
ServerInfo = serverInfo!,
|
||||
ServerInstructions = serverInstructions,
|
||||
NegotiatedProtocolVersion = negotiatedProtocolVersion,
|
||||
};
|
||||
|
||||
await using (var resumedClient = await McpClient.ResumeSessionAsync(
|
||||
resumeTransport,
|
||||
resumeOptions,
|
||||
loggerFactory: LoggerFactory,
|
||||
cancellationToken: TestContext.Current.CancellationToken))
|
||||
{
|
||||
var tools = await resumedClient.ListToolsAsync(cancellationToken: TestContext.Current.CancellationToken);
|
||||
Assert.NotEmpty(tools);
|
||||
|
||||
Assert.Equal(serverInstructions, resumedClient.ServerInstructions);
|
||||
Assert.Equal(negotiatedProtocolVersion, resumedClient.NegotiatedProtocolVersion);
|
||||
}
|
||||
|
||||
Assert.Equal(1, runSessionCount);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ using ModelContextProtocol.AspNetCore.Tests.Utils;
|
|||
using ModelContextProtocol.Client;
|
||||
using ModelContextProtocol.Protocol;
|
||||
using ModelContextProtocol.Server;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization.Metadata;
|
||||
|
||||
|
|
@ -107,6 +109,22 @@ public class StreamableHttpClientConformanceTests(ITestOutputHelper outputHelper
|
|||
await _app.StartAsync(TestContext.Current.CancellationToken);
|
||||
}
|
||||
|
||||
private async Task<ResumeTestServer> StartResumeServerAsync(string expectedSessionId)
|
||||
{
|
||||
Builder.Services.Configure<JsonOptions>(options =>
|
||||
{
|
||||
options.SerializerOptions.TypeInfoResolverChain.Add(McpJsonUtilities.DefaultOptions.TypeInfoResolver!);
|
||||
});
|
||||
|
||||
_app = Builder.Build();
|
||||
|
||||
var resumeServer = new ResumeTestServer(expectedSessionId);
|
||||
resumeServer.MapEndpoints(_app);
|
||||
|
||||
await _app.StartAsync(TestContext.Current.CancellationToken);
|
||||
return resumeServer;
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CanCallToolOnSessionlessStreamableHttpServer()
|
||||
{
|
||||
|
|
@ -174,6 +192,94 @@ public class StreamableHttpClientConformanceTests(ITestOutputHelper outputHelper
|
|||
Assert.Equal("test-session-123", sessionId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task DoesNotSendDeleteWhenTransportDoesNotOwnSession()
|
||||
{
|
||||
await StartAsync(enableDelete: true);
|
||||
|
||||
await using var transport = new HttpClientTransport(new()
|
||||
{
|
||||
Endpoint = new("http://localhost:5000/mcp"),
|
||||
TransportMode = HttpTransportMode.StreamableHttp,
|
||||
OwnsSession = false,
|
||||
}, HttpClient, LoggerFactory);
|
||||
|
||||
await using (await McpClient.CreateAsync(transport, loggerFactory: LoggerFactory, cancellationToken: TestContext.Current.CancellationToken))
|
||||
{
|
||||
// No-op. Disposing the client should not trigger a DELETE request.
|
||||
}
|
||||
|
||||
Assert.Empty(_deleteRequestSessionIds);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task ResumeSessionStartsGetImmediately()
|
||||
{
|
||||
const string sessionId = "resume-session-123";
|
||||
const string resumeInstructions = "Use cached instructions";
|
||||
const string resumeProtocolVersion = "2025-06-18";
|
||||
var resumeServer = await StartResumeServerAsync(sessionId);
|
||||
|
||||
await using var transport = new HttpClientTransport(new()
|
||||
{
|
||||
Endpoint = new("http://localhost:5000/mcp"),
|
||||
TransportMode = HttpTransportMode.StreamableHttp,
|
||||
KnownSessionId = sessionId,
|
||||
}, HttpClient, LoggerFactory);
|
||||
|
||||
var serverCapabilities = new ServerCapabilities
|
||||
{
|
||||
Tools = new(),
|
||||
};
|
||||
var resumeOptions = new ResumeClientSessionOptions
|
||||
{
|
||||
ServerCapabilities = serverCapabilities,
|
||||
ServerInfo = new Implementation { Name = "resume-server", Version = "1.0.0" },
|
||||
ServerInstructions = resumeInstructions,
|
||||
NegotiatedProtocolVersion = resumeProtocolVersion,
|
||||
};
|
||||
|
||||
await using (var client = await McpClient.ResumeSessionAsync(
|
||||
transport,
|
||||
resumeOptions,
|
||||
loggerFactory: LoggerFactory,
|
||||
cancellationToken: TestContext.Current.CancellationToken))
|
||||
{
|
||||
var observedSessionId = await resumeServer.GetStarted.WaitAsync(TimeSpan.FromSeconds(5), TestContext.Current.CancellationToken);
|
||||
Assert.Equal(sessionId, observedSessionId);
|
||||
|
||||
var tools = await client.ListToolsAsync(cancellationToken: TestContext.Current.CancellationToken);
|
||||
var tool = Assert.Single(tools);
|
||||
Assert.Equal("resume-echo", tool.Name);
|
||||
|
||||
Assert.Equal(sessionId, Assert.Single(resumeServer.PostSessionIds));
|
||||
Assert.Same(serverCapabilities, client.ServerCapabilities);
|
||||
Assert.Same(resumeOptions.ServerInfo, client.ServerInfo);
|
||||
Assert.Equal(resumeInstructions, client.ServerInstructions);
|
||||
Assert.Equal(resumeProtocolVersion, client.NegotiatedProtocolVersion);
|
||||
}
|
||||
|
||||
Assert.Equal(sessionId, Assert.Single(resumeServer.DeleteSessionIds));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task CreateAsyncWithKnownSessionIdThrows()
|
||||
{
|
||||
await StartAsync();
|
||||
|
||||
await using var transport = new HttpClientTransport(new()
|
||||
{
|
||||
Endpoint = new("http://localhost:5000/mcp"),
|
||||
TransportMode = HttpTransportMode.StreamableHttp,
|
||||
KnownSessionId = "already-initialized",
|
||||
}, HttpClient, LoggerFactory);
|
||||
|
||||
var exception = await Assert.ThrowsAsync<InvalidOperationException>(() =>
|
||||
McpClient.CreateAsync(transport, loggerFactory: LoggerFactory, cancellationToken: TestContext.Current.CancellationToken));
|
||||
|
||||
Assert.Contains(nameof(McpClient.ResumeSessionAsync), exception.Message);
|
||||
}
|
||||
|
||||
private static async Task CallEchoAndValidateAsync(McpClientTool echoTool)
|
||||
{
|
||||
var response = await echoTool.CallAsync(new Dictionary<string, object?>() { ["message"] = "Hello world!" }, cancellationToken: TestContext.Current.CancellationToken);
|
||||
|
|
@ -198,4 +304,98 @@ public class StreamableHttpClientConformanceTests(ITestOutputHelper outputHelper
|
|||
{
|
||||
return message;
|
||||
}
|
||||
|
||||
private sealed class ResumeTestServer
|
||||
{
|
||||
private static readonly Tool ResumeTool = new()
|
||||
{
|
||||
Name = "resume-echo",
|
||||
Description = "Echoes the provided message.",
|
||||
};
|
||||
|
||||
private readonly string _expectedSessionId;
|
||||
private readonly TaskCompletionSource<string> _getStarted = new(TaskCreationOptions.RunContinuationsAsynchronously);
|
||||
private readonly List<string> _postSessionIds = [];
|
||||
private readonly List<string> _deleteSessionIds = [];
|
||||
|
||||
public ResumeTestServer(string expectedSessionId)
|
||||
{
|
||||
_expectedSessionId = expectedSessionId;
|
||||
}
|
||||
|
||||
public Task<string> GetStarted => _getStarted.Task;
|
||||
public IReadOnlyList<string> PostSessionIds => _postSessionIds;
|
||||
public IReadOnlyList<string> DeleteSessionIds => _deleteSessionIds;
|
||||
|
||||
public void MapEndpoints(WebApplication app)
|
||||
{
|
||||
app.MapGet("/mcp", HandleGetAsync);
|
||||
app.MapPost("/mcp", HandlePostAsync);
|
||||
app.MapDelete("/mcp", HandleDeleteAsync);
|
||||
}
|
||||
|
||||
private async Task HandleGetAsync(HttpContext context)
|
||||
{
|
||||
var sessionId = context.Request.Headers["mcp-session-id"].ToString();
|
||||
if (!string.Equals(sessionId, _expectedSessionId, StringComparison.Ordinal))
|
||||
{
|
||||
context.Response.StatusCode = StatusCodes.Status404NotFound;
|
||||
return;
|
||||
}
|
||||
|
||||
context.Response.Headers.ContentType = "text/event-stream";
|
||||
_getStarted.TrySetResult(sessionId);
|
||||
await context.Response.Body.FlushAsync();
|
||||
|
||||
try
|
||||
{
|
||||
await Task.Delay(Timeout.Infinite, context.RequestAborted);
|
||||
}
|
||||
catch (OperationCanceledException)
|
||||
{
|
||||
}
|
||||
}
|
||||
|
||||
private async Task HandlePostAsync(HttpContext context)
|
||||
{
|
||||
var sessionId = context.Request.Headers["mcp-session-id"].ToString();
|
||||
_postSessionIds.Add(sessionId);
|
||||
|
||||
if (!string.Equals(sessionId, _expectedSessionId, StringComparison.Ordinal))
|
||||
{
|
||||
context.Response.StatusCode = StatusCodes.Status404NotFound;
|
||||
return;
|
||||
}
|
||||
|
||||
var request = await context.Request.ReadFromJsonAsync(GetJsonTypeInfo<JsonRpcRequest>(), context.RequestAborted);
|
||||
if (request is null)
|
||||
{
|
||||
context.Response.StatusCode = StatusCodes.Status400BadRequest;
|
||||
return;
|
||||
}
|
||||
|
||||
if (request.Method == RequestMethods.ToolsList)
|
||||
{
|
||||
var response = new JsonRpcResponse
|
||||
{
|
||||
Id = request.Id,
|
||||
Result = JsonSerializer.SerializeToNode(new ListToolsResult
|
||||
{
|
||||
Tools = [ResumeTool],
|
||||
}, McpJsonUtilities.DefaultOptions),
|
||||
};
|
||||
|
||||
await context.Response.WriteAsJsonAsync(response, cancellationToken: context.RequestAborted);
|
||||
return;
|
||||
}
|
||||
|
||||
context.Response.StatusCode = StatusCodes.Status202Accepted;
|
||||
}
|
||||
|
||||
private Task HandleDeleteAsync(HttpContext context)
|
||||
{
|
||||
_deleteSessionIds.Add(context.Request.Headers["mcp-session-id"].ToString());
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue