spa hardening, offline logging, rate limit fixes

server:
- backup exporter, auth extractors, error shapes, CONTEXT (prior work)
- spa assets served outside the rate limit via route_layer
- requests_per_second went to per_second(), which takes an interval not a
  rate: 50 meant one request per 50s once burst was spent. now converted
  properly. 15/s, burst 60

spa fixes:
- account delete cleared snake_case token keys that were never written
- refresh interceptor could retry forever
- date ranges used local day boundaries stamped +00:00
- "all" period trend plotted one page; calendar days fabricated mood 3
- chart grid invisible: hsl(var(--border)) against rgba tokens
- blob url leak, orphaned media on failed save, devtools in prod bundle
- pt-safe/safe-area-pb classes never existed

spa features:
- offline outbox: entries queue to IndexedDB, replay with backoff, only
  server refusals count against an entry
- drafts persist, quick-log sheet, diary infinite scroll + filters
- route error boundary, stale-chunk recovery, no service worker in dev

a11y + perf:
- mood picker is a radiogroup, activity picker keyboard-operable,
  text alternatives for colour/emoji, locale week start
- dark glass over the bright photo: worst case 1.4:1 -> 4.9-9.6:1
- initial payload 1095->769kB raw, 306->230kB gzip; 38 unused components
  and 5 deps dropped; fonts 218->133kB

53 tests added (43 spa, 10 server)
This commit is contained in:
2026-08-28 14:59:21 +02:00
parent 23d052278a
commit bf148902ab
395 changed files with 13972 additions and 10635 deletions

View File

@@ -11,6 +11,7 @@ config.workspace = true
web-push-adapter.workspace = true
axum.workspace = true
tower-http.workspace = true
tower_governor.workspace = true
async-trait.workspace = true
serde.workspace = true
serde_json.workspace = true
@@ -18,3 +19,8 @@ uuid.workspace = true
utoipa.workspace = true
utoipa-scalar.workspace = true
tracing.workspace = true
[dev-dependencies]
tower.workspace = true
http-body-util.workspace = true
tokio.workspace = true

View File

@@ -3,24 +3,37 @@ use axum::http::StatusCode;
use axum::response::{IntoResponse, Response};
use api_types::errors::ApiValidationError;
use api_types::responses::ErrorResponse;
use application::errors::ApplicationError;
use domain::errors::DomainError;
pub const NOT_FOUND: &str = "NOT_FOUND";
pub const INVALID_INPUT: &str = "INVALID_INPUT";
pub const CONFLICT: &str = "CONFLICT";
pub const UNAUTHORIZED: &str = "UNAUTHORIZED";
pub const FORBIDDEN: &str = "FORBIDDEN";
pub const VALIDATION_ERROR: &str = "VALIDATION_ERROR";
pub const TOO_MANY_REQUESTS: &str = "TOO_MANY_REQUESTS";
pub const INTERNAL_ERROR: &str = "INTERNAL_ERROR";
pub struct ApiError(pub ApplicationError);
pub fn refuse(status: StatusCode, code: &str, message: impl Into<String>) -> Response {
(status, Json(ErrorResponse::new(code, message))).into_response()
}
impl IntoResponse for ApiError {
fn into_response(self) -> Response {
let (status, code, message) = match &self.0 {
ApplicationError::Domain(domain_err) => domain_error_response(domain_err),
ApplicationError::Validation(msg) => (
StatusCode::UNPROCESSABLE_ENTITY,
"VALIDATION_ERROR",
VALIDATION_ERROR,
msg.clone(),
),
};
let body = serde_json::json!({ "error": { "code": code, "message": message } });
(status, Json(body)).into_response()
refuse(status, code, message)
}
}
@@ -47,10 +60,10 @@ impl From<DomainError> for ApiError {
fn domain_error_response(err: &DomainError) -> (StatusCode, &'static str, String) {
match err {
DomainError::NotFound(msg) => (StatusCode::NOT_FOUND, "NOT_FOUND", msg.clone()),
DomainError::InvalidInput(msg) => (StatusCode::BAD_REQUEST, "INVALID_INPUT", msg.clone()),
DomainError::Conflict(msg) => (StatusCode::CONFLICT, "CONFLICT", msg.clone()),
DomainError::Unauthorized(msg) => (StatusCode::UNAUTHORIZED, "UNAUTHORIZED", msg.clone()),
DomainError::Forbidden(msg) => (StatusCode::FORBIDDEN, "FORBIDDEN", msg.clone()),
DomainError::NotFound(msg) => (StatusCode::NOT_FOUND, NOT_FOUND, msg.clone()),
DomainError::InvalidInput(msg) => (StatusCode::BAD_REQUEST, INVALID_INPUT, msg.clone()),
DomainError::Conflict(msg) => (StatusCode::CONFLICT, CONFLICT, msg.clone()),
DomainError::Unauthorized(msg) => (StatusCode::UNAUTHORIZED, UNAUTHORIZED, msg.clone()),
DomainError::Forbidden(msg) => (StatusCode::FORBIDDEN, FORBIDDEN, msg.clone()),
}
}

View File

@@ -1,57 +0,0 @@
use axum::Json;
use axum::extract::FromRequestParts;
use axum::http::StatusCode;
use axum::http::request::Parts;
use axum::response::{IntoResponse, Response};
use domain::user::UserId;
use crate::state::AppState;
pub struct AuthenticatedUser(pub UserId);
impl IntoResponse for AuthRejection {
fn into_response(self) -> Response {
let body = serde_json::json!({ "error": self.0 });
(StatusCode::UNAUTHORIZED, Json(body)).into_response()
}
}
pub struct AuthRejection(String);
impl AuthRejection {
pub fn new(reason: impl Into<String>) -> Self {
Self(reason.into())
}
}
impl<S> FromRequestParts<S> for AuthenticatedUser
where
S: Send + Sync,
AppState: FromRef<S>,
{
type Rejection = AuthRejection;
async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
let app_state = AppState::from_ref(state);
let token = bearer_token(parts)
.ok_or_else(|| AuthRejection("missing or invalid authorization header".into()))?;
let user_id = app_state
.auth_service
.validate_token(&token)
.await
.map_err(|_| AuthRejection("invalid or expired token".into()))?;
Ok(AuthenticatedUser(user_id))
}
}
pub fn bearer_token(parts: &Parts) -> Option<String> {
let header = parts.headers.get("authorization")?.to_str().ok()?;
let token = header.strip_prefix("Bearer ")?;
Some(token.to_string())
}
use axum::extract::FromRef;

View File

@@ -0,0 +1,145 @@
use axum::http::StatusCode;
use axum::http::request::Parts;
use axum::response::{IntoResponse, Response};
use application::errors::ApplicationError;
use domain::api_token::{ApiToken, TokenScope};
use domain::errors::DomainError;
use domain::metric::Source;
use domain::user::UserId;
use application::api_token::use_cases::authenticate_api_token;
use crate::errors::{FORBIDDEN, UNAUTHORIZED, refuse};
use crate::state::AppState;
pub struct AuthRejection {
status: StatusCode,
code: &'static str,
reason: String,
}
impl AuthRejection {
pub fn new(reason: impl Into<String>) -> Self {
Self {
status: StatusCode::UNAUTHORIZED,
code: UNAUTHORIZED,
reason: reason.into(),
}
}
pub fn forbidding(reason: impl Into<String>) -> Self {
Self {
status: StatusCode::FORBIDDEN,
code: FORBIDDEN,
reason: reason.into(),
}
}
}
impl IntoResponse for AuthRejection {
fn into_response(self) -> Response {
refuse(self.status, self.code, self.reason)
}
}
pub enum Bearer {
Session(UserId),
Token(ApiToken),
}
impl Bearer {
pub fn user_id(&self) -> &UserId {
match self {
Self::Session(user_id) => user_id,
Self::Token(token) => token.user_id(),
}
}
pub fn into_user_id(self) -> UserId {
match self {
Self::Session(user_id) => user_id,
Self::Token(token) => token.user_id().clone(),
}
}
pub fn attributes_writes_to(&self) -> Source {
match self {
Self::Session(_) => Source::Manual,
Self::Token(token) => Source::Provider(token.name().clone()),
}
}
}
pub fn bearer_token(parts: &Parts) -> Option<String> {
let header = parts.headers.get("authorization")?.to_str().ok()?;
let token = header.strip_prefix("Bearer ")?;
Some(token.to_string())
}
pub async fn session_only(parts: &Parts, state: &AppState) -> Result<UserId, AuthRejection> {
let presented = bearer_token(parts)
.ok_or_else(|| AuthRejection::new("missing or invalid authorization header"))?;
state
.auth_service
.validate_token(&presented)
.await
.map_err(|_| {
AuthRejection::new("this endpoint needs a signed-in session, not an api token")
})
}
pub async fn administrator(parts: &Parts, state: &AppState) -> Result<UserId, AuthRejection> {
let user_id = session_only(parts, state).await?;
let user = state
.user_query
.find_by_id(&user_id)
.await
.map_err(|_| AuthRejection::new("this account could not be read"))?
.ok_or_else(|| AuthRejection::new("this account no longer exists"))?;
if !user.is_admin() {
return Err(AuthRejection::forbidding(
"this endpoint is for whoever runs the server",
));
}
Ok(user_id)
}
pub async fn session_or_token_granting(
parts: &Parts,
state: &AppState,
needed: TokenScope,
) -> Result<Bearer, AuthRejection> {
let presented = bearer_token(parts)
.ok_or_else(|| AuthRejection::new("missing or invalid authorization header"))?;
if let Ok(user_id) = state.auth_service.validate_token(&presented).await {
return Ok(Bearer::Session(user_id));
}
let deps = authenticate_api_token::Deps {
query: state.api_token_query.clone(),
command: state.api_token_command.clone(),
secrets: state.api_token_secrets.clone(),
};
let token = authenticate_api_token::execute(&presented, needed, &deps)
.await
.map_err(refusal_for)?;
Ok(Bearer::Token(token))
}
fn refusal_for(error: ApplicationError) -> AuthRejection {
match error {
ApplicationError::Domain(DomainError::Forbidden(reason)) => {
AuthRejection::forbidding(reason)
}
other => AuthRejection::new(other.to_string()),
}
}

View File

@@ -0,0 +1,59 @@
use axum::extract::rejection::{JsonRejection, QueryRejection};
use axum::extract::{FromRequest, FromRequestParts, Query, Request};
use axum::http::StatusCode;
use axum::http::request::Parts;
use axum::response::{IntoResponse, Response};
use crate::errors::{INVALID_INPUT, refuse};
pub struct Body<T>(pub T);
pub struct Params<T>(pub T);
pub struct MalformedRequest(String);
impl IntoResponse for MalformedRequest {
fn into_response(self) -> Response {
refuse(StatusCode::BAD_REQUEST, INVALID_INPUT, self.0)
}
}
impl From<JsonRejection> for MalformedRequest {
fn from(rejection: JsonRejection) -> Self {
Self(rejection.body_text())
}
}
impl From<QueryRejection> for MalformedRequest {
fn from(rejection: QueryRejection) -> Self {
Self(rejection.body_text())
}
}
impl<S, T> FromRequest<S> for Body<T>
where
S: Send + Sync,
axum::Json<T>: FromRequest<S, Rejection = JsonRejection>,
{
type Rejection = MalformedRequest;
async fn from_request(request: Request, state: &S) -> Result<Self, Self::Rejection> {
let axum::Json(value) = axum::Json::<T>::from_request(request, state).await?;
Ok(Self(value))
}
}
impl<S, T> FromRequestParts<S> for Params<T>
where
S: Send + Sync,
Query<T>: FromRequestParts<S, Rejection = QueryRejection>,
{
type Rejection = MalformedRequest;
async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
let Query(value) = Query::<T>::from_request_parts(parts, state).await?;
Ok(Self(value))
}
}

View File

