optimize tidy check on src/tools/tidy/src/issues.txt

This change applies to the following:

- Handles `is_sorted` in the first iteration without needing a second.
- Fixes line sorting on `--bless`.
- Reads `issues.txt` as str rather than making it part of the source code.

Signed-off-by: onur-ozkan <[email protected]>

Author: onur-ozkan

src/tools/tidy/src/issues.txt

@@ -105,18 +105,27 @@ pub fn check(root_path: &Path, bless: bool, bad: &mut bool) {
 
     // the list of files in ui tests that are allowed to start with `issue-XXXX`
     // BTreeSet because we would like a stable ordering so --bless works
-    let issues_list =
-        include!("issues.txt").map(|path| path.replace("/", std::path::MAIN_SEPARATOR_STR));
-    let issues: Vec<String> = Vec::from(issues_list.clone());
-    let is_sorted = issues.windows(2).all(|w| w[0] < w[1]);
+    let mut prev_line = String::new();
+    let mut is_sorted = true;
+    let allowed_issue_names: BTreeSet<_> = include_str!("issues.txt")
+        .lines()
+        .map(|line| {
+            if *prev_line > *line {
+                is_sorted = false;
+            }
+
+            prev_line = line.to_string();
+            line.to_string()
+        })
+        .collect();
+
     if !is_sorted && !bless {
         tidy_error!(
             bad,
             "`src/tools/tidy/src/issues.txt` is not in order, mostly because you modified it manually,
             please only update it with command `x test tidy --bless`"
         );
     }
-    let allowed_issue_names = BTreeSet::from(issues_list);
 
     let mut remaining_issue_names: BTreeSet<String> = allowed_issue_names.clone();
 
@@ -186,29 +195,19 @@ pub fn check(root_path: &Path, bless: bool, bad: &mut bool) {
     // if there are any file names remaining, they were moved on the fs.
     // our data must remain up to date, so it must be removed from issues.txt
     // do this automatically on bless, otherwise issue a tidy error
-    if bless && !remaining_issue_names.is_empty() {
-        let issues_txt_header = r#"
-/*
-============================================================
-    ⚠️⚠️⚠️NOTHING SHOULD EVER BE ADDED TO THIS LIST⚠️⚠️⚠️
-============================================================
-*/
-[
-"#;
+    if bless && (!remaining_issue_names.is_empty() || !is_sorted) {
         let tidy_src = root_path.join("src/tools/tidy/src");
         // instead of overwriting the file, recreate it and use an "atomic rename"
         // so we don't bork things on panic or a contributor using Ctrl+C
         let blessed_issues_path = tidy_src.join("issues_blessed.txt");
         let mut blessed_issues_txt = fs::File::create(&blessed_issues_path).unwrap();
-        blessed_issues_txt.write(issues_txt_header.as_bytes()).unwrap();
         // If we changed paths to use the OS separator, reassert Unix chauvinism for blessing.
         for filename in allowed_issue_names
             .difference(&remaining_issue_names)
             .map(|s| s.replace(std::path::MAIN_SEPARATOR_STR, "/"))
         {
-            write!(blessed_issues_txt, "\"{filename}\",\n").unwrap();
+            writeln!(blessed_issues_txt, "{filename}").unwrap();
         }
-        write!(blessed_issues_txt, "]\n").unwrap();
         let old_issues_path = tidy_src.join("issues.txt");
         fs::rename(blessed_issues_path, old_issues_path).unwrap();
     } else {