diff --git a/src/jira.rs b/src/jira.rs index 2fe0ef4..95d0a96 100644 --- a/src/jira.rs +++ b/src/jira.rs @@ -6,6 +6,232 @@ use url::Url; // Re-export the Issue type from gouqi so callers don't depend on the crate. pub use gouqi::Issue as JiraIssue; + +/// Recursively extracts plain text from an Atlassian Document Format (ADF) node. +/// +/// Jira Cloud API v3 returns issue descriptions as ADF — a nested JSON structure +/// rather than a plain string. This function walks the content tree and writes +/// leaf `"type": "text"` node values into a single output buffer so extraction +/// remains linear in the size of the final text. +fn extract_adf_text(node: &serde_json::Value) -> String { + struct PendingSeparator<'a> { + separator: &'a str, + previous_ended_whitespace: bool, + } + + struct TextAccumulator { + text: String, + last_char_is_whitespace: bool, + } + + impl TextAccumulator { + fn new() -> Self { + Self { text: String::new(), last_char_is_whitespace: true } + } + + fn len(&self) -> usize { + self.text.len() + } + + fn ends_with_newline(&self) -> bool { + self.text.ends_with('\n') + } + + fn last_char_is_whitespace(&self) -> bool { + self.last_char_is_whitespace + } + + fn write_text( + &mut self, + text: &str, + pending_separator: &mut Option>, + ) -> bool { + if text.is_empty() { + return false; + } + + if let Some(pending_separator) = pending_separator.take() { + let starts_non_whitespace = + text.chars().next().map(|ch| !ch.is_whitespace()).unwrap_or(false); + if !pending_separator.previous_ended_whitespace && starts_non_whitespace { + self.text.push_str(pending_separator.separator); + if let Some(last_char) = pending_separator.separator.chars().last() { + self.last_char_is_whitespace = last_char.is_whitespace(); + } + } + } + + self.text.push_str(text); + if let Some(last_char) = text.chars().last() { + self.last_char_is_whitespace = last_char.is_whitespace(); + } + true + } + + fn write_char( + &mut self, + ch: char, + pending_separator: &mut Option>, + ) -> bool { + if let Some(pending_separator) = pending_separator.take() { + if !pending_separator.previous_ended_whitespace && !ch.is_whitespace() { + self.text.push_str(pending_separator.separator); + if let Some(last_char) = pending_separator.separator.chars().last() { + self.last_char_is_whitespace = last_char.is_whitespace(); + } + } + } + + self.text.push(ch); + self.last_char_is_whitespace = ch.is_whitespace(); + true + } + } + + fn write_adf_text( + node: &serde_json::Value, + output: &mut TextAccumulator, + pending_separator: &mut Option>, + ) -> bool { + match node { + serde_json::Value::Object(map) => { + let node_type = map.get("type").and_then(|v| v.as_str()); + if node_type == Some("text") { + return output.write_text( + map.get("text").and_then(|v| v.as_str()).unwrap_or(""), + pending_separator, + ); + } + if node_type == Some("hardBreak") { + return output.write_char('\n', pending_separator); + } + + let start_len = output.len(); + if let Some(children) = map.get("content").and_then(|v| v.as_array()) { + let separator = match node_type { + Some("table") => Some("\n"), + Some("tableRow") => Some(" "), + _ => None, + }; + let mut wrote_child_text = false; + let mut previous_ended_whitespace = true; + for child in children { + let mut child_pending_separator = if wrote_child_text { + separator.map(|separator| PendingSeparator { + separator, + previous_ended_whitespace, + }) + } else { + pending_separator.take() + }; + let child_wrote_text = + write_adf_text(child, output, &mut child_pending_separator); + if !wrote_child_text && !child_wrote_text { + *pending_separator = child_pending_separator; + } + if child_wrote_text { + wrote_child_text = true; + previous_ended_whitespace = output.last_char_is_whitespace(); + } + } + } + + if matches!( + node_type, + Some( + "paragraph" + | "heading" + | "blockquote" + | "listItem" + | "codeBlock" + | "tableRow" + | "table" + ) + ) && output.len() > start_len + && !output.ends_with_newline() + { + output.text.push('\n'); + output.last_char_is_whitespace = true; + } + + output.len() > start_len + } + serde_json::Value::Array(arr) => { + let start_len = output.len(); + let mut wrote_child_text = false; + for child in arr { + let mut child_pending_separator = + if wrote_child_text { None } else { pending_separator.take() }; + let child_wrote_text = + write_adf_text(child, output, &mut child_pending_separator); + if !wrote_child_text && !child_wrote_text { + *pending_separator = child_pending_separator; + } + if child_wrote_text { + wrote_child_text = true; + } + } + output.len() > start_len + } + _ => false, + } + } + + let mut output = TextAccumulator::new(); + let mut pending_separator = None; + write_adf_text(node, &mut output, &mut pending_separator); + output.text +} + +/// Returns true if the value looks like an ADF document root. +fn is_adf(value: &serde_json::Value) -> bool { + value.get("type").and_then(|v| v.as_str()).map(|t| t == "doc").unwrap_or(false) +} + +fn flatten_adf_fields(issue_value: &mut serde_json::Value) { + // Jira Cloud API v3 returns descriptions as Atlassian Document Format (ADF), + // a nested JSON tree whose leaf text nodes contain the actual content. + // Flatten ADF to a plain string so the secret scanner can match against it. + if let Some(desc) = issue_value.pointer("/fields/description") { + if is_adf(desc) { + let plain_text = extract_adf_text(desc); + if let Some(fields) = + issue_value.pointer_mut("/fields").and_then(|value| value.as_object_mut()) + { + fields.insert( + "description".to_string(), + serde_json::Value::String(plain_text.trim_end_matches('\n').to_string()), + ); + } + } + } + + // Apply the same ADF flattening to comment bodies. + if let Some(comments) = issue_value.pointer_mut("/fields/comment/comments") { + if let Some(arr) = comments.as_array_mut() { + for comment in arr.iter_mut() { + let plain_text = comment.get("body").and_then(|body| { + if is_adf(body) { + Some(extract_adf_text(body)) + } else { + None + } + }); + if let Some(plain_text) = plain_text { + if let Some(comment_obj) = comment.as_object_mut() { + comment_obj.insert( + "body".to_string(), + serde_json::Value::String( + plain_text.trim_end_matches('\n').to_string(), + ), + ); + } + } + } + } + } +} + pub async fn fetch_issues( jira_url: Url, jql: &str, @@ -44,9 +270,243 @@ pub async fn download_issues_to_dir( let issues = fetch_issues(jira_url, jql, max_results, ignore_certs).await?; let mut paths = Vec::new(); for issue in issues { + let mut issue_value = serde_json::to_value(&issue)?; + + flatten_adf_fields(&mut issue_value); + let file = output_dir.join(format!("{}.json", issue.key)); - std::fs::write(&file, serde_json::to_vec(&issue)?)?; + std::fs::write(&file, serde_json::to_vec(&issue_value)?)?; paths.push(file); } Ok(paths) } + +#[cfg(test)] +mod tests { + use super::{extract_adf_text, flatten_adf_fields, is_adf}; + use serde_json::json; + + #[test] + fn is_adf_detects_doc_root() { + let doc = json!({"type": "doc", "version": 1, "content": []}); + assert!(is_adf(&doc)); + assert!(!is_adf(&json!({"type": "paragraph"}))); + assert!(!is_adf(&json!("not-a-doc"))); + } + + #[test] + fn extract_adf_text_concatenates_adjacent_text_nodes() { + let value = json!({ + "type": "doc", + "version": 1, + "content": [{ + "type": "paragraph", + "content": [ + {"type": "text", "text": "sk-"}, + {"type": "text", "text": "proj-123"} + ] + }] + }); + let text = extract_adf_text(&value); + assert_eq!(text.trim_end(), "sk-proj-123"); + } + + #[test] + fn extract_adf_text_preserves_hard_breaks() { + let value = json!({ + "type": "doc", + "version": 1, + "content": [{ + "type": "paragraph", + "content": [ + {"type": "text", "text": "foo"}, + {"type": "hardBreak"}, + {"type": "text", "text": "bar"} + ] + }] + }); + let text = extract_adf_text(&value); + assert_eq!(text.trim_end(), "foo\nbar"); + } + + #[test] + fn extract_adf_text_adds_paragraph_separator() { + let value = json!({ + "type": "doc", + "version": 1, + "content": [ + {"type": "paragraph", "content": [{"type": "text", "text": "first"}]}, + {"type": "paragraph", "content": [{"type": "text", "text": "second"}]} + ] + }); + let text = extract_adf_text(&value); + assert_eq!(text.trim_end(), "first\nsecond"); + } + + #[test] + fn extract_adf_text_returns_empty_for_non_adf_values() { + let value = json!("plain description string"); + let text = extract_adf_text(&value); + assert_eq!(text, ""); + + let number_value = json!(42); + let number_text = extract_adf_text(&number_value); + assert_eq!(number_text, ""); + + let null_value = json!(null); + let null_text = extract_adf_text(&null_value); + assert_eq!(null_text, ""); + } + + #[test] + fn extract_adf_text_handles_missing_content_fields() { + let doc_without_content = json!({ + "type": "doc", + "version": 1 + }); + let text = extract_adf_text(&doc_without_content); + assert_eq!(text, ""); + + let paragraph_without_content = json!({ + "type": "paragraph" + }); + let para_text = extract_adf_text(¶graph_without_content); + assert_eq!(para_text, ""); + } + + #[test] + fn extract_adf_text_handles_empty_doc() { + let empty_doc = json!({ + "type": "doc", + "version": 1, + "content": [] + }); + let text = extract_adf_text(&empty_doc); + assert_eq!(text, ""); + } + + #[test] + fn extract_adf_text_handles_lists_and_code_blocks() { + let value = json!({ + "type": "doc", + "version": 1, + "content": [ + { + "type": "bulletList", + "content": [ + { + "type": "listItem", + "content": [{ + "type": "paragraph", + "content": [{"type": "text", "text": "item1"}] + }] + }, + { + "type": "listItem", + "content": [{ + "type": "paragraph", + "content": [{"type": "text", "text": "item2"}] + }] + } + ] + }, + { + "type": "codeBlock", + "content": [{"type": "text", "text": "code"}] + } + ] + }); + let text = extract_adf_text(&value); + assert_eq!(text.trim_end(), "item1\nitem2\ncode"); + } + + #[test] + fn extract_adf_text_preserves_table_row_whitespace_rules() { + let value = json!({ + "type": "doc", + "version": 1, + "content": [{ + "type": "tableRow", + "content": [ + {"type": "text", "text": "foo"}, + {"type": "text", "text": "bar"}, + {"type": "text", "text": " baz"} + ] + }] + }); + let text = extract_adf_text(&value); + assert_eq!(text.trim_end(), "foo bar baz"); + } + + #[test] + fn flatten_adf_fields_converts_comment_bodies() { + let mut issue_value = json!({ + "fields": { + "comment": { + "comments": [ + { + "body": { + "type": "doc", + "version": 1, + "content": [{ + "type": "paragraph", + "content": [{"type": "text", "text": "secret"}] + }] + } + } + ] + } + } + }); + flatten_adf_fields(&mut issue_value); + let body = issue_value + .pointer("/fields/comment/comments/0/body") + .and_then(|v| v.as_str()) + .unwrap_or(""); + assert_eq!(body, "secret"); + } + + #[test] + fn flatten_adf_fields_converts_description() { + let mut issue_value = json!({ + "fields": { + "description": { + "type": "doc", + "version": 1, + "content": [{ + "type": "paragraph", + "content": [{"type": "text", "text": "desc"}] + }] + } + } + }); + flatten_adf_fields(&mut issue_value); + let desc = + issue_value.pointer("/fields/description").and_then(|v| v.as_str()).unwrap_or(""); + assert_eq!(desc, "desc"); + } + + #[test] + fn flatten_adf_fields_leaves_plain_description() { + let mut issue_value = json!({ + "fields": { + "description": "plain description" + } + }); + flatten_adf_fields(&mut issue_value); + let desc = + issue_value.pointer("/fields/description").and_then(|v| v.as_str()).unwrap_or(""); + assert_eq!(desc, "plain description"); + } + + #[test] + fn flatten_adf_fields_handles_missing_description() { + let mut issue_value = json!({ + "fields": { + "summary": "no description here" + } + }); + flatten_adf_fields(&mut issue_value); + assert!(issue_value.pointer("/fields/description").is_none()); + } +}