display goal progress with a tracking bar

Author: nikomatsakis

.gitignore

@@ -1,3 +1,4 @@
 book
 target
 .cache
+src/api

book.toml

@@ -27,6 +27,7 @@ command = "cargo run -p mdbook-goals --"
 git-repository-url = "https://github.com/rust-lang/rust-project-goals"
 edit-url-template = "https://github.com/rust-lang/rust-project-goals/edit/main/{path}"
 site-url = "/rust-project-goals/"
+additional-js = ["src/update-progress-bars.js"]
 
 [output.html.fold]
 enable = true

justfile

@@ -0,0 +1,8 @@
+api:
+    cargo run -- json 2024h2 --json-path src/api/2024h2.json
+    
+serve: api
+    mdbook serve
+
+build: api
+    mdbook build

mdbook-goals/src/gh/issue_id.rs

@@ -1,21 +1,62 @@
-use crate::re::TRACKING_ISSUE;
+use crate::re::{REPOSITORY, TRACKING_ISSUE};
 use std::fmt::Display;
 
+#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug)]
+pub struct Repository {
+    /// Something like `rust-lang`
+    pub org: String,
+
+    /// Something like `rust-project-goals`
+    pub repo: String,
+}
+
+impl Repository {
+    pub fn new(org: &(impl Display + ?Sized), repo: &(impl Display + ?Sized)) -> Self {
+        Self {
+            org: org.to_string(),
+            repo: repo.to_string(),
+        }
+    }
+}
+
+impl std::fmt::Display for Repository {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let Repository { org, repo } = self;
+        write!(f, "{org}/{repo}")
+    }
+}
+
+impl std::str::FromStr for Repository {
+    type Err = anyhow::Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let Some(c) = REPOSITORY.captures(s) else {
+            anyhow::bail!("invalid repository `{s}`")
+        };
+
+        Ok(Repository::new(&c[1], &c[2]))
+    }
+}
+
 #[derive(PartialEq, Eq, PartialOrd, Ord, Clone)]
 pub struct IssueId {
-    /// Something like `rust-lang/rust-project-goals`
-    pub repository: String,
+    pub repository: Repository,
 
     /// Something like `22`
     pub number: u64,
 }
 
 impl IssueId {
-    pub fn new(repository: &(impl Display + ?Sized), number: u64) -> Self {
-        Self {
-            repository: repository.to_string(),
+    pub fn new(repository: Repository, number: u64) -> Self {
+        Self { repository, number }
+    }
+
+    pub fn url(&self) -> String {
+        let IssueId {
+            repository: Repository { org, repo },
             number,
-        }
+        } = self;
+        format!("https://github.com/{org}/{repo}/issues/{number}")
     }
 }
 
@@ -27,12 +68,11 @@ impl std::fmt::Debug for IssueId {
 
 impl std::fmt::Display for IssueId {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(
-            f,
-            "[{repository}#{number}]",
-            repository = self.repository,
-            number = self.number,
-        )
+        let IssueId {
+            repository: Repository { org, repo },
+            number,
+        } = self;
+        write!(f, "[{org}/{repo}#{number}]")
     }
 }
 
@@ -44,6 +84,6 @@ impl std::str::FromStr for IssueId {
             anyhow::bail!("invalid issue-id")
         };
 
-        Ok(IssueId::new(&c[1], c[2].parse()?))
+        Ok(IssueId::new(Repository::new(&c[1], &c[2]), c[3].parse()?))
     }
 }

mdbook-goals/src/gh/issues.rs

@@ -8,7 +8,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::util::comma;
 
