generate JSON for consumption by the website etc

Author: nikomatsakis

mdbook-goals/src/gh/issues.rs

@@ -7,6 +7,8 @@ use serde::{Deserialize, Serialize};
 
 use crate::util::comma;
 
+use super::labels::GhLabel;
+
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub struct ExistingGithubIssue {
     pub number: u64,
@@ -15,13 +17,16 @@ pub struct ExistingGithubIssue {
     pub comments: Vec<ExistingGithubComment>,
     pub body: String,
     pub state: ExistingIssueState,
+    pub labels: Vec<GhLabel>,
 }
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub struct ExistingGithubComment {
     /// Just github username, no `@`
     pub author: String,
     pub body: String,
+    pub created_at: String,
+    pub url: String,
 }
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
@@ -32,6 +37,7 @@ struct ExistingGithubIssueJson {
     comments: Vec<ExistingGithubCommentJson>,
     body: String,
     state: ExistingIssueState,
+    labels: Vec<GhLabel>,
 }
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
@@ -44,6 +50,9 @@ struct ExistingGithubAssigneeJson {
 struct ExistingGithubCommentJson {
     body: String,
     author: ExistingGithubAuthorJson,
+    #[serde(rename = "createdAt")]
+    created_at: String,
+    url: String,
 }
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
@@ -72,7 +81,7 @@ pub fn list_issue_titles_in_milestone(
         .arg("-s")
         .arg("all")
         .arg("--json")
-        .arg("title,assignees,number,comments,body,state")
+        .arg("title,assignees,number,comments,body,state,labels")
         .output()?;
 
     let existing_issues: Vec<ExistingGithubIssueJson> = serde_json::from_slice(&output.stdout)?;
@@ -91,10 +100,13 @@ pub fn list_issue_titles_in_milestone(
                         .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,
                 },
             )
         })
@@ -221,3 +233,10 @@ pub fn lock_issue(repository: &str, number: u64) -> anyhow::Result<()> {
 
     Ok(())
 }
+
+impl ExistingGithubComment {
+    /// True if this is one of the special comments that we put on issues.
+    pub fn is_automated_comment(&self) -> bool {
+        self.body.trim() == LOCK_TEXT
+    }
+}

mdbook-goals/src/json.rs

@@ -1,4 +1,121 @@
-pub(super) fn generate_json() {
+//! Generate JSON summarizing the tracking issues.
 
+use std::path::PathBuf;
+
+use serde::Serialize;
+
+use crate::{
+    gh::issues::{list_issue_titles_in_milestone, ExistingGithubComment, ExistingGithubIssue},
+    re,
+};
+
+pub(super) fn generate_json(
+    repository: &str,
+    milestone: &str,
+    json_path: &Option<PathBuf>,
+) -> anyhow::Result<()> {
+    let issues = list_issue_titles_in_milestone(repository, milestone)?;
+
+    let issues = TrackingIssues {
+        issues: issues
+            .into_iter()
+            .map(|(title, issue)| {
+                let (total_checkboxes, checked_checkboxes) = checkboxes(&issue);
+                TrackingIssue {
+                    number: issue.number,
+                    title,
+                    flagship: is_flagship(&issue),
+                    total_checkboxes,
+                    checked_checkboxes,
+                    assignees: issue.assignees.into_iter().collect(),
+                    updates: updates(issue.comments),
+                }
+            })
+            .collect(),
+        repository: repository.to_string(),
+        milestone: milestone.to_string(),
+    };
+
+    if let Some(json_path) = json_path {
+        let json = serde_json::to_string(&issues)?;
+        std::fs::write(json_path, json)?;
+    } else {
+        println!("{}", serde_json::to_string_pretty(&issues)?);
+    }
+
+    Ok(())
+}
+
+#[derive(Serialize)]
+struct TrackingIssues {
+    repository: String,
+    milestone: String,
+    issues: Vec<TrackingIssue>,
+}
+
+#[derive(Serialize)]
+struct TrackingIssue {
+    /// Issue number on the repository
+    number: u64,
+
+    /// Title of the tracking issue
+    title: String,
+
+    /// True if this is a flagship goal
+    flagship: bool,
+
+    /// Total checkboxes appearing in the body (i.e., `* [ ]` or `* [x]`)
+    total_checkboxes: u32,
+
+    /// Checked checkboxes appearing in the body (i.e., `* [x]`)
+    checked_checkboxes: u32,
+
+    /// Set of assigned people
+    assignees: Vec<String>,
+
+    /// Posts that we consider to be status updates, in chronological order
+    updates: Vec<TrackingIssueUpdate>,
 }
 
+#[derive(Serialize)]
+struct TrackingIssueUpdate {
+    pub author: String,
+    pub body: String,
+    #[serde(rename = "createdAt")]
+    pub created_at: String,
+    pub url: String,
+}
+
+fn checkboxes(issue: &ExistingGithubIssue) -> (u32, u32) {
+    let mut total = 0;
+    let mut checked = 0;
+
+    for line in issue.body.lines() {
+        if re::CHECKBOX.is_match(line) {
+            total += 1;
+        }
+
+        if re::CHECKED_CHECKBOX.is_match(line) {
+            checked += 1;
+        }
+    }
+
+    (total, checked)
+}
+
+fn is_flagship(issue: &ExistingGithubIssue) -> bool {
+    issue.labels.iter().any(|label| label.name == "flagship")
+}
+
+fn updates(comments: Vec<ExistingGithubComment>) -> Vec<TrackingIssueUpdate> {
+    comments
+        .into_iter()
+        .filter(|comment| !comment.is_automated_comment())
+        .map(|comment| TrackingIssueUpdate {
+            author: comment.author,
+            body: comment.body,
+            created_at: comment.created_at,
+            url: comment.url,
+        })
+        .collect()
+}

mdbook-goals/src/main.rs

@@ -9,6 +9,7 @@ use walkdir::WalkDir;
 
 mod gh;
 mod goal;
+mod json;
 mod markwaydown;
 mod mdbook_preprocessor;
 mod re;
@@ -67,6 +68,13 @@ enum Command {
 
     /// Checks that the goal documents are well-formed, intended for use within CI
     Check {},
+
+    Json {
+        milestone: String,
+
+        #[structopt(long)]
+        json_path: Option<PathBuf>,
+    },
 }
 
 fn main() -> anyhow::Result<()> {
@@ -108,6 +116,13 @@ fn main() -> anyhow::Result<()> {
         } => {
             team_repo::generate_team_repo(&path, team_repo_path)?;
         }
+
+        Command::Json {
+            milestone,
+            json_path,
+        } => {
+            json::generate_json(&opt.repository, &milestone, json_path)?;
+        }
     }
 
     Ok(())

mdbook-goals/src/re.rs

@@ -20,3 +20,11 @@ lazy_static! {
 lazy_static! {
     pub static ref TRACKING_ISSUE: Regex = Regex::new(r"\[([^#]*)#([0-9]+)\]").unwrap();
 }
+
+lazy_static! {
+    pub static ref CHECKBOX: Regex = Regex::new(r"\s*[-*] \[[ x]\] ").unwrap();
+}
+
+lazy_static! {
+    pub static ref CHECKED_CHECKBOX: Regex = Regex::new(r"\s*[-*] \[x\] ").unwrap();
+}