use axum::{
extract::FromRef,
response::IntoResponse,
};
use common::http::{
extract::MtState,
HttpResponseError,
};
use errors::ErrorMetadata;
use http::StatusCode;
use model::backend_state::{
types::BackendState,
BackendStateModel,
};
use utoipa_axum::router::OpenApiRouter;
use crate::{
admin::must_be_admin_with_write_access,
authentication::ExtractIdentity,
LocalAppState,
};
/// Pause deployment
///
/// Disables a deployment without deleting any data. The deployment will not
/// operate until it is unpaused. While a deployment is paused, new functions
/// calls will return an error, scheduled jobs will queue and run when the
/// deployment is resumed, and cron jobs will be skipped. This means that no
/// function calls or bandwidth usage will be charged while the deployment is
/// paused, but storage costs will still apply.
#[utoipa::path(
post,
path = "/pause_deployment",
responses((status = 200)),
security(
("Deploy Key" = []),
("OAuth Team Token" = []),
("Team Token" = []),
("OAuth Project Token" = []),
),
)]
pub async fn pause_deployment(
MtState(st): MtState<LocalAppState>,
ExtractIdentity(identity): ExtractIdentity,
) -> Result<impl IntoResponse, HttpResponseError> {
must_be_admin_with_write_access(&identity)?;
let mut tx = st.application.begin(identity.clone()).await?;
let current_state = BackendStateModel::new(&mut tx).get_backend_state().await?;
if current_state == BackendState::Disabled || current_state == BackendState::Suspended {
return Err(anyhow::anyhow!(ErrorMetadata::bad_request(
"PauseDeploymentFailed",
"Deployment is currently disabled or suspended by Convex and cannot be paused."
))
.into());
}
st.application
.change_deployment_state(identity, BackendState::Paused)
.await?;
Ok(StatusCode::OK)
}
/// Unpause deployment
///
/// Reenables a deployment that was previously paused. The deployment will
/// resume normal operation, including any scheduled jobs that were queued while
/// paused.
#[utoipa::path(
post,
path = "/unpause_deployment",
responses((status = 200)),
security(
("Deploy Key" = []),
("OAuth Team Token" = []),
("Team Token" = []),
("OAuth Project Token" = []),
),
)]
pub async fn unpause_deployment(
MtState(st): MtState<LocalAppState>,
ExtractIdentity(identity): ExtractIdentity,
) -> Result<impl IntoResponse, HttpResponseError> {
must_be_admin_with_write_access(&identity)?;
let mut tx = st.application.begin(identity.clone()).await?;
let current_state = BackendStateModel::new(&mut tx).get_backend_state().await?;
if current_state != BackendState::Paused {
return Err(anyhow::anyhow!(ErrorMetadata::bad_request(
"UnpauseDeploymentFailed",
"Deployment is not currently paused."
))
.into());
}
st.application
.change_deployment_state(identity, BackendState::Running)
.await?;
Ok(StatusCode::OK)
}
pub fn platform_router<S>() -> OpenApiRouter<S>
where
LocalAppState: FromRef<S>,
S: Clone + Send + Sync + 'static,
{
OpenApiRouter::new()
.routes(utoipa_axum::routes!(pause_deployment))
.routes(utoipa_axum::routes!(unpause_deployment))
}
