rustploy 0.1.16

Rustploy PaaS daemon — lightweight self-hosted deployment platform
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
//! Execução de um `Job` (tarefa one-shot via docker-compose): resolve rede +
//! env vars do serviço gatilho, sobe o stack até `main_service` terminar
//! (`docker::compose::run_once`), grava o resultado em `job_run`/`job_log` e
//! reagenda (`Job::recurrence`, quando houver).

use crate::engine::{self, DockerClient, networks};
use crate::features::jobs::JobsContext;
use crate::platform::event_bus::EventBus;
use crate::platform::secrets::SecretsManager;
use crate::store;
use anyhow::Result;
use chrono::Utc;
use shared::{Event, Job, JobRun};
use std::future::Future;
use std::path::PathBuf;
use std::sync::Arc;
use tokio::sync::OwnedSemaphorePermit;
use tracing::{error, info, warn};

use crate::features::deploy::queue::DeployQueue;

pub struct JobRunner {
    pub db: Arc<store::Db>,
    pub docker: Arc<DockerClient>,
    pub bus: Arc<EventBus>,
    pub secrets: Arc<SecretsManager>,
    pub db_path: PathBuf,
    pub registry_internal_token: Option<Arc<str>>,
}

/// Cria o `job_run` e dispara a execução em background (`tokio::spawn`) —
/// usado tanto pelo `scheduler_loop` (jobs vencidos) quanto por
/// `Command::JobRunNow` (disparo manual). Retorna assim que o `job_run` é
/// criado; o resultado chega depois via `Event::JobRunStateChanged` +
/// `Command::JobRunHistory`/`GetJobLogs`.
pub async fn spawn(state: &JobsContext, job: Job) -> Result<JobRun> {
    let run = store::job_run::create(&state.db, &job.id).await?;
    let runner = Arc::new(JobRunner {
        db: state.db.clone(),
        docker: state.docker.clone(),
        bus: state.bus.clone(),
        secrets: state.secrets.clone(),
        db_path: state.db_path.clone(),
        registry_internal_token: state.registry_internal_token.clone(),
    });
    let run_id = run.id.clone();

    // Sinal de cancelamento (`Command::JobRunCancel` → `JobsContext::
    // active_jobs`): registrado ANTES da task começar a rodar, removido
    // depois de terminar (sucesso, falha ou cancelamento) — mesmo idioma de
    // `active_deploys`, mas com um `watch<bool>` observado dentro de
    // `docker::compose::run_once_up` em vez de abortar a task (abortar a
    // task não mataria o processo `docker compose up` filho). Só o caminho
    // scheduler/`JobRunNow` (aqui) registra — o `run_inner_mirrored` chamado
    // pelo `DeployExecutor` (`PreDeployCheck`) passa `None`, fora de escopo
    // por ora.
    let (cancel_tx, cancel_rx) = tokio::sync::watch::channel(false);
    if let Ok(mut map) = state.active_jobs.lock() {
        map.insert(run_id.clone(), cancel_tx);
    }
    let active_jobs = state.active_jobs.clone();

    // Empurra o próximo horário JÁ, não só ao terminar: o job pode esperar a vez
    // atrás de um deploy longo, e sem isso o agendador o veria "vencido" a cada
    // tick e dispararia outra execução por cima.
    runner.reschedule(&job).await;

    // Uma coisa por vez: o job espera a MESMA vaga do worker de deploys (ver
    // `deploy::queue`). O gate de pré-deploy não passa por aqui — roda por dentro
    // de um deploy, que já tem a vaga.
    let queue = state.deploy_queue.clone();
    tokio::spawn(async move {
        let vaga = {
            let (r, j, id) = (runner.clone(), job.clone(), run_id.clone());
            esperar_vaga(&queue, cancel_rx.clone(), async move {
                r.linha(
                    &j.id,
                    &id,
                    "==> Aguardando a vez: há um deploy ou outro job em execução (ou a fila está pausada)",
                )
                .await;
            })
            .await
        };
        match vaga {
            Some(vaga) => {
                runner
                    .linha(&job.id, &run_id, "==> Sua vez: iniciando")
                    .await;
                runner.run(&job, run_id.clone(), Some(cancel_rx)).await;
                drop(vaga);
            }
            None => runner.cancelar_antes_de_comecar(&job, &run_id).await,
        }
        if let Ok(mut map) = active_jobs.lock() {
            map.remove(&run_id);
        }
    });
    Ok(run)
}