@@ -8,7 +8,9 @@ use application::api_token::use_cases::authenticate_api_token;
use crate::state::AppState;
use super::authenticated_user::{AuthRejection, bearer_token};
use domain::api_token::TokenScope;
use super::authentication::{AuthRejection, bearer_token};
pub struct ImportingProvider {
pub user_id: UserId,
@@ -34,9 +36,13 @@ where
secrets: app_state.api_token_secrets,
};
let token = authenticate_api_token::execute(&presented, &deps)
let token = authenticate_api_token::execute(&presented, TokenScope::WriteMetrics, &deps)
.await
.map_err(|_| AuthRejection::new("importing needs an api token minted in settings"))?;
.map_err(|_| {
AuthRejection::new(
"importing needs an api token granting writeMetrics, minted in settings",
)
})?;
Ok(Self {
user_id: token.user_id().clone(),

View File

@@ -1,53 +0,0 @@
use axum::extract::{FromRef, FromRequestParts};
use axum::http::request::Parts;
use domain::metric::Source;
use domain::user::UserId;
use application::api_token::use_cases::authenticate_api_token;
use crate::state::AppState;
use super::authenticated_user::{AuthRejection, bearer_token};
pub struct MetricWriter {
pub user_id: UserId,
pub source: Source,
}
impl<S> FromRequestParts<S> for MetricWriter
where
S: Send + Sync,
AppState: FromRef<S>,
{
type Rejection = AuthRejection;
async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
let app_state = AppState::from_ref(state);
let presented = bearer_token(parts)
.ok_or_else(|| AuthRejection::new("missing or invalid authorization header"))?;
if let Ok(user_id) = app_state.auth_service.validate_token(&presented).await {
return Ok(Self {
user_id,
source: Source::Manual,
});
}
let deps = authenticate_api_token::Deps {
query: app_state.api_token_query,
command: app_state.api_token_command,
secrets: app_state.api_token_secrets,
};
let token = authenticate_api_token::execute(&presented, &deps)
.await
.map_err(|_| AuthRejection::new("invalid or expired token"))?;
Ok(Self {
user_id: token.user_id().clone(),
source: Source::Provider(token.name().clone()),
})
}
}

View File

@@ -1,11 +1,15 @@
pub mod authenticated_user;
pub mod authentication;
mod body;
mod importing_provider;
mod metric_writer;
mod multipart;
mod path_id;
mod scoped;
pub use authenticated_user::AuthenticatedUser;
pub use authentication::AuthRejection;
pub use body::{Body, Params};
pub use importing_provider::ImportingProvider;
pub use metric_writer::MetricWriter;
pub use multipart::{extract_file_bytes, extract_media_upload};
pub use path_id::PathId;
pub use scoped::{
Administrator, JournalReader, JournalWriter, MetricWriter, ProfileReader, SessionUser,
};

View File

@@ -1,4 +1,3 @@
use axum::Json;
use axum::extract::Path;
use axum::http::StatusCode;
use axum::response::{IntoResponse, Response};
@@ -9,8 +8,11 @@ pub struct PathIdRejection(String);
impl IntoResponse for PathIdRejection {
fn into_response(self) -> Response {
let body = serde_json::json!({ "error": self.0 });
(StatusCode::BAD_REQUEST, Json(body)).into_response()
crate::errors::refuse(
StatusCode::BAD_REQUEST,
crate::errors::INVALID_INPUT,
self.0,
)
}
}

View File

@@ -0,0 +1,99 @@
use axum::extract::{FromRef, FromRequestParts};
use axum::http::request::Parts;
use domain::api_token::TokenScope;
use domain::metric::Source;
use domain::user::UserId;
use crate::state::AppState;
use super::authentication::{
AuthRejection, administrator, session_only, session_or_token_granting,
};
pub struct SessionUser(pub UserId);
pub struct Administrator(pub UserId);
pub struct JournalReader(pub UserId);
pub struct JournalWriter(pub UserId);
pub struct ProfileReader(pub UserId);
pub struct MetricWriter {
pub user_id: UserId,
pub source: Source,
}
impl<S> FromRequestParts<S> for SessionUser
where
S: Send + Sync,
AppState: FromRef<S>,
{
type Rejection = AuthRejection;
async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
let state = AppState::from_ref(state);
Ok(Self(session_only(parts, &state).await?))
}
}
impl<S> FromRequestParts<S> for Administrator
where
S: Send + Sync,
AppState: FromRef<S>,
{
type Rejection = AuthRejection;
async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
let state = AppState::from_ref(state);
Ok(Self(administrator(parts, &state).await?))
}
}
macro_rules! scoped_extractor {
($name:ident, $scope:expr) => {
impl<S> FromRequestParts<S> for $name
where
S: Send + Sync,
AppState: FromRef<S>,
{
type Rejection = AuthRejection;
async fn from_request_parts(
parts: &mut Parts,
state: &S,
) -> Result<Self, Self::Rejection> {
let state = AppState::from_ref(state);
let bearer = session_or_token_granting(parts, &state, $scope).await?;
Ok(Self(bearer.into_user_id()))
}
}
};
}
scoped_extractor!(JournalReader, TokenScope::ReadJournal);
scoped_extractor!(JournalWriter, TokenScope::WriteJournal);
scoped_extractor!(ProfileReader, TokenScope::ReadProfile);
impl<S> FromRequestParts<S> for MetricWriter
where
S: Send + Sync,
AppState: FromRef<S>,
{
type Rejection = AuthRejection;
async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Self::Rejection> {
let state = AppState::from_ref(state);
let bearer = session_or_token_granting(parts, &state, TokenScope::WriteMetrics).await?;
Ok(Self {
source: bearer.attributes_writes_to(),
user_id: bearer.into_user_id(),
})
}
}

View File

