1a7cd97099<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The following PR adds a new v0.1 API version. The goal is to mark v0.1 as a "freeze" point while keeping v0 as the moving target for new features so integrators can start building on top of something stable(r). Details: * This change is quite simple - we re-register the same handlers twice, once as `v0` and once as `v0.1` * Going forward, we'll keep v0.1 frozen while we add changes either on top of both (non-breaking) or we'll have to branch if breaking changes are necessary * We all acknowledge this is not exactly best-practice, but it gives us a way to gather feedback and allow clients to start integrating with the API without breaking them (**note** this implies a follow up PR that would branch the handlers used in v0.1). * For integrators/clients: please provide your feedback - what works well, what doesn't so we can take this into account going towards GA. ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> No, this just adds a new API version alongside the existing one. ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> Fixes: #649 Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
82 lines
2.7 KiB
Go
82 lines
2.7 KiB
Go
package v0_test
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"testing"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/danielgtaylor/huma/v2/adapters/humago"
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
v0 "github.com/modelcontextprotocol/registry/internal/api/handlers/v0"
|
|
"github.com/modelcontextprotocol/registry/internal/api/router"
|
|
"github.com/modelcontextprotocol/registry/internal/config"
|
|
"github.com/modelcontextprotocol/registry/internal/database"
|
|
"github.com/modelcontextprotocol/registry/internal/service"
|
|
"github.com/modelcontextprotocol/registry/internal/telemetry"
|
|
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
|
|
"github.com/modelcontextprotocol/registry/pkg/model"
|
|
)
|
|
|
|
func TestPrometheusHandler(t *testing.T) {
|
|
registryService := service.NewRegistryService(database.NewTestDB(t), config.NewConfig())
|
|
server, err := registryService.CreateServer(context.Background(), &apiv0.ServerJSON{
|
|
Schema: model.CurrentSchemaURL,
|
|
Name: "io.github.example/test-server",
|
|
Description: "Test server detail",
|
|
Repository: model.Repository{
|
|
URL: "https://github.com/example/test-server",
|
|
Source: "github",
|
|
ID: "example/test-server",
|
|
},
|
|
Version: "2.0.0",
|
|
})
|
|
assert.NoError(t, err)
|
|
|
|
cfg := config.NewConfig()
|
|
shutdownTelemetry, metrics, _ := telemetry.InitMetrics("dev")
|
|
|
|
mux := http.NewServeMux()
|
|
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
|
|
|
|
// Add metrics middleware with options
|
|
api.UseMiddleware(router.MetricTelemetryMiddleware(metrics,
|
|
router.WithSkipPaths("/health", "/metrics", "/ping", "/docs"),
|
|
))
|
|
v0.RegisterHealthEndpoint(api, "/v0", cfg, metrics)
|
|
v0.RegisterServersEndpoints(api, "/v0", registryService)
|
|
|
|
// Add /metrics for Prometheus metrics using promhttp
|
|
mux.Handle("/metrics", metrics.PrometheusHandler())
|
|
|
|
// Create request - using latest version endpoint
|
|
url := "/v0/servers/" + url.PathEscape(server.Server.Name) + "/versions/latest"
|
|
req := httptest.NewRequest(http.MethodGet, url, nil)
|
|
w := httptest.NewRecorder()
|
|
|
|
// Serve the request
|
|
mux.ServeHTTP(w, req)
|
|
|
|
// Check the status code
|
|
if w.Code != http.StatusOK {
|
|
t.Fatalf("expected status %d, got %d", http.StatusOK, w.Code)
|
|
}
|
|
|
|
req = httptest.NewRequest(http.MethodGet, "/metrics", nil)
|
|
w = httptest.NewRecorder()
|
|
mux.ServeHTTP(w, req)
|
|
|
|
// shutdown metrics provider
|
|
_ = shutdownTelemetry(context.Background())
|
|
|
|
assert.Equal(t, http.StatusOK, w.Code, "Expected status OK for /metrics endpoint")
|
|
|
|
body := w.Body.String()
|
|
// Check if the response body contains expected metrics
|
|
assert.Contains(t, body, "mcp_registry_http_request_duration_bucket")
|
|
assert.Contains(t, body, "mcp_registry_http_requests_total")
|
|
assert.Contains(t, body, "path=\"/v0/servers/{serverName}/versions/{version}\"")
|
|
}
|