<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The follow PR removes the in-memory database option from the registry. We had a chat about this with @domdomegg and although it is supposed to be convenient, it isn't that useful in reality. We want to test and develop the registry in a setup that is closer to the environment it is supposed to be run. One of the main reasons are: * We don't use it anywhere else besides unit testing and potentially local development. Instead we should use postgresql for reliable results (in-memory was actually giving false positive results) * We have to keep maintaining it and make sure it mimics the behaviour we have for postgresql which is not yielding a lot of value ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> Yes, I've updated the test unit make target to run in the postgresql environment and now we can see the race condition issue happening. ## Breaking Changes <!-- Will users need to update their code or configurations? --> No ## 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 --> --------- Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
74 lines
3.2 KiB
Go
74 lines
3.2 KiB
Go
package database
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"time"
|
|
|
|
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
|
|
)
|
|
|
|
// Common database errors
|
|
var (
|
|
ErrNotFound = errors.New("record not found")
|
|
ErrAlreadyExists = errors.New("record already exists")
|
|
ErrInvalidInput = errors.New("invalid input")
|
|
ErrDatabase = errors.New("database error")
|
|
ErrInvalidVersion = errors.New("invalid version: cannot publish duplicate version")
|
|
ErrMaxServersReached = errors.New("maximum number of versions for this server reached (10000): please reach out at https://github.com/modelcontextprotocol/registry to explain your use case")
|
|
)
|
|
|
|
// ServerFilter defines filtering options for server queries
|
|
type ServerFilter struct {
|
|
Name *string // for finding versions of same server
|
|
RemoteURL *string // for duplicate URL detection
|
|
UpdatedSince *time.Time // for incremental sync filtering
|
|
SubstringName *string // for substring search on name
|
|
Version *string // for exact version matching
|
|
IsLatest *bool // for filtering latest versions only
|
|
}
|
|
|
|
// Database defines the interface for database operations
|
|
type Database interface {
|
|
// Retrieve server entries with optional filtering
|
|
List(ctx context.Context, filter *ServerFilter, cursor string, limit int) ([]*apiv0.ServerJSON, string, error)
|
|
// Retrieve a single server by its version ID
|
|
GetByVersionID(ctx context.Context, versionID string) (*apiv0.ServerJSON, error)
|
|
// Retrieve latest version of a server by server ID
|
|
GetByServerID(ctx context.Context, serverID string) (*apiv0.ServerJSON, error)
|
|
// Retrieve specific version of a server by server ID and version
|
|
GetByServerIDAndVersion(ctx context.Context, serverID string, version string) (*apiv0.ServerJSON, error)
|
|
// Retrieve all versions of a server by server ID
|
|
GetAllVersionsByServerID(ctx context.Context, serverID string) ([]*apiv0.ServerJSON, error)
|
|
// CreateServer adds a new server to the database
|
|
CreateServer(ctx context.Context, server *apiv0.ServerJSON) (*apiv0.ServerJSON, error)
|
|
// UpdateServer updates an existing server record
|
|
UpdateServer(ctx context.Context, id string, server *apiv0.ServerJSON) (*apiv0.ServerJSON, error)
|
|
// WithPublishLock executes a function with an exclusive lock for publishing a server
|
|
// This prevents race conditions when multiple versions are published concurrently
|
|
WithPublishLock(ctx context.Context, serverName string, fn func(ctx context.Context) error) error
|
|
// Close closes the database connection
|
|
Close() error
|
|
}
|
|
|
|
// WithPublishLockT is a generic helper that wraps WithPublishLock for functions returning a value
|
|
// This exists because Go does not support generic methods on interfaces - only the Database interface
|
|
// method WithPublishLock (without generics) can exist, so we provide this generic wrapper function.
|
|
// This is a common pattern in Go for working around this language limitation.
|
|
func WithPublishLockT[T any](ctx context.Context, db Database, serverName string, fn func(ctx context.Context) (T, error)) (T, error) {
|
|
var result T
|
|
var fnErr error
|
|
|
|
err := db.WithPublishLock(ctx, serverName, func(lockCtx context.Context) error {
|
|
result, fnErr = fn(lockCtx)
|
|
return fnErr
|
|
})
|
|
|
|
if err != nil {
|
|
var zero T
|
|
return zero, err
|
|
}
|
|
|
|
return result, nil
|
|
}
|
|
|