[E7.S5] Implement Layered Architecture #41

New issue

Closed

opened 2025-06-03 02:38:26 +00:00 by rwachters · 0 comments

rwachters commented

2025-06-03 02:38:26 +00:00

(Migrated from github.com)

Description

As a developer, I will structure the codebase with clear boundaries between the UI (app.ui), Frontend API Client (app.api.client), Embedded Server (server.api.server), Application Logic (server.service), Data Access (server.data), and External Services (server.external) across the defined Gradle modules (common, app, server). I will ensure dependencies flow correctly and interfaces are used to decouple components, allowing for potential future extraction or modularity. This architecture now explicitly includes layers responsible for handling message threading logic and data persistence.

Acceptance Criteria

This is not a single user story but a coding standard and architectural task applied during the implementation of other stories:

Code is organized into packages corresponding to the layers and modules as defined in the architectural document (V1.1).
Core business logic, including threading logic, resides in the server.service layer.
Data access logic, including persistence of threading relationships, is encapsulated within the server.data package (DAO interfaces and Exposed implementations).
External service communication (LLM calls, Credential Manager) is abstracted behind interfaces/classes in server.external.
Dependencies flow primarily unidirectionally as defined in the V1.1 architecture document.
Interfaces are defined and used by the calling code.
Code reviews enforce adherence to this modular and layered architecture.
Dependency Injection (e.g., Koin) is used to wire concrete implementations to interfaces across modules.

Implementation Details

This is a cross-cutting requirement that affects all aspects of implementation. The architecture should be established early and maintained consistently throughout development.

Dependencies

Requires basic project structure with Gradle modules set up
Reference to architectural document v1.1 for package structure and dependency flow

Epic

Epic 7: Application Core Framework & Windows 11 Integration

## Description As a developer, I will structure the codebase with clear boundaries between the UI (`app.ui`), Frontend API Client (`app.api.client`), Embedded Server (`server.api.server`), Application Logic (`server.service`), Data Access (`server.data`), and External Services (`server.external`) across the defined Gradle modules (`common`, `app`, `server`). I will ensure dependencies flow correctly and interfaces are used to decouple components, allowing for potential future extraction or modularity. This architecture now explicitly includes layers responsible for handling message threading logic and data persistence. ## Acceptance Criteria This is not a single user story but a coding standard and architectural task applied _during_ the implementation of other stories: - [ ] Code is organized into packages corresponding to the layers and modules as defined in the architectural document (V1.1). - [ ] Core business logic, including threading logic, resides in the `server.service` layer. - [ ] Data access logic, including persistence of threading relationships, is encapsulated within the `server.data` package (DAO interfaces and Exposed implementations). - [ ] External service communication (LLM calls, Credential Manager) is abstracted behind interfaces/classes in `server.external`. - [ ] Dependencies flow primarily unidirectionally as defined in the V1.1 architecture document. - [ ] Interfaces are defined and used by the calling code. - [ ] Code reviews enforce adherence to this modular and layered architecture. - [ ] Dependency Injection (e.g., Koin) is used to wire concrete implementations to interfaces across modules. ## Implementation Details This is a cross-cutting requirement that affects all aspects of implementation. The architecture should be established early and maintained consistently throughout development. ## Dependencies - Requires basic project structure with Gradle modules set up - Reference to architectural document v1.1 for package structure and dependency flow ## Epic Epic 7: Application Core Framework & Windows 11 Integration