-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdi_helpers.go
More file actions
366 lines (324 loc) · 12.5 KB
/
di_helpers.go
File metadata and controls
366 lines (324 loc) · 12.5 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
package forge
import (
"github.com/xraph/forge/internal/health"
"github.com/xraph/forge/internal/shared"
"github.com/xraph/vessel"
)
// GetLogger resolves the logger from the container
// Returns the logger instance and an error if resolution fails.
func GetLogger(c Container) (Logger, error) {
return vessel.Inject[Logger](c)
}
// GetMetrics resolves the metrics from the container
// Returns the metrics instance and an error if resolution fails.
func GetMetrics(c Container) (Metrics, error) {
return vessel.Inject[Metrics](c)
}
// GetHealthManager resolves the health manager from the container
// Returns the health manager instance and an error if resolution fails.
func GetHealthManager(c Container) (HealthManager, error) {
return health.GetManager(c)
}
// =============================================================================
// Dependency Specification Types and Helpers
// =============================================================================
// Dep represents a dependency specification for a service.
// It describes what service is needed and how it should be resolved.
type Dep = shared.Dep
// DepMode specifies how a dependency should be resolved.
type DepMode = shared.DepMode
// Dependency mode constants.
const (
// DepEager resolves the dependency immediately during service creation.
DepEager = shared.DepEager
// DepLazy defers resolution until the dependency is first accessed.
DepLazy = shared.DepLazy
// DepOptional resolves immediately but returns nil if not found.
DepOptional = shared.DepOptional
// DepLazyOptional combines lazy resolution with optional behavior.
DepLazyOptional = shared.DepLazyOptional
)
// DepEagerSpec creates an eager dependency specification.
// The dependency is resolved immediately and fails if not found.
func DepEagerSpec(name string) Dep {
return shared.Eager(name)
}
// DepLazySpec creates a lazy dependency specification.
// The dependency is resolved on first access.
func DepLazySpec(name string) Dep {
return shared.Lazy(name)
}
// DepOptionalSpec creates an optional dependency specification.
// The dependency is resolved immediately but returns nil if not found.
func DepOptionalSpec(name string) Dep {
return shared.Optional(name)
}
// DepLazyOptionalSpec creates a lazy optional dependency specification.
// The dependency is resolved on first access and returns nil if not found.
func DepLazyOptionalSpec(name string) Dep {
return shared.LazyOptional(name)
}
// =============================================================================
// Lazy Wrapper Types
// =============================================================================
// LazyRef wraps a dependency that is resolved on first access.
// This is useful for breaking circular dependencies or deferring
// resolution of expensive services until they're actually needed.
type LazyRef[T any] = vessel.Lazy[T]
// OptionalLazyRef wraps an optional dependency that is resolved on first access.
// Returns nil without error if the dependency is not found.
type OptionalLazyRef[T any] = vessel.OptionalLazy[T]
// ProviderRef wraps a dependency that creates new instances on each access.
// This is useful for transient dependencies where a fresh instance is needed each time.
type ProviderRef[T any] = vessel.Provider[T]
// NewLazyRef creates a new lazy dependency wrapper.
func NewLazyRef[T any](c Container, name string) *LazyRef[T] {
return vessel.NewLazy[T](c, name)
}
// NewOptionalLazyRef creates a new optional lazy dependency wrapper.
func NewOptionalLazyRef[T any](c Container, name string) *OptionalLazyRef[T] {
return vessel.NewOptionalLazy[T](c, name)
}
// NewProviderRef creates a new provider for transient dependencies.
func NewProviderRef[T any](c Container, name string) *ProviderRef[T] {
return vessel.NewProvider[T](c, name)
}
// Inject creates an eager injection option for a dependency.
// The dependency is resolved immediately when the service is created.
//
// Usage:
//
// forge.Provide(c, "userService",
// forge.Inject[*bun.DB](c),
// func(db *bun.DB) (*UserService, error) { ... },
// )
func Inject[T any](c Container) (T, error) {
return vessel.Inject[T](c)
}
// MustInject resolves a dependency and panics if it fails.
// The dependency is resolved immediately when the service is created.
//
// Usage:
//
// forge.Provide(c, "userService",
// forge.MustInject[*bun.DB]("database"),
// func(db *bun.DB) (*UserService, error) { ... },
// )
func MustInject[T any](c Container) T {
return vessel.MustInject[T](c)
}
// Provide registers a constructor function with automatic dependency resolution.
// Dependencies are inferred from function parameters and all return types (except error)
// are registered as services.
//
// This follows the Uber dig pattern for constructor-based dependency injection:
// - Function parameters become dependencies (resolved by type)
// - Return types become provided services
// - Error return type is handled for construction failures
//
// Example:
//
// // Simple constructor
// func NewUserService(db *Database, logger *Logger) *UserService {
// return &UserService{db: db, logger: logger}
// }
// Provide(c, NewUserService)
//
// // Constructor with error
// func NewDatabase(config *Config) (*Database, error) {
// return sql.Open(config.Driver, config.DSN)
// }
// Provide(c, NewDatabase)
//
// // Using In struct for many dependencies
// type ServiceParams struct {
// vessel.In
// DB *Database
// Logger *Logger `optional:"true"`
// }
// func NewService(p ServiceParams) *Service {
// return &Service{db: p.DB, logger: p.Logger}
// }
// Provide(c, NewService)
func Provide(c Container, constructor any, opts ...ProvideOption) error {
return vessel.Provide(c, constructor, opts...)
}
// =============================================================================
// Constructor Injection (Type-Based DI)
// =============================================================================
// ProvideConstructor registers a service constructor with automatic type-based dependency resolution.
// Dependencies are resolved by their return types, making this the cleanest DI pattern.
//
// Usage:
//
// func NewDatabase(dsn string) *Database { return &Database{dsn: dsn} }
// func NewUserService(db *Database, log forge.Logger) *UserService {
// return &UserService{db: db, log: log}
// }
//
// // Register constructors - dependencies auto-resolved by type
// forge.ProvideConstructor(c, NewDatabase)
// forge.ProvideConstructor(c, NewUserService)
//
// // Resolve by type
// userService, err := forge.InjectType[*UserService](c)
func ProvideConstructor(c Container, constructor any, opts ...vessel.ConstructorOption) error {
return vessel.Provide(c, constructor, opts...)
}
// ProvideValue registers a pre-built instance as a singleton service.
// The instance is registered by its type and can be resolved with Inject[T].
//
// Example:
//
// cfg := &Config{Port: 8080}
// ProvideValue(c, cfg)
//
// // Later:
// config, _ := Inject[*Config](c)
func ProvideValue[T any](c Container, value T, opts ...ProvideOption) error {
return vessel.ProvideValue(c, value, opts...)
}
// InjectType resolves a service by its type.
// This is used with constructor injection to resolve services without string keys.
//
// Usage:
//
// db, err := forge.InjectType[*Database](c)
// userService, err := forge.InjectType[*UserService](c)
func InjectType[T any](c Container) (T, error) {
return vessel.Inject[T](c)
}
// InjectNamed resolves a named service by type.
// Used when you have multiple instances of the same type.
//
// Usage:
//
// forge.ProvideConstructor(c, NewPrimaryDB, vessel.WithName("primary"))
// forge.ProvideConstructor(c, NewReplicaDB, vessel.WithName("replica"))
//
// primary, err := forge.InjectNamed[*Database](c, "primary")
// replica, err := forge.InjectNamed[*Database](c, "replica")
func InjectNamed[T any](c Container, name string) (T, error) {
return vessel.InjectNamed[T](c, name)
}
// MustInjectNamed resolves a named service by type or panics.
func MustInjectNamed[T any](c Container, name string) T {
return vessel.MustInjectNamed[T](c, name)
}
// InjectGroup resolves all services in a group by type.
// Returns a slice of all services registered with the same group name.
//
// Usage:
//
// forge.ProvideConstructor(c, NewHandler1, vessel.AsGroup("handlers"))
// forge.ProvideConstructor(c, NewHandler2, vessel.AsGroup("handlers"))
//
// handlers, err := forge.InjectGroup[Handler](c, "handlers")
func InjectGroup[T any](c Container, groupName string) ([]T, error) {
return vessel.InjectGroup[T](c, groupName)
}
// MustInjectGroup resolves a group by type or panics.
func MustInjectGroup[T any](c Container, groupName string) []T {
return vessel.MustInjectGroup[T](c, groupName)
}
// HasType checks if a service of the given type is registered.
func HasType[T any](c Container) bool {
return vessel.HasType[T](c)
}
// HasTypeNamed checks if a named service of the given type is registered.
func HasTypeNamed[T any](c Container, name string) bool {
return vessel.HasTypeNamed[T](c, name)
}
// =============================================================================
// Named Resolution (Backward-Compatible Helpers)
// =============================================================================
// Resolve resolves a named service by type from the container.
// This is a convenience wrapper for InjectNamed.
//
// Usage:
//
// repo, err := forge.Resolve[*UserRepository](c, "userRepo")
func Resolve[T any](c Container, name string) (T, error) {
return vessel.InjectNamed[T](c, name)
}
// Must resolves a named service by type or panics.
// Only use during application startup where a panic is acceptable.
//
// Usage:
//
// repo := forge.Must[*UserRepository](c, "userRepo")
func Must[T any](c Container, name string) T {
return vessel.MustInjectNamed[T](c, name)
}
// =============================================================================
// Named Registration (Backward-Compatible Helpers)
// =============================================================================
// RegisterSingleton registers a named singleton service with the container.
// The factory receives the container and returns the service instance.
//
// Usage:
//
// forge.RegisterSingleton(c, "userRepo", func(c forge.Container) (*UserRepo, error) {
// db, err := forge.Inject[*sql.DB](c)
// if err != nil { return nil, err }
// return NewUserRepository(db), nil
// })
func RegisterSingleton[T any](c Container, name string, factory func(Container) (T, error)) error {
return vessel.ProvideNamed(c, name, func() (T, error) {
return factory(c)
}, vessel.AsSingleton())
}
// RegisterSingletonWith is an alias for RegisterSingleton.
//
// Deprecated: Use RegisterSingleton instead.
func RegisterSingletonWith[T any](c Container, name string, factory func(Container) (T, error)) error {
return RegisterSingleton[T](c, name, factory)
}
// RegisterTransient registers a named transient service with the container.
// A new instance is created on every resolution.
//
// Usage:
//
// forge.RegisterTransient[*RequestLogger](c, "requestLogger",
// func(c forge.Container) (*RequestLogger, error) {
// return NewRequestLogger(), nil
// },
// )
func RegisterTransient[T any](c Container, name string, factory func(Container) (T, error)) error {
return vessel.ProvideNamed(c, name, func() (T, error) {
return factory(c)
}, vessel.AsTransient())
}
// RegisterScoped registers a named scoped service with the container.
// One instance is created per scope (e.g., per HTTP request).
//
// Usage:
//
// forge.RegisterScoped[*Transaction](c, "transaction",
// func(c forge.Container) (*Transaction, error) {
// db, err := forge.Inject[*sql.DB](c)
// if err != nil { return nil, err }
// tx, _ := db.Begin()
// return &Transaction{tx: tx}, nil
// },
// )
func RegisterScoped[T any](c Container, name string, factory func(Container) (T, error)) error {
return vessel.ProvideNamed(c, name, func() (T, error) {
return factory(c)
}, vessel.AsScoped())
}
// RegisterValue registers a pre-built instance as a named singleton service.
// The value is registered by its type under the given name.
//
// Usage:
//
// cfg := &AppSettings{Debug: true}
// forge.RegisterValue[*AppSettings](c, "settings", cfg)
//
// // Later:
// settings, _ := forge.Resolve[*AppSettings](c, "settings")
func RegisterValue[T any](c Container, name string, value T) error {
return vessel.ProvideValue[T](c, value, vessel.WithName(name))
}
// Registration options (Singleton, Transient, Scoped, WithDependencies,
// WithGroup, WithDIMetadata) are defined in di_opts.go.