-
Notifications
You must be signed in to change notification settings - Fork 115
Add file-based registry provider to thv-registry-api #1909
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
// Package service provides the business logic for the MCP registry API | ||
package service | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"os" | ||
"path/filepath" | ||
|
||
"github.com/stacklok/toolhive/pkg/registry" | ||
) | ||
|
||
// FileRegistryDataProvider implements RegistryDataProvider using local file system. | ||
// This implementation reads registry data from a mounted file instead of calling the Kubernetes API. | ||
// It is designed to work with ConfigMaps mounted as volumes in Kubernetes deployments. | ||
type FileRegistryDataProvider struct { | ||
filePath string | ||
registryName string | ||
} | ||
|
||
// NewFileRegistryDataProvider creates a new file-based registry data provider. | ||
// The filePath parameter should point to the registry.json file, typically mounted from a ConfigMap. | ||
// The registryName parameter specifies the registry identifier for business logic purposes. | ||
func NewFileRegistryDataProvider(filePath, registryName string) *FileRegistryDataProvider { | ||
return &FileRegistryDataProvider{ | ||
filePath: filePath, | ||
registryName: registryName, | ||
} | ||
} | ||
|
||
// GetRegistryData implements RegistryDataProvider.GetRegistryData. | ||
// It reads the registry.json file from the local filesystem and parses it into a Registry struct. | ||
func (p *FileRegistryDataProvider) GetRegistryData(_ context.Context) (*registry.Registry, error) { | ||
if p.filePath == "" { | ||
return nil, fmt.Errorf("file path not configured") | ||
} | ||
|
||
// Check if the file exists and is readable | ||
if _, err := os.Stat(p.filePath); err != nil { | ||
if os.IsNotExist(err) { | ||
return nil, fmt.Errorf("registry file not found at %s: %w", p.filePath, err) | ||
} | ||
return nil, fmt.Errorf("cannot access registry file at %s: %w", p.filePath, err) | ||
} | ||
|
||
// Read the file contents | ||
data, err := os.ReadFile(p.filePath) | ||
if err != nil { | ||
return nil, fmt.Errorf("failed to read registry file at %s: %w", p.filePath, err) | ||
} | ||
|
||
// Parse the JSON data | ||
var reg registry.Registry | ||
if err := json.Unmarshal(data, ®); err != nil { | ||
return nil, fmt.Errorf("failed to parse registry data from file %s: %w", p.filePath, err) | ||
} | ||
|
||
return ®, nil | ||
} | ||
|
||
// GetSource implements RegistryDataProvider.GetSource. | ||
// It returns a descriptive string indicating the file source. | ||
func (p *FileRegistryDataProvider) GetSource() string { | ||
if p.filePath == "" { | ||
return "file:<not-configured>" | ||
} | ||
|
||
// Clean the path for consistent display | ||
cleanPath := filepath.Clean(p.filePath) | ||
return fmt.Sprintf("file:%s", cleanPath) | ||
} | ||
|
||
// GetRegistryName implements RegistryDataProvider.GetRegistryName. | ||
// It returns the injected registry name identifier. | ||
func (p *FileRegistryDataProvider) GetRegistryName() string { | ||
jhrozek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
return p.registryName | ||
} |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.