/// Espera a vaga única da fila (ver [`DeployQueue::acquire_job_slot`]). Se a vaga
/// já está livre devolve na hora, sem chamar `avisar_espera`; senão roda
/// `avisar_espera` uma vez (o "aguardando a vez" no log) e espera. `None` se o
/// cancelamento chegar antes de a vez chegar. Livre de Docker/banco, para testar.
async fn esperar_vaga<F: Future<Output = ()>>(
    queue: &DeployQueue,
    mut cancel_rx: tokio::sync::watch::Receiver<bool>,
    avisar_espera: F,
) -> Option<OwnedSemaphorePermit> {
    if let Some(vaga) = queue.try_job_slot_now() {
        return Some(vaga);
    }
    avisar_espera.await;
    // Só cancela com o sinal de fato enviado: um `Sender` descartado sem ter
    // cancelado faz o `wait_for` devolver `Err` na hora, e isso NÃO é cancelamento.
    let cancelado = async {
        if cancel_rx.wait_for(|c| *c).await.is_err() {
            std::future::pending::<()>().await;
        }
    };
    tokio::select! {
        vaga = queue.acquire_job_slot() => Some(vaga),
        _ = cancelado => None,
    }
}

impl JobRunner {
    pub async fn run(
        &self,
        job: &Job,
        run_id: String,
        cancel_rx: Option<tokio::sync::watch::Receiver<bool>>,
    ) {
        info!(job_id = %job.id, run_id = %run_id, "job_runner: iniciando execução");
        self.bus.publish(Event::JobRunStateChanged {
            job_id: job.id.clone(),
            job_run_id: run_id.clone(),
            running: true,
            success: None,
        });

        let result = self.run_inner_mirrored(job, &run_id, None, cancel_rx).await;
        let success = match &result {
            Ok(exit_code) => *exit_code == 0,
            Err(e) => {
                error!(job_id = %job.id, run_id = %run_id, error = %e, "job_runner: falha ao executar job");
                let _ = store::job_run::finish(&self.db, &run_id, -1).await;
                false
            }
        };

        self.bus.publish(Event::JobRunStateChanged {
            job_id: job.id.clone(),
            job_run_id: run_id.clone(),
            running: false,
            success: Some(success),
        });

        self.reschedule(job).await;
    }

