-
Notifications
You must be signed in to change notification settings - Fork 171
Introduce service layer and improve API/CLI error handling #3480
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.
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
Open
dmjb
wants to merge
4
commits into
main
Choose a base branch
from
registry-service-and-error-handling
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report❌ Patch coverage is
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. 🚀 New features to boost your workflow:
|
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>
e262af8 to
a16a3b9
Compare
* 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>
JAORMX
approved these changes
Jan 28, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Depends on: #3479 (builds on structured error types)
Changes
Service Layer
RegistryConfigServiceinterface (pkg/config/registry_service.go)SetRegistryFromInput(): Auto-detects registry type (URL/API/File)UnsetRegistry(): Resets to default registryGetRegistryInfo(): Returns current registry configurationpkg/config/registry_service_test.go)pkg/config/mocks/mock_registry_service.go)API Layer (
pkg/api/v1/registry.go)502 Bad Gateway: Validation errors (invalid JSON, missing servers)504 Gateway Timeout: Connectivity/timeout errors (unreachable hosts)400 Bad Request: Invalid request formatisConnectivityError()andisValidationError()helpersupdateRegistry()to useRegistryConfigServicepkg/api/v1/registry_timeout_test.go)CLI Layer (
cmd/thv/app/config.go)RegistryConfigServicefor cleaner, more maintainable codeenhanceRegistryError()for user-friendly error messages with actionable hintsBenefits
Example Error Messages
Before
After
Testing
🤖 Generated with Claude Code
Fixes: #3464