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
377 linesCodeBlameRaw
1//! Every response the REST routes give, run through the converter the API
2//! sends them with, checked for `camelCase` that would leak out.
3//!
4//! The samples are the reference's example responses, put back into the
5//! `camelCase` the services send (as serde's `rename_all` writes it) and,
6//! where an operation returns a contract type, decoded into that type and
7//! encoded again, so that every field the type has is sent, not only the
8//! ones an example shows.
9
10use g1t_contracts::{access, actions, checks, codeowners, integrations, repos, rules, search, teams, webhooks, work};
11use g1t_kit::wire::{self, USER_KEYED};
12use serde::Serialize;
13use serde::de::DeserializeOwned;
14use serde_json::{Map, Value, json};
15
16use crate::openapi::document;
17use crate::operations::Op;
18use crate::checks::ChecksOp;
19use crate::rules::RulesOp;
20use crate::deploy_keys::DeployKeysOp;
21use crate::coordination::CoordinationOp;
22
23/// A key as `#[serde(rename_all = "camelCase")]` writes it.
24fn camel_key(key: &str) -> String {
25 let mut out = String::with_capacity(key.len());
26 let mut upper = false;
27 for c in key.chars() {
28 if c == '_' {
29 upper = true;
30 } else if upper {
31 out.extend(c.to_uppercase());
32 upper = false;
33 } else {
34 out.push(c);
35 }
36 }
37 out
38}
39
40/// A response as the services send it: `camelCase`, but for the maps the
41/// converter passes through, which are data.
42fn as_services_send(value: &Value) -> Value {
43 match value {
44 Value::Object(fields) => {
45 let mut out = Map::new();
46 for (key, value) in fields {
47 let user_keyed = value.is_object()
48 && (USER_KEYED.contains(&key.as_str()) || key.starts_with("by_"));
49 let value = if user_keyed { value.clone() } else { as_services_send(value) };
50 // A `by_…` map keeps its name in the converter's spelling.
51 let key = if key.starts_with("by_") { key.clone() } else { camel_key(key) };
52 out.insert(key, value);
53 }
54 Value::Object(out)
55 }
56 Value::Array(items) => Value::Array(items.iter().map(as_services_send).collect()),
57 other => other.clone(),
58 }
59}
60
61/// `value` decoded as `T` and encoded again, as the service would send it.
62fn through<T: DeserializeOwned + Serialize>(op: Op, value: Value) -> Value {
63 let decoded: T = serde_json::from_value(value)
64 .unwrap_or_else(|error| panic!("{}: the example is not a {}: {error}", op.name(), std::any::type_name::<T>()));
65 serde_json::to_value(decoded).unwrap()
66}
67
68/// What the service behind an operation sends, from its example.
69fn sample(op: Op, example: &Value) -> Value {
70 // Types serde already writes in `snake_case`: a person, and who has
71 // access. Sent as they are.
72 let as_is = example.clone();
73 match op {
74 Op::Whoami => return through::<g1t_contracts::User>(op, as_is),
75 Op::ListCollaborators => return through::<access::RepoAccess>(op, as_is),
76 Op::AddCollaborator => return through::<access::Added>(op, as_is),
77 Op::UpdateCollaborator => return through::<access::Collaborator>(op, as_is),
78 Op::GetCollaboratorPermission => return through::<access::PermissionInfo>(op, as_is),
79 Op::ListRepoInvitations | Op::ListMyRepoInvitations => {
80 return through::<Vec<access::RepoInvitation>>(op, as_is);
81 }
82 Op::RevokeRepoInvitation | Op::AcceptRepoInvitation | Op::DeclineRepoInvitation => {
83 return through::<access::RepoInvitation>(op, as_is);
84 }
85 Op::ListOutsideCollaborators => return through::<Vec<access::OutsideCollaborator>>(op, as_is),
86 // Members, also `snake_case`.
87 Op::ListMembers => return through::<Vec<g1t_contracts::identity::Member>>(op, as_is),
88 Op::UpdateMember => return through::<g1t_contracts::identity::Member>(op, as_is),
89 Op::RemoveMember | Op::TransferOwnership | Op::LeaveWorkspace => return through::<bool>(op, as_is),
90 // Teams and code owners, also `snake_case`.
91 Op::ListTeams | Op::ListChildTeams | Op::ListUserTeams => return through::<Vec<teams::Team>>(op, as_is),
92 Op::GetTeam | Op::CreateTeam | Op::UpdateTeam | Op::SetTeamReviewAssignment => {
93 return through::<teams::Team>(op, as_is);
94 }
95 Op::ListTeamMembers => return through::<Vec<teams::TeamMember>>(op, as_is),
96 Op::SetTeamMember => return through::<teams::TeamMember>(op, as_is),
97 Op::ListTeamRepos => return through::<Vec<teams::TeamRepo>>(op, as_is),
98 Op::SetTeamRepo => return through::<teams::TeamRepo>(op, as_is),
99 Op::DeleteTeam | Op::RemoveTeamMember | Op::RemoveTeamRepo => return through::<bool>(op, as_is),
100 Op::GetCodeownersErrors => return through::<codeowners::CodeOwnersReport>(op, as_is),
101 // Rulesets travel in `snake_case` between services too.
102 Op::Rules(RulesOp::ListRepoRulesets | RulesOp::ListWorkspaceRulesets) => {
103 return through::<Vec<rules::Ruleset>>(op, as_is);
104 }
105 Op::Rules(
106 RulesOp::GetRepoRuleset
107 | RulesOp::CreateRepoRuleset
108 | RulesOp::UpdateRepoRuleset
109 | RulesOp::GetWorkspaceRuleset
110 | RulesOp::CreateWorkspaceRuleset
111 | RulesOp::UpdateWorkspaceRuleset,
112 ) => return through::<rules::Ruleset>(op, as_is),
113 Op::Rules(RulesOp::GetBranchRules) => return through::<rules::EffectiveRules>(op, as_is),
114 Op::Rules(RulesOp::ListRuleEvaluations | RulesOp::ListWorkspaceRuleEvaluations) => {
115 return through::<rules::EvaluationPage>(op, as_is);
116 }
117 // Built by the API itself.
118 Op::Rules(RulesOp::DeleteRepoRuleset | RulesOp::DeleteWorkspaceRuleset) => return as_is,
119 // Deployments travel in `snake_case` between services too.
120 Op::Deployments(_) => return as_is,
121 // So does telemetry.
122 Op::Telemetry(_) => return as_is,
123 // Artifacts are shaped by the API itself, in `snake_case`.
124 Op::Artifacts(_) => return as_is,
125 // The cache's entries travel in `snake_case` from the actions service.
126 Op::Caches(_) => return as_is,
127 // So are archive links.
128 Op::Archives(_) => return as_is,
129 // Deploy keys travel in `snake_case` from identity.
130 Op::DeployKeys(DeployKeysOp::ListDeployKeys) => return through::<Vec<g1t_contracts::deploy_keys::DeployKey>>(op, as_is),
131 Op::DeployKeys(DeployKeysOp::GetDeployKey | DeployKeysOp::CreateDeployKey) => {
132 return through::<g1t_contracts::deploy_keys::DeployKey>(op, as_is);
133 }
134 Op::DeployKeys(DeployKeysOp::DeleteDeployKey) => return through::<bool>(op, as_is),
135 // Packages are shaped by the API itself, in `snake_case`.
136 Op::Packages(_) => return as_is,
137 // Artifacts are shaped by the API itself, in `snake_case`.
138 Op::Folios(_) => return as_is,
139 // Built by the API itself, in `snake_case`.
140 Op::ListSecurityAlerts => return through::<Vec<crate::alerts::SecurityAlert>>(op, as_is),
141 Op::DismissSecurityAlert | Op::ReopenSecurityAlert => {
142 return through::<crate::alerts::SecurityAlert>(op, as_is);
143 }
144 _ => {}
145 }
146 let mut sent = as_services_send(example);
147 // A pull request's code owners are `snake_case` inside it.
148 if op == Op::GetPullRequest
149 && let Some(code_owners) = example.get("code_owners")
150 {
151 sent["codeOwners"] = code_owners.clone();
152 }
153 match op {
154 Op::GetWorkspace | Op::CreateWorkspace | Op::UpdateWorkspace => through::<g1t_contracts::identity::Workspace>(op, sent),
155 Op::ListRepos | Op::ListForks => through::<Vec<repos::Repo>>(op, sent),
156 Op::SyncFork => through::<repos::SyncedFork>(op, sent),
157 Op::Search => through::<search::SearchResults>(op, sent),
158 Op::GetRepo
159 | Op::CreateRepo
160 | Op::UpdateRepo
161 | Op::TransferRepo
162 | Op::ForkRepo
163 | Op::DetachFork
164 | Op::RenameRepo
165 | Op::RenameBranch
166 | Op::ArchiveRepo
167 | Op::UnarchiveRepo
168 | Op::SetRepoVisibility
169 | Op::RestoreRepo => through::<repos::Repo>(op, sent),
170 Op::CreateBranch | Op::DeleteBranch => through::<repos::Branch>(op, sent),
171 Op::DeleteRepo => through::<repos::DeletedRepo>(op, sent),
172 Op::ListDeletedRepos => through::<Vec<repos::DeletedRepo>>(op, sent),
173 Op::GetRepoSettings | Op::UpdateRepoSettings => through::<work::RepoSettings>(op, sent),
174 Op::ListCheckNames => through::<Vec<work::SeenCheck>>(op, sent),
175 Op::GetMergeQueue => through::<work::QueueView>(op, sent),
176 Op::ListDecisions => through::<Vec<g1t_contracts::decisions::Decision>>(op, sent),
177 Op::RecordDecision => through::<g1t_contracts::decisions::Decision>(op, sent),
178 Op::Why => through::<g1t_contracts::decisions::Why>(op, sent),
179 Op::ListIssues => through::<Vec<work::Issue>>(op, sent),
180 Op::CreateIssue | Op::UpdateIssue | Op::CloseIssue | Op::ReopenIssue => {
181 through::<work::Issue>(op, sent)
182 }
183 Op::GetIssue => through::<work::IssueDetail>(op, sent),
184 Op::ListPullRequests => through::<Vec<work::Pull>>(op, sent),
185 Op::UpdatePullRequest => through::<work::Pull>(op, sent),
186 Op::ListLabels | Op::AddDefaultLabels | Op::ListIssueLabels => through::<Vec<work::Label>>(op, sent),
187 Op::CreateLabel | Op::UpdateLabel => through::<work::Label>(op, sent),
188 Op::ListMilestones => through::<Vec<work::Milestone>>(op, sent),
189 Op::CreateMilestone | Op::UpdateMilestone => through::<work::Milestone>(op, sent),
190 Op::GetMilestone => through::<work::MilestoneDetail>(op, sent),
191 Op::GetPullRequest => through::<work::PullDetail>(op, sent),
192 Op::MarkPullRequestReady
193 | Op::ClosePullRequest
194 | Op::ReopenPullRequest
195 | Op::ConvertPullRequestToDraft
196 | Op::MergePullRequest
197 | Op::EnablePullRequestAutoMerge
198 | Op::DisablePullRequestAutoMerge
199 | Op::DeletePullRequestHeadBranch
200 | Op::RestorePullRequestHeadBranch
201 | Op::RequestReviewers
202 | Op::RemoveRequestedReviewers => {
203 through::<work::Pull>(op, sent)
204 }
205 Op::UpdatePullRequestBranch => through::<repos::PullBranchUpdate>(op, sent),
206 Op::GetPullRequestMergeOptions => through::<work::MergeChoices>(op, sent),
207 Op::ListRepoCommitComments | Op::ListCommitComments => through::<Vec<work::CommitComment>>(op, sent),
208 Op::CreateCommitComment | Op::UpdateCommitComment => through::<work::CommitComment>(op, sent),
209 Op::ListWorkflows => through::<Vec<actions::Workflow>>(op, sent),
210 Op::GetWorkflow => through::<actions::WorkflowDetail>(op, sent),
211 Op::ListWorkflowRuns => through::<Vec<actions::WorkflowRun>>(op, sent),
212 Op::GetWorkflowRun => through::<actions::RunDetail>(op, sent),
213 Op::GetJobLogs => through::<actions::JobLog>(op, sent),
214 Op::DispatchWorkflow | Op::CancelWorkflowRun | Op::RerunWorkflowRun => {
215 through::<actions::WorkflowRun>(op, sent)
216 }
217 Op::ListActionsSecrets | Op::ListActionsVariables => through::<Vec<actions::Setting>>(op, sent),
218 Op::ListRunners => through::<Vec<g1t_contracts::runners::Runner>>(op, sent),
219 Op::ListRunnerGroups => through::<Vec<g1t_contracts::runners::RunnerGroup>>(op, sent),
220 Op::CreateRunnerGroup | Op::UpdateRunnerGroup => through::<g1t_contracts::runners::RunnerGroup>(op, sent),
221 Op::GetRunnerSettings | Op::UpdateRunnerSettings => through::<g1t_contracts::runners::RunnerSettings>(op, sent),
222 Op::CreateRunnerRegistrationToken => through::<g1t_contracts::runners::RegistrationToken>(op, sent),
223 Op::ListWebhooks => through::<Vec<webhooks::Hook>>(op, sent),
224 Op::ListIntegrations => through::<Vec<integrations::Connection>>(op, sent),
225 Op::ListEvents => through::<Vec<g1t_contracts::events::Event>>(op, sent),
226 Op::ListEmails | Op::AddEmail | Op::RemoveEmail | Op::UpdateEmailSettings => {
227 through::<g1t_contracts::accounts::AccountEmails>(op, sent)
228 }
229 Op::ConfirmEmail => through::<g1t_contracts::accounts::EmailConfirmed>(op, sent),
230 Op::ListInvites => through::<g1t_contracts::identity::InvitesOverview>(op, sent),
231 Op::CreateInvite | Op::RevokeInvite | Op::ResendInvite | Op::InviteMember | Op::RevokeWorkspaceInvite => {
232 through::<g1t_contracts::identity::Invite>(op, sent)
233 }
234 Op::ListWorkspaceInvites => through::<Vec<g1t_contracts::identity::Invite>>(op, sent),
235 Op::ListInvitations => through::<Vec<g1t_contracts::identity::WorkspaceInvitation>>(op, sent),
236 Op::ListNotifications => through::<g1t_contracts::inbox::InboxPage>(op, sent),
237 Op::GetNotificationThread | Op::MarkThreadRead | Op::MarkThreadDone | Op::SaveThread | Op::SnoozeThread => {
238 through::<g1t_contracts::inbox::InboxThread>(op, sent)
239 }
240 Op::GetThreadSubscription | Op::SetThreadSubscription | Op::DeleteThreadSubscription => {
241 through::<g1t_contracts::inbox::ThreadSubscription>(op, sent)
242 }
243 Op::Checks(ChecksOp::CreateCommitStatus) => through::<work::CommitStatus>(op, sent),
244 Op::Checks(ChecksOp::ListCommitStatuses) => through::<Vec<work::CommitStatus>>(op, sent),
245 Op::Checks(ChecksOp::GetCombinedStatus) => through::<checks::CombinedStatus>(op, sent),
246 Op::Checks(ChecksOp::CreateCheckRun | ChecksOp::UpdateCheckRun | ChecksOp::GetCheckRun) => {
247 through::<checks::CommitCheckRun>(op, sent)
248 }
249 Op::Checks(ChecksOp::ListCheckRunAnnotations) => through::<Vec<checks::CheckAnnotation>>(op, sent),
250 Op::Checks(ChecksOp::ListCheckRunsForRef) => through::<checks::CheckRunList>(op, sent),
251 Op::Checks(ChecksOp::ListCheckSuitesForRef) => through::<checks::CheckSuiteList>(op, sent),
252 Op::Checks(ChecksOp::GetCheckSuite) => through::<checks::CommitCheckSuite>(op, sent),
253 Op::Coordination(CoordinationOp::StartSession | CoordinationOp::UpdateSession | CoordinationOp::EndSession) => {
254 through::<work::Session>(op, sent)
255 }
256 Op::Coordination(CoordinationOp::GetSession) => through::<work::SessionDetail>(op, sent),
257 Op::Coordination(CoordinationOp::ListSessions) => through::<Vec<work::Session>>(op, sent),
258 Op::Coordination(CoordinationOp::RecordSessionEntries) => through::<work::Recorded>(op, sent),
259 Op::Coordination(CoordinationOp::ClaimIssue) => through::<work::Claimed>(op, sent),
260 Op::Coordination(CoordinationOp::ReleaseClaim | CoordinationOp::HandOffIssue) => through::<work::Claim>(op, sent),
261 Op::Coordination(CoordinationOp::ListClaims) => through::<Vec<work::Claim>>(op, sent),
262 Op::Coordination(CoordinationOp::GetWork) => through::<work::WorkContext>(op, sent),
263 Op::Coordination(CoordinationOp::StartAgentSession) => through::<g1t_contracts::agent_sessions::AgentSessionStarted>(op, sent),
264 _ => sent,
265 }
266}
267
268/// Every key of `example`, as paths, outside the maps passed through.
269fn paths(value: &Value, path: &str, out: &mut Vec<String>) {
270 match value {
271 Value::Object(fields) => {
272 for (key, value) in fields {
273 let here = format!("{path}.{key}");
274 out.push(here.clone());
275 let user_keyed = value.is_object()
276 && (USER_KEYED.contains(&key.as_str()) || key.starts_with("by_"));
277 if !user_keyed {
278 paths(value, &here, out);
279 }
280 }
281 }
282 Value::Array(items) => {
283 for item in items {
284 paths(item, &format!("{path}[]"), out);
285 }
286 }
287 _ => {}
288 }
289}
290
291#[test]
292fn no_route_answers_with_camel_case() {
293 let document = document();
294 let (mut checked, mut converted) = (0, 0);
295 for (path, methods) in document["paths"].as_object().unwrap() {
296 for (method, operation) in methods.as_object().unwrap() {
297 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
298 let tool = operation["x-operation"].as_str().unwrap_or_default();
299 let Some(op) = Op::by_name(tool) else {
300 // Device sign-in, which is written in `snake_case` by hand.
301 assert!(wire::camel_case_keys(example).is_empty(), "{method} {path}");
302 continue;
303 };
304 let mut sample = sample(op, example);
305 // Each person gets their chosen case on the way out (people.rs).
306 crate::people::fill(&mut sample, &std::collections::HashMap::new());
307 converted += wire::camel_case_keys(&sample).len();
308 let sent = wire::snake_case(sample);
309 let leaked = wire::camel_case_keys(&sent);
310 assert!(leaked.is_empty(), "{method} {path} sends {leaked:?}");
311 // The reference shows what is sent: each of its names is one.
312 let (mut shown, mut real) = (Vec::new(), Vec::new());
313 paths(example, "", &mut shown);
314 paths(&sent, "", &mut real);
315 for name in shown {
316 assert!(real.contains(&name), "{method} {path}: the reference shows {name}, which is not sent");
317 }
318 checked += 1;
319 }
320 }
321 assert!(checked >= Op::ALL.len());
322 // The samples are in the services' spelling, so there was something to
323 // convert.
324 assert!(converted > 100, "{converted}");
325}
326
327#[test]
328fn every_route_has_a_sample() {
329 let document = document();
330 for route in crate::rest::ROUTES {
331 if route.no_content() {
332 continue;
333 }
334 let path = route
335 .path
336 .split('/')
337 .map(|segment| match segment.strip_prefix(':') {
338 Some(name) => format!("{{{name}}}"),
339 None => segment.to_owned(),
340 })
341 .collect::<Vec<_>>()
342 .join("/");
343 let example = &document["paths"][&path][route.method.to_lowercase()]["responses"]["200"]
344 ["content"]["application/json"]["example"];
345 assert!(!example.is_null(), "{} {path}", route.method);
346 }
347}
348
349#[test]
350fn errors_and_reports_are_snake_case() {
351 let failure = g1t_contracts::Failure {
352 code: g1t_contracts::FailureCode::NotFound,
353 message: "No such endpoint.".to_owned(),
354 };
355 assert!(wire::camel_case_keys(&wire::snake_case(json!({ "error": failure }))).is_empty());
356}
357
358#[test]
359fn a_job_spec_keeps_github_s_spelling() {
360 let spec = json!({
361 "job": "job_1",
362 "spec": { "runs-on": "ubuntu-latest", "timeoutMinutes": 5 },
363 "workflow": { "env": { "nodeEnv": "x" } },
364 "github": { "eventName": "push", "headRef": "" },
365 "event": { "pull_request": { "headSha": "x" } },
366 "contexts": { "inputs": { "dryRun": true }, "matrix": { "nodeVersion": 20 } },
367 "checkout": { "ref": "main" },
368 "timeoutMinutes": 30,
369 "masks": [],
370 });
371 let sent = wire::snake_case_keeping(spec.clone(), crate::JOB_SPEC_AS_GIVEN);
372 assert_eq!(sent["timeout_minutes"], 30);
373 assert!(sent.get("timeoutMinutes").is_none());
374 for kept in ["spec", "workflow", "github", "event", "contexts", "checkout"] {
375 assert_eq!(sent[kept], spec[kept], "{kept}");
376 }
377}