502 lines
21 KiB
HTML
502 lines
21 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>0022: Error Handling - 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/0022-error-handling.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-022-two-tier-error-handling-thiserror--http-wrapper"><a class="header" href="#adr-022-two-tier-error-handling-thiserror--http-wrapper">ADR-022: Two-Tier Error Handling (thiserror + HTTP Wrapper)</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 domain errors from HTTP response concerns</p>
|
|
<hr />
|
|
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
|
|
<p>Implementar <strong>two-tier error handling</strong>: <code>thiserror</code> para domain errors, <code>ApiError</code> wrapper para HTTP responses.</p>
|
|
<hr />
|
|
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
|
|
<ol>
|
|
<li><strong>Separation of Concerns</strong>: Domain logic no conoce HTTP (reusable en CLI, libraries)</li>
|
|
<li><strong>Reusability</strong>: Mismo error type usado por backend, frontend (via API), agents</li>
|
|
<li><strong>Type Safety</strong>: Compiler ensures all error cases handled</li>
|
|
<li><strong>HTTP Mapping</strong>: Clean mapping from domain errors to HTTP status codes</li>
|
|
</ol>
|
|
<hr />
|
|
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
|
|
<h3 id="-single-error-type-mixed-domain--http"><a class="header" href="#-single-error-type-mixed-domain--http">❌ Single Error Type (Mixed Domain + HTTP)</a></h3>
|
|
<ul>
|
|
<li><strong>Pros</strong>: Simple</li>
|
|
<li><strong>Cons</strong>: Domain logic coupled to HTTP, not reusable</li>
|
|
</ul>
|
|
<h3 id="-error-strings-only"><a class="header" href="#-error-strings-only">❌ Error Strings Only</a></h3>
|
|
<ul>
|
|
<li><strong>Pros</strong>: Simple, flexible</li>
|
|
<li><strong>Cons</strong>: No type safety, easy to forget cases</li>
|
|
</ul>
|
|
<h3 id="-two-tier-domain--http-wrapper-chosen"><a class="header" href="#-two-tier-domain--http-wrapper-chosen">✅ Two-Tier (Domain + HTTP wrapper) (CHOSEN)</a></h3>
|
|
<ul>
|
|
<li>Clean separation, reusable, type-safe</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
|
|
<p><strong>Pros</strong>:</p>
|
|
<ul>
|
|
<li>✅ Domain logic independent of HTTP</li>
|
|
<li>✅ Error types reusable in different contexts</li>
|
|
<li>✅ Type-safe error handling</li>
|
|
<li>✅ Explicit HTTP status code mapping</li>
|
|
</ul>
|
|
<p><strong>Cons</strong>:</p>
|
|
<ul>
|
|
<li>⚠️ Two error types to maintain</li>
|
|
<li>⚠️ Conversion logic between layers</li>
|
|
<li>⚠️ Slightly more verbose</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
|
|
<p><strong>Domain Error Type</strong>:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>// crates/vapora-shared/src/error.rs
|
|
|
|
use thiserror::Error;
|
|
|
|
#[derive(Error, Debug)]
|
|
pub enum VaporaError {
|
|
#[error("Project not found: {0}")]
|
|
ProjectNotFound(String),
|
|
|
|
#[error("Task not found: {0}")]
|
|
TaskNotFound(String),
|
|
|
|
#[error("Unauthorized access to resource: {0}")]
|
|
Unauthorized(String),
|
|
|
|
#[error("Agent {agent_id} failed with: {reason}")]
|
|
AgentExecutionFailed { agent_id: String, reason: String },
|
|
|
|
#[error("Budget exceeded for role {role}: spent ${spent}, limit ${limit}")]
|
|
BudgetExceeded { role: String, spent: u32, limit: u32 },
|
|
|
|
#[error("Database error: {0}")]
|
|
DatabaseError(#[from] surrealdb::Error),
|
|
|
|
#[error("External service error: {service}: {message}")]
|
|
ExternalServiceError { service: String, message: String },
|
|
|
|
#[error("Invalid request: {0}")]
|
|
ValidationError(String),
|
|
|
|
#[error("Internal server error: {0}")]
|
|
Internal(String),
|
|
}
|
|
|
|
pub type Result<T> = std::result::Result<T, VaporaError>;
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>HTTP Wrapper Type</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/error.rs
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
use axum::{
|
|
http::StatusCode,
|
|
response::{IntoResponse, Response},
|
|
Json,
|
|
};
|
|
use vapora_shared::error::VaporaError;
|
|
|
|
#[derive(Serialize, Deserialize, Debug)]
|
|
pub struct ApiError {
|
|
pub code: String,
|
|
pub message: String,
|
|
pub status: u16,
|
|
}
|
|
|
|
impl ApiError {
|
|
pub fn new(code: impl Into<String>, message: impl Into<String>, status: u16) -> Self {
|
|
Self {
|
|
code: code.into(),
|
|
message: message.into(),
|
|
status,
|
|
}
|
|
}
|
|
}
|
|
|
|
// Convert domain error to HTTP response
|
|
impl From<VaporaError> for ApiError {
|
|
fn from(err: VaporaError) -> Self {
|
|
match err {
|
|
VaporaError::ProjectNotFound(id) => {
|
|
ApiError::new("NOT_FOUND", format!("Project {} not found", id), 404)
|
|
}
|
|
VaporaError::TaskNotFound(id) => {
|
|
ApiError::new("NOT_FOUND", format!("Task {} not found", id), 404)
|
|
}
|
|
VaporaError::Unauthorized(reason) => {
|
|
ApiError::new("UNAUTHORIZED", reason, 401)
|
|
}
|
|
VaporaError::ValidationError(msg) => {
|
|
ApiError::new("BAD_REQUEST", msg, 400)
|
|
}
|
|
VaporaError::BudgetExceeded { role, spent, limit } => {
|
|
ApiError::new(
|
|
"BUDGET_EXCEEDED",
|
|
format!("Role {} budget exceeded: ${}/{}", role, spent, limit),
|
|
429, // Too Many Requests
|
|
)
|
|
}
|
|
VaporaError::AgentExecutionFailed { agent_id, reason } => {
|
|
ApiError::new(
|
|
"AGENT_ERROR",
|
|
format!("Agent {} execution failed: {}", agent_id, reason),
|
|
503, // Service Unavailable
|
|
)
|
|
}
|
|
VaporaError::ExternalServiceError { service, message } => {
|
|
ApiError::new(
|
|
"SERVICE_ERROR",
|
|
format!("External service {} error: {}", service, message),
|
|
502, // Bad Gateway
|
|
)
|
|
}
|
|
VaporaError::DatabaseError(db_err) => {
|
|
ApiError::new("DATABASE_ERROR", "Database operation failed", 500)
|
|
}
|
|
VaporaError::Internal(msg) => {
|
|
ApiError::new("INTERNAL_ERROR", msg, 500)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
impl IntoResponse for ApiError {
|
|
fn into_response(self) -> Response {
|
|
let status = StatusCode::from_u16(self.status).unwrap_or(StatusCode::INTERNAL_SERVER_ERROR);
|
|
(status, Json(self)).into_response()
|
|
}
|
|
}
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Usage in Handlers</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 get_project(
|
|
State(app_state): State<AppState>,
|
|
Path(project_id): Path<String>,
|
|
) -> Result<Json<Project>, ApiError> {
|
|
let user = get_current_user()?;
|
|
|
|
// Service returns VaporaError
|
|
let project = app_state
|
|
.project_service
|
|
.get_project(&user.tenant_id, &project_id)
|
|
.await
|
|
.map_err(ApiError::from)?; // Convert to HTTP error
|
|
|
|
Ok(Json(project))
|
|
}
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Usage in 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/services/project_service.rs
|
|
|
|
pub async fn get_project(
|
|
&self,
|
|
tenant_id: &str,
|
|
project_id: &str,
|
|
) -> Result<Project> {
|
|
let project = self
|
|
.db
|
|
.query("SELECT * FROM projects WHERE id = $1 AND tenant_id = $2")
|
|
.bind((project_id, tenant_id))
|
|
.await? // ? propagates database errors
|
|
.take::<Option<Project>>(0)?
|
|
.ok_or_else(|| VaporaError::ProjectNotFound(project_id.to_string()))?;
|
|
|
|
Ok(project)
|
|
}
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Key Files</strong>:</p>
|
|
<ul>
|
|
<li><code>/crates/vapora-shared/src/error.rs</code> (domain errors)</li>
|
|
<li><code>/crates/vapora-backend/src/api/error.rs</code> (HTTP wrapper)</li>
|
|
<li><code>/crates/vapora-backend/src/api/</code> (handlers using errors)</li>
|
|
<li><code>/crates/vapora-backend/src/services/</code> (services using errors)</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
|
|
<pre><code class="language-bash"># Test error creation and conversion
|
|
cargo test -p vapora-backend test_error_conversion
|
|
|
|
# Test HTTP status code mapping
|
|
cargo test -p vapora-backend test_error_status_codes
|
|
|
|
# Test error propagation with ?
|
|
cargo test -p vapora-backend test_error_propagation
|
|
|
|
# Test API responses with errors
|
|
cargo test -p vapora-backend test_api_error_response
|
|
|
|
# Integration: full error flow
|
|
cargo test -p vapora-backend test_error_full_flow
|
|
</code></pre>
|
|
<p><strong>Expected Output</strong>:</p>
|
|
<ul>
|
|
<li>Domain errors created correctly</li>
|
|
<li>Status codes mapped appropriately</li>
|
|
<li>Error messages clear and helpful</li>
|
|
<li>HTTP responses valid JSON</li>
|
|
<li>Error propagation with ? works</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
|
|
<h3 id="error-handling-pattern"><a class="header" href="#error-handling-pattern">Error Handling Pattern</a></h3>
|
|
<ul>
|
|
<li>Use <code>?</code> operator for propagation</li>
|
|
<li>Convert at HTTP boundary only</li>
|
|
<li>Domain logic error-agnostic</li>
|
|
</ul>
|
|
<h3 id="maintainability"><a class="header" href="#maintainability">Maintainability</a></h3>
|
|
<ul>
|
|
<li>Errors centralized in shared crate</li>
|
|
<li>HTTP mapping documented in one place</li>
|
|
<li>Easy to add new error types</li>
|
|
</ul>
|
|
<h3 id="reusability"><a class="header" href="#reusability">Reusability</a></h3>
|
|
<ul>
|
|
<li>Same error type in CLI tools</li>
|
|
<li>Agents can use domain errors</li>
|
|
<li>Frontend consumes HTTP errors</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="references"><a class="header" href="#references">References</a></h2>
|
|
<ul>
|
|
<li><a href="https://docs.rs/thiserror/latest/thiserror/">thiserror Documentation</a></li>
|
|
<li><code>/crates/vapora-shared/src/error.rs</code> (domain errors)</li>
|
|
<li><code>/crates/vapora-backend/src/api/error.rs</code> (HTTP wrapper)</li>
|
|
</ul>
|
|
<hr />
|
|
<p><strong>Related ADRs</strong>: ADR-024 (Service Architecture)</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../../adrs/0021-websocket-updates.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/0023-testing-strategy.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/0021-websocket-updates.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/0023-testing-strategy.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>
|