8d7e471fd3<!-- Provide a brief summary of your changes -->
This PR serves as a placeholder and brings together all of the changes
related to supporting vendor extensions passed through the API. The idea
is to have a single place to track and review the work as it comes
together (even if it’s still a bit of a work in progress).
**The changes in this PR cover:**
* Updates on the data model
* Updates on both databases (in-memory and postgresql), added a new
table to PSQL for tracking the extensions leaving the server table only
for the clean server.json properties
* Updates the seed.json file (thus the big line change)
* Adds a seed-migrate tool to help migrating an existing seed file to
the new format
* Updates the seed import mechanism to support this
* Updates the existing tests - unit, integration and validation tests
* Adds the publish handler to the OpenAPI spec (it was missing)
* Fixes linting errors
* Updates on the API side on (publish, list, get) to support the new
format of `ServerResponse` -
```
{
"server": {},
"x-io.modelcontextprotocol.registry": {}, /*not available for publish since this gets populated by the registry*/
"x-publisher": {}
}
```
## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->
Motivated by the discussions in:
https://github.com/modelcontextprotocol/registry/discussions/284
## How Has This Been Tested?
<!-- Have you tested this in a real application? Which scenarios were
tested? -->
Locally and by running all of the tests
## Breaking Changes
<!-- Will users need to update their code or configurations? -->
Yes, it changes both the API and the format of the seed file
## 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)
- [x] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update
---
Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
Co-authored-by: adam jones <domdomegg+git@gmail.com>
91 lines
2.7 KiB
Go
91 lines
2.7 KiB
Go
package v0_test
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/danielgtaylor/huma/v2/adapters/humago"
|
|
"github.com/google/uuid"
|
|
"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/model"
|
|
"github.com/modelcontextprotocol/registry/internal/telemetry"
|
|
)
|
|
|
|
func mockServerEndpoint(registry *MockRegistryService, serverID string) {
|
|
serverDetail := &model.ServerResponse{
|
|
Server: model.ServerDetail{
|
|
Name: "test-server-detail",
|
|
Description: "Test server detail",
|
|
Repository: model.Repository{
|
|
URL: "https://github.com/example/test-server-detail",
|
|
Source: "github",
|
|
ID: "example/test-server-detail",
|
|
},
|
|
VersionDetail: model.VersionDetail{
|
|
Version: "2.0.0",
|
|
},
|
|
},
|
|
XIOModelContextProtocolRegistry: map[string]interface{}{
|
|
"id": serverID,
|
|
},
|
|
}
|
|
registry.Mock.On("GetByID", serverID).Return(serverDetail, nil)
|
|
}
|
|
|
|
func TestPrometheusHandler(t *testing.T) {
|
|
mockRegistry := new(MockRegistryService)
|
|
|
|
serverID := uuid.New().String()
|
|
mockServerEndpoint(mockRegistry, serverID)
|
|
|
|
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, cfg, metrics)
|
|
v0.RegisterServersEndpoints(api, mockRegistry)
|
|
|
|
// Add /metrics for Prometheus metrics using promhttp
|
|
mux.Handle("/metrics", metrics.PrometheusHandler())
|
|
|
|
// Create request
|
|
url := "/v0/servers/" + serverID
|
|
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/{id}\"")
|
|
}
|