    /// Roda `job` até o `main_service` terminar e devolve o exit code — sem
    /// tocar em `job.recurrence`/`reschedule` (isso é responsabilidade de
    /// `run()`, chamado pelo scheduler/`JobRunNow`). `mirror_deployment`,
    /// quando `Some((deployment_id, service_id))`, também espelha a saída
    /// como `Event::BuildLog` — usado pelo `DeployExecutor` no estado
    /// `PreDeployCheck` (ver `docs/plano-pre-deploy-gate.md`) pra a saída do
    /// check aparecer na tela de deploy; nesse caminho `cancel_rx` é sempre
    /// `None` (cancelamento de job só é suportado no caminho scheduler/
    /// `JobRunNow`, via `spawn()` — ver `docs/plano-cancelamento-de-jobs.md`).
    pub(crate) async fn run_inner_mirrored(
        &self,
        job: &Job,
        run_id: &str,
        mirror_deployment: Option<(String, String)>,
        cancel_rx: Option<tokio::sync::watch::Receiver<bool>>,
    ) -> Result<i32> {
        let project_net = crate::store::projects::network_name(&self.db, &job.project_id).await?;
        let network_name =
            networks::ensure_project_network(&self.docker.inner, &project_net).await?;

        // Base (projeto [+ serviço gatilho]) + overrides do próprio job, maior
        // precedência — ver deploy::env_resolve::resolve_job.
        let env_vars =
            crate::features::deploy::env_resolve::resolve_job(&self.db, &self.secrets, job).await?;

        // Nome de projeto do compose: só minúsculas/dígitos/`_`/`-` (regra do
        // próprio `docker compose`) — o run_id (ULID) tem letras maiúsculas.
        let project_name = run_id.to_lowercase();
        let build_dir = self.db_path.join("jobs").join(run_id);

        // Job git-sourced: clona pra dentro do PRÓPRIO build_dir (vira o
        // checkout) antes do compose — mesma resolução de credenciais do
        // deploy de serviço git-sourced (`deploy::git::resolve_clone_
        // credentials`), reusada aqui pra não duplicar. O progresso do clone
        // vira linha de log do job (mesmo bus_batch que o stdout do compose),
        // pra aparecer ao vivo em "Ver logs" igual o resto da execução.
        let build_source = match &job.git_source {
            Some(git) => {
                let bus = self.bus.clone();
                let db_handle = self.db.clone();
                let jid = job.id.clone();
                let rid = run_id.to_string();
                super::source::clone_git_source(
                    &self.db,
                    &self.secrets,
                    job,
                    git,
                    &build_dir,
                    move |p| {
                        let ts = Utc::now();
                        bus.publish(Event::JobLogLine {
                            job_run_id: rid.clone(),
                            job_id: jid.clone(),
                            line: p.description.clone(),
                            timestamp: ts,
                            stream: shared::protocol::LogStream::Stdout,
                        });
                        let db_handle = db_handle.clone();
                        let rid = rid.clone();
                        let line = p.description;
                        tokio::spawn(async move {
                            let _ = store::job_log::append(
                                &db_handle,
                                &rid,
                                &shared::protocol::LogStream::Stdout,
                                &line,
                                ts,
                            )
                            .await;
                        });
                    },
                )
                .await?;

                engine::compose::JobBuildSource::Git {
                    compose_rel_path: &git.compose_path,
                }
            }
            None => engine::compose::JobBuildSource::Compose(&job.compose),
        };

        // Cancelamento pode chegar durante um clone Git lento (não
        // interrompido no meio — só checado depois); sem isso, o job
        // seguiria pra subir containers mesmo já tendo sido cancelado.
        let already_cancelled = cancel_rx.as_ref().map(|rx| *rx.borrow()).unwrap_or(false);
        let (exit_code, images) = if already_cancelled {
            (engine::compose::CANCELLED_EXIT_CODE, None)
        } else {
            engine::compose::run_once(
                build_source,
                &project_name,
                &network_name,
                &job.main_service,
                &job.id,
                run_id,
                &self.bus,
                &self.db,
                &env_vars,
                &build_dir,
                self.registry_internal_token.clone(),
                mirror_deployment,
                cancel_rx,
            )
            .await?
        };

        store::job_run::finish(&self.db, run_id, exit_code).await?;

        if let Some(images) = images {
            super::warm::record(&self.db, job, &images).await;
        }

        if let Err(e) = tokio::fs::remove_dir_all(&build_dir).await {
            warn!(run_id = %run_id, error = %e, "job_runner: falha ao limpar build_dir (best-effort)");
        }

        Ok(exit_code)
    }

    /// Uma linha no log da execução (banco + evento ao vivo).
    async fn linha(&self, job_id: &str, run_id: &str, texto: &str) {
        let ts = Utc::now();
        self.bus.publish(Event::JobLogLine {
            job_run_id: run_id.to_string(),
            job_id: job_id.to_string(),
            line: texto.to_string(),
            timestamp: ts,
            stream: shared::protocol::LogStream::Stdout,
        });
        let _ = store::job_log::append(
            &self.db,
            run_id,
            &shared::protocol::LogStream::Stdout,
            texto,
            ts,
        )
        .await;
    }

