Skip to content
Sign up

flagon-io/g1t

public
00

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

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