Files
goplt/docs/content/stories/epic1/1.1-enhanced-di-container.md
0x1d b4b918cba8
All checks were successful
CI / Test (pull_request) Successful in 27s
CI / Lint (pull_request) Successful in 20s
CI / Build (pull_request) Successful in 16s
CI / Format Check (pull_request) Successful in 2s
docs: ensure newline before lists across docs for MkDocs rendering
2025-11-06 10:56:50 +01:00

3.6 KiB

Story 1.1: Enhanced Dependency Injection Container

Metadata

  • Story ID: 1.1
  • Title: Enhanced Dependency Injection Container
  • Epic: 1 - Core Kernel & Infrastructure
  • Status: Completed
  • Priority: High
  • Estimated Time: 3-4 hours
  • Dependencies: 0.5

Goal

Extend the DI container to provide core kernel infrastructure services only (no business logic services) with proper lifecycle management, dependency resolution, and service override support.

Description

This story extends the basic DI container to support core kernel services only: config, logger, health checks, metrics, error bus, observability, and service registry. The container must handle service initialization order, lifecycle management, and provide a clean way to override services for testing.

Note: Business services (Auth, Identity, Authz, Audit) are NOT in the core kernel. They are separate services implemented in Epic 2.

Deliverables

1. Extended DI Container (internal/di/container.go)

  • Registration of all core services
  • Lifecycle management via FX
  • Service override support for testing
  • Dependency resolution
  • Error handling during initialization

2. Provider Functions (internal/di/providers.go)

Complete provider functions for core kernel services only:

  • ProvideConfig() fx.Option - Configuration provider
  • ProvideLogger() fx.Option - Logger provider
  • ProvideHealthCheckers() fx.Option - Health check registry provider
  • ProvideMetrics() fx.Option - Prometheus metrics registry provider
  • ProvideErrorBus() fx.Option - Error bus provider
  • ProvideTracer() fx.Option - OpenTelemetry tracer provider
  • ProvideServiceRegistry() fx.Option - Service registry provider (Consul)

Note: Database provider is NOT in core kernel - each service will create its own database client.

3. Core Module (internal/di/core_module.go)

  • Export CoreModule() fx.Option that provides all core services
  • Easy composition with future modules
  • Single import point for core services

Implementation Steps

  1. Extend Container

    • Update internal/di/container.go
    • Add support for all core services
    • Implement lifecycle hooks
  2. Create Provider Functions

    • Create internal/di/providers.go
    • Implement all provider functions
    • Handle dependencies correctly
  3. Create Core Module

    • Create internal/di/core_module.go
    • Export CoreModule function
    • Document usage
  4. Test Integration

    • Verify all services are provided
    • Test service overrides
    • Test lifecycle hooks

Acceptance Criteria

  • All core kernel services are provided via DI container
  • Services are initialized in correct dependency order
  • Lifecycle hooks work for all services
  • Services can be overridden for testing
  • DI container compiles without errors
  • CoreModule can be imported and used
  • Error handling works during initialization
  • No business logic services in core kernel
  • Service registry provider is included

Implementation Notes

  • Use FX's dependency injection features
  • Ensure proper initialization order
  • Support service overrides via FX options
  • Handle errors gracefully during startup
  • Document provider functions

Testing

# Test DI container
go test ./internal/di/...

# Test service injection
go run cmd/platform/main.go

Files to Create/Modify

  • internal/di/container.go - Extended container
  • internal/di/providers.go - Provider functions
  • internal/di/core_module.go - Core module export