Skip to content
Sign in

flagon-io/g1t

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