Merge pull request #141 from nikomatsakis/see-also

Implement support for see-also, improve docs

Author: nikomatsakis

.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/rust
+{
+	"name": "Rust",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/rust:1-1-bullseye",
+	"features": {
+		"ghcr.io/eitsupi/devcontainer-features/mdbook:1": {},
+		"ghcr.io/guiyomh/features/just:0": {}
+	}
+
+	// Use 'mounts' to make the cargo cache persistent in a Docker Volume.
+	// "mounts": [
+	// 	{
+	// 		"source": "devcontainer-cargo-cache-${devcontainerId}",
+	// 		"target": "/usr/local/cargo",
+	// 		"type": "volume"
+	// 	}
+	// ]
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "rustc --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

mdbook-goals/src/gh/issues.rs

@@ -118,6 +118,21 @@ pub fn count_issues_matching_search(
     Ok(count_issues)
 }
 
+pub fn fetch_issue(repository: &Repository, issue: u64) -> anyhow::Result<ExistingGithubIssue> {
+    let output = Command::new("gh")
+        .arg("-R")
+        .arg(&repository.to_string())
+        .arg("view")
+        .arg(&format!("{issue}"))
+        .arg("--json")
+        .arg("title,assignees,number,comments,body,state,labels")
+        .output()?;
+
+    let e_i: ExistingGithubIssueJson = serde_json::from_slice(&output.stdout)?;
+
+    Ok(ExistingGithubIssue::from(e_i))
+}
+
 pub fn list_issue_titles_in_milestone(
     repository: &Repository,
     timeframe: &str,
@@ -139,28 +154,7 @@ pub fn list_issue_titles_in_milestone(
 
     Ok(existing_issues
         .into_iter()
-        .map(|e_i| {
-            (
-                e_i.title,
-                ExistingGithubIssue {
-                    number: e_i.number,
-                    assignees: e_i.assignees.into_iter().map(|a| a.login).collect(),
-                    comments: e_i
-                        .comments
-                        .into_iter()
-                        .map(|c| ExistingGithubComment {
-                            author: format!("@{}", c.author.login),
-                            body: c.body,
-                            url: c.url,
-                            created_at: c.created_at,
-                        })
-                        .collect(),
-                    body: e_i.body,
-                    state: e_i.state,
-                    labels: e_i.labels,
-                },
-            )
-        })
+        .map(|e_i| (e_i.title.clone(), ExistingGithubIssue::from(e_i)))
         .collect())
 }
 
@@ -296,3 +290,25 @@ impl ExistingGithubComment {
             .expect("failed to parse date")
     }
 }
+
+impl From<ExistingGithubIssueJson> for ExistingGithubIssue {
+    fn from(e_i: ExistingGithubIssueJson) -> Self {
+        ExistingGithubIssue {
+            number: e_i.number,
+            assignees: e_i.assignees.into_iter().map(|a| a.login).collect(),
+            comments: e_i
+                .comments
+                .into_iter()
+                .map(|c| ExistingGithubComment {
+                    author: format!("@{}", c.author.login),
+                    body: c.body,
+                    url: c.url,
+                    created_at: c.created_at,
+                })
+                .collect(),
+            body: e_i.body,
+            state: e_i.state,
+            labels: e_i.labels,
+        }
+    }
+}

mdbook-goals/src/json.rs

@@ -14,7 +14,7 @@ use crate::{
     gh::{
         issue_id::Repository,
         issues::{
-            count_issues_matching_search, list_issue_titles_in_milestone, CountIssues,
+            count_issues_matching_search, fetch_issue, list_issue_titles_in_milestone, CountIssues,
             ExistingGithubComment, ExistingGithubIssue, ExistingIssueState,
         },
     },
@@ -131,38 +131,66 @@ struct TrackingIssueUpdate {
 ///
 /// Returns a tuple (completed, total) with the number of completed items and the total number of items.
 fn checkboxes(issue: &ExistingGithubIssue) -> anyhow::Result<Progress> {
-    let mut checkboxes = None;
-    let mut issues = None;
+    let mut completed = 0;
+    let mut total = 0;
 
     for line in issue.body.lines() {
         // Does this match TRACKED_ISSUES?
         if let Some(c) = re::TRACKED_ISSUES_QUERY.captures(line) {
-            let repo = Repository::from_str(&c[1])?;
-            let query = &c[2];
-
-            if issues.is_some() {
-                anyhow::bail!("found multiple search queries for Tracked Issues");
-            }
+            let repo = Repository::from_str(&c["repo"])?;
+            let query = &c["query"];
 
             let CountIssues { open, closed } = count_issues_matching_search(&repo, query)?;
-            issues = Some((closed, open + closed));
+            completed += closed;
+            total += open + closed;
+            continue;
         }
 
-        let (checked, total) = checkboxes.unwrap_or((0, 0));
+        if let Some(c) = re::SEE_ALSO_QUERY.captures(line) {
+            let issue_urls = c["issues"].split(&[',', ' ']).filter(|s| !s.is_empty());
+
+            for issue_url in issue_urls {
+                let Some(c) = re::SEE_ALSO_ISSUE.captures(issue_url) else {
+                    anyhow::bail!("invalid issue URL `{issue_url}`")
+                };
+                let repository = Repository::new(&c["org"], &c["repo"]);
+                let issue_number = c["issue"].parse::<u64>()?;
+                let issue = fetch_issue(&repository, issue_number)?;
+                match checkboxes(&issue)? {
+                    Progress::Binary => {
+                        if issue.state == ExistingIssueState::Closed {
+                            completed += 1;
+                        }
+                        total += 1;
+                    }
+
+                    Progress::Tracked {
+                        completed: c,
+                        total: t,
+                    } => {
+                        completed += c;
+                        total += t;
+                    }
+
+                    Progress::Error { message } => {
+                        anyhow::bail!("error parsing {repository}#{issue_number}: {message}")
+                    }
+                }
+            }
+        }
 
         if re::CHECKED_CHECKBOX.is_match(line) {
-            checkboxes = Some((checked + 1, total + 1));
+            total += 1;
+            completed += 1;
         } else if re::CHECKBOX.is_match(line) {
-            checkboxes = Some((checked, total + 1));
+            total += 1;
         }
     }
 
-    match (checkboxes, issues) {
-        (Some((completed, total)), None) | (None, Some((completed, total))) => {
-            Ok(Progress::Tracked { completed, total })
-        }
-        (None, None) => Ok(Progress::Binary),
-        (Some(_), Some(_)) => anyhow::bail!("found both Tracked Issues and checkboxes"),
+    if total == 0 && completed == 0 {
+        Ok(Progress::Binary)
+    } else {
+        Ok(Progress::Tracked { completed, total })
     }
 }
 

mdbook-goals/src/re.rs

@@ -35,5 +35,15 @@ lazy_static! {
 
 lazy_static! {
     pub static ref TRACKED_ISSUES_QUERY: Regex =
-        Regex::new(r"^\| *Tracked +issues *\| *\[([^ ]*) ([^]]*)\]\(.*\) *\| *$").unwrap();
+        Regex::new(r"^\| *Tracked +issues *\| *\[(?P<repo>[^ ]*) (?P<query>[^]]*)\]\(.*\) *\| *$")
+            .unwrap();
+}
+
+lazy_static! {
+    pub static ref SEE_ALSO_QUERY: Regex =
+        Regex::new(r"^\| *See also *\| (?P<issues>[^, ]+,|[^, ] )+ *\| *$").unwrap();
+}
+
+lazy_static! {
+    pub static ref SEE_ALSO_ISSUE: Regex = Regex::new(r"(?P<org>[^#/]*)/(?P<repo>[^#/]*)#(?P<issue>[0-9]+)|https://github.com/(?P<org>[^#/]*)/(?P<repo>[^#/]*)/issues/(?P<issue>[0-9]+)").unwrap();
 }

src/2024h2/Rust-for-SciComp.md

@@ -5,7 +5,8 @@
 | Owner(s)       | @ZuseZ4                            |
 | Teams          | [lang], [compiler]                 |
 | Status         | Accepted                           |
-| Tracking issue | [rust-lang/rust-project-goals#109, rust-lang/rust/issues/124509, rust-lang/rust/issues/124509] |
+| Tracking issue | [rust-lang/rust-project-goals#109] |
+| Other tracking issues | [rust-lang/rust#124509], [rust-lang/rust#124509] |
 
 
 ## Summary