-use super::labels::GhLabel;
+use super::{issue_id::Repository, labels::GhLabel};
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub struct ExistingGithubIssue {
@@ -78,12 +78,12 @@ impl std::fmt::Display for ExistingIssueState {
 }
 
 pub fn list_issue_titles_in_milestone(
-    repository: &str,
+    repository: &Repository,
     timeframe: &str,
 ) -> anyhow::Result<BTreeMap<String, ExistingGithubIssue>> {
     let output = Command::new("gh")
         .arg("-R")
-        .arg(repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("list")
         .arg("-m")
@@ -124,7 +124,7 @@ pub fn list_issue_titles_in_milestone(
 }
 
 pub fn create_issue(
-    repository: &str,
+    repository: &Repository,
     body: &str,
     title: &str,
     labels: &[String],
@@ -133,7 +133,7 @@ pub fn create_issue(
 ) -> anyhow::Result<()> {
     let output = Command::new("gh")
         .arg("-R")
-        .arg(&repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("create")
         .arg("-b")
@@ -160,15 +160,15 @@ pub fn create_issue(
 }
 
 pub fn sync_assignees(
-    repository: &str,
+    repository: &Repository,
     number: u64,
     remove_owners: &BTreeSet<String>,
     add_owners: &BTreeSet<String>,
 ) -> anyhow::Result<()> {
     let mut command = Command::new("gh");
     command
         .arg("-R")
-        .arg(&repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("edit")
         .arg(number.to_string());
@@ -203,10 +203,10 @@ impl ExistingGithubIssue {
     }
 }
 
-pub fn lock_issue(repository: &str, number: u64) -> anyhow::Result<()> {
+pub fn lock_issue(repository: &Repository, number: u64) -> anyhow::Result<()> {
     let output = Command::new("gh")
         .arg("-R")
-        .arg(repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("lock")
         .arg(number.to_string())
@@ -225,7 +225,7 @@ pub fn lock_issue(repository: &str, number: u64) -> anyhow::Result<()> {
     // Leave a comment explaining what is going on.
     let output = Command::new("gh")
         .arg("-R")
-        .arg(repository)
+        .arg(&repository.to_string())
         .arg("issue")
         .arg("comment")
         .arg(number.to_string())

mdbook-goals/src/gh/labels.rs

@@ -2,17 +2,19 @@ use std::process::Command;
 
 use serde::{Deserialize, Serialize};
 
+use super::issue_id::Repository;
+
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub struct GhLabel {
     pub name: String,
     pub color: String,
 }
 
 impl GhLabel {
-    pub fn list(repository: &str) -> anyhow::Result<Vec<GhLabel>> {
+    pub fn list(repository: &Repository) -> anyhow::Result<Vec<GhLabel>> {
         let output = Command::new("gh")
             .arg("-R")
-            .arg(repository)
+            .arg(&repository.to_string())
             .arg("label")
             .arg("list")
             .arg("--json")
@@ -24,10 +26,10 @@ impl GhLabel {
         Ok(labels)
     }
 
-    pub fn create(&self, repository: &str) -> anyhow::Result<()> {
+    pub fn create(&self, repository: &Repository) -> anyhow::Result<()> {
         let output = Command::new("gh")
             .arg("-R")
-            .arg(repository)
+            .arg(&repository.to_string())
             .arg("label")
             .arg("create")
             .arg(&self.name)

mdbook-goals/src/goal.rs

@@ -6,7 +6,7 @@ use std::{collections::BTreeSet, path::PathBuf};
 use anyhow::Context;
 use regex::Regex;
 
-use crate::gh::issue_id::IssueId;
+use crate::gh::issue_id::{IssueId, Repository};
 use crate::re::USERNAME;
 use crate::team::{self, TeamName};
 use crate::util::{commas, markdown_files};
@@ -232,27 +232,66 @@ pub fn format_team_asks(asks_of_any_team: &[&TeamAsk]) -> anyhow::Result<String>
 }
 
 pub fn format_goal_table(goals: &[&GoalDocument]) -> anyhow::Result<String> {
-    let mut table = vec![vec![
-        "Goal".to_string(),
-        "Owner".to_string(),
-        "Team".to_string(),
-    ]];
-
-    for goal in goals {
-        let teams: BTreeSet<&TeamName> = goal
-            .team_asks
-            .iter()
-            .flat_map(|ask| &ask.teams)
-            .copied()
-            .collect();
-        let teams: Vec<&TeamName> = teams.into_iter().collect();
-        table.push(vec![
-            format!("[{}]({})", goal.metadata.title, goal.link_path.display()),
-            goal.metadata.owners.clone(),
-            commas(&teams),
-        ]);
-    }
+    // If any of the goals have tracking issues, include those in the table.
+    let goal_has_tracking_issue = goals.iter().any(|g| g.metadata.tracking_issue.is_some());
+
+    let mut table;
+
+    if goal_has_tracking_issue {
+        table = vec![vec![
+            "Goal".to_string(),
+            "Owner".to_string(),
+            "Progress".to_string(),
+        ]];
+
+        for goal in goals {
+            // Find the directory in which the goal document is located.
+            // That is our "milestone" directory (e.g., 2024h2).
+            let milestone: &str = goal
+                .path
+                .parent()
+                .unwrap()
+                .file_stem()
+                .unwrap()
+                .to_str()
+                .unwrap();
+
+            let progress_bar = match &goal.metadata.tracking_issue {
+                Some(issue_id @ IssueId { repository: Repository { org, repo }, number }) => format!(
+                    "<a href='{url}' alt='Tracking issue'><progress id='{milestone}:{org}:{repo}:{number}' value='0' max='100'></progress></a>",
+                    url = issue_id.url(),
+                ),
+                None => format!("(no tracking issue)"),
+            };
 
+            table.push(vec![
+                format!("[{}]({})", goal.metadata.title, goal.link_path.display()),
+                goal.metadata.owners.clone(),
+                progress_bar,
+            ]);
+        }
+    } else {
+        table = vec![vec![
+            "Goal".to_string(),
+            "Owner".to_string(),
+            "Team".to_string(),
+        ]];
+
+        for goal in goals {
+            let teams: BTreeSet<&TeamName> = goal
+                .team_asks
+                .iter()
+                .flat_map(|ask| &ask.teams)
+                .copied()
+                .collect();
+            let teams: Vec<&TeamName> = teams.into_iter().collect();
+            table.push(vec![
+                format!("[{}]({})", goal.metadata.title, goal.link_path.display()),
+                goal.metadata.owners.clone(),
+                commas(&teams),
+            ]);
+        }
+    }
     Ok(util::format_table(&table))
 }
 

mdbook-goals/src/json.rs

@@ -11,15 +11,18 @@ use std::path::PathBuf;
 use serde::Serialize;
 
 use crate::{
-    gh::issues::{
-        list_issue_titles_in_milestone, ExistingGithubComment, ExistingGithubIssue,
-        ExistingIssueState,
+    gh::{
+        issue_id::Repository,
+        issues::{
+            list_issue_titles_in_milestone, ExistingGithubComment, ExistingGithubIssue,
+            ExistingIssueState,
+        },
     },
     re,
 };
 
 pub(super) fn generate_json(
-    repository: &str,
+    repository: &Repository,
     milestone: &str,
     json_path: &Option<PathBuf>,
 ) -> anyhow::Result<()> {

mdbook-goals/src/main.rs

@@ -1,4 +1,5 @@
 use anyhow::Context;
+use gh::issue_id::Repository;
 use mdbook::preprocess::{CmdPreprocessor, Preprocessor};
 use mdbook_preprocessor::GoalPreprocessor;
 use regex::Regex;
@@ -27,7 +28,7 @@ struct Opt {
 
     /// Repository to use if applicable
     #[structopt(long, default_value = "rust-lang/rust-project-goals")]
-    repository: String,
+    repository: Repository,
 }
 
 #[derive(StructOpt, Debug)]

mdbook-goals/src/re.rs

@@ -18,7 +18,11 @@ lazy_static! {
 }
 
 lazy_static! {
-    pub static ref TRACKING_ISSUE: Regex = Regex::new(r"\[([^#]*)#([0-9]+)\]").unwrap();
+    pub static ref REPOSITORY: Regex = Regex::new(r"([^#/]*)/([^#/]*)").unwrap();
+}
+
+lazy_static! {
+    pub static ref TRACKING_ISSUE: Regex = Regex::new(r"\[([^#/]*)/([^#/]*)#([0-9]+)\]").unwrap();
 }
 
 lazy_static! {