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
790 linesCodeBlameRaw
1//! Security updates: for each vulnerable package with a fix, g1t itself
2//! opens a pull request that raises its version.
3//!
4//! 1. A dependency scan asks the runner for a `bump` (most severe first):
5//! a sandbox raises the package in each lockfile with the ecosystem's
6//! own tool and pushes that to `g1t/security/<package>-<version>`.
7//! 2. That push (`git.push`) opens the pull request, authored by g1t
8//! (`User::system`). It lands through the branch's required checks like
9//! any other. An older one for the same package is closed as superseded.
10//! 3. When its checks fail because code has to change, or the sandbox
11//! never pushed, the pull request is closed and a work item is opened for
12//! g1t to work on, started by g1t. That is the only time an agent is
13//! used.
14//! 4. Once none of the alerts it fixes is open (fixed on the default
15//! branch, or dismissed), its pull request is closed with a comment
16//! saying why and its branch deleted (`resolved`).
17//!
18//! Each step is written to the alerts' activity log.
19
20use std::collections::BTreeMap;
21
22use g1t_contracts::repos::RepoPath;
23use g1t_contracts::security::{BumpArgs, UpdateState, update_branch};
24use g1t_contracts::time::rfc3339;
25use g1t_contracts::work::{
26 CloseReason, CloseWorkItemArgs, OpenPullArgs, Pull, PullActionArgs, PullDetail, PullStatus, Runtime, ViewArgs, WorkItemActionArgs,
27};
28use g1t_contracts::{Outcome, User};
29use g1t_kit::now_ms;
30use g1t_scan::osv::{self, Severity};
31use g1t_scan::version;
32use serde_json::Value;
33use worker::Result;
34
35use g1t_contracts::security::UPDATE_BRANCH_PREFIX;
36use g1t_contracts::updates::{BumpPackage, IgnoreCondition, UpdatedDependency, VersionUpdateEntry, VersionUpdatesState};
37use g1t_contracts::work::UpdatePullArgs;
38
39use crate::Security;
40use crate::config::{CommitMessage, Config, Entry, glob, matches};
41use crate::deps::advisory_table;
42use crate::pull_text;
43use crate::ranges;
44use crate::store::{Activity, RepoRow, UpdateRow, VulnRow};
45use crate::update_store::NewPull;
46use crate::version_updates::{Loaded, package_ecosystem};
47
48/// Security updates asked for per scan, most severe first.
49const MAX_NEW_UPDATES: usize = 8;
50/// A sandbox that has not pushed its branch after this long is taken to
51/// have failed.
52const STALLED_MS: u64 = 45 * 60 * 1000;
53/// A failed update is tried again after this long.
54const RETRY_FAILED_MS: u64 = 24 * 60 * 60 * 1000;
55
56/// What to do about a package's existing update, given the version it
57/// should now reach.
58#[derive(Debug, PartialEq, Eq)]
59pub enum Next {
60 /// Leave it: in flight, done, or someone closed it.
61 Wait,
62 /// Ask for a new one.
63 Request,
64}
65
66/// Whether a package with an update in `state` to `current`, last changed
67/// at `updated_at`, needs a new one to reach `target`. A higher target
68/// always does; the same one only when the last was superseded (it is
69/// vulnerable again) or failed long enough ago.
70pub fn next_step(state: UpdateState, current: &str, target: &str, updated_at: &str, retry_after: &str) -> Next {
71 if version::compare(target, current) == std::cmp::Ordering::Greater {
72 return Next::Request;
73 }
74 match state {
75 UpdateState::Superseded => Next::Request,
76 UpdateState::Failed if updated_at < retry_after => Next::Request,
77 _ => Next::Wait,
78 }
79}
80
81/// Why an update that never pushed failed, as its alert shows it.
82pub fn cannot_raise(package: &str, target: &str) -> String {
83 format!(
84 "`{package}` could not be raised to {target} on its own: a package that depends on it may hold it back, or the upgrade needs code changes."
85 )
86}
87
88/// The pull request's title.
89pub fn pull_title(package: &str, target: &str) -> String {
90 format!("Upgrade {package} to {target}").chars().take(200).collect()
91}
92
93/// The pull request's body: what it fixes, where, and what happens if
94/// raising the version is not enough.
95pub fn pull_text(ecosystem: &str, package: &str, target: &str, vulns: &[&VulnRow]) -> String {
96 let mut from: Vec<&str> = vulns.iter().map(|vuln| vuln.version.as_str()).collect();
97 from.sort();
98 from.dedup();
99 let mut lockfiles: Vec<&str> = vulns.iter().map(|vuln| vuln.manifest.as_str()).collect();
100 lockfiles.sort();
101 lockfiles.dedup();
102 let mut body = format!(
103 "Upgrades `{package}` ({ecosystem}) from {} to **{target}**, which fixes these known vulnerabilities:\n\n",
104 from.join(", ")
105 );
106 body.push_str(&advisory_table(vulns));
107 body.push_str(&format!(
108 "\nLockfiles changed: {}.\n\n\
109 Only the version changes. This pull request lands through this branch's required checks like any other. \
110 If they fail because code has to change, g1t closes it and puts g1t on a work item to make the change.\n\n\
111 ---\n_Opened by g1t's security updates. Turn them off for this project on its Security page._",
112 lockfiles.iter().map(|path| format!("`{path}`")).collect::<Vec<_>>().join(", ")
113 ));
114 body
115}
116
117/// A package a `security-updates` group gathers.
118pub struct GroupMember {
119 /// OSV's name.
120 pub ecosystem: String,
121 pub package: String,
122 /// The lowest vulnerable version found.
123 pub from: String,
124 pub target: String,
125 /// The lockfiles that resolve a vulnerable version.
126 pub manifests: Vec<String>,
127}
128
129fn lowest(vulns: &[&VulnRow]) -> String {
130 vulns.iter().map(|vuln| vuln.version.clone()).min_by(|a, b| version::compare(a, b)).unwrap_or_default()
131}
132
133/// Whether one of the file's directories (`/web`, or a glob) holds the
134/// lockfile at `path`, from the root.
135fn covers(directories: &[String], path: &str) -> bool {
136 let directory = format!("/{}", path.rsplit_once('/').map_or("", |(dir, _)| dir));
137 directories.iter().any(|wanted| if wanted.contains(['*', '?']) { glob(wanted, &directory) } else { *wanted == directory })
138}
139
140/// The `updates` entry that speaks for a vulnerable package: its
141/// ecosystem, a directory holding one of its lockfiles, and no
142/// `target-branch` but the default branch (security updates always go to
143/// the default branch, and such an entry's options are for version
144/// updates only).
145pub fn security_entry<'a>(config: &'a Config, default_branch: &str, osv: &str, manifests: &[&str]) -> Option<&'a Entry> {
146 let ecosystem = package_ecosystem(osv)?;
147 config.updates.iter().find(|entry| {
148 entry.ecosystem == ecosystem
149 && entry.target_branch.as_deref().is_none_or(|branch| branch == default_branch)
150 && manifests.iter().any(|path| covers(&entry.directories, path))
151 })
152}
153
154/// Whether the file lets a security update raise `package` to `target`:
155/// not ignored (by name, or for these versions) in the file or by a
156/// comment, and named by `allow` when it names dependencies.
157pub fn security_allowed(entry: &Entry, comments: &[IgnoreCondition], package: &str, target: &str) -> bool {
158 let ignored = entry.ignore.iter().filter(|rule| matches(&rule.dependency, package)).any(|rule| {
159 (rule.versions.is_empty() && rule.update_types.is_empty()) || rule.versions.iter().any(|versions| ranges::ignored_by(versions, target))
160 });
161 let commented = comments.iter().filter(|c| c.ecosystem == entry.ecosystem && c.dependency.eq_ignore_ascii_case(package)).any(|c| {
162 (c.versions.is_none() && c.update_type.is_none()) || c.versions.as_deref().is_some_and(|versions| ranges::ignored_by(versions, target))
163 });
164 let named: Vec<&str> = entry.allow.iter().filter_map(|rule| rule.dependency.as_deref()).collect();
165 let allowed = named.is_empty() || named.iter().any(|pattern| matches(pattern, package));
166 !ignored && !commented && allowed
167}
168
169/// The `security-updates` group that gathers `package`, if any.
170pub fn security_group(entry: &Entry, package: &str, from: &str, target: &str) -> Option<String> {
171 let level = ranges::update_level(from, target);
172 entry
173 .groups
174 .iter()
175 .filter(|group| group.applies_to == "security-updates")
176 .find(|group| {
177 (group.patterns.is_empty() || group.patterns.iter().any(|pattern| matches(pattern, package)))
178 && !group.exclude_patterns.iter().any(|pattern| matches(pattern, package))
179 && (group.update_types.is_empty() || group.update_types.iter().any(|wanted| wanted == level))
180 })
181 .map(|group| group.name.clone())
182}
183
184/// The entry, as last read, that speaks for a package's security update.
185pub fn security_settings<'a>(state: &'a VersionUpdatesState, osv: &str, manifests: &[&str]) -> Option<&'a VersionUpdateEntry> {
186 let ecosystem = package_ecosystem(osv)?;
187 state.updates.iter().find(|entry| {
188 entry.ecosystem == ecosystem && entry.target_branch.is_none() && manifests.iter().any(|path| covers(&entry.directories, path))
189 })
190}
191
192/// An entry's `commit-message`, as last read.
193pub fn commit_message_of(entry: &VersionUpdateEntry) -> Option<CommitMessage> {
194 let message = entry.options.get("commit-message")?;
195 let text = |key: &str| message.get(key).and_then(Value::as_str).map(str::to_owned);
196 Some(CommitMessage { prefix: text("prefix"), prefix_development: text("prefix-development"), scope: text("include").as_deref() == Some("scope") })
197}
198
199/// A title with the file's commit message prefix, if it has one.
200fn prefixed(prefix: &str, plain: String) -> String {
201 let text = if prefix.is_empty() { plain } else { format!("{prefix}{}{}", plain[..1].to_lowercase(), &plain[1..]) };
202 text.chars().take(200).collect()
203}
204
205/// A grouped security update's body.
206pub fn group_text(group: &str, members: &[GroupMember], vulns: &[&VulnRow], file: &str) -> String {
207 let mut body = format!("Upgrades the {group} group's vulnerable packages to the versions that fix them:\n\n| Package | From | To |\n| --- | --- | --- |\n");
208 for member in members {
209 body.push_str(&format!("| `{}` | {} | **{}** |\n", member.package, member.from, member.target));
210 }
211 body.push_str("\nThe known vulnerabilities they fix:\n\n");
212 body.push_str(&advisory_table(vulns));
213 body.push_str(&format!(
214 "\nOnly the versions change. This pull request lands through this branch's required checks like any other. \
215 If they fail because code has to change, g1t closes it and puts g1t on a work item to make the change.\n\n{}\n\n---\n\
216 _Opened by g1t's security updates, grouped as `{file}` asks. Turn them off for this project on its Security page._",
217 pull_text::COMMANDS
218 ));
219 body
220}
221
222impl Security {
223 pub(crate) fn path_of(repo: &RepoRow) -> RepoPath {
224 RepoPath { namespace: repo.namespace.clone(), name: repo.name.clone() }
225 }
226
227 pub(crate) async fn get_pull(&self, repo: &RepoRow, number: u32) -> Result<Option<Pull>> {
228 let found: Outcome<PullDetail> = g1t_kit::call(
229 &self.work,
230 "get_pull",
231 &ViewArgs { repo: Self::path_of(repo), number, viewer: Some(User::system(&repo.namespace)), after_seq: 0 },
232 )
233 .await?;
234 Ok(found.into_result().ok().map(|detail| detail.pull))
235 }
236
237 /// Closes one of g1t's pull requests, saying why first. Returns
238 /// whether it closed.
239 pub(crate) async fn close_with(&self, repo: &RepoRow, number: u32, why: String) -> Result<bool> {
240 let system = User::system(&repo.namespace);
241 self.comment(&system, &Self::path_of(repo), number, why).await?;
242 let closed: Outcome<Value> = g1t_kit::call(
243 &self.work,
244 "close_pull",
245 &PullActionArgs {
246 actor: system,
247 repo: Self::path_of(repo),
248 number,
249 summary: String::new(),
250 keep_item_open: false,
251 ignore_checks: false,
252 bypass_rules: false,
253 merge_method: None,
254 commit_title: None,
255 commit_message: None,
256 expected_head: None,
257 delete_branch: None,
258 update_method: None,
259 },
260 )
261 .await?;
262 if let Outcome::Fail(refused) = &closed {
263 worker::console_error!("security: #{number} of {} not closed: {}", repo.repo_id, refused.message);
264 }
265 Ok(matches!(closed, Outcome::Ok(_)))
266 }
267
268 /// The slug of the workspace a repository is in.
269 pub(crate) fn workspace_of(repo: &RepoRow) -> String {
270 repo.namespace.to_lowercase()
271 }
272
273 /// Closes a work item g1t opened for an update before it stopped
274 /// opening them, saying why. One already closed is left as it is.
275 pub(crate) async fn close_item_with(&self, repo: &RepoRow, number: u32, why: String) -> Result<()> {
276 let system = User::system(&repo.namespace);
277 let workspace = Self::workspace_of(repo);
278 let item = WorkItemActionArgs { actor: system.clone(), workspace: workspace.clone(), number, reason: Some(CloseReason::NotPlanned) };
279 let closed: Outcome<Value> =
280 g1t_kit::call(&self.work, "close_work_item", &CloseWorkItemArgs { item, repo: None, commit: None }).await?;
281 if matches!(closed, Outcome::Ok(_)) {
282 self.comment_on(&system, None, &workspace, number, why).await?;
283 }
284 Ok(())
285 }
286
287 /// Records `action` on every open alert of an update's package, except
288 /// on an alert whose latest entry already says the same.
289 async fn note(&self, row: &UpdateRow, action: &str, actor: Option<&str>, number: Option<u32>, comment: Option<&str>) -> Result<()> {
290 let ids = self.store.open_ids(&row.repo_id, &row.ecosystem, &row.package).await?;
291 let latest = self.store.latest_activity(&row.repo_id, &ids).await?;
292 let activity: Vec<Activity> = ids
293 .iter()
294 .filter(|id| latest.get(*id).is_none_or(|(last, said)| last != action || said.as_deref() != comment))
295 .map(|id| Activity { alert_id: id, action, actor, reason: None, comment, number })
296 .collect();
297 self.store.record(&row.repo_id, &activity).await
298 }
299
300 /// After a dependency scan: asks for an update for each vulnerable
301 /// package with a fix (when `enabled`). Those no longer needed were
302 /// closed already (`resolved`).
303 ///
304 /// The dependency update file, when there is one, applies as it does to
305 /// version updates: `ignore` and `allow` by name, people's `@g1t ignore`
306 /// comments, `groups` with `applies-to: security-updates` (one pull
307 /// request for each group), and `assignees`, `reviewers` and
308 /// `commit-message`. `open-pull-requests-limit` does not apply.
309 pub async fn security_updates(&self, repo: &RepoRow, enabled: bool, rules: Option<&Loaded>) -> Result<()> {
310 let open = self.store.open_vulnerabilities(&repo.repo_id).await?;
311 let mut by_package: BTreeMap<(String, String), Vec<&VulnRow>> = BTreeMap::new();
312 for vuln in &open {
313 by_package.entry((vuln.ecosystem.clone(), vuln.package.clone())).or_default().push(vuln);
314 }
315 if !enabled {
316 return Ok(());
317 }
318 let mut groups: Vec<((String, String), Vec<&VulnRow>)> = by_package
319 .into_iter()
320 .filter(|(_, vulns)| vulns.iter().any(|vuln| vuln.fixed_version.is_some()))
321 .collect();
322 groups.sort_by_key(|(_, vulns)| std::cmp::Reverse(vulns.iter().map(|v| Severity::parse(&v.severity)).max()));
323 let retry_after = rfc3339(now_ms().saturating_sub(RETRY_FAILED_MS));
324 let comments = self.store.ignores(&repo.repo_id).await?;
325 let mut grouped: BTreeMap<(String, String), Vec<GroupMember>> = BTreeMap::new();
326 let mut asked = 0;
327 for ((ecosystem, package), vulns) in groups {
328 if asked >= MAX_NEW_UPDATES {
329 break;
330 }
331 let Some(target) = osv::upgrade_target(vulns.iter().filter_map(|v| v.fixed_version.as_deref())) else {
332 continue;
333 };
334 let manifests: Vec<&str> = vulns.iter().map(|vuln| vuln.manifest.as_str()).collect();
335 if let Some(entry) = rules.and_then(|loaded| security_entry(&loaded.config, &loaded.default_branch, &ecosystem, &manifests)) {
336 if !security_allowed(entry, &comments, &package, &target) {
337 continue;
338 }
339 let from = lowest(&vulns);
340 if let Some(group) = security_group(entry, &package, &from, &target) {
341 let key = (entry.id(), group);
342 if !grouped.contains_key(&key) {
343 asked += 1;
344 }
345 let manifests = manifests.iter().map(|path| (*path).to_owned()).collect();
346 grouped.entry(key).or_default().push(GroupMember { ecosystem: ecosystem.clone(), package: package.clone(), from, target, manifests });
347 continue;
348 }
349 }
350 match self.store.update(&repo.repo_id, &ecosystem, &package).await? {
351 Some(row) => {
352 if next_step(row.state(), &row.target, &target, &row.updated_at, &retry_after) == Next::Wait {
353 continue;
354 }
355 }
356 None => {
357 // An upgrade work item from before security updates,
358 // still open, is left to the agent on it.
359 if let Some(existing) = self.store.upgrade(&repo.repo_id, &ecosystem, &package).await?
360 && self
361 .item(&User::system(&repo.namespace), &Self::workspace_of(repo), existing.item as u32)
362 .await?
363 .is_some_and(|item| item.state == g1t_contracts::work::State::Open)
364 {
365 continue;
366 }
367 }
368 }
369 asked += 1;
370 self.request(repo, &ecosystem, &package, &target, &vulns).await?;
371 }
372 for ((entry_id, group), members) in grouped {
373 let Some(loaded) = rules else { continue };
374 let Some(entry) = loaded.config.updates.iter().find(|entry| entry.id() == entry_id) else { continue };
375 self.request_group(repo, loaded, entry, &group, members, &open).await?;
376 }
377 Ok(())
378 }
379
380 /// Asks for one pull request for a `security-updates` group's
381 /// packages, unless one for the same versions is under way or was
382 /// closed.
383 async fn request_group(&self, repo: &RepoRow, loaded: &Loaded, entry: &Entry, group: &str, members: Vec<GroupMember>, open: &[VulnRow]) -> Result<()> {
384 let subject = format!("security:{group}");
385 let mut signature: Vec<String> = members.iter().map(|m| format!("{}@{}", m.package, m.target)).collect();
386 signature.sort();
387 let signature = signature.join(",");
388 let existing = self.store.update_pulls(&repo.repo_id).await?;
389 let known = |row: &&crate::update_store::PullRow| row.kind == "security" && row.subject == subject && row.signature == signature;
390 if existing.iter().filter(known).any(|row| row.state().in_progress() || row.state() == UpdateState::Closed) {
391 return Ok(());
392 }
393 let branch = format!("{UPDATE_BRANCH_PREFIX}{}-{}", group.to_lowercase().replace('|', "-"), pull_text::digest(&signature));
394 let vulns: Vec<&VulnRow> = open.iter().filter(|vuln| members.iter().any(|m| m.ecosystem == vuln.ecosystem && m.package == vuln.package)).collect();
395 let count = if members.len() == 1 { "1 security update".to_owned() } else { format!("{} security updates", members.len()) };
396 let title = prefixed(&pull_text::prefix(entry.commit_message.as_ref(), false), format!("Bump the {group} group with {count}"));
397 let body = group_text(group, &members, &vulns, &loaded.file);
398 let mut lockfiles: Vec<String> = members.iter().flat_map(|m| m.manifests.clone()).collect();
399 lockfiles.sort();
400 lockfiles.dedup();
401 let packages: Vec<BumpPackage> = members.iter().map(|m| BumpPackage { package: m.package.clone(), version: m.target.clone() }).collect();
402 let bump = BumpArgs {
403 repo: Self::path_of(repo),
404 ecosystem: members[0].ecosystem.clone(),
405 package: packages[0].package.clone(),
406 version: packages[0].version.clone(),
407 lockfiles,
408 branch: branch.clone(),
409 message: title.clone(),
410 kind: None,
411 packages,
412 strategy: None,
413 force: existing.iter().any(|row| row.branch == branch && row.state().in_progress()),
414 registries: Vec::new(),
415 base: None,
416 };
417 let dependencies: Vec<UpdatedDependency> = members
418 .iter()
419 .map(|m| UpdatedDependency {
420 name: m.package.clone(),
421 from: m.from.clone(),
422 to: m.target.clone(),
423 directory: m.manifests.first().map(|path| format!("/{}", path.rsplit_once('/').map_or("", |(dir, _)| dir))).unwrap_or_else(|| "/".to_owned()),
424 dependency_type: String::new(),
425 update_type: ranges::update_type(&m.from, &m.target),
426 })
427 .collect();
428 let people = |names: &[String]| -> Vec<String> { names.iter().filter(|name| !name.contains('/')).cloned().collect() };
429 let id = self
430 .store
431 .add_update_pull(&NewPull {
432 repo_id: &repo.repo_id,
433 kind: "security",
434 entry: &entry.id(),
435 ecosystem: &entry.ecosystem,
436 subject: &subject,
437 signature: &signature,
438 group: Some(group),
439 branch: &branch,
440 title: &title,
441 body: &body,
442 dependencies: &dependencies,
443 bump: &bump,
444 assignees: &people(&entry.assignees),
445 reviewers: &people(&entry.reviewers),
446 })
447 .await?;
448 for member in &members {
449 self.store.request_update(&repo.repo_id, &member.ecosystem, &member.package, &member.target, &branch).await?;
450 }
451 let started: std::result::Result<(), String> = match g1t_kit::call::<_, Outcome<bool>>(&self.runner, "bump", &bump).await {
452 Ok(Outcome::Ok(_)) => Ok(()),
453 Ok(Outcome::Fail(refused)) => Err(refused.message),
454 Err(error) => Err(format!("the runner could not be reached: {error}")),
455 };
456 for member in &members {
457 let Some(row) = self.store.update(&repo.repo_id, &member.ecosystem, &member.package).await? else { continue };
458 match &started {
459 Ok(()) => self.note(&row, "update_requested", Some(g1t_contracts::system::USERNAME), None, None).await?,
460 Err(reason) => {
461 let error = format!("g1t could not start the security update: {reason}");
462 self.store.set_update(&row, UpdateState::Failed, row.pull(), None, Some(&error)).await?;
463 self.note(&row, "update_failed", Some(g1t_contracts::system::USERNAME), None, Some(&error)).await?;
464 }
465 }
466 }
467 if let Err(reason) = started {
468 self.store.set_update_pull(&id, UpdateState::Failed, None, None, Some(&format!("g1t could not start the security update: {reason}"))).await?;
469 }
470 Ok(())
471 }
472
473 /// Asks the runner to make the change on its branch.
474 async fn request(&self, repo: &RepoRow, ecosystem: &str, package: &str, target: &str, vulns: &[&VulnRow]) -> Result<()> {
475 let branch = update_branch(package, target);
476 let mut lockfiles: Vec<String> = vulns.iter().map(|vuln| vuln.manifest.clone()).collect();
477 lockfiles.sort();
478 lockfiles.dedup();
479 let args = BumpArgs {
480 repo: Self::path_of(repo),
481 ecosystem: ecosystem.to_owned(),
482 package: package.to_owned(),
483 version: target.to_owned(),
484 lockfiles,
485 branch: branch.clone(),
486 message: format!("Upgrade {package} to {target}"),
487 kind: None,
488 packages: Vec::new(),
489 strategy: None,
490 force: false,
491 registries: Vec::new(),
492 base: None,
493 };
494 let started: std::result::Result<(), String> = match g1t_kit::call::<_, Outcome<bool>>(&self.runner, "bump", &args).await {
495 Ok(Outcome::Ok(_)) => Ok(()),
496 Ok(Outcome::Fail(refused)) => Err(refused.message),
497 Err(error) => Err(format!("the runner could not be reached: {error}")),
498 };
499 self.store.request_update(&repo.repo_id, ecosystem, package, target, &branch).await?;
500 let Some(row) = self.store.update(&repo.repo_id, ecosystem, package).await? else {
501 return Ok(());
502 };
503 match started {
504 Ok(()) => self.note(&row, "update_requested", Some(g1t_contracts::system::USERNAME), None, None).await,
505 Err(reason) => {
506 let error = format!("g1t could not start the security update: {reason}");
507 self.store.set_update(&row, UpdateState::Failed, row.pull(), None, Some(&error)).await?;
508 self.note(&row, "update_failed", Some(g1t_contracts::system::USERNAME), None, Some(&error)).await
509 }
510 }
511 }
512
513 /// A security update's branch was pushed: its pull request opens, and
514 /// an older one for the same package is closed as superseded.
515 pub async fn update_pushed(&self, repo_id: &str, branch: &str, after: &str) -> Result<()> {
516 let Some(row) = self.store.update_by_branch(repo_id, branch).await? else {
517 return Ok(());
518 };
519 if row.state() == UpdateState::Superseded && row.pull().is_none() {
520 // No longer needed by the time its sandbox pushed: the branch goes.
521 return self.drop_pushed(repo_id, branch, after).await;
522 }
523 if row.state() != UpdateState::Requested {
524 return Ok(());
525 }
526 let Some(repo) = self.store.repo(repo_id).await? else {
527 return Ok(());
528 };
529 let open = self.store.open_vulnerabilities(repo_id).await?;
530 let vulns: Vec<&VulnRow> = open
531 .iter()
532 .filter(|vuln| vuln.ecosystem == row.ecosystem && vuln.package == row.package)
533 .collect();
534 let system = User::system(&repo.namespace);
535 // What the dependency update file says for this package's directory.
536 let state = repo.version_updates();
537 let manifests: Vec<&str> = vulns.iter().map(|vuln| vuln.manifest.as_str()).collect();
538 let settings = security_settings(&state, &row.ecosystem, &manifests);
539 let prefix = settings.map(|entry| pull_text::prefix(commit_message_of(entry).as_ref(), false)).unwrap_or_default();
540 let opened: Outcome<Pull> = g1t_kit::call(
541 &self.work,
542 "open_pull",
543 &OpenPullArgs {
544 actor: system.clone(),
545 repo: Self::path_of(&repo),
546 item: None,
547 title: prefixed(&prefix, pull_title(&row.package, &row.target)),
548 body: pull_text(&row.ecosystem, &row.package, &row.target, &vulns),
549 branch: Some(branch.to_owned()),
550 head_repo: None,
551 agent: String::new(),
552 runtime: Runtime::External,
553 // Security updates are for the default branch.
554 base: None,
555 draft: false,
556 },
557 )
558 .await?;
559 let pull = match opened {
560 Outcome::Ok(pull) => pull,
561 Outcome::Fail(refused) => {
562 let error = format!("The pull request could not be opened: {}", refused.message);
563 self.store.set_update(&row, UpdateState::Failed, row.pull(), None, Some(&error)).await?;
564 return self.note(&row, "update_failed", Some(g1t_contracts::system::USERNAME), None, Some(&error)).await;
565 }
566 };
567 if let Some(older) = row.pull().filter(|older| *older != pull.number)
568 && let Some(found) = self.get_pull(&repo, older).await?
569 && matches!(found.status, PullStatus::Open | PullStatus::Draft)
570 && self
571 .close_with(&repo, older, format!("Closed: superseded by #{}, which upgrades `{}` to {}.", pull.number, row.package, row.target))
572 .await?
573 && found.branch.as_deref() != Some(branch)
574 {
575 self.delete_pull_branch(&repo, &Pull { status: PullStatus::Closed, ..found }).await;
576 }
577 self.store.set_update(&row, UpdateState::Open, Some(pull.number), None, None).await?;
578 // Labelled as the entry for its directory says, or `dependencies`
579 // and its ecosystem's label; assigned and in a milestone as it says.
580 let ecosystem = package_ecosystem(&row.ecosystem).unwrap_or(row.ecosystem.as_str());
581 let labels = crate::config::update_labels(settings.and_then(|entry| entry.labels.as_deref()), ecosystem);
582 let people = |names: &[String]| -> Vec<String> { names.iter().filter(|name| !name.contains('/')).cloned().collect() };
583 let (assignees, reviewers) = settings.map(|entry| (people(&entry.assignees), people(&entry.reviewers))).unwrap_or_default();
584 if !assignees.is_empty() || !reviewers.is_empty() || !labels.is_empty() {
585 let _: Outcome<Value> = g1t_kit::call(
586 &self.work,
587 "update_pull",
588 &UpdatePullArgs {
589 actor: system.clone(),
590 repo: Self::path_of(&repo),
591 number: pull.number,
592 assignees: (!assignees.is_empty()).then_some(assignees),
593 reviewers: (!reviewers.is_empty()).then_some(reviewers),
594 labels: (!labels.is_empty()).then_some(labels),
595 milestone: None,
596 base: None,
597 },
598 )
599 .await?;
600 }
601 if let Some(milestone) = settings.and_then(|entry| entry.milestone) {
602 let _: Outcome<Value> = g1t_kit::call(
603 &self.work,
604 "update_pull",
605 &UpdatePullArgs {
606 actor: system,
607 repo: Self::path_of(&repo),
608 number: pull.number,
609 assignees: None,
610 reviewers: None,
611 labels: None,
612 milestone: Some(milestone),
613 base: None,
614 },
615 )
616 .await?;
617 }
618 self.note(&row, "update_opened", Some(g1t_contracts::system::USERNAME), Some(pull.number), None).await
619 }
620
621 /// A pull request merged or closed: if it is a security update's, where
622 /// the update stands now. One whose checks fail stays open for a person
623 /// to decide on.
624 pub async fn update_pull_event(&self, kind: &str, repo_id: &str, number: u32, actor: Option<&str>) -> Result<()> {
625 let Some(row) = self.store.update_by_pull(repo_id, number).await? else {
626 return Ok(());
627 };
628 if row.state() != UpdateState::Open {
629 return Ok(());
630 }
631 match kind {
632 "pull.merged" => {
633 self.store.set_update(&row, UpdateState::Merged, Some(number), None, None).await?;
634 self.note(&row, "update_merged", actor, Some(number), None).await
635 }
636 "pull.closed" => {
637 self.store.set_update(&row, UpdateState::Closed, Some(number), None, None).await?;
638 self.note(&row, "update_closed", actor, Some(number), None).await
639 }
640 _ => Ok(()),
641 }
642 }
643
644 /// Updates whose sandbox never pushed: raising the version did not
645 /// work on its own, so the update fails with why, shown on the alert,
646 /// and is tried again later. Nothing is opened for it: a person can ask
647 /// g1t to fix the alert. On a repository that takes no updates now
648 /// (security updates off, archived or deleted) the reason is that
649 /// instead.
650 pub async fn stalled_updates(&self) -> Result<()> {
651 let before = rfc3339(now_ms().saturating_sub(STALLED_MS));
652 for row in self.store.stalled_updates(&before, 10).await? {
653 let Some(repo) = self.store.repo(&row.repo_id).await? else { continue };
654 let waits = if repo.upkeep == 0 { Some("The version could not be raised in a sandbox.".to_owned()) } else { self.takes_updates(&repo).await?.err() };
655 if let Some(why) = waits {
656 self.store.set_update(&row, UpdateState::Failed, row.pull(), None, Some(&why)).await?;
657 continue;
658 }
659 let why = cannot_raise(&row.package, &row.target);
660 self.store.set_update(&row, UpdateState::Failed, row.pull(), None, Some(&why)).await?;
661 self.note(&row, "update_failed", Some(g1t_contracts::system::USERNAME), None, Some(&why)).await?;
662 }
663 // Left from when g1t opened a work item for an upgrade it could not
664 // make: the work item closes, and the update fails as one would now.
665 for row in self.store.needs_code_updates(10).await? {
666 let why = cannot_raise(&row.package, &row.target);
667 if let (Some(repo), Some(number)) = (self.store.repo(&row.repo_id).await?, row.item()) {
668 let path = Self::path_of(&repo);
669 let alerts = format!("/{}/{}/security/vulnerabilities", path.namespace, path.name);
670 self.close_item_with(&repo, number, format!(
671 "g1t no longer opens work items for upgrades it cannot make on its own. This one is on [its alert]({alerts}), \
672 which says why and is tried again later."
673 ))
674 .await?;
675 }
676 self.store.set_update(&row, UpdateState::Failed, row.pull(), None, Some(&why)).await?;
677 self.note(&row, "update_failed", Some(g1t_contracts::system::USERNAME), None, Some(&why)).await?;
678 }
679 Ok(())
680 }
681}
682
683#[cfg(test)]
684mod tests {
685 use super::*;
686
687 fn rules(extra: &str) -> Config {
688 let source = format!(
689 "version: 2\nupdates:\n - package-ecosystem: npm\n directories: [\"/\", \"/apps/*\"]\n schedule: {{interval: weekly}}\n{extra} - package-ecosystem: npm\n directory: /legacy\n target-branch: develop\n schedule: {{interval: weekly}}\n"
690 );
691 let found = crate::config::read(&source);
692 assert!(found.problems.is_empty(), "{:?}", found.problems);
693 found.config
694 }
695
696 #[test]
697 fn security_updates_follow_the_file() {
698 let config = rules(
699 " ignore:\n - dependency-name: left-pad\n - dependency-name: react\n versions: [\">=19\"]\n groups:\n fixes:\n applies-to: security-updates\n patterns: [\"@babel/*\"]\n update-types: [patch, minor]\n minor:\n patterns: [\"*\"]\n",
700 );
701 let entry = security_entry(&config, "main", "npm", &["apps/web/package-lock.json"]).unwrap();
702 assert_eq!(entry.id(), "npm:/,/apps/*");
703 // An entry for another branch never speaks for security updates.
704 assert!(security_entry(&config, "main", "npm", &["legacy/package-lock.json"]).is_none());
705 assert!(security_entry(&config, "main", "crates.io", &["Cargo.lock"]).is_none());
706 assert!(!security_allowed(entry, &[], "left-pad", "1.3.0"));
707 assert!(!security_allowed(entry, &[], "react", "19.0.1"));
708 assert!(security_allowed(entry, &[], "react", "18.3.1"));
709 let comment = IgnoreCondition { ecosystem: "npm".into(), dependency: "Lodash".into(), versions: None, update_type: None, by: "ana".into(), pull: None, at: String::new() };
710 assert!(!security_allowed(entry, &[comment], "lodash", "4.17.21"));
711 assert_eq!(security_group(entry, "@babel/core", "7.0.0", "7.24.1").as_deref(), Some("fixes"));
712 // A major bump is outside the group's update types, and only security groups count.
713 assert_eq!(security_group(entry, "@babel/core", "6.0.0", "7.24.1"), None);
714 assert_eq!(security_group(entry, "lodash", "4.17.20", "4.17.21"), None);
715 let named = rules(" allow:\n - dependency-name: \"lodash\"\n");
716 let entry = security_entry(&named, "main", "npm", &["package-lock.json"]).unwrap();
717 assert!(security_allowed(entry, &[], "lodash", "4.17.21") && !security_allowed(entry, &[], "minimist", "1.2.6"));
718 }
719
720 #[test]
721 fn grouped_security_updates_say_what_they_fix() {
722 let vuln = row("4.17.20", "4.17.21");
723 let members = vec![GroupMember { ecosystem: "npm".into(), package: "lodash".into(), from: "4.17.20".into(), target: "4.17.21".into(), manifests: vec!["package-lock.json".into()] }];
724 let body = group_text("fixes", &members, &[&vuln], ".github/dependabot.yml");
725 assert!(body.starts_with("Upgrades the fixes group's vulnerable packages"));
726 assert!(body.contains("| `lodash` | 4.17.20 | **4.17.21** |"));
727 assert!(body.contains("GHSA-35jh-r3h4-6jhm") && body.contains("`@g1t rebase`"));
728 assert!(body.ends_with("on its Security page._"));
729 assert_eq!(prefixed("build(deps): ", "Upgrade lodash to 4.17.21".into()), "build(deps): upgrade lodash to 4.17.21");
730 assert_eq!(prefixed("", "Upgrade lodash to 4.17.21".into()), "Upgrade lodash to 4.17.21");
731 }
732
733 fn row(version: &str, fixed: &str) -> VulnRow {
734 VulnRow {
735 id: "vul_1".into(),
736 repo_id: "rep_1".into(),
737 ecosystem: "npm".into(),
738 package: "lodash".into(),
739 version: version.into(),
740 manifest: "web/package-lock.json".into(),
741 osv_id: "GHSA-35jh-r3h4-6jhm".into(),
742 advisory: "GHSA-35jh-r3h4-6jhm".into(),
743 summary: "Command Injection in lodash".into(),
744 severity: "high".into(),
745 fixed_version: Some(fixed.into()),
746 status: "open".into(),
747 found_at: "2026-10-04T00:00:00Z".into(),
748 fixed_at: None,
749 item: None,
750 dismiss_reason: None,
751 dismiss_comment: None,
752 dismissed_by: None,
753 dismissed_at: None,
754 }
755 }
756
757 #[test]
758 fn a_newer_fix_asks_again_and_the_same_one_waits() {
759 let retry = "2026-10-05T00:00:00Z";
760 let at = "2026-10-06T00:00:00Z";
761 assert_eq!(next_step(UpdateState::Open, "4.17.20", "4.17.21", at, retry), Next::Request);
762 assert_eq!(next_step(UpdateState::Open, "4.17.21", "4.17.21", at, retry), Next::Wait);
763 assert_eq!(next_step(UpdateState::Requested, "4.17.21", "4.17.21", at, retry), Next::Wait);
764 assert_eq!(next_step(UpdateState::Merged, "4.17.21", "4.17.21", at, retry), Next::Wait);
765 // A person closed it: left alone until a newer fix.
766 assert_eq!(next_step(UpdateState::Closed, "4.17.21", "4.17.21", at, retry), Next::Wait);
767 assert_eq!(next_step(UpdateState::Closed, "4.17.21", "4.17.22", at, retry), Next::Request);
768 // Vulnerable again after it was no longer needed.
769 assert_eq!(next_step(UpdateState::Superseded, "4.17.21", "4.17.21", at, retry), Next::Request);
770 // Failed: tried again a day later.
771 assert_eq!(next_step(UpdateState::Failed, "4.17.21", "4.17.21", at, retry), Next::Wait);
772 assert_eq!(next_step(UpdateState::Failed, "4.17.21", "4.17.21", "2026-10-04T00:00:00Z", retry), Next::Request);
773 assert_eq!(next_step(UpdateState::NeedsCode, "4.17.21", "4.17.21", at, retry), Next::Wait);
774 }
775
776 #[test]
777 fn the_pull_request_says_what_it_fixes_and_where() {
778 let a = row("4.17.20", "4.17.21");
779 let mut b = row("4.17.19", "4.17.21");
780 b.manifest = "package-lock.json".into();
781 let body = pull_text("npm", "lodash", "4.17.21", &[&a, &b]);
782 assert!(body.starts_with("Upgrades `lodash` (npm) from 4.17.19, 4.17.20 to **4.17.21**"));
783 assert!(body.contains("[GHSA-35jh-r3h4-6jhm](https://osv.dev/vulnerability/GHSA-35jh-r3h4-6jhm)"));
784 assert!(body.contains("Lockfiles changed: `package-lock.json`, `web/package-lock.json`."));
785 assert!(body.contains("required checks"));
786 assert_eq!(pull_title("lodash", "4.17.21"), "Upgrade lodash to 4.17.21");
787 assert_eq!(update_branch("@babel/core", "7.24.1"), "g1t/security/babel-core-7.24.1");
788 assert_eq!(update_branch("golang.org/x/net", "v0.23.0"), "g1t/security/golang.org-x-net-v0.23.0");
789 }
790}