Skip to content

Refactor schema validation error construction to remove duplicated invariant arguments #8955

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

Merged
lpcox merged 2 commits into from
Jul 8, 2026
Merged

Refactor schema validation error construction to remove duplicated invariant arguments #8955

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1aa3c24
Initial plan
Copilot Jul 8, 2026
3fa0267
refactor: deduplicate schema validation error construction
Copilot Jul 8, 2026
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
33 changes: 17 additions & 16 deletions internal/config/validation_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ func validateCustomServerConfig(name string, server *StdinServerConfig, customSc

// validateAgainstCustomSchema fetches and validates a server config against its custom schema
func validateAgainstCustomSchema(name string, server *StdinServerConfig, schemaURL string, jsonPath string) error {
schemaErr := func(message, hint string) error {
return SchemaValidationError(server.Type, message, jsonPath, hint)
}

if cachedSchema, ok := customSchemaCache.Load(schemaURL); ok {
if schema, ok := cachedSchema.(*jsonschema.Schema); ok {
logValidation.Printf("Using cached custom schema: name=%s, url=%s", name, schemaURL)
Expand All @@ -241,9 +245,8 @@ func validateAgainstCustomSchema(name string, server *StdinServerConfig, schemaU
schemaJSON, err := fetchSchema(schemaURL)
if err != nil {
logValidation.Printf("Failed to fetch custom schema: name=%s, url=%s, error=%v", name, schemaURL, err)
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("failed to fetch custom schema: %v", err),
jsonPath,
fmt.Sprintf("Ensure the schema URL '%s' is accessible and returns a valid JSON Schema", schemaURL))
}

Expand All @@ -252,9 +255,8 @@ func validateAgainstCustomSchema(name string, server *StdinServerConfig, schemaU
// Parse the schema JSON into a document
schemaDoc, parseErr := jsonschema.UnmarshalJSON(bytes.NewReader(schemaJSON))
if parseErr != nil {
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("failed to parse custom schema: %v", parseErr),
jsonPath,
fmt.Sprintf("The schema at '%s' must be valid JSON", schemaURL))
}

Expand All @@ -271,25 +273,22 @@ func validateAgainstCustomSchema(name string, server *StdinServerConfig, schemaU

// Add the schema with the fetch URL
if err := compiler.AddResource(schemaURL, schemaDoc); err != nil {
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("failed to compile custom schema: %v", err),
jsonPath,
fmt.Sprintf("The schema at '%s' must be a valid JSON Schema document", schemaURL))
}
if schemaID != schemaURL {
if err := compiler.AddResource(schemaID, schemaDoc); err != nil {
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("failed to compile custom schema with $id: %v", err),
jsonPath,
fmt.Sprintf("Check the $id field in the schema at '%s'", schemaURL))
}
}

schema, err := compiler.Compile(schemaID)
if err != nil {
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("failed to compile custom schema: %v", err),
jsonPath,
fmt.Sprintf("The schema at '%s' must be a valid JSON Schema Draft 7 document", schemaURL))
}

Expand All @@ -302,6 +301,9 @@ func validateAgainstCustomSchema(name string, server *StdinServerConfig, schemaU
// validateServerAgainstSchema validates a server config map (including additional
// properties) against a compiled custom schema.
func validateServerAgainstSchema(name string, server *StdinServerConfig, schema *jsonschema.Schema, schemaURL string, jsonPath string) error {
schemaErr := func(message, hint string) error {
return SchemaValidationError(server.Type, message, jsonPath, hint)
}

// Convert server config to a map that includes both struct fields and additional properties
// This ensures custom fields are validated against the custom schema
Expand All @@ -310,16 +312,16 @@ func validateServerAgainstSchema(name string, server *StdinServerConfig, schema
// Marshal the struct to JSON first
serverJSON, err := json.Marshal(server)
if err != nil {
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("failed to marshal server config for validation: %v", err),
jsonPath, "Internal error - please report this issue")
"Internal error - please report this issue")
}

// Unmarshal to map to get struct fields
if err := json.Unmarshal(serverJSON, &serverMap); err != nil {
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("failed to unmarshal server config for validation: %v", err),
jsonPath, "Internal error - please report this issue")
"Internal error - please report this issue")
}

// Merge additional properties (custom fields) into the map
Expand All @@ -330,9 +332,8 @@ func validateServerAgainstSchema(name string, server *StdinServerConfig, schema
// Validate the merged map against the custom schema
if err := schema.Validate(serverMap); err != nil {
logValidation.Printf("Custom schema validation failed: name=%s, error=%v", name, err)
return SchemaValidationError(server.Type,
return schemaErr(
fmt.Sprintf("server configuration does not match custom schema: %v", err),
jsonPath,
fmt.Sprintf("Update the server configuration to match the schema requirements at '%s'", schemaURL))
}

Expand Down
Loading