-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathextension_base.go
More file actions
258 lines (223 loc) · 6.87 KB
/
extension_base.go
File metadata and controls
258 lines (223 loc) · 6.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
package forge
import (
"context"
"sync"
"github.com/xraph/vessel"
)
// BaseExtension provides common functionality for implementing extensions.
// Extensions can embed BaseExtension to get standard implementations of common methods.
//
// Example usage:
//
// type MyExtension struct {
// *forge.BaseExtension
// config MyConfig
// client *MyClient
// }
//
// func NewMyExtension(config MyConfig) forge.Extension {
// return &MyExtension{
// BaseExtension: forge.NewBaseExtension("my-ext", "1.0.0", "My extension"),
// config: config,
// }
// }
type BaseExtension struct {
name string
version string
description string
dependencies []string
logger Logger
metrics Metrics
app App
started bool
mu sync.RWMutex
}
// NewBaseExtension creates a new base extension with the given identity.
func NewBaseExtension(name, version, description string) *BaseExtension {
return &BaseExtension{
name: name,
version: version,
description: description,
dependencies: []string{},
}
}
// Name returns the extension name.
func (e *BaseExtension) Name() string {
return e.name
}
// Version returns the extension version.
func (e *BaseExtension) Version() string {
return e.version
}
// Description returns the extension description.
func (e *BaseExtension) Description() string {
return e.description
}
// Dependencies returns the extension dependencies.
func (e *BaseExtension) Dependencies() []string {
return e.dependencies
}
// SetDependencies sets the extension dependencies.
func (e *BaseExtension) SetDependencies(deps []string) {
e.dependencies = deps
}
// SetLogger sets the logger for this extension.
func (e *BaseExtension) SetLogger(logger Logger) {
e.logger = logger
}
// Logger returns the extension's logger.
func (e *BaseExtension) Logger() Logger {
return e.logger
}
// SetMetrics sets the metrics for this extension.
func (e *BaseExtension) SetMetrics(metrics Metrics) {
e.metrics = metrics
}
// Metrics returns the extension's metrics.
func (e *BaseExtension) Metrics() Metrics {
return e.metrics
}
// IsStarted returns true if the extension has been started.
func (e *BaseExtension) IsStarted() bool {
e.mu.RLock()
defer e.mu.RUnlock()
return e.started
}
// MarkStarted marks the extension as started.
func (e *BaseExtension) MarkStarted() {
e.mu.Lock()
defer e.mu.Unlock()
e.started = true
}
// MarkStopped marks the extension as stopped.
func (e *BaseExtension) MarkStopped() {
e.mu.Lock()
defer e.mu.Unlock()
e.started = false
}
// Register is a default implementation that does nothing.
// Extensions should override this to register their services.
func (e *BaseExtension) Register(app App) error {
// Default: store app reference, logger and metrics from app
e.app = app
e.logger = app.Logger()
e.metrics = app.Metrics()
return nil
}
// Start is a default implementation that does nothing.
// Extensions should override this to start their services.
func (e *BaseExtension) Start(ctx context.Context) error {
e.MarkStarted()
return nil
}
// Stop is a default implementation that does nothing.
// Extensions should override this to stop their services.
func (e *BaseExtension) Stop(ctx context.Context) error {
e.MarkStopped()
return nil
}
// Health is a default implementation that always returns healthy.
// Extensions should override this to implement actual health checks.
func (e *BaseExtension) Health(ctx context.Context) error {
return nil
}
// LoadConfig loads configuration for this extension from ConfigManager.
//
// It tries the following keys in order:
// 1. "extensions.{key}" - Namespaced pattern (preferred)
// 2. "{key}" - Top-level pattern (legacy/v1 compatibility)
//
// Parameters:
// - key: The config key (e.g., "cache", "mcp")
// - target: Pointer to config struct to populate
// - programmaticConfig: Config provided programmatically (may be partially filled)
// - defaults: Default config to use if nothing found
// - requireConfig: If true, returns error when config not found; if false, uses defaults
//
// Example:
//
// func (e *Extension) Register(app forge.App) error {
// if err := e.BaseExtension.Register(app); err != nil {
// return err
// }
//
// // Load config from ConfigManager
// finalConfig := DefaultConfig()
// if err := e.LoadConfig("cache", &finalConfig, e.config, DefaultConfig(), false); err != nil {
// return err
// }
// e.config = finalConfig
//
// // ... rest of registration
// }
func (e *BaseExtension) LoadConfig(
key string,
target any,
programmaticConfig any,
defaults any,
requireConfig bool,
) error {
if e.app == nil {
if requireConfig {
return ErrExtensionNotRegistered
}
// No app available, use programmatic or defaults
loader := NewExtensionConfigLoader(nil, e.logger)
return loader.LoadConfig(key, target, programmaticConfig, defaults, false)
}
loader := NewExtensionConfigLoader(e.app, e.logger)
return loader.LoadConfig(key, target, programmaticConfig, defaults, requireConfig)
}
// App returns the app instance this extension is registered with.
func (e *BaseExtension) App() App {
return e.app
}
// RegisterConstructor registers a service constructor with the DI container.
// This is the preferred method for registering services as it uses type-based dependency injection.
//
// The constructor function's parameters are automatically resolved by their types from the container.
// Config should be captured in the constructor closure when calling this method.
//
// Example:
//
// func (e *Extension) Register(app forge.App) error {
// e.BaseExtension.Register(app)
// cfg := e.loadConfig()
//
// // Register constructor - config captured in closure
// return e.RegisterConstructor(func(logger forge.Logger, metrics forge.Metrics) (*MyService, error) {
// return NewMyService(cfg, logger, metrics)
// })
// }
func (e *BaseExtension) RegisterConstructor(constructor any, opts ...vessel.ConstructorOption) error {
if e.app == nil {
return ErrExtensionNotRegistered
}
return ProvideConstructor(e.app.Container(), constructor, opts...)
}
// RegisterConstructors registers multiple service constructors at once.
// This is a convenience method for extensions that register multiple services.
//
// Example:
//
// func (e *Extension) Register(app forge.App) error {
// e.BaseExtension.Register(app)
// cfg := e.loadConfig()
//
// return e.RegisterConstructors(
// func(logger forge.Logger) (*ServiceA, error) {
// return NewServiceA(cfg, logger)
// },
// func(logger forge.Logger, metrics forge.Metrics) (*ServiceB, error) {
// return NewServiceB(cfg, logger, metrics)
// },
// )
// }
func (e *BaseExtension) RegisterConstructors(constructors ...any) error {
for _, ctor := range constructors {
if err := e.RegisterConstructor(ctor); err != nil {
return err
}
}
return nil
}