mcp: fix flaky ExampleLoggingTransport (#483)

Reads are technically racy with writes. Sort for stability.
This commit is contained in:
Robert Findley 2025-09-18 08:30:53 -04:00 • committed by GitHub
commit b636b1633b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 17 additions and 6 deletions

View file

@ -39,12 +39,15 @@ func ExampleLoggingTransport() {
if _, err := client.Connect(ctx, logTransport, nil); err != nil {
log.Fatal(err)
}
fmt.Println(b.String())
// Output:
// write: {"jsonrpc":"2.0","id":1,"method":"initialize","params":{"capabilities":{"roots":{"listChanged":true}},"clientInfo":{"name":"client","version":"v0.0.1"},"protocolVersion":"2025-06-18"}}
// read: {"jsonrpc":"2.0","id":1,"result":{"capabilities":{"logging":{}},"protocolVersion":"2025-06-18","serverInfo":{"name":"server","version":"v0.0.1"}}}
// write: {"jsonrpc":"2.0","method":"notifications/initialized","params":{}}
// Sort for stability: reads are concurrent to writes.
for _, line := range slices.Sorted(strings.SplitSeq(b.String(), "\n")) {
fmt.Println(line)
}
// Output:
// read: {"jsonrpc":"2.0","id":1,"result":{"capabilities":{"logging":{}},"protocolVersion":"2025-06-18","serverInfo":{"name":"server","version":"v0.0.1"}}}
// write: {"jsonrpc":"2.0","id":1,"method":"initialize","params":{"capabilities":{"roots":{"listChanged":true}},"clientInfo":{"name":"client","version":"v0.0.1"},"protocolVersion":"2025-06-18"}}
// write: {"jsonrpc":"2.0","method":"notifications/initialized","params":{}}
}
```

View file

@ -2,6 +2,9 @@
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file.
// Uses strings.SplitSeq.
//go:build go1.24
package mcp_test
import (
@ -9,6 +12,8 @@ import (
"context"
"fmt"
"log"
"slices"
"strings"
"github.com/modelcontextprotocol/go-sdk/mcp"
)
@ -29,12 +34,15 @@ func ExampleLoggingTransport() {
if _, err := client.Connect(ctx, logTransport, nil); err != nil {
log.Fatal(err)
}
fmt.Println(b.String())
// Output:
// write: {"jsonrpc":"2.0","id":1,"method":"initialize","params":{"capabilities":{"roots":{"listChanged":true}},"clientInfo":{"name":"client","version":"v0.0.1"},"protocolVersion":"2025-06-18"}}
// read: {"jsonrpc":"2.0","id":1,"result":{"capabilities":{"logging":{}},"protocolVersion":"2025-06-18","serverInfo":{"name":"server","version":"v0.0.1"}}}
// write: {"jsonrpc":"2.0","method":"notifications/initialized","params":{}}
// Sort for stability: reads are concurrent to writes.
for _, line := range slices.Sorted(strings.SplitSeq(b.String(), "\n")) {
fmt.Println(line)
}
// Output:
// read: {"jsonrpc":"2.0","id":1,"result":{"capabilities":{"logging":{}},"protocolVersion":"2025-06-18","serverInfo":{"name":"server","version":"v0.0.1"}}}
// write: {"jsonrpc":"2.0","id":1,"method":"initialize","params":{"capabilities":{"roots":{"listChanged":true}},"clientInfo":{"name":"client","version":"v0.0.1"},"protocolVersion":"2025-06-18"}}
// write: {"jsonrpc":"2.0","method":"notifications/initialized","params":{}}
}
// !-loggingtransport