Skip to content

Conversation

@dmjb
Copy link
Member

@dmjb dmjb commented Jan 28, 2026

Summary

This PR consolidates registry configuration logic into a service layer and improves error handling in both the API and CLI with proper HTTP status codes and user-friendly messages.

This is part 2 of 3 PRs that improve registry API error handling:

  1. Add registry validation and structured errors #3479 - Add validation infrastructure and error types
  2. This PR: Introduce service layer and improve API/CLI error handling
  3. Update E2E tests

Depends on: #3479 (builds on structured error types)

Changes

Service Layer

  • New: RegistryConfigService interface (pkg/config/registry_service.go)
    • Consolidates registry configuration operations
    • SetRegistryFromInput(): Auto-detects registry type (URL/API/File)
    • UnsetRegistry(): Resets to default registry
    • GetRegistryInfo(): Returns current registry configuration
  • Add comprehensive service tests (pkg/config/registry_service_test.go)
  • Generate mocks for testing (pkg/config/mocks/mock_registry_service.go)

API Layer (pkg/api/v1/registry.go)

  • Map errors to proper HTTP status codes:
    • 502 Bad Gateway: Validation errors (invalid JSON, missing servers)
    • 504 Gateway Timeout: Connectivity/timeout errors (unreachable hosts)
    • 400 Bad Request: Invalid request format
  • Add isConnectivityError() and isValidationError() helpers
  • Refactor updateRegistry() to use RegistryConfigService
  • Add timeout integration tests (pkg/api/v1/registry_timeout_test.go)

CLI Layer (cmd/thv/app/config.go)

  • Use RegistryConfigService for cleaner, more maintainable code
  • Add enhanceRegistryError() for user-friendly error messages with actionable hints
  • Map error types to match API behavior (504 for timeout, 502 for validation)
  • Provide helpful troubleshooting steps for common failures

Benefits

  1. Single source of truth: Registry logic consolidated in service layer
  2. Proper HTTP semantics: Correct status codes for different error types
  3. Better UX: Users get actionable error messages with hints
  4. Easier testing: Service abstraction enables better unit testing
  5. Consistency: API and CLI handle errors the same way

Example Error Messages

Before

Error: failed to set registry: invalid registry format

After

Error: validation failed
The registry at https://example.com/registry.json returned an invalid response or does not appear to be a valid registry.
Please verify:
  - The URL points to a valid MCP registry
  - The registry format is correct
  - The registry contains at least one server
Original error: registry validation failed: registry contains no servers

Testing

  • Added comprehensive service layer tests
  • Added API timeout integration tests
  • Updated existing tests to use service layer
  • All tests pass with new error handling

🤖 Generated with Claude Code

Fixes: #3464

@github-actions github-actions bot added the size/L Large PR: 600-999 lines changed label Jan 28, 2026
@codecov
Copy link

codecov bot commented Jan 28, 2026

Codecov Report

❌ Patch coverage is 66.66667% with 39 lines in your changes missing coverage. Please review.
✅ Project coverage is 65.25%. Comparing base (ebf0f55) to head (8694a6c).

Files with missing lines Patch % Lines
pkg/api/v1/registry.go 66.10% 13 Missing and 7 partials ⚠️
pkg/registry/service.go 67.24% 15 Missing and 4 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3480      +/-   ##
==========================================
+ Coverage   65.23%   65.25%   +0.01%     
==========================================
  Files         398      399       +1     
  Lines       38793    38865      +72     
==========================================
+ Hits        25308    25362      +54     
- Misses      11525    11538      +13     
- Partials     1960     1965       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Base automatically changed from registry-validation-and-errors to main January 28, 2026 10:54
@github-actions github-actions bot added size/L Large PR: 600-999 lines changed and removed size/L Large PR: 600-999 lines changed labels Jan 28, 2026
dmjb and others added 2 commits January 28, 2026 10:56
This change consolidates registry configuration logic into a service layer
and improves error handling in both the API and CLI.

Changes:

Service Layer:
- Add RegistryConfigService interface (pkg/config/registry_service.go)
- Consolidates registry configuration operations (SetRegistryFromInput, UnsetRegistry)
- Auto-detects registry type (URL/API/File) and provides user-friendly messages
- Add comprehensive service tests (pkg/config/registry_service_test.go)
- Generate mocks for testing (pkg/config/mocks/mock_registry_service.go)

API Layer (pkg/api/v1/registry.go):
- Map structured errors to proper HTTP status codes:
  - 502 Bad Gateway: Validation errors (invalid JSON, missing servers)
  - 504 Gateway Timeout: Connectivity/timeout errors (unreachable hosts)
- Add isConnectivityError() and isValidationError() helpers
- Refactor updateRegistry() to use RegistryConfigService
- Add timeout integration tests (registry_timeout_test.go)

CLI Layer (cmd/thv/app/config.go):
- Use RegistryConfigService for cleaner code
- Add enhanceRegistryError() for user-friendly error messages
- Provide actionable hints for common failure scenarios
- Map error types to match API status codes (504, 502)

