-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathcontainer.go
More file actions
396 lines (319 loc) · 9.45 KB
/
container.go
File metadata and controls
396 lines (319 loc) · 9.45 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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
package pal
import (
"context"
"errors"
"fmt"
"log/slog"
"maps"
"reflect"
"slices"
typetostring "github.com/samber/go-type-to-string"
"golang.org/x/sync/errgroup"
"github.com/zhulik/pal/pkg/dag"
)
type factoryServiceMaping struct {
Factory any
Service ServiceDef
}
type factoryService interface {
Factory() any
MustFactory() any
}
// Container is responsible for storing services, instances and the dependency graph
type Container struct {
pal *Pal
services map[string]ServiceDef
factories map[string]factoryServiceMaping
graph *dag.DAG[string, ServiceDef]
logger *slog.Logger
}
// NewContainer creates a new Container instance
func NewContainer(pal *Pal, services ...ServiceDef) *Container {
services = flattenServices(services)
container := &Container{
pal: pal,
services: map[string]ServiceDef{},
factories: map[string]factoryServiceMaping{},
graph: dag.New[string, ServiceDef](),
logger: slog.With("palComponent", "Container"),
}
for _, service := range services {
container.addService(service)
if factory, ok := service.(factoryService); ok {
// Add Factory to the container
fn := factory.Factory()
fnType := reflect.TypeOf(fn)
container.factories[typetostring.GetReflectType(fnType)] = factoryServiceMaping{
Factory: fn,
Service: service,
}
// Add MustFactory to the container
fn = factory.MustFactory()
fnType = reflect.TypeOf(fn)
container.factories[typetostring.GetReflectType(fnType)] = factoryServiceMaping{
Factory: fn,
Service: service,
}
}
}
return container
}
func (c *Container) Init(ctx context.Context) error {
c.logger.Debug("Building dependency tree...")
for _, service := range c.services {
if err := c.addDependencyVertex(service, nil); err != nil {
return err
}
}
for _, service := range c.graph.ReverseTopologicalOrder() {
if err := service.Init(ctx); err != nil {
c.logger.Error("Failed to initialize container", "error", err)
return err
}
}
c.logger.Debug("Container initialized")
return nil
}
func (c *Container) Invoke(ctx context.Context, name string, args ...any) (any, error) {
service, ok := c.services[name]
if !ok {
return nil, fmt.Errorf("%w: '%s', known services: %s", ErrServiceNotFound, name, c.services)
}
if len(args) != service.Arguments() {
return nil, fmt.Errorf("%w: '%s': %d arguments expected, got %d", ErrServiceInvalidArgumentsCount, name, service.Arguments(), len(args))
}
instance, err := service.Instance(ctx, args...)
if err != nil {
return nil, fmt.Errorf("%w: '%s': %w", ErrServiceInitFailed, name, err)
}
return instance, nil
}
func (c *Container) InvokeByInterface(ctx context.Context, iface reflect.Type, args ...any) (any, error) {
if iface.Kind() != reflect.Interface {
return nil, fmt.Errorf("%w: must be an interface, got %s", ErrNotAnInterface, iface.String())
}
matches := []ServiceDef{}
for _, service := range c.services {
instance := service.Make()
if instance == nil {
continue
}
if reflect.TypeOf(instance).Implements(iface) {
matches = append(matches, service)
}
}
if len(matches) == 0 {
return nil, fmt.Errorf("%w: no implementations of %s found", ErrServiceNotFound, iface.String())
}
if len(matches) == 1 {
return matches[0].Instance(ctx, args...)
}
return nil, fmt.Errorf("%w: found %d services for interface %s", ErrMultipleServicesFoundByInterface, len(matches), iface.String())
}
func (c *Container) InjectInto(ctx context.Context, target any) error {
v := reflect.ValueOf(target).Elem()
t := v.Type()
for i := 0; i < t.NumField(); i++ {
field := v.Field(i)
tags, err := ParseTag(t.Field(i).Tag.Get("pal"))
if err != nil {
return err
}
if _, ok := tags[TagSkip]; ok || !field.CanSet() {
continue
}
fieldType := t.Field(i).Type
if fieldType == reflect.TypeOf((*slog.Logger)(nil)) && c.pal.config.AttrSetters != nil {
c.injectLoggerIntoField(field, target)
continue
}
if _, ok := tags[TagMatchInterface]; ok {
err = c.injectByInterface(ctx, field, fieldType)
if err != nil {
return err
}
continue
}
typeName, mustInject := tags[TagName]
if typeName == "" {
typeName = typetostring.GetReflectType(fieldType)
}
if fieldType.Kind() == reflect.Func {
mapping, ok := c.factories[typeName]
if ok {
field.Set(reflect.ValueOf(mapping.Factory))
}
continue
}
err = c.injectByName(ctx, typeName, field)
if err != nil {
if errors.Is(err, ErrServiceNotFound) && !mustInject {
continue
}
return err
}
}
return nil
}
func (c *Container) injectByInterface(ctx context.Context, field reflect.Value, fieldType reflect.Type) error {
dependency, err := c.InvokeByInterface(ctx, fieldType)
if err != nil {
return err
}
field.Set(reflect.ValueOf(dependency))
return nil
}
func (c *Container) injectByName(ctx context.Context, name string, field reflect.Value) error {
dependency, err := c.Invoke(ctx, name)
if err != nil {
if errors.Is(err, ErrServiceInvalidArgumentsCount) {
return fmt.Errorf("%w: '%s': %w", ErrFactoryServiceDependency, name, err)
}
return err
}
field.Set(reflect.ValueOf(dependency))
return nil
}
func (c *Container) Shutdown(ctx context.Context) error {
c.logger.Debug("Shutting down all runners")
for _, service := range c.graph.TopologicalOrder() {
err := service.Shutdown(ctx)
if err != nil {
c.logger.Error("Failed to shutdown service. Exiting immediately", "service", service.Name(), "error", err)
return err
}
}
c.logger.Debug("Container shut down successfully")
return nil
}
func (c *Container) HealthCheck(ctx context.Context) error {
var wg errgroup.Group
c.logger.Debug("Healthchecking services")
for _, service := range c.graph.TopologicalOrder() {
wg.Go(func() error {
// Do not check pal again, this leads to recursion
if service.Name() == "*github.com/zhulik/pal.Pal" {
return nil
}
err := service.HealthCheck(ctx)
if err != nil {
return err
}
return nil
})
}
err := wg.Wait()
if err != nil {
c.logger.Error("Healthcheck failed", "error", err)
return err
}
c.logger.Debug("Healthcheck successful")
return nil
}
// Services returns a map of all registered services in the container, keyed by their names.
// This can be useful for debugging or introspection purposes.
func (c *Container) Services() map[string]ServiceDef {
return c.services
}
// StartRunners starts all services that implement the Runner interface in background goroutines.
// It creates a cancellable context that will be canceled during shutdown.
// Returns an error if any runner fails, though runners continue to execute independently.
func (c *Container) StartRunners(ctx context.Context) error {
services := slices.Collect(maps.Values(c.services))
return RunServices(ctx, services)
}
// Graph returns the dependency graph of services.
// This can be useful for visualization or analysis of the service dependencies.
func (c *Container) Graph() *dag.DAG[string, ServiceDef] {
return c.graph
}
func (c *Container) addService(service ServiceDef) {
setPalField(reflect.ValueOf(service), c.pal, map[reflect.Value]bool{})
c.services[service.Name()] = service
}
// addDependencyVertex adds a service to the dependency graph and recursively adds its dependencies.
// If parent is not nil, it also adds an edge from parent to service in the graph.
// This method is used during container initialization to build the complete dependency graph.
func (c *Container) addDependencyVertex(service ServiceDef, parent ServiceDef) error {
c.graph.AddVertexIfNotExist(service.Name(), service)
if parent != nil {
if err := c.graph.AddEdgeIfNotExist(parent.Name(), service.Name()); err != nil {
return err
}
}
m := service.Make()
if isNil(m) {
return nil
}
val := reflect.ValueOf(m)
if val.Kind() == reflect.Ptr {
val = val.Elem()
}
if !val.IsValid() {
return nil
}
typ := val.Type()
for i := 0; i < typ.NumField(); i++ {
field := typ.Field(i)
if !field.IsExported() {
continue
}
tags, err := ParseTag(field.Tag.Get("pal"))
if err != nil {
return err
}
dependencyName := tags[TagName]
if dependencyName == "" {
dependencyName = typetostring.GetReflectType(field.Type)
}
if childService, ok := c.services[dependencyName]; ok {
if err := c.addDependencyVertex(childService, service); err != nil {
return err
}
}
if factoryMapping, ok := c.factories[dependencyName]; ok {
if err := c.addDependencyVertex(factoryMapping.Service, service); err != nil {
return err
}
}
}
return nil
}
func (c *Container) injectLoggerIntoField(field reflect.Value, target any) {
logger := slog.Default()
for _, attrSetter := range c.pal.config.AttrSetters {
name, value := attrSetter(target)
logger = logger.With(name, value)
}
field.Set(reflect.ValueOf(logger))
}
func setPalField(v reflect.Value, pal *Pal, visited map[reflect.Value]bool) {
if visited[v] {
return
}
visited[v] = true
if v.Kind() == reflect.Interface {
v = v.Elem()
}
if v.Kind() == reflect.Pointer {
v = v.Elem()
}
if v.Kind() != reflect.Struct {
return
}
for i := 0; i < v.NumField(); i++ {
field := v.Field(i)
if field.CanSet() && field.Type() == reflect.TypeOf(pal) {
field.Set(reflect.ValueOf(pal))
}
if field.Kind() == reflect.Struct || (field.Kind() == reflect.Pointer && !field.IsNil()) {
setPalField(field, pal, visited)
}
if field.Kind() == reflect.Array || field.Kind() == reflect.Slice {
for i := 0; i < field.Len(); i++ {
item := field.Index(i)
setPalField(item, pal, visited)
}
}
}
}