agnaldo4j / kanban_vision_api_iex / af23e3d1034dfc03efd6f4bf3ae3c96320b274fc

88%

Build Type

push

github

Committed by web-flow

Commit Message

Refactor: Implement explicit Use Cases with observability and validation (#11)

* Refactor: Implement explicit Use Cases with observability and validation

This commit applies architectural improvements to align with Platform
Engineering Standards and Clean Architecture principles.

## Major Changes

### 1. Explicit Use Cases (SRP)
- Created 8 dedicated Use Case modules (one per operation)
- Organizations: CreateOrganization, DeleteOrganization, GetOrganizationById,
  GetOrganizationByName, GetAllOrganizations
- Simulations: CreateSimulation, GetAllSimulations, GetSimulationByOrgAndName
- GenServers now only orchestrate; business logic moved to Use Cases

### 2. Observability (Logger + Telemetry)
- Added structured logging with correlation_id to all Use Cases
- INFO logs for mutations (create, delete)
- DEBUG logs for queries
- ERROR logs for failures
- Telemetry events emitted after mutations: :organization_created,
  :organization_deleted, :simulation_created

### 3. Input Validation
- Commands/Queries now use factory functions with validation
- @enforce_keys for required fields
- Type and size validation in new/N functions
- Returns {:ok, cmd} | {:error, :invalid_*}

### 4. Contract Tests
- Added OrganizationRepositoryContractTest
- Added SimulationRepositoryContractTest
- Verify Agents correctly implement Port behaviours
- Tagged with @integration (excluded by default)

### 5. Updated Tests
- All tests adapted to use factory functions
- Added validation tests for Commands/Queries
- All tests passing (39 tests, 0 failures)

### 6. Documentation
- README completely rewritten with new architecture
- Added "Architecture Evolution" section documenting changes
- Updated project structure showing Use Case modules
- Added Key Design Decisions section

## Files Changed
- New: 8 Use Case modules in usecase/organizations/ and usecase/simulations/
- New: 2 contract test files
- New: docs/skills/definition-of-done.md
- Modified: Commands/Queries with validatio... (continued)

Run Details

121 of 134 new or added lines in 14 files covered. (90.3%)

6 existing lines in 3 files now uncovered.

213 of 229 relevant lines covered (93.01%)

3.01 hits per line