Improve stdio transport validation and function naming (#365)

## Summary
- Add validation that URL must be empty for stdio transport types
- Rename `validateTransport` to `validateRemoteTransport` for better
clarity
- Update corresponding test case to expect error when stdio transport
has URL

## Context
This addresses two specific feedback comments from @domdomegg on PR
#345:
1. "do we want to validate the the url _is_ empty?" - Now validates URL
is empty for stdio
2. "maybe rename validateRemoteTransport or something?" - Renamed
function for clarity

The changes enforce stricter validation while improving code readability
through better naming.
This commit is contained in:
adam jones 2025-09-06 00:51:23 +01:00 • committed by GitHub
commit e9884c1d7b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 10 deletions

View file

@ -34,7 +34,7 @@ func ValidateServerJSON(serverJSON *apiv0.ServerJSON) error {
// Validate all remotes // Validate all remotes
for _, remote := range serverJSON.Remotes { for _, remote := range serverJSON.Remotes {
if err := validateTransport(&remote); err != nil { if err := validateRemoteTransport(&remote); err != nil {
return err return err
} }
} }
@ -178,7 +178,10 @@ func validatePackageTransport(transport *model.Transport, availableVariables []s
// Validate transport type is supported // Validate transport type is supported
switch transport.Type { switch transport.Type {
case model.TransportTypeStdio: case model.TransportTypeStdio:
// No additional validation needed for stdio - URL should be empty // Validate that URL is empty for stdio transport
if transport.URL != "" {
return fmt.Errorf("url must be empty for %s transport type, got: %s", transport.Type, transport.URL)
}
return nil return nil
case model.TransportTypeStreamableHTTP, model.TransportTypeSSE: case model.TransportTypeStreamableHTTP, model.TransportTypeSSE:
// URL is required for streamable-http and sse // URL is required for streamable-http and sse
@ -201,8 +204,8 @@ func validatePackageTransport(transport *model.Transport, availableVariables []s
} }
} }
// validateTransport validates a remote transport (no templating allowed) // validateRemoteTransport validates a remote transport (no templating allowed)
func validateTransport(obj *model.Transport) error { func validateRemoteTransport(obj *model.Transport) error {
// Validate transport type is supported - remotes only support streamable-http and sse // Validate transport type is supported - remotes only support streamable-http and sse
switch obj.Type { switch obj.Type {
case model.TransportTypeStreamableHTTP, model.TransportTypeSSE: case model.TransportTypeStreamableHTTP, model.TransportTypeSSE:

View file

@ -832,7 +832,7 @@ func TestValidate_TransportValidation(t *testing.T) {
}{ }{
// Package transport tests - stdio (no URL required) // Package transport tests - stdio (no URL required)
{ {
name: "package transport stdio without URL", name: "package transport stdio without URL should pass",
serverDetail: apiv0.ServerJSON{ serverDetail: apiv0.ServerJSON{
Name: "com.example/test-server", Name: "com.example/test-server",
Description: "A test server", Description: "A test server",
@ -852,7 +852,7 @@ func TestValidate_TransportValidation(t *testing.T) {
expectedError: "", expectedError: "",
}, },
{ {
name: "package transport stdio with URL (should still work)", name: "package transport stdio with URL (should fail)",
serverDetail: apiv0.ServerJSON{ serverDetail: apiv0.ServerJSON{
Name: "com.example/test-server", Name: "com.example/test-server",
Description: "A test server", Description: "A test server",
@ -870,7 +870,7 @@ func TestValidate_TransportValidation(t *testing.T) {
}, },
}, },
}, },
expectedError: "", expectedError: "url must be empty for stdio transport type",
}, },
// Package transport tests - streamable-http (URL required) // Package transport tests - streamable-http (URL required)
{ {
@ -1270,9 +1270,9 @@ func createValidServerWithArgument(arg model.Argument) apiv0.ServerJSON {
}, },
Packages: []model.Package{ Packages: []model.Package{
{ {
Identifier: "test-package", Identifier: "test-package",
RegistryType: "npm", RegistryType: "npm",
RegistryBaseURL: "https://registry.npmjs.org", RegistryBaseURL: "https://registry.npmjs.org",
Transport: model.Transport{ Transport: model.Transport{
Type: "stdio", Type: "stdio",
}, },