Skip to content
Sign up

flagon-io/g1t

public
0
1,813 linesCodeBlameRaw
1//! The actions service: GitHub Actions workflows, run on g1t as they are.
2//!
3//! A repository's `.g1t/workflows/*.yml`, in GitHub's format, are read
4//! from the commit an
5//! event is about (the default branch for issues, schedules and manual
6//! runs). Each workflow an event starts becomes a run; each job of the run
7//! (one per matrix combination) runs in a sandbox once the jobs it needs
8//! have finished. Jobs report their steps and logs back as they go, and a
9//! run on a pull request's head is a status on that pull request.
10//!
11//! Secrets and variables belong to a repository or to its workspace; a
12//! repository's override its workspace's of the same name. Secret values
13//! are sealed at rest and never returned.
14//!
15//! Mirrors `packages/contracts/src/actions.ts`.
16
17use serde::{Deserialize, Serialize};
18use serde_json::Value;
19
20use crate::repos::RepoPath;
21use crate::{User, Viewer};
22
23/// A note on something in a workflow that runs differently on g1t.
24#[derive(Clone, Debug, Serialize, Deserialize)]
25#[serde(rename_all = "camelCase")]
26pub struct WorkflowNote {
27 /// `info`, `warning` or `unsupported`.
28 pub severity: String,
29 pub job: Option<String>,
30 pub message: String,
31}
32
33#[derive(Clone, Debug, Serialize, Deserialize)]
34#[serde(rename_all = "camelCase")]
35pub struct Workflow {
36 pub id: String,
37 /// `.g1t/workflows/ci.yml`.
38 pub path: String,
39 pub name: String,
40 /// The events that start it, such as `push` and `pull_request`.
41 pub events: Vec<String>,
42 /// `active`, or `disabled` when a member turned it off.
43 pub state: String,
44 /// Why the file cannot be used, if it cannot.
45 pub error: Option<String>,
46 pub notes: Vec<WorkflowNote>,
47 /// `on.workflow_dispatch.inputs` as written, when it can be run by hand.
48 pub dispatch: Option<Value>,
49 pub last_run: Option<WorkflowRun>,
50 /// For a managed workflow (`managed/<name>.yml`): what installed it.
51 #[serde(default)]
52 pub managed_by: Option<ManagedBy>,
53}
54
55/// What installed a managed workflow in a repository.
56#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
57#[serde(rename_all = "camelCase")]
58pub struct ManagedBy {
59 /// `g1t` for one g1t's services installed (such as a project's deploy
60 /// workflow), or the workspace's name for one its owners added.
61 pub origin: String,
62 /// The workspace's: `required` or `default`. Empty for g1t's.
63 #[serde(default)]
64 pub mode: String,
65 /// The workspace's: the file it was copied from, as
66 /// `owner/repo/path@ref`.
67 #[serde(default)]
68 pub source: Option<String>,
69}
70
71#[derive(Clone, Debug, Serialize, Deserialize)]
72#[serde(rename_all = "camelCase")]
73pub struct WorkflowRun {
74 pub id: String,
75 pub workflow_id: String,
76 pub path: String,
77 /// The workflow's name.
78 pub name: String,
79 /// `run-name`, or what started it: a commit's subject, a pull request's title.
80 pub title: String,
81 /// Counts the workflow's runs: 1, 2, 3…
82 pub number: u64,
83 pub attempt: u64,
84 /// The GitHub event: `push`, `pull_request`, `schedule`…
85 pub event: String,
86 #[serde(rename = "ref")]
87 pub git_ref: String,
88 pub sha: String,
89 /// The pull request it ran for, if any.
90 pub pull: Option<u32>,
91 /// `queued`, `in_progress` or `completed`.
92 pub status: String,
93 /// When completed: `success`, `failure`, `cancelled` or `skipped`.
94 pub conclusion: Option<String>,
95 /// Why it could not start, such as a workflow file that does not read.
96 pub error: Option<String>,
97 /// Username of whoever caused it.
98 pub actor: Option<String>,
99 pub created_at: String,
100 pub started_at: Option<String>,
101 pub finished_at: Option<String>,
102}
103
104#[derive(Clone, Debug, Default, Serialize, Deserialize)]
105#[serde(rename_all = "camelCase")]
106pub struct StepState {
107 /// From 1.
108 pub number: u32,
109 pub name: String,
110 /// `queued`, `in_progress` or `completed`.
111 pub status: String,
112 /// `success`, `failure`, `cancelled` or `skipped`.
113 pub conclusion: Option<String>,
114 pub started_at: Option<String>,
115 pub finished_at: Option<String>,
116}
117
118/// A message a step left with `::error::`, `::warning::` or `::notice::`.
119#[derive(Clone, Debug, Default, Serialize, Deserialize)]
120#[serde(rename_all = "camelCase")]
121pub struct Annotation {
122 /// `error`, `warning` or `notice`.
123 pub level: String,
124 pub message: String,
125 pub title: Option<String>,
126 pub file: Option<String>,
127 pub line: Option<u32>,
128}
129
130#[derive(Clone, Debug, Serialize, Deserialize)]
131#[serde(rename_all = "camelCase")]
132pub struct Job {
133 pub id: String,
134 pub run_id: String,
135 /// Its key under `jobs:`.
136 pub key: String,
137 /// With its matrix combination: `test (ubuntu-latest, 20)`.
138 pub name: String,
139 pub needs: Vec<String>,
140 /// `queued`, `waiting` (for the jobs it needs), `in_progress` or `completed`.
141 pub status: String,
142 pub conclusion: Option<String>,
143 pub steps: Vec<StepState>,
144 pub annotations: Vec<Annotation>,
145 /// Why it did not run, what stopped it, or what it waits for.
146 pub reason: Option<String>,
147 pub started_at: Option<String>,
148 pub finished_at: Option<String>,
149 /// The environment it names, once its needs are done (an expression
150 /// read by then). A job held by the environment's protection rules is
151 /// `pending` until they let it through.
152 #[serde(default)]
153 pub environment: Option<String>,
154 /// Its `runs-on` names self-hosted runners (see `runners`).
155 #[serde(default)]
156 pub self_hosted: bool,
157 /// The self-hosted runner that took it, by name.
158 #[serde(default)]
159 pub runner: Option<String>,
160 /// It was cancelled and is running its `if: always()` and `cancelled()`
161 /// steps and its post steps before it ends.
162 #[serde(default)]
163 pub cancelling: bool,
164 /// Where its deployment is (`environment.url`), for a job that deploys
165 /// and says; the current attempt's only.
166 #[serde(default, skip_serializing_if = "Option::is_none")]
167 pub environment_url: Option<String>,
168 /// For a job that calls a reusable workflow: that workflow's file. Its
169 /// jobs' keys start with this job's key and a `/`.
170 #[serde(default, skip_serializing_if = "Option::is_none")]
171 pub uses: Option<String>,
172}
173
174#[derive(Clone, Debug, Serialize, Deserialize)]
175#[serde(rename_all = "camelCase")]
176pub struct RunDetail {
177 pub run: WorkflowRun,
178 pub jobs: Vec<Job>,
179 /// The workflow's notes, as of the run's commit.
180 pub notes: Vec<WorkflowNote>,
181 /// For a run of a pull request from outside: whether it waits for, or
182 /// had, someone's approval (`status` is `action_required` while it waits).
183 #[serde(default)]
184 pub approval: Option<RunApproval>,
185 /// The environments whose protection rules hold its jobs, this attempt.
186 #[serde(default)]
187 pub pending_deployments: Vec<PendingDeployment>,
188 /// Every attempt of the run, oldest first, the one shown included.
189 /// `run.attempt` says which one `jobs` belong to.
190 #[serde(default)]
191 pub attempts: Vec<RunAttempt>,
192}
193
194/// One attempt of a run: the first, or a re-run.
195#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
196#[serde(rename_all = "camelCase")]
197pub struct RunAttempt {
198 /// From 1.
199 pub attempt: u64,
200 /// `queued`, `in_progress` or `completed`; earlier attempts are completed.
201 pub status: String,
202 pub conclusion: Option<String>,
203 /// Who started it: whoever caused the run for the first, whoever re-ran
204 /// it for the rest.
205 pub actor: Option<String>,
206 /// It ran with debug logging (`RUNNER_DEBUG=1`).
207 pub debug: bool,
208 pub started_at: Option<String>,
209 pub finished_at: Option<String>,
210}
211
212/// One job's summary: what its steps wrote to `$GITHUB_STEP_SUMMARY`, in
213/// Markdown, masked.
214#[derive(Clone, Debug, Serialize, Deserialize)]
215#[serde(rename_all = "camelCase")]
216pub struct JobSummary {
217 /// The job's id, as `RunDetail.jobs` gives it for the attempt.
218 pub job_id: String,
219 pub name: String,
220 pub steps: Vec<StepSummary>,
221}
222
223#[derive(Clone, Debug, Serialize, Deserialize)]
224#[serde(rename_all = "camelCase")]
225pub struct StepSummary {
226 /// The step, from 1 (post steps follow the job's own).
227 pub step: u32,
228 pub markdown: String,
229}
230
231/// A job's whole log, for downloading: its steps, to split the text by.
232#[derive(Clone, Debug, Serialize, Deserialize)]
233#[serde(rename_all = "camelCase")]
234pub struct JobLogText {
235 pub job_id: String,
236 pub name: String,
237 pub steps: Vec<StepState>,
238 pub chunks: Vec<LogChunk>,
239 /// Whether the job has finished.
240 pub done: bool,
241 /// Its log was left out: the run's logs reached `MAX_RUN_LOG_BYTES`.
242 #[serde(default)]
243 pub omitted: bool,
244}
245
246/// A run that needed approval before it started.
247#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
248#[serde(rename_all = "camelCase")]
249pub struct RunApproval {
250 /// `required` while it waits, then `approved`.
251 pub state: String,
252 /// Why it waits, in words.
253 pub reason: String,
254 /// Who approved it.
255 pub approved_by: Option<String>,
256}
257
258/// One person or team who may approve a job's deployment to an
259/// environment.
260#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
261pub struct EnvironmentReviewer {
262 /// `user` or `team`.
263 #[serde(rename = "type")]
264 pub kind: String,
265 /// A username, or a team's slug in the repository's workspace.
266 pub name: String,
267}
268
269/// A branch or tag pattern an environment lets deploy.
270#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
271pub struct BranchPattern {
272 /// fnmatch-style, as branch filters are: `main`, `release/*`, `v*`.
273 pub name: String,
274 /// `branch` or `tag`.
275 #[serde(rename = "type", default = "branch_kind")]
276 pub kind: String,
277}
278
279fn branch_kind() -> String {
280 "branch".to_owned()
281}
282
283/// The most reviewers an environment may have, as on GitHub.
284pub const MAX_ENVIRONMENT_REVIEWERS: usize = 6;
285/// The longest wait timer, in minutes: 30 days.
286pub const MAX_WAIT_MINUTES: u32 = 43_200;
287
288/// An environment and its protection rules. Jobs that name it with
289/// `environment:` wait until the rules let them through; only then does the
290/// job get the environment's secrets.
291#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
292#[serde(rename_all = "camelCase")]
293pub struct Environment {
294 /// Lowercase.
295 pub name: String,
296 /// Who may approve its jobs; none means no review is needed.
297 pub reviewers: Vec<EnvironmentReviewer>,
298 /// Whoever started a run may not approve its jobs, even as a reviewer.
299 pub prevent_self_review: bool,
300 /// Minutes each job waits before it may start.
301 pub wait_minutes: u32,
302 /// Which refs may deploy: `all`, `protected` (branches the rules
303 /// protect, the default branch included) or `selected` (`branch_patterns`).
304 pub branch_policy: String,
305 pub branch_patterns: Vec<BranchPattern>,
306 /// Admins may approve without being reviewers, which also skips the wait.
307 pub admins_bypass: bool,
308 /// Whether it has rules saved; false for one only named by a workflow,
309 /// a secret or a deployment.
310 pub protected: bool,
311 pub updated_at: Option<String>,
312 pub updated_by: Option<String>,
313}
314
315/// An environment holding a run's jobs, and where its rules stand.
316#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
317#[serde(rename_all = "camelCase")]
318pub struct PendingDeployment {
319 pub environment: String,
320 /// `waiting`, `approved` or `rejected`.
321 pub state: String,
322 /// Whether a reviewer must approve it before its jobs start.
323 pub needs_review: bool,
324 /// When its wait timer lets its jobs start, if it has one.
325 pub wait_until: Option<String>,
326 pub reviewers: Vec<EnvironmentReviewer>,
327 /// The jobs it holds, by name.
328 pub jobs: Vec<String>,
329 /// Whether the viewer may approve or reject it now.
330 #[serde(default)]
331 pub can_review: bool,
332 pub reviewed_by: Option<String>,
333 pub comment: Option<String>,
334 pub reviewed_at: Option<String>,
335}
336
337/// A repository's choices for its workflows.
338#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
339#[serde(rename_all = "camelCase")]
340pub struct ActionsSettings {
341 /// What a workflow without `permissions:` gets: `read` (contents and
342 /// packages read) or `write` (every permission). Unchosen, a repository
343 /// made before restricted tokens keeps `write`; a newer one takes its
344 /// workspace's default. Never more than the workspace's maximum.
345 pub default_permissions: String,
346 /// Whether the repository chose it, rather than taking it as above.
347 #[serde(default)]
348 pub default_chosen: bool,
349 /// The most the workspace lets a repository's default be.
350 #[serde(default = "write")]
351 pub max_permissions: String,
352 /// Which pull requests' runs wait for approval: `first_time_contributors`,
353 /// `outside_contributors` (the default) or `all_external_contributors`.
354 pub approval_policy: String,
355 /// Whether a job's token may open pull requests and approve them. Off
356 /// unless the repository turns it on, and only where the workspace
357 /// allows it.
358 #[serde(default)]
359 pub can_approve_pull_requests: bool,
360 /// Whether the workspace lets its repositories turn that on.
361 #[serde(default)]
362 pub workspace_allows_pull_requests: bool,
363 /// Who may use this repository's actions and reusable workflows from
364 /// their workflows, when it is private: `none` (only itself, the
365 /// default) or `organization` (private repositories of its workspace).
366 /// A public repository's are anyone's. See [`ACCESS_LEVELS`].
367 #[serde(default = "no_access")]
368 pub access_level: String,
369}
370
371fn no_access() -> String {
372 "none".to_owned()
373}
374
375/// The values of `access_level`. `user` is read as `organization`: a
376/// personal account's repositories are its own workspace's.
377pub const ACCESS_LEVELS: [&str; 2] = ["none", "organization"];
378
379/// `access_level` as given, as one of [`ACCESS_LEVELS`]; None when it is
380/// not one.
381pub fn access_level(given: &str) -> Option<&'static str> {
382 match given.trim().to_ascii_lowercase().as_str() {
383 "none" | "" => Some("none"),
384 "organization" | "user" | "workspace" => Some("organization"),
385 _ => None,
386 }
387}
388
389fn write() -> String {
390 "write".to_owned()
391}
392
393/// A workspace's policy for its repositories' tokens.
394#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
395#[serde(rename_all = "camelCase")]
396pub struct WorkspaceActionsSettings {
397 /// What a repository made from now on gets by default: `read` (the
398 /// default) or `write`.
399 pub default_permissions: String,
400 /// The most any repository's default may be: `write` (the default) or
401 /// `read`, which holds every repository to read-only.
402 pub max_permissions: String,
403 /// Whether its repositories may let jobs open and approve pull
404 /// requests. Off by default.
405 pub can_approve_pull_requests: bool,
406}
407
408/// `workspace_actions_settings`: members only. Returns
409/// `Outcome<WorkspaceActionsSettings>`.
410#[derive(Debug, Serialize, Deserialize)]
411pub struct WorkspaceActionsSettingsArgs {
412 pub viewer: Viewer,
413 pub workspace: String,
414}
415
416/// `set_workspace_actions_settings`: owners only. Fields left out stay as
417/// they are. Returns `Outcome<WorkspaceActionsSettings>`.
418#[derive(Debug, Serialize, Deserialize)]
419#[serde(rename_all = "camelCase")]
420pub struct SetWorkspaceActionsSettingsArgs {
421 pub actor: User,
422 pub workspace: String,
423 #[serde(default)]
424 pub default_permissions: Option<String>,
425 #[serde(default)]
426 pub max_permissions: Option<String>,
427 #[serde(default)]
428 pub can_approve_pull_requests: Option<bool>,
429}
430
431/// The approval policies, least strict first.
432pub const APPROVAL_POLICIES: [&str; 3] = ["first_time_contributors", "outside_contributors", "all_external_contributors"];
433
434/// `actions_settings`. Returns `Outcome<ActionsSettings>`; anyone who can
435/// read the repository may see them.
436#[derive(Debug, Serialize, Deserialize)]
437pub struct ActionsSettingsArgs {
438 pub viewer: Viewer,
439 pub repo: RepoPath,
440}
441
442/// `set_actions_settings`: Admins only. Fields left out stay as they are.
443/// Returns `Outcome<ActionsSettings>`.
444#[derive(Debug, Serialize, Deserialize)]
445#[serde(rename_all = "camelCase")]
446pub struct SetActionsSettingsArgs {
447 pub actor: User,
448 pub repo: RepoPath,
449 /// `read` or `write`; `inherit` goes back to the workspace's (or, for a
450 /// repository made before restricted tokens, `write`).
451 #[serde(default)]
452 pub default_permissions: Option<String>,
453 #[serde(default)]
454 pub approval_policy: Option<String>,
455 #[serde(default)]
456 pub can_approve_pull_requests: Option<bool>,
457 /// `none`, or `organization` (`user` reads the same). See
458 /// [`ActionsSettings::access_level`].
459 #[serde(default)]
460 pub access_level: Option<String>,
461}
462
463/// `environments`: every environment a repository's workflows, secrets,
464/// deployments or rules name, with its rules. `environment`: one, by
465/// `name`. Returns `Outcome<Vec<Environment>>` and `Outcome<Environment>`.
466#[derive(Debug, Serialize, Deserialize)]
467pub struct EnvironmentsArgs {
468 pub viewer: Viewer,
469 pub repo: RepoPath,
470 #[serde(default)]
471 pub name: Option<String>,
472}
473
474/// `set_environment`: create an environment's rules or change them. Fields
475/// left out stay as they are (none, for a new one). Admins only. Returns
476/// `Outcome<Environment>`.
477#[derive(Debug, Serialize, Deserialize)]
478#[serde(rename_all = "camelCase")]
479pub struct SetEnvironmentArgs {
480 pub actor: User,
481 pub repo: RepoPath,
482 pub name: String,
483 #[serde(default)]
484 pub reviewers: Option<Vec<EnvironmentReviewer>>,
485 #[serde(default)]
486 pub prevent_self_review: Option<bool>,
487 #[serde(default)]
488 pub wait_minutes: Option<u32>,
489 #[serde(default)]
490 pub branch_policy: Option<String>,
491 #[serde(default)]
492 pub branch_patterns: Option<Vec<BranchPattern>>,
493 #[serde(default)]
494 pub admins_bypass: Option<bool>,
495}
496
497/// `delete_environment`: its rules go; jobs naming it run without them.
498/// Its secrets' rows stay. Admins only. Returns `Outcome<bool>`.
499#[derive(Debug, Serialize, Deserialize)]
500pub struct DeleteEnvironmentArgs {
501 pub actor: User,
502 pub repo: RepoPath,
503 pub name: String,
504}
505
506/// `pending_deployments`: the environments holding a run's jobs. Returns
507/// `Outcome<Vec<PendingDeployment>>`.
508#[derive(Debug, Serialize, Deserialize)]
509pub struct PendingDeploymentsArgs {
510 pub viewer: Viewer,
511 pub repo: RepoPath,
512 pub id: String,
513}
514
515/// `review_deployments`: approve or reject a run's jobs for `environments`
516/// (every one waiting, if empty). Returns `Outcome<Vec<PendingDeployment>>`.
517#[derive(Debug, Serialize, Deserialize)]
518pub struct ReviewDeploymentsArgs {
519 pub actor: User,
520 pub repo: RepoPath,
521 pub id: String,
522 #[serde(default)]
523 pub environments: Vec<String>,
524 /// `approved` or `rejected`.
525 pub state: String,
526 #[serde(default)]
527 pub comment: Option<String>,
528}
529
530/// `repository_dispatch`: start the default branch's workflows that run
531/// `on: repository_dispatch` for `event_type`. Needs the Write role (a
532/// token's `code:write`). Returns `Outcome<u32>`: how many started.
533#[derive(Debug, Serialize, Deserialize)]
534#[serde(rename_all = "camelCase")]
535pub struct RepositoryDispatchArgs {
536 pub actor: User,
537 pub repo: RepoPath,
538 pub event_type: String,
539 #[serde(default)]
540 pub client_payload: Value,
541}
542
543#[derive(Clone, Debug, Serialize, Deserialize)]
544#[serde(rename_all = "camelCase")]
545pub struct LogChunk {
546 pub seq: u64,
547 /// The step it belongs to, from 1; 0 for the job's setup.
548 pub step: u32,
549 pub text: String,
550}
551
552#[derive(Clone, Debug, Serialize, Deserialize)]
553#[serde(rename_all = "camelCase")]
554pub struct JobLog {
555 pub chunks: Vec<LogChunk>,
556 /// Whether the job has finished, so no more will come.
557 pub done: bool,
558}
559
560/// Who may read a secret or variable: workflows (`secrets.*` and `vars.*`
561/// in GitHub Actions) and deployments (a deploy build's environment and the
562/// running app's bindings). Agents, checks and the merge queue read none.
563pub const CONSUMERS: [&str; 2] = ["workflows", "deployments"];
564
565/// One row of a repository's or workspace's secrets and variables, as
566/// Vercel lists environment variables: a key, its type, the environments
567/// it applies to and who reads it. A key may have one row per environment.
568/// Secrets' values are never returned.
569#[derive(Clone, Debug, Serialize, Deserialize)]
570#[serde(rename_all = "camelCase")]
571pub struct Setting {
572 #[serde(default)]
573 pub id: String,
574 pub name: String,
575 /// `secret`, or `variable` (shown as Config).
576 #[serde(default)]
577 pub kind: String,
578 /// A variable's value; secrets' are never returned.
579 pub value: Option<String>,
580 /// `project` (a repository's, which belong to its project) or
581 /// `workspace`.
582 pub scope: String,
583 pub updated_at: String,
584 /// `workflows` and/or `deployments`.
585 #[serde(default)]
586 pub available_to: Vec<String>,
587 /// The environments it applies to; empty is every environment.
588 #[serde(default)]
589 pub environments: Vec<String>,
590 /// A workspace's row: the projects it reaches, by slug; empty is every
591 /// project.
592 #[serde(default)]
593 pub projects: Vec<String>,
594 #[serde(default)]
595 pub note: Option<String>,
596 #[serde(default)]
597 pub updated_by: Option<String>,
598 /// A brokered secret's hosts: a job gets a stand-in for it, and g1t
599 /// puts the real value on the job's requests to these hosts as they
600 /// leave its sandbox. Empty for a secret that is not brokered, and for
601 /// config.
602 #[serde(default)]
603 pub brokered_hosts: Vec<String>,
604}
605
606/// How a brokered secret's stand-in starts. The rest is 48 random hex
607/// characters, so the whole is shaped like a token and tools take it.
608pub const STAND_IN_PREFIX: &str = "g1tsec_";
609
610/// A stand-in a running job was given for a brokered secret, as the runner
611/// Worker asks for them (`brokered_secrets`) to fill in the real value on
612/// the job's requests to `hosts`.
613#[derive(Clone, Debug, Serialize, Deserialize)]
614#[serde(rename_all = "camelCase")]
615pub struct BrokeredSecret {
616 pub stand_in: String,
617 /// The secret's key, for the job's log.
618 pub name: String,
619 pub value: String,
620 pub hosts: Vec<String>,
621}
622
623// --- Methods ---------------------------------------------------------------
624
625/// `workflows`. Returns `Outcome<Vec<Workflow>>`.
626#[derive(Debug, Serialize, Deserialize)]
627pub struct WorkflowsArgs {
628 pub repo: RepoPath,
629 pub viewer: Viewer,
630}
631
632/// `workflow`: one workflow, named by its id (`wfl_…`), its file name
633/// (`ci.yml`), its path or its name, with its file as of `ref` (the
634/// default branch when absent). Returns `Outcome<WorkflowDetail>`.
635#[derive(Debug, Serialize, Deserialize)]
636pub struct WorkflowArgs {
637 pub repo: RepoPath,
638 pub viewer: Viewer,
639 pub workflow: String,
640 #[serde(default, rename = "ref")]
641 pub git_ref: Option<String>,
642}
643
644/// A workflow with its file.
645#[derive(Clone, Debug, Serialize, Deserialize)]
646#[serde(rename_all = "camelCase")]
647pub struct WorkflowDetail {
648 #[serde(flatten)]
649 pub workflow: Workflow,
650 /// The branch or tag the file was read from.
651 #[serde(rename = "ref")]
652 pub git_ref: String,
653 /// The file, as written on `ref`.
654 pub source: String,
655}
656
657/// `runs`: newest first. Returns `Outcome<Vec<WorkflowRun>>`.
658#[derive(Debug, Serialize, Deserialize)]
659pub struct RunsArgs {
660 pub repo: RepoPath,
661 pub viewer: Viewer,
662 /// A workflow's id or file name.
663 #[serde(default)]
664 pub workflow: Option<String>,
665 #[serde(default)]
666 pub branch: Option<String>,
667 #[serde(default)]
668 pub event: Option<String>,
669 /// The pull request's number.
670 #[serde(default)]
671 pub pull: Option<u32>,
672 #[serde(default)]
673 pub sha: Option<String>,
674 #[serde(default)]
675 pub limit: Option<u32>,
676}
677
678/// `run`. Returns `Outcome<RunDetail>`.
679#[derive(Debug, Serialize, Deserialize)]
680pub struct RunArgs {
681 pub repo: RepoPath,
682 pub viewer: Viewer,
683 pub id: String,
684 /// An earlier attempt; the latest when absent.
685 #[serde(default)]
686 pub attempt: Option<u64>,
687}
688
689/// `summaries`: the job summaries of a run's attempt (the latest when
690/// `attempt` is absent), jobs in the run's order, those with none left
691/// out. Returns `Outcome<Vec<JobSummary>>`.
692#[derive(Debug, Serialize, Deserialize)]
693pub struct SummariesArgs {
694 pub repo: RepoPath,
695 pub viewer: Viewer,
696 pub id: String,
697 #[serde(default)]
698 pub attempt: Option<u64>,
699}
700
701/// `job_log_text`: one job's whole log, any attempt's (by the id the run
702/// gave the job). Returns `Outcome<JobLogText>`.
703#[derive(Debug, Serialize, Deserialize)]
704pub struct JobLogTextArgs {
705 pub repo: RepoPath,
706 pub viewer: Viewer,
707 pub job: String,
708}
709
710/// `run_logs`: every job's whole log for an attempt of a run (the latest
711/// when `attempt` is absent), until they add up to `MAX_RUN_LOG_BYTES`;
712/// jobs past it come `omitted`, with no chunks. Returns
713/// `Outcome<Vec<JobLogText>>`.
714#[derive(Debug, Serialize, Deserialize)]
715pub struct RunLogsArgs {
716 pub repo: RepoPath,
717 pub viewer: Viewer,
718 pub id: String,
719 #[serde(default)]
720 pub attempt: Option<u64>,
721}
722
723/// The most log `run_logs` returns at once, in bytes.
724pub const MAX_RUN_LOG_BYTES: usize = 24 * 1024 * 1024;
725
726/// `logs`: a job's log after `after`, or with `tail` its last chunks.
727/// Returns `Outcome<JobLog>`.
728#[derive(Debug, Serialize, Deserialize)]
729pub struct LogsArgs {
730 pub repo: RepoPath,
731 pub viewer: Viewer,
732 pub job: String,
733 #[serde(default)]
734 pub after: u64,
735 /// The last this many chunks (at most [`MAX_LOG_PAGE`]) instead: where
736 /// a failed job says why. `after` is ignored with it.
737 #[serde(default, skip_serializing_if = "Option::is_none")]
738 pub tail: Option<u32>,
739}
740
741/// The most chunks of a log one `logs` call returns.
742pub const MAX_LOG_PAGE: u32 = 500;
743
744/// `dispatch`: run a workflow that has `workflow_dispatch`. Members only.
745/// Returns `Outcome<WorkflowRun>`.
746#[derive(Debug, Serialize, Deserialize)]
747pub struct DispatchArgs {
748 pub actor: User,
749 pub repo: RepoPath,
750 /// A workflow's id or file name.
751 pub workflow: String,
752 /// A branch or tag; the default branch when absent.
753 #[serde(default, rename = "ref")]
754 pub git_ref: Option<String>,
755 #[serde(default)]
756 pub inputs: serde_json::Map<String, Value>,
757}
758
759/// `cancel` and `rerun`: every job, with `failed_only` the ones that did
760/// not succeed, or with `job` that one job (by its id in the run's latest
761/// attempt); each with the jobs that need them. `debug` runs the new
762/// attempt with debug logging. Members only. Returns `Outcome<WorkflowRun>`.
763#[derive(Debug, Serialize, Deserialize)]
764pub struct RunActionArgs {
765 pub actor: User,
766 pub repo: RepoPath,
767 pub id: String,
768 #[serde(default)]
769 pub failed_only: bool,
770 #[serde(default)]
771 pub job: Option<String>,
772 #[serde(default)]
773 pub debug: bool,
774 /// `cancel`: stop running jobs outright, without their cleanup steps.
775 #[serde(default)]
776 pub force: bool,
777}
778
779/// `set_workflow_enabled`. Members only. Returns `Outcome<Workflow>`.
780#[derive(Debug, Serialize, Deserialize)]
781pub struct SetWorkflowEnabledArgs {
782 pub actor: User,
783 pub repo: RepoPath,
784 pub workflow: String,
785 pub enabled: bool,
786}
787
788/// Whose secrets or variables: a repository's, or with only `workspace`,
789/// a workspace's.
790#[derive(Clone, Debug, Serialize, Deserialize)]
791pub struct SettingsOwner {
792 #[serde(default)]
793 pub repo: Option<RepoPath>,
794 #[serde(default)]
795 pub workspace: Option<String>,
796}
797
798/// `settings`: the secrets (`kind: secret`) or variables (`kind: variable`)
799/// of a repository, with its workspace's, or of a workspace. Members only.
800/// Returns `Outcome<Vec<Setting>>`.
801#[derive(Debug, Serialize, Deserialize)]
802pub struct SettingsArgs {
803 pub actor: User,
804 #[serde(flatten)]
805 pub owner: SettingsOwner,
806 pub kind: String,
807}
808
809/// `set_setting`: add or replace one. A repository's need a member; a
810/// workspace's an owner. Returns `Outcome<Setting>`.
811#[derive(Debug, Serialize, Deserialize)]
812pub struct SetSettingArgs {
813 pub actor: User,
814 #[serde(flatten)]
815 pub owner: SettingsOwner,
816 /// `secret` or `variable`. Changing a variable's row to `secret` seals
817 /// it; a secret cannot become a variable.
818 pub kind: String,
819 pub name: String,
820 /// The row to change. Left out, the key's row for every environment, as
821 /// GitHub's API addresses a secret by name alone.
822 #[serde(default)]
823 pub id: Option<String>,
824 /// Needed for a new row; left out, an existing row keeps its value.
825 #[serde(default)]
826 pub value: Option<String>,
827 /// `workflows` and/or `deployments`; left out, unchanged (both, for a
828 /// new row).
829 // Named as callers send it: an `alias` is not honoured beside the
830 // flattened owner in the Worker's build.
831 #[serde(default, rename = "availableTo")]
832 pub available_to: Option<Vec<String>>,
833 /// The environments it applies to; empty is every one. Left out,
834 /// unchanged.
835 #[serde(default)]
836 pub environments: Option<Vec<String>>,
837 /// A workspace's row: project slugs; empty for every one.
838 #[serde(default)]
839 pub projects: Option<Vec<String>>,
840 #[serde(default)]
841 pub note: Option<String>,
842 /// A secret's brokered hosts (`Setting::brokered_hosts`); empty stops
843 /// brokering it. Left out, unchanged.
844 #[serde(default, rename = "brokeredHosts")]
845 pub brokered_hosts: Option<Vec<String>>,
846}
847
848/// `set_managed_workflow`: installs, or replaces, a managed workflow in a
849/// repository (`g1t_actions::managed`): one that runs as if it were in
850/// `.g1t/workflows/` without being committed there, under the path
851/// `managed/<name>.yml`. For g1t's own services; never reached from the API.
852/// Refused when `source` is not a workflow g1t can read. Returns `bool`.
853#[derive(Debug, Serialize, Deserialize)]
854#[serde(rename_all = "camelCase")]
855pub struct SetManagedWorkflowArgs {
856 pub repo_id: String,
857 /// Letters, digits and hyphens: the file name its path ends with.
858 pub name: String,
859 pub source: String,
860 /// What keeps it: `deployments`, or a workspace's id.
861 pub origin: String,
862}
863
864/// `set_managed_deploy`: installs, replaces or removes the deploy workflow
865/// a project's deployments run through (`g1t_actions::managed`), named
866/// `deploy-<project>`, from the project's settings. Nothing deploys (both
867/// `previews` and `production` off) removes it. For the deployments
868/// service only. Returns `bool`, whether one is installed now.
869#[derive(Debug, Serialize, Deserialize)]
870#[serde(rename_all = "camelCase")]
871pub struct SetManagedDeployArgs {
872 pub repo_id: String,
873 pub project: String,
874 pub production_branch: String,
875 #[serde(default)]
876 pub root_dir: String,
877 #[serde(default)]
878 pub build_command: String,
879 #[serde(default)]
880 pub output_dir: String,
881 pub previews: bool,
882 pub production: bool,
883}
884
885/// A workflow a workspace's owners added to its repositories
886/// (`g1t_actions::managed::Target`): it runs in each repository it targets
887/// as that repository's own, with its token and secrets, under the path
888/// `managed/<name>.yml`, from a copy of its source taken when it was saved.
889#[derive(Clone, Debug, Serialize, Deserialize)]
890#[serde(rename_all = "camelCase")]
891pub struct WorkspaceManagedWorkflow {
892 /// Lowercase letters, digits and hyphens: its path is
893 /// `managed/<name>.yml`.
894 pub name: String,
895 pub path: String,
896 /// Its `name:`, as repositories list it; a repository's workflow of
897 /// this name takes a default one's place.
898 pub workflow_name: String,
899 /// Where it was copied from: `owner/repo/path@ref`, a repository of the
900 /// same workspace.
901 pub source: String,
902 /// The commit it was copied at.
903 pub source_sha: Option<String>,
904 /// Whether the source repository is private, so the workflow runs in
905 /// private repositories only.
906 pub source_private: bool,
907 /// `required` or `default`.
908 pub mode: String,
909 /// Names and patterns of the repositories it runs in; empty is every one.
910 pub repositories: Vec<String>,
911 /// `all`, `public` or `private`.
912 pub visibility: String,
913 /// The copy that runs.
914 pub content: String,
915 pub created_at: String,
916 pub updated_at: String,
917 pub updated_by: String,
918}
919
920/// `workspace_managed_workflows`: owners only. Returns
921/// `Outcome<Vec<WorkspaceManagedWorkflow>>`.
922#[derive(Debug, Serialize, Deserialize)]
923pub struct WorkspaceManagedWorkflowsArgs {
924 pub viewer: Viewer,
925 pub workspace: String,
926}
927
928/// `set_workspace_managed_workflow`: owners only. Adds one (`create`, which
929/// needs `source` and `mode`) or changes one; fields left out stay as they
930/// are. The source is copied again when it is given or `refresh` is set.
931/// Refused when the source is not a workflow file in a repository of the
932/// workspace, or is private while the workflow could run in a public
933/// repository. Returns `Outcome<WorkspaceManagedWorkflow>`.
934#[derive(Debug, Serialize, Deserialize)]
935#[serde(rename_all = "camelCase")]
936pub struct SetWorkspaceManagedWorkflowArgs {
937 pub actor: User,
938 pub workspace: String,
939 pub name: String,
940 #[serde(default)]
941 pub create: bool,
942 /// `owner/repo/.g1t/workflows/file.yml@ref`.
943 #[serde(default)]
944 pub source: Option<String>,
945 #[serde(default)]
946 pub mode: Option<String>,
947 #[serde(default)]
948 pub repositories: Option<Vec<String>>,
949 #[serde(default)]
950 pub visibility: Option<String>,
951 #[serde(default)]
952 pub refresh: bool,
953}
954
955/// `remove_workspace_managed_workflow`: owners only. Its runs stay.
956/// Returns `Outcome<bool>`, whether there was one.
957#[derive(Debug, Serialize, Deserialize)]
958pub struct RemoveWorkspaceManagedWorkflowArgs {
959 pub actor: User,
960 pub workspace: String,
961 pub name: String,
962}
963
964/// `remove_managed_workflow`: takes a managed workflow out of a repository.
965/// Its runs stay. Returns `bool`, whether there was one.
966#[derive(Debug, Serialize, Deserialize)]
967#[serde(rename_all = "camelCase")]
968pub struct RemoveManagedWorkflowArgs {
969 pub repo_id: String,
970 pub name: String,
971}
972
973/// `resolve_settings`: the secrets and variables one reader gets, for the
974/// services that hand them out (the deployments service). Returns
975/// `ResolvedSettings`.
976#[derive(Debug, Serialize, Deserialize)]
977#[serde(rename_all = "camelCase")]
978pub struct ResolveSettingsArgs {
979 pub repo_id: String,
980 pub repo: RepoPath,
981 /// The project being read for; its repository's primary project if left
982 /// out.
983 #[serde(default)]
984 pub project_id: Option<String>,
985 #[serde(default)]
986 pub project_slug: Option<String>,
987 /// `workflows` or `deployments`.
988 pub consumer: String,
989 /// The environment being read for, such as `production` or `preview`.
990 #[serde(default)]
991 pub environment: Option<String>,
992 /// Whether the run is trusted; an untrusted one gets no secrets.
993 pub trusted: bool,
994}
995
996#[derive(Debug, Default, Serialize, Deserialize)]
997pub struct ResolvedSettings {
998 pub secrets: serde_json::Map<String, serde_json::Value>,
999 pub variables: serde_json::Map<String, serde_json::Value>,
1000}
1001
1002/// `delete_setting`. Returns `Outcome<bool>`.
1003#[derive(Debug, Serialize, Deserialize)]
1004pub struct DeleteSettingArgs {
1005 pub actor: User,
1006 #[serde(flatten)]
1007 pub owner: SettingsOwner,
1008 pub kind: String,
1009 pub name: String,
1010 /// One row; left out, every row of the key.
1011 #[serde(default)]
1012 pub id: Option<String>,
1013}
1014
1015/// `job_spec` and `job_report`: the sandbox running a job, with the job's
1016/// own token. `report` is one of:
1017/// `{"kind": "step", "number", "status", "conclusion"}`,
1018/// `{"kind": "log", "step", "text"}`,
1019/// `{"kind": "annotation", "level", "message", "title", "file", "line"}`,
1020/// `{"kind": "done", "conclusion", "outputs", "reason"}`.
1021#[derive(Debug, Serialize, Deserialize)]
1022pub struct JobCallArgs {
1023 pub job: String,
1024 pub token: String,
1025 #[serde(default)]
1026 pub report: Value,
1027 /// `job_spec` only: the harness takes a new token with the spec, and
1028 /// the one it asked with stops working, so a copy of it left on the
1029 /// runner's computer cannot fetch the job's secrets again. Harnesses
1030 /// that predate it never ask, and keep their token.
1031 #[serde(default)]
1032 pub rotate: bool,
1033 /// `job_spec` only: the harness on a self-hosted runner can pass the
1034 /// job's requests to a brokered secret's hosts through g1t
1035 /// (`POST /actions/jobs/{job}/broker`), so its spec lists each
1036 /// stand-in's hosts, never a value. Harnesses that predate it never
1037 /// ask, and their job's log says the stand-ins will not be filled in.
1038 #[serde(default)]
1039 pub broker: bool,
1040}
1041
1042/// What the runner needs to start a job's sandbox.
1043#[derive(Debug, Serialize, Deserialize)]
1044#[serde(rename_all = "camelCase")]
1045pub struct StartJobArgs {
1046 pub job: String,
1047 pub token: String,
1048 pub repo: RepoPath,
1049 /// Minutes before the job is stopped.
1050 pub timeout_minutes: u32,
1051 /// The workflow file the job is in (`.g1t/workflows/deploy.yml`), for
1052 /// the guardrails' workflow-only domains.
1053 #[serde(default)]
1054 pub workflow: Option<String>,
1055 /// The environment the job names with `environment:`, when it names
1056 /// one plainly (not with an expression).
1057 #[serde(default)]
1058 pub environment: Option<String>,
1059 /// Whether its run is trusted: not a pull request from a fork. Only a
1060 /// trusted run's jobs reach workflow-only domains.
1061 #[serde(default)]
1062 pub trusted: bool,
1063 /// The machine its `runs-on` asked for, by label (`instance_for`):
1064 /// `g1t-2core` or `g1t-4core`; absent, the standard one.
1065 #[serde(default)]
1066 pub instance: Option<String>,
1067 /// Whether the job may be given brokered secrets, so the runner sends
1068 /// its HTTP and HTTPS through the Worker even when its network is open.
1069 #[serde(default)]
1070 pub brokered: bool,
1071}
1072
1073// ── The machine catalogue ─────────────────────────────────────────────────
1074//
1075// `INSTANCE_TYPES` is the one table of g1t's hosted machines: each row is a
1076// `runs-on` label, the machine it bills as, the runner's Container class
1077// that runs it, the Cloudflare Containers instance type behind that class,
1078// its size, and its price a minute. Its TypeScript mirror is
1079// packages/contracts/src/instances.ts, and services/runner/wrangler.jsonc
1080// gives each class its instance type; tests hold the three together.
1081// Adding a size, renaming a label or pointing a label at another instance
1082// type is a row here and in the mirror, and a class in wrangler.jsonc
1083// (CONTRIBUTING.md, "Adding a machine size").
1084
1085/// A label a workflow job can ask for in `runs-on`, and the machine g1t
1086/// runs it on. Each machine is a named Cloudflare Containers instance type
1087/// (no custom types): the standard machine is standard-3 (2 vCPU, 8 GiB,
1088/// 16 GB of disk), `g1t-2core` is kept as a name of it so workflows that
1089/// ask for it keep working, and `g1t-4core` is standard-4 (4 vCPU, 12 GiB,
1090/// 20 GB).
1091#[derive(Clone, Copy, Debug, PartialEq)]
1092pub struct InstanceType {
1093 /// The `runs-on` label, or `standard` for the default.
1094 pub label: &'static str,
1095 /// The machine, as it is billed and reported: runner minutes are
1096 /// counted by machine (`2-core`), so a label renamed or pointed at
1097 /// another machine leaves the history where it was. Never reused for a
1098 /// different machine.
1099 pub machine: &'static str,
1100 /// The runner's Durable Object class that runs it, one per label (a
1101 /// class has one instance type and its own `max_instances`).
1102 pub class: &'static str,
1103 /// The named Containers instance type its class runs on.
1104 pub container: &'static str,
1105 pub vcpu: f64,
1106 pub memory_gib: f64,
1107 pub disk_gb: f64,
1108 /// What a minute of it is charged, in millionths of a dollar: a job is
1109 /// charged its minutes, rounded up, at this rate (`runner_minutes`).
1110 /// The machine's cost a minute at Cloudflare's list prices with half
1111 /// its vCPUs busy, plus the 20% margin, rounded up to a tenth of a cent,
1112 /// and never under its cost with every vCPU busy (Cloudflare bills
1113 /// memory, disk and the Durable Object for every second, CPU as used).
1114 pub micros_per_minute: i64,
1115}
1116
1117impl InstanceType {
1118 /// Its price as a multiple of the standard machine's.
1119 pub fn price_scale(&self) -> f64 {
1120 self.micros_per_minute as f64 / STANDARD_INSTANCE.micros_per_minute as f64
1121 }
1122
1123 /// `2 vCPU, 8 GiB, 16 GB`.
1124 pub fn size(&self) -> String {
1125 format!("{} vCPU, {} GiB, {} GB", self.vcpu, self.memory_gib, self.disk_gb)
1126 }
1127}
1128
1129/// The default: what `ubuntu-latest` and every other hosted label get.
1130pub const STANDARD_INSTANCE: InstanceType = InstanceType {
1131 label: "standard",
1132 machine: "2-core",
1133 class: "AttemptSandbox",
1134 container: "standard-3",
1135 vcpu: 2.0,
1136 memory_gib: 8.0,
1137 disk_gb: 16.0,
1138 micros_per_minute: 4_000,
1139};
1140
1141/// Every label a workflow job can ask for, the default first.
1142pub const INSTANCE_TYPES: [InstanceType; 3] = [
1143 STANDARD_INSTANCE,
1144 // The standard machine under the name it had when it was larger.
1145 InstanceType { label: "g1t-2core", class: "Sandbox2Core", ..STANDARD_INSTANCE },
1146 InstanceType {
1147 label: "g1t-4core",
1148 machine: "4-core",
1149 class: "Sandbox4Core",
1150 container: "standard-4",
1151 vcpu: 4.0,
1152 memory_gib: 12.0,
1153 disk_gb: 20.0,
1154 micros_per_minute: 7_000,
1155 },
1156];
1157
1158/// The machines, once each, in the catalogue's order: the first row of
1159/// each.
1160pub fn machines() -> Vec<InstanceType> {
1161 let mut seen: Vec<InstanceType> = Vec::new();
1162 for instance in INSTANCE_TYPES {
1163 if !seen.iter().any(|m| m.machine == instance.machine) {
1164 seen.push(instance);
1165 }
1166 }
1167 seen
1168}
1169
1170/// A machine by its key (`2-core`), if it is one.
1171pub fn machine_named(machine: &str) -> Option<InstanceType> {
1172 INSTANCE_TYPES.iter().find(|instance| instance.machine == machine).copied()
1173}
1174
1175/// The minutes a job on g1t's machines is charged for: its time rounded up
1176/// to the whole minute, so 61 seconds is 2 minutes and any job that ran is
1177/// at least 1. Nothing for a job that never ran.
1178pub fn runner_minutes(seconds: i64) -> i64 {
1179 if seconds <= 0 { 0 } else { (seconds + 59) / 60 }
1180}
1181
1182/// The machine a job's `runs-on` labels ask for: the dearest named (the
1183/// later row when two cost the same), or the standard one. Labels compare
1184/// without regard to case.
1185pub fn instance_for(labels: &[String]) -> InstanceType {
1186 INSTANCE_TYPES
1187 .iter()
1188 .filter(|instance| instance.label != STANDARD_INSTANCE.label && labels.iter().any(|label| label.trim().eq_ignore_ascii_case(instance.label)))
1189 .max_by_key(|instance| instance.micros_per_minute)
1190 .copied()
1191 .unwrap_or(STANDARD_INSTANCE)
1192}
1193
1194/// An instance type by its label, if it is one.
1195pub fn instance_named(label: &str) -> Option<InstanceType> {
1196 INSTANCE_TYPES.iter().find(|instance| instance.label.eq_ignore_ascii_case(label.trim())).copied()
1197}
1198
1199// ── The cache (actions/cache) ─────────────────────────────────────────────
1200//
1201// Entries are kept in R2 by the API (the ACTIONS_CACHE bucket) and listed
1202// here, by the actions service, which decides what is found, what fits and
1203// what is evicted. A sandbox reaches these through the API with its job's
1204// token: `/actions/jobs/{job}/cache` (see apps/api/src/blobs.rs).
1205
1206/// The largest one cache entry may be, compressed.
1207pub const CACHE_MAX_ENTRY_BYTES: u64 = 2 * 1024 * 1024 * 1024;
1208/// What one repository's entries may hold together. Saving past it evicts
1209/// the entries restored longest ago.
1210pub const CACHE_REPO_QUOTA_BYTES: u64 = 10 * 1024 * 1024 * 1024;
1211/// An entry not restored for this long is deleted.
1212pub const CACHE_UNUSED_DAYS: u64 = 7;
1213/// An entry is deleted this long after it was saved, however often it is
1214/// restored (the bucket's own lifecycle rule deletes objects at 30 days).
1215pub const CACHE_MAX_AGE_DAYS: u64 = 28;
1216/// An upload is sent in parts of this size (the last may be smaller).
1217pub const CACHE_PART_BYTES: u64 = 32 * 1024 * 1024;
1218/// What R2 charges g1t to store a GB for a month, in millionths of a
1219/// dollar ($0.015): what the cache's storage is charged at, plus the margin.
1220pub const CACHE_MICROS_PER_GB_MONTH: i64 = 15_000;
1221
1222/// `cache_lookup`: the entry a job restores: its key exactly, else the
1223/// newest whose key starts with one of `restore`, in order.
1224/// Returns `Outcome<Option<CacheHit>>`.
1225#[derive(Debug, Serialize, Deserialize)]
1226pub struct CacheLookupArgs {
1227 pub job: String,
1228 pub token: String,
1229 pub key: String,
1230 #[serde(default)]
1231 pub restore: Vec<String>,
1232 /// The entry's version, a hash of its paths and compression, as the
1233 /// toolkit's client and g1t's runner both send it: only an entry of the
1234 /// same version is found. `None` from runners that send none, whose
1235 /// entries have none.
1236 #[serde(default)]
1237 pub version: Option<String>,
1238}
1239
1240#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1241pub struct CacheHit {
1242 pub key: String,
1243 pub object: String,
1244 pub size: u64,
1245 /// When it was saved, RFC 3339.
1246 #[serde(default)]
1247 pub created_at: String,
1248 /// A signed token for downloading it through the toolkit's blob
1249 /// endpoint, when the lookup came with a version.
1250 #[serde(default)]
1251 pub blob: Option<String>,
1252}
1253
1254/// `cache_reserve`: a job about to save `size` bytes under `key`. Refused
1255/// when the key is taken (`conflict`: keys are written once) or the entry
1256/// is too large. Returns `Outcome<CacheReservation>`.
1257#[derive(Debug, Serialize, Deserialize)]
1258pub struct CacheReserveArgs {
1259 pub job: String,
1260 pub token: String,
1261 pub key: String,
1262 /// Its size, when known before it is sent (the toolkit's newer client
1263 /// says only when it finishes: 0 then).
1264 pub size: u64,
1265 /// As in `CacheLookupArgs`.
1266 #[serde(default)]
1267 pub version: Option<String>,
1268}
1269
1270#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1271pub struct CacheReservation {
1272 pub id: String,
1273 /// Where the API puts it in R2.
1274 pub object: String,
1275 /// The entry's number, which the toolkit's older protocol names it by.
1276 #[serde(default)]
1277 pub number: u64,
1278 /// Its R2 upload, once one is started.
1279 #[serde(default)]
1280 pub upload: Option<String>,
1281 /// A signed token for sending its parts through the toolkit's blob
1282 /// endpoint, once its upload is started.
1283 #[serde(default)]
1284 pub blob: Option<String>,
1285}
1286
1287/// `cache_upload`: an entry a job is still uploading, by its number or by
1288/// key and version. Returns `Outcome<CacheReservation>`, with `upload` and
1289/// `blob` set once its upload has been started.
1290#[derive(Debug, Serialize, Deserialize)]
1291pub struct CacheUploadArgs {
1292 pub job: String,
1293 pub token: String,
1294 #[serde(default)]
1295 pub number: Option<u64>,
1296 #[serde(default)]
1297 pub key: Option<String>,
1298 #[serde(default)]
1299 pub version: Option<String>,
1300}
1301
1302/// `cache_commit`: the upload of `id` is complete, at `size` bytes. Returns
1303/// `Outcome<CacheCommitted>`: the objects of entries it evicted, which the
1304/// API deletes from R2.
1305#[derive(Debug, Serialize, Deserialize)]
1306pub struct CacheCommitArgs {
1307 pub job: String,
1308 pub token: String,
1309 pub id: String,
1310 pub size: u64,
1311}
1312
1313#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1314pub struct CacheCommitted {
1315 pub evicted: Vec<String>,
1316}
1317
1318/// `cache_abort`: an upload that will not finish; its reservation goes.
1319/// Returns `Outcome<bool>`.
1320#[derive(Debug, Serialize, Deserialize)]
1321pub struct CacheAbortArgs {
1322 pub job: String,
1323 pub token: String,
1324 pub id: String,
1325}
1326
1327/// A cache entry as people see it, in GitHub's shape: `id` is a number,
1328/// `git_ref` the ref whose run saved it (sent as `ref`; a pull request from
1329/// outside the repository saves under `untrusted:<ref>`), `version` the
1330/// hash of its paths and compression (empty for one g1t's own
1331/// `actions/cache` saved).
1332#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1333pub struct CacheEntry {
1334 pub id: u64,
1335 pub key: String,
1336 #[serde(rename = "ref")]
1337 pub git_ref: String,
1338 pub version: String,
1339 pub size_in_bytes: u64,
1340 pub created_at: String,
1341 pub last_accessed_at: String,
1342}
1343
1344/// A page of cache entries, in GitHub's shape.
1345#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1346pub struct CacheList {
1347 pub total_count: u64,
1348 pub actions_caches: Vec<CacheEntry>,
1349}
1350
1351/// How a list of cache entries is ordered: GitHub's `sort` names.
1352pub const CACHE_SORTS: [&str; 3] = ["last_accessed_at", "created_at", "size_in_bytes"];
1353
1354/// `caches`: a repository's saved cache entries, narrowed to keys starting
1355/// with `key` and to one `git_ref`, ordered by `sort` (one of
1356/// `CACHE_SORTS`, `last_accessed_at` by default) in `direction` (`asc` or
1357/// `desc`, the default), a page at a time (30 by default, at most 100).
1358/// Anyone who can see the repository. Returns `Outcome<CacheList>`.
1359#[derive(Debug, Serialize, Deserialize)]
1360pub struct CachesArgs {
1361 pub repo: RepoPath,
1362 pub viewer: Viewer,
1363 #[serde(default)]
1364 pub key: Option<String>,
1365 #[serde(default)]
1366 pub git_ref: Option<String>,
1367 #[serde(default)]
1368 pub sort: Option<String>,
1369 #[serde(default)]
1370 pub direction: Option<String>,
1371 #[serde(default)]
1372 pub page: Option<u32>,
1373 #[serde(default)]
1374 pub per_page: Option<u32>,
1375}
1376
1377/// `cache_usage`: what a repository's saved entries hold together, against
1378/// `CACHE_REPO_QUOTA_BYTES`. Anyone who can see the repository. Returns
1379/// `Outcome<CacheUsage>`.
1380#[derive(Debug, Serialize, Deserialize)]
1381pub struct CacheUsageArgs {
1382 pub repo: RepoPath,
1383 pub viewer: Viewer,
1384}
1385
1386/// GitHub's shape, with the most the repository may hold.
1387#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1388pub struct CacheUsage {
1389 pub active_caches_size_in_bytes: u64,
1390 pub active_caches_count: u64,
1391 pub quota_bytes: u64,
1392}
1393
1394/// `delete_caches`: deletes one entry by `id`, or every entry whose key is
1395/// exactly `key` (only `git_ref`'s, when given). Needs the Write role.
1396/// Returns the entries deleted: `Outcome<CacheList>`.
1397#[derive(Debug, Serialize, Deserialize)]
1398pub struct DeleteCachesArgs {
1399 pub actor: User,
1400 pub repo: RepoPath,
1401 #[serde(default)]
1402 pub id: Option<u64>,
1403 #[serde(default)]
1404 pub key: Option<String>,
1405 #[serde(default)]
1406 pub git_ref: Option<String>,
1407}
1408
1409// ── Artifacts (actions/upload-artifact) ───────────────────────────────────
1410//
1411// Kept in R2 by the API (the ACTIONS_CACHE bucket, under `a/`) and listed
1412// here, by the actions service, which decides names, sizes and how long
1413// each is kept. A sandbox reaches them with its job's token
1414// (`/actions/jobs/{job}/artifacts…`) or, through the toolkit's protocol,
1415// with its runtime token (`ACTIONS_RUNTIME_TOKEN`); people through the
1416// REST API and the run's page.
1417
1418/// The largest one artifact may be.
1419pub const ARTIFACT_MAX_BYTES: u64 = 5 * 1024 * 1024 * 1024;
1420/// What one run's artifacts may hold together.
1421pub const RUN_ARTIFACTS_MAX_BYTES: u64 = 10 * 1024 * 1024 * 1024;
1422/// How long artifacts are kept unless a repository says otherwise.
1423pub const ARTIFACT_RETENTION_DEFAULT_DAYS: u32 = 14;
1424/// The longest a repository may keep them.
1425pub const ARTIFACT_RETENTION_MAX_DAYS: u32 = 90;
1426/// A native upload is sent in parts of this size (the last may be smaller).
1427pub const ARTIFACT_PART_BYTES: u64 = 32 * 1024 * 1024;
1428
1429/// An artifact, as the API and the site show it.
1430#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1431pub struct Artifact {
1432 pub id: u64,
1433 pub name: String,
1434 pub size: u64,
1435 /// `sha256:<hex>`, when the uploader said.
1436 pub digest: Option<String>,
1437 /// `zip`, or `tgz` for one an older runner sent.
1438 pub format: String,
1439 pub run_id: String,
1440 pub job_id: String,
1441 pub repo_id: String,
1442 /// Whether it has expired or been deleted (its bytes are gone).
1443 pub expired: bool,
1444 pub created_at: String,
1445 pub updated_at: String,
1446 pub expires_at: String,
1447 /// The run's branch and commit, for the REST shape.
1448 #[serde(default)]
1449 pub head_branch: Option<String>,
1450 #[serde(default)]
1451 pub head_sha: Option<String>,
1452}
1453
1454/// An artifact with where its bytes are, and a signed token for them.
1455#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1456pub struct ArtifactBlob {
1457 pub artifact: Artifact,
1458 pub object: String,
1459 /// For the toolkit's blob endpoint (`/actions/toolkit/blobs/{blob}`).
1460 pub blob: String,
1461}
1462
1463/// A page of artifacts, in GitHub's shape.
1464#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
1465pub struct ArtifactList {
1466 pub total_count: u64,
1467 pub artifacts: Vec<Artifact>,
1468}
1469
1470/// `artifact_reserve`: a job about to upload an artifact. Refused when its
1471/// run has one of that name and `overwrite` is not set (`conflict`), or it
1472/// is too large. Returns `Outcome<ArtifactReservation>`.
1473#[derive(Debug, Default, Serialize, Deserialize)]
1474pub struct ArtifactReserveArgs {
1475 pub job: String,
1476 /// The job's token, or its runtime token.
1477 pub token: String,
1478 pub name: String,
1479 /// Its size, when known before it is sent (0 otherwise).
1480 #[serde(default)]
1481 pub size: u64,
1482 /// Days to keep it: 0 for the repository's default; at most the
1483 /// repository's setting.
1484 #[serde(default)]
1485 pub retention_days: u32,
1486 /// When to expire it, RFC 3339, as the toolkit says it (in place of
1487 /// `retention_days`).
1488 #[serde(default)]
1489 pub expires_at: Option<String>,
1490 #[serde(default)]
1491 pub overwrite: bool,
1492 /// `zip` (the default) or `tgz`.
1493 #[serde(default)]
1494 pub format: Option<String>,
1495}
1496
1497#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1498pub struct ArtifactReservation {
1499 pub id: u64,
1500 /// Where the API puts it in R2.
1501 pub object: String,
1502 /// The days it will be kept, and until when.
1503 pub retention_days: u32,
1504 pub expires_at: String,
1505}
1506
1507/// `artifact_commit`: its upload is complete, at `size` bytes. The artifact
1508/// is named by `id`, or by `name` in the job's run (the toolkit's way).
1509/// Returns `Outcome<Artifact>`.
1510#[derive(Debug, Default, Serialize, Deserialize)]
1511pub struct ArtifactCommitArgs {
1512 pub job: String,
1513 pub token: String,
1514 #[serde(default)]
1515 pub id: Option<u64>,
1516 #[serde(default)]
1517 pub name: Option<String>,
1518 pub size: u64,
1519 #[serde(default)]
1520 pub digest: Option<String>,
1521}
1522
1523/// `job_artifacts`: a running job listing the artifacts of its own run, or
1524/// of another run of its repository (`run_id`), narrowed by `name` or
1525/// `id`: `Outcome<Vec<Artifact>>`. `job_artifact` gives the one named, with
1526/// a token to download it: `Outcome<ArtifactBlob>`. `job_delete_artifact`
1527/// deletes one of its own run's: `Outcome<Artifact>`. `artifact_abort`
1528/// gives up an upload by `id`: `Outcome<bool>`.
1529#[derive(Debug, Default, Serialize, Deserialize)]
1530pub struct JobArtifactsArgs {
1531 pub job: String,
1532 pub token: String,
1533 #[serde(default)]
1534 pub run_id: Option<String>,
1535 #[serde(default)]
1536 pub name: Option<String>,
1537 #[serde(default)]
1538 pub id: Option<u64>,
1539}
1540
1541/// `artifacts`: a repository's artifacts, newest first, or one run's.
1542/// Anyone who can see the repository. Returns `Outcome<ArtifactList>`.
1543#[derive(Debug, Serialize, Deserialize)]
1544pub struct ArtifactsArgs {
1545 pub repo: RepoPath,
1546 pub viewer: Viewer,
1547 #[serde(default)]
1548 pub run: Option<String>,
1549 #[serde(default)]
1550 pub name: Option<String>,
1551 #[serde(default)]
1552 pub page: Option<u32>,
1553 #[serde(default)]
1554 pub per_page: Option<u32>,
1555}
1556
1557/// `artifact` (`Outcome<Artifact>`) and `artifact_download`
1558/// (`Outcome<ArtifactBlob>`, with a token good for a few minutes): one
1559/// artifact by `id`, or by `name` within `run`. Anyone who can see the
1560/// repository.
1561#[derive(Debug, Serialize, Deserialize)]
1562pub struct ArtifactArgs {
1563 pub repo: RepoPath,
1564 pub viewer: Viewer,
1565 #[serde(default)]
1566 pub id: Option<u64>,
1567 #[serde(default)]
1568 pub run: Option<String>,
1569 #[serde(default)]
1570 pub name: Option<String>,
1571}
1572
1573/// `delete_artifact`: needs the Write role. Returns `Outcome<Artifact>`.
1574#[derive(Debug, Serialize, Deserialize)]
1575pub struct DeleteArtifactArgs {
1576 pub actor: User,
1577 pub repo: RepoPath,
1578 pub id: u64,
1579}
1580
1581/// `artifact_retention`: anyone who can see the repository. With `days`,
1582/// sets it, which needs the Maintain role. Returns
1583/// `Outcome<ArtifactRetention>`.
1584#[derive(Debug, Serialize, Deserialize)]
1585pub struct ArtifactRetentionArgs {
1586 pub repo: RepoPath,
1587 pub viewer: Viewer,
1588 #[serde(default)]
1589 pub days: Option<u32>,
1590}
1591
1592/// GitHub's shape: the days artifacts are kept by default, and the most a
1593/// repository may choose.
1594#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1595pub struct ArtifactRetention {
1596 pub days: u32,
1597 pub maximum_allowed_days: u32,
1598}
1599
1600// ── The toolkit's protocols ───────────────────────────────────────────────
1601//
1602// Actions built on GitHub's toolkit (`@actions/cache`, `@actions/artifact`,
1603// `@actions/core`'s `getIDToken`) reach g1t with the job's runtime token,
1604// `ACTIONS_RUNTIME_TOKEN`: a JSON Web Token whose `scp` names the run and
1605// job, signed with a key derived from the job's own token, so the actions
1606// service checks it without keeping another secret. Cache and artifact
1607// operations above take it in place of the job's token.
1608
1609/// `runtime_auth`: which job a runtime token is, while it runs:
1610/// `Outcome<RuntimeJob>`. `oidc_claims` takes the same and returns
1611/// `Outcome<Value>`: the claims of the job's OIDC token, less `iss`, `aud`,
1612/// `jti` and the times, or `forbidden` when the job's `permissions` do not
1613/// give it `id-token: write`.
1614#[derive(Debug, Serialize, Deserialize)]
1615pub struct RuntimeAuthArgs {
1616 pub job: String,
1617 pub token: String,
1618}
1619
1620#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1621pub struct RuntimeJob {
1622 pub job: String,
1623 pub run: String,
1624 pub repo_id: String,
1625 pub namespace: String,
1626 /// `owner/name`.
1627 pub repository: String,
1628}
1629
1630/// What a signed blob token lets its holder do.
1631#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1632pub struct BlobGrant {
1633 /// `cache` or `artifact`.
1634 pub kind: String,
1635 /// The entry's id: a cache entry's `cache_…`, an artifact's number.
1636 pub id: String,
1637 pub object: String,
1638 /// The R2 upload it sends parts to; `None` for a download.
1639 pub upload: Option<String>,
1640 /// For a download: what to call the file, and its type.
1641 #[serde(default)]
1642 pub filename: Option<String>,
1643 #[serde(default)]
1644 pub content_type: Option<String>,
1645}
1646
1647/// `blob_sign`: a token for uploading an entry the job reserved, to the R2
1648/// upload the API started for it. Returns `Outcome<String>`.
1649#[derive(Debug, Serialize, Deserialize)]
1650pub struct BlobSignArgs {
1651 pub job: String,
1652 pub token: String,
1653 /// `cache` or `artifact`.
1654 pub kind: String,
1655 pub id: String,
1656 pub upload: String,
1657}
1658
1659/// `blob_open`: what a signed token grants, while it is good and its entry
1660/// is there: `Outcome<BlobGrant>`. `blob_part` records a part sent with an
1661/// upload token (`part`, `etag`, `size`): `Outcome<bool>`. `blob_parts`
1662/// gives the parts recorded, in order: `Outcome<Vec<BlobPart>>`, and
1663/// `blob_done` forgets them: `Outcome<bool>`.
1664#[derive(Debug, Default, Serialize, Deserialize)]
1665pub struct BlobArgs {
1666 pub blob: String,
1667 #[serde(default)]
1668 pub part: u32,
1669 #[serde(default)]
1670 pub etag: String,
1671 #[serde(default)]
1672 pub size: u64,
1673}
1674
1675#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
1676pub struct BlobPart {
1677 pub part: u32,
1678 pub etag: String,
1679 pub size: u64,
1680}
1681
1682#[cfg(test)]
1683mod instance_tests {
1684 use super::*;
1685
1686 fn labels(given: &[&str]) -> Vec<String> {
1687 given.iter().map(|l| (*l).to_owned()).collect()
1688 }
1689
1690 #[test]
1691 fn runs_on_picks_the_machine() {
1692 assert_eq!(instance_for(&labels(&["ubuntu-latest"])), STANDARD_INSTANCE);
1693 assert_eq!(instance_for(&labels(&[])).label, "standard");
1694 assert_eq!(instance_for(&labels(&["g1t-4core"])).label, "g1t-4core");
1695 assert_eq!(instance_for(&labels(&["ubuntu-latest", "G1T-2Core"])).label, "g1t-2core");
1696 // Both named: the later one.
1697 assert_eq!(instance_for(&labels(&["g1t-2core", "g1t-4core"])).label, "g1t-4core");
1698 assert_eq!(instance_named("g1t-2core").map(|i| i.vcpu), Some(2.0));
1699 assert_eq!(instance_named("g1t-4core").map(|i| i.vcpu), Some(4.0));
1700 assert_eq!(instance_named("standard"), Some(STANDARD_INSTANCE));
1701 assert_eq!(instance_named("g1t-64core"), None);
1702 }
1703
1704 #[test]
1705 fn every_machine_is_a_named_instance_type_at_its_size() {
1706 // Containers' named instance types, at the sizes Cloudflare gives
1707 // them; no custom types.
1708 let named = |container: &str| match container {
1709 "standard-3" => Some((2.0, 8.0, 16.0)),
1710 "standard-4" => Some((4.0, 12.0, 20.0)),
1711 _ => None,
1712 };
1713 for instance in INSTANCE_TYPES {
1714 assert_eq!(named(instance.container), Some((instance.vcpu, instance.memory_gib, instance.disk_gb)), "{}", instance.label);
1715 }
1716 // g1t-2core is a name of the standard machine, in a class of its own.
1717 let two = instance_named("g1t-2core").unwrap();
1718 assert_eq!(InstanceType { label: "standard", class: "AttemptSandbox", ..two }, STANDARD_INSTANCE);
1719 }
1720
1721 #[test]
1722 fn the_catalogue_is_one_row_a_label_and_one_size_a_machine() {
1723 let mut labels: Vec<_> = INSTANCE_TYPES.iter().map(|i| i.label).collect();
1724 let mut classes: Vec<_> = INSTANCE_TYPES.iter().map(|i| i.class).collect();
1725 labels.sort_unstable();
1726 labels.dedup();
1727 classes.sort_unstable();
1728 classes.dedup();
1729 assert_eq!((labels.len(), classes.len()), (INSTANCE_TYPES.len(), INSTANCE_TYPES.len()));
1730 // Every row of a machine says the same size and price as its first.
1731 for instance in INSTANCE_TYPES {
1732 let first = machine_named(instance.machine).unwrap();
1733 assert_eq!(
1734 (instance.container, instance.vcpu, instance.memory_gib, instance.disk_gb, instance.micros_per_minute),
1735 (first.container, first.vcpu, first.memory_gib, first.disk_gb, first.micros_per_minute),
1736 "{}",
1737 instance.label
1738 );
1739 }
1740 assert_eq!(machines().iter().map(|m| m.machine).collect::<Vec<_>>(), ["2-core", "4-core"]);
1741 assert_eq!(STANDARD_INSTANCE.size(), "2 vCPU, 8 GiB, 16 GB");
1742 assert!((INSTANCE_TYPES[2].price_scale() - 1.75).abs() < 1e-12);
1743 }
1744
1745 #[test]
1746 fn rates_cover_the_machine_at_full_cpu_and_its_usual_cost_plus_the_margin() {
1747 // Memory, disk and the Durable Object behind the container (128 MB)
1748 // for every second, and vCPU as used, at Cloudflare's list prices,
1749 // in micros a minute.
1750 let per_minute = |i: &InstanceType, busy_vcpus: f64| 60.0 * (i.memory_gib * 2.5 + i.disk_gb * 0.07 + 0.125 * 12.5 + busy_vcpus * 20.0);
1751 let tenth_of_a_cent = |micros: f64| ((micros / 1_000.0).ceil() * 1_000.0) as i64;
1752 for instance in machines() {
1753 let usual = per_minute(&instance, instance.vcpu / 2.0) * 1.2;
1754 let full = per_minute(&instance, instance.vcpu);
1755 assert_eq!(instance.micros_per_minute, tenth_of_a_cent(usual).max(tenth_of_a_cent(full)), "{}: {usual} {full}", instance.machine);
1756 assert!(instance.micros_per_minute as f64 >= full, "{}", instance.machine);
1757 }
1758 assert_eq!(STANDARD_INSTANCE.micros_per_minute, 4_000);
1759 assert_eq!(machine_named("4-core").map(|m| m.micros_per_minute), Some(7_000));
1760 }
1761
1762 #[test]
1763 fn the_typescript_mirror_has_every_row() {
1764 let mirror = include_str!("../../../packages/contracts/src/instances.ts");
1765 let rows = mirror.lines().filter(|line| line.trim_start().starts_with("{ label: ")).count();
1766 assert_eq!(rows, INSTANCE_TYPES.len());
1767 for i in INSTANCE_TYPES {
1768 let row = format!(
1769 r#"{{ label: "{}", machine: "{}", sandboxClass: "{}", container: "{}", vcpu: {}, memoryGib: {}, diskGb: {}, microsPerMinute: {} }}"#,
1770 i.label, i.machine, i.class, i.container, i.vcpu, i.memory_gib, i.disk_gb, i.micros_per_minute
1771 );
1772 assert!(mirror.contains(&row), "instances.ts has no row\n{row}");
1773 }
1774 }
1775
1776 #[test]
1777 fn a_job_is_charged_its_minutes_rounded_up() {
1778 assert_eq!(runner_minutes(0), 0);
1779 assert_eq!(runner_minutes(-5), 0);
1780 assert_eq!(runner_minutes(1), 1);
1781 assert_eq!(runner_minutes(60), 1);
1782 assert_eq!(runner_minutes(61), 2);
1783 assert_eq!(runner_minutes(3_600), 60);
1784 }
1785
1786 #[test]
1787 fn start_args_from_older_callers_read() {
1788 let args: StartJobArgs = serde_json::from_value(serde_json::json!({
1789 "job": "job_1", "token": "t", "repo": { "namespace": "acme", "name": "web" }, "timeoutMinutes": 30
1790 }))
1791 .unwrap();
1792 assert!(args.workflow.is_none() && args.environment.is_none() && !args.trusted && args.instance.is_none());
1793 }
1794}
1795
1796#[cfg(test)]
1797mod setting_args_tests {
1798 use super::*;
1799
1800 #[test]
1801 fn who_reads_a_row_is_read_as_the_site_and_api_send_it() {
1802 let args: SetSettingArgs = serde_json::from_value(serde_json::json!({
1803 "actor": { "id": "usr_1", "username": "a" },
1804 "repo": { "namespace": "acme", "name": "web" },
1805 "kind": "secret",
1806 "name": "STRIPE_KEY",
1807 "availableTo": ["deployments"],
1808 "environments": ["production"],
1809 }))
1810 .unwrap();
1811 assert_eq!(args.available_to, Some(vec!["deployments".to_owned()]));
1812 }
1813}