Skip to content

feat: add auto-generated RPC wrapper system for plugins #112

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.

Sign up for GitHub

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

Draft
Pratham-Mishra04 wants to merge 2 commits into
base: graphite-base/112
Choose a base branch
from
Draft

feat: add auto-generated RPC wrapper system for plugins #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ddbcea
feat: new plugin integration architecture
Pratham-Mishra04 Jun 22, 2025
dba9309
feat: plugin system standardized for transports
Pratham-Mishra04 Jun 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion core/schemas/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
// Package schemas defines the core schemas and types used by the Bifrost system.
package schemas

import "context"
import (
"context"
"encoding/json"
)

// PluginShortCircuit represents a plugin's decision to short-circuit the normal flow.
// It can contain either a response (success short-circuit) or an error (error short-circuit).
Expand Down Expand Up @@ -38,11 +41,22 @@ type PluginShortCircuit struct {
// - AllowFallbacks = nil: Treated as true by default (allow fallbacks for resilience)
//
// Plugin authors should ensure their hooks are robust to both response and error being nil, and should not assume either is always present.
//
// STANDARDIZED PLUGIN DEVELOPMENT:
// All plugins should follow these conventions:
// 1. Constructor: NewPlugin(config json.RawMessage) (Plugin, error)
// 2. Implement SetLogger method for dependency injection
// 3. Handle nil logger gracefully (use default logging or no-op)

type Plugin interface {
// GetName returns the name of the plugin.
GetName() string

// SetLogger injects a logger instance into the plugin.
// Plugins should handle nil logger gracefully (use default logging or no-op).
// This method will be called by Bifrost after plugin creation.
SetLogger(logger Logger)

// PreHook is called before a request is processed by a provider.
// It allows plugins to modify the request before it is sent to the provider.
// The context parameter can be used to maintain state across plugin calls.
Expand All @@ -60,3 +74,8 @@ type Plugin interface {
// Returns any error that occurred during cleanup, which will be logged as a warning by the Bifrost instance.
Cleanup() error
}

// PluginConstructor defines the standardized constructor signature for all plugins.
// All plugins should implement: NewPlugin(config json.RawMessage) (Plugin, error)
// This is enforced at development time through documentation and examples.
type PluginConstructor func(config json.RawMessage) (Plugin, error)
Loading