prepare first release with graceful shutdown + containerfile + push to #4

Merged
qpismont merged 5 commits from 1.0 into main 2026-06-12 22:38:25 +02:00
8 changed files with 86 additions and 8 deletions
Showing only changes of commit a30d7c5d90 - Show all commits
+4
View File
@@ -0,0 +1,4 @@
target/
.env
.devcontainer/
docs/
Generated
+1 -1
View File
@@ -786,7 +786,7 @@ checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a"
[[package]] [[package]]
name = "herald" name = "herald"
version = "0.1.0" version = "1.0.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"axum", "axum",
+1 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "herald" name = "herald"
version = "0.1.0" version = "1.0.0"
edition = "2024" edition = "2024"
[dependencies] [dependencies]
+12
View File
@@ -0,0 +1,12 @@
FROM rust:1.96 as builder
Review

L'image Rust 1.96 n'est pas une version stable connue. Privilégiez une version précise et stable (ex: rust:1.85.0) pour garantir la reproductibilité des builds. Si vous utilisez une nightly, indiquez-le clairement avec une date ou un digest.

L'image Rust `1.96` n'est pas une version stable connue. Privilégiez une version précise et stable (ex: `rust:1.85.0`) pour garantir la reproductibilité des builds. Si vous utilisez une nightly, indiquez-le clairement avec une date ou un digest.
WORKDIR /app
COPY . .
RUN cargo build --release
FROM debian:trixie-slim
Review

Debian trixie est actuellement une version Testing, pas encore stable. Utilisez une version stable comme debian:bookworm-slim (Debian 12) ou debian:bullseye-slim pour éviter des surprises lors de mises à jour non contrôlées.

Debian `trixie` est actuellement une version Testing, pas encore stable. Utilisez une version stable comme `debian:bookworm-slim` (Debian 12) ou `debian:bullseye-slim` pour éviter des surprises lors de mises à jour non contrôlées.
WORKDIR /app
COPY --from=builder /app/target/release/herald .
CMD [ "./herald" ]
+22
View File
@@ -0,0 +1,22 @@
#!/usr/bin/env bash
set -euo pipefail
IMAGE="tintounn/herald"
if [ -z "${CI_COMMIT_TAG:-}" ]; then
echo "Error: CI_COMMIT_TAG is not set" >&2
exit 1
fi
TAG="${CI_COMMIT_TAG}"
echo "Building ${IMAGE}:${TAG}..."
buildah build \
--file Containerfile \
--tag "docker.io/${IMAGE}:${TAG}" \
.
echo "Pushing ${IMAGE}:${TAG}..."
buildah push "${IMAGE}:${TAG}"
Review

La commande push ne précise pas le registre complet. Comme l'image a été taguée avec docker.io/..., cela fonctionnera, mais il peut être plus explicite d'utiliser buildah push "docker.io/${IMAGE}:${TAG}" pour éviter toute ambiguïté. Ajoutez également un tag latest si cela est souhaité pour les releases.

La commande `push` ne précise pas le registre complet. Comme l'image a été taguée avec `docker.io/...`, cela fonctionnera, mais il peut être plus explicite d'utiliser `buildah push "docker.io/${IMAGE}:${TAG}"` pour éviter toute ambiguïté. Ajoutez également un tag `latest` si cela est souhaité pour les releases.
echo "Done: ${IMAGE}:${TAG}"
+8 -3
View File
@@ -1,5 +1,4 @@
use anyhow::anyhow; use axum::body::{Bytes, to_bytes};
Review

L'import Bytes semble inutilisé dans ce fichier (le nom est importé mais jamais référencé). Supprimez-le pour éviter un avertissement du compilateur. Vérifiez la suite du fichier, mais si non utilisé, il est préférable de le retirer.

