Skip to content
Sign up

flagon-io/g1t

public
0
368 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.
13//! - [`protection`] keeps a repository's workflow settings and its
14//! environments' protection rules, holds jobs at those rules until they
15//! pass, and lets pull requests' runs from outside wait for approval.
16//! - [`cache`] lists `actions/cache` entries, which the API keeps in R2.
17//! - [`reach`] finds the actions and reusable workflows of other
18//! repositories on g1t, and [`registry`] resolves those from GitHub to
19//! commits and keeps their archives, for jobs to download from g1t.
20//! - [`runners`] keeps self-hosted runners, hands them jobs (and agent
21//! work from the runner service) when they ask, and hears back.
22//!
23//! The service acts as the repository's workspace: it reads what the
24//! workspace can read, and a job's `GITHUB_TOKEN` is a token of the
25//! workspace's that reaches the job's repository only, with the scopes its
26//! `permissions:` give it, revoked when the job ends.
27
28mod run_artifacts;
29mod cache;
30mod mirrored;
31mod payload;
32mod plan;
33mod protection;
34mod reach;
35mod registry;
36mod rename;
37pub mod runtime;
38mod runners;
39mod settings;
40mod sync;
41mod trigger;
42mod views;
43
44use g1t_contracts::access::{self, Capability};
45use g1t_contracts::events::Event;
46use g1t_contracts::identity::{SlugArgs, Workspace};
47use g1t_contracts::repos::{GetArgs, GetByIdArgs, Repo, RepoPath};
48use g1t_contracts::{FailureCode, Membership, Outcome, PrincipalKind, User, Viewer};
49use g1t_kit::{args, reply, rpc_method};
50use g1t_secrets::Sealer;
51use serde::Deserialize;
52use serde_json::Value;
53use worker::wasm_bindgen::JsValue;
54use worker::{Context, D1Database, Env, Fetcher, MessageBatch, MessageExt, Request, Response, Result, ScheduleContext, ScheduledEvent, event};
55
56/// The most workflow files read from a repository.
57pub const MAX_WORKFLOWS: usize = 50;
58/// Jobs one workspace may have running at once; the rest wait their turn.
59pub const RUNNING_PER_WORKSPACE: u32 = 4;
60/// The longest a job on g1t's own machines may run, whatever its
61/// `timeout-minutes`.
62pub const MAX_TIMEOUT_MINUTES: u32 = g1t_actions::workflow::HOSTED_MAX_TIMEOUT_MINUTES;
63/// The longest a job on a self-hosted runner may run: the machine is the
64/// workspace's own, and its time costs nothing.
65pub const SELF_HOSTED_MAX_TIMEOUT_MINUTES: u32 = 24 * 60;
66/// A running job that has said nothing for this long is taken as lost.
67pub const SILENT_MS: u64 = 10 * 60 * 1000;
68/// Schedules pause in a repository that has had no push for this long; the
69/// next push resumes them.
70pub const SCHEDULE_IDLE_MS: u64 = 60 * 24 * 60 * 60 * 1000;
71/// How long a workflow's schedule waits after billing refused to start a
72/// job of one of its scheduled runs, before it tries again.
73pub const SCHEDULE_REFUSED_MS: u64 = 60 * 60 * 1000;
74pub const SITE: &str = "https://g1t.sh";
75pub const API: &str = "https://api.g1t.sh";
76
77#[derive(Deserialize)]
78struct Count {
79 n: u32,
80}
81
82pub fn optional(value: Option<&str>) -> JsValue {
83 value.map_or(JsValue::NULL, JsValue::from)
84}
85
86pub fn fail<T>(code: FailureCode, message: impl Into<String>) -> Outcome<T> {
87 Outcome::fail(code, message)
88}
89
90/// `owner/name` as a path.
91pub fn repo_path(full_name: &str) -> RepoPath {
92 let (namespace, name) = full_name.split_once('/').unwrap_or((full_name, ""));
93 RepoPath {
94 namespace: namespace.to_owned(),
95 name: name.to_owned(),
96 }
97}
98
99pub struct Actions {
100 db: D1Database,
101 repos: Fetcher,
102 work: Fetcher,
103 identity: Fetcher,
104 runner: Fetcher,
105 events: Fetcher,
106 /// Projects: a repository's secrets and variables belong to its project.
107 projects: Fetcher,
108 /// Billing: self-hosted runners' time, recorded at $0, and the
109 /// cache's storage.
110 billing: Fetcher,
111 /// Deployments: a job with an `environment:` deploys to it, and its
112 /// run's deployment is recorded there (plan.rs `report_deployment`).
113 deployments: Fetcher,
114 /// Where the API keeps cache entries, for deleting evicted ones.
115 cache: Option<worker::Bucket>,
116 /// Seals secrets; absent until `ACTIONS_KEY` is set, when secrets
117 /// cannot be saved.
118 sealer: Option<Sealer>,
119 /// Signs the toolkit's blob links (runtime.rs), from `ACTIONS_KEY`.
120 blob_key: Option<String>,
121}
122
123impl Actions {
124 fn new(env: &Env) -> Result<Self> {
125 Ok(Actions {
126 db: env.d1("DB")?,
127 repos: env.service("REPOS")?,
128 work: env.service("WORK")?,
129 identity: env.service("IDENTITY")?,
130 runner: env.service("RUNNER")?,
131 events: env.service("EVENTS")?,
132 projects: env.service("PROJECTS")?,
133 billing: env.service("BILLING")?,
134 deployments: env.service("DEPLOYMENTS")?,
135 cache: env.bucket("ACTIONS_CACHE").ok(),
136 sealer: env.secret("ACTIONS_KEY").ok().and_then(|key| Sealer::new(&key.to_string())),
137 blob_key: env.secret("ACTIONS_KEY").ok().map(|key| runtime::blob_key(&key.to_string())),
138 })
139 }
140
141 /// The workspace itself, as the service acts.
142 async fn workspace_actor(&self, slug: &str) -> Result<Option<User>> {
143 let workspace: Option<Workspace> = g1t_kit::call(&self.identity, "get_workspace", &SlugArgs { slug: slug.to_owned() }).await?;
144 Ok(workspace.map(|workspace| User {
145 id: workspace.id,
146 username: workspace.slug.clone(),
147 kind: PrincipalKind::Workspace,
148 verified: true,
149 workspaces: vec![Membership::member(workspace.slug)],
150 ..User::default()
151 }))
152 }
153
154 /// The repository, if the viewer may see it and it is not a pull
155 /// request's working copy.
156 async fn visible_repo(&self, path: &RepoPath, viewer: &Viewer) -> Result<Option<Repo>> {
157 let found: Outcome<Repo> = g1t_kit::call(
158 &self.repos,
159 "get",
160 &GetArgs {
161 path: path.clone(),
162 viewer: viewer.clone(),
163 },
164 )
165 .await?;
166 Ok(found.into_result().ok().filter(|repo| repo.fork_of.is_none()))
167 }
168
169 /// A repository by id, as its workspace sees it.
170 async fn repo_by_id(&self, id: &str) -> Result<Option<(Repo, User)>> {
171 let path: Option<RepoPath> = g1t_kit::call(&self.repos, "path_by_id", &g1t_contracts::repos::PathByIdArgs { id: id.to_owned() }).await?;
172 let Some(path) = path else { return Ok(None) };
173 let Some(actor) = self.workspace_actor(&path.namespace).await? else {
174 return Ok(None);
175 };
176 let found: Outcome<Repo> = g1t_kit::call(
177 &self.repos,
178 "get_by_id",
179 &GetByIdArgs {
180 id: id.to_owned(),
181 viewer: Some(actor.clone()),
182 },
183 )
184 .await?;
185 Ok(found.into_result().ok().filter(|repo| repo.fork_of.is_none()).map(|repo| (repo, actor)))
186 }
187
188 /// The repository at `path`, when `actor` may do `capability` in it:
189 /// not found when they cannot read it, forbidden when their role falls
190 /// short. Agents never may: people and tokens run and change workflows.
191 async fn may(&self, actor: &User, path: &RepoPath, capability: Capability) -> Result<Outcome<Repo>> {
192 if actor.kind == PrincipalKind::Agent {
193 return Ok(fail(FailureCode::Forbidden, "An agent cannot do that. Ask a person."));
194 }
195 let Some(repo) = self.visible_repo(path, &Some(actor.clone())).await? else {
196 return Ok(fail(FailureCode::NotFound, "There is no such repository."));
197 };
198 if !access::can(Some(actor), &repo, capability) {
199 return Ok(fail(
200 FailureCode::Forbidden,
201 access::needs(capability, &format!("{}/{}", repo.namespace, repo.name)),
202 ));
203 }
204 Ok(Outcome::Ok(repo))
205 }
206}
207
208/// Unwraps an `Outcome`, or returns its failure from the enclosing method.
209#[macro_export]
210macro_rules! check {
211 ($outcome:expr) => {
212 match $outcome {
213 g1t_contracts::Outcome::Ok(value) => value,
214 g1t_contracts::Outcome::Fail(refused) => return Ok(g1t_contracts::Outcome::Fail(refused)),
215 }
216 };
217}
218
219#[event(fetch)]
220async fn fetch(mut request: Request, env: Env, _ctx: Context) -> Result<Response> {
221 let Some(method) = rpc_method(&request) else {
222 return Response::error("Not found", 404);
223 };
224 let body: Value = request.json().await?;
225 let service = Actions::new(&env)?;
226 match method.as_str() {
227 "workflows" => reply(&service.workflows(args(body)?).await?),
228 "runs" => reply(&service.runs(args(body)?).await?),
229 "run" => reply(&service.run(args(body)?).await?),
230 "logs" => reply(&service.logs(args(body)?).await?),
231 "job_log_text" => reply(&service.job_log_text(args(body)?).await?),
232 "run_logs" => reply(&service.run_logs(args(body)?).await?),
233 "summaries" => reply(&service.summaries(args(body)?).await?),
234 "dispatch" => reply(&service.dispatch(args(body)?).await?),
235 "repository_dispatch" => reply(&service.repository_dispatch(args(body)?).await?),
236 "approve_run" => reply(&service.approve_run(args(body)?).await?),
237 "pending_deployments" => reply(&service.pending_deployments(args(body)?).await?),
238 "review_deployments" => reply(&service.review_deployments(args(body)?).await?),
239 "actions_settings" => reply(&service.actions_settings(args(body)?).await?),
240 "set_actions_settings" => reply(&service.set_actions_settings(args(body)?).await?),
241 "workspace_actions_settings" => reply(&service.workspace_actions_settings(args(body)?).await?),
242 "set_workspace_actions_settings" => reply(&service.set_workspace_actions_settings(args(body)?).await?),
243 "environments" => reply(&service.environments(args(body)?).await?),
244 "set_environment" => reply(&service.set_environment(args(body)?).await?),
245 "delete_environment" => reply(&service.delete_environment(args(body)?).await?),
246 "merge_group" => reply(&service.merge_group(args(body)?).await?),
247 "cancel" => reply(&service.cancel(args(body)?).await?),
248 "rerun" => reply(&service.rerun(args(body)?).await?),
249 "set_workflow_enabled" => reply(&service.set_workflow_enabled(args(body)?).await?),
250 "settings" => reply(&service.settings(args(body)?).await?),
251 "set_setting" => reply(&service.set_setting(args(body)?).await?),
252 "delete_setting" => reply(&service.delete_setting(args(body)?).await?),
253 "resolve_settings" => reply(&service.resolve_settings(args(body)?).await?),
254 "job_spec" => reply(&service.job_spec(args(body)?).await?),
255 "job_auth" => reply(&service.job_auth(args(body)?).await?),
256 "job_action" => reply(&service.job_action(args(body)?).await?),
257 "job_action_archive" => reply(&service.job_action_archive(args(body)?).await?),
258 "check_runs" => reply(&service.check_runs(args(body)?).await?),
259 "job_report" => reply(&service.job_report(args(body)?).await?),
260 // actions/cache, through the API with the job's token.
261 "cache_lookup" => reply(&service.cache_lookup(args(body)?).await?),
262 "cache_reserve" => reply(&service.cache_reserve(args(body)?).await?),
263 "cache_commit" => reply(&service.cache_commit(args(body)?).await?),
264 "cache_abort" => reply(&service.cache_abort(args(body)?).await?),
265 "cache_upload" => reply(&service.cache_upload(args(body)?).await?),
266 // Artifacts: a job's side, with its token or its runtime token.
267 "artifact_reserve" => reply(&service.artifact_reserve(args(body)?).await?),
268 "artifact_commit" => reply(&service.artifact_commit(args(body)?).await?),
269 "artifact_abort" => reply(&service.artifact_abort(args(body)?).await?),
270 "job_artifacts" => reply(&service.job_artifacts(args(body)?).await?),
271 "job_artifact" => reply(&service.job_artifact(args(body)?).await?),
272 "job_delete_artifact" => reply(&service.job_delete_artifact(args(body)?).await?),
273 // Artifacts: people's side.
274 "artifacts" => reply(&service.artifacts(args(body)?).await?),
275 "artifact" => reply(&service.artifact(args(body)?).await?),
276 "artifact_download" => reply(&service.artifact_download(args(body)?).await?),
277 "delete_artifact" => reply(&service.delete_artifact(args(body)?).await?),
278 "artifact_retention" => reply(&service.artifact_retention(args(body)?).await?),
279 // The toolkit's protocols: the runtime token, OIDC, blob links.
280 "runtime_auth" => reply(&service.runtime_auth(args(body)?).await?),
281 "oidc_claims" => reply(&service.oidc_claims(args(body)?).await?),
282 "blob_sign" => reply(&service.blob_sign(args(body)?).await?),
283 "blob_open" => reply(&service.blob_open(args(body)?).await?),
284 "blob_part" => reply(&service.blob_part(args(body)?).await?),
285 "blob_parts" => reply(&service.blob_parts(args(body)?).await?),
286 "blob_done" => reply(&service.blob_done(args(body)?).await?),
287 // Self-hosted runners: people's side.
288 "runners" => reply(&service.runners(args(body)?).await?),
289 "create_registration_token" => reply(&service.create_registration_token(args(body)?).await?),
290 "remove_runner" => reply(&service.remove_runner(args(body)?).await?),
291 "runner_groups" => reply(&service.runner_groups(args(body)?).await?),
292 "set_runner_group" => reply(&service.set_runner_group(args(body)?).await?),
293 "delete_runner_group" => reply(&service.delete_runner_group(args(body)?).await?),
294 "runner_settings" => reply(&service.runner_settings(args(body)?).await?),
295 "set_runner_settings" => reply(&service.set_runner_settings(args(body)?).await?),
296 // The runner's own side, through the API with its credential.
297 "runner_register" => reply(&service.runner_register(args(body)?).await?),
298 "runner_poll" => reply(&service.runner_poll(args(body)?).await?),
299 "runner_finished" => reply(&service.runner_finished(args(body)?).await?),
300 "runner_remove_self" => reply(&service.runner_remove_self(args(body)?).await?),
301 // Agent work, from the runner service.
302 "runner_route" => reply(&service.runner_route(args(body)?).await?),
303 "stuck_jobs" => reply(&service.stuck_jobs(args(body)?).await?),
304 "runner_activity" => reply(&service.runner_activity(args(body)?).await?),
305 "enqueue_task" => reply(&service.enqueue_task(args(body)?).await?),
306 "cancel_task" => reply(&service.cancel_task(args(body)?).await?),
307 _ => Response::error("Unknown method", 404),
308 }
309}
310
311/// Events from the bus, on this service's own queue.
312#[event(queue)]
313async fn queue(batch: MessageBatch<Event>, env: Env, _ctx: Context) -> Result<()> {
314 let service = Actions::new(&env)?;
315 for message in batch.messages()? {
316 // A workspace renamed: its rows move to the slug it has now.
317 if g1t_kit::rename::on_event(&env, &env.d1("DB")?, message.body(), rename::STATEMENTS).await? {
318 message.ack();
319 continue;
320 }
321 // A repository renamed or transferred: its rows follow its new path.
322 if g1t_kit::transfer::on_event(&env, &env.d1("DB")?, message.body(), rename::TRANSFERRED).await? {
323 message.ack();
324 continue;
325 }
326 // A workspace deleted: what it kept for itself goes.
327 if g1t_kit::deleted::on_event(&env.d1("DB")?, message.body(), rename::DELETED).await? {
328 message.ack();
329 continue;
330 }
331 // A repository purged: every row kept for it goes.
332 if g1t_kit::lifecycle::on_purged(&env.d1("DB")?, message.body(), rename::PURGED).await? {
333 message.ack();
334 continue;
335 }
336 // A repository deleted or archived: its runs stop.
337 if let Some(repo_id) = plan::stops_runs(message.body()) {
338 if let Err(error) = service.stop_runs(&repo_id).await {
339 worker::console_error!("actions: event {} failed: {error}", message.body().id);
340 message.retry();
341 continue;
342 }
343 message.ack();
344 continue;
345 }
346 if let Err(error) = service.on_event(message.body()).await {
347 worker::console_error!("actions: event {} failed: {error}", message.body().id);
348 message.retry();
349 continue;
350 }
351 message.ack();
352 }
353 Ok(())
354}
355
356/// Every minute: schedules that fire, jobs waiting for room, and jobs
357/// whose sandbox went quiet.
358#[event(scheduled)]
359async fn scheduled(_event: ScheduledEvent, env: Env, _ctx: ScheduleContext) {
360 match Actions::new(&env) {
361 Ok(service) => {
362 if let Err(error) = service.on_minute(g1t_kit::now_ms()).await {
363 worker::console_error!("actions: the sweep failed: {error}");
364 }
365 }
366 Err(error) => worker::console_error!("actions: could not start: {error}"),
367 }
368}