    /// Cancelada enquanto esperava a vez: nunca começou. Fecha a execução como
    /// cancelada (o mesmo exit code do cancelamento durante a execução).
    async fn cancelar_antes_de_comecar(&self, job: &Job, run_id: &str) {
        self.linha(&job.id, run_id, "==> Cancelado antes de começar a executar")
            .await;
        let _ =
            store::job_run::finish(&self.db, run_id, engine::compose::CANCELLED_EXIT_CODE).await;
        self.bus.publish(Event::JobRunStateChanged {
            job_id: job.id.clone(),
            job_run_id: run_id.to_string(),
            running: false,
            success: Some(false),
        });
    }

    async fn reschedule(&self, job: &Job) {
        let now = Utc::now();
        let next_run_at = job.recurrence.map(|r| r.next_after(now));
        if let Err(e) = store::job::mark_fired(&self.db, &job.id, now, next_run_at).await {
            error!(job_id = %job.id, error = %e, "job_runner: falha ao reagendar");
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::atomic::{AtomicBool, Ordering};
    use std::time::Duration;
    use tokio::time::{sleep, timeout};

    const ESPERA: Duration = Duration::from_millis(60);
    const LIMITE: Duration = Duration::from_secs(2);

    fn sem_cancelar() -> tokio::sync::watch::Receiver<bool> {
        tokio::sync::watch::channel(false).1
    }

    #[tokio::test]
    async fn vaga_livre_entra_na_hora_sem_avisar() {
        let q = DeployQueue::new();
        let avisou = Arc::new(AtomicBool::new(false));
        let a = avisou.clone();
        let vaga = esperar_vaga(&q, sem_cancelar(), async move {
            a.store(true, Ordering::SeqCst)
        })
        .await;
        assert!(vaga.is_some());
        assert!(!avisou.load(Ordering::SeqCst), "não esperou, não avisa");
    }

    #[tokio::test]
    async fn vaga_ocupada_avisa_uma_vez_e_entra_quando_liberar() {
        let q = DeployQueue::new();
        let ocupada = q.acquire_job_slot().await; // um deploy/job em execução
        let avisos = Arc::new(std::sync::atomic::AtomicUsize::new(0));
        let (q2, a) = (q.clone(), avisos.clone());
        let espera = tokio::spawn(async move {
            esperar_vaga(&q2, sem_cancelar(), async move {
                a.fetch_add(1, Ordering::SeqCst);
            })
            .await
        });
        sleep(ESPERA).await;
        assert!(!espera.is_finished(), "espera enquanto a vaga está ocupada");
        assert_eq!(avisos.load(Ordering::SeqCst), 1, "avisou uma vez");
        drop(ocupada);
        let vaga = timeout(LIMITE, espera).await.unwrap().unwrap();
        assert!(vaga.is_some());
        assert_eq!(avisos.load(Ordering::SeqCst), 1);
    }

    #[tokio::test]
    async fn cancelar_enquanto_espera_devolve_none_e_nao_prende_a_vaga() {
        let q = DeployQueue::new();
        let ocupada = q.acquire_job_slot().await;
        let (tx, rx) = tokio::sync::watch::channel(false);
        let q2 = q.clone();
        let espera = tokio::spawn(async move { esperar_vaga(&q2, rx, async {}).await });
        sleep(ESPERA).await;
        tx.send(true).unwrap();
        let vaga = timeout(LIMITE, espera).await.unwrap().unwrap();
        assert!(vaga.is_none(), "cancelado antes de começar");
        // A vaga continua sendo de quem a tinha, e volta a ficar livre normalmente.
        drop(ocupada);
        assert!(
            q.try_job_slot_now().is_some(),
            "a espera cancelada não deixou a vaga presa"
        );
    }

    #[tokio::test]
    async fn fila_pausada_segura_o_job_ate_retomar() {
        let q = DeployQueue::new();
        q.set_paused(true);
        let q2 = q.clone();
        let espera = tokio::spawn(async move { esperar_vaga(&q2, sem_cancelar(), async {}).await });
        sleep(ESPERA).await;
        assert!(
            !espera.is_finished(),
            "pausada: o job espera, mesmo com a vaga livre"
        );
        q.set_paused(false);
        assert!(timeout(LIMITE, espera).await.unwrap().unwrap().is_some());
    }
}