L'import `Bytes` semble inutilisé dans ce fichier (le nom est importé mais jamais référencé). Supprimez-le pour éviter un avertissement du compilateur. Vérifiez la suite du fichier, mais si non utilisé, il est préférable de le retirer.
use axum::body::{Body, Bytes, to_bytes};
use axum::extract::{FromRef, FromRequest, State}; use axum::extract::{FromRef, FromRequest, State};
use axum::http::Request; use axum::http::Request;
use axum::response::IntoResponse; use axum::response::IntoResponse;
@@ -15,12 +14,14 @@ use tower::ServiceBuilder;
use tower_http::trace::TraceLayer; use tower_http::trace::TraceLayer;
use tracing::{info, instrument}; use tracing::{info, instrument};
use tokio_util::sync::CancellationToken;
use crate::consts::{GITEA_EVENT_TYPE_HEADER_NAME, GITEA_SIG_HEADER_NAME, MAX_WEBHOOK_BODY_SIZE}; use crate::consts::{GITEA_EVENT_TYPE_HEADER_NAME, GITEA_SIG_HEADER_NAME, MAX_WEBHOOK_BODY_SIZE};
use crate::errors::AppError; use crate::errors::AppError;
use crate::gitea::WebhookType; use crate::gitea::WebhookType;
use crate::state::AppState; use crate::state::AppState;
pub async fn start(app_state: AppState) -> anyhow::Result<()> { pub async fn start(app_state: AppState, shutdown: CancellationToken) -> anyhow::Result<()> {
let http_port = app_state.config.http_port; let http_port = app_state.config.http_port;
let app = Router::new() let app = Router::new()
@@ -38,8 +39,12 @@ pub async fn start(app_state: AppState) -> anyhow::Result<()> {
info!("Listening API on port {}", http_port); info!("Listening API on port {}", http_port);
axum::serve(listener, app) axum::serve(listener, app)
.with_graceful_shutdown(async move { shutdown.cancelled().await })
.await .await
.map_err(anyhow::Error::from) .map_err(anyhow::Error::from)
.inspect(|_| info!("API shutting down complete"))?;
Ok(())
} }
async fn root() -> &'static str { async fn root() -> &'static str {
+13 -2
View File
@@ -5,6 +5,7 @@ use crate::{
}; };
use serde::Deserialize; use serde::Deserialize;
use std::{sync::Arc, time::Duration}; use std::{sync::Arc, time::Duration};
use tokio_util::sync::CancellationToken;
use tracing::{error, info, instrument}; use tracing::{error, info, instrument};
#[derive(Deserialize, Debug)] #[derive(Deserialize, Debug)]
@@ -54,13 +55,23 @@ impl Bot {
pub async fn start( pub async fn start(
&self, &self,
mut rx: tokio::sync::mpsc::Receiver<WebhookType>, mut rx: tokio::sync::mpsc::Receiver<WebhookType>,
shutdown: CancellationToken,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
info!("Bot started"); info!("Bot started");
let sem = Arc::new(tokio::sync::Semaphore::new(self.max_concurrent)); let sem = Arc::new(tokio::sync::Semaphore::new(self.max_concurrent));
let mut tasks = tokio::task::JoinSet::new(); let mut tasks = tokio::task::JoinSet::new();
while let Some(wb) = rx.recv().await { loop {
let wb = tokio::select! {
biased;
_ = shutdown.cancelled() => break,
msg = rx.recv() => match msg {
Some(wb) => wb,
None => break,
},
};
// Drain completed tasks to avoid the JoinSet growing unbounded // Drain completed tasks to avoid the JoinSet growing unbounded
while let Some(res) = tasks.try_join_next() { while let Some(res) = tasks.try_join_next() {
if let Err(e) = res { if let Err(e) = res {
@@ -82,7 +93,7 @@ impl Bot {
// properly before returning // properly before returning
tasks.join_all().await; tasks.join_all().await;
info!("Bot shutting down, channel closed"); info!("Bot shutting down complete");
Ok(()) Ok(())
} }
+25 -1
View File
@@ -1,5 +1,8 @@
use crate::{bot::Bot, gitea::WebhookType, state::AppState}; use crate::{bot::Bot, gitea::WebhookType, state::AppState};
use dotenvy::dotenv; use dotenvy::dotenv;
use tokio::signal::unix::{SignalKind, signal};
use tokio_util::sync::CancellationToken;
use tracing::{info, warn}; use tracing::{info, warn};
use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt}; use tracing_subscriber::{EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt};
@@ -54,11 +57,32 @@ async fn run() -> anyhow::Result<()> {
"Starting Herald" "Starting Herald"
); );
let shutdown = CancellationToken::new();
let bot = Bot::new(config.clone())?; let bot = Bot::new(config.clone())?;
let (tx, rx) = tokio::sync::mpsc::channel::<WebhookType>(config.bot_max_concurrent * 2); let (tx, rx) = tokio::sync::mpsc::channel::<WebhookType>(config.bot_max_concurrent * 2);
let app_state = AppState { bot_tx: tx, config }; let app_state = AppState { bot_tx: tx, config };
tokio::try_join!(bot.start(rx), api::start(app_state))?; let signal = async {
let mut sigterm = signal(SignalKind::terminate())?;
Outdated
Review

Le code utilise tokio::signal::unix qui ne fonctionne que sous Linux/Unix. Assurez-vous que l'application ne cible que ces systèmes, ou ajoutez une gestion alternative pour Windows (ex: tokio::signal::ctrl_c). Pour une première release, cela peut être acceptable si le déploiement est Linux uniquement.

Le code utilise `tokio::signal::unix` qui ne fonctionne que sous Linux/Unix. Assurez-vous que l'application ne cible que ces systèmes, ou ajoutez une gestion alternative pour Windows (ex: `tokio::signal::ctrl_c`). Pour une première release, cela peut être acceptable si le déploiement est Linux uniquement.
let mut sigint = signal(SignalKind::interrupt())?;
tokio::select! {
_ = sigterm.recv() => info!("Received SIGTERM"),
_ = sigint.recv() => info!("Received SIGINT"),
}
info!("Shutting down...");
shutdown.cancel();
anyhow::Ok(())
};
tokio::try_join!(
bot.start(rx, shutdown.clone()),
api::start(app_state, shutdown.clone()),
signal
)?;
info!("Shutdown complete");
Ok(()) Ok(())
} }