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.

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