@@ -2,8 +2,9 @@ use axum::Json;
use axum::extract::State;
use axum::http::StatusCode;
use api_types::params::ListActivitiesParams;
use api_types::requests::{CreateActivityRequest, RenameActivityRequest, SetCategoryRequest};
use api_types::responses::ActivityResponse;
use api_types::responses::{ActivityResponse, ErrorResponse};
use application::activity::use_cases::{
archive_activity, create_activity, delete_activity, get_activity, list_activities,
rename_activity, set_category,
@@ -11,17 +12,21 @@ use application::activity::use_cases::{
use domain::activity::ActivityId;
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, PathId};
use crate::extractors::{Body, JournalReader, JournalWriter, Params, PathId};
use crate::state::AppState;
#[utoipa::path(post, path = "/api/v1/activities", tag = "activities", security(("bearer" = [])),
request_body = CreateActivityRequest,
responses((status = 201, body = ActivityResponse))
responses((status = 201, body = ActivityResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_create(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<CreateActivityRequest>,
JournalWriter(user_id): JournalWriter,
Body(body): Body<CreateActivityRequest>,
) -> Result<(StatusCode, Json<ActivityResponse>), ApiError> {
let cmd = body.into_command(user_id)?;
let deps = create_activity::Deps {
@@ -34,11 +39,15 @@ pub async fn handle_create(
#[utoipa::path(get, path = "/api/v1/activities/{id}", tag = "activities", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 200, body = ActivityResponse))
responses((status = 200, body = ActivityResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_get(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
PathId(activity_id): PathId<ActivityId>,
) -> Result<Json<ActivityResponse>, ApiError> {
let deps = get_activity::Deps {
@@ -49,16 +58,28 @@ pub async fn handle_get(
}
#[utoipa::path(get, path = "/api/v1/activities", tag = "activities", security(("bearer" = [])),
responses((status = 200, body = Vec<ActivityResponse>))
description = "This account's activity catalogue. Archived activities are left out unless \
`includeArchived` asks for them, because they cannot be tagged onto anything \
new — but they stay listable, so a client can show them and unarchive one.",
params(ListActivitiesParams),
responses((status = 200, body = Vec<ActivityResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
Params(params): Params<ListActivitiesParams>,
) -> Result<Json<Vec<ActivityResponse>>, ApiError> {
let deps = list_activities::Deps {
query: state.activity_query,
};
let activities = list_activities::active_only(user_id, &deps).await?;
let activities = match params.include_archived.unwrap_or(false) {
true => list_activities::all(user_id, &deps).await?,
false => list_activities::active_only(user_id, &deps).await?,
};
Ok(Json(
activities.into_iter().map(ActivityResponse::from).collect(),
))
@@ -67,13 +88,17 @@ pub async fn handle_list(
#[utoipa::path(patch, path = "/api/v1/activities/{id}/name", tag = "activities", security(("bearer" = [])),
params(("id" = String, Path)),
request_body = RenameActivityRequest,
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_rename(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(activity_id): PathId<ActivityId>,
Json(body): Json<RenameActivityRequest>,
Body(body): Body<RenameActivityRequest>,
) -> Result<StatusCode, ApiError> {
let cmd = body.into_command(activity_id)?;
let deps = rename_activity::Deps {
@@ -88,13 +113,17 @@ pub async fn handle_rename(
#[utoipa::path(patch, path = "/api/v1/activities/{id}/category", tag = "activities", security(("bearer" = [])),
params(("id" = String, Path)),
request_body = SetCategoryRequest,
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_set_category(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(activity_id): PathId<ActivityId>,
Json(body): Json<SetCategoryRequest>,
Body(body): Body<SetCategoryRequest>,
) -> Result<StatusCode, ApiError> {
let cmd = body.into_command(activity_id)?;
let deps = set_category::Deps {
@@ -107,11 +136,15 @@ pub async fn handle_set_category(
#[utoipa::path(post, path = "/api/v1/activities/{id}/archive", tag = "activities", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_archive(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(activity_id): PathId<ActivityId>,
) -> Result<StatusCode, ApiError> {
let deps = archive_activity::Deps {
@@ -125,11 +158,15 @@ pub async fn handle_archive(
#[utoipa::path(post, path = "/api/v1/activities/{id}/unarchive", tag = "activities", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_unarchive(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(activity_id): PathId<ActivityId>,
) -> Result<StatusCode, ApiError> {
let deps = archive_activity::Deps {
@@ -143,14 +180,19 @@ pub async fn handle_unarchive(
#[utoipa::path(delete, path = "/api/v1/activities/{id}", tag = "activities", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_delete(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(activity_id): PathId<ActivityId>,
) -> Result<StatusCode, ApiError> {
let deps = delete_activity::Deps {
entries: state.entry_query.clone(),
command: state.activity_command,
query: state.activity_query,
};

View File

@@ -3,20 +3,23 @@ use axum::extract::State;
use axum::http::StatusCode;
use api_types::requests::LoginRequest;
use api_types::responses::UserResponse;
use api_types::responses::{ErrorResponse, RefreshedResponse, SignedInResponse, UserResponse};
use application::auth::use_cases::{login, logout, refresh};
use crate::errors::ApiError;
use crate::extractors::Body;
use crate::state::AppState;
#[utoipa::path(post, path = "/api/v1/auth/login", tag = "auth",
request_body = LoginRequest,
responses((status = 200, description = "Login successful"))
responses((status = 200, body = SignedInResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_login(
State(state): State<AppState>,
Json(body): Json<LoginRequest>,
) -> Result<Json<serde_json::Value>, ApiError> {
Body(body): Body<LoginRequest>,
) -> Result<Json<SignedInResponse>, ApiError> {
let cmd = body.into_command();
let deps = login::Deps {
user_query: state.user_query,
@@ -27,14 +30,13 @@ pub async fn handle_login(
};
let result = login::execute(cmd, &deps).await?;
let user_response = UserResponse::from(result.user);
Ok(Json(serde_json::json!({
"accessToken": result.access_token.token(),
"refreshToken": result.refresh_token,
"expiresAt": result.access_token.expires_at(),
"user": user_response,
})))
Ok(Json(SignedInResponse {
access_token: result.access_token.token().to_string(),
refresh_token: result.refresh_token,
expires_at: *result.access_token.expires_at(),
user: UserResponse::from(result.user),
}))
}
#[derive(serde::Deserialize, utoipa::ToSchema)]
@@ -45,12 +47,14 @@ pub struct RefreshRequest {
#[utoipa::path(post, path = "/api/v1/auth/refresh", tag = "auth",
request_body = RefreshRequest,
responses((status = 200, description = "Token refreshed"))
responses((status = 200, body = RefreshedResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_refresh(
State(state): State<AppState>,
Json(body): Json<RefreshRequest>,
) -> Result<Json<serde_json::Value>, ApiError> {
Body(body): Body<RefreshRequest>,
) -> Result<Json<RefreshedResponse>, ApiError> {
let deps = refresh::Deps {
auth_service: state.auth_service,
refresh_session_command: state.refresh_session_command,
@@ -60,11 +64,11 @@ pub async fn handle_refresh(
let result = refresh::execute(&body.refresh_token, &deps).await?;
Ok(Json(serde_json::json!({
"accessToken": result.access_token.token(),
"refreshToken": result.refresh_token,
"expiresAt": result.access_token.expires_at(),
})))
Ok(Json(RefreshedResponse {
access_token: result.access_token.token().to_string(),
refresh_token: result.refresh_token,
expires_at: *result.access_token.expires_at(),
}))
}
#[derive(serde::Deserialize, utoipa::ToSchema)]
@@ -75,11 +79,13 @@ pub struct LogoutRequest {
#[utoipa::path(post, path = "/api/v1/auth/logout", tag = "auth",
request_body = LogoutRequest,
responses((status = 204, description = "Logged out"))
responses((status = 204, description = "Logged out"),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_logout(
State(state): State<AppState>,
Json(body): Json<LogoutRequest>,
Body(body): Body<LogoutRequest>,
) -> Result<StatusCode, ApiError> {
let deps = logout::Deps {
refresh_session_command: state.refresh_session_command,

View File

@@ -1,13 +1,13 @@
use axum::Json;
use axum::extract::{Query, State};
use axum::extract::State;
use api_types::requests::DateSpanParams;
use api_types::responses::CorrelationRowResponse;
use api_types::params::DateSpanParams;
use api_types::responses::{CorrelationRowResponse, ErrorResponse};
use application::correlation::queries::CorrelationQuery;
use application::correlation::use_cases::get_correlations;
use crate::errors::ApiError;
use crate::extractors::AuthenticatedUser;
use crate::extractors::{JournalReader, Params};
use crate::state::AppState;
#[utoipa::path(get, path = "/api/v1/correlations", tag = "correlations", security(("bearer" = [])),
@@ -18,12 +18,16 @@ use crate::state::AppState;
never ranked by strength. Below the configured minimum sample size a row \
carries its day count and no coefficient.",
params(DateSpanParams),
responses((status = 200, body = Vec<CorrelationRowResponse>))
responses((status = 200, body = Vec<CorrelationRowResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Query(params): Query<DateSpanParams>,
JournalReader(user_id): JournalReader,
Params(params): Params<DateSpanParams>,
) -> Result<Json<Vec<CorrelationRowResponse>>, ApiError> {
let span = params.into_span()?;
@@ -33,6 +37,7 @@ pub async fn handle_list(
activities: state.activity_query,
cycles: state.cycle_query,
weather_store: state.weather_store,
activity_store: state.activity_store,
preferences: state.preferences_query,
users: state.user_query,
};

View File

@@ -4,23 +4,27 @@ use axum::http::StatusCode;
use api_types::mappers::parse_date;
use api_types::requests::SetPreferencesRequest;
use api_types::responses::{CycleViewResponse, PreferencesResponse};
use api_types::responses::{CycleViewResponse, ErrorResponse, PreferencesResponse};
use application::cycle::use_cases::{forget_cycle_start, read_cycle, record_cycle_start};
use application::user::use_cases::set_preferences;
use crate::errors::ApiError;
use crate::extractors::AuthenticatedUser;
use crate::extractors::{Body, JournalReader, JournalWriter, ProfileReader, SessionUser};
use crate::state::AppState;
#[utoipa::path(get, path = "/api/v1/cycle", tag = "cycle", security(("bearer" = [])),
description = "The recorded cycle starts and the cycle day derived for today. Cycle day is \
never stored: correcting a start corrects every day that depended on it. \
Returns nothing at all while cycle tracking is off.",
responses((status = 200, body = CycleViewResponse))
responses((status = 200, body = CycleViewResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_read(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
) -> Result<Json<CycleViewResponse>, ApiError> {
let deps = read_cycle::Deps {
query: state.cycle_query,
@@ -37,11 +41,15 @@ pub async fn handle_read(
description = "Records that a cycle began on this date. Recording the same date twice \
records it once.",
params(("date" = String, Path, description = "Calendar date, as YYYY-MM-DD")),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_record(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
Path(date): Path<String>,
) -> Result<StatusCode, ApiError> {
let deps = record_cycle_start::Deps {
@@ -58,11 +66,15 @@ pub async fn handle_record(
description = "Forgets a recorded start. Every day that derived its cycle day from it \
changes at once.",
params(("date" = String, Path, description = "Calendar date, as YYYY-MM-DD")),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_forget(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
Path(date): Path<String>,
) -> Result<StatusCode, ApiError> {
let deps = forget_cycle_start::Deps {
@@ -78,12 +90,16 @@ pub async fn handle_forget(
description = "Turns optional features on or off. Cycle tracking is off until turned on, \
and turning it off hides the cycle without forgetting what was recorded.",
request_body = SetPreferencesRequest,
responses((status = 200, body = PreferencesResponse))
responses((status = 200, body = PreferencesResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_set_preferences(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<SetPreferencesRequest>,
SessionUser(user_id): SessionUser,
Body(body): Body<SetPreferencesRequest>,
) -> Result<Json<PreferencesResponse>, ApiError> {
let deps = set_preferences::Deps {
command: state.preferences_command,
@@ -96,11 +112,15 @@ pub async fn handle_set_preferences(
}
#[utoipa::path(get, path = "/api/v1/users/me/preferences", tag = "users", security(("bearer" = [])),
responses((status = 200, body = PreferencesResponse))
responses((status = 200, body = PreferencesResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_preferences(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
ProfileReader(user_id): ProfileReader,
) -> Result<Json<PreferencesResponse>, ApiError> {
let preferences =
application::user::preferences::preferences_of(&user_id, &state.preferences_query).await?;

View File

@@ -3,13 +3,13 @@ use axum::extract::{Multipart, State};
use axum::http::{StatusCode, header};
use axum::response::IntoResponse;
use api_types::responses::RestoreOutcomeResponse;
use api_types::responses::{ErrorResponse, RestoreOutcomeResponse};
use application::export::use_cases::{write_backup, write_extract};
use application::restore::commands::RestoreBackupCommand;
use application::restore::use_cases::restore_backup;
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, extract_file_bytes};
use crate::extractors::{SessionUser, extract_file_bytes};
use crate::state::AppState;
const BACKUP_FILENAME: &str = "k-mood-complete-backup.zip";
@@ -20,11 +20,15 @@ const EXTRACT_FILENAME: &str = "k-mood-shareable-journal.md";
every cycle start, the activity catalogue, reminders, preferences and all \
media. Restores through /data/restore. Keep it private — it holds everything \
the account knows.",
responses((status = 200, description = "A zip archive", content_type = "application/zip"))
responses((status = 200, description = "A zip archive", content_type = "application/zip"),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_backup(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
) -> Result<impl IntoResponse, ApiError> {
let deps = write_backup::Deps {
entries: state.entry_query,
@@ -48,11 +52,15 @@ pub async fn handle_backup(
readable markdown document. It carries no places, no health readings, no \
cycle records and no media, and it cannot be restored from. This is the one \
to hand to someone.",
responses((status = 200, description = "A markdown document", content_type = "text/markdown"))
responses((status = 200, description = "A markdown document", content_type = "text/markdown"),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_extract(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
) -> Result<impl IntoResponse, ApiError> {
let deps = write_extract::Deps {
entries: state.entry_query,
@@ -74,16 +82,23 @@ pub async fn handle_extract(
description = "Restores a complete backup into this account. Existing data is kept: a \
restore adds, it does not replace. Anything in the archive this build cannot \
read is reported rather than silently dropped.",
responses((status = 200, body = RestoreOutcomeResponse))
responses((status = 200, body = RestoreOutcomeResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_restore(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
multipart: Multipart,
) -> Result<Json<RestoreOutcomeResponse>, ApiError> {
let data = extract_file_bytes(multipart).await?;
let deps = restore_backup::Deps {
entry_query: state.entry_query.clone(),
reminder_query: state.reminder_query.clone(),
media_ownership: state.media_ownership.clone(),
reader: state.backup_reader,
entry_command: state.entry_command,
dimensions: state.dimensions,

View File

@@ -1,26 +1,25 @@
use axum::Json;
use axum::extract::{Path, Query, State};
use axum::extract::{Path, State};
use axum::http::StatusCode;
use api_types::params::{DateRangeParams, ListEntriesParams};
use api_types::requests::{
CreateEntryRequest, DateRangeParams, ListEntriesParams, ReplaceActivityRequest,
UpdateEntryRequest,
CreateEntriesRequest, CreateEntryRequest, ReplaceActivityRequest, UpdateEntryRequest,
};
use api_types::responses::{
BulkActionResponse, CalendarDayResponse, EntryResponse, MoodStatsResponse,
BulkActionResponse, CalendarDayResponse, EntryPageResponse, EntryResponse, ErrorResponse,
MoodStatsResponse,
};
use application::entry::composition::EntryComposer;
use application::entry::queries::{FilterByActivityQuery, FilterByMoodQuery, MoodStatsQuery};
use application::entry::queries::MoodStatsQuery;
use application::entry::use_cases::{
create_entry, delete_entries_by_date_range, delete_entry, filter_by_activity, filter_by_mood,
get_calendar, get_entry, get_mood_stats, list_entries, replace_activity, update_entry,
create_entries, create_entry, delete_entries_by_date_range, delete_entry, get_calendar,
get_entry, get_mood_stats, list_entries, replace_activity, update_entry,
};
use domain::activity::ActivityId;
use domain::entry::MoodEntry;
use domain::entry::{Mood, MoodEntryId};
use domain::entry::{MoodEntry, MoodEntryId, Page};
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, PathId};
use crate::extractors::{Body, JournalReader, JournalWriter, Params, PathId};
use crate::state::AppState;
async fn compose(
@@ -31,6 +30,24 @@ async fn compose(
Ok(composed.into_iter().map(EntryResponse::from).collect())
}
async fn composed_page(
dimensions: Vec<std::sync::Arc<dyn domain::ports::EntryDimensionPort>>,
page: Page<MoodEntry>,
) -> Result<EntryPageResponse, ApiError> {
let total = page.total();
let limit = page.limit();
let offset = page.offset();
let has_more = page.more_after_this();
Ok(EntryPageResponse {
items: compose(dimensions, page.into_items()).await?,
total,
limit,
offset,
has_more,
})
}
async fn compose_one(
dimensions: Vec<std::sync::Arc<dyn domain::ports::EntryDimensionPort>>,
entry: MoodEntry,
@@ -41,16 +58,21 @@ async fn compose_one(
#[utoipa::path(post, path = "/api/v1/entries", tag = "entries", security(("bearer" = [])),
request_body = CreateEntryRequest,
responses((status = 201, body = EntryResponse))
responses((status = 201, body = EntryResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_create(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<CreateEntryRequest>,
JournalWriter(user_id): JournalWriter,
Body(body): Body<CreateEntryRequest>,
) -> Result<(StatusCode, Json<EntryResponse>), ApiError> {
let cmd = body.into_command(user_id, &state.entry_config)?;
let dimensions = state.dimensions.clone();
let deps = create_entry::Deps {
activities: state.activity_query.clone(),
entries: state.entry_command,
dimensions: state.dimensions.clone(),
events: state.event_publisher,
@@ -62,13 +84,55 @@ pub async fn handle_create(
))
}
#[utoipa::path(post, path = "/api/v1/entries/bulk", tag = "entries", security(("bearer" = [])),
description = "Creates many entries in one request, for a client syncing what it collected \
while offline. Either every entry is written or none is: one activity the \
account does not own refuses the whole batch.",
request_body = CreateEntriesRequest,
responses((status = 201, body = Vec<EntryResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_create_many(
State(state): State<AppState>,
JournalWriter(user_id): JournalWriter,
Body(body): Body<CreateEntriesRequest>,
) -> Result<(StatusCode, Json<Vec<EntryResponse>>), ApiError> {
let wanted = body
.entries
.into_iter()
.map(|one| one.into_command(user_id.clone(), &state.entry_config))
.collect::<Result<Vec<_>, _>>()?;
let dimensions = state.dimensions.clone();
let deps = create_entries::Deps {
entries: state.entry_command,
dimensions: state.dimensions.clone(),
activities: state.activity_query.clone(),
events: state.event_publisher,
};
let created = create_entries::execute(user_id, wanted, &deps).await?;
Ok((
StatusCode::CREATED,
Json(compose(dimensions, created).await?),
))
}
#[utoipa::path(get, path = "/api/v1/entries/{id}", tag = "entries", security(("bearer" = [])),
params(("id" = String, Path, description = "Entry ID")),
responses((status = 200, body = EntryResponse))
responses((status = 200, body = EntryResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_get(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
PathId(entry_id): PathId<MoodEntryId>,
) -> Result<Json<EntryResponse>, ApiError> {
let dimensions = state.dimensions.clone();
@@ -81,36 +145,52 @@ pub async fn handle_get(
#[utoipa::path(get, path = "/api/v1/entries", tag = "entries", security(("bearer" = [])),
params(ListEntriesParams),
responses((status = 200, body = Vec<EntryResponse>))
description = "One page of entries, newest first, narrowed by any combination of the \
parameters. `total` counts everything the selection matches, not the page, \
so a client can page with confidence. `updatedSince` returns only entries \
changed after that instant, which is what a polling client should use rather \
than refetching the journal.",
responses((status = 200, body = EntryPageResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Query(params): Query<ListEntriesParams>,
) -> Result<Json<Vec<EntryResponse>>, ApiError> {
let query = params.into_query(user_id)?;
JournalReader(user_id): JournalReader,
Params(params): Params<ListEntriesParams>,
) -> Result<Json<EntryPageResponse>, ApiError> {
let query = params.into_query(user_id, &state.entry_config)?;
let dimensions = state.dimensions.clone();
let deps = list_entries::Deps {
query: state.entry_query,
};
let entries = list_entries::execute(query, &deps).await?;
Ok(Json(compose(dimensions, entries).await?))
let page = list_entries::execute(query, &deps).await?;
Ok(Json(composed_page(dimensions, page).await?))
}
#[utoipa::path(patch, path = "/api/v1/entries/{id}", tag = "entries", security(("bearer" = [])),
params(("id" = String, Path, description = "Entry ID")),
request_body = UpdateEntryRequest,
responses((status = 200, body = EntryResponse))
responses((status = 200, body = EntryResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_update(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(entry_id): PathId<MoodEntryId>,
Json(body): Json<UpdateEntryRequest>,
Body(body): Body<UpdateEntryRequest>,
) -> Result<Json<EntryResponse>, ApiError> {
let cmd = body.into_command(entry_id, &state.entry_config)?;
let dimensions = state.dimensions.clone();
let deps = update_entry::Deps {
activities: state.activity_query.clone(),
command: state.entry_command,
dimensions: state.dimensions.clone(),
query: state.entry_query,
@@ -123,11 +203,15 @@ pub async fn handle_update(
#[utoipa::path(delete, path = "/api/v1/entries/{id}", tag = "entries", security(("bearer" = [])),
params(("id" = String, Path, description = "Entry ID")),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_delete(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(entry_id): PathId<MoodEntryId>,
) -> Result<StatusCode, ApiError> {
let deps = delete_entry::Deps {
@@ -142,53 +226,65 @@ pub async fn handle_delete(
}
#[utoipa::path(get, path = "/api/v1/entries/filter/mood/{mood}", tag = "entries", security(("bearer" = [])),
params(("mood" = u8, Path, description = "Mood value 1-5")),
responses((status = 200, body = Vec<EntryResponse>))
description = "A page of entries of one mood. The same selection is available on \
GET /entries as the `mood` parameter, alongside every other narrowing.",
params(("mood" = u8, Path, description = "Mood value 1-5"), ListEntriesParams),
responses((status = 200, body = EntryPageResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_filter_by_mood(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
reader: JournalReader,
Path(mood): Path<u8>,
) -> Result<Json<Vec<EntryResponse>>, ApiError> {
let mood = Mood::try_from(mood)?;
let query = FilterByMoodQuery { user_id, mood };
let dimensions = state.dimensions.clone();
let deps = filter_by_mood::Deps {
query: state.entry_query,
Params(params): Params<ListEntriesParams>,
) -> Result<Json<EntryPageResponse>, ApiError> {
let narrowed = ListEntriesParams {
mood: Some(mood),
..params
};
let entries = filter_by_mood::execute(query, &deps).await?;
Ok(Json(compose(dimensions, entries).await?))
handle_list(State(state), reader, Params(narrowed)).await
}
#[utoipa::path(get, path = "/api/v1/entries/filter/activity/{id}", tag = "entries", security(("bearer" = [])),
params(("id" = String, Path, description = "Activity ID")),
responses((status = 200, body = Vec<EntryResponse>))
description = "A page of entries tagged with one activity. The same selection is available \
on GET /entries as the `activity` parameter.",
params(("id" = String, Path, description = "Activity ID"), ListEntriesParams),
responses((status = 200, body = EntryPageResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_filter_by_activity(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
PathId(activity_id): PathId<ActivityId>,
) -> Result<Json<Vec<EntryResponse>>, ApiError> {
let query = FilterByActivityQuery {
user_id,
activity_id,
reader: JournalReader,
Path(activity_id): Path<String>,
Params(params): Params<ListEntriesParams>,
) -> Result<Json<EntryPageResponse>, ApiError> {
let narrowed = ListEntriesParams {
activity: Some(activity_id),
..params
};
let dimensions = state.dimensions.clone();
let deps = filter_by_activity::Deps {
query: state.entry_query,
};
let entries = filter_by_activity::execute(query, &deps).await?;
Ok(Json(compose(dimensions, entries).await?))
handle_list(State(state), reader, Params(narrowed)).await
}
#[utoipa::path(get, path = "/api/v1/entries/stats", tag = "entries", security(("bearer" = [])),
params(ListEntriesParams),
responses((status = 200, body = MoodStatsResponse))
responses((status = 200, body = MoodStatsResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_stats(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Query(params): Query<ListEntriesParams>,
JournalReader(user_id): JournalReader,
Params(params): Params<ListEntriesParams>,
) -> Result<Json<MoodStatsResponse>, ApiError> {
let range = match (params.from, params.to) {
(Some(from), Some(to)) => {
@@ -209,12 +305,16 @@ pub async fn handle_stats(
#[utoipa::path(get, path = "/api/v1/entries/calendar", tag = "entries", security(("bearer" = [])),
params(DateRangeParams),
responses((status = 200, body = Vec<CalendarDayResponse>))
responses((status = 200, body = Vec<CalendarDayResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_calendar(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Query(params): Query<DateRangeParams>,
JournalReader(user_id): JournalReader,
Params(params): Params<DateRangeParams>,
) -> Result<Json<Vec<CalendarDayResponse>>, ApiError> {
let range = params.into_date_range()?;
let deps = get_calendar::Deps {
@@ -232,12 +332,16 @@ pub async fn handle_calendar(
#[utoipa::path(delete, path = "/api/v1/entries/bulk/delete", tag = "entries", security(("bearer" = [])),
params(DateRangeParams),
responses((status = 200, body = BulkActionResponse))
responses((status = 200, body = BulkActionResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_delete_by_date_range(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Query(params): Query<DateRangeParams>,
JournalWriter(user_id): JournalWriter,
Params(params): Params<DateRangeParams>,
) -> Result<Json<BulkActionResponse>, ApiError> {
let range = params.into_date_range()?;
let deps = delete_entries_by_date_range::Deps {
@@ -252,12 +356,16 @@ pub async fn handle_delete_by_date_range(
#[utoipa::path(post, path = "/api/v1/entries/bulk/replace-activity", tag = "entries", security(("bearer" = [])),
request_body = ReplaceActivityRequest,
responses((status = 200, body = BulkActionResponse))
responses((status = 200, body = BulkActionResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_replace_activity(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<ReplaceActivityRequest>,
JournalWriter(user_id): JournalWriter,
Body(body): Body<ReplaceActivityRequest>,
) -> Result<Json<BulkActionResponse>, ApiError> {
let (user_id, old_id, new_id) = body.into_parts(user_id)?;
let deps = replace_activity::Deps {

View File

@@ -1,20 +1,24 @@
use axum::Json;
use axum::extract::{Multipart, State};
use api_types::responses::ImportResultResponse;
use api_types::responses::{ErrorResponse, ImportResultResponse};
use application::import::commands::ImportCommand;
use application::import::use_cases::import_entries;
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, extract_file_bytes};
use crate::extractors::{SessionUser, extract_file_bytes};
use crate::state::AppState;
#[utoipa::path(post, path = "/api/v1/data/import", tag = "data", security(("bearer" = [])),
responses((status = 200, body = ImportResultResponse))
responses((status = 200, body = ImportResultResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_import(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
multipart: Multipart,
) -> Result<Json<ImportResultResponse>, ApiError> {
let data = extract_file_bytes(multipart).await?;

View File

@@ -0,0 +1,35 @@
use axum::Json;
use axum::extract::State;
use api_types::responses::{ErrorResponse, ExhaustedJobResponse};
use application::job::use_cases::list_exhausted_jobs;
use crate::errors::ApiError;
use crate::extractors::Administrator;
use crate::state::AppState;
const MOST_SHOWN: usize = 100;
#[utoipa::path(get, path = "/api/v1/jobs/exhausted", tag = "jobs", security(("bearer" = [])),
description = "Background work that used every attempt and stopped being retried, with the \
reason the last attempt failed. Losing a job costs promptness and never data, \
so this is an operator's view of what is stale rather than what is missing. \
Needs an administrator's session.",
responses((status = 200, body = Vec<ExhaustedJobResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list_exhausted(
State(state): State<AppState>,
Administrator(_who): Administrator,
) -> Result<Json<Vec<ExhaustedJobResponse>>, ApiError> {
let deps = list_exhausted_jobs::Deps {
jobs: state.job_view,
};
let stalled = list_exhausted_jobs::execute(MOST_SHOWN, &deps).await?;
Ok(Json(stalled.into_iter().map(Into::into).collect()))
}

View File

@@ -3,55 +3,89 @@ use axum::extract::{Multipart, State};
use axum::http::{StatusCode, header};
use axum::response::IntoResponse;
use api_types::responses::MediaIdResponse;
use api_types::responses::{ErrorResponse, MediaIdResponse, OwnedMediaResponse};
use application::media::use_cases::{
delete_photo, delete_voice_memo, upload_photo, upload_voice_memo,
delete_photo, delete_voice_memo, list_media, upload_photo, upload_voice_memo,
};
use domain::attachment::{PhotoId, VoiceMemoId};
use domain::errors::DomainError;
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, PathId, extract_media_upload};
use crate::extractors::{JournalReader, JournalWriter, PathId, extract_media_upload};
use crate::state::AppState;
#[utoipa::path(post, path = "/api/v1/media/photos", tag = "media", security(("bearer" = [])),
responses((status = 201, body = MediaIdResponse))
responses((status = 201, body = MediaIdResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_upload_photo(
State(state): State<AppState>,
AuthenticatedUser(_user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
multipart: Multipart,
) -> Result<(StatusCode, Json<MediaIdResponse>), ApiError> {
let upload = extract_media_upload(multipart).await?;
let deps = upload_photo::Deps {
storage: state.media_storage,
ownership: state.media_ownership,
};
let photo_id = upload_photo::execute(upload, &deps).await?;
let photo_id = upload_photo::execute(user_id, upload, &deps).await?;
Ok((StatusCode::CREATED, Json(MediaIdResponse::from(photo_id))))
}
#[utoipa::path(post, path = "/api/v1/media/voice-memos", tag = "media", security(("bearer" = [])),
responses((status = 201, body = MediaIdResponse))
responses((status = 201, body = MediaIdResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_upload_voice_memo(
State(state): State<AppState>,
AuthenticatedUser(_user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
multipart: Multipart,
) -> Result<(StatusCode, Json<MediaIdResponse>), ApiError> {
let upload = extract_media_upload(multipart).await?;
let deps = upload_voice_memo::Deps {
storage: state.media_storage,
ownership: state.media_ownership,
};
let voice_memo_id = upload_voice_memo::execute(upload, &deps).await?;
let voice_memo_id = upload_voice_memo::execute(user_id, upload, &deps).await?;
Ok((
StatusCode::CREATED,
Json(MediaIdResponse::from(voice_memo_id)),
))
}
#[utoipa::path(get, path = "/api/v1/media", tag = "media", security(("bearer" = [])),
description = "Every photo and voice memo this account owns, including any uploaded but \
never attached to an entry, each with the url it is served from.",
responses((status = 200, body = Vec<OwnedMediaResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
JournalReader(user_id): JournalReader,
) -> Result<Json<Vec<OwnedMediaResponse>>, ApiError> {
let deps = list_media::Deps {
ownership: state.media_ownership,
};
let held = list_media::execute(user_id, &deps).await?;
Ok(Json(held.into_iter().map(Into::into).collect()))
}
#[utoipa::path(get, path = "/api/v1/media/photos/{id}", tag = "media",
params(("id" = String, Path)),
responses((status = 200, description = "Photo binary"))
responses((status = 200, description = "Photo binary"),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_serve_photo(
State(state): State<AppState>,
@@ -71,7 +105,9 @@ pub async fn handle_serve_photo(
#[utoipa::path(get, path = "/api/v1/media/voice-memos/{id}", tag = "media",
params(("id" = String, Path)),
responses((status = 200, description = "Voice memo binary"))
responses((status = 200, description = "Voice memo binary"),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_serve_voice_memo(
State(state): State<AppState>,
@@ -91,32 +127,42 @@ pub async fn handle_serve_voice_memo(
#[utoipa::path(delete, path = "/api/v1/media/photos/{id}", tag = "media", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_delete_photo(
State(state): State<AppState>,
AuthenticatedUser(_user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(photo_id): PathId<PhotoId>,
) -> Result<StatusCode, ApiError> {
let deps = delete_photo::Deps {
storage: state.media_storage,
ownership: state.media_ownership,
};
delete_photo::execute(photo_id, &deps).await?;
delete_photo::execute(photo_id, user_id, &deps).await?;
Ok(StatusCode::NO_CONTENT)
}
#[utoipa::path(delete, path = "/api/v1/media/voice-memos/{id}", tag = "media", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_delete_voice_memo(
State(state): State<AppState>,
AuthenticatedUser(_user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(voice_memo_id): PathId<VoiceMemoId>,
) -> Result<StatusCode, ApiError> {
let deps = delete_voice_memo::Deps {
storage: state.media_storage,
ownership: state.media_ownership,
};
delete_voice_memo::execute(voice_memo_id, &deps).await?;
delete_voice_memo::execute(voice_memo_id, user_id, &deps).await?;
Ok(StatusCode::NO_CONTENT)
}

View File

@@ -1,27 +1,34 @@
use axum::Json;
use axum::extract::{Path, Query, State};
use axum::extract::{Path, State};
use axum::http::StatusCode;
use api_types::mappers::parse_date;
use api_types::requests::{DateSpanParams, ImportDailyMetricsRequest, SetDailyMetricsRequest};
use api_types::responses::{DailyMetricResponse, ImportOutcomeResponse, RejectionResponse};
use api_types::params::DateSpanParams;
use api_types::requests::{ImportDailyMetricsRequest, SetDailyMetricsRequest};
use api_types::responses::{
DailyMetricResponse, ErrorResponse, ImportOutcomeResponse, RejectionResponse,
};
use application::import::commands::ImportDailyMetricsCommand;
use application::import::use_cases::import_daily_metrics;
use application::metric::commands::SetDailyMetricsCommand;
use application::metric::use_cases::{list_daily_metrics, set_daily_metrics};
use application::metric::use_cases::{list_daily_metrics, list_rejections, set_daily_metrics};
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, ImportingProvider, MetricWriter};
use crate::extractors::{Body, ImportingProvider, JournalReader, MetricWriter, Params};
use crate::state::AppState;
#[utoipa::path(get, path = "/api/v1/metrics", tag = "metrics", security(("bearer" = [])),
params(DateSpanParams),
responses((status = 200, body = Vec<DailyMetricResponse>))
responses((status = 200, body = Vec<DailyMetricResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Query(params): Query<DateSpanParams>,
JournalReader(user_id): JournalReader,
Params(params): Params<DateSpanParams>,
) -> Result<Json<Vec<DailyMetricResponse>>, ApiError> {
let span = params.into_span()?;
@@ -40,13 +47,17 @@ pub async fn handle_list(
only once per request.",
params(("date" = String, Path, description = "Calendar date, as YYYY-MM-DD")),
request_body = SetDailyMetricsRequest,
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_set(
State(state): State<AppState>,
writer: MetricWriter,
Path(date): Path<String>,
Json(body): Json<SetDailyMetricsRequest>,
Body(body): Body<SetDailyMetricsRequest>,
) -> Result<StatusCode, ApiError> {
let date = parse_date(&date)?;
@@ -85,12 +96,16 @@ pub async fn handle_set(
rejection. Only a payload carrying more days than the configured limit is \
refused outright.",
request_body = ImportDailyMetricsRequest,
responses((status = 200, body = ImportOutcomeResponse))
responses((status = 200, body = ImportOutcomeResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_import(
State(state): State<AppState>,
importer: ImportingProvider,
Json(body): Json<ImportDailyMetricsRequest>,
Body(body): Body<ImportDailyMetricsRequest>,
) -> Result<Json<ImportOutcomeResponse>, ApiError> {
let deps = import_daily_metrics::Deps {
metrics: state.daily_metric_command,
@@ -115,13 +130,21 @@ pub async fn handle_import(
description = "Readings that could not be used, most recent first, whether they arrived \
broken from an importer or were stored by an older build and can no longer be \
read. Only the most recent are kept.",
responses((status = 200, body = Vec<RejectionResponse>))
responses((status = 200, body = Vec<RejectionResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_rejections(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
) -> Result<Json<Vec<RejectionResponse>>, ApiError> {
let rejections = state.rejection_query.find_recent_by_user(&user_id).await?;
let deps = list_rejections::Deps {
rejections: state.rejection_query,
};
let rejections = list_rejections::execute(user_id, &deps).await?;
Ok(Json(rejections.into_iter().map(Into::into).collect()))
}

View File

@@ -5,10 +5,12 @@ pub mod cycle;
pub mod data;
pub mod entries;
pub mod import_export;
pub mod jobs;
pub mod media;
pub mod metrics;
pub mod providers;
pub mod push;
pub mod reminders;
pub mod server;
pub mod tokens;
pub mod users;

View File

@@ -4,7 +4,7 @@ use axum::http::StatusCode;
use api_types::dimension::DimensionPayload;
use api_types::requests::ConnectProviderRequest;
use api_types::responses::ProviderConnectionResponse;
use api_types::responses::{ErrorResponse, ProviderConnectionResponse};
use application::provider::commands::ConnectProviderCommand;
use application::provider::use_cases::{
connect_provider, disconnect_provider, get_now_playing, list_connections,
@@ -14,7 +14,7 @@ use domain::errors::DomainError;
use domain::provider::ProviderName;
use crate::errors::ApiError;
use crate::extractors::AuthenticatedUser;
use crate::extractors::{Body, JournalReader, ProfileReader, SessionUser};
use crate::state::AppState;
fn cipher(
@@ -30,11 +30,15 @@ fn cipher(
}
#[utoipa::path(get, path = "/api/v1/providers", tag = "providers", security(("bearer" = [])),
responses((status = 200, body = Vec<ProviderConnectionResponse>))
responses((status = 200, body = Vec<ProviderConnectionResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
ProfileReader(user_id): ProfileReader,
) -> Result<Json<Vec<ProviderConnectionResponse>>, ApiError> {
let deps = list_connections::Deps {
query: state.provider_connection_query,
@@ -47,13 +51,17 @@ pub async fn handle_list(
#[utoipa::path(put, path = "/api/v1/providers/{provider}", tag = "providers", security(("bearer" = [])),
params(("provider" = String, Path, description = "Provider name")),
request_body = ConnectProviderRequest,
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_connect(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
Path(provider): Path<String>,
Json(body): Json<ConnectProviderRequest>,
Body(body): Body<ConnectProviderRequest>,
) -> Result<StatusCode, ApiError> {
let cipher = cipher(&state)?;
let provider = ProviderName::new(provider)?;
@@ -81,11 +89,15 @@ pub async fn handle_connect(
#[utoipa::path(delete, path = "/api/v1/providers/{provider}", tag = "providers", security(("bearer" = [])),
params(("provider" = String, Path, description = "Provider name")),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_disconnect(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
Path(provider): Path<String>,
) -> Result<StatusCode, ApiError> {
let provider = ProviderName::new(provider)?;
@@ -100,11 +112,15 @@ pub async fn handle_disconnect(
}
#[utoipa::path(get, path = "/api/v1/providers/now-playing", tag = "providers", security(("bearer" = [])),
responses((status = 200, body = Option<DimensionPayload>))
responses((status = 200, body = Option<DimensionPayload>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_now_playing(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
) -> Result<Json<Option<DimensionPayload>>, ApiError> {
let cipher = cipher(&state)?;

View File

@@ -3,18 +3,21 @@ use axum::extract::State;
use axum::http::StatusCode;
use api_types::requests::{PushSubscribeRequest, PushUnsubscribeRequest};
use application::push::use_cases::{subscribe, unsubscribe};
use api_types::responses::{ErrorResponse, PushSubscriptionResponse, VapidKeyResponse};
use application::push::use_cases::{list_subscriptions, subscribe, unsubscribe};
use crate::errors::ApiError;
use crate::extractors::AuthenticatedUser;
use crate::extractors::{Body, SessionUser};
use crate::state::AppState;
#[utoipa::path(get, path = "/api/v1/push/vapid-key", tag = "push",
responses((status = 200, description = "VAPID public key"))
responses((status = 200, body = VapidKeyResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_vapid_key(
State(state): State<AppState>,
) -> Result<Json<serde_json::Value>, ApiError> {
) -> Result<Json<VapidKeyResponse>, ApiError> {
if !state.push_config.enabled {
return Err(domain::errors::DomainError::NotFound(
"push notifications are disabled".into(),
@@ -22,17 +25,44 @@ pub async fn handle_vapid_key(
.into());
}
let public_key = web_push_adapter::WebPushSender::public_key_base64(&state.push_config)?;
Ok(Json(serde_json::json!({ "publicKey": public_key })))
Ok(Json(VapidKeyResponse { public_key }))
}
#[utoipa::path(get, path = "/api/v1/push/subscriptions", tag = "push", security(("bearer" = [])),
description = "The devices this account has subscribed for reminders. Keys are never \
returned; a client sees only which endpoints exist and when each was added.",
responses((status = 200, body = Vec<PushSubscriptionResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list_subscriptions(
State(state): State<AppState>,
SessionUser(user_id): SessionUser,
) -> Result<Json<Vec<PushSubscriptionResponse>>, ApiError> {
let deps = list_subscriptions::Deps {
push_query: state.push_subscription_query,
};
let held = list_subscriptions::execute(user_id, &deps).await?;
Ok(Json(held.into_iter().map(Into::into).collect()))
}
#[utoipa::path(post, path = "/api/v1/push/subscribe", tag = "push", security(("bearer" = [])),
request_body = PushSubscribeRequest,
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_subscribe(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<PushSubscribeRequest>,
SessionUser(user_id): SessionUser,
Body(body): Body<PushSubscribeRequest>,
) -> Result<StatusCode, ApiError> {
let cmd = body.into_command(user_id);
let deps = subscribe::Deps {
@@ -45,14 +75,18 @@ pub async fn handle_subscribe(
#[utoipa::path(post, path = "/api/v1/push/unsubscribe", tag = "push", security(("bearer" = [])),
request_body = PushUnsubscribeRequest,
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_unsubscribe(
State(state): State<AppState>,
AuthenticatedUser(_user_id): AuthenticatedUser,
Json(body): Json<PushUnsubscribeRequest>,
SessionUser(user_id): SessionUser,
Body(body): Body<PushUnsubscribeRequest>,
) -> Result<StatusCode, ApiError> {
let cmd = body.into_command();
let cmd = body.into_command(user_id);
let deps = unsubscribe::Deps {
push_command: state.push_subscription_command,
};
@@ -61,11 +95,15 @@ pub async fn handle_unsubscribe(
}
#[utoipa::path(post, path = "/api/v1/push/test", tag = "push", security(("bearer" = [])),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_test(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
) -> Result<StatusCode, ApiError> {
let sender = state
.reminder_sender

View File

@@ -3,24 +3,28 @@ use axum::extract::State;
use axum::http::StatusCode;
use api_types::requests::{CreateReminderRequest, UpdateReminderRequest};
use api_types::responses::ReminderResponse;
use api_types::responses::{ErrorResponse, ReminderResponse};
use application::reminder::use_cases::{
create_reminder, delete_reminder, get_reminder, list_reminders, update_reminder,
};
use domain::reminder::ReminderId;
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, PathId};
use crate::extractors::{Body, JournalReader, JournalWriter, PathId};
use crate::state::AppState;
#[utoipa::path(post, path = "/api/v1/reminders", tag = "reminders", security(("bearer" = [])),
request_body = CreateReminderRequest,
responses((status = 201, body = ReminderResponse))
responses((status = 201, body = ReminderResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_create(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<CreateReminderRequest>,
JournalWriter(user_id): JournalWriter,
Body(body): Body<CreateReminderRequest>,
) -> Result<(StatusCode, Json<ReminderResponse>), ApiError> {
let cmd = body.into_command(user_id)?;
let deps = create_reminder::Deps {
@@ -33,11 +37,15 @@ pub async fn handle_create(
#[utoipa::path(get, path = "/api/v1/reminders/{id}", tag = "reminders", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 200, body = ReminderResponse))
responses((status = 200, body = ReminderResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_get(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
PathId(reminder_id): PathId<ReminderId>,
) -> Result<Json<ReminderResponse>, ApiError> {
let deps = get_reminder::Deps {
@@ -48,11 +56,15 @@ pub async fn handle_get(
}
#[utoipa::path(get, path = "/api/v1/reminders", tag = "reminders", security(("bearer" = [])),
responses((status = 200, body = Vec<ReminderResponse>))
responses((status = 200, body = Vec<ReminderResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalReader(user_id): JournalReader,
) -> Result<Json<Vec<ReminderResponse>>, ApiError> {
let deps = list_reminders::Deps {
query: state.reminder_query,
@@ -66,13 +78,17 @@ pub async fn handle_list(
#[utoipa::path(patch, path = "/api/v1/reminders/{id}", tag = "reminders", security(("bearer" = [])),
params(("id" = String, Path)),
request_body = UpdateReminderRequest,
responses((status = 200, body = ReminderResponse))
responses((status = 200, body = ReminderResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_update(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(reminder_id): PathId<ReminderId>,
Json(body): Json<UpdateReminderRequest>,
Body(body): Body<UpdateReminderRequest>,
) -> Result<Json<ReminderResponse>, ApiError> {
let cmd = body.into_command(reminder_id)?;
let deps = update_reminder::Deps {
@@ -86,11 +102,15 @@ pub async fn handle_update(
#[utoipa::path(delete, path = "/api/v1/reminders/{id}", tag = "reminders", security(("bearer" = [])),
params(("id" = String, Path)),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_delete(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
JournalWriter(user_id): JournalWriter,
PathId(reminder_id): PathId<ReminderId>,
) -> Result<StatusCode, ApiError> {
let deps = delete_reminder::Deps {

View File

@@ -0,0 +1,76 @@
use axum::Json;
use axum::extract::State;
use api_types::responses::{
ErrorResponse, MetricKindResponse, MoodResponse, ServerInfoResponse, ServerLimitsResponse,
TokenScopeResponse,
};
use domain::api_token::TokenScope;
use domain::entry::Mood;
use domain::metric::MetricKind;
use domain::weather::Condition;
use crate::state::AppState;
#[utoipa::path(get, path = "/api/v1/server", tag = "server",
description = "What this deployment is and what it allows, for a client deciding what to \
offer before anyone has signed in. Carries no secrets and needs no \
authentication. The vocabularies are the ones the API validates against, so \
a client can build its forms from here rather than hardcoding them.",
responses((status = 200, body = ServerInfoResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_info(State(state): State<AppState>) -> Json<ServerInfoResponse> {
Json(ServerInfoResponse {
version: env!("CARGO_PKG_VERSION").to_string(),
registration_open: state.auth_config.allow_registration,
push_enabled: state.push_config.enabled,
weather_enabled: state.weather_enabled,
now_playing_provider: state
.now_playing
.as_ref()
.map(|playing| playing.provider().to_string()),
access_token_ttl_seconds: state.auth_config.access_token_ttl_seconds,
limits: ServerLimitsResponse {
max_body_size: state.server_config.max_body_size,
max_content_length: state.entry_config.max_content_length,
max_photos: state.entry_config.max_photos,
max_voice_memos: state.entry_config.max_voice_memos,
max_activities_per_entry: state.entry_config.max_activities_per_entry,
max_entries_per_page: state.entry_config.max_entries_per_page,
max_import_days: state.import_config.maximum_days_per_import,
},
token_scopes: TokenScope::ALL
.into_iter()
.map(|scope| TokenScopeResponse {
name: scope.name().to_string(),
describes: scope.describes().to_string(),
})
.collect(),
metric_kinds: MetricKind::ALL
.into_iter()
.map(|kind| {
let (minimum, maximum) = kind.bounds();
MetricKindResponse {
name: kind.name().to_string(),
unit: kind.unit().to_string(),
minimum,
maximum,
}
})
.collect(),
moods: Mood::ALL
.into_iter()
.map(|mood| MoodResponse {
value: mood.value(),
label: mood.label().to_string(),
})
.collect(),
weather_conditions: Condition::ALL
.into_iter()
.map(|condition| condition.name().to_string())
.collect(),
})
}

View File

@@ -3,24 +3,28 @@ use axum::extract::State;
use axum::http::StatusCode;
use api_types::requests::MintApiTokenRequest;
use api_types::responses::{ApiTokenResponse, MintedApiTokenResponse};
use api_types::responses::{ApiTokenResponse, ErrorResponse, MintedApiTokenResponse};
use application::api_token::commands::MintApiTokenCommand;
use application::api_token::use_cases::{list_api_tokens, mint_api_token, revoke_api_token};
use domain::api_token::ApiTokenId;
use domain::api_token::{ApiTokenId, TokenScopes};
use domain::provider::ProviderName;
use crate::errors::ApiError;
use crate::extractors::{AuthenticatedUser, PathId};
use crate::extractors::{Body, PathId, SessionUser};
use crate::state::AppState;
#[utoipa::path(get, path = "/api/v1/tokens", tag = "tokens", security(("bearer" = [])),
description = "Lists this account's api tokens. Values are never returned; only the name, \
when it was minted, and when it was last used.",
responses((status = 200, body = Vec<ApiTokenResponse>))
responses((status = 200, body = Vec<ApiTokenResponse>),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_list(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
) -> Result<Json<Vec<ApiTokenResponse>>, ApiError> {
let deps = list_api_tokens::Deps {
query: state.api_token_query,
@@ -32,16 +36,23 @@ pub async fn handle_list(
}
#[utoipa::path(post, path = "/api/v1/tokens", tag = "tokens", security(("bearer" = [])),
description = "Mints a token for writing daily metrics. The value comes back once and is \
never retrievable again. The name becomes the Provider that the token's \
writes are attributed to, so it must be lowercase letters, digits and hyphens.",
description = "Mints a token granting the scopes named in the request, and nothing else. \
The value comes back once and is never retrievable again. The name becomes \
the Provider that the token's metric writes are attributed to, so it must be \
lowercase letters, digits and hyphens. Account operations — minting tokens, \
changing the password, backup and restore — always need a signed-in session \
and are never reachable with a token.",
request_body = MintApiTokenRequest,
responses((status = 201, body = MintedApiTokenResponse))
responses((status = 201, body = MintedApiTokenResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_mint(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<MintApiTokenRequest>,
SessionUser(user_id): SessionUser,
Body(body): Body<MintApiTokenRequest>,
) -> Result<(StatusCode, Json<MintedApiTokenResponse>), ApiError> {
let deps = mint_api_token::Deps {
command: state.api_token_command,
@@ -52,6 +63,7 @@ pub async fn handle_mint(
MintApiTokenCommand {
user_id,
name: ProviderName::new(body.name)?,
scopes: TokenScopes::from_names(body.scopes.iter().map(String::as_str))?,
},
&deps,
)
@@ -63,11 +75,15 @@ pub async fn handle_mint(
#[utoipa::path(delete, path = "/api/v1/tokens/{id}", tag = "tokens", security(("bearer" = [])),
description = "Revokes a token. It stops working at once.",
params(("id" = String, Path, description = "Token ID")),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_revoke(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
PathId(token_id): PathId<ApiTokenId>,
) -> Result<StatusCode, ApiError> {
let deps = revoke_api_token::Deps {

View File

@@ -3,22 +3,24 @@ use axum::extract::State;
use axum::http::StatusCode;
use api_types::requests::{ChangePasswordRequest, RegisterRequest, UpdateProfileRequest};
use api_types::responses::UserResponse;
use api_types::responses::{ErrorResponse, UserResponse};
use application::user::use_cases::{
change_password, clear_data, delete_user, get_profile, register, update_profile,
};
use crate::errors::ApiError;
use crate::extractors::AuthenticatedUser;
use crate::extractors::{Body, ProfileReader, SessionUser};
use crate::state::AppState;
#[utoipa::path(post, path = "/api/v1/users/register", tag = "users",
request_body = RegisterRequest,
responses((status = 201, body = UserResponse))
responses((status = 201, body = UserResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_register(
State(state): State<AppState>,
Json(body): Json<RegisterRequest>,
Body(body): Body<RegisterRequest>,
) -> Result<(StatusCode, Json<UserResponse>), ApiError> {
if !state.auth_config.allow_registration {
return Err(
@@ -39,11 +41,15 @@ pub async fn handle_register(
}
#[utoipa::path(get, path = "/api/v1/users/me", tag = "users", security(("bearer" = [])),
responses((status = 200, body = UserResponse))
responses((status = 200, body = UserResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_get_profile(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
ProfileReader(user_id): ProfileReader,
) -> Result<Json<UserResponse>, ApiError> {
let deps = get_profile::Deps {
user_query: state.user_query,
@@ -54,12 +60,16 @@ pub async fn handle_get_profile(
#[utoipa::path(patch, path = "/api/v1/users/me", tag = "users", security(("bearer" = [])),
request_body = UpdateProfileRequest,
responses((status = 200, body = UserResponse))
responses((status = 200, body = UserResponse),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_update_profile(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<UpdateProfileRequest>,
SessionUser(user_id): SessionUser,
Body(body): Body<UpdateProfileRequest>,
) -> Result<Json<UserResponse>, ApiError> {
let cmd = body.into_command(user_id)?;
let deps = update_profile::Deps {
@@ -72,15 +82,20 @@ pub async fn handle_update_profile(
#[utoipa::path(patch, path = "/api/v1/users/me/password", tag = "users", security(("bearer" = [])),
request_body = ChangePasswordRequest,
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_change_password(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
Json(body): Json<ChangePasswordRequest>,
SessionUser(user_id): SessionUser,
Body(body): Body<ChangePasswordRequest>,
) -> Result<StatusCode, ApiError> {
let cmd = body.into_command(user_id);
let deps = change_password::Deps {
refresh_sessions: state.refresh_session_command.clone(),
user_command: state.user_command,
user_query: state.user_query,
password_hasher: state.password_hasher,
@@ -90,18 +105,21 @@ pub async fn handle_change_password(
}
#[utoipa::path(delete, path = "/api/v1/users/me", tag = "users", security(("bearer" = [])),
responses((status = 204))
responses((status = 204),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_delete(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
) -> Result<StatusCode, ApiError> {
let deps = delete_user::Deps {
dimensions: state.dimensions.clone(),
user_query: state.user_query,
entry_query: state.entry_query,
cascade: state.cascade,
media_storage: state.media_storage,
media_ownership: state.media_ownership,
events: state.event_publisher,
};
delete_user::execute(user_id, &deps).await?;
@@ -109,17 +127,20 @@ pub async fn handle_delete(
}
#[utoipa::path(delete, path = "/api/v1/users/me/data", tag = "users", security(("bearer" = [])),
responses((status = 204, description = "All user data cleared"))
responses((status = 204, description = "All user data cleared"),
(status = 401, description = "No credential, or one this endpoint does not accept", body = ErrorResponse),
(status = 403, description = "A token that does not grant what this endpoint needs", body = ErrorResponse),
(status = 400, description = "Malformed request", body = ErrorResponse),
(status = 422, description = "Understood but refused", body = ErrorResponse))
)]
pub async fn handle_clear_data(
State(state): State<AppState>,
AuthenticatedUser(user_id): AuthenticatedUser,
SessionUser(user_id): SessionUser,
) -> Result<StatusCode, ApiError> {
let deps = clear_data::Deps {
dimensions: state.dimensions.clone(),
entry_query: state.entry_query,
cascade: state.cascade,
media_storage: state.media_storage,
media_ownership: state.media_ownership,
};
clear_data::execute(user_id, &deps).await?;
Ok(StatusCode::NO_CONTENT)

View File

@@ -18,6 +18,7 @@ use utoipa::{Modify, OpenApi};
crate::handlers::auth::handle_refresh,
crate::handlers::auth::handle_logout,
crate::handlers::entries::handle_create,
crate::handlers::entries::handle_create_many,
crate::handlers::entries::handle_get,
crate::handlers::entries::handle_list,
crate::handlers::entries::handle_update,
@@ -47,6 +48,7 @@ use utoipa::{Modify, OpenApi};
crate::handlers::reminders::handle_list,
crate::handlers::reminders::handle_update,
crate::handlers::reminders::handle_delete,
crate::handlers::media::handle_list,
crate::handlers::media::handle_upload_photo,
crate::handlers::media::handle_upload_voice_memo,
crate::handlers::media::handle_serve_photo,
@@ -58,6 +60,7 @@ use utoipa::{Modify, OpenApi};
crate::handlers::data::handle_restore,
crate::handlers::import_export::handle_import,
crate::handlers::push::handle_vapid_key,
crate::handlers::push::handle_list_subscriptions,
crate::handlers::push::handle_subscribe,
crate::handlers::push::handle_unsubscribe,
crate::handlers::push::handle_test,
@@ -74,14 +77,19 @@ use utoipa::{Modify, OpenApi};
crate::handlers::metrics::handle_import,
crate::handlers::metrics::handle_rejections,
crate::handlers::metrics::handle_set,
crate::handlers::server::handle_info,
crate::handlers::jobs::handle_list_exhausted,
),
components(schemas(
api_types::requests::CreateEntryRequest,
api_types::requests::CreateEntriesRequest,
api_types::responses::EntryPageResponse,
api_types::requests::UpdateEntryRequest,
api_types::requests::ListEntriesParams,
api_types::requests::DateRangeParams,
api_types::params::ListEntriesParams,
api_types::params::DateRangeParams,
api_types::requests::ReplaceActivityRequest,
api_types::requests::CreateActivityRequest,
api_types::params::ListActivitiesParams,
api_types::requests::RenameActivityRequest,
api_types::requests::SetCategoryRequest,
api_types::requests::RegisterRequest,
@@ -98,15 +106,18 @@ use utoipa::{Modify, OpenApi};
api_types::responses::ReminderResponse,
api_types::responses::DayScheduleResponse,
api_types::responses::MoodStatsResponse,
api_types::responses::MoodFrequency,
api_types::responses::MoodFrequencyResponse,
api_types::responses::CalendarDayResponse,
api_types::responses::BulkActionResponse,
api_types::responses::ImportResultResponse,
api_types::responses::RestoreOutcomeResponse,
api_types::responses::MediaIdResponse,
api_types::responses::OwnedMediaResponse,
api_types::responses::ExhaustedJobResponse,
api_types::responses::PushSubscriptionResponse,
api_types::requests::SetDailyMetricsRequest,
api_types::requests::MetricPayload,
api_types::requests::DateSpanParams,
api_types::params::DateSpanParams,
api_types::responses::DailyMetricResponse,
api_types::requests::MintApiTokenRequest,
api_types::requests::SetPreferencesRequest,
@@ -127,6 +138,16 @@ use utoipa::{Modify, OpenApi};
api_types::responses::StrategyScoreResponse,
api_types::requests::PushSubscribeRequest,
api_types::requests::PushUnsubscribeRequest,
api_types::responses::ErrorResponse,
api_types::responses::ErrorDetailResponse,
api_types::responses::SignedInResponse,
api_types::responses::RefreshedResponse,
api_types::responses::VapidKeyResponse,
api_types::responses::ServerInfoResponse,
api_types::responses::ServerLimitsResponse,
api_types::responses::TokenScopeResponse,
api_types::responses::MetricKindResponse,
api_types::responses::MoodResponse,
)),
tags(
(name = "auth", description = "Authentication"),

View File

@@ -1,15 +1,20 @@
use axum::extract::DefaultBodyLimit;
use axum::http::HeaderValue;
use axum::http::StatusCode;
use axum::routing::{delete, get, patch, post, put};
use axum::{Json, Router};
use tower_governor::GovernorError;
use tower_governor::governor::GovernorConfigBuilder;
use tower_governor::{GovernorLayer, key_extractor::SmartIpKeyExtractor};
use tower_http::cors::{AllowOrigin, Any, CorsLayer};
use tower_http::trace::TraceLayer;
use utoipa::OpenApi;
use utoipa_scalar::{Scalar, Servable};
use crate::errors::{INTERNAL_ERROR, TOO_MANY_REQUESTS, refuse};
use crate::handlers::{
activities, auth, correlations, cycle, data, entries, import_export, media, metrics, providers,
push, reminders, tokens, users,
activities, auth, correlations, cycle, data, entries, import_export, jobs, media, metrics,
providers, push, reminders, server, tokens, users,
};
use crate::openapi::ApiDoc;
use crate::state::AppState;
@@ -18,11 +23,17 @@ pub fn build_router(state: AppState) -> Router {
let cors = build_cors(&state.server_config.cors);
let body_limit = DefaultBodyLimit::max(state.server_config.max_body_size);
Router::new()
let answered_here = Router::new()
.nest("/api/v1", api_routes())
.route("/health", get(health))
.route("/openapi.json", get(openapi_json))
.merge(Scalar::with_url("/docs", ApiDoc::openapi()))
.merge(Scalar::with_url("/docs", ApiDoc::openapi()));
// The limit guards the journal, not the files the browser needs to show
// it. One cold load of the client asks for a dozen or more hashed assets
// at once, and counting those against the same budget as the API means a
// hard refresh can leave the app unable to fetch its own code.
rate_limited(answered_here, &state.server_config.rate_limit)
.fallback_service(crate::spa::serve_spa(&state.server_config.spa_dir))
.layer(body_limit)
.layer(cors)
@@ -30,6 +41,98 @@ pub fn build_router(state: AppState) -> Router {
.with_state(state)
}
/// One second, in milliseconds.
const ONE_SECOND_IN_MILLIS: u64 = 1000;
/// How long to wait between replenishing one unit of the quota.
///
/// `GovernorConfigBuilder::per_second` takes the *interval* between
/// replenishments, not a rate, so feeding it a per-second figure means the
/// opposite of what the name says: `50` asks for one request every fifty
/// seconds rather than fifty every second. This converts the configured rate
/// into the interval the builder actually wants.
pub fn replenish_interval_millis(requests_per_second: u64) -> u64 {
(ONE_SECOND_IN_MILLIS / requests_per_second.max(1)).max(1)
}
/// Applies the limit with `route_layer`, so it runs only for requests that
/// match a route here. Static client assets are served by the fallback and are
/// deliberately outside it.
pub fn rate_limited<S>(router: Router<S>, config: &config::RateLimitConfig) -> Router<S>
where
S: Clone + Send + Sync + 'static,
{
if !config.enabled {
tracing::warn!("rate limiting is switched off, so any client may poll as fast as it likes");
return router;
}
match config.trust_forwarded_for {
true => keyed_by_forwarded_ip(router, config),
false => keyed_by_peer_ip(router, config),
}
}
fn keyed_by_forwarded_ip<S>(router: Router<S>, config: &config::RateLimitConfig) -> Router<S>
where
S: Clone + Send + Sync + 'static,
{
let built = GovernorConfigBuilder::default()
.per_millisecond(replenish_interval_millis(config.requests_per_second))
.burst_size(config.burst)
.key_extractor(SmartIpKeyExtractor)
.finish();
match built {
Some(governor) => router.route_layer(GovernorLayer::new(governor).error_handler(slow_down)),
None => unusable(router),
}
}
fn keyed_by_peer_ip<S>(router: Router<S>, config: &config::RateLimitConfig) -> Router<S>
where
S: Clone + Send + Sync + 'static,
{
let built = GovernorConfigBuilder::default()
.per_millisecond(replenish_interval_millis(config.requests_per_second))
.burst_size(config.burst)
.finish();
match built {
Some(governor) => router.route_layer(GovernorLayer::new(governor).error_handler(slow_down)),
None => unusable(router),
}
}
fn unusable<S>(router: Router<S>) -> Router<S> {
tracing::error!("the configured rate limit is not usable, so none is applied");
router
}
fn slow_down(error: GovernorError) -> axum::response::Response {
let (status, code, message) = match error {
GovernorError::TooManyRequests { .. } => (
StatusCode::TOO_MANY_REQUESTS,
TOO_MANY_REQUESTS,
"too many requests: slow down and try again shortly".to_string(),
),
GovernorError::UnableToExtractKey => (
StatusCode::INTERNAL_SERVER_ERROR,
INTERNAL_ERROR,
"the caller could not be identified for rate limiting".to_string(),
),
GovernorError::Other { msg, .. } => (
StatusCode::INTERNAL_SERVER_ERROR,
INTERNAL_ERROR,
msg.unwrap_or_else(|| "rate limiting failed".to_string()),
),
};
refuse(status, code, message)
}
async fn openapi_json() -> Json<utoipa::openapi::OpenApi> {
Json(ApiDoc::openapi())
}
@@ -72,6 +175,8 @@ fn api_routes() -> Router<AppState> {
.nest("/providers", provider_routes())
.nest("/push", push_routes())
.nest("/data", data_routes())
.route("/server", get(server::handle_info))
.route("/jobs/exhausted", get(jobs::handle_list_exhausted))
}
fn cycle_routes() -> Router<AppState> {
@@ -125,6 +230,7 @@ fn entry_routes() -> Router<AppState> {
.patch(entries::handle_update)
.delete(entries::handle_delete),
)
.route("/bulk", post(entries::handle_create_many))
.route("/stats", get(entries::handle_stats))
.route("/calendar", get(entries::handle_calendar))
.route("/filter/mood/{mood}", get(entries::handle_filter_by_mood))
@@ -188,6 +294,7 @@ fn reminder_routes() -> Router<AppState> {
fn media_routes() -> Router<AppState> {
Router::new()
.route("/", get(media::handle_list))
.route("/photos", post(media::handle_upload_photo))
.route(
"/photos/{id}",
@@ -203,6 +310,7 @@ fn media_routes() -> Router<AppState> {
fn push_routes() -> Router<AppState> {
Router::new()
.route("/vapid-key", get(push::handle_vapid_key))
.route("/subscriptions", get(push::handle_list_subscriptions))
.route("/subscribe", post(push::handle_subscribe))
.route("/unsubscribe", post(push::handle_unsubscribe))
.route("/test", post(push::handle_test))

View File

@@ -7,12 +7,13 @@ use domain::ports::{
ActivityCommandPort, ActivityQueryPort, ApiTokenCommandPort, ApiTokenQueryPort,
ApiTokenSecretPort, AuthServicePort, BackupReaderPort, BackupWriterPort, CascadeDeletePort,
CycleStartCommandPort, CycleStartQueryPort, DailyMetricCommandPort, DailyMetricQueryPort,
EntryDimensionPort, EventPublisherPort, ExtractWriterPort, ImportSourcePort, MediaStoragePort,
MoodEntryCommandPort, MoodEntryQueryPort, PasswordHasherPort, ProviderConnectionCommandPort,
ProviderConnectionQueryPort, PushSubscriptionCommandPort, PushSubscriptionQueryPort,
RefreshSessionCommandPort, RefreshSessionQueryPort, RejectionCommandPort, RejectionQueryPort,
ReminderCommandPort, ReminderQueryPort, ReminderSenderPort, UserCommandPort,
UserPreferencesCommandPort, UserPreferencesQueryPort, UserQueryPort,
EntryDimensionPort, EventPublisherPort, ExtractWriterPort, ImportSourcePort,
MediaOwnershipPort, MediaStoragePort, MoodEntryCommandPort, MoodEntryQueryPort,
PasswordHasherPort, ProviderConnectionCommandPort, ProviderConnectionQueryPort,
PushSubscriptionCommandPort, PushSubscriptionQueryPort, RefreshSessionCommandPort,
RefreshSessionQueryPort, RejectionCommandPort, RejectionQueryPort, ReminderCommandPort,
ReminderQueryPort, ReminderSenderPort, UserCommandPort, UserPreferencesCommandPort,
UserPreferencesQueryPort, UserQueryPort,
};
#[derive(Clone)]
@@ -21,6 +22,7 @@ pub struct AppState {
pub entry_query: Arc<dyn MoodEntryQueryPort>,
pub dimensions: Vec<Arc<dyn EntryDimensionPort>>,
pub weather_store: Arc<dyn EntryDimensionPort>,
pub activity_store: Arc<dyn EntryDimensionPort>,
pub activity_command: Arc<dyn ActivityCommandPort>,
pub activity_query: Arc<dyn ActivityQueryPort>,
pub user_command: Arc<dyn UserCommandPort>,
@@ -45,6 +47,8 @@ pub struct AppState {
pub password_hasher: Arc<dyn PasswordHasherPort>,
pub event_publisher: Arc<dyn EventPublisherPort>,
pub media_storage: Arc<dyn MediaStoragePort>,
pub media_ownership: Arc<dyn MediaOwnershipPort>,
pub job_view: Arc<dyn domain::ports::JobQueueQueryPort>,
pub backup_writer: Arc<dyn BackupWriterPort>,
pub backup_reader: Arc<dyn BackupReaderPort>,
pub extract_writer: Arc<dyn ExtractWriterPort>,
@@ -53,6 +57,7 @@ pub struct AppState {
pub provider_connection_query: Arc<dyn ProviderConnectionQueryPort>,
pub credential_cipher: Option<Arc<dyn domain::provider::CredentialCipher>>,
pub now_playing: Option<Arc<dyn domain::ports::NowPlayingPort>>,
pub weather_enabled: bool,
pub recording_lookup: Arc<dyn domain::ports::RecordingLookupPort>,
pub push_subscription_command: Arc<dyn PushSubscriptionCommandPort>,
pub push_subscription_query: Arc<dyn PushSubscriptionQueryPort>,

View File

@@ -0,0 +1,129 @@
use utoipa::OpenApi;
fn spec() -> serde_json::Value {
serde_json::to_value(http_axum::openapi::ApiDoc::openapi()).unwrap()
}
fn operations(spec: &serde_json::Value) -> Vec<(String, String, serde_json::Value)> {
spec["paths"]
.as_object()
.unwrap()
.iter()
.flat_map(|(path, methods)| {
methods
.as_object()
.unwrap()
.iter()
.map(move |(verb, op)| (verb.to_uppercase(), path.clone(), op.clone()))
})
.collect()
}
#[test]
fn every_operation_that_can_succeed_with_a_body_declares_its_shape() {
let spec = spec();
let mut untyped = Vec::new();
for (verb, path, op) in operations(&spec) {
let responses = op["responses"].as_object().unwrap();
let describes_a_success = responses
.iter()
.any(|(code, response)| code.starts_with('2') && response.get("content").is_some());
let says_nothing_comes_back = responses.contains_key("204");
let serves_bytes = path.starts_with("/api/v1/media/");
if !describes_a_success && !says_nothing_comes_back && !serves_bytes {
untyped.push(format!("{verb} {path}"));
}
}
assert!(
untyped.is_empty(),
"a generated client cannot type these responses: {untyped:?}"
);
}
#[test]
fn every_operation_documents_the_refusals_a_client_must_handle() {
let spec = spec();
let mut silent = Vec::new();
for (verb, path, op) in operations(&spec) {
let responses = op["responses"].as_object().unwrap();
if !responses.keys().any(|code| code.starts_with('4')) {
silent.push(format!("{verb} {path}"));
}
}
assert!(
silent.is_empty(),
"these operations can refuse a client but never say so: {silent:?}"
);
}
#[test]
fn every_guarded_operation_says_what_a_wrong_credential_looks_like() {
let spec = spec();
let mut silent = Vec::new();
for (verb, path, op) in operations(&spec) {
if op.get("security").is_none() {
continue;
}
let responses = op["responses"].as_object().unwrap();
if !responses.contains_key("401") || !responses.contains_key("403") {
silent.push(format!("{verb} {path}"));
}
}
assert!(
silent.is_empty(),
"these need a credential but never describe refusing one: {silent:?}"
);
}
#[test]
fn every_refusal_is_the_one_error_shape() {
let spec = spec();
let mut odd = Vec::new();
for (verb, path, op) in operations(&spec) {
for (code, response) in op["responses"].as_object().unwrap() {
if !code.starts_with('4') && !code.starts_with('5') {
continue;
}
let named = response["content"]["application/json"]["schema"]["$ref"]
.as_str()
.unwrap_or_default();
if named != "#/components/schemas/ErrorResponse" {
odd.push(format!("{verb} {path} -> {code}"));
}
}
}
assert!(
odd.is_empty(),
"a client should parse one error shape, not several: {odd:?}"
);
}
#[test]
fn the_server_tells_a_client_what_it_allows_without_a_credential() {
let spec = spec();
let info = &spec["paths"]["/api/v1/server"]["get"];
assert!(
info.get("security").is_none(),
"a client decides whether to offer registration before anyone has signed in"
);
assert_eq!(
info["responses"]["200"]["content"]["application/json"]["schema"]["$ref"],
"#/components/schemas/ServerInfoResponse"
);
}

View File

@@ -0,0 +1,119 @@
//! The limit exists to protect the journal from being hammered. It must not
//! also throttle the static files the browser needs to render the journal:
//! one cold load of the client asks for a dozen or more hashed assets at once,
//! and counting those against the same budget makes a hard refresh able to
//! starve the app of its own code.
use std::net::SocketAddr;
use axum::Router;
use axum::body::Body;
use axum::extract::ConnectInfo;
use axum::http::{Request, StatusCode};
use axum::routing::get;
use config::RateLimitConfig;
use http_axum::router::rate_limited;
use tower::util::ServiceExt;
const CALLER: SocketAddr =
SocketAddr::new(std::net::IpAddr::V4(std::net::Ipv4Addr::LOCALHOST), 9000);
/// One request allowed, then nothing until it replenishes — so a second call
/// is refused and the difference between guarded and exempt is unmistakable.
fn strictest() -> RateLimitConfig {
RateLimitConfig {
enabled: true,
requests_per_second: 1,
burst: 1,
trust_forwarded_for: false,
}
}
fn under_test(config: &RateLimitConfig) -> Router {
rate_limited(
Router::new().route("/api/v1/entries", get(|| async { "journal" })),
config,
)
.fallback(|| async { "index.html" })
}
async fn status_of(app: &Router, path: &str) -> StatusCode {
let mut request = Request::builder().uri(path).body(Body::empty()).unwrap();
request.extensions_mut().insert(ConnectInfo(CALLER));
app.clone().oneshot(request).await.unwrap().status()
}
#[tokio::test]
async fn a_guarded_route_is_refused_once_its_budget_is_spent() {
let app = under_test(&strictest());
assert_eq!(status_of(&app, "/api/v1/entries").await, StatusCode::OK);
assert_eq!(
status_of(&app, "/api/v1/entries").await,
StatusCode::TOO_MANY_REQUESTS
);
}
#[tokio::test]
async fn client_assets_keep_being_served_after_the_budget_is_spent() {
let app = under_test(&strictest());
// Spend the whole budget on the API.
assert_eq!(status_of(&app, "/api/v1/entries").await, StatusCode::OK);
assert_eq!(
status_of(&app, "/api/v1/entries").await,
StatusCode::TOO_MANY_REQUESTS
);
// The files the client is made of are still served, as many as it asks for.
for _ in 0..25 {
assert_eq!(
status_of(&app, "/assets/index-abc123.js").await,
StatusCode::OK
);
}
}
#[tokio::test]
async fn a_switched_off_limit_guards_nothing() {
let off = RateLimitConfig {
enabled: false,
..strictest()
};
let app = under_test(&off);
for _ in 0..10 {
assert_eq!(status_of(&app, "/api/v1/entries").await, StatusCode::OK);
}
}
/// `GovernorConfigBuilder::per_second` takes an interval, not a rate, so the
/// configured figure has to be converted or it means its own opposite.
mod replenishment {
use http_axum::router::replenish_interval_millis;
#[test]
fn a_rate_becomes_the_interval_between_replenishments() {
assert_eq!(replenish_interval_millis(1), 1000);
assert_eq!(replenish_interval_millis(10), 100);
assert_eq!(replenish_interval_millis(15), 66);
}
#[test]
fn a_faster_rate_waits_a_shorter_time() {
assert!(replenish_interval_millis(50) < replenish_interval_millis(5));
}
#[test]
fn an_interval_is_never_zero_however_high_the_rate() {
// The builder rejects a zero interval outright.
assert_eq!(replenish_interval_millis(10_000), 1);
assert_eq!(replenish_interval_millis(u64::MAX), 1);
}
#[test]
fn a_nonsensical_rate_of_zero_falls_back_to_one_a_second() {
assert_eq!(replenish_interval_millis(0), 1000);
}
}