feat(analysis): gate page leasing on a vision readiness probe
The analysis worker leases an analyze_page job (incrementing attempts in SQL) before calling vision, so a stopped/loading vision burns all retries and writes a permanent failed page_analysis row. With the vision-manager autoscaler idle-stopping the container, that would poison the queue on every cold start. Add an optional VisionReadiness seam (HTTP GET /health in production) wired via the new env-only ANALYSIS_VISION_HEALTH_URL. When set, the worker parks without leasing until the probe answers 2xx; jobs stay pending with attempts untouched and resume the instant vision is ready. None preserves today's behavior for always-on endpoints. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -32,6 +32,10 @@ use crate::storage::Storage;
|
||||
const LEASE_DURATION: Duration = Duration::from_secs(60);
|
||||
/// Heartbeat cadence — a third of the lease window.
|
||||
const LEASE_HEARTBEAT: Duration = Duration::from_secs(20);
|
||||
/// How long to wait before re-probing vision when the readiness gate is
|
||||
/// closed. Short enough to resume promptly after an autoscaler cold start,
|
||||
/// long enough not to hammer `/health` while vision is down.
|
||||
const READINESS_POLL: Duration = Duration::from_secs(2);
|
||||
|
||||
/// The unit of work: analyze one page. Implemented by
|
||||
/// [`RealAnalyzeDispatcher`] in production and stubbed in tests.
|
||||
@@ -40,12 +44,45 @@ pub trait AnalyzeDispatcher: Send + Sync {
|
||||
async fn dispatch(&self, page_id: Uuid) -> anyhow::Result<()>;
|
||||
}
|
||||
|
||||
/// Probe answering "is the vision backend up and the model loaded?". When a
|
||||
/// probe is wired in, the worker refuses to *lease* a job until it reports
|
||||
/// ready — so an idle-stopped vision (the autoscaler's normal state) never
|
||||
/// burns a job's retries or writes a `failed` row. Implemented by
|
||||
/// [`HttpVisionReadiness`] in production (a `GET /health`) and stubbed in
|
||||
/// tests.
|
||||
#[async_trait]
|
||||
pub trait VisionReadiness: Send + Sync {
|
||||
async fn ready(&self) -> bool;
|
||||
}
|
||||
|
||||
/// Production readiness probe: `GET {health_url}`, ready iff it answers 2xx.
|
||||
/// Any transport error (connection refused while stopped, 503 while the
|
||||
/// model loads) is treated as not-ready.
|
||||
pub struct HttpVisionReadiness {
|
||||
pub http: reqwest::Client,
|
||||
pub health_url: String,
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl VisionReadiness for HttpVisionReadiness {
|
||||
async fn ready(&self) -> bool {
|
||||
match self.http.get(&self.health_url).send().await {
|
||||
Ok(resp) => resp.status().is_success(),
|
||||
Err(_) => false,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub struct AnalysisDaemonConfig {
|
||||
pub dispatcher: Arc<dyn AnalyzeDispatcher>,
|
||||
pub workers: usize,
|
||||
pub job_timeout: Duration,
|
||||
/// Live-event sink (Started/Completed/Failed) for admin SSE.
|
||||
pub events: Arc<AnalysisEvents>,
|
||||
/// Optional vision readiness gate. `None` ⇒ no gate (today's behavior,
|
||||
/// for always-on endpoints). `Some` ⇒ the worker parks instead of
|
||||
/// leasing while the probe is not ready.
|
||||
pub readiness: Option<Arc<dyn VisionReadiness>>,
|
||||
}
|
||||
|
||||
pub struct AnalysisDaemonHandle {
|
||||
@@ -75,6 +112,7 @@ pub fn spawn(
|
||||
dispatcher: Arc::clone(&cfg.dispatcher),
|
||||
job_timeout: cfg.job_timeout,
|
||||
events: Arc::clone(&cfg.events),
|
||||
readiness: cfg.readiness.clone(),
|
||||
id,
|
||||
};
|
||||
join.spawn(async move { ctx.run().await });
|
||||
@@ -88,6 +126,7 @@ struct WorkerContext {
|
||||
dispatcher: Arc<dyn AnalyzeDispatcher>,
|
||||
job_timeout: Duration,
|
||||
events: Arc<AnalysisEvents>,
|
||||
readiness: Option<Arc<dyn VisionReadiness>>,
|
||||
id: usize,
|
||||
}
|
||||
|
||||
@@ -98,6 +137,18 @@ impl WorkerContext {
|
||||
tracing::info!(worker = self.id, "analysis worker: shutdown");
|
||||
return;
|
||||
}
|
||||
// Readiness gate: park (without leasing) while vision is down or
|
||||
// still loading its model, so the autoscaler's idle-stop never
|
||||
// costs a job its retries. Probe *before* the lease — leasing
|
||||
// increments `attempts` in SQL and can't be undone.
|
||||
if let Some(readiness) = &self.readiness {
|
||||
if !readiness.ready().await {
|
||||
if self.sleep_or_cancel(READINESS_POLL).await {
|
||||
return;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
}
|
||||
let leases =
|
||||
match jobs::lease(&self.pool, Some(KIND_ANALYZE_PAGE), 1, LEASE_DURATION).await {
|
||||
Ok(v) => v,
|
||||
@@ -269,7 +320,29 @@ impl AnalyzeDispatcher for RealAnalyzeDispatcher {
|
||||
/// in the `tests/` dir (a separate crate).
|
||||
pub mod test_support {
|
||||
use super::*;
|
||||
use std::sync::atomic::{AtomicUsize, Ordering};
|
||||
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
|
||||
|
||||
/// A readiness probe whose answer can be flipped from the test thread, to
|
||||
/// drive the "vision is down, then comes up" transition.
|
||||
pub struct ToggleReadiness {
|
||||
ready: AtomicBool,
|
||||
}
|
||||
|
||||
impl ToggleReadiness {
|
||||
pub fn new(ready: bool) -> Arc<Self> {
|
||||
Arc::new(Self { ready: AtomicBool::new(ready) })
|
||||
}
|
||||
pub fn set(&self, ready: bool) {
|
||||
self.ready.store(ready, Ordering::Release);
|
||||
}
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl VisionReadiness for ToggleReadiness {
|
||||
async fn ready(&self) -> bool {
|
||||
self.ready.load(Ordering::Acquire)
|
||||
}
|
||||
}
|
||||
|
||||
/// Counts dispatch calls and returns a configurable result.
|
||||
pub struct CountingDispatcher {
|
||||
|
||||
@@ -420,6 +420,24 @@ fn spawn_analysis_daemon(
|
||||
model: cfg.model.clone(),
|
||||
max_image_bytes: cfg.max_image_bytes,
|
||||
});
|
||||
// When a readiness URL is configured, gate leasing on it so an
|
||||
// autoscaler that idle-stops the vision container never lets a job burn
|
||||
// its retries. A dedicated short-timeout client keeps the probe snappy
|
||||
// and independent of the (long) per-request analysis timeout.
|
||||
let readiness: Option<Arc<dyn crate::analysis::daemon::VisionReadiness>> =
|
||||
match &cfg.vision_health_url {
|
||||
Some(url) if !url.is_empty() => {
|
||||
let probe = reqwest::Client::builder()
|
||||
.timeout(std::time::Duration::from_secs(5))
|
||||
.build()
|
||||
.context("build vision readiness http client")?;
|
||||
Some(Arc::new(crate::analysis::daemon::HttpVisionReadiness {
|
||||
http: probe,
|
||||
health_url: url.clone(),
|
||||
}))
|
||||
}
|
||||
_ => None,
|
||||
};
|
||||
let handle = crate::analysis::daemon::spawn(
|
||||
db,
|
||||
CancellationToken::new(),
|
||||
@@ -428,6 +446,7 @@ fn spawn_analysis_daemon(
|
||||
workers: cfg.workers,
|
||||
job_timeout: cfg.job_timeout,
|
||||
events,
|
||||
readiness,
|
||||
},
|
||||
);
|
||||
tracing::info!(workers = cfg.workers, model = %cfg.model, "analysis worker daemon started");
|
||||
|
||||
@@ -124,6 +124,13 @@ pub struct AnalysisConfig {
|
||||
pub workers: usize,
|
||||
/// OpenAI-compatible chat/completions URL (`ANALYSIS_VISION_URL`).
|
||||
pub endpoint: String,
|
||||
/// Optional vision readiness probe URL (`ANALYSIS_VISION_HEALTH_URL`),
|
||||
/// e.g. `http://mangalord-vision:8000/health`. When set, the worker
|
||||
/// refuses to lease a job until this answers 2xx — so an autoscaler that
|
||||
/// idle-stops the vision container never lets a job burn its retries or
|
||||
/// land a `failed` row. `None` (the default) disables the gate, matching
|
||||
/// the prior behavior for always-on endpoints. Env-only, like `api_key`.
|
||||
pub vision_health_url: Option<String>,
|
||||
/// Model id to request (`ANALYSIS_MODEL`).
|
||||
pub model: String,
|
||||
/// Optional bearer token (`ANALYSIS_API_KEY`); local servers usually
|
||||
@@ -190,6 +197,7 @@ impl Default for AnalysisConfig {
|
||||
enabled: false,
|
||||
workers: 1,
|
||||
endpoint: "http://localhost:8000/v1/chat/completions".to_string(),
|
||||
vision_health_url: None,
|
||||
model: String::new(),
|
||||
api_key: None,
|
||||
request_timeout: Duration::from_secs(120),
|
||||
@@ -221,6 +229,9 @@ impl AnalysisConfig {
|
||||
enabled: env_bool("ANALYSIS_ENABLED", d.enabled),
|
||||
workers: env_usize("ANALYSIS_WORKERS", d.workers).max(1),
|
||||
endpoint: std::env::var("ANALYSIS_VISION_URL").unwrap_or(d.endpoint),
|
||||
vision_health_url: std::env::var("ANALYSIS_VISION_HEALTH_URL")
|
||||
.ok()
|
||||
.filter(|s| !s.is_empty()),
|
||||
model: std::env::var("ANALYSIS_MODEL").unwrap_or(d.model),
|
||||
api_key: std::env::var("ANALYSIS_API_KEY")
|
||||
.ok()
|
||||
|
||||
@@ -410,6 +410,8 @@ impl AnalysisSettings {
|
||||
grounding_prompt: prompt(&self.grounding_prompt, GROUNDING_PROMPT_DEFAULT),
|
||||
// Env-only secret preserved from the base.
|
||||
api_key: base.api_key.clone(),
|
||||
// Env-only readiness probe URL preserved from the base.
|
||||
vision_health_url: base.vision_health_url.clone(),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
149
backend/tests/analysis_readiness.rs
Normal file
149
backend/tests/analysis_readiness.rs
Normal file
@@ -0,0 +1,149 @@
|
||||
//! Integration tests for the analysis worker's *vision readiness gate*.
|
||||
//!
|
||||
//! When a readiness probe is wired in and reports "not ready" (the vision
|
||||
//! container is stopped, or running but the model is still loading), the
|
||||
//! worker must NOT lease any `analyze_page` job. Leasing increments
|
||||
//! `attempts` in SQL and a down vision then burns all retries and writes a
|
||||
//! permanent `failed` row — poisoning the queue while the autoscaler is
|
||||
//! mid-cold-start. So a not-ready gate must leave jobs untouched
|
||||
//! (`state='pending'`, `attempts=0`, no `page_analysis` row) and resume the
|
||||
//! instant the probe flips to ready.
|
||||
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use mangalord::analysis::daemon::{
|
||||
self,
|
||||
test_support::{CountingDispatcher, ToggleReadiness},
|
||||
AnalysisDaemonConfig,
|
||||
};
|
||||
use mangalord::repo::page_analysis;
|
||||
use sqlx::PgPool;
|
||||
use tokio_util::sync::CancellationToken;
|
||||
use uuid::Uuid;
|
||||
|
||||
async fn seed_page(pool: &PgPool) -> Uuid {
|
||||
let manga_id: Uuid =
|
||||
sqlx::query_scalar("INSERT INTO mangas (title) VALUES ('M') RETURNING id")
|
||||
.fetch_one(pool)
|
||||
.await
|
||||
.unwrap();
|
||||
let chapter_id: Uuid =
|
||||
sqlx::query_scalar("INSERT INTO chapters (manga_id, number) VALUES ($1, 1) RETURNING id")
|
||||
.bind(manga_id)
|
||||
.fetch_one(pool)
|
||||
.await
|
||||
.unwrap();
|
||||
sqlx::query_scalar(
|
||||
"INSERT INTO pages (chapter_id, page_number, storage_key, content_type) \
|
||||
VALUES ($1, 1, 'k/1.png', 'image/png') RETURNING id",
|
||||
)
|
||||
.bind(chapter_id)
|
||||
.fetch_one(pool)
|
||||
.await
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
async fn job_row(pool: &PgPool, page_id: Uuid) -> (String, i32) {
|
||||
sqlx::query_as(
|
||||
"SELECT state, attempts FROM crawler_jobs \
|
||||
WHERE payload->>'kind' = 'analyze_page' AND payload->>'page_id' = $1",
|
||||
)
|
||||
.bind(page_id.to_string())
|
||||
.fetch_one(pool)
|
||||
.await
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
async fn wait_for_state(pool: &PgPool, page_id: Uuid, want: &str) {
|
||||
let result = tokio::time::timeout(Duration::from_secs(8), async {
|
||||
loop {
|
||||
if job_row(pool, page_id).await.0 == want {
|
||||
return;
|
||||
}
|
||||
tokio::time::sleep(Duration::from_millis(50)).await;
|
||||
}
|
||||
})
|
||||
.await;
|
||||
assert!(result.is_ok(), "job for {page_id} never reached state {want}");
|
||||
}
|
||||
|
||||
fn spawn_with(
|
||||
pool: &PgPool,
|
||||
dispatcher: Arc<CountingDispatcher>,
|
||||
readiness: Option<Arc<dyn daemon::VisionReadiness>>,
|
||||
) -> daemon::AnalysisDaemonHandle {
|
||||
daemon::spawn(
|
||||
pool.clone(),
|
||||
CancellationToken::new(),
|
||||
AnalysisDaemonConfig {
|
||||
dispatcher,
|
||||
workers: 1,
|
||||
job_timeout: Duration::from_secs(5),
|
||||
events: Arc::new(mangalord::analysis::events::AnalysisEvents::new()),
|
||||
readiness,
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
#[sqlx::test(migrations = "./migrations")]
|
||||
async fn not_ready_gate_never_leases_or_fails_the_page(pool: PgPool) {
|
||||
let page_id = seed_page(&pool).await;
|
||||
page_analysis::enqueue_for_page(&pool, page_id, false)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let dispatcher = CountingDispatcher::ok();
|
||||
let readiness = ToggleReadiness::new(false);
|
||||
let handle = spawn_with(&pool, dispatcher.clone(), Some(readiness.clone()));
|
||||
|
||||
// Give the worker several poll cycles to (wrongly) lease if the gate is
|
||||
// broken.
|
||||
tokio::time::sleep(Duration::from_millis(800)).await;
|
||||
handle.shutdown().await;
|
||||
|
||||
assert_eq!(dispatcher.call_count(), 0, "must not dispatch while not ready");
|
||||
let (state, attempts) = job_row(&pool, page_id).await;
|
||||
assert_eq!(state, "pending", "job must stay pending while vision is down");
|
||||
assert_eq!(attempts, 0, "job must not be leased (attempts must stay 0)");
|
||||
assert!(
|
||||
page_analysis::load(&pool, page_id).await.unwrap().is_none(),
|
||||
"no failed/any page_analysis row may be written while not ready"
|
||||
);
|
||||
}
|
||||
|
||||
#[sqlx::test(migrations = "./migrations")]
|
||||
async fn resumes_when_readiness_flips_to_ready(pool: PgPool) {
|
||||
let page_id = seed_page(&pool).await;
|
||||
page_analysis::enqueue_for_page(&pool, page_id, false)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let dispatcher = CountingDispatcher::ok();
|
||||
let readiness = ToggleReadiness::new(false);
|
||||
let handle = spawn_with(&pool, dispatcher.clone(), Some(readiness.clone()));
|
||||
|
||||
// Confirm it is parked, then open the gate.
|
||||
tokio::time::sleep(Duration::from_millis(300)).await;
|
||||
assert_eq!(dispatcher.call_count(), 0);
|
||||
readiness.set(true);
|
||||
|
||||
wait_for_state(&pool, page_id, "done").await;
|
||||
handle.shutdown().await;
|
||||
assert_eq!(dispatcher.call_count(), 1, "must process once ready");
|
||||
}
|
||||
|
||||
#[sqlx::test(migrations = "./migrations")]
|
||||
async fn no_gate_processes_as_before(pool: PgPool) {
|
||||
// readiness = None preserves today's behavior for always-on endpoints.
|
||||
let page_id = seed_page(&pool).await;
|
||||
page_analysis::enqueue_for_page(&pool, page_id, false)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let dispatcher = CountingDispatcher::ok();
|
||||
let handle = spawn_with(&pool, dispatcher.clone(), None);
|
||||
wait_for_state(&pool, page_id, "done").await;
|
||||
handle.shutdown().await;
|
||||
assert_eq!(dispatcher.call_count(), 1);
|
||||
}
|
||||
@@ -78,6 +78,7 @@ fn spawn_with(
|
||||
events: std::sync::Arc::new(
|
||||
mangalord::analysis::events::AnalysisEvents::new(),
|
||||
),
|
||||
readiness: None,
|
||||
},
|
||||
);
|
||||
(handle, cancel)
|
||||
@@ -227,6 +228,7 @@ async fn worker_publishes_started_and_completed_events(pool: PgPool) {
|
||||
workers: 1,
|
||||
job_timeout: Duration::from_secs(5),
|
||||
events: events.clone(),
|
||||
readiness: None,
|
||||
},
|
||||
);
|
||||
|
||||
@@ -277,6 +279,7 @@ async fn worker_publishes_failed_event_on_dispatch_error(pool: PgPool) {
|
||||
workers: 1,
|
||||
job_timeout: Duration::from_secs(5),
|
||||
events: events.clone(),
|
||||
readiness: None,
|
||||
},
|
||||
);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user