Skip to content
Sign up

flagon-io/g1t

public
00

Where people and agents ship software together. The open-source git platform for the whole job: issues, agents, checks and deploys to the edge.

g1t.sh
gitagentscloudflarerustforgemcp
3,229 linesCodeBlameRaw
1//! A run's life: made, its jobs waiting on the jobs they need, each job
2//! skipped or expanded into its matrix and queued, started in a sandbox
3//! when its workspace has room, reporting its steps and logs as it goes,
4//! and finished; the run finishes with its last job.
5
6use g1t_actions::events::{RunInfo, runner_context};
7use g1t_actions::expr::{self, Scope, Status};
8use g1t_actions::matrix;
9use g1t_actions::workflow::{self, Workflow};
10use g1t_contracts::access::Capability;
11use g1t_contracts::actions::{JobCallArgs, RunActionArgs, RunApproval, StartJobArgs, WorkflowRun};
12use g1t_contracts::identity::{CreateJobTokenArgs, CreatedAccessToken, RevokeJobTokensArgs};
13use g1t_contracts::repos::{Repo, RepoPath};
14use g1t_contracts::time::rfc3339;
15use g1t_contracts::{FailureCode, Outcome, new_id};
16use g1t_kit::now_ms;
17use g1t_secrets::{random_hex, same, sha256_hex};
18use serde::Deserialize;
19use serde_json::{Map, Value, json};
20use worker::Result;
21
22use crate::broker::{self, Broker};
23use crate::protection::Gate;
24use crate::sync::WorkflowRow;
25use crate::{Actions, Count, MAX_TIMEOUT_MINUTES, RUNNING_PER_WORKSPACE, SELF_HOSTED_MAX_TIMEOUT_MINUTES, SILENT_MS, SITE, check, fail, optional, repo_path};
26use g1t_contracts::runners::{Wanted, waiting_reason};
27
28/// The most log one job keeps, in bytes; past it, the log says so and stops.
29const MAX_LOG_BYTES: usize = 4 * 1024 * 1024;
30/// The most a single log report may add.
31const MAX_CHUNK_BYTES: usize = 256 * 1024;
32const MAX_ANNOTATIONS: usize = 50;
33/// Swaps a running job's token for a new one, only while it still has the
34/// one the caller showed (`job_spec` with `rotate`), keeping the hash of
35/// the one it started with for `brokered_secrets` (migration 0020).
36const TOKEN_ROTATE: &str = "UPDATE jobs SET first_token_hash = COALESCE(first_token_hash, token_hash), token_hash = ?1
37 WHERE id = ?2 AND status = 'in_progress' AND token_hash = ?3 RETURNING id";
38
39/// Whether `token` is a running job's: its current one, or with `started`
40/// (`brokered_secrets` only) the one it started with before its harness
41/// swapped it.
42fn token_opens(current: Option<&str>, first: Option<&str>, token: &str, started: bool) -> bool {
43 let hash = sha256_hex(token);
44 current.is_some_and(|h| same(h, &hash)) || (started && first.is_some_and(|h| same(h, &hash)))
45}
46/// A batch of a job's log, under the next `seq` of that job's, worked out
47/// in the same statement (SQLite runs one write at a time). `?4` is the
48/// runner's number for the batch (null from runners that send none): a
49/// batch sent again, after an answer the runner did not hear, has the
50/// number of one already kept, and is not kept twice (migration 0016).
51pub(crate) const LOG_INSERT: &str = "INSERT INTO logs (job_id, seq, step, text, chunk)
52 SELECT ?1, COALESCE(MAX(seq), 0) + 1, ?2, ?3, ?4 FROM logs WHERE job_id = ?1
53 ON CONFLICT (job_id, chunk) DO NOTHING";
54/// The most one step's job summary keeps, in bytes, and how many steps of a
55/// job may have one, as on GitHub.
56pub(crate) const MAX_SUMMARY_BYTES: usize = 1024 * 1024;
57pub(crate) const MAX_SUMMARIES: u32 = 20;
58
59/// Whether a step's summary of `adding` bytes is kept: a job keeps up to
60/// 20 steps' summaries (`steps` it has, `mine` this step's bytes so far)
61/// of up to 1 MiB each.
62pub(crate) fn summary_fits(steps: u32, mine: Option<usize>, adding: usize) -> bool {
63 if adding == 0 {
64 return false;
65 }
66 match mine {
67 Some(used) => used + adding <= MAX_SUMMARY_BYTES,
68 None => steps < MAX_SUMMARIES && adding <= MAX_SUMMARY_BYTES,
69 }
70}
71
72/// The repository whose unfinished runs `event` stops, by id: one deleted,
73/// or archived (not unarchived).
74pub fn stops_runs(event: &g1t_contracts::events::Event) -> Option<String> {
75 let stops = match event.kind.as_str() {
76 "repo.deleted" => true,
77 "repo.archived" => event.data["archived"].as_bool() != Some(false),
78 _ => false,
79 };
80 if !stops {
81 return None;
82 }
83 event.repo_id.clone().or_else(|| event.data["repoId"].as_str().map(str::to_owned))
84}
85
86pub struct NewRun {
87 pub repo: Repo,
88 pub path: String,
89 pub source: String,
90 pub workflow: Workflow,
91 pub info: RunInfo,
92 pub action: Option<String>,
93 pub pull: Option<u32>,
94 pub title: String,
95 pub inputs: Map<String, Value>,
96 pub event_key: String,
97 pub actor_id: Option<String>,
98 pub actor: Option<String>,
99 pub trusted: bool,
100 /// Why the run waits for someone with the Write role to approve it
101 /// before anything starts: a pull request from outside (protection.rs).
102 pub approval: Option<String>,
103 /// The commit the run is listed, and its statuses and checks reported,
104 /// on when it is not the one it builds (`info.sha`): a pull request's
105 /// head, when the run builds its test merge commit, as on GitHub.
106 pub head_sha: Option<String>,
107}
108
109#[derive(Clone, Deserialize)]
110pub struct RunRow {
111 pub id: String,
112 pub workflow_id: String,
113 pub repo_id: String,
114 pub repo: String,
115 pub path: String,
116 pub name: String,
117 pub title: String,
118 pub number: u64,
119 pub attempt: u64,
120 pub event: String,
121 pub action: Option<String>,
122 pub git_ref: String,
123 pub sha: String,
124 pub pull: Option<u32>,
125 pub status: String,
126 pub conclusion: Option<String>,
127 pub error: Option<String>,
128 pub actor: Option<String>,
129 pub actor_id: Option<String>,
130 pub source: String,
131 pub info: String,
132 pub inputs: String,
133 pub trusted: u32,
134 pub concurrency_group: Option<String>,
135 pub created_at: String,
136 pub started_at: Option<String>,
137 pub finished_at: Option<String>,
138 /// JSON `RunApproval`, for a run that needed approval (migration 0006).
139 #[serde(default)]
140 pub approval: Option<String>,
141 /// Whether its concurrency group cancels what it replaces.
142 #[serde(default)]
143 pub cancel_in_progress: u32,
144 /// Who started the current attempt, once it is re-run (migration 0009).
145 #[serde(default)]
146 pub triggering_actor: Option<String>,
147 /// The current attempt runs with debug logging.
148 #[serde(default)]
149 pub debug: u32,
150}
151
152impl RunRow {
153 pub fn approval(&self) -> Option<RunApproval> {
154 self.approval.as_deref().and_then(|text| serde_json::from_str(text).ok())
155 }
156
157 pub fn info(&self) -> RunInfo {
158 let mut info: RunInfo = serde_json::from_str(&self.info).unwrap_or_default();
159 info.run_id = self.id.clone();
160 info.run_number = self.number;
161 info.run_attempt = self.attempt;
162 info.workflow_path = self.path.clone();
163 if info.workflow.is_empty() {
164 info.workflow = self.name.clone();
165 }
166 info
167 }
168
169 pub fn inputs(&self) -> Map<String, Value> {
170 serde_json::from_str(&self.inputs).unwrap_or_default()
171 }
172
173 pub fn summary(&self) -> WorkflowRun {
174 WorkflowRun {
175 id: self.id.clone(),
176 workflow_id: self.workflow_id.clone(),
177 path: self.path.clone(),
178 name: self.name.clone(),
179 title: self.title.clone(),
180 number: self.number,
181 attempt: self.attempt,
182 event: self.event.clone(),
183 git_ref: self.git_ref.clone(),
184 sha: self.sha.clone(),
185 pull: self.pull,
186 status: self.status.clone(),
187 conclusion: self.conclusion.clone(),
188 error: self.error.clone(),
189 actor: self.actor.clone(),
190 created_at: self.created_at.clone(),
191 started_at: self.started_at.clone(),
192 finished_at: self.finished_at.clone(),
193 }
194 }
195}
196
197#[derive(Clone, Deserialize)]
198pub struct JobRow {
199 pub id: String,
200 pub run_id: String,
201 pub repo_id: String,
202 pub namespace: String,
203 pub key: String,
204 pub ordinal: u32,
205 pub name: String,
206 pub needs: String,
207 pub matrix: Option<String>,
208 pub status: String,
209 pub conclusion: Option<String>,
210 pub steps: String,
211 pub annotations: String,
212 pub outputs: String,
213 pub reason: Option<String>,
214 pub token_hash: Option<String>,
215 pub timeout_minutes: u32,
216 pub continue_on_error: u32,
217 pub max_parallel: Option<u32>,
218 /// Set for a job that calls a reusable workflow, and for that
219 /// workflow's jobs (see migration 0002).
220 pub call: Option<String>,
221 pub seen_at: Option<String>,
222 pub started_at: Option<String>,
223 pub finished_at: Option<String>,
224 /// For a job whose `runs-on` names self-hosted runners: what it asks
225 /// for, as a JSON array (see `g1t_contracts::runners::Wanted`), when it
226 /// started waiting, and the runner that took it (migration 0004).
227 #[serde(default)]
228 pub labels: Option<String>,
229 #[serde(default)]
230 pub queued_at: Option<String>,
231 #[serde(default)]
232 pub runner_id: Option<String>,
233 #[serde(default)]
234 pub runner_name: Option<String>,
235 /// The environment it names, read when its needs were done; a job its
236 /// rules hold is `pending` (migration 0006).
237 #[serde(default)]
238 pub environment: Option<String>,
239 /// Its own `concurrency` group, and whether that cancels what it replaces.
240 #[serde(default)]
241 pub concurrency_group: Option<String>,
242 #[serde(default)]
243 pub cancel_in_progress: u32,
244 /// When it was told to stop, while it runs its cleanup steps
245 /// (migration 0009).
246 #[serde(default)]
247 pub cancel_requested_at: Option<String>,
248 /// Whether it was given stand-ins for brokered secrets (migration
249 /// 0019), so its log is masked for their values too.
250 #[serde(default)]
251 pub brokered: u32,
252 /// The hash of the token it started with, once its harness swapped that
253 /// for another (migration 0020): good for `brokered_secrets` only.
254 #[serde(default)]
255 pub first_token_hash: Option<String>,
256}
257
258/// How long a cancelled job has to run its `if: always()` and `cancelled()`
259/// steps and its post steps before it is stopped outright, as on GitHub.
260pub const CANCEL_GRACE_MS: u64 = 5 * 60 * 1000;
261
262/// Which jobs a re-run runs again.
263#[derive(Clone, Copy, Debug, PartialEq)]
264pub enum Rerun<'a> {
265 All,
266 /// Those that did not succeed.
267 Failed,
268 /// One job's key.
269 Job(&'a str),
270}
271
272/// The keys a re-run runs again, in `order`: those `which` names and,
273/// transitively, every key that needs one of them. `needs` gives a key's
274/// needs; `succeeded` whether every job of a key succeeded.
275pub fn rerun_keys(order: &[&str], needs: impl Fn(&str) -> Vec<String>, succeeded: impl Fn(&str) -> bool, which: Rerun) -> Vec<String> {
276 let mut again: Vec<String> = Vec::new();
277 for key in order {
278 let named = match which {
279 Rerun::All => true,
280 Rerun::Failed => !succeeded(key),
281 Rerun::Job(job) => *key == job,
282 };
283 if named || needs(key).iter().any(|need| again.contains(need)) {
284 again.push((*key).to_owned());
285 }
286 }
287 again
288}
289
290/// The key under `jobs:` a job belongs to: a called workflow's jobs
291/// (`build/test`, or `build[1]/test` for a matrix's second call) run again
292/// with the job that calls it (`build`).
293pub fn top_key(key: &str) -> &str {
294 let first = key.split('/').next().unwrap_or(key);
295 first.split('[').next().unwrap_or(first)
296}
297
298/// What the keys of the jobs a caller's call makes start with: the
299/// caller's key, and for a matrix the combination's index after it
300/// (`build[1]`), so each combination's call has jobs of its own. A job id
301/// has no `[`, so the two never meet.
302fn call_prefix(key: &str, index: Option<usize>) -> String {
303 match index {
304 Some(index) => format!("{key}[{index}]"),
305 None => key.to_owned(),
306 }
307}
308
309/// Whether a run may call one more reusable workflow, `file`, `depth`
310/// levels below the workflow it started from, having called `called`
311/// already (one name per call; repeats are one workflow). As on GitHub: ten
312/// levels of workflows at most, the top one and nine reusable ones below
313/// it, and 50 different reusable workflows in a run.
314fn call_allowed(depth: u64, called: &[&str], file: &str) -> std::result::Result<(), String> {
315 if depth > MAX_CALL_DEPTH {
316 return Err(format!(
317 "`{file}` would be the {}th level of workflows: a run connects at most ten, the workflow it started from and nine levels of reusable workflows below it.",
318 depth + 1
319 ));
320 }
321 let mut unique: Vec<&str> = called.to_vec();
322 unique.push(file);
323 unique.sort_unstable();
324 unique.dedup();
325 if unique.len() > MAX_CALLED_WORKFLOWS {
326 return Err(format!("Calling `{file}` would make {} reusable workflows in this run: a run calls at most {MAX_CALLED_WORKFLOWS} different ones.", unique.len()));
327 }
328 Ok(())
329}
330
331/// What a job is shown as: its `name` (else its id), under the job whose
332/// call made it (`caller`), read with its matrix when it has an
333/// expression, else with the matrix's values after it.
334fn shown_name(job: &workflow::Job, caller: Option<&str>, combination: &Map<String, Value>, scope: &Scope) -> String {
335 let base = job.name.clone().unwrap_or(job.id.clone());
336 let base = match caller {
337 Some(caller) => format!("{caller} / {base}"),
338 None => base,
339 };
340 if expr::has_expression(&base) {
341 expr::interpolate(&base, scope).unwrap_or(base)
342 } else if job.matrix.is_some() {
343 matrix::job_name(&base, combination)
344 } else {
345 base
346 }
347}
348
349/// Debug logging for a job, as a re-run with it turned on gives GitHub's:
350/// `RUNNER_DEBUG=1` and `runner.debug`, and `ACTIONS_STEP_DEBUG` and
351/// `ACTIONS_RUNNER_DEBUG` set, which the runner reads as the secrets of
352/// those names (`::debug::` lines shown, and how each step's `if` read).
353pub fn debug_logging(variables: &mut Map<String, Value>, runner: &mut Value) {
354 variables.insert("RUNNER_DEBUG".into(), json!("1"));
355 variables.insert("ACTIONS_STEP_DEBUG".into(), json!("true"));
356 variables.insert("ACTIONS_RUNNER_DEBUG".into(), json!("true"));
357 runner["debug"] = json!("1");
358}
359
360impl JobRow {
361 pub fn needs(&self) -> Vec<String> {
362 serde_json::from_str(&self.needs).unwrap_or_default()
363 }
364
365 pub fn call(&self) -> Option<Value> {
366 self.call.as_deref().and_then(|call| serde_json::from_str(call).ok())
367 }
368
369 /// For a job that calls a reusable workflow: what the keys of the jobs
370 /// its call makes start with (`call_prefix`).
371 pub fn call_prefix(&self) -> Option<String> {
372 let call = self.call().filter(|call| call["role"] == "caller")?;
373 Some(call["prefix"].as_str().unwrap_or(&self.key).to_owned())
374 }
375
376 /// A job that calls a reusable workflow and has not called it yet: it
377 /// waits for room under its matrix's `max-parallel`, or in its
378 /// concurrency group.
379 pub fn holds_call(&self) -> bool {
380 self.status == "waiting" && self.call_prefix().is_some()
381 }
382
383 /// For a job of a called workflow: that workflow, the job's own id in
384 /// it, and the job.
385 pub fn callee(&self) -> Option<(Workflow, workflow::Job, Value)> {
386 let call = self.call().filter(|call| call["role"] == "callee")?;
387 let called = workflow::parse(call["source"].as_str()?).ok()?;
388 let job = called.jobs.iter().find(|job| call["job"].as_str() == Some(job.id.as_str()))?.clone();
389 Some((called, job, call))
390 }
391}
392
393/// A job to decide on: its key, its definition, and what it needs, as
394/// (name in `needs`, key of the jobs).
395type Unit = (String, workflow::Job, Vec<(String, String)>);
396
397/// How many levels of reusable workflows may sit below the workflow a run
398/// started from, as on GitHub (ten levels of workflows in all).
399const MAX_CALL_DEPTH: u64 = 9;
400/// How many different reusable workflows a run may call, as on GitHub.
401const MAX_CALLED_WORKFLOWS: usize = 50;
402
403/// What the jobs of one key came to, for `needs.<key>`.
404fn key_result(rows: &[&JobRow]) -> &'static str {
405 let failed = |row: &&&JobRow| row.conclusion.as_deref() == Some("failure") && row.continue_on_error == 0;
406 if rows.iter().any(|row| failed(&row)) {
407 "failure"
408 } else if rows.iter().any(|row| row.conclusion.as_deref() == Some("cancelled")) {
409 "cancelled"
410 } else if rows.iter().all(|row| row.conclusion.as_deref() == Some("skipped")) {
411 "skipped"
412 } else {
413 "success"
414 }
415}
416
417/// Whether any job before `key` failed: one it needs, or one those need,
418/// however far back. A job after a skipped one still sees the failure
419/// that skipped it, as GitHub's failure() does. `needs_of`: each key's
420/// needs, as keys; `failed`: whether a key's jobs came to a failure.
421fn ancestor_failed(needs_of: &std::collections::HashMap<&str, Vec<&str>>, key: &str, failed: impl Fn(&str) -> bool) -> bool {
422 let mut seen = std::collections::HashSet::new();
423 let mut stack: Vec<&str> = needs_of.get(key).cloned().unwrap_or_default();
424 while let Some(next) = stack.pop() {
425 if !seen.insert(next) {
426 continue;
427 }
428 if failed(next) {
429 return true;
430 }
431 stack.extend(needs_of.get(next).into_iter().flatten().copied());
432 }
433 false
434}
435
436/// A job's `environment:`, as deployments read it: its name, the address in
437/// `environment.url` once its expressions are filled in from the run, and
438/// whether the job deploys to it. A job with `deployment: false` only reads
439/// the environment's secrets and variables, and makes no deployment.
440#[derive(Clone, Debug, Default, PartialEq)]
441pub(crate) struct JobEnvironment {
442 pub(crate) name: String,
443 pub(crate) url: Option<String>,
444 pub(crate) deploys: bool,
445}
446
447/// The environment `environment:` names, as written in `raw` (a job), with
448/// `contexts` to fill in expressions: null when it names none, or only
449/// through an expression this cannot read before the job runs.
450pub(crate) fn environment_of(raw: &Value, contexts: &Map<String, Value>) -> Option<JobEnvironment> {
451 let scope = Scope { contexts, status: Status::Success, hash_files: None };
452 let plain = |value: &Value| -> Option<String> {
453 let text = match value {
454 Value::String(text) if text.contains("${{") => expr::interpolate_value(value, &scope).ok().map(|v| expr::to_text(&v))?,
455 Value::String(text) => text.clone(),
456 _ => return None,
457 };
458 let text = text.trim().to_owned();
459 (!text.is_empty()).then_some(text)
460 };
461 match raw.get("environment")? {
462 name @ Value::String(_) => Some(JobEnvironment { name: plain(name)?, url: None, deploys: workflow::records_deployment(raw) }),
463 Value::Object(env) => {
464 let name = plain(env.get("name")?)?;
465 let url = env
466 .get("url")
467 .and_then(plain)
468 .filter(|url| url.starts_with("https://") || url.starts_with("http://"));
469 Some(JobEnvironment { name, url, deploys: workflow::records_deployment(raw) })
470 }
471 _ => None,
472 }
473}
474
475/// The contexts a job's `runs-on` and `environment` are read with before it
476/// runs: the run's `github`, its inputs, and the job's matrix.
477fn start_contexts(run: &RunRow, job: &JobRow, key: &str) -> Map<String, Value> {
478 let mut contexts = Map::new();
479 contexts.insert("github".into(), run.info().context(key, "", run.action.as_deref()));
480 contexts.insert("inputs".into(), Value::Object(run.inputs()));
481 contexts.insert("matrix".into(), job.matrix.as_deref().and_then(|m| serde_json::from_str(m).ok()).unwrap_or_else(|| json!({})));
482 contexts
483}
484
485/// The job as its workflow (or the workflow it calls) defines it.
486fn job_spec(run: &RunRow, job: &JobRow) -> Option<workflow::Job> {
487 match job.callee() {
488 Some((_, spec, _)) => Some(spec),
489 None => workflow::parse(&run.source).ok().and_then(|w| w.jobs.into_iter().find(|j| j.id == job.key)),
490 }
491}
492
493/// The environment a job deploys to, if it deploys: by the name read when
494/// its needs were done (which may have needed their outputs), else as
495/// its `environment:` reads now.
496pub(crate) fn deploys_to(run: &RunRow, job: &JobRow) -> Option<JobEnvironment> {
497 let spec = job_spec(run, job)?;
498 let read = environment_of(&spec.raw, &start_contexts(run, job, &spec.id));
499 let env = match (read, &job.environment) {
500 (Some(env), Some(name)) => Some(JobEnvironment { name: name.clone(), ..env }),
501 (Some(env), None) => Some(env),
502 (None, Some(name)) => Some(JobEnvironment { name: name.clone(), url: None, deploys: workflow::records_deployment(&spec.raw) }),
503 (None, None) => None,
504 };
505 env.filter(|env| env.deploys)
506}
507
508/// The machine a job's `runs-on` asks for (`instance_for`), for the
509/// runner: none for the standard one.
510fn start_instance(run: &RunRow, job: &JobRow) -> Option<String> {
511 let spec = match job.callee() {
512 Some((_, spec, _)) => spec,
513 None => workflow::parse(&run.source).ok().and_then(|w| w.jobs.into_iter().find(|j| j.id == job.key))?,
514 };
515 // `runs-on` as the job was queued with: its matrix and the run's
516 // inputs. A label that needs more than those is the standard machine.
517 let contexts = start_contexts(run, job, &spec.id);
518 let scope = Scope { contexts: &contexts, status: Status::Success, hash_files: None };
519 let labels: Vec<String> = match expr::interpolate_value(&spec.runs_on, &scope).unwrap_or(Value::Null) {
520 Value::String(label) => vec![label],
521 Value::Array(labels) => labels.iter().map(expr::to_text).collect(),
522 Value::Object(given) => match given.get("labels") {
523 Some(Value::Array(labels)) => labels.iter().map(expr::to_text).collect(),
524 Some(label) => vec![expr::to_text(label)],
525 None => Vec::new(),
526 },
527 _ => Vec::new(),
528 };
529 let instance = g1t_contracts::actions::instance_for(&labels);
530 (instance != g1t_contracts::actions::STANDARD_INSTANCE).then(|| instance.label.to_owned())
531}
532
533fn now() -> String {
534 rfc3339(now_ms())
535}
536
537/// How a finished run went for one environment, from the conclusions of
538/// the jobs that deploy to it: failed if any failed, an error if any was
539/// cancelled, else a success; nothing when none ran (all skipped).
540pub(crate) fn deployment_outcome(conclusions: &[Option<String>]) -> Option<&'static str> {
541 let ran: Vec<&str> = conclusions.iter().flatten().map(String::as_str).filter(|c| *c != "skipped").collect();
542 if ran.is_empty() {
543 return None;
544 }
545 if ran.iter().any(|c| *c == "failure" || *c == "timed_out") {
546 return Some("failure");
547 }
548 if ran.contains(&"cancelled") {
549 return Some("error");
550 }
551 Some("success")
552}
553
554impl Actions {
555 pub async fn run_row(&self, id: &str) -> Result<Option<RunRow>> {
556 self.db.prepare("SELECT * FROM runs WHERE id = ?").bind(&[id.into()])?.first::<RunRow>(None).await
557 }
558
559 pub async fn job_rows(&self, run_id: &str) -> Result<Vec<JobRow>> {
560 self.db
561 .prepare("SELECT * FROM jobs WHERE run_id = ? ORDER BY rowid")
562 .bind(&[run_id.into()])?
563 .all()
564 .await?
565 .results::<JobRow>()
566 }
567
568 pub async fn run_summary(&self, id: &str) -> Result<Outcome<WorkflowRun>> {
569 Ok(match self.run_row(id).await? {
570 Some(row) => Outcome::Ok(row.summary()),
571 None => fail(FailureCode::NotFound, "No such run."),
572 })
573 }
574
575 /// The contexts every expression outside a job's steps may use.
576 fn base_contexts(run: &RunRow, vars: &Map<String, Value>, job: &str) -> Map<String, Value> {
577 let mut contexts = Map::new();
578 contexts.insert("github".into(), run.info().context(job, "", run.action.as_deref()));
579 contexts.insert("inputs".into(), Value::Object(run.inputs()));
580 contexts.insert("vars".into(), Value::Object(vars.clone()));
581 contexts.insert("needs".into(), json!({}));
582 contexts.insert("runner".into(), runner_context());
583 contexts
584 }
585
586 /// Whether `namespace` is a person's own workspace: usernames and
587 /// workspaces share one namespace, so it is when someone has that
588 /// username. Kept in the isolate for a few minutes, so a burst of
589 /// runs asks identity once.
590 async fn personal_namespace(&self, namespace: &str) -> Result<bool> {
591 const KEEP_MS: u64 = 5 * 60 * 1000;
592 thread_local! {
593 static PERSONAL: std::cell::RefCell<std::collections::HashMap<String, (bool, u64)>> = Default::default();
594 }
595 let now = now_ms();
596 let key = namespace.to_ascii_lowercase();
597 if let Some(personal) = PERSONAL.with(|kept| kept.borrow().get(&key).filter(|(_, at)| now.saturating_sub(*at) < KEEP_MS).map(|(personal, _)| *personal)) {
598 return Ok(personal);
599 }
600 let found: g1t_contracts::Viewer = g1t_kit::call(
601 &self.identity,
602 "user_by_username",
603 &g1t_contracts::identity::UsernameArgs { username: key.clone() },
604 )
605 .await?;
606 let personal = found.is_some_and(|user| user.username.eq_ignore_ascii_case(namespace));
607 PERSONAL.with(|kept| {
608 let mut kept = kept.borrow_mut();
609 if kept.len() > 1000 {
610 kept.clear();
611 }
612 kept.insert(key, (personal, now));
613 });
614 Ok(personal)
615 }
616
617 /// Makes a run and its jobs, and starts what can start. `None` when the
618 /// event already started this workflow.
619 pub async fn create_run(&self, new: NewRun) -> Result<Option<String>> {
620 self.create_run_with(new, false).await
621 }
622
623 /// As `create_run`, but the run's pending status must reach Work: one
624 /// that cannot is cancelled and the error returned, so that a caller
625 /// waiting on statuses (the merge queue) never reads "no workflows" or
626 /// a premature pass from a run nothing was told about.
627 pub async fn create_run_registered(&self, new: NewRun) -> Result<Option<String>> {
628 self.create_run_with(new, true).await
629 }
630
631 async fn create_run_with(&self, new: NewRun, strict: bool) -> Result<Option<String>> {
632 // Nothing starts on an archived repository. A deleted one is never
633 // found to start anything on.
634 if new.repo.archived() {
635 return Ok(None);
636 }
637 let workflow_row = self.workflow_row(&new.repo, &new.path, &new.workflow.display_name(&new.path), &new.source).await?;
638 let numbered = self
639 .db
640 .prepare("UPDATE workflows SET run_count = run_count + 1 WHERE id = ? RETURNING run_count AS n")
641 .bind(&[workflow_row.id.as_str().into()])?
642 .first::<Count>(None)
643 .await?
644 .map_or(1, |count| count.n);
645 let id = new_id("run", now_ms());
646 let mut info = new.info.clone();
647 // A personal workspace's repositories are a `User`'s, as on GitHub.
648 if self.personal_namespace(&new.repo.namespace).await? {
649 crate::payload::owned_by_person(&mut info.event, &new.repo.namespace);
650 }
651 info.workflow = new.workflow.display_name(&new.path);
652 info.workflow_path = new.path.clone();
653 info.run_id = id.clone();
654 info.run_number = u64::from(numbered);
655 let vars = self
656 .variables_for(&new.repo.id, &format!("{}/{}", new.repo.namespace, new.repo.name), None, new.trusted)
657 .await?;
658
659 // run-name and the concurrency group read github, inputs and vars.
660 let mut contexts = Map::new();
661 contexts.insert("github".into(), info.context("", "", new.action.as_deref()));
662 contexts.insert("inputs".into(), Value::Object(new.inputs.clone()));
663 contexts.insert("vars".into(), Value::Object(vars));
664 let scope = Scope {
665 contexts: &contexts,
666 status: Status::Success,
667 hash_files: None,
668 };
669 let title = new
670 .workflow
671 .run_name
672 .as_deref()
673 .and_then(|run_name| expr::interpolate(run_name, &scope).ok())
674 .filter(|title| !title.trim().is_empty())
675 .unwrap_or(new.title.clone());
676 let group = new.workflow.concurrency.as_ref().and_then(|c| expr::interpolate(&c.group, &scope).ok());
677 let cancel_in_progress = new
678 .workflow
679 .concurrency
680 .as_ref()
681 .and_then(|c| expr::interpolate_value(&c.cancel_in_progress, &scope).ok())
682 .is_some_and(|value| expr::truthy(&value));
683
684 let approval = new.approval.as_ref().map(|reason| RunApproval { state: "required".into(), reason: reason.clone(), approved_by: None });
685 let inserted = self
686 .db
687 .prepare(
688 "INSERT OR IGNORE INTO runs (id, workflow_id, repo_id, repo, path, name, title, number, event, action, git_ref, sha,
689 pull, status, actor, actor_id, source, info, inputs, trusted, concurrency_group, event_key, created_at,
690 approval, cancel_in_progress)
691 VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?) RETURNING id",
692 )
693 .bind(&[
694 id.as_str().into(),
695 workflow_row.id.as_str().into(),
696 new.repo.id.as_str().into(),
697 format!("{}/{}", new.repo.namespace, new.repo.name).into(),
698 new.path.as_str().into(),
699 info.workflow.as_str().into(),
700 title.as_str().into(),
701 numbered.into(),
702 info.event_name.as_str().into(),
703 optional(new.action.as_deref()),
704 info.git_ref.as_str().into(),
705 new.head_sha.as_deref().unwrap_or(&info.sha).into(),
706 new.pull.map_or(worker::wasm_bindgen::JsValue::NULL, Into::into),
707 if approval.is_some() { "action_required" } else { "queued" }.into(),
708 optional(new.actor.as_deref()),
709 optional(new.actor_id.as_deref()),
710 new.source.as_str().into(),
711 serde_json::to_string(&info)?.into(),
712 serde_json::to_string(&new.inputs)?.into(),
713 u32::from(new.trusted).into(),
714 optional(group.as_deref()),
715 new.event_key.as_str().into(),
716 now().into(),
717 approval.as_ref().map(serde_json::to_string).transpose()?.as_deref().map_or(worker::wasm_bindgen::JsValue::NULL, Into::into),
718 u32::from(cancel_in_progress).into(),
719 ])?
720 .first::<Value>(None)
721 .await?;
722 if inserted.is_none() {
723 return Ok(None);
724 }
725 let mut unregistered = None;
726 if let Some(run) = self.run_row(&id).await? {
727 if strict {
728 if let Err(error) = self.try_report_pending(&run).await {
729 unregistered = Some((run, error));
730 }
731 } else {
732 self.report_pending(&run).await?;
733 }
734 }
735
736 // Every job, waiting; each is expanded when the jobs it needs are done.
737 let mut statements = Vec::new();
738 for job in &new.workflow.jobs {
739 statements.push(
740 self.db
741 .prepare(
742 "INSERT INTO jobs (id, run_id, repo_id, namespace, key, name, needs, status) VALUES (?, ?, ?, ?, ?, ?, ?, 'waiting')",
743 )
744 .bind(&[
745 new_id("job", now_ms()).into(),
746 id.as_str().into(),
747 new.repo.id.as_str().into(),
748 new.repo.namespace.as_str().into(),
749 job.id.as_str().into(),
750 job.name.clone().filter(|n| !expr::has_expression(n)).unwrap_or(job.id.clone()).into(),
751 serde_json::to_string(&job.needs)?.into(),
752 ])?,
753 );
754 }
755 self.db.batch(statements).await?;
756 if let Some((run, error)) = unregistered {
757 self.cancel_run(&run, "Its pending status could not be registered.", false).await?;
758 return Err(error);
759 }
760
761 // A pull request's run from outside waits to be approved; it joins
762 // its concurrency group once it is (protection.rs, approve_run).
763 if approval.is_some() {
764 return Ok(Some(id));
765 }
766 if let Some(run) = self.run_row(&id).await? {
767 self.enter_group(&run).await?;
768 }
769 Ok(Some(id))
770 }
771
772 /// A run about to start: one run at a time per concurrency group, as on
773 /// GitHub. A newer run replaces one that waits in the group, and with
774 /// `cancel-in-progress` the one that runs; otherwise it waits as
775 /// `pending` for the one that runs. Then it moves along.
776 pub(crate) async fn enter_group(&self, run: &RunRow) -> Result<()> {
777 if let Some(group) = &run.concurrency_group {
778 let cancel_in_progress = run.cancel_in_progress != 0;
779 let others = self
780 .db
781 .prepare(
782 "SELECT * FROM runs WHERE repo_id = ? AND concurrency_group = ? AND id != ? AND status NOT IN ('completed', 'action_required') ORDER BY id",
783 )
784 .bind(&[run.repo_id.as_str().into(), group.as_str().into(), run.id.as_str().into()])?
785 .all()
786 .await?
787 .results::<RunRow>()?;
788 for other in &others {
789 if cancel_in_progress || other.status == "pending" {
790 // A newer run replaces a waiting one, as on GitHub.
791 self.cancel_run(other, "A newer run in the same concurrency group replaced it.", false).await?;
792 }
793 }
794 if !cancel_in_progress && others.iter().any(|other| other.status != "pending") {
795 self.db
796 .prepare("UPDATE runs SET status = 'pending' WHERE id = ?")
797 .bind(&[run.id.as_str().into()])?
798 .run()
799 .await?;
800 return Ok(());
801 }
802 }
803 self.advance(&run.id).await
804 }
805
806 /// A run that could not start, such as for a workflow file that does not read.
807 #[allow(clippy::too_many_arguments)]
808 pub async fn record_failed_run(
809 &self,
810 row: &WorkflowRow,
811 git_ref: &str,
812 sha: &str,
813 event_key: &str,
814 actor_id: Option<&str>,
815 actor: &str,
816 problem: &str,
817 ) -> Result<()> {
818 let numbered = self
819 .db
820 .prepare("UPDATE workflows SET run_count = run_count + 1 WHERE id = ? RETURNING run_count AS n")
821 .bind(&[row.id.as_str().into()])?
822 .first::<Count>(None)
823 .await?
824 .map_or(1, |count| count.n);
825 let at = now();
826 self.db
827 .prepare(
828 "INSERT OR IGNORE INTO runs (id, workflow_id, repo_id, repo, path, name, title, number, event, git_ref, sha, status,
829 conclusion, error, actor, actor_id, source, info, event_key, created_at, finished_at)
830 VALUES (?, ?, ?, ?, ?, ?, ?, ?, 'push', ?, ?, 'completed', 'failure', ?, ?, ?, ?, '{}', ?, ?, ?)",
831 )
832 .bind(&[
833 new_id("run", now_ms()).into(),
834 row.id.as_str().into(),
835 row.repo_id.as_str().into(),
836 row.repo.as_str().into(),
837 row.path.as_str().into(),
838 row.path.as_str().into(),
839 "Invalid workflow file".into(),
840 numbered.into(),
841 git_ref.into(),
842 sha.into(),
843 problem.into(),
844 actor.into(),
845 optional(actor_id),
846 row.source.as_str().into(),
847 event_key.into(),
848 at.as_str().into(),
849 at.as_str().into(),
850 ])?
851 .run()
852 .await?;
853 Ok(())
854 }
855
856 /// Moves a run along: jobs whose needs are done are decided on, and
857 /// jobs that can start are started.
858 pub async fn advance(&self, run_id: &str) -> Result<()> {
859 // Each pass may finish jobs (skipped ones), which may free others.
860 for _ in 0..20 {
861 let Some(run) = self.run_row(run_id).await? else { return Ok(()) };
862 if matches!(run.status.as_str(), "completed" | "pending" | "action_required") {
863 return Ok(());
864 }
865 let workflow = match workflow::parse(&run.source) {
866 Ok(workflow) => workflow,
867 Err(problem) => {
868 self.finish_run(&run, Some(&problem)).await?;
869 return Ok(());
870 }
871 };
872 let jobs = self.job_rows(run_id).await?;
873 let mut changed = false;
874 // What to decide on: the workflow's jobs, and the jobs of the
875 // workflows they call, each with its needs as (name, key).
876 let mut units: Vec<Unit> = workflow
877 .jobs
878 .iter()
879 .map(|job| (job.id.clone(), job.clone(), job.needs.iter().map(|n| (n.clone(), n.clone())).collect()))
880 .collect();
881 let mut seen = std::collections::HashSet::new();
882 for row in &jobs {
883 if !seen.insert(row.key.clone()) {
884 continue;
885 }
886 if let Some((_, job, call)) = row.callee() {
887 let parent = call["parent"].as_str().unwrap_or_default().to_owned();
888 let needs = job.needs.iter().map(|n| (n.clone(), format!("{parent}/{n}"))).collect();
889 units.push((row.key.clone(), job, needs));
890 }
891 }
892 // Each key's needs, as keys, to look back through for failure().
893 let needs_of: std::collections::HashMap<&str, Vec<&str>> =
894 units.iter().map(|(key, _, needs)| (key.as_str(), needs.iter().map(|(_, need)| need.as_str()).collect())).collect();
895 let key_failed = |key: &str| key_result(&jobs.iter().filter(|row| row.key == key).collect::<Vec<_>>()) == "failure";
896 for (key, job, needs) in &units {
897 let rows: Vec<&JobRow> = jobs.iter().filter(|row| &row.key == key).collect();
898 if rows.is_empty() || !rows.iter().all(|row| row.status == "waiting" && !row.holds_call()) {
899 continue;
900 }
901 let needed: Vec<(&String, Vec<&JobRow>)> =
902 needs.iter().map(|(name, need)| (name, jobs.iter().filter(|row| &row.key == need).collect())).collect();
903 if !needed.iter().all(|(_, rows)| rows.iter().all(|row| row.status == "completed")) {
904 continue;
905 }
906 let failed_before = ancestor_failed(&needs_of, key, key_failed);
907 self.decide(&run, job, rows[0], &needed, failed_before).await?;
908 changed = true;
909 }
910 // A job that called a workflow finishes with that workflow's jobs.
911 for row in jobs.iter().filter(|row| row.status == "calling") {
912 let prefix = row.call_prefix().unwrap_or(row.key.clone());
913 let children: Vec<&JobRow> = jobs
914 .iter()
915 .filter(|child| child.call().is_some_and(|call| call["role"] == "callee" && call["parent"].as_str() == Some(prefix.as_str())))
916 .collect();
917 if !children.is_empty() && children.iter().all(|child| child.status == "completed") {
918 self.finish_call(&run, row, &children).await?;
919 changed = true;
920 }
921 }
922 // Calls that wait start while their matrix's `max-parallel` and
923 // their concurrency group have room.
924 let mut calling: std::collections::HashMap<&str, u32> = std::collections::HashMap::new();
925 for row in jobs.iter().filter(|row| row.status == "calling") {
926 *calling.entry(row.key.as_str()).or_default() += 1;
927 }
928 for row in jobs.iter().filter(|row| row.holds_call()) {
929 let running = calling.get(row.key.as_str()).copied().unwrap_or(0);
930 if row.max_parallel.is_some_and(|max| running >= max) || self.group_busy(row).await? {
931 continue;
932 }
933 if self.start_call(row).await? {
934 calling.insert(row.key.as_str(), running + 1);
935 changed = true;
936 }
937 }
938 if !changed {
939 break;
940 }
941 }
942 self.start_queued().await?;
943 self.finish_if_done(run_id).await
944 }
945
946 /// Decides on one job whose needs are done: skip it, fail it, or expand
947 /// it into its matrix and queue it. `failed_before`: whether any job
948 /// before it failed, however far back (`ancestor_failed`).
949 async fn decide(&self, run: &RunRow, job: &workflow::Job, row: &JobRow, needed: &[(&String, Vec<&JobRow>)], failed_before: bool) -> Result<()> {
950 let vars = self.variables_for(&run.repo_id, &run.repo, None, run.trusted != 0).await?;
951 let mut contexts = Self::base_contexts(run, &vars, &job.id);
952 // A called workflow's jobs read the inputs they were called with.
953 let call = row.call();
954 // Shown under the job whose call made it, by that job's name.
955 let caller = call.as_ref().filter(|c| c["role"] == "callee").and_then(|c| {
956 c["title"].as_str().map(str::to_owned).or_else(|| c["parent"].as_str().map(|parent| parent.replace('/', " / ")))
957 });
958 if let Some(call) = call.as_ref().filter(|c| c["role"] == "callee") {
959 contexts.insert("inputs".into(), call["inputs"].clone());
960 }
961 let mut needs = Map::new();
962 let mut results = Vec::new();
963 for (key, rows) in needed {
964 let result = key_result(rows);
965 let mut outputs = Map::new();
966 for row in rows {
967 if let Ok(Value::Object(more)) = serde_json::from_str::<Value>(&row.outputs) {
968 outputs.extend(more);
969 }
970 }
971 results.push(result);
972 needs.insert((*key).clone(), json!({ "result": result, "outputs": outputs }));
973 }
974 // As on GitHub: a need that was skipped makes success() false but
975 // not failure(); failure() is a failure anywhere before the job.
976 let status = expr::job_status(results, failed_before, run.conclusion.as_deref() == Some("cancelled"));
977 contexts.insert("needs".into(), Value::Object(needs));
978 let scope = Scope {
979 contexts: &contexts,
980 status,
981 hash_files: None,
982 };
983 let condition = job.condition.as_deref().unwrap_or_default();
984 match expr::condition(condition, &scope) {
985 Ok(true) => {}
986 Ok(false) => return self.skip_job(row, None).await,
987 Err(problem) => return self.fail_job(row, &format!("Its `if` does not read: {problem}")).await,
988 }
989 // Its matrix, which may come from a needed job's outputs.
990 let combinations = match &job.matrix {
991 None => vec![Map::new()],
992 Some(matrix) => {
993 let value = match expr::interpolate_value(matrix, &scope) {
994 Ok(value) => value,
995 Err(problem) => return self.fail_job(row, &format!("Its matrix does not read: {problem}")).await,
996 };
997 match matrix::expand(&value) {
998 Ok(combinations) if !combinations.is_empty() => combinations,
999 Ok(_) => return self.fail_job(row, "Its matrix makes no jobs.").await,
1000 Err(problem) => return self.fail_job(row, &problem).await,
1001 }
1002 }
1003 };
1004 // A job that calls a reusable workflow calls it once for each.
1005 if let Some(uses) = &job.uses {
1006 return self.call_workflow(run, job, row, uses, &contexts, &combinations, caller.as_deref()).await;
1007 }
1008 let total = combinations.len();
1009 let raw = job.raw.as_object().cloned().unwrap_or_default();
1010 // Whether pull requests from forks may use self-hosted runners here,
1011 // asked once, and only for a run that is not trusted.
1012 let mut forks_allowed: Option<bool> = None;
1013 // Each concurrency group its jobs join, and whether it cancels.
1014 let mut groups: Vec<(String, bool)> = Vec::new();
1015 let mut statements = Vec::new();
1016 for (index, combination) in combinations.iter().enumerate() {
1017 let mut contexts = contexts.clone();
1018 contexts.insert("matrix".into(), Value::Object(combination.clone()));
1019 contexts.insert(
1020 "strategy".into(),
1021 json!({ "fail-fast": job.fail_fast, "job-index": index, "job-total": total, "max-parallel": job.max_parallel.unwrap_or(total as u32) }),
1022 );
1023 let scope = Scope {
1024 contexts: &contexts,
1025 status: Status::Success,
1026 hash_files: None,
1027 };
1028 let name = shown_name(job, caller.as_deref(), combination, &scope);
1029 let runs_on = expr::interpolate_value(&job.runs_on, &scope).unwrap_or(Value::Null);
1030 let labels = match &runs_on {
1031 Value::String(label) => vec![label.clone()],
1032 Value::Array(labels) => labels.iter().map(expr::to_text).collect(),
1033 Value::Object(spec) => spec.get("labels").map(|l| match l {
1034 Value::Array(labels) => labels.iter().map(expr::to_text).collect(),
1035 other => vec![expr::to_text(other)],
1036 }).unwrap_or_default(),
1037 _ => Vec::new(),
1038 };
1039 // `runs-on: self-hosted` (or a group): the workspace's own
1040 // machines, which may run any OS. Otherwise g1t's Linux sandboxes.
1041 let group = match &runs_on {
1042 Value::Object(spec) => spec.get("group").map(expr::to_text),
1043 _ => None,
1044 };
1045 let wanted = Wanted::of(&labels, group.as_deref());
1046 let mut reason = if wanted.self_hosted {
1047 None
1048 } else {
1049 labels
1050 .iter()
1051 .find(|label| {
1052 let lower = label.to_ascii_lowercase();
1053 lower.contains("windows") || lower.contains("macos")
1054 })
1055 .map(|label| {
1056 let os = if label.to_ascii_lowercase().contains("windows") { "windows" } else { "macos" };
1057 format!("`runs-on: {label}`: g1t's own runners are Linux. A self-hosted runner can run it: `runs-on: [self-hosted, {os}]`.")
1058 })
1059 };
1060 // A pull request from a fork runs code anyone could write: never
1061 // on the workspace's machines unless it said they may.
1062 if wanted.self_hosted && run.trusted == 0 {
1063 let allowed = match forks_allowed {
1064 Some(allowed) => allowed,
1065 None => {
1066 let allowed = self.effective_runner_settings(&row.namespace, Some(&run.repo_id)).await?.fork_pull_requests;
1067 forks_allowed = Some(allowed);
1068 allowed
1069 }
1070 };
1071 if !allowed {
1072 reason = Some(
1073 "Pull requests from forks do not run on self-hosted runners here. An admin can allow it under Settings, Runners.".to_owned(),
1074 );
1075 }
1076 }
1077 let max_minutes = if wanted.self_hosted { SELF_HOSTED_MAX_TIMEOUT_MINUTES } else { MAX_TIMEOUT_MINUTES };
1078 let timeout = raw
1079 .get("timeout-minutes")
1080 .and_then(|value| expr::interpolate_value(value, &scope).ok())
1081 .and_then(|value| value.as_f64().or_else(|| expr::to_text(&value).parse().ok()))
1082 .map_or(g1t_actions::workflow::DEFAULT_TIMEOUT_MINUTES.min(max_minutes), |minutes| (minutes.ceil() as u32).clamp(1, max_minutes));
1083 let continue_on_error = raw
1084 .get("continue-on-error")
1085 .and_then(|value| expr::interpolate_value(value, &scope).ok())
1086 .is_some_and(|value| expr::truthy(&value));
1087 let (mut status, mut conclusion, mut finished) = match &reason {
1088 Some(_) => ("completed", Some("failure"), Some(now())),
1089 None => ("queued", None, None),
1090 };
1091 // A self-hosted job waits, saying for what, until a runner takes it.
1092 let (labels_json, queued_at) = if wanted.self_hosted && reason.is_none() {
1093 reason = Some(waiting_reason(&wanted));
1094 (Some(serde_json::to_string(&wanted.stored())?), Some(now()))
1095 } else {
1096 (None, None)
1097 };
1098 // The environment it names, an expression read now, and what
1099 // that environment's protection rules say: it starts, waits as
1100 // `pending` (protection.rs), or may not deploy there.
1101 let environment = environment_of(&job.raw, &contexts).map(|env| env.name);
1102 if status == "queued"
1103 && let Some(name) = &environment
1104 {
1105 match self.gate(run, name).await? {
1106 Gate::Open => {}
1107 Gate::Held(why) => {
1108 status = "pending";
1109 reason = Some(why);
1110 }
1111 Gate::Refused(why) => {
1112 (status, conclusion, finished) = ("completed", Some("failure"), Some(now()));
1113 reason = Some(why);
1114 }
1115 }
1116 }
1117 // Its own concurrency group.
1118 let job_group = job
1119 .concurrency
1120 .as_ref()
1121 .and_then(|c| expr::interpolate(&c.group, &scope).ok())
1122 .map(|group| group.trim().to_owned())
1123 .filter(|group| !group.is_empty());
1124 let job_cancel = job
1125 .concurrency
1126 .as_ref()
1127 .and_then(|c| expr::interpolate_value(&c.cancel_in_progress, &scope).ok())
1128 .is_some_and(|value| expr::truthy(&value));
1129 if status != "completed"
1130 && let Some(group) = &job_group
1131 && !groups.iter().any(|(known, _)| known == group)
1132 {
1133 groups.push((group.clone(), job_cancel));
1134 }
1135 let values: Vec<worker::wasm_bindgen::JsValue> = vec![
1136 name.into(),
1137 serde_json::to_string(combination)?.into(),
1138 status.into(),
1139 optional(conclusion),
1140 optional(reason.as_deref()),
1141 timeout.into(),
1142 u32::from(continue_on_error).into(),
1143 job.max_parallel.map_or(worker::wasm_bindgen::JsValue::NULL, Into::into),
1144 optional(finished.as_deref()),
1145 optional(labels_json.as_deref()),
1146 optional(queued_at.as_deref()),
1147 optional(environment.as_deref()),
1148 optional(job_group.as_deref()),
1149 u32::from(job_cancel).into(),
1150 ];
1151 if index == 0 {
1152 let mut bound = values;
1153 bound.push(row.id.as_str().into());
1154 statements.push(
1155 self.db
1156 .prepare(
1157 "UPDATE jobs SET name = ?, matrix = ?, status = ?, conclusion = ?, reason = ?, timeout_minutes = ?,
1158 continue_on_error = ?, max_parallel = ?, finished_at = ?, labels = ?, queued_at = ?, environment = ?,
1159 concurrency_group = ?, cancel_in_progress = ? WHERE id = ?",
1160 )
1161 .bind(&bound)?,
1162 );
1163 } else {
1164 let mut bound: Vec<worker::wasm_bindgen::JsValue> = vec![
1165 new_id("job", now_ms()).into(),
1166 row.run_id.as_str().into(),
1167 row.repo_id.as_str().into(),
1168 row.namespace.as_str().into(),
1169 row.key.as_str().into(),
1170 (index as u32).into(),
1171 row.needs.as_str().into(),
1172 optional(row.call.as_deref()),
1173 ];
1174 bound.extend(values);
1175 statements.push(
1176 self.db
1177 .prepare(
1178 "INSERT INTO jobs (id, run_id, repo_id, namespace, key, ordinal, needs, call, name, matrix, status, conclusion, reason,
1179 timeout_minutes, continue_on_error, max_parallel, finished_at, labels, queued_at, environment,
1180 concurrency_group, cancel_in_progress)
1181 VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
1182 )
1183 .bind(&bound)?,
1184 );
1185 }
1186 }
1187 self.db.batch(statements).await?;
1188 self.replace_in_groups(run, &row.key, &groups).await
1189 }
1190
1191 /// A job queued in its own concurrency group: with `cancel-in-progress`
1192 /// it cancels the group's other jobs; otherwise it replaces any that
1193 /// are queued and not started, and waits for the one running
1194 /// (`start_queued` starts one of a group at a time). As on GitHub.
1195 async fn replace_in_groups(&self, run: &RunRow, key: &str, groups: &[(String, bool)]) -> Result<()> {
1196 if groups.is_empty() {
1197 return Ok(());
1198 }
1199 #[derive(Deserialize)]
1200 struct Id {
1201 id: String,
1202 }
1203 let mine: Vec<String> = self
1204 .db
1205 .prepare("SELECT id FROM jobs WHERE run_id = ? AND key = ?")
1206 .bind(&[run.id.as_str().into(), key.into()])?
1207 .all()
1208 .await?
1209 .results::<Id>()?
1210 .into_iter()
1211 .map(|row| row.id)
1212 .collect();
1213 let mut moved: Vec<String> = Vec::new();
1214 for (group, cancel) in groups {
1215 let others = self
1216 .db
1217 // A call that waits in the group, or calls, is in it too.
1218 .prepare("SELECT * FROM jobs WHERE repo_id = ? AND concurrency_group = ? AND status IN ('waiting', 'queued', 'pending', 'in_progress', 'calling')")
1219 .bind(&[run.repo_id.as_str().into(), group.as_str().into()])?
1220 .all()
1221 .await?
1222 .results::<JobRow>()?;
1223 for other in others.iter().filter(|other| !mine.contains(&other.id)) {
1224 if *cancel || matches!(other.status.as_str(), "queued" | "waiting") {
1225 self.stop_job(other, "A newer job in the same concurrency group replaced it.").await?;
1226 if !moved.contains(&other.run_id) {
1227 moved.push(other.run_id.clone());
1228 }
1229 }
1230 }
1231 }
1232 for other_run in moved.iter().filter(|id| **id != run.id) {
1233 Box::pin(self.advance(other_run)).await?;
1234 }
1235 Ok(())
1236 }
1237
1238 /// A job that calls a reusable workflow, in the repository or another
1239 /// (reach.rs): once for each combination of its matrix, as on GitHub,
1240 /// each with the inputs and secrets it passes read with that
1241 /// combination's `matrix`. Each call waits (`holds_call`) until its
1242 /// matrix's `max-parallel` and its concurrency group have room, when
1243 /// `start_call` puts the workflow's jobs in the run under it.
1244 #[allow(clippy::too_many_arguments)]
1245 async fn call_workflow(
1246 &self,
1247 run: &RunRow,
1248 job: &workflow::Job,
1249 row: &JobRow,
1250 uses: &str,
1251 contexts: &Map<String, Value>,
1252 combinations: &[Map<String, Value>],
1253 caller: Option<&str>,
1254 ) -> Result<()> {
1255 let depth = row.call().and_then(|c| c["depth"].as_u64()).unwrap_or(0) + 1;
1256 if depth > MAX_CALL_DEPTH {
1257 return self.fail_job(row, &call_allowed(depth, &[], uses).unwrap_err()).await;
1258 }
1259 let (file, source, origin) = match self.called_workflow(run, row, uses).await? {
1260 Ok(found) => found,
1261 Err(why) => return self.fail_job(row, &why).await,
1262 };
1263 let jobs = self.job_rows(&run.id).await?;
1264 // Each call so far, by the workflow it called.
1265 let called_paths: Vec<String> = jobs
1266 .iter()
1267 .filter(|other| other.call_prefix().is_some())
1268 .filter_map(JobRow::call)
1269 .filter_map(|call| call["path"].as_str().map(str::to_owned))
1270 .collect();
1271 let called_already: Vec<&str> = called_paths.iter().map(String::as_str).collect();
1272 if let Err(why) = call_allowed(depth, &called_already, &file) {
1273 return self.fail_job(row, &why).await;
1274 }
1275 let called = match workflow::parse(&source) {
1276 Ok(called) => called,
1277 Err(problem) => return self.fail_job(row, &format!("`{file}` does not read: {problem}")).await,
1278 };
1279 let Some(trigger) = called.trigger("workflow_call") else {
1280 return self.fail_job(row, &format!("`{file}` cannot be called: it has no `on: workflow_call`.")).await;
1281 };
1282 // Secrets: none but the job's token unless `secrets:` passes them,
1283 // by name or with `inherit`; read when each job starts (job_spec).
1284 let outer = row.call().filter(|c| c["role"] == "callee").and_then(|c| c.get("secrets").cloned());
1285 let total = combinations.len();
1286 let mut groups: Vec<(String, bool)> = Vec::new();
1287 let mut statements = Vec::new();
1288 for (index, combination) in combinations.iter().enumerate() {
1289 let mut contexts = contexts.clone();
1290 contexts.insert("matrix".into(), Value::Object(combination.clone()));
1291 contexts.insert(
1292 "strategy".into(),
1293 json!({ "fail-fast": job.fail_fast, "job-index": index, "job-total": total, "max-parallel": job.max_parallel.unwrap_or(total as u32) }),
1294 );
1295 let scope = Scope { contexts: &contexts, status: Status::Success, hash_files: None };
1296 let name = shown_name(job, caller, combination, &scope);
1297 // Inputs: what `with:` passes, as the called workflow types them.
1298 let given = match job.raw.get("with") {
1299 Some(with) => match expr::interpolate_value(with, &scope) {
1300 Ok(Value::Object(given)) => Ok(given),
1301 Ok(_) => Ok(Map::new()),
1302 Err(problem) => Err(format!("Its `with` does not read: {problem}")),
1303 },
1304 None => Ok(Map::new()),
1305 };
1306 let inputs = given.and_then(|given| crate::reach::call_inputs(&file, &trigger.inputs, &given));
1307 let secrets = crate::reach::secrets_plan(&job.raw, &contexts, outer.clone());
1308 let problem = match &inputs {
1309 Err(why) => Some(why.clone()),
1310 Ok(_) => crate::reach::missing_secrets(&called.raw, &secrets)
1311 .first()
1312 .map(|name| format!("`{file}` needs the secret `{name}`: pass it under `secrets:`, or use `secrets: inherit`."))
1313 .or_else(|| {
1314 crate::reach::undeclared_secrets(&called.raw, &secrets)
1315 .first()
1316 .map(|name| format!("Invalid secret: `{name}` is not defined in `{file}`."))
1317 }),
1318 };
1319 // Its own concurrency group, which it holds while its workflow runs.
1320 let group = job
1321 .concurrency
1322 .as_ref()
1323 .and_then(|c| expr::interpolate(&c.group, &scope).ok())
1324 .map(|group| group.trim().to_owned())
1325 .filter(|group| !group.is_empty());
1326 let cancel = job
1327 .concurrency
1328 .as_ref()
1329 .and_then(|c| expr::interpolate_value(&c.cancel_in_progress, &scope).ok())
1330 .is_some_and(|value| expr::truthy(&value));
1331 if problem.is_none()
1332 && let Some(group) = &group
1333 && !groups.iter().any(|(known, _)| known == group)
1334 {
1335 groups.push((group.clone(), cancel));
1336 }
1337 let call = json!({
1338 "role": "caller", "path": file, "source": source, "origin": origin, "depth": depth,
1339 "prefix": call_prefix(&row.key, job.matrix.is_some().then_some(index)), "title": name,
1340 "inputs": inputs.unwrap_or_default(), "secrets": secrets, "fail_fast": job.fail_fast,
1341 });
1342 let (status, conclusion, finished) = match &problem {
1343 Some(_) => ("completed", Some("failure"), Some(now())),
1344 None => ("waiting", None, None),
1345 };
1346 let values: Vec<worker::wasm_bindgen::JsValue> = vec![
1347 name.as_str().into(),
1348 serde_json::to_string(combination)?.into(),
1349 status.into(),
1350 optional(conclusion),
1351 optional(problem.as_deref()),
1352 job.max_parallel.map(|max| max.max(1)).map_or(worker::wasm_bindgen::JsValue::NULL, Into::into),
1353 optional(finished.as_deref()),
1354 optional(group.as_deref()),
1355 u32::from(cancel).into(),
1356 serde_json::to_string(&call)?.into(),
1357 ];
1358 if index == 0 {
1359 let mut bound = values;
1360 bound.push(row.id.as_str().into());
1361 statements.push(
1362 self.db
1363 .prepare(
1364 "UPDATE jobs SET name = ?, matrix = ?, status = ?, conclusion = ?, reason = ?, max_parallel = ?, finished_at = ?,
1365 concurrency_group = ?, cancel_in_progress = ?, call = ? WHERE id = ?",
1366 )
1367 .bind(&bound)?,
1368 );
1369 } else {
1370 let mut bound: Vec<worker::wasm_bindgen::JsValue> = vec![
1371 new_id("job", now_ms()).into(),
1372 row.run_id.as_str().into(),
1373 row.repo_id.as_str().into(),
1374 row.namespace.as_str().into(),
1375 row.key.as_str().into(),
1376 (index as u32).into(),
1377 row.needs.as_str().into(),
1378 ];
1379 bound.extend(values);
1380 statements.push(
1381 self.db
1382 .prepare(
1383 "INSERT INTO jobs (id, run_id, repo_id, namespace, key, ordinal, needs, name, matrix, status, conclusion, reason,
1384 max_parallel, finished_at, concurrency_group, cancel_in_progress, call)
1385 VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
1386 )
1387 .bind(&bound)?,
1388 );
1389 }
1390 }
1391 self.db.batch(statements).await?;
1392 self.replace_in_groups(run, &row.key, &groups).await
1393 }
1394
1395 /// Whether another job of `row`'s concurrency group runs, or calls a
1396 /// workflow, so that `row` waits for it.
1397 async fn group_busy(&self, row: &JobRow) -> Result<bool> {
1398 let Some(group) = &row.concurrency_group else { return Ok(false) };
1399 let busy = self
1400 .db
1401 .prepare("SELECT COUNT(*) AS n FROM jobs WHERE repo_id = ? AND concurrency_group = ? AND status IN ('in_progress', 'calling') AND id != ?")
1402 .bind(&[row.repo_id.as_str().into(), group.as_str().into(), row.id.as_str().into()])?
1403 .first::<Count>(None)
1404 .await?
1405 .map_or(0, |count| count.n);
1406 Ok(busy > 0)
1407 }
1408
1409 /// A call that waited (`holds_call`) is made: the called workflow's
1410 /// jobs join the run under it, named under its name and keyed under its
1411 /// prefix. False when it no longer waits.
1412 async fn start_call(&self, row: &JobRow) -> Result<bool> {
1413 let Some(call) = row.call() else { return Ok(false) };
1414 let Some(prefix) = row.call_prefix() else { return Ok(false) };
1415 let Some(called) = call["source"].as_str().and_then(|source| workflow::parse(source).ok()) else { return Ok(false) };
1416 let file = call["path"].as_str().unwrap_or_default();
1417 let started = self
1418 .db
1419 .prepare("UPDATE jobs SET status = 'calling', reason = ?, started_at = ? WHERE id = ? AND status = 'waiting' RETURNING id")
1420 .bind(&[format!("Calls `{file}`.").into(), now().into(), row.id.as_str().into()])?
1421 .first::<Value>(None)
1422 .await?;
1423 if started.is_none() {
1424 return Ok(false);
1425 }
1426 let mut statements = Vec::new();
1427 for called_job in &called.jobs {
1428 let needs: Vec<String> = called_job.needs.iter().map(|n| format!("{prefix}/{n}")).collect();
1429 let callee = json!({
1430 "role": "callee", "parent": prefix, "title": row.name, "job": called_job.id, "path": file,
1431 "source": call["source"], "inputs": call["inputs"], "depth": call["depth"], "origin": call["origin"], "secrets": call["secrets"],
1432 });
1433 statements.push(
1434 self.db
1435 .prepare("INSERT INTO jobs (id, run_id, repo_id, namespace, key, name, needs, status, call) VALUES (?, ?, ?, ?, ?, ?, ?, 'waiting', ?)")
1436 .bind(&[
1437 new_id("job", now_ms()).into(),
1438 row.run_id.as_str().into(),
1439 row.repo_id.as_str().into(),
1440 row.namespace.as_str().into(),
1441 format!("{prefix}/{}", called_job.id).into(),
1442 format!("{} / {}", row.name, called_job.name.clone().unwrap_or(called_job.id.clone())).into(),
1443 serde_json::to_string(&needs)?.into(),
1444 serde_json::to_string(&callee)?.into(),
1445 ])?,
1446 );
1447 }
1448 if !statements.is_empty() {
1449 self.db.batch(statements).await?;
1450 }
1451 Ok(true)
1452 }
1453
1454 /// The runs with a call waiting in `group`, but `run_id`, moved along
1455 /// now that a job of the group has finished.
1456 async fn wake_group(&self, repo_id: &str, group: &str, run_id: &str) -> Result<()> {
1457 #[derive(Deserialize)]
1458 struct RunId {
1459 run_id: String,
1460 }
1461 let waiting = self
1462 .db
1463 .prepare("SELECT DISTINCT run_id FROM jobs WHERE repo_id = ? AND concurrency_group = ? AND status = 'waiting' AND run_id != ?")
1464 .bind(&[repo_id.into(), group.into(), run_id.into()])?
1465 .all()
1466 .await?
1467 .results::<RunId>()?;
1468 for other in waiting {
1469 Box::pin(self.advance(&other.run_id)).await?;
1470 }
1471 Ok(())
1472 }
1473
1474 /// A job that called a workflow, finished with its jobs: their result,
1475 /// and the outputs the workflow declares. A failed call of a fail-fast
1476 /// matrix stops the matrix's other calls.
1477 async fn finish_call(&self, run: &RunRow, row: &JobRow, children: &[&JobRow]) -> Result<()> {
1478 let call = row.call().unwrap_or_default();
1479 let called = call["source"].as_str().and_then(|s| workflow::parse(s).ok());
1480 let mut jobs_context = Map::new();
1481 let mut by_key: std::collections::BTreeMap<String, Vec<&JobRow>> = std::collections::BTreeMap::new();
1482 for child in children {
1483 by_key.entry(child.key.clone()).or_default().push(child);
1484 }
1485 for (key, rows) in &by_key {
1486 let mut outputs = Map::new();
1487 for child in rows {
1488 if let Ok(Value::Object(more)) = serde_json::from_str::<Value>(&child.outputs) {
1489 outputs.extend(more);
1490 }
1491 }
1492 let id = key.rsplit('/').next().unwrap_or(key);
1493 jobs_context.insert(id.to_owned(), json!({ "result": key_result(rows), "outputs": outputs }));
1494 }
1495 let inputs = children.first().and_then(|c| c.call()).map(|c| c["inputs"].clone()).unwrap_or(json!({}));
1496 let mut contexts = Map::new();
1497 contexts.insert("jobs".into(), Value::Object(jobs_context));
1498 contexts.insert("inputs".into(), inputs);
1499 let scope = Scope { contexts: &contexts, status: Status::Success, hash_files: None };
1500 let mut outputs = Map::new();
1501 if let Some(Value::Object(declared)) = called.as_ref().map(|w| {
1502 let on = w.raw.get("on").or_else(|| w.raw.get("true")).cloned().unwrap_or(Value::Null);
1503 on.get("workflow_call").and_then(|c| c.get("outputs")).cloned().unwrap_or(Value::Null)
1504 }) {
1505 for (name, spec) in declared {
1506 if let Some(value) = spec.get("value") {
1507 let value = expr::interpolate_value(value, &scope).unwrap_or(Value::Null);
1508 outputs.insert(name, Value::String(expr::to_text(&value)));
1509 }
1510 }
1511 }
1512 let conclusion = key_result(children);
1513 let finished = self
1514 .db
1515 .prepare("UPDATE jobs SET status = 'completed', conclusion = ?, outputs = ?, finished_at = ? WHERE id = ? AND status = 'calling' RETURNING id")
1516 .bind(&[conclusion.into(), serde_json::to_string(&outputs)?.into(), now().into(), row.id.as_str().into()])?
1517 .first::<Value>(None)
1518 .await?;
1519 if finished.is_none() {
1520 return Ok(());
1521 }
1522 if conclusion == "failure" && row.matrix.as_deref().is_some_and(|m| m != "{}") && call["fail_fast"] != json!(false) {
1523 let siblings = self
1524 .db
1525 .prepare("SELECT * FROM jobs WHERE run_id = ? AND key = ? AND status != 'completed'")
1526 .bind(&[row.run_id.as_str().into(), row.key.as_str().into()])?
1527 .all()
1528 .await?
1529 .results::<JobRow>()?;
1530 for sibling in siblings {
1531 self.stop_job(&sibling, "Another job of its matrix failed, and the matrix is fail-fast.").await?;
1532 }
1533 }
1534 if let Some(group) = &row.concurrency_group {
1535 self.wake_group(&run.repo_id, group, &run.id).await?;
1536 }
1537 Ok(())
1538 }
1539
1540 /// A file's text at a commit, if it is there.
1541 pub(crate) async fn read_file(&self, path: &RepoPath, ws: &g1t_contracts::User, sha: &str, file: &str) -> Result<Option<String>> {
1542 let blob: Outcome<g1t_contracts::repos::BlobView> = g1t_kit::call(
1543 &self.repos,
1544 "blob",
1545 &g1t_contracts::repos::BlobArgs {
1546 path: path.clone(),
1547 viewer: Some(ws.clone()),
1548 git_ref: sha.to_owned(),
1549 file_path: file.to_owned(),
1550 },
1551 )
1552 .await?;
1553 Ok(match blob {
1554 Outcome::Ok(view) => view.text,
1555 Outcome::Fail(_) => None,
1556 })
1557 }
1558
1559 async fn skip_job(&self, row: &JobRow, reason: Option<&str>) -> Result<()> {
1560 self.db
1561 .prepare("UPDATE jobs SET status = 'completed', conclusion = 'skipped', reason = ?, finished_at = ? WHERE id = ?")
1562 .bind(&[optional(reason), now().into(), row.id.as_str().into()])?
1563 .run()
1564 .await?;
1565 Ok(())
1566 }
1567
1568 async fn fail_job(&self, row: &JobRow, reason: &str) -> Result<()> {
1569 self.db
1570 .prepare("UPDATE jobs SET status = 'completed', conclusion = 'failure', reason = ?, finished_at = ? WHERE id = ? AND status != 'completed'")
1571 .bind(&[reason.into(), now().into(), row.id.as_str().into()])?
1572 .run()
1573 .await?;
1574 Ok(())
1575 }
1576
1577 /// Starts queued jobs, oldest first, while their workspace has room.
1578 pub async fn start_queued(&self) -> Result<()> {
1579 let queued = self
1580 .db
1581 // Self-hosted jobs are taken by their runners (runners.rs).
1582 .prepare("SELECT * FROM jobs WHERE status = 'queued' AND labels IS NULL ORDER BY rowid LIMIT 50")
1583 .all()
1584 .await?
1585 .results::<JobRow>()?;
1586 let mut running: std::collections::HashMap<String, u32> = std::collections::HashMap::new();
1587 for job in queued {
1588 let in_workspace = match running.get(&job.namespace) {
1589 Some(n) => *n,
1590 None => {
1591 let n = self
1592 .db
1593 // Only g1t's own sandboxes count against the workspace's room.
1594 .prepare("SELECT COUNT(*) AS n FROM jobs WHERE status = 'in_progress' AND namespace = ? AND runner_id IS NULL")
1595 .bind(&[job.namespace.as_str().into()])?
1596 .first::<Count>(None)
1597 .await?
1598 .map_or(0, |count| count.n);
1599 running.insert(job.namespace.clone(), n);
1600 n
1601 }
1602 };
1603 if in_workspace >= RUNNING_PER_WORKSPACE {
1604 continue;
1605 }
1606 if let Some(max) = job.max_parallel {
1607 let siblings = self
1608 .db
1609 .prepare("SELECT COUNT(*) AS n FROM jobs WHERE run_id = ? AND key = ? AND status = 'in_progress'")
1610 .bind(&[job.run_id.as_str().into(), job.key.as_str().into()])?
1611 .first::<Count>(None)
1612 .await?
1613 .map_or(0, |count| count.n);
1614 if siblings >= max {
1615 continue;
1616 }
1617 }
1618 // One job of a concurrency group runs at a time.
1619 if let Some(group) = &job.concurrency_group {
1620 let running = self
1621 .db
1622 .prepare("SELECT COUNT(*) AS n FROM jobs WHERE repo_id = ? AND concurrency_group = ? AND status IN ('in_progress', 'calling') AND id != ?")
1623 .bind(&[job.repo_id.as_str().into(), group.as_str().into(), job.id.as_str().into()])?
1624 .first::<Count>(None)
1625 .await?
1626 .map_or(0, |count| count.n);
1627 if running > 0 {
1628 continue;
1629 }
1630 }
1631 let token = random_hex(24);
1632 let at = now();
1633 let claimed = self
1634 .db
1635 .prepare(
1636 "UPDATE jobs SET status = 'in_progress', token_hash = ?, first_token_hash = NULL, started_at = ?, seen_at = ? WHERE id = ? AND status = 'queued' RETURNING id",
1637 )
1638 .bind(&[sha256_hex(&token).into(), at.as_str().into(), at.as_str().into(), job.id.as_str().into()])?
1639 .first::<Value>(None)
1640 .await?;
1641 if claimed.is_none() {
1642 continue;
1643 }
1644 running.insert(job.namespace.clone(), in_workspace + 1);
1645 self.db
1646 .prepare("UPDATE runs SET status = 'in_progress', started_at = COALESCE(started_at, ?) WHERE id = ? AND status = 'queued'")
1647 .bind(&[at.as_str().into(), job.run_id.as_str().into()])?
1648 .run()
1649 .await?;
1650 let run = self.run_row(&job.run_id).await?;
1651 let repo: RepoPath = run.as_ref().map(|run| repo_path(&run.repo)).unwrap_or(RepoPath {
1652 namespace: job.namespace.clone(),
1653 name: String::new(),
1654 });
1655 // The machine it asked for, for the runner.
1656 let instance = run.as_ref().and_then(|run| start_instance(run, &job));
1657 let trusted = run.as_ref().is_some_and(|run| run.trusted != 0);
1658 // Only a trusted run's jobs get secrets, brokered ones included.
1659 let brokered = trusted && self.may_broker(&job.repo_id, &job.namespace).await?;
1660 let started: Outcome<Value> = g1t_kit::call(
1661 &self.runner,
1662 "start_actions_job",
1663 &StartJobArgs {
1664 job: job.id.clone(),
1665 token,
1666 repo,
1667 timeout_minutes: job.timeout_minutes,
1668 instance,
1669 brokered,
1670 },
1671 )
1672 .await
1673 .unwrap_or_else(|error| fail(FailureCode::Conflict, format!("The runner could not be reached: {error}")));
1674 if let Outcome::Fail(refused) = started {
1675 // Billing would not pay for a scheduled run's job: the
1676 // schedule waits rather than making runs only to refuse them.
1677 if refused.code == FailureCode::PaymentRequired
1678 && let Some(run) = run.as_ref().filter(|run| run.event == "schedule")
1679 {
1680 self.db
1681 .prepare("UPDATE workflows SET schedule_refused_until = ? WHERE id = ?")
1682 .bind(&[rfc3339(now_ms() + crate::SCHEDULE_REFUSED_MS).into(), run.workflow_id.as_str().into()])?
1683 .run()
1684 .await?;
1685 }
1686 Box::pin(self.finish_job(&job.id, "failure", Some(&refused.message), None)).await?;
1687 } else {
1688 self.job_started(&job.id).await?;
1689 }
1690 }
1691 Ok(())
1692 }
1693
1694 /// Finishes a job and moves its run along.
1695 pub async fn finish_job(&self, job_id: &str, conclusion: &str, reason: Option<&str>, outputs: Option<&Map<String, Value>>) -> Result<()> {
1696 let finished = self
1697 .db
1698 .prepare(
1699 "UPDATE jobs SET status = 'completed', conclusion = ?, reason = COALESCE(?, reason), outputs = COALESCE(?, outputs),
1700 finished_at = ?, token_hash = NULL, first_token_hash = NULL WHERE id = ? AND status != 'completed' RETURNING *",
1701 )
1702 .bind(&[
1703 conclusion.into(),
1704 optional(reason),
1705 outputs.map(|o| serde_json::to_string(o).unwrap_or_default()).as_deref().map_or(worker::wasm_bindgen::JsValue::NULL, Into::into),
1706 now().into(),
1707 job_id.into(),
1708 ])?
1709 .first::<JobRow>(None)
1710 .await?;
1711 let Some(job) = finished else { return Ok(()) };
1712 self.tell_live(&job.repo_id, &job.run_id, None, None).await;
1713 // Its G1T_TOKEN stops working with it.
1714 self.revoke_job_tokens(&job.id).await;
1715 // A g1t.page build it opened and did not finish fails now, not at
1716 // the deployments sweep. Only a job that ran can have opened one.
1717 if job.started_at.is_some() {
1718 self.end_job_builds(&job.id, conclusion).await;
1719 }
1720 // A job that deploys failed: so did its run's deployment, now.
1721 if conclusion == "failure" && job.continue_on_error == 0 && job.started_at.is_some()
1722 && let Some(run) = self.run_row(&job.run_id).await?
1723 && let Some(env) = deploys_to(&run, &job)
1724 {
1725 self.report_deployment(&run, &env, "failure", false).await;
1726 }
1727 // A self-hosted runner's job: the runner is free again, and its time
1728 // is recorded, at nothing.
1729 if job.runner_id.is_some() {
1730 self.released(&job).await?;
1731 }
1732 // Steps still marked as going are not going any more.
1733 let mut steps: Vec<Value> = serde_json::from_str(&job.steps).unwrap_or_default();
1734 let mut touched = false;
1735 for step in steps.iter_mut() {
1736 if step["status"] != "completed" {
1737 let was_running = step["status"] == "in_progress";
1738 step["status"] = json!("completed");
1739 step["conclusion"] = json!(if was_running { conclusion } else { "skipped" });
1740 touched = true;
1741 }
1742 }
1743 if touched {
1744 self.db
1745 .prepare("UPDATE jobs SET steps = ? WHERE id = ?")
1746 .bind(&[serde_json::to_string(&steps)?.into(), job.id.as_str().into()])?
1747 .run()
1748 .await?;
1749 }
1750 // fail-fast: one failed combination stops the rest of its matrix.
1751 if conclusion == "failure" && job.continue_on_error == 0 && job.matrix.as_deref().is_some_and(|m| m != "{}") {
1752 let run = self.run_row(&job.run_id).await?;
1753 // As its workflow, or the workflow it is a job of, says.
1754 let fail_fast = run.as_ref().and_then(|run| job_spec(run, &job)).is_none_or(|j| j.fail_fast);
1755 if fail_fast {
1756 let siblings = self
1757 .db
1758 .prepare("SELECT * FROM jobs WHERE run_id = ? AND key = ? AND status != 'completed'")
1759 .bind(&[job.run_id.as_str().into(), job.key.as_str().into()])?
1760 .all()
1761 .await?
1762 .results::<JobRow>()?;
1763 for sibling in siblings {
1764 self.stop_job(&sibling, "Another job of its matrix failed, and the matrix is fail-fast.").await?;
1765 }
1766 }
1767 }
1768 // A call waiting in its concurrency group, in another run, may start.
1769 if let Some(group) = &job.concurrency_group {
1770 self.wake_group(&job.repo_id, group, &job.run_id).await?;
1771 }
1772 Box::pin(self.advance(&job.run_id)).await
1773 }
1774
1775 /// Cancels a job. One that is running is told to stop (the answer to
1776 /// its next report), and runs its `if: always()` and `cancelled()`
1777 /// steps and its post steps before it ends `cancelled`; one that has
1778 /// not started is cancelled at once.
1779 async fn stop_job(&self, job: &JobRow, reason: &str) -> Result<()> {
1780 // A job calling a workflow stops with that workflow's jobs.
1781 if job.status == "calling"
1782 && let Some(prefix) = job.call_prefix()
1783 {
1784 let under = format!("{prefix}/");
1785 for child in self.job_rows(&job.run_id).await?.iter().filter(|child| child.key.starts_with(&under) && child.status != "completed") {
1786 Box::pin(self.stop_job(child, reason)).await?;
1787 }
1788 }
1789 if job.status == "in_progress" && job.started_at.is_some() {
1790 self.db
1791 .prepare("UPDATE jobs SET cancel_requested_at = COALESCE(cancel_requested_at, ?), reason = ? WHERE id = ? AND status = 'in_progress'")
1792 .bind(&[now().into(), reason.into(), job.id.as_str().into()])?
1793 .run()
1794 .await?;
1795 return Ok(());
1796 }
1797 self.hard_stop(job, reason).await
1798 }
1799
1800 /// Cancels a job outright, stopping its sandbox if it has one.
1801 async fn hard_stop(&self, job: &JobRow, reason: &str) -> Result<()> {
1802 // A self-hosted runner hears it was cancelled on its next poll.
1803 if job.status == "in_progress" && job.runner_id.is_none() {
1804 let _: Result<Value> = g1t_kit::call(&self.runner, "stop_actions_job", &json!({ "job": job.id })).await;
1805 }
1806 let stopped = self
1807 .db
1808 .prepare("UPDATE jobs SET status = 'completed', conclusion = 'cancelled', reason = ?, finished_at = ?, token_hash = NULL, first_token_hash = NULL WHERE id = ? AND status != 'completed' RETURNING *")
1809 .bind(&[reason.into(), now().into(), job.id.as_str().into()])?
1810 .first::<JobRow>(None)
1811 .await?;
1812 if stopped.as_ref().is_some_and(|row| row.started_at.is_some()) {
1813 self.revoke_job_tokens(&job.id).await;
1814 self.end_job_builds(&job.id, "cancelled").await;
1815 }
1816 if let Some(stopped) = stopped.filter(|row| row.runner_id.is_some()) {
1817 self.released(&stopped).await?;
1818 }
1819 Ok(())
1820 }
1821
1822 /// Ends a job's tokens at once. A failure is logged: the token expires
1823 /// on its own soon after the job's time limit.
1824 async fn revoke_job_tokens(&self, job_id: &str) {
1825 let revoked: Result<bool> =
1826 g1t_kit::call(&self.identity, "revoke_job_tokens", &RevokeJobTokensArgs { job_id: job_id.to_owned() }).await;
1827 if let Err(error) = revoked {
1828 worker::console_error!("actions: the tokens of job {job_id} were not revoked: {error}");
1829 }
1830 }
1831
1832 /// Finishes the run when every job has.
1833 async fn finish_if_done(&self, run_id: &str) -> Result<()> {
1834 let Some(run) = self.run_row(run_id).await? else { return Ok(()) };
1835 if matches!(run.status.as_str(), "completed" | "pending" | "action_required") {
1836 return Ok(());
1837 }
1838 let jobs = self.job_rows(run_id).await?;
1839 if !jobs.iter().all(|job| job.status == "completed") {
1840 return Ok(());
1841 }
1842 self.finish_run(&run, None).await
1843 }
1844
1845 async fn finish_run(&self, run: &RunRow, error: Option<&str>) -> Result<()> {
1846 let jobs = self.job_rows(&run.id).await?;
1847 let rows: Vec<&JobRow> = jobs.iter().collect();
1848 let conclusion = if error.is_some() {
1849 "failure"
1850 } else if run.conclusion.as_deref() == Some("cancelled") {
1851 "cancelled"
1852 } else if rows.is_empty() {
1853 "skipped"
1854 } else {
1855 key_result(&rows)
1856 };
1857 let done = self
1858 .db
1859 .prepare("UPDATE runs SET status = 'completed', conclusion = ?, error = COALESCE(?, error), finished_at = ? WHERE id = ? AND status != 'completed' RETURNING id")
1860 .bind(&[conclusion.into(), optional(error), now().into(), run.id.as_str().into()])?
1861 .first::<Value>(None)
1862 .await?;
1863 if done.is_none() {
1864 return Ok(());
1865 }
1866 self.report_status(run, conclusion).await?;
1867 self.settle_deployments(run, &jobs, conclusion == "cancelled").await;
1868 let published: Result<()> = g1t_kit::call(
1869 &self.events,
1870 "publish",
1871 &g1t_contracts::events::Publish {
1872 events: vec![g1t_contracts::events::NewEvent {
1873 kind: "workflow.completed",
1874 source: "actions",
1875 repo_id: Some(run.repo_id.clone()),
1876 actor: run.actor_id.clone(),
1877 data: g1t_contracts::events::WorkflowEvent {
1878 run_id: run.id.clone(),
1879 repo_id: run.repo_id.clone(),
1880 workflow: run.name.clone(),
1881 path: run.path.clone(),
1882 number: run.number,
1883 event: run.event.clone(),
1884 conclusion: conclusion.to_owned(),
1885 git_ref: run.git_ref.clone(),
1886 sha: run.sha.clone(),
1887 pull: run.pull,
1888 },
1889 }],
1890 },
1891 )
1892 .await;
1893 if let Err(error) = published {
1894 worker::console_error!("actions: could not publish workflow.completed: {error}");
1895 }
1896 // The next run waiting in its concurrency group.
1897 if let Some(group) = &run.concurrency_group {
1898 let next = self
1899 .db
1900 .prepare("SELECT * FROM runs WHERE repo_id = ? AND concurrency_group = ? AND status = 'pending' ORDER BY id LIMIT 1")
1901 .bind(&[run.repo_id.as_str().into(), group.as_str().into()])?
1902 .first::<RunRow>(None)
1903 .await?;
1904 if let Some(next) = next {
1905 self.db.prepare("UPDATE runs SET status = 'queued' WHERE id = ?").bind(&[next.id.as_str().into()])?.run().await?;
1906 Box::pin(self.advance(&next.id)).await?;
1907 }
1908 }
1909 Ok(())
1910 }
1911
1912 /// Tells the deployments service that a job ended (`workflow_job_ended`),
1913 /// so a build it opened with `start_from_workflow` and left open fails
1914 /// at once. Never fails the job: an answer that does not come is
1915 /// logged, and the sweep fails the build later.
1916 async fn end_job_builds(&self, job_id: &str, conclusion: &str) {
1917 let ended: Result<Value> =
1918 g1t_kit::call(&self.deployments, "workflow_job_ended", &json!({ "jobId": job_id, "conclusion": conclusion })).await;
1919 if let Err(error) = ended {
1920 worker::console_log!("actions: could not tell deployments that job {job_id} ended: {error}");
1921 }
1922 }
1923
1924 /// Tells the deployments service how a run's deployment to `env` stands:
1925 /// made when its first job naming the environment starts, failed when one
1926 /// of them fails, and settled (`last`) when the run finishes. Never fails
1927 /// the run: a deployment that could not be recorded is logged.
1928 async fn report_deployment(&self, run: &RunRow, env: &JobEnvironment, state: &str, last: bool) {
1929 let path = repo_path(&run.repo);
1930 let reported: Result<Value> = g1t_kit::call(
1931 &self.deployments,
1932 "actions_deployment",
1933 &json!({
1934 "repoId": run.repo_id,
1935 "repo": { "namespace": path.namespace, "name": path.name },
1936 "runId": run.id,
1937 "attempt": run.attempt,
1938 "runUrl": format!("{SITE}/{}/actions/runs/{}", run.repo, run.id),
1939 "environment": env.name,
1940 "url": env.url,
1941 "ref": run.git_ref,
1942 "sha": run.sha,
1943 "state": state,
1944 "final": last,
1945 "creator": run.actor,
1946 "workflow": run.name,
1947 }),
1948 )
1949 .await;
1950 if let Err(error) = reported {
1951 worker::console_error!("actions: deployment to {} not recorded for run {}: {error}", env.name, run.id);
1952 }
1953 }
1954
1955 /// A job that deploys has started: its run's deployment to the
1956 /// environment is under way.
1957 pub(crate) async fn job_started(&self, job_id: &str) -> Result<()> {
1958 let Some(job) = self.db.prepare("SELECT * FROM jobs WHERE id = ?").bind(&[job_id.into()])?.first::<JobRow>(None).await? else {
1959 return Ok(());
1960 };
1961 let Some(run) = self.run_row(&job.run_id).await? else { return Ok(()) };
1962 self.tell_live(&run.repo_id, &run.id, Some(&run.sha), run.pull).await;
1963 if let Some(env) = deploys_to(&run, &job) {
1964 self.report_deployment(&run, &env, "in_progress", false).await;
1965 }
1966 Ok(())
1967 }
1968
1969 /// Pages open on the repository hear that a run's job started or
1970 /// finished, which is no event (`g1t_contracts::live`). Logged and left
1971 /// when notify cannot be reached: the pages catch up by themselves.
1972 pub(crate) async fn tell_live(&self, repo_id: &str, run_id: &str, sha: Option<&str>, pull: Option<u32>) {
1973 let Some(notify) = &self.notify else { return };
1974 let change = g1t_contracts::live::RepoChange {
1975 repo_id: repo_id.to_owned(),
1976 kind: g1t_contracts::live::RUN_UPDATED.to_owned(),
1977 run: Some(run_id.to_owned()),
1978 sha: sha.map(str::to_owned),
1979 number: pull,
1980 at: now(),
1981 ..Default::default()
1982 };
1983 let args = g1t_contracts::live::RepoChangedArgs { changes: vec![change] };
1984 let told: Result<Value> = g1t_kit::call(notify, g1t_contracts::live::REPO_CHANGED, &args).await;
1985 if let Err(error) = told {
1986 worker::console_error!("actions: live pages not told of run {run_id}: {error}");
1987 }
1988 }
1989
1990 /// The run is over: each environment its jobs deployed to takes the
1991 /// outcome of those jobs (`deployment_outcome`).
1992 async fn settle_deployments(&self, run: &RunRow, jobs: &[JobRow], cancelled: bool) {
1993 let mut seen: Vec<(JobEnvironment, Vec<Option<String>>)> = Vec::new();
1994 for job in jobs {
1995 let Some(env) = deploys_to(run, job) else { continue };
1996 let conclusion = if cancelled && job.conclusion.as_deref() != Some("skipped") && job.started_at.is_some() {
1997 Some("cancelled".to_owned())
1998 } else if job.started_at.is_none() {
1999 Some("skipped".to_owned())
2000 } else {
2001 job.conclusion.clone()
2002 };
2003 match seen.iter_mut().find(|(known, _)| known.name.eq_ignore_ascii_case(&env.name)) {
2004 Some((known, conclusions)) => {
2005 if known.url.is_none() {
2006 known.url = env.url.clone();
2007 }
2008 conclusions.push(conclusion);
2009 }
2010 None => seen.push((env, vec![conclusion])),
2011 }
2012 }
2013 for (env, conclusions) in seen {
2014 if let Some(state) = deployment_outcome(&conclusions) {
2015 self.report_deployment(run, &env, state, true).await;
2016 }
2017 }
2018 }
2019
2020 /// Tells the pull request (or commit) how the run went, as a status.
2021 async fn report_status(&self, run: &RunRow, conclusion: &str) -> Result<()> {
2022 let state = match conclusion {
2023 "success" | "skipped" => "success",
2024 "cancelled" => "error",
2025 _ => "failure",
2026 };
2027 let _: Result<Value> = g1t_kit::call(
2028 &self.work,
2029 "set_commit_status",
2030 &json!({
2031 "repoId": run.repo_id,
2032 "sha": run.sha,
2033 "context": format!("{} / {}", run.name, run.event),
2034 "state": state,
2035 "description": format!("{} {}", run.name, match conclusion {
2036 "success" => "passed",
2037 "skipped" => "was skipped",
2038 "cancelled" => "was cancelled",
2039 _ => "failed",
2040 }),
2041 "targetUrl": format!("{SITE}/{}/actions/runs/{}", run.repo, run.id),
2042 "source": "actions",
2043 }),
2044 )
2045 .await;
2046 Ok(())
2047 }
2048
2049 /// Tells the pull request a run has started on its head.
2050 pub async fn report_pending(&self, run: &RunRow) -> Result<()> {
2051 if let Err(error) = self.try_report_pending(run).await {
2052 worker::console_warn!("pending status for run {} not reported: {error}", run.id);
2053 }
2054 Ok(())
2055 }
2056
2057 /// Reports a run as pending on its commit, failing when Work did not
2058 /// store it.
2059 pub async fn try_report_pending(&self, run: &RunRow) -> Result<()> {
2060 let stored: Outcome<bool> = g1t_kit::call(
2061 &self.work,
2062 "set_commit_status",
2063 &json!({
2064 "repoId": run.repo_id,
2065 "sha": run.sha,
2066 "context": format!("{} / {}", run.name, run.event),
2067 "state": "pending",
2068 "description": if run.status == "action_required" {
2069 format!("{} is waiting for approval", run.name)
2070 } else {
2071 format!("{} is running", run.name)
2072 },
2073 "targetUrl": format!("{SITE}/{}/actions/runs/{}", run.repo, run.id),
2074 "source": "actions",
2075 }),
2076 )
2077 .await?;
2078 match stored {
2079 Outcome::Ok(_) => Ok(()),
2080 Outcome::Fail(failure) => Err(worker::Error::RustError(format!("pending status refused: {}", failure.message))),
2081 }
2082 }
2083
2084 /// Cancels a run: its waiting and queued jobs at once, and its running
2085 /// ones gracefully (`stop_job`), or outright when `force`.
2086 pub async fn cancel_run(&self, run: &RunRow, reason: &str, force: bool) -> Result<()> {
2087 self.db
2088 .prepare("UPDATE runs SET conclusion = 'cancelled' WHERE id = ? AND status != 'completed'")
2089 .bind(&[run.id.as_str().into()])?
2090 .run()
2091 .await?;
2092 for job in self.job_rows(&run.id).await?.iter().filter(|job| job.status != "completed") {
2093 if force {
2094 self.hard_stop(job, reason).await?;
2095 } else {
2096 self.stop_job(job, reason).await?;
2097 }
2098 }
2099 if run.status == "pending" || run.status == "action_required" {
2100 self.db.prepare("UPDATE runs SET status = 'queued' WHERE id = ?").bind(&[run.id.as_str().into()])?.run().await?;
2101 }
2102 self.advance(&run.id).await
2103 }
2104
2105 /// Cancels every run of the repository that has not finished, for
2106 /// `repo.deleted` and `repo.archived`.
2107 pub async fn stop_runs(&self, repo_id: &str) -> Result<()> {
2108 let runs = self
2109 .db
2110 .prepare("SELECT * FROM runs WHERE repo_id = ? AND status != 'completed'")
2111 .bind(&[repo_id.into()])?
2112 .all()
2113 .await?
2114 .results::<RunRow>()?;
2115 for run in runs {
2116 self.cancel_run(&run, "The repository was archived or deleted.", true).await?;
2117 }
2118 Ok(())
2119 }
2120
2121 pub async fn cancel(&self, a: RunActionArgs) -> Result<Outcome<WorkflowRun>> {
2122 if let Outcome::Fail(refused) = self.may(&a.actor, &a.repo, Capability::Run).await? {
2123 return Ok(Outcome::Fail(refused));
2124 }
2125 let run = check!(self.run_in(&a.repo, &a.id).await?);
2126 if run.status == "completed" {
2127 return Ok(fail(FailureCode::Conflict, "The run has already finished."));
2128 }
2129 // Cancelling a run that is already cancelling stops its jobs
2130 // outright, without waiting for their cleanup steps.
2131 let force = a.force || run.conclusion.as_deref() == Some("cancelled");
2132 let reason = if force {
2133 format!("{} stopped the run without waiting for its cleanup steps.", a.actor.username)
2134 } else {
2135 format!("{} cancelled the run.", a.actor.username)
2136 };
2137 self.cancel_run(&run, &reason, force).await?;
2138 self.run_summary(&run.id).await
2139 }
2140
2141 /// Runs again, as a new attempt: every job, with `failed_only` those
2142 /// that did not succeed, or with `job` that one; each with the jobs that
2143 /// need them. The attempt that ends is kept, its jobs and their logs and
2144 /// summaries with it (`job_attempts`, `run_attempts`).
2145 pub async fn rerun(&self, a: RunActionArgs) -> Result<Outcome<WorkflowRun>> {
2146 if let Outcome::Fail(refused) = self.may(&a.actor, &a.repo, Capability::Run).await? {
2147 return Ok(Outcome::Fail(refused));
2148 }
2149 // A job alone (`POST …/jobs/{job}/rerun`) names its run.
2150 let run_id = match (&a.job, a.id.is_empty()) {
2151 (Some(job), true) => {
2152 #[derive(Deserialize)]
2153 struct Of {
2154 run_id: String,
2155 }
2156 let of = self.db.prepare("SELECT run_id FROM jobs WHERE id = ?").bind(&[job.as_str().into()])?.first::<Of>(None).await?;
2157 match of {
2158 Some(of) => of.run_id,
2159 None => return Ok(fail(FailureCode::NotFound, "No such job.")),
2160 }
2161 }
2162 _ => a.id.clone(),
2163 };
2164 let run = check!(self.run_in(&a.repo, &run_id).await?);
2165 if run.status != "completed" {
2166 return Ok(fail(FailureCode::Conflict, "The run is still going: cancel it first."));
2167 }
2168 // Nothing starts again on an archived repository.
2169 match self.visible_repo(&a.repo, &Some(a.actor.clone())).await? {
2170 Some(repo) if repo.archived() => {
2171 return Ok(fail(FailureCode::Forbidden, g1t_contracts::repos::archived_message(&repo.namespace, &repo.name)));
2172 }
2173 Some(_) => {}
2174 None => return Ok(fail(FailureCode::NotFound, "There is no such repository.")),
2175 }
2176 if run.error.is_some() {
2177 return Ok(fail(FailureCode::Conflict, "This run never started: fix the workflow file and push again."));
2178 }
2179 let jobs = self.job_rows(&run.id).await?;
2180 let workflow = workflow::parse(&run.source).ok();
2181 let target = match &a.job {
2182 Some(id) => match jobs.iter().find(|job| &job.id == id) {
2183 Some(job) => Some(top_key(&job.key).to_owned()),
2184 None => return Ok(fail(FailureCode::NotFound, "That job is not in the run's latest attempt.")),
2185 },
2186 None => None,
2187 };
2188 let which = match (&target, a.failed_only) {
2189 (Some(key), _) => Rerun::Job(key),
2190 (None, true) => Rerun::Failed,
2191 (None, false) => Rerun::All,
2192 };
2193 let order = workflow.as_ref().map(|w| w.job_order()).unwrap_or_default();
2194 let again = rerun_keys(
2195 &order,
2196 |key| jobs.iter().find(|j| j.key == key).map(JobRow::needs).unwrap_or_default(),
2197 |key| jobs.iter().filter(|j| j.key == key).all(|j| j.conclusion.as_deref() == Some("success")),
2198 which,
2199 );
2200 if again.is_empty() {
2201 return Ok(fail(FailureCode::Conflict, "Every job succeeded: there is nothing to run again."));
2202 }
2203 // The jobs that run again, a called workflow's with the job calling it.
2204 let rerun_ids: Vec<&str> = jobs.iter().filter(|job| again.iter().any(|key| key == top_key(&job.key))).map(|job| job.id.as_str()).collect();
2205 let ids = serde_json::to_string(&rerun_ids)?;
2206 let ended = run.attempt.to_string();
2207 let ended = ended.as_str();
2208 let mut statements = vec![
2209 // The attempt that ends, as it ended.
2210 self.db
2211 .prepare(
2212 "INSERT OR REPLACE INTO run_attempts (run_id, attempt, repo_id, conclusion, actor, debug, started_at, finished_at)
2213 SELECT id, attempt, repo_id, conclusion, COALESCE(triggering_actor, actor), debug, started_at, finished_at FROM runs WHERE id = ?",
2214 )
2215 .bind(&[run.id.as_str().into()])?,
2216 // Earlier attempts that showed a job's logs from where it ran
2217 // then now find them where they move to.
2218 self.db
2219 .prepare("UPDATE job_attempts SET log_id = log_id || '.' || ?1 WHERE run_id = ?2 AND log_id IN (SELECT value FROM json_each(?3))")
2220 .bind(&[ended.into(), run.id.as_str().into(), ids.as_str().into()])?,
2221 // Each of its jobs: one that runs again keeps its logs under
2222 // `{id}.{attempt}`; one left alone is still the live job's.
2223 self.db
2224 .prepare(
2225 "INSERT OR REPLACE INTO job_attempts (id, run_id, repo_id, attempt, job_id, log_id, key, ordinal, name, needs, status, conclusion,
2226 steps, annotations, reason, environment, labels, runner_name, started_at, finished_at)
2227 SELECT id || '.' || ?1, run_id, repo_id, ?1, id,
2228 CASE WHEN id IN (SELECT value FROM json_each(?3)) THEN id || '.' || ?1 ELSE id END,
2229 key, ordinal, name, needs, status, conclusion, steps, annotations, reason, environment, labels, runner_name, started_at, finished_at
2230 FROM jobs WHERE run_id = ?2 ORDER BY rowid",
2231 )
2232 .bind(&[ended.into(), run.id.as_str().into(), ids.as_str().into()])?,
2233 self.db
2234 .prepare("UPDATE logs SET job_id = job_id || '.' || ?1 WHERE job_id IN (SELECT value FROM json_each(?2))")
2235 .bind(&[ended.into(), ids.as_str().into()])?,
2236 self.db
2237 .prepare("UPDATE job_summaries SET job_id = job_id || '.' || ?1 WHERE job_id IN (SELECT value FROM json_each(?2))")
2238 .bind(&[ended.into(), ids.as_str().into()])?,
2239 ];
2240 for key in &again {
2241 statements.push(self.db.prepare("DELETE FROM jobs WHERE run_id = ? AND key = ? AND ordinal > 0").bind(&[run.id.as_str().into(), key.as_str().into()])?);
2242 // The jobs of a workflow it called (each matrix combination's
2243 // under `key[i]/`) are made again when it calls it again.
2244 statements.push(
2245 self.db
2246 .prepare("DELETE FROM jobs WHERE run_id = ? AND (key LIKE ? OR key LIKE ?)")
2247 .bind(&[run.id.as_str().into(), format!("{key}/%").into(), format!("{key}[%").into()])?,
2248 );
2249 statements.push(
2250 self.db
2251 .prepare(
2252 "UPDATE jobs SET status = 'waiting', conclusion = NULL, steps = '[]', annotations = '[]', outputs = '{}', reason = NULL,
2253 matrix = NULL, call = NULL, token_hash = NULL, first_token_hash = NULL, seen_at = NULL, started_at = NULL, finished_at = NULL,
2254 labels = NULL, queued_at = NULL, runner_id = NULL, runner_name = NULL, environment = NULL,
2255 concurrency_group = NULL, cancel_in_progress = 0, cancel_requested_at = NULL WHERE run_id = ? AND key = ?",
2256 )
2257 .bind(&[run.id.as_str().into(), key.as_str().into()])?,
2258 );
2259 }
2260 statements.push(
2261 self.db
2262 .prepare(
2263 "UPDATE runs SET status = 'queued', conclusion = NULL, attempt = attempt + 1, started_at = NULL, finished_at = NULL,
2264 triggering_actor = ?, debug = ? WHERE id = ?",
2265 )
2266 .bind(&[a.actor.username.as_str().into(), u32::from(a.debug).into(), run.id.as_str().into()])?,
2267 );
2268 self.db.batch(statements).await?;
2269 if let Some(run) = self.run_row(&run.id).await? {
2270 self.report_pending(&run).await?;
2271 }
2272 self.advance(&run.id).await?;
2273 // A page left open on the attempt that ended, which asks for nothing
2274 // while its run is over, hears that it is going again: re-run from
2275 // the API, the MCP tool, a pull request or another tab, as well as
2276 // from that page, it offers Cancel run and not the re-runs.
2277 self.tell_live(&run.repo_id, &run.id, Some(&run.sha), run.pull).await;
2278 self.run_summary(&run.id).await
2279 }
2280
2281 pub async fn run_in(&self, repo: &RepoPath, id: &str) -> Result<Outcome<RunRow>> {
2282 let row = self
2283 .db
2284 .prepare("SELECT * FROM runs WHERE id = ? AND lower(repo) = lower(?)")
2285 .bind(&[id.into(), format!("{}/{}", repo.namespace, repo.name).into()])?
2286 .first::<RunRow>(None)
2287 .await?;
2288 Ok(row.map_or_else(|| fail(FailureCode::NotFound, "No such run."), Outcome::Ok))
2289 }
2290
2291 // --- The sandbox's side -----------------------------------------------------
2292
2293 pub(crate) async fn job_for_token(&self, a: &JobCallArgs) -> Result<Outcome<JobRow>> {
2294 self.job_for(a, false).await
2295 }
2296
2297 /// As [`Self::job_for_token`], and also with the token the job started
2298 /// with after its harness swapped it (`job_spec` with `rotate`): for
2299 /// `brokered_secrets` alone, which the runner Worker asks with the
2300 /// token it was given at the start, and which no API route passes on.
2301 pub(crate) async fn job_for_started_token(&self, a: &JobCallArgs) -> Result<Outcome<JobRow>> {
2302 self.job_for(a, true).await
2303 }
2304
2305 async fn job_for(&self, a: &JobCallArgs, started: bool) -> Result<Outcome<JobRow>> {
2306 let job = self.db.prepare("SELECT * FROM jobs WHERE id = ?").bind(&[a.job.as_str().into()])?.first::<JobRow>(None).await?;
2307 Ok(match job {
2308 Some(job) if job.status == "in_progress" && token_opens(job.token_hash.as_deref(), job.first_token_hash.as_deref(), &a.token, started) => Outcome::Ok(job),
2309 _ => fail(FailureCode::Unauthenticated, "That job is not running, or the token is not its."),
2310 })
2311 }
2312
2313 /// `job_auth`: which run and repository a running job's token is for,
2314 /// so the API can keep its artifacts and cache.
2315 pub async fn job_auth(&self, a: JobCallArgs) -> Result<Outcome<Value>> {
2316 let job = check!(self.job_for_token(&a).await?);
2317 Ok(Outcome::Ok(json!({ "run": job.run_id, "repoId": job.repo_id })))
2318 }
2319
2320 /// `job_spec`: everything the sandbox needs to run the job.
2321 pub async fn job_spec(&self, a: JobCallArgs) -> Result<Outcome<Value>> {
2322 let job = check!(self.job_for_token(&a).await?);
2323 // Asked to, the token the harness asked with is spent here: it gets
2324 // a new one with the spec, for everything after, so a copy of the
2325 // first left on the runner's computer (a Windows job's script, a
2326 // container's environment) cannot fetch the secrets again. The new
2327 // token is made now, as the runtime token is signed with its hash,
2328 // and swapped in last, so a spec that could not be made leaves the
2329 // old one working.
2330 let next = a.rotate.then(|| random_hex(24));
2331 let token_hash = match &next {
2332 Some(next) => sha256_hex(next),
2333 None => job.token_hash.clone().unwrap_or_default(),
2334 };
2335 let Some(run) = self.run_row(&job.run_id).await? else {
2336 return Ok(fail(FailureCode::NotFound, "No such run."));
2337 };
2338 let Ok(caller) = workflow::parse(&run.source) else {
2339 return Ok(fail(FailureCode::Invalid, "The workflow no longer reads."));
2340 };
2341 // A called workflow's job runs as that workflow defines it.
2342 let callee = job.callee();
2343 let (workflow, spec, call_inputs) = match callee {
2344 Some((called, spec, call)) => (called, spec, Some(call["inputs"].clone())),
2345 None => match caller.jobs.iter().find(|j| j.id == job.key) {
2346 Some(spec) => (caller.clone(), spec.clone(), None),
2347 None => return Ok(fail(FailureCode::NotFound, "The job is not in the workflow.")),
2348 },
2349 };
2350 let spec = &spec;
2351 let repo = repo_path(&run.repo);
2352 let trusted = run.trusted != 0;
2353 // The job's `environment:`, by name, as read when its needs were done
2354 // (an expression included), once the environment's protection rules
2355 // let it start: entries with a value for it give that value instead
2356 // of their default, as GitHub's environment secrets do.
2357 let environment: Option<String> = job.environment.clone();
2358 // What its token may do: its `permissions:` (a called workflow's
2359 // jobs no more than the job that calls it), else the repository's
2360 // default; read-only for a pull request from outside.
2361 // The repository's default, its workspace's taken in, and whether
2362 // its jobs may open and approve pull requests.
2363 let (default, pull_requests) = self.token_policy(&run.repo_id).await?;
2364 let mut permissions = spec.permissions(&workflow, default);
2365 if let Some(parent) = &job.call().filter(|c| c["role"] == "callee").and_then(|c| c["parent"].as_str().map(str::to_owned)) {
2366 let top = top_key(parent);
2367 if let Some(caller_job) = caller.jobs.iter().find(|j| j.id == top) {
2368 permissions = permissions.capped_by(&caller_job.permissions(&caller, default));
2369 }
2370 }
2371 if !trusted {
2372 permissions = permissions.read_only();
2373 }
2374 // G1T_TOKEN, and GITHUB_TOKEN as its alias: a token of the
2375 // workspace's that reaches this repository only, with the scopes
2376 // its permissions give, until the job ends.
2377 let token = match self.workspace_actor(&repo.namespace).await? {
2378 Some(workspace) => {
2379 let created: CreatedAccessToken = g1t_kit::call(
2380 &self.identity,
2381 "create_job_token",
2382 &CreateJobTokenArgs {
2383 workspace,
2384 repo: repo.clone(),
2385 run_id: run.id.clone(),
2386 job_id: job.id.clone(),
2387 name: format!("G1T_TOKEN for {} run {}", run.repo, run.number),
2388 ttl_seconds: u64::from(job.timeout_minutes) * 60 + 600,
2389 scopes: permissions.scopes().into_iter().map(str::to_owned).collect(),
2390 pull_requests: pull_requests && trusted,
2391 },
2392 )
2393 .await?;
2394 created.token
2395 }
2396 None => String::new(),
2397 };
2398 // A run that is not trusted (a pull request from outside the
2399 // workspace) gets no secrets and an empty token.
2400 let passed = job.call().filter(|c| c["role"] == "callee").and_then(|c| c.get("secrets").cloned());
2401 // Brokered secrets among them (broker.rs), whatever keys they reach
2402 // the job under.
2403 let mut brokers: Vec<Broker> = Vec::new();
2404 let mut secrets = match (trusted, passed) {
2405 (false, _) => Map::new(),
2406 (true, None) => {
2407 let resolved = self.secrets_for(&run.repo_id, &run.repo, environment.as_deref(), true).await?;
2408 brokers.extend(resolved.brokers());
2409 resolved.values
2410 }
2411 // A called workflow's job: what its callers passed it (reach.rs),
2412 // and its own environment's secrets over them.
2413 (true, Some(plan)) => {
2414 let base = self.secrets_for(&run.repo_id, &run.repo, None, true).await?;
2415 brokers.extend(base.brokers());
2416 let base = base.values;
2417 let vars = self.variables_for(&run.repo_id, &run.repo, None, true).await?;
2418 let github = run.info().context(&job.key, "", run.action.as_deref());
2419 let mut passed = crate::reach::resolve_secrets(&plan, &base, &github, &vars);
2420 if let Some(name) = environment.as_deref() {
2421 let own = self.secrets_for(&run.repo_id, &run.repo, Some(name), true).await?;
2422 brokers.extend(own.brokers());
2423 for (key, value) in own.values {
2424 if base.get(&key) != Some(&value) {
2425 passed.insert(key, value);
2426 }
2427 }
2428 }
2429 passed
2430 }
2431 };
2432 // A brokered secret's value never reaches the sandbox: the job gets
2433 // a stand-in, which the runner Worker fills in on its requests to
2434 // the secret's hosts. A self-hosted runner's requests never pass
2435 // the Worker: a harness there that brokers is given each stand-in's
2436 // hosts, and passes its job's requests to them through g1t
2437 // (broker.rs); any other keeps a stand-in that does nothing, and
2438 // the log says so.
2439 let stand_ins = broker::substitute(&mut secrets, &brokers, broker::stand_in);
2440 let relayed = job.runner_id.is_some() && a.broker && !stand_ins.is_empty();
2441 if !stand_ins.is_empty() {
2442 self.keep_stand_ins(&job.id, job.timeout_minutes, &stand_ins).await?;
2443 if job.runner_id.is_some() {
2444 let mut made: Vec<&broker::StandIn> = stand_ins.iter().collect();
2445 made.sort_unstable_by(|a, b| a.broker.name.cmp(&b.broker.name));
2446 let notes: String = made
2447 .iter()
2448 .map(|made| {
2449 let note = if relayed { broker::brokered_note(&made.broker.name, &made.broker.hosts) } else { broker::self_hosted_note(&made.broker.name) };
2450 note + "\n"
2451 })
2452 .collect();
2453 self.note_log(&job.id, 0, &notes).await?;
2454 }
2455 }
2456 secrets.insert("G1T_TOKEN".into(), Value::String(token.clone()));
2457 secrets.insert("GITHUB_TOKEN".into(), Value::String(token.clone()));
2458 // Each secret as it is, a line at a time, base64 and JSON-escaped.
2459 let mut masks: Vec<String> = g1t_actions::mask::all_variants(secrets.values().filter_map(|v| v.as_str()));
2460 let vars = self.variables_for(&run.repo_id, &run.repo, environment.as_deref(), trusted).await?;
2461 // The toolkit's runtime token (runtime.rs), for as long as the job
2462 // may run; the API puts it and the toolkit's addresses in the
2463 // job's variables.
2464 let runtime_token = crate::runtime::runtime_token(
2465 &job.id,
2466 &job.run_id,
2467 &token_hash,
2468 now_ms() / 1000,
2469 u64::from(job.timeout_minutes) * 60 + 600,
2470 );
2471 masks.push(runtime_token.clone());
2472 let retention_days = self.retention_setting(&run.repo_id).await?;
2473
2474 let jobs = self.job_rows(&run.id).await?;
2475 let mut needs = Map::new();
2476 // In a called workflow, its jobs' keys sit under the job that called it.
2477 let parent = job.call().filter(|c| c["role"] == "callee").and_then(|c| c["parent"].as_str().map(str::to_owned));
2478 for need in &spec.needs {
2479 let key = match &parent {
2480 Some(parent) => format!("{parent}/{need}"),
2481 None => need.clone(),
2482 };
2483 let rows: Vec<&JobRow> = jobs.iter().filter(|row| row.key == key).collect();
2484 let mut outputs = Map::new();
2485 for row in &rows {
2486 if let Ok(Value::Object(more)) = serde_json::from_str::<Value>(&row.outputs) {
2487 outputs.extend(more);
2488 }
2489 }
2490 needs.insert(need.clone(), json!({ "result": key_result(&rows), "outputs": outputs }));
2491 }
2492 let siblings = jobs.iter().filter(|row| row.key == job.key).count();
2493 let matrix: Value = job.matrix.as_deref().and_then(|m| serde_json::from_str(m).ok()).unwrap_or(json!({}));
2494 let info = run.info();
2495 let mut github = info.context(&job.key, &token, run.action.as_deref());
2496 github["token"] = json!(token);
2497 github["retention_days"] = json!(retention_days);
2498 // On a self-hosted runner, `runner` and `RUNNER_*` describe that
2499 // machine rather than g1t's sandbox.
2500 let mut variables = info.variables(&job.key);
2501 variables.insert("GITHUB_RETENTION_DAYS".into(), json!(retention_days.to_string()));
2502 let mut runner = match &job.runner_id {
2503 Some(id) => self.runner_context_for(id, &mut variables).await?,
2504 None => runner_context(),
2505 };
2506 // A re-run with debug logging: what GitHub sets for one.
2507 if run.debug != 0 {
2508 debug_logging(&mut variables, &mut runner);
2509 }
2510
2511 // Where to check out: the repository, which holds a pull request's
2512 // test merge commit; a pull request's fork when the run builds its
2513 // head instead (`run.sha` is the head, `info.sha` what is built).
2514 let clone_url = match run.pull {
2515 Some(number) if run.event.starts_with("pull_request") && run.event != "pull_request_target" && info.sha == run.sha => {
2516 let located: Outcome<g1t_contracts::work::PullDetail> = g1t_kit::call(
2517 &self.work,
2518 "get_pull",
2519 &g1t_contracts::work::ViewArgs {
2520 repo: repo.clone(),
2521 number,
2522 viewer: self.workspace_actor(&repo.namespace).await?,
2523 after_seq: 0,
2524 },
2525 )
2526 .await?;
2527 match located {
2528 Outcome::Ok(detail) => match detail.pull.fork {
2529 Some(fork) => format!("{SITE}/{}/{}.git", fork.namespace, fork.name),
2530 None => format!("{SITE}/{}.git", run.repo),
2531 },
2532 Outcome::Fail(_) => format!("{SITE}/{}.git", run.repo),
2533 }
2534 }
2535 _ => format!("{SITE}/{}.git", run.repo),
2536 };
2537
2538 // Only one fetch with a token gets its spec: of two at once, the
2539 // second finds the hash already changed and is refused.
2540 if next.is_some() {
2541 let swapped = self
2542 .db
2543 .prepare(TOKEN_ROTATE)
2544 .bind(&[token_hash.as_str().into(), job.id.as_str().into(), job.token_hash.as_deref().unwrap_or_default().into()])?
2545 .first::<Value>(None)
2546 .await?;
2547 if swapped.is_none() {
2548 return Ok(fail(FailureCode::Unauthenticated, "That job is not running, or the token is not its."));
2549 }
2550 }
2551
2552 let mut spec = json!({
2553 "job": job.id,
2554 "run": run.id,
2555 "key": job.key,
2556 "name": job.name,
2557 "spec": spec.raw,
2558 "workflow": {
2559 "env": workflow.env,
2560 "defaults": workflow.raw.get("defaults").cloned().unwrap_or(Value::Null),
2561 },
2562 "github": github,
2563 "variables": variables,
2564 "event": info.event,
2565 "contexts": {
2566 "vars": vars,
2567 "secrets": secrets,
2568 "inputs": call_inputs.unwrap_or_else(|| Value::Object(run.inputs())),
2569 "matrix": matrix,
2570 "needs": needs,
2571 "strategy": {
2572 "fail-fast": spec.fail_fast,
2573 "job-index": job.ordinal,
2574 "job-total": siblings,
2575 "max-parallel": spec.max_parallel.unwrap_or(siblings as u32),
2576 },
2577 "runner": runner,
2578 },
2579 "checkout": {
2580 "repository": run.repo,
2581 "url": clone_url,
2582 "sha": info.sha,
2583 "ref": run.git_ref,
2584 "token": token,
2585 },
2586 "timeoutMinutes": job.timeout_minutes,
2587 "masks": masks,
2588 // As the job's log lists them at its start.
2589 "permissions": permissions.listed().into_iter().map(|(name, access)| (name.to_owned(), json!(access.as_str()))).collect::<Map<String, Value>>(),
2590 // Whether the job may ask for an OIDC token decides whether it
2591 // is told where to.
2592 "runtime": {
2593 "token": runtime_token,
2594 "idToken": self.oidc_allowed(&run, &job),
2595 },
2596 });
2597 if let Some(next) = next {
2598 spec["nextToken"] = json!(next);
2599 }
2600 if relayed {
2601 spec["brokered"] = broker::spec_entries(&stand_ins);
2602 }
2603 Ok(Outcome::Ok(spec))
2604 }
2605
2606 /// `job_report`: the sandbox telling how the job is going.
2607 pub async fn job_report(&self, a: JobCallArgs) -> Result<Outcome<Value>> {
2608 let job = check!(self.job_for_token(&a).await?);
2609 let report = &a.report;
2610 let at = now();
2611 match report["kind"].as_str().unwrap_or_default() {
2612 "steps" => {
2613 // The list can grow as the job goes (post steps), so steps
2614 // already reported keep where they stand.
2615 let known: Vec<Value> = serde_json::from_str(&job.steps).unwrap_or_default();
2616 let steps: Vec<Value> = report["steps"]
2617 .as_array()
2618 .map(|names| {
2619 names
2620 .iter()
2621 .enumerate()
2622 .map(|(i, name)| match known.get(i) {
2623 Some(step) if step["status"] != "queued" => step.clone(),
2624 _ => json!({ "number": i + 1, "name": expr::to_text(name), "status": "queued", "conclusion": null, "startedAt": null, "finishedAt": null }),
2625 })
2626 .collect()
2627 })
2628 .unwrap_or_default();
2629 self.db
2630 .prepare("UPDATE jobs SET steps = ?, seen_at = ? WHERE id = ?")
2631 .bind(&[serde_json::to_string(&steps)?.into(), at.as_str().into(), job.id.as_str().into()])?
2632 .run()
2633 .await?;
2634 }
2635 "step" => {
2636 let number = report["number"].as_u64().unwrap_or(0) as usize;
2637 let mut steps: Vec<Value> = serde_json::from_str(&job.steps).unwrap_or_default();
2638 if let Some(step) = number.checked_sub(1).and_then(|i| steps.get_mut(i)) {
2639 let status = report["status"].as_str().unwrap_or("in_progress");
2640 step["status"] = json!(status);
2641 if status == "in_progress" {
2642 step["startedAt"] = json!(at);
2643 }
2644 if status == "completed" {
2645 step["finishedAt"] = json!(at);
2646 step["conclusion"] = report["conclusion"].clone();
2647 }
2648 if let Some(name) = report["name"].as_str() {
2649 step["name"] = json!(name);
2650 }
2651 }
2652 self.db
2653 .prepare("UPDATE jobs SET steps = ?, seen_at = ? WHERE id = ?")
2654 .bind(&[serde_json::to_string(&steps)?.into(), at.as_str().into(), job.id.as_str().into()])?
2655 .run()
2656 .await?;
2657 }
2658 // A line from g1t itself, not the job: the runner Worker's note
2659 // that a brokered secret went to a host it is not for. Put
2660 // under the step that is running.
2661 "note" => {
2662 let text = report["text"].as_str().unwrap_or_default().chars().take(1000).collect::<String>();
2663 let steps: Vec<Value> = serde_json::from_str(&job.steps).unwrap_or_default();
2664 let step = steps.iter().rev().find(|step| step["status"] == "in_progress").and_then(|step| step["number"].as_u64()).unwrap_or(0);
2665 if !text.trim().is_empty() {
2666 self.note_log(&job.id, step as u32, &text).await?;
2667 }
2668 }
2669 "log" => {
2670 let mut text = report["text"].as_str().unwrap_or_default().to_owned();
2671 // A brokered secret's value never enters the sandbox, but an
2672 // answer that echoed it whole could carry it in; it is
2673 // masked here, where the value is known.
2674 if job.brokered != 0 {
2675 let values: Vec<String> = self.stand_ins_of(&job.id).await?.into_iter().map(|secret| secret.value).collect();
2676 if !values.is_empty() {
2677 text = g1t_actions::mask::apply(&text, &g1t_actions::mask::all_variants(values.iter().map(String::as_str)));
2678 }
2679 }
2680 if text.len() > MAX_CHUNK_BYTES {
2681 let mut cut = MAX_CHUNK_BYTES;
2682 while !text.is_char_boundary(cut) {
2683 cut -= 1;
2684 }
2685 text.truncate(cut);
2686 }
2687 #[derive(Deserialize)]
2688 struct Size {
2689 n: Option<f64>,
2690 }
2691 let size = self
2692 .db
2693 .prepare("SELECT SUM(LENGTH(text)) AS n FROM logs WHERE job_id = ?")
2694 .bind(&[job.id.as_str().into()])?
2695 .first::<Size>(None)
2696 .await?;
2697 let used = size.and_then(|s| s.n).unwrap_or(0.0) as usize;
2698 if used < MAX_LOG_BYTES {
2699 if used + text.len() >= MAX_LOG_BYTES {
2700 text.push_str("\n… The log reached its limit of 4 MB; the rest is not kept.\n");
2701 }
2702 // The next `seq` is taken in the insert itself, so two
2703 // batches at once (a report sent again while the first
2704 // was still being written) never reach for the same one
2705 // and lose a chunk to the primary key.
2706 self.db
2707 .prepare(LOG_INSERT)
2708 .bind(&[
2709 job.id.as_str().into(),
2710 (report["step"].as_u64().unwrap_or(0) as u32).into(),
2711 text.into(),
2712 report["chunk"].as_u64().map_or(worker::wasm_bindgen::JsValue::NULL, |n| (n as f64).into()),
2713 ])?
2714 .run()
2715 .await?;
2716 }
2717 self.db.prepare("UPDATE jobs SET seen_at = ? WHERE id = ?").bind(&[at.into(), job.id.as_str().into()])?.run().await?;
2718 }
2719 "summary" => {
2720 // `$GITHUB_STEP_SUMMARY`, masked by the runner: added to the
2721 // step's summary, up to 1 MiB a step and 20 steps a job.
2722 let step = report["step"].as_u64().unwrap_or(0) as u32;
2723 let markdown = report["markdown"].as_str().unwrap_or_default();
2724 #[derive(Deserialize)]
2725 struct Held {
2726 steps: u32,
2727 mine: Option<f64>,
2728 }
2729 let held = self
2730 .db
2731 .prepare("SELECT COUNT(*) AS steps, MAX(CASE WHEN step = ? THEN LENGTH(markdown) END) AS mine FROM job_summaries WHERE job_id = ?")
2732 .bind(&[step.into(), job.id.as_str().into()])?
2733 .first::<Held>(None)
2734 .await?;
2735 let (steps, mine) = held.map_or((0, None), |held| (held.steps, held.mine.map(|n| n as usize)));
2736 if summary_fits(steps, mine, markdown.len()) {
2737 self.db
2738 .prepare(
2739 "INSERT INTO job_summaries (job_id, step, markdown) VALUES (?, ?, ?)
2740 ON CONFLICT (job_id, step) DO UPDATE SET markdown = job_summaries.markdown || excluded.markdown",
2741 )
2742 .bind(&[job.id.as_str().into(), step.into(), markdown.into()])?
2743 .run()
2744 .await?;
2745 }
2746 self.db.prepare("UPDATE jobs SET seen_at = ? WHERE id = ?").bind(&[at.into(), job.id.as_str().into()])?.run().await?;
2747 }
2748 "annotation" => {
2749 let mut annotations: Vec<Value> = serde_json::from_str(&job.annotations).unwrap_or_default();
2750 if annotations.len() < MAX_ANNOTATIONS {
2751 annotations.push(json!({
2752 "level": report["level"].as_str().unwrap_or("notice"),
2753 "message": report["message"].as_str().unwrap_or_default().chars().take(4000).collect::<String>(),
2754 "title": report["title"],
2755 "file": report["file"],
2756 "line": report["line"],
2757 }));
2758 self.db
2759 .prepare("UPDATE jobs SET annotations = ?, seen_at = ? WHERE id = ?")
2760 .bind(&[serde_json::to_string(&annotations)?.into(), at.as_str().into(), job.id.as_str().into()])?
2761 .run()
2762 .await?;
2763 }
2764 }
2765 // Nothing to tell; the answer says whether to stop.
2766 "ping" => {
2767 self.db.prepare("UPDATE jobs SET seen_at = ? WHERE id = ?").bind(&[at.into(), job.id.as_str().into()])?.run().await?;
2768 }
2769 "done" => {
2770 // A job told to stop ends cancelled, however its cleanup went.
2771 let conclusion = if job.cancel_requested_at.is_some() {
2772 "cancelled"
2773 } else {
2774 report["conclusion"]
2775 .as_str()
2776 .filter(|c| matches!(*c, "success" | "failure" | "cancelled"))
2777 .unwrap_or("failure")
2778 };
2779 let outputs = report["outputs"].as_object().cloned();
2780 Box::pin(self.finish_job(&job.id, conclusion, report["reason"].as_str(), outputs.as_ref())).await?;
2781 }
2782 other => return Ok(fail(FailureCode::Invalid, format!("There is no report called `{other}`."))),
2783 }
2784 // `cancelled`: the run was cancelled, and the runner should stop
2785 // the step it is on and run only its cleanup steps.
2786 Ok(Outcome::Ok(json!({ "ok": true, "cancelled": job.cancel_requested_at.is_some() })))
2787 }
2788
2789 // --- Every minute ---------------------------------------------------------------
2790
2791 pub async fn on_minute(&self, now_ms: u64) -> Result<()> {
2792 let minute = now_ms / 60_000 * 60_000;
2793 // Repositories a workspace's managed workflows changed in, beyond
2794 // those synced at once (managed.rs): their schedules wait for it.
2795 if let Err(error) = self.catch_up_syncs().await {
2796 worker::console_error!("actions: catching up syncs failed: {error}");
2797 }
2798 // Staff (or billing's usage watcher) paused scheduled runs across
2799 // g1t: this minute's schedules are skipped, not queued for later.
2800 // Kept 30 seconds in the isolate (g1t_kit::pause).
2801 if g1t_kit::pause::paused(&self.billing, g1t_contracts::billing::PauseLevel::Schedules).await {
2802 worker::console_log!("actions: schedules are paused across g1t; skipped this minute's");
2803 } else if let Err(error) = self.run_schedules(minute).await {
2804 worker::console_error!("actions: schedules failed: {error}");
2805 }
2806 // Jobs whose sandbox went quiet or ran past their time.
2807 let running = self.db.prepare("SELECT * FROM jobs WHERE status = 'in_progress'").all().await?.results::<JobRow>()?;
2808 for job in running {
2809 // Times in g1t's format compare as text.
2810 let before = |ms: u64| rfc3339(now_ms.saturating_sub(ms));
2811 let silent = job.seen_at.as_deref().is_some_and(|seen| seen < before(SILENT_MS).as_str());
2812 let limit = (u64::from(job.timeout_minutes) * 60 + 120) * 1000;
2813 let over = job.started_at.as_deref().is_some_and(|started| started < before(limit).as_str());
2814 let cancel_overdue = job.cancel_requested_at.as_deref().is_some_and(|at| at < before(CANCEL_GRACE_MS).as_str());
2815 if cancel_overdue {
2816 // Cancelled, and still going after its grace period.
2817 self.hard_stop(&job, "It was cancelled, and did not finish its cleanup steps within 5 minutes.").await?;
2818 self.advance(&job.run_id).await?;
2819 } else if over {
2820 let reason = format!("It ran longer than its time limit of {} minutes.", job.timeout_minutes);
2821 // A self-hosted runner is told to stop on its next poll.
2822 if job.runner_id.is_none() {
2823 let _: Result<Value> = g1t_kit::call(&self.runner, "stop_actions_job", &json!({ "job": job.id })).await;
2824 }
2825 self.finish_job(&job.id, "failure", Some(&reason), None).await?;
2826 } else if silent {
2827 let reason = match &job.runner_name {
2828 Some(name) => format!("The self-hosted runner {name} stopped answering."),
2829 None => "The runner stopped answering.".to_owned(),
2830 };
2831 self.finish_job(&job.id, "failure", Some(&reason), None).await?;
2832 }
2833 }
2834 // Calls of reusable workflows waiting in a concurrency group, in
2835 // case the job they waited for was cancelled in another run.
2836 #[derive(Deserialize)]
2837 struct RunId {
2838 run_id: String,
2839 }
2840 let held = self
2841 .db
2842 .prepare("SELECT DISTINCT run_id FROM jobs WHERE status = 'waiting' AND concurrency_group IS NOT NULL LIMIT 20")
2843 .all()
2844 .await?
2845 .results::<RunId>()?;
2846 for run in held {
2847 self.advance(&run.run_id).await?;
2848 }
2849 if let Err(error) = self.sweep_runners(now_ms).await {
2850 worker::console_error!("actions: the runners' sweep failed: {error}");
2851 }
2852 // Jobs held at an environment whose wait timer has run out.
2853 if let Err(error) = self.release_gates().await {
2854 worker::console_error!("actions: environments' gates failed: {error}");
2855 }
2856 // Once an hour: the cache's expired entries, and its storage.
2857 if (now_ms / 60_000) % 60 == 7
2858 && let Err(error) = self.sweep_cache(now_ms).await
2859 {
2860 worker::console_error!("actions: the cache's sweep failed: {error}");
2861 }
2862 // And the archives of GitHub's actions no job uses any more.
2863 if (now_ms / 60_000) % 60 == 47
2864 && let Err(error) = self.sweep_action_archives(now_ms).await
2865 {
2866 worker::console_error!("actions: the action archives' sweep failed: {error}");
2867 }
2868 // And artifacts past their time, and the toolkit's abandoned parts.
2869 if (now_ms / 60_000) % 60 == 37 {
2870 if let Err(error) = self.sweep_artifacts(now_ms).await {
2871 worker::console_error!("actions: the artifacts' sweep failed: {error}");
2872 }
2873 if let Err(error) = self.sweep_blob_parts(now_ms).await {
2874 worker::console_error!("actions: the blob parts' sweep failed: {error}");
2875 }
2876 }
2877 // And logs of jobs that finished longer ago than LOG_RETENTION_DAYS.
2878 if (now_ms / 60_000) % 60 == 17
2879 && let Err(error) = self.sweep_logs(now_ms).await
2880 {
2881 worker::console_error!("actions: the logs' sweep failed: {error}");
2882 }
2883 self.start_queued().await
2884 }
2885}
2886
2887
2888#[cfg(test)]
2889mod log_chunks {
2890 use rusqlite::{Connection, params};
2891
2892 use super::LOG_INSERT;
2893
2894 /// The logs table as the migrations leave it.
2895 fn database() -> Connection {
2896 let db = Connection::open_in_memory().unwrap();
2897 for name in ["0001_init.sql", "0016_log_chunks.sql"] {
2898 let path = format!("{}/migrations/{name}", env!("CARGO_MANIFEST_DIR"));
2899 db.execute_batch(&std::fs::read_to_string(path).unwrap()).unwrap();
2900 }
2901 db
2902 }
2903
2904 fn log(db: &Connection, job: &str) -> Vec<(i64, i64, String)> {
2905 let mut rows = db.prepare("SELECT seq, step, text FROM logs WHERE job_id = ? ORDER BY seq").unwrap();
2906 rows.query_map([job], |row| Ok((row.get(0)?, row.get(1)?, row.get(2)?))).unwrap().map(Result::unwrap).collect()
2907 }
2908
2909 #[test]
2910 fn a_batch_sent_again_is_kept_once() {
2911 let db = database();
2912 let insert = |job: &str, step: i64, text: &str, chunk: Option<i64>| db.execute(LOG_INSERT, params![job, step, text, chunk]).unwrap();
2913 assert_eq!(insert("job_1", 0, "one\n", Some(1)), 1);
2914 // The runner did not hear the answer and sent the batch again.
2915 assert_eq!(insert("job_1", 0, "one\n", Some(1)), 0);
2916 assert_eq!(insert("job_1", 1, "two\n", Some(2)), 1);
2917 // Another job numbers its batches from 1 too.
2918 assert_eq!(insert("job_2", 0, "other\n", Some(1)), 1);
2919 // A runner that numbers nothing has every batch kept, as before.
2920 assert_eq!(insert("job_3", 0, "a\n", None), 1);
2921 assert_eq!(insert("job_3", 0, "a\n", None), 1);
2922 assert_eq!(log(&db, "job_1"), [(1, 0, "one\n".into()), (2, 1, "two\n".into())]);
2923 assert_eq!(log(&db, "job_2"), [(1, 0, "other\n".into())]);
2924 assert_eq!(log(&db, "job_3").len(), 2);
2925 // A job run again moves its log aside (`{id}.{attempt}`), and the
2926 // new attempt's runner numbers from 1 again.
2927 db.execute("UPDATE logs SET job_id = job_id || '.1' WHERE job_id = 'job_1'", []).unwrap();
2928 assert_eq!(insert("job_1", 0, "again\n", Some(1)), 1);
2929 assert_eq!(log(&db, "job_1"), [(1, 0, "again\n".into())]);
2930 assert_eq!(log(&db, "job_1.1").len(), 2);
2931 }
2932}
2933
2934#[cfg(test)]
2935mod token_rotation {
2936 use g1t_secrets::sha256_hex;
2937 use rusqlite::{Connection, OptionalExtension, params};
2938
2939 use super::{TOKEN_ROTATE, token_opens};
2940
2941 fn database() -> Connection {
2942 let db = Connection::open_in_memory().unwrap();
2943 for name in ["0001_init.sql", "0020_job_token_rotation.sql"] {
2944 let path = format!("{}/migrations/{name}", env!("CARGO_MANIFEST_DIR"));
2945 db.execute_batch(&std::fs::read_to_string(path).unwrap()).unwrap();
2946 }
2947 db.execute(
2948 "INSERT INTO jobs (id, run_id, repo_id, namespace, key, name, status, token_hash) VALUES ('job_1', 'run_1', 'repo_1', 'acme', 'build', 'build', 'in_progress', ?1)",
2949 [sha256_hex("first")],
2950 )
2951 .unwrap();
2952 db
2953 }
2954
2955 fn rotate(db: &Connection, next: &str, shown: &str) -> bool {
2956 db.query_row(TOKEN_ROTATE, params![sha256_hex(next), "job_1", sha256_hex(shown)], |row| row.get::<_, String>(0))
2957 .optional()
2958 .unwrap()
2959 .is_some()
2960 }
2961
2962 /// The job's current token's hash, and the one it started with.
2963 fn hashes(db: &Connection) -> (Option<String>, Option<String>) {
2964 db.query_row("SELECT token_hash, first_token_hash FROM jobs WHERE id = 'job_1'", [], |row| Ok((row.get(0)?, row.get(1)?))).unwrap()
2965 }
2966
2967 #[test]
2968 fn a_job_token_fetches_its_spec_once() {
2969 let db = database();
2970 assert!(rotate(&db, "second", "first"));
2971 assert_eq!(hashes(&db), (Some(sha256_hex("second")), Some(sha256_hex("first"))));
2972 // The first token, shown again (a copy left on the computer, or a
2973 // second fetch racing the first), swaps nothing and is refused.
2974 assert!(!rotate(&db, "third", "first"));
2975 assert_eq!(hashes(&db).0, Some(sha256_hex("second")));
2976 // A job that ended has no token to swap.
2977 db.execute("UPDATE jobs SET status = 'completed', token_hash = NULL, first_token_hash = NULL", []).unwrap();
2978 assert!(!rotate(&db, "fourth", "second"));
2979 assert_eq!(hashes(&db), (None, None));
2980 }
2981
2982 #[test]
2983 fn the_worker_finds_brokered_secrets_with_the_token_the_job_started_with() {
2984 let db = database();
2985 let opens = |db: &Connection, token: &str, started: bool| {
2986 let (current, first) = hashes(db);
2987 token_opens(current.as_deref(), first.as_deref(), token, started)
2988 };
2989 // Before any swap, the job's one token opens everything.
2990 assert!(opens(&db, "first", false) && opens(&db, "first", true));
2991 assert!(rotate(&db, "second", "first"));
2992 // The harness's new token opens everything.
2993 assert!(opens(&db, "second", false) && opens(&db, "second", true));
2994 // The token it started with, which the runner Worker holds, still
2995 // finds the job's brokered secrets, and opens nothing else.
2996 assert!(opens(&db, "first", true));
2997 assert!(!opens(&db, "first", false));
2998 assert!(!opens(&db, "other", true));
2999 // Another swap keeps the token it started with, not the one between.
3000 assert!(rotate(&db, "third", "second"));
3001 assert!(opens(&db, "first", true));
3002 assert!(!opens(&db, "second", true));
3003 }
3004
3005 #[test]
3006 fn the_runtime_token_is_signed_for_the_token_that_replaces_the_first() {
3007 let now = 1_800_000_000;
3008 let token = crate::runtime::runtime_token("job_1", "run_1", &sha256_hex("second"), now, 600);
3009 assert!(crate::runtime::runtime_valid(&token, "job_1", &sha256_hex("second"), now));
3010 assert!(!crate::runtime::runtime_valid(&token, "job_1", &sha256_hex("first"), now));
3011 }
3012}
3013
3014#[cfg(test)]
3015mod stopping {
3016 use super::stops_runs;
3017 use g1t_contracts::events::Event;
3018 use serde_json::{Value, json};
3019
3020 fn event(kind: &str, data: Value) -> Event {
3021 Event {
3022 id: "evt_1".into(),
3023 kind: kind.into(),
3024 source: "repos".into(),
3025 time: "2026-10-05T00:00:00Z".into(),
3026 repo_id: Some("rep_1".into()),
3027 actor: None,
3028 data,
3029 }
3030 }
3031
3032 #[test]
3033 fn deleting_or_archiving_stops_runs() {
3034 assert_eq!(stops_runs(&event("repo.deleted", json!({ "repoId": "rep_1" }))).as_deref(), Some("rep_1"));
3035 assert_eq!(stops_runs(&event("repo.archived", json!({ "archived": true }))).as_deref(), Some("rep_1"));
3036 assert_eq!(stops_runs(&event("repo.unarchived", json!({ "archived": false }))), None);
3037 assert_eq!(stops_runs(&event("repo.restored", json!({}))), None);
3038 assert_eq!(stops_runs(&event("git.push", json!({}))), None);
3039 }
3040}
3041
3042#[cfg(test)]
3043mod status_of_needs {
3044 use std::collections::HashMap;
3045
3046 use super::ancestor_failed;
3047
3048 /// check -> plan -> (migrate) -> core -> edge, as deploy.yml has them,
3049 /// and a job that needs only the last.
3050 fn graph() -> HashMap<&'static str, Vec<&'static str>> {
3051 HashMap::from([
3052 ("check", vec![]),
3053 ("plan", vec!["check"]),
3054 ("migrate", vec!["plan"]),
3055 ("core", vec!["plan", "migrate"]),
3056 ("edge", vec!["plan", "migrate", "core"]),
3057 ("notify", vec!["edge"]),
3058 ])
3059 }
3060
3061 #[test]
3062 fn a_failure_is_seen_however_far_back() {
3063 let needs = graph();
3064 let failed = |which: &'static str| move |key: &str| key == which;
3065 // check failed; plan, and everything after, was skipped for it.
3066 assert!(ancestor_failed(&needs, "notify", failed("check")));
3067 assert!(ancestor_failed(&needs, "core", failed("check")));
3068 assert!(ancestor_failed(&needs, "edge", failed("core")));
3069 // Nothing before a job failed: a skipped migrate is not a failure.
3070 assert!(!ancestor_failed(&needs, "edge", |_| false));
3071 assert!(!ancestor_failed(&needs, "core", failed("edge")));
3072 assert!(!ancestor_failed(&needs, "check", failed("check")));
3073 }
3074
3075 #[test]
3076 fn cycles_and_unknown_keys_end() {
3077 let needs = HashMap::from([("a", vec!["b"]), ("b", vec!["a"])]);
3078 assert!(!ancestor_failed(&needs, "a", |_| false));
3079 assert!(!ancestor_failed(&needs, "missing", |_| true));
3080 }
3081}
3082
3083#[cfg(test)]
3084mod deployments {
3085 use serde_json::{Map, Value, json};
3086
3087 use super::{JobEnvironment, deployment_outcome, environment_of};
3088
3089 #[test]
3090 fn a_jobs_environment_is_read_for_deployments() {
3091 let contexts: Map<String, Value> = serde_json::from_value(json!({
3092 "github": { "ref_name": "main", "repository": "acme/web" },
3093 "inputs": { "target": "staging" },
3094 "matrix": {},
3095 }))
3096 .unwrap();
3097 let read = |raw: Value| environment_of(&raw, &contexts);
3098 assert_eq!(read(json!({})), None);
3099 assert_eq!(
3100 read(json!({ "environment": "production" })),
3101 Some(JobEnvironment { name: "production".into(), url: None, deploys: true })
3102 );
3103 assert_eq!(
3104 read(json!({ "environment": { "name": "production", "url": "https://g1t.sh" } })),
3105 Some(JobEnvironment { name: "production".into(), url: Some("https://g1t.sh".into()), deploys: true })
3106 );
3107 // Expressions are filled in from the run.
3108 assert_eq!(
3109 read(json!({ "environment": { "name": "${{ inputs.target }}", "url": "https://${{ github.ref_name }}.example.com" } })),
3110 Some(JobEnvironment { name: "staging".into(), url: Some("https://main.example.com".into()), deploys: true })
3111 );
3112 // Secrets only: no deployment.
3113 assert!(!read(json!({ "environment": { "name": "production", "deployment": false } })).unwrap().deploys);
3114 // The same, said in the job's g1t settings.
3115 assert!(!read(json!({ "environment": "production", "g1t": { "deployment": false } })).unwrap().deploys);
3116 assert!(!read(json!({ "environment": { "name": "production" }, "g1t": { "deployment": false } })).unwrap().deploys);
3117 // Only http(s) addresses.
3118 assert_eq!(read(json!({ "environment": { "name": "production", "url": "javascript:alert(1)" } })).unwrap().url, None);
3119 }
3120
3121 #[test]
3122 fn a_runs_outcome_for_an_environment() {
3123 let of = |list: &[&str]| deployment_outcome(&list.iter().map(|c| Some((*c).to_owned())).collect::<Vec<_>>());
3124 assert_eq!(of(&["success", "skipped"]), Some("success"));
3125 assert_eq!(of(&["success", "failure"]), Some("failure"));
3126 assert_eq!(of(&["success", "cancelled"]), Some("error"));
3127 assert_eq!(of(&["skipped"]), None);
3128 assert_eq!(deployment_outcome(&[None]), None);
3129 }
3130}
3131
3132#[cfg(test)]
3133mod reruns {
3134 use serde_json::{Map, Value, json};
3135
3136 use super::{MAX_SUMMARIES, MAX_SUMMARY_BYTES, Rerun, Scope, Status, call_allowed, call_prefix, debug_logging, rerun_keys, shown_name, summary_fits, top_key};
3137
3138 /// build ← test ← deploy, and lint on its own.
3139 fn keys(which: Rerun, failed: &[&str]) -> Vec<String> {
3140 let order = ["build", "lint", "test", "deploy"];
3141 let needs = |key: &str| -> Vec<String> {
3142 match key {
3143 "test" => vec!["build".into()],
3144 "deploy" => vec!["test".into()],
3145 _ => Vec::new(),
3146 }
3147 };
3148 rerun_keys(&order, needs, |key| !failed.contains(&key), which)
3149 }
3150
3151 #[test]
3152 fn a_rerun_takes_the_jobs_it_names_and_those_that_need_them() {
3153 assert_eq!(keys(Rerun::All, &[]), ["build", "lint", "test", "deploy"]);
3154 assert_eq!(keys(Rerun::Failed, &["test"]), ["test", "deploy"]);
3155 assert_eq!(keys(Rerun::Failed, &["lint"]), ["lint"]);
3156 assert!(keys(Rerun::Failed, &[]).is_empty());
3157 // One job, whatever it came to, and what depends on it.
3158 assert_eq!(keys(Rerun::Job("build"), &[]), ["build", "test", "deploy"]);
3159 assert_eq!(keys(Rerun::Job("lint"), &["test"]), ["lint"]);
3160 assert_eq!(keys(Rerun::Job("deploy"), &[]), ["deploy"]);
3161 assert!(keys(Rerun::Job("missing"), &[]).is_empty());
3162 }
3163
3164 #[test]
3165 fn a_called_workflows_jobs_run_again_with_the_job_that_calls_it() {
3166 assert_eq!(top_key("build/test"), "build");
3167 assert_eq!(top_key("build/inner/test"), "build");
3168 assert_eq!(top_key("lint"), "lint");
3169 // A matrix's calls each have their own jobs, under `key[i]/`.
3170 assert_eq!(top_key("build[1]/test"), "build");
3171 assert_eq!(top_key("build/inner[0]/test"), "build");
3172 assert_eq!(call_prefix("build", Some(1)), "build[1]");
3173 assert_eq!(call_prefix("build/inner", None), "build/inner");
3174 }
3175
3176 #[test]
3177 fn a_run_connects_ten_levels_of_workflows_and_fifty_reusable_ones() {
3178 assert!(call_allowed(1, &[], "a.yml").is_ok());
3179 assert!(call_allowed(9, &[], "a.yml").is_ok());
3180 let deep = call_allowed(10, &[], "a.yml").unwrap_err();
3181 assert!(deep.contains("at most ten") && deep.contains("nine levels"), "{deep}");
3182 let names: Vec<String> = (0..50).map(|n| format!("w{n}.yml")).collect();
3183 let fifty: Vec<&str> = names.iter().map(String::as_str).collect();
3184 // A workflow called again, as by each combination of a matrix, is one.
3185 assert!(call_allowed(1, &fifty, "w3.yml").is_ok());
3186 assert!(call_allowed(1, &fifty, "another.yml").unwrap_err().contains("at most 50 different"));
3187 }
3188
3189 #[test]
3190 fn a_matrixs_calls_are_named_by_the_caller_and_its_values() {
3191 let workflow = super::workflow::parse(
3192 "on: push\njobs:\n build:\n name: Build\n strategy:\n matrix: { os: [linux], node: [20] }\n uses: ./.g1t/workflows/b.yml\n plain:\n uses: ./.g1t/workflows/b.yml\n test:\n name: Test ${{ matrix.os }}\n strategy:\n matrix: { os: [linux] }\n runs-on: ubuntu-latest\n steps: [{ run: 'true' }]",
3193 )
3194 .unwrap();
3195 let job = |id: &str| workflow.jobs.iter().find(|job| job.id == id).unwrap();
3196 let combination: Map<String, Value> = serde_json::from_value(json!({ "os": "linux", "node": 20 })).unwrap();
3197 let mut contexts = Map::new();
3198 contexts.insert("matrix".into(), Value::Object(combination.clone()));
3199 let scope = Scope { contexts: &contexts, status: Status::Success, hash_files: None };
3200 assert_eq!(shown_name(job("build"), None, &combination, &scope), "Build (linux, 20)");
3201 assert_eq!(shown_name(job("plain"), None, &Map::new(), &scope), "plain");
3202 // A called workflow's job, under the call that made it.
3203 assert_eq!(shown_name(job("plain"), Some("Build (linux, 20)"), &Map::new(), &scope), "Build (linux, 20) / plain");
3204 assert_eq!(shown_name(job("test"), Some("Build"), &combination, &scope), "Build / Test linux");
3205 }
3206
3207 #[test]
3208 fn a_job_keeps_twenty_steps_summaries_of_a_mebibyte_each() {
3209 assert!(summary_fits(0, None, 10));
3210 assert!(!summary_fits(0, None, 0), "nothing to keep");
3211 assert!(!summary_fits(MAX_SUMMARIES, None, 10), "a twenty-first step's summary is dropped");
3212 assert!(summary_fits(MAX_SUMMARIES, Some(10), 10), "a step that has one may add to it");
3213 assert!(summary_fits(1, Some(MAX_SUMMARY_BYTES - 10), 10));
3214 assert!(!summary_fits(1, Some(MAX_SUMMARY_BYTES - 10), 11));
3215 assert!(!summary_fits(0, None, MAX_SUMMARY_BYTES + 1));
3216 }
3217
3218 #[test]
3219 fn a_debug_rerun_sets_what_github_sets() {
3220 let mut variables = Map::new();
3221 let mut runner = json!({ "name": "g1t", "debug": "" });
3222 debug_logging(&mut variables, &mut runner);
3223 assert_eq!(variables["RUNNER_DEBUG"], "1");
3224 assert_eq!(variables["ACTIONS_STEP_DEBUG"], "true");
3225 assert_eq!(variables["ACTIONS_RUNNER_DEBUG"], "true");
3226 assert_eq!(runner["debug"], Value::String("1".into()));
3227 assert_eq!(runner["name"], "g1t");
3228 }
3229}