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