544 lines
22 KiB
HTML
544 lines
22 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>0024: Service Architecture - VAPORA Platform Documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff">
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Provide site root and default themes to javascript -->
|
||
|
|
<script>
|
||
|
|
const path_to_root = "../";
|
||
|
|
const default_light_theme = "light";
|
||
|
|
const default_dark_theme = "dark";
|
||
|
|
</script>
|
||
|
|
<!-- Start loading toc.js asap -->
|
||
|
|
<script src="../toc.js"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="mdbook-help-container">
|
||
|
|
<div id="mdbook-help-popup">
|
||
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
|
|
<div>
|
||
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
||
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="body-container">
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script>
|
||
|
|
try {
|
||
|
|
let theme = localStorage.getItem('mdbook-theme');
|
||
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script>
|
||
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
|
|
let theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
const html = document.documentElement;
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add("js");
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script>
|
||
|
|
let sidebar = null;
|
||
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
} else {
|
||
|
|
sidebar = 'hidden';
|
||
|
|
}
|
||
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<!-- populated by js -->
|
||
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
|
|
<noscript>
|
||
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
||
|
|
</noscript>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||
|
|
<div class="sidebar-resize-indicator"></div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</label>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../adrs/0024-service-architecture.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script>
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1 id="adr-024-service-oriented-module-architecture"><a class="header" href="#adr-024-service-oriented-module-architecture">ADR-024: Service-Oriented Module Architecture</a></h1>
|
||
|
|
<p><strong>Status</strong>: Accepted | Implemented
|
||
|
|
<strong>Date</strong>: 2024-11-01
|
||
|
|
<strong>Deciders</strong>: Backend Architecture Team
|
||
|
|
<strong>Technical Story</strong>: Separating HTTP concerns from business logic via service layer</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
|
||
|
|
<p>Implementar <strong>service-oriented architecture</strong>: API layer (thin) delega a service layer (thick).</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
|
||
|
|
<ol>
|
||
|
|
<li><strong>Separation of Concerns</strong>: HTTP != business logic</li>
|
||
|
|
<li><strong>Testability</strong>: Services testable without HTTP layer</li>
|
||
|
|
<li><strong>Reusability</strong>: Same services usable from CLI, agents, other services</li>
|
||
|
|
<li><strong>Maintainability</strong>: Clear responsibility boundaries</li>
|
||
|
|
</ol>
|
||
|
|
<hr />
|
||
|
|
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
|
||
|
|
<h3 id="-handlers-directly-query-database"><a class="header" href="#-handlers-directly-query-database">❌ Handlers Directly Query Database</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Pros</strong>: Simple, fewer files</li>
|
||
|
|
<li><strong>Cons</strong>: Business logic in HTTP layer, not reusable, hard to test</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="-anemic-service-layer-just-crud"><a class="header" href="#-anemic-service-layer-just-crud">❌ Anemic Service Layer (Just CRUD)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><strong>Pros</strong>: Simple</li>
|
||
|
|
<li><strong>Cons</strong>: Business logic still in handlers</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="-service-oriented-with-thick-services-chosen"><a class="header" href="#-service-oriented-with-thick-services-chosen">✅ Service-Oriented with Thick Services (CHOSEN)</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Services encapsulate business logic</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
|
||
|
|
<p><strong>Pros</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>✅ Clear separation HTTP ≠ business logic</li>
|
||
|
|
<li>✅ Services independently testable</li>
|
||
|
|
<li>✅ Reusable across contexts</li>
|
||
|
|
<li>✅ Easy to add new endpoints</li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Cons</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>⚠️ More files (API + Service)</li>
|
||
|
|
<li>⚠️ Slight latency from extra layer</li>
|
||
|
|
<li>⚠️ Coordination between layers</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
|
||
|
|
<p><strong>API Layer (Thin)</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-backend/src/api/projects.rs
|
||
|
|
|
||
|
|
pub async fn create_project(
|
||
|
|
State(app_state): State<AppState>,
|
||
|
|
Json(req): Json<CreateProjectRequest>,
|
||
|
|
) -> Result<(StatusCode, Json<Project>), ApiError> {
|
||
|
|
// 1. Extract user context
|
||
|
|
let user = get_current_user()?;
|
||
|
|
|
||
|
|
// 2. Delegate to service
|
||
|
|
let project = app_state
|
||
|
|
.project_service
|
||
|
|
.create_project(
|
||
|
|
&user.tenant_id,
|
||
|
|
&req.title,
|
||
|
|
&req.description,
|
||
|
|
)
|
||
|
|
.await
|
||
|
|
.map_err(ApiError::from)?;
|
||
|
|
|
||
|
|
// 3. Return HTTP response
|
||
|
|
Ok((StatusCode::CREATED, Json(project)))
|
||
|
|
}
|
||
|
|
|
||
|
|
pub async fn get_project(
|
||
|
|
State(app_state): State<AppState>,
|
||
|
|
Path(project_id): Path<String>,
|
||
|
|
) -> Result<Json<Project>, ApiError> {
|
||
|
|
let user = get_current_user()?;
|
||
|
|
|
||
|
|
// Delegate to service
|
||
|
|
let project = app_state
|
||
|
|
.project_service
|
||
|
|
.get_project(&user.tenant_id, &project_id)
|
||
|
|
.await
|
||
|
|
.map_err(ApiError::from)?;
|
||
|
|
|
||
|
|
Ok(Json(project))
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Service Layer (Thick)</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-backend/src/services/project_service.rs
|
||
|
|
|
||
|
|
pub struct ProjectService {
|
||
|
|
db: Surreal<Ws>,
|
||
|
|
}
|
||
|
|
|
||
|
|
impl ProjectService {
|
||
|
|
pub fn new(db: Surreal<Ws>) -> Self {
|
||
|
|
Self { db }
|
||
|
|
}
|
||
|
|
|
||
|
|
/// Create new project with validation and defaults
|
||
|
|
pub async fn create_project(
|
||
|
|
&self,
|
||
|
|
tenant_id: &str,
|
||
|
|
title: &str,
|
||
|
|
description: &Option<String>,
|
||
|
|
) -> Result<Project> {
|
||
|
|
// 1. Validate input
|
||
|
|
if title.is_empty() {
|
||
|
|
return Err(VaporaError::ValidationError("Title cannot be empty".into()));
|
||
|
|
}
|
||
|
|
if title.len() > 255 {
|
||
|
|
return Err(VaporaError::ValidationError("Title too long".into()));
|
||
|
|
}
|
||
|
|
|
||
|
|
// 2. Create project
|
||
|
|
let project = Project {
|
||
|
|
id: uuid::Uuid::new_v4().to_string(),
|
||
|
|
tenant_id: tenant_id.to_string(),
|
||
|
|
title: title.to_string(),
|
||
|
|
description: description.clone(),
|
||
|
|
status: ProjectStatus::Active,
|
||
|
|
created_at: Utc::now(),
|
||
|
|
updated_at: Utc::now(),
|
||
|
|
..Default::default()
|
||
|
|
};
|
||
|
|
|
||
|
|
// 3. Persist to database
|
||
|
|
self.db
|
||
|
|
.create("projects")
|
||
|
|
.content(&project)
|
||
|
|
.await?;
|
||
|
|
|
||
|
|
// 4. Audit log
|
||
|
|
audit_log::log_project_created(tenant_id, &project.id, title)?;
|
||
|
|
|
||
|
|
Ok(project)
|
||
|
|
}
|
||
|
|
|
||
|
|
/// Get project with permission check
|
||
|
|
pub async fn get_project(
|
||
|
|
&self,
|
||
|
|
tenant_id: &str,
|
||
|
|
project_id: &str,
|
||
|
|
) -> Result<Project> {
|
||
|
|
// 1. Query database
|
||
|
|
let project = self.db
|
||
|
|
.query("SELECT * FROM projects WHERE id = $1 AND tenant_id = $2")
|
||
|
|
.bind((project_id, tenant_id))
|
||
|
|
.await?
|
||
|
|
.take::<Option<Project>>(0)?
|
||
|
|
.ok_or_else(|| VaporaError::ProjectNotFound(project_id.to_string()))?;
|
||
|
|
|
||
|
|
// 2. Permission check (implicit via tenant_id query)
|
||
|
|
Ok(project)
|
||
|
|
}
|
||
|
|
|
||
|
|
/// List projects for tenant with pagination
|
||
|
|
pub async fn list_projects(
|
||
|
|
&self,
|
||
|
|
tenant_id: &str,
|
||
|
|
limit: u32,
|
||
|
|
offset: u32,
|
||
|
|
) -> Result<(Vec<Project>, u32)> {
|
||
|
|
// 1. Get total count
|
||
|
|
let total = self.db
|
||
|
|
.query("SELECT count(id) FROM projects WHERE tenant_id = $1")
|
||
|
|
.bind(tenant_id)
|
||
|
|
.await?
|
||
|
|
.take::<Option<u32>>(0)?
|
||
|
|
.unwrap_or(0);
|
||
|
|
|
||
|
|
// 2. Get paginated results
|
||
|
|
let projects = self.db
|
||
|
|
.query(
|
||
|
|
"SELECT * FROM projects \
|
||
|
|
WHERE tenant_id = $1 \
|
||
|
|
ORDER BY created_at DESC \
|
||
|
|
LIMIT $2 START $3"
|
||
|
|
)
|
||
|
|
.bind((tenant_id, limit, offset))
|
||
|
|
.await?
|
||
|
|
.take::<Vec<Project>>(0)?
|
||
|
|
.unwrap_or_default();
|
||
|
|
|
||
|
|
Ok((projects, total))
|
||
|
|
}
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>AppState (Depends On Services)</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>// crates/vapora-backend/src/api/state.rs
|
||
|
|
|
||
|
|
pub struct AppState {
|
||
|
|
pub project_service: ProjectService,
|
||
|
|
pub task_service: TaskService,
|
||
|
|
pub agent_service: AgentService,
|
||
|
|
// Other services...
|
||
|
|
}
|
||
|
|
|
||
|
|
impl AppState {
|
||
|
|
pub fn new(
|
||
|
|
project_service: ProjectService,
|
||
|
|
task_service: TaskService,
|
||
|
|
agent_service: AgentService,
|
||
|
|
) -> Self {
|
||
|
|
Self {
|
||
|
|
project_service,
|
||
|
|
task_service,
|
||
|
|
agent_service,
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Testable Services</strong>:</p>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>#[cfg(test)]
|
||
|
|
mod tests {
|
||
|
|
use super::*;
|
||
|
|
|
||
|
|
#[tokio::test]
|
||
|
|
async fn test_create_project() {
|
||
|
|
let db = setup_test_db().await;
|
||
|
|
let service = ProjectService::new(db);
|
||
|
|
|
||
|
|
let result = service
|
||
|
|
.create_project("tenant:1", "My Project", &None)
|
||
|
|
.await;
|
||
|
|
|
||
|
|
assert!(result.is_ok());
|
||
|
|
let project = result.unwrap();
|
||
|
|
assert_eq!(project.title, "My Project");
|
||
|
|
}
|
||
|
|
|
||
|
|
#[tokio::test]
|
||
|
|
async fn test_create_project_empty_title() {
|
||
|
|
let db = setup_test_db().await;
|
||
|
|
let service = ProjectService::new(db);
|
||
|
|
|
||
|
|
let result = service
|
||
|
|
.create_project("tenant:1", "", &None)
|
||
|
|
.await;
|
||
|
|
|
||
|
|
assert!(result.is_err());
|
||
|
|
}
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<p><strong>Key Files</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>/crates/vapora-backend/src/api/</code> (thin API handlers)</li>
|
||
|
|
<li><code>/crates/vapora-backend/src/services/</code> (thick service logic)</li>
|
||
|
|
<li><code>/crates/vapora-backend/src/api/state.rs</code> (AppState)</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
|
||
|
|
<pre><code class="language-bash"># Test service logic independently
|
||
|
|
cargo test -p vapora-backend test_service_logic
|
||
|
|
|
||
|
|
# Test API handlers
|
||
|
|
cargo test -p vapora-backend test_api_handlers
|
||
|
|
|
||
|
|
# Verify separation (API shouldn't directly query DB)
|
||
|
|
grep -r "\.query(" crates/vapora-backend/src/api/ 2>/dev/null | grep -v service
|
||
|
|
|
||
|
|
# Check service reusability (used in multiple places)
|
||
|
|
grep -r "ProjectService::" crates/vapora-backend/src/
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Expected Output</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>API layer contains only HTTP logic</li>
|
||
|
|
<li>Services contain business logic</li>
|
||
|
|
<li>Services independently testable</li>
|
||
|
|
<li>No direct DB queries in API layer</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
|
||
|
|
<h3 id="code-organization"><a class="header" href="#code-organization">Code Organization</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><code>/api/</code> for HTTP concerns</li>
|
||
|
|
<li><code>/services/</code> for business logic</li>
|
||
|
|
<li>Clear separation of responsibilities</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="testing"><a class="header" href="#testing">Testing</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>API tests mock services</li>
|
||
|
|
<li>Service tests use real database</li>
|
||
|
|
<li>Fast unit tests + integration tests</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="maintainability"><a class="header" href="#maintainability">Maintainability</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>Business logic changes in one place</li>
|
||
|
|
<li>Adding endpoints: just add API handler</li>
|
||
|
|
<li>Reusing logic: call service from multiple places</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="extensibility"><a class="header" href="#extensibility">Extensibility</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li>CLI tool can use same services</li>
|
||
|
|
<li>Agents can use same services</li>
|
||
|
|
<li>No duplication of business logic</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="references"><a class="header" href="#references">References</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li><code>/crates/vapora-backend/src/api/</code> (API layer)</li>
|
||
|
|
<li><code>/crates/vapora-backend/src/services/</code> (service layer)</li>
|
||
|
|
<li>ADR-022 (Error Handling)</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<p><strong>Related ADRs</strong>: ADR-022 (Error Handling), ADR-023 (Testing)</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../../adrs/0023-testing-strategy.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../adrs/0025-multi-tenancy.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../../adrs/0023-testing-strategy.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../adrs/0025-multi-tenancy.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script>
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../elasticlunr.min.js"></script>
|
||
|
|
<script src="../mark.min.js"></script>
|
||
|
|
<script src="../searcher.js"></script>
|
||
|
|
|
||
|
|
<script src="../clipboard.min.js"></script>
|
||
|
|
<script src="../highlight.js"></script>
|
||
|
|
<script src="../book.js"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|