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
466 linesCodeBlameRaw
1//! The actions service: a repository's GitHub Actions workflows, run on
2//! g1t as they are. See `g1t_contracts::actions` for the methods and
3//! `g1t_actions` for how workflows, expressions and filters are read.
4//!
5//! - [`sync`] reads workflow files, at the default branch for the list and
6//! at an event's own commit for its runs.
7//! - [`trigger`] turns events, schedules and manual runs into runs.
8//! - [`plan`] moves a run's jobs along: each waits for the jobs it needs,
9//! is skipped or expanded into its matrix, queued, started in a sandbox
10//! when the workspace has room, and finished by the sandbox's report.
11//! - [`payload`] builds the webhook-shaped `github.event`.
12//! - [`settings`] keeps secrets and variables, and [`broker`] the stand-ins
13//! jobs are given for brokered secrets.
14//! - [`protection`] keeps a repository's workflow settings and its
15//! environments' protection rules, holds jobs at those rules until they
16//! pass, and lets pull requests' runs from outside wait for approval.
17//! - [`cache`] lists `actions/cache` entries, which the API keeps in R2.
18//! - [`reach`] finds the actions and reusable workflows of other
19//! repositories on g1t, and [`registry`] resolves those from GitHub to
20//! commits and keeps their archives, for jobs to download from g1t.
21//! - [`runners`] keeps self-hosted runners, hands them jobs (and agent
22//! work from the runner service) when they ask, and hears back.
23//!
24//! The service acts as the repository's workspace: it reads what the
25//! workspace can read, and a job's `GITHUB_TOKEN` is a token of the
26//! workspace's that reaches the job's repository only, with the scopes its
27//! `permissions:` give it, revoked when the job ends.
28
29mod run_artifacts;
30mod broker;
31mod cache;
32mod limits;
33mod managed;
34mod payload;
35mod plan;
36mod protection;
37mod reach;
38mod registry;
39mod rename;
40mod retention;
41pub mod runtime;
42mod runners;
43mod settings;
44mod sync;
45mod trigger;
46mod views;
47
48use g1t_contracts::access::{self, Capability};
49use g1t_contracts::events::Event;
50use g1t_contracts::identity::{SlugArgs, Workspace};
51use g1t_contracts::repos::{GetArgs, GetByIdArgs, Repo, RepoPath};
52use g1t_contracts::{FailureCode, Membership, Outcome, PrincipalKind, User, Viewer};
53use g1t_kit::{args, reply, rpc_method};
54use g1t_secrets::Sealer;
55use serde::Deserialize;
56use serde_json::Value;
57use worker::wasm_bindgen::JsValue;
58use worker::{Context, D1Database, Env, Fetcher, MessageBatch, MessageExt, Request, Response, Result, ScheduleContext, ScheduledEvent, event};
59
60/// The most workflow files read from a repository.
61pub const MAX_WORKFLOWS: usize = 50;
62/// Jobs on g1t's own machines one workspace may always have running at
63/// once; the rest wait their turn, unless the pool has room (`has_room`).
64pub const RUNNING_PER_WORKSPACE: u32 = 4;
65/// The most one workspace may run at once while the pool has room to spare.
66pub const BURST_PER_WORKSPACE: u32 = 12;
67/// Sandboxes g1t's own machines have between them (services/runner's
68/// wrangler.jsonc: 20 standard, 10 g1t-2core, 30 g1t-4core, which every
69/// public repository's ubuntu-latest jobs run on).
70pub const HOSTED_POOL: u32 = 60;
71/// Kept free while workspaces run past their share, so another workspace's
72/// first jobs still start at once.
73pub const POOL_HEADROOM: u32 = 8;
74
75/// Whether a workspace running `in_workspace` jobs on g1t's machines may
76/// start another while `in_pool` run across every workspace: always within
77/// its share, and past it, up to the burst, while the pool keeps its
78/// headroom.
79pub fn has_room(in_workspace: u32, in_pool: u32) -> bool {
80 in_workspace < RUNNING_PER_WORKSPACE
81 || (in_workspace < BURST_PER_WORKSPACE && in_pool + POOL_HEADROOM < HOSTED_POOL)
82}
83
84/// How long a job waits for a machine when the runner has none for it
85/// (every sandbox of its class taken, or a rollout replacing them) before it
86/// fails saying so. Tried again each minute until then.
87pub const WAIT_FOR_MACHINE_MS: u64 = 30 * 60 * 1000;
88
89/// Whether a job that has waited for a machine since `since` (RFC 3339)
90/// should stop waiting at `now`. One whose start cannot be read waits from
91/// now on.
92pub fn waited_for_a_machine(since: Option<&str>, now: u64) -> bool {
93 since
94 .and_then(g1t_contracts::time::parse_rfc3339)
95 .is_some_and(|since| now.saturating_sub(since) >= WAIT_FOR_MACHINE_MS)
96}
97/// The longest a job on g1t's own machines may run, whatever its
98/// `timeout-minutes`.
99pub const MAX_TIMEOUT_MINUTES: u32 = g1t_actions::workflow::HOSTED_MAX_TIMEOUT_MINUTES;
100/// The longest a job on a self-hosted runner may run: the machine is the
101/// workspace's own, and its time costs nothing.
102pub const SELF_HOSTED_MAX_TIMEOUT_MINUTES: u32 = 24 * 60;
103/// A running job that has said nothing for this long is taken as lost.
104pub const SILENT_MS: u64 = 10 * 60 * 1000;
105/// Schedules pause in a repository that has had no push for this long; the
106/// next push resumes them.
107pub const SCHEDULE_IDLE_MS: u64 = 60 * 24 * 60 * 60 * 1000;
108/// How long a workflow's schedule waits after billing refused to start a
109/// job of one of its scheduled runs, before it tries again.
110pub const SCHEDULE_REFUSED_MS: u64 = 60 * 60 * 1000;
111pub const SITE: &str = "https://g1t.sh";
112pub const API: &str = "https://api.g1t.sh";
113
114#[derive(Deserialize)]
115struct Count {
116 n: u32,
117}
118
119pub fn optional(value: Option<&str>) -> JsValue {
120 value.map_or(JsValue::NULL, JsValue::from)
121}
122
123pub fn fail<T>(code: FailureCode, message: impl Into<String>) -> Outcome<T> {
124 Outcome::fail(code, message)
125}
126
127/// `owner/name` as a path.
128pub fn repo_path(full_name: &str) -> RepoPath {
129 let (namespace, name) = full_name.split_once('/').unwrap_or((full_name, ""));
130 RepoPath {
131 namespace: namespace.to_owned(),
132 name: name.to_owned(),
133 }
134}
135
136pub struct Actions {
137 db: D1Database,
138 repos: Fetcher,
139 work: Fetcher,
140 identity: Fetcher,
141 runner: Fetcher,
142 events: Fetcher,
143 /// Projects: a repository's secrets and variables belong to its project.
144 projects: Fetcher,
145 /// Billing: self-hosted runners' time, recorded at $0, and the
146 /// cache's storage.
147 billing: Fetcher,
148 /// Deployments: a job with an `environment:` deploys to it, and its
149 /// run's deployment is recorded there (plan.rs `report_deployment`).
150 deployments: Fetcher,
151 /// Notify, optional: pages open on a repository hear its runs' jobs
152 /// start and finish (plan.rs `tell_live`). Without it they catch up
153 /// on their own.
154 notify: Option<Fetcher>,
155 /// Where the API keeps cache entries, for deleting evicted ones.
156 cache: Option<worker::Bucket>,
157 /// Seals secrets; absent until `ACTIONS_KEY` is set, when secrets
158 /// cannot be saved.
159 sealer: Option<Sealer>,
160 /// Signs the toolkit's blob links (runtime.rs), from `ACTIONS_KEY`.
161 blob_key: Option<String>,
162 /// Log retention and free workspaces' caps, from wrangler vars (limits.rs).
163 limits: limits::Limits,
164 /// Whether repositories' Actions are on, read once per request.
165 actions_on: protection::ActionsOn,
166}
167
168impl Actions {
169 fn new(env: &Env) -> Result<Self> {
170 Ok(Actions {
171 db: env.d1("DB")?,
172 repos: env.service("REPOS")?,
173 work: env.service("WORK")?,
174 identity: env.service("IDENTITY")?,
175 runner: env.service("RUNNER")?,
176 events: env.service("EVENTS")?,
177 projects: env.service("PROJECTS")?,
178 billing: env.service("BILLING")?,
179 deployments: env.service("DEPLOYMENTS")?,
180 notify: env.service("NOTIFY").ok(),
181 cache: env.bucket("ACTIONS_CACHE").ok(),
182 sealer: env.secret("ACTIONS_KEY").ok().and_then(|key| Sealer::new(&key.to_string())),
183 blob_key: env.secret("ACTIONS_KEY").ok().map(|key| runtime::blob_key(&key.to_string())),
184 limits: limits::Limits::from_env(env),
185 actions_on: protection::ActionsOn::default(),
186 })
187 }
188
189 /// The workspace itself, as the service acts.
190 async fn workspace_actor(&self, slug: &str) -> Result<Option<User>> {
191 let workspace: Option<Workspace> = g1t_kit::call(&self.identity, "get_workspace", &SlugArgs { slug: slug.to_owned() }).await?;
192 Ok(workspace.map(|workspace| User {
193 id: workspace.id,
194 username: workspace.slug.clone(),
195 kind: PrincipalKind::Workspace,
196 verified: true,
197 workspaces: vec![Membership::member(workspace.slug)],
198 ..User::default()
199 }))
200 }
201
202 /// The repository, if the viewer may see it and it is not a pull
203 /// request's working copy.
204 async fn visible_repo(&self, path: &RepoPath, viewer: &Viewer) -> Result<Option<Repo>> {
205 let found: Outcome<Repo> = g1t_kit::call(
206 &self.repos,
207 "get",
208 &GetArgs {
209 path: path.clone(),
210 viewer: viewer.clone(),
211 },
212 )
213 .await?;
214 Ok(found.into_result().ok().filter(|repo| repo.fork_of.is_none()))
215 }
216
217 /// A repository by id, as its workspace sees it.
218 async fn repo_by_id(&self, id: &str) -> Result<Option<(Repo, User)>> {
219 let path: Option<RepoPath> = g1t_kit::call(&self.repos, "path_by_id", &g1t_contracts::repos::PathByIdArgs { id: id.to_owned() }).await?;
220 let Some(path) = path else { return Ok(None) };
221 let Some(actor) = self.workspace_actor(&path.namespace).await? else {
222 return Ok(None);
223 };
224 let found: Outcome<Repo> = g1t_kit::call(
225 &self.repos,
226 "get_by_id",
227 &GetByIdArgs {
228 id: id.to_owned(),
229 viewer: Some(actor.clone()),
230 },
231 )
232 .await?;
233 Ok(found.into_result().ok().filter(|repo| repo.fork_of.is_none()).map(|repo| (repo, actor)))
234 }
235
236 /// The repository at `path`, when `actor` may do `capability` in it:
237 /// not found when they cannot read it, forbidden when their role falls
238 /// short.
239 async fn may(&self, actor: &User, path: &RepoPath, capability: Capability) -> Result<Outcome<Repo>> {
240 let Some(repo) = self.visible_repo(path, &Some(actor.clone())).await? else {
241 return Ok(fail(FailureCode::NotFound, "There is no such repository."));
242 };
243 if !access::can(Some(actor), &repo, capability) {
244 return Ok(fail(
245 FailureCode::Forbidden,
246 access::needs(capability, &format!("{}/{}", repo.namespace, repo.name)),
247 ));
248 }
249 Ok(Outcome::Ok(repo))
250 }
251}
252
253/// Unwraps an `Outcome`, or returns its failure from the enclosing method.
254#[macro_export]
255macro_rules! check {
256 ($outcome:expr) => {
257 match $outcome {
258 g1t_contracts::Outcome::Ok(value) => value,
259 g1t_contracts::Outcome::Fail(refused) => return Ok(g1t_contracts::Outcome::Fail(refused)),
260 }
261 };
262}
263
264#[event(fetch)]
265async fn fetch(mut request: Request, env: Env, _ctx: Context) -> Result<Response> {
266 let Some(method) = rpc_method(&request) else {
267 return Response::error("Not found", 404);
268 };
269 let body: Value = request.json().await?;
270 let service = Actions::new(&env)?;
271 match method.as_str() {
272 "workflows" => reply(&service.workflows(args(body)?).await?),
273 "workflow" => reply(&service.workflow(args(body)?).await?),
274 "runs" => reply(&service.runs(args(body)?).await?),
275 "run" => reply(&service.run(args(body)?).await?),
276 "logs" => reply(&service.logs(args(body)?).await?),
277 "job_log_text" => reply(&service.job_log_text(args(body)?).await?),
278 "run_logs" => reply(&service.run_logs(args(body)?).await?),
279 "summaries" => reply(&service.summaries(args(body)?).await?),
280 "dispatch" => reply(&service.dispatch(args(body)?).await?),
281 "repository_dispatch" => reply(&service.repository_dispatch(args(body)?).await?),
282 "approve_run" => reply(&service.approve_run(args(body)?).await?),
283 "pending_deployments" => reply(&service.pending_deployments(args(body)?).await?),
284 "review_deployments" => reply(&service.review_deployments(args(body)?).await?),
285 "actions_settings" => reply(&service.actions_settings(args(body)?).await?),
286 "set_actions_settings" => reply(&service.set_actions_settings(args(body)?).await?),
287 "workspace_actions_settings" => reply(&service.workspace_actions_settings(args(body)?).await?),
288 "set_workspace_actions_settings" => reply(&service.set_workspace_actions_settings(args(body)?).await?),
289 "environments" => reply(&service.environments(args(body)?).await?),
290 "set_environment" => reply(&service.set_environment(args(body)?).await?),
291 "delete_environment" => reply(&service.delete_environment(args(body)?).await?),
292 "merge_group" => reply(&service.merge_group(args(body)?).await?),
293 "cancel" => reply(&service.cancel(args(body)?).await?),
294 "rerun" => reply(&service.rerun(args(body)?).await?),
295 "set_workflow_enabled" => reply(&service.set_workflow_enabled(args(body)?).await?),
296 "settings" => reply(&service.settings(args(body)?).await?),
297 "set_setting" => reply(&service.set_setting(args(body)?).await?),
298 "delete_setting" => reply(&service.delete_setting(args(body)?).await?),
299 "resolve_settings" => reply(&service.resolve_settings(args(body)?).await?),
300 // Managed workflows: g1t's services' side only.
301 "set_managed_workflow" => reply(&service.set_managed_workflow(args(body)?).await?),
302 "remove_managed_workflow" => reply(&service.remove_managed_workflow(args(body)?).await?),
303 "set_managed_deploy" => reply(&service.set_managed_deploy(args(body)?).await?),
304 // A workspace's managed workflows: its owners'.
305 "workspace_managed_workflows" => reply(&service.workspace_managed_workflows(args(body)?).await?),
306 "set_workspace_managed_workflow" => reply(&service.set_workspace_managed_workflow(args(body)?).await?),
307 "remove_workspace_managed_workflow" => reply(&service.remove_workspace_managed_workflow(args(body)?).await?),
308 "job_spec" => reply(&service.job_spec(args(body)?).await?),
309 "job_auth" => reply(&service.job_auth(args(body)?).await?),
310 "job_action" => reply(&service.job_action(args(body)?).await?),
311 "job_action_archive" => reply(&service.job_action_archive(args(body)?).await?),
312 "check_runs" => reply(&service.check_runs(args(body)?).await?),
313 "job_report" => reply(&service.job_report(args(body)?).await?),
314 // A running job's stand-ins for brokered secrets: the runner
315 // Worker's alone, never passed on by the API.
316 "brokered_secrets" => reply(&service.brokered_secrets(args(body)?).await?),
317 // The same for a self-hosted job's broker requests, which the
318 // runner Worker relays (`POST /actions/jobs/{job}/broker`): with
319 // the job's current token only.
320 "relayed_secrets" => reply(&service.relayed_secrets(args(body)?).await?),
321 // actions/cache, through the API with the job's token.
322 "cache_lookup" => reply(&service.cache_lookup(args(body)?).await?),
323 "cache_reserve" => reply(&service.cache_reserve(args(body)?).await?),
324 "cache_commit" => reply(&service.cache_commit(args(body)?).await?),
325 "cache_abort" => reply(&service.cache_abort(args(body)?).await?),
326 "cache_upload" => reply(&service.cache_upload(args(body)?).await?),
327 // The cache: people's side, listing what is saved and deleting it.
328 "caches" => reply(&service.caches(args(body)?).await?),
329 "cache_usage" => reply(&service.cache_usage(args(body)?).await?),
330 "delete_caches" => reply(&service.delete_caches(args(body)?).await?),
331 // Artifacts: a job's side, with its token or its runtime token.
332 "artifact_reserve" => reply(&service.artifact_reserve(args(body)?).await?),
333 "artifact_commit" => reply(&service.artifact_commit(args(body)?).await?),
334 "artifact_abort" => reply(&service.artifact_abort(args(body)?).await?),
335 "job_artifacts" => reply(&service.job_artifacts(args(body)?).await?),
336 "job_artifact" => reply(&service.job_artifact(args(body)?).await?),
337 "job_delete_artifact" => reply(&service.job_delete_artifact(args(body)?).await?),
338 // Artifacts: people's side.
339 "artifacts" => reply(&service.artifacts(args(body)?).await?),
340 "artifact" => reply(&service.artifact(args(body)?).await?),
341 "artifact_download" => reply(&service.artifact_download(args(body)?).await?),
342 "delete_artifact" => reply(&service.delete_artifact(args(body)?).await?),
343 "artifact_retention" => reply(&service.artifact_retention(args(body)?).await?),
344 // The toolkit's protocols: the runtime token, OIDC, blob links.
345 "runtime_auth" => reply(&service.runtime_auth(args(body)?).await?),
346 "oidc_claims" => reply(&service.oidc_claims(args(body)?).await?),
347 "blob_sign" => reply(&service.blob_sign(args(body)?).await?),
348 "blob_open" => reply(&service.blob_open(args(body)?).await?),
349 "blob_part" => reply(&service.blob_part(args(body)?).await?),
350 "blob_parts" => reply(&service.blob_parts(args(body)?).await?),
351 "blob_done" => reply(&service.blob_done(args(body)?).await?),
352 // Self-hosted runners: people's side.
353 "runners" => reply(&service.runners(args(body)?).await?),
354 "create_registration_token" => reply(&service.create_registration_token(args(body)?).await?),
355 "remove_runner" => reply(&service.remove_runner(args(body)?).await?),
356 // Staff only, from sudo: a workspace's runners, and removing them.
357 "admin_runners" => reply(&service.admin_runners(args(body)?).await?),
358 "admin_remove_runners" => reply(&service.admin_remove_runners(args(body)?).await?),
359 "runner_groups" => reply(&service.runner_groups(args(body)?).await?),
360 "set_runner_group" => reply(&service.set_runner_group(args(body)?).await?),
361 "delete_runner_group" => reply(&service.delete_runner_group(args(body)?).await?),
362 "runner_settings" => reply(&service.runner_settings(args(body)?).await?),
363 "set_runner_settings" => reply(&service.set_runner_settings(args(body)?).await?),
364 // The desktop app's runners, as each app says they are.
365 "report_desktop" => reply(&service.report_desktop(args(body)?).await?),
366 "desktop_runners" => reply(&service.desktop_runners(args(body)?).await?),
367 // The runner's own side, through the API with its credential.
368 "runner_register" => reply(&service.runner_register(args(body)?).await?),
369 "runner_poll" => reply(&service.runner_poll(args(body)?).await?),
370 "runner_finished" => reply(&service.runner_finished(args(body)?).await?),
371 "runner_remove_self" => reply(&service.runner_remove_self(args(body)?).await?),
372 // Agent work, from the runner service.
373 "runner_route" => reply(&service.runner_route(args(body)?).await?),
374 "stuck_jobs" => reply(&service.stuck_jobs(args(body)?).await?),
375 "runner_activity" => reply(&service.runner_activity(args(body)?).await?),
376 "enqueue_task" => reply(&service.enqueue_task(args(body)?).await?),
377 "cancel_task" => reply(&service.cancel_task(args(body)?).await?),
378 _ => Response::error("Unknown method", 404),
379 }
380}
381
382/// Events from the bus, on this service's own queue.
383#[event(queue)]
384async fn queue(batch: MessageBatch<Event>, env: Env, _ctx: Context) -> Result<()> {
385 let service = Actions::new(&env)?;
386 for message in batch.messages()? {
387 // A workspace renamed: its rows move to the slug it has now.
388 if g1t_kit::rename::on_event(&env, &env.d1("DB")?, message.body(), rename::STATEMENTS).await? {
389 message.ack();
390 continue;
391 }
392 // A repository renamed or transferred: its rows follow its new path.
393 if g1t_kit::transfer::on_event(&env, &env.d1("DB")?, message.body(), rename::TRANSFERRED).await? {
394 message.ack();
395 continue;
396 }
397 // A workspace deleted: what it kept for itself goes.
398 if g1t_kit::deleted::on_event(&env.d1("DB")?, message.body(), rename::DELETED).await? {
399 message.ack();
400 continue;
401 }
402 // A repository purged: every row kept for it goes.
403 if g1t_kit::lifecycle::on_purged(&env.d1("DB")?, message.body(), rename::PURGED).await? {
404 message.ack();
405 continue;
406 }
407 // A repository deleted or archived: its runs stop.
408 if let Some(repo_id) = plan::stops_runs(message.body()) {
409 if let Err(error) = service.stop_runs(&repo_id).await {
410 worker::console_error!("actions: event {} failed: {error}", message.body().id);
411 message.retry();
412 continue;
413 }
414 message.ack();
415 continue;
416 }
417 if let Err(error) = service.on_event(message.body()).await {
418 worker::console_error!("actions: event {} failed: {error}", message.body().id);
419 message.retry();
420 continue;
421 }
422 message.ack();
423 }
424 Ok(())
425}
426
427/// Every minute: schedules that fire, jobs waiting for room, and jobs
428/// whose sandbox went quiet.
429#[event(scheduled)]
430async fn scheduled(_event: ScheduledEvent, env: Env, _ctx: ScheduleContext) {
431 match Actions::new(&env) {
432 Ok(service) => {
433 if let Err(error) = service.on_minute(g1t_kit::now_ms()).await {
434 worker::console_error!("actions: the sweep failed: {error}");
435 }
436 }
437 Err(error) => worker::console_error!("actions: could not start: {error}"),
438 }
439}
440
441#[cfg(test)]
442mod room_tests {
443 use super::*;
444
445 #[test]
446 fn a_workspace_always_has_its_share() {
447 assert!(has_room(RUNNING_PER_WORKSPACE - 1, HOSTED_POOL));
448 assert!(!has_room(RUNNING_PER_WORKSPACE, HOSTED_POOL));
449 }
450
451 #[test]
452 fn past_its_share_a_workspace_runs_more_while_the_pool_keeps_its_headroom() {
453 assert!(has_room(RUNNING_PER_WORKSPACE, HOSTED_POOL - POOL_HEADROOM - 1));
454 assert!(!has_room(RUNNING_PER_WORKSPACE, HOSTED_POOL - POOL_HEADROOM));
455 assert!(!has_room(BURST_PER_WORKSPACE, 0));
456 }
457
458 #[test]
459 fn a_job_waits_for_a_machine_for_half_an_hour() {
460 let since = g1t_contracts::time::rfc3339(1_000_000);
461 assert!(!waited_for_a_machine(None, u64::MAX));
462 assert!(!waited_for_a_machine(Some(&since), 1_000_000 + WAIT_FOR_MACHINE_MS - 1));
463 assert!(waited_for_a_machine(Some(&since), 1_000_000 + WAIT_FOR_MACHINE_MS));
464 assert!(!waited_for_a_machine(Some("not a time"), u64::MAX));
465 }
466}