Benefits:
- Single source of truth for registry configuration logic
- Consistent error handling across API and CLI
- Better user experience with actionable error messages
- Easier testing with service abstraction

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@dmjb dmjb force-pushed the registry-service-and-error-handling branch from e262af8 to a16a3b9 Compare January 28, 2026 11:17
@github-actions github-actions bot added size/L Large PR: 600-999 lines changed and removed size/L Large PR: 600-999 lines changed labels Jan 28, 2026
@github-actions github-actions bot added size/L Large PR: 600-999 lines changed and removed size/L Large PR: 600-999 lines changed labels Jan 28, 2026
* Infrastructure improvements and bugfixes for vMCP (#3439)

* Infrastructure improvements and bugfixes for vMCP

- Add OpenTelemetry tracing to capability aggregation
- Add singleflight deduplication for discovery requests
- Add health checker self-check prevention
- Add HTTP client timeout fixes
- Improve E2E test reliability
- Various build and infrastructure improvements

* fix: Update CallTool and GetPrompt signatures to match BackendClient interface

- Add conversion import for meta field handling
- Update CallTool to accept meta parameter and return *vmcp.ToolCallResult
- Update GetPrompt to return *vmcp.PromptGetResult
- Add convertContent helper function

* fix: Update ReadResource signature to match BackendClient interface

- Update ReadResource to return *vmcp.ResourceReadResult instead of []byte
- Extract and include meta field from backend response
- Include MIME type in result

* fix: Pass selfURL parameter to health.NewMonitor

- Construct selfURL from Host, Port, and EndpointPath
- Prevents health checker from checking itself

* Fix NewHealthChecker calls in checker_test.go to include selfURL parameter

* Fix NewMonitor calls in monitor_test.go to include selfURL parameter

All 10 calls to NewMonitor in monitor_test.go were missing the new selfURL parameter that was added to the function signature. This was causing compilation failures in CI.

* Fix Go import formatting issues (gci linter)

Fixed import ordering in:
- pkg/vmcp/client/client.go
- pkg/vmcp/health/checker_test.go
- pkg/vmcp/health/monitor_test.go

* Fix Chart.yaml version - restore to 0.0.103

The version was incorrectly downgraded to 0.0.102. Restore it to 0.0.103 to match main branch.

* Bump Chart.yaml version to 0.0.104

The chart-testing tool requires version bumps to be higher than the base branch version (0.0.103).

* Update README.md version badge to 0.0.104

Match the Chart.yaml version update to satisfy helm-docs pre-commit hook.

* Refactor vMCP tracing and remove health checker self-check

Move telemetry provider initialization earlier in vmcp serve command to
enable distributed tracing in the aggregator. The aggregator now accepts
an explicit tracer provider parameter instead of using the global otel
tracer, following dependency injection best practices.

Improve tracing error handling by using named return values and deferred
error recording in aggregator methods, ensuring errors are properly
captured in traces.

Remove health checker self-check functionality that prevented the server
from checking its own health endpoint. This simplifies the implementation
and removes unnecessary URL normalization logic.

Changes:
- Add tracerProvider parameter to aggregator.NewDefaultAggregator
- Use noop tracer when provider is nil
- Improve span error handling with deferred recording
- Remove selfURL parameter from health.NewHealthChecker
- Delete pkg/vmcp/health/checker_selfcheck_test.go
- Update all tests to match new function signatures
- Add debug logging for auth strategy application in client

* Add explanatory comment for MCP SDK Meta limitations

Restores comment explaining why Meta field preservation is important
for ReadResource, in anticipation of future SDK improvements.

This addresses PR feedback to maintain context about the SDK's
current limitations regarding Meta field handling.

* Update test helper comments to clarify pod readiness contract

- Clarify that checkPodsReady waits for at least one pod (not all pods)
- Add context that helpers are used for single replica deployments
- Update comments on WaitForPodsReady and WaitForVirtualMCPServerReady

Addresses code review feedback from PR review.

* Complete error capture pattern in MergeCapabilities defer

- Add named return value (retErr error) to MergeCapabilities
- Add error capture in defer statement with span.RecordError and span.SetStatus
- Ensures consistent error handling pattern across all aggregator methods

This completes the implementation of the error capture pattern suggested
in code review for all methods with tracing spans.

* Remove singleflight race condition fix

Moving the singleflight deduplication logic to a separate PR
as it addresses a different race condition from the one fixed in #3450.

The fix prevents duplicate capability aggregation when multiple
concurrent requests arrive simultaneously at startup.

* Add SPDX license headers to manager.go

* Update E2E tests to reflect new registry error behavior

This change updates E2E tests to match the new HTTP status codes and
error messages introduced in the registry API improvements.

Changes:
- Update expected status codes:
  - 502 Bad Gateway: For validation errors (invalid JSON, missing servers)
  - 504 Gateway Timeout: For connectivity errors (unreachable hosts)
- Update expected error messages:
  - "Will use built-in registry" instead of "reset to default"
- Update test for api_url validation:
  - api_url now validates reachability (returns 504 for unreachable hosts)
  - Previously it only validated URL format

Updated tests:
1. "should reset to default with empty request"
   - Expected message: "Will use built-in registry"
2. "should return 502 for invalid JSON file"
   - Expected status: 502 (was 400)
3. "should return 502 for file without servers"
   - Expected status: 502 (was 400)
4. "should return 504 for URL pointing to unreachable host"
   - Expected status: 504 (was 400)
5. "should return 504 for api_url pointing to unreachable host"
   - Expected status: 504 (was 200)
   - Updated test name and comment to reflect new behavior

These changes validate that the registry API now properly distinguishes
between validation errors (502) and connectivity errors (504), providing
better semantics and user experience.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Nigel Brown <nigel@stacklok.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
@github-actions github-actions bot added size/L Large PR: 600-999 lines changed and removed size/L Large PR: 600-999 lines changed labels Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/L Large PR: 600-999 lines changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ToolHive does not gracefully handle misconfigured registries.

3 participants