Rollup merge of #122372 - onur-ozkan:change-id-improvement, r=Mark-Simulacrum

prevent notifying the same changes more than once

Prevents re-reporting of previously notified changes by using the .last-warned-change-id value for change detection.

Resolves #122344
This commit is contained in:
Chris Denton 2024-03-16 18:27:32 +00:00 committed by GitHub
commit 491acfa08d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -7,6 +7,7 @@
use std::io::Write; use std::io::Write;
use std::process; use std::process;
use std::str::FromStr;
use std::{ use std::{
env, env,
fs::{self, OpenOptions}, fs::{self, OpenOptions},
@ -136,16 +137,25 @@ fn check_version(config: &Config) -> Option<String> {
let latest_change_id = CONFIG_CHANGE_HISTORY.last().unwrap().change_id; let latest_change_id = CONFIG_CHANGE_HISTORY.last().unwrap().change_id;
let warned_id_path = config.out.join("bootstrap").join(".last-warned-change-id"); let warned_id_path = config.out.join("bootstrap").join(".last-warned-change-id");
if let Some(id) = config.change_id { if let Some(mut id) = config.change_id {
if id == latest_change_id { if id == latest_change_id {
return None; return None;
} }
if let Ok(last_warned_id) = fs::read_to_string(&warned_id_path) { // Always try to use `change-id` from .last-warned-change-id first. If it doesn't exist,
if latest_change_id.to_string() == last_warned_id { // then use the one from the config.toml. This way we never show the same warnings
return None; // more than once.
if let Ok(t) = fs::read_to_string(&warned_id_path) {
let last_warned_id =
usize::from_str(&t).expect(&format!("{} is corrupted.", warned_id_path.display()));
// We only use the last_warned_id if it exists in `CONFIG_CHANGE_HISTORY`.
// Otherwise, we may retrieve all the changes if it's not the highest value.
// For better understanding, refer to `change_tracker::find_recent_config_change_ids`.
if CONFIG_CHANGE_HISTORY.iter().any(|config| config.change_id == last_warned_id) {
id = last_warned_id;
} }
} };
let changes = find_recent_config_change_ids(id); let changes = find_recent_config_change_ids(id);