Files
huskies/server/src/http/workflow/story_ops.rs
T

632 lines
25 KiB
Rust
Raw Normal View History

use crate::io::story_metadata::set_front_matter_field;
use std::collections::HashMap;
use std::path::Path;
use super::{next_item_number, read_story_content, replace_section_content, slugify_name, story_stage, write_story_content_with_fs};
/// Shared create-story logic used by both the OpenApi and MCP handlers.
///
/// Writes the new story to the database content store and CRDT.
/// The `commit` parameter is retained for API compatibility but ignored.
pub fn create_story_file(
root: &std::path::Path,
name: &str,
user_story: Option<&str>,
acceptance_criteria: Option<&[String]>,
depends_on: Option<&[u32]>,
_commit: bool,
) -> Result<String, String> {
let story_number = next_item_number(root)?;
let slug = slugify_name(name);
if slug.is_empty() {
return Err("Name must contain at least one alphanumeric character.".to_string());
}
let story_id = format!("{story_number}_story_{slug}");
let mut content = String::new();
content.push_str("---\n");
content.push_str(&format!("name: \"{}\"\n", name.replace('"', "\\\"")));
if let Some(deps) = depends_on.filter(|d| !d.is_empty()) {
let nums: Vec<String> = deps.iter().map(|n| n.to_string()).collect();
content.push_str(&format!("depends_on: [{}]\n", nums.join(", ")));
}
content.push_str("---\n\n");
content.push_str(&format!("# Story {story_number}: {name}\n\n"));
content.push_str("## User Story\n\n");
if let Some(us) = user_story {
content.push_str(us);
content.push('\n');
} else {
content.push_str("As a ..., I want ..., so that ...\n");
}
content.push('\n');
content.push_str("## Acceptance Criteria\n\n");
if let Some(criteria) = acceptance_criteria {
for criterion in criteria {
content.push_str(&format!("- [ ] {criterion}\n"));
}
} else {
content.push_str("- [ ] TODO\n");
}
content.push('\n');
content.push_str("## Out of Scope\n\n");
content.push_str("- TBD\n");
// Write to database content store.
write_story_content_with_fs(root, &story_id, "1_backlog", &content);
// Also write to filesystem for backwards compatibility during migration.
let backlog_dir = root.join(".huskies").join("work").join("1_backlog");
if let Ok(()) = std::fs::create_dir_all(&backlog_dir) {
let _ = std::fs::write(backlog_dir.join(format!("{story_id}.md")), &content);
}
Ok(story_id)
}
/// Check off the Nth unchecked acceptance criterion in a story.
///
/// `criterion_index` is 0-based among unchecked (`- [ ]`) items.
pub fn check_criterion_in_file(
project_root: &Path,
story_id: &str,
criterion_index: usize,
) -> Result<(), String> {
let contents = read_story_content(project_root, story_id)?;
let mut unchecked_count: usize = 0;
let mut found = false;
let new_lines: Vec<String> = contents
.lines()
.map(|line| {
let trimmed = line.trim();
if let Some(rest) = trimmed.strip_prefix("- [ ] ") {
if unchecked_count == criterion_index {
unchecked_count += 1;
found = true;
let indent_len = line.len() - trimmed.len();
let indent = &line[..indent_len];
return format!("{indent}- [x] {rest}");
}
unchecked_count += 1;
}
line.to_string()
})
.collect();
if !found {
return Err(format!(
"Criterion index {criterion_index} out of range. Story '{story_id}' has \
{unchecked_count} unchecked criteria (indices 0..{}).",
unchecked_count.saturating_sub(1)
));
}
let mut new_str = new_lines.join("\n");
if contents.ends_with('\n') {
new_str.push('\n');
}
// Write back to content store.
let stage = story_stage(story_id).unwrap_or_else(|| "2_current".to_string());
write_story_content_with_fs(project_root, story_id, &stage, &new_str);
Ok(())
}
/// Add a new acceptance criterion to a story.
///
/// Appends `- [ ] {criterion}` after the last existing criterion line in the
/// "## Acceptance Criteria" section.
pub fn add_criterion_to_file(
project_root: &Path,
story_id: &str,
criterion: &str,
) -> Result<(), String> {
let contents = read_story_content(project_root, story_id)?;
let lines: Vec<&str> = contents.lines().collect();
let mut in_ac_section = false;
let mut ac_section_start: Option<usize> = None;
let mut last_criterion_line: Option<usize> = None;
for (i, line) in lines.iter().enumerate() {
let trimmed = line.trim();
if trimmed == "## Acceptance Criteria" {
in_ac_section = true;
ac_section_start = Some(i);
continue;
}
if in_ac_section {
if trimmed.starts_with("## ") {
break;
}
if trimmed.starts_with("- [ ] ") || trimmed.starts_with("- [x] ") {
last_criterion_line = Some(i);
}
}
}
let insert_after = last_criterion_line
.or(ac_section_start)
.ok_or_else(|| {
format!("Story '{story_id}' has no '## Acceptance Criteria' section.")
})?;
let mut new_lines: Vec<String> = lines.iter().map(|s| s.to_string()).collect();
new_lines.insert(insert_after + 1, format!("- [ ] {criterion}"));
let mut new_str = new_lines.join("\n");
if contents.ends_with('\n') {
new_str.push('\n');
}
// Write back to content store.
let stage = story_stage(story_id).unwrap_or_else(|| "2_current".to_string());
write_story_content_with_fs(project_root, story_id, &stage, &new_str);
Ok(())
}
/// Encode a string value as a YAML scalar.
///
/// Booleans (`true`/`false`), integers, and inline sequences (`[...]`) are
/// written as native YAML types (unquoted). Everything else is written as a
/// quoted string to avoid ambiguity.
fn yaml_encode_scalar(value: &str) -> String {
match value {
"true" | "false" => value.to_string(),
s if s.parse::<i64>().is_ok() => s.to_string(),
// YAML inline sequences like [490] or [490, 491] — write unquoted so
// serde_yaml can deserialise them as Vec<u32>.
s if s.starts_with('[') && s.ends_with(']') => s.to_string(),
s => format!("\"{}\"", s.replace('"', "\\\"").replace('\n', " ").replace('\r', "")),
}
}
/// Update the user story text and/or description in a story.
///
/// At least one of `user_story` or `description` must be provided.
/// Replaces the content of the corresponding `##` section in place.
pub fn update_story_in_file(
project_root: &Path,
story_id: &str,
user_story: Option<&str>,
description: Option<&str>,
front_matter: Option<&HashMap<String, String>>,
) -> Result<(), String> {
let has_front_matter_updates = front_matter.map(|m| !m.is_empty()).unwrap_or(false);
if user_story.is_none() && description.is_none() && !has_front_matter_updates {
return Err(
"At least one of 'user_story', 'description', or 'front_matter' must be provided."
.to_string(),
);
}
let mut contents = read_story_content(project_root, story_id)?;
if let Some(fields) = front_matter {
for (key, value) in fields {
let yaml_value = yaml_encode_scalar(value);
contents = set_front_matter_field(&contents, key, &yaml_value);
}
}
if let Some(us) = user_story {
contents = replace_section_content(&contents, "User Story", us)?;
}
if let Some(desc) = description {
contents = replace_section_content(&contents, "Description", desc)?;
}
// Write back to content store.
let stage = story_stage(story_id).unwrap_or_else(|| "2_current".to_string());
write_story_content_with_fs(project_root, story_id, &stage, &contents);
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::io::story_metadata::parse_front_matter;
use std::fs;
fn setup_git_repo(root: &std::path::Path) {
std::process::Command::new("git")
.args(["init"])
.current_dir(root)
.output()
.unwrap();
std::process::Command::new("git")
.args(["config", "user.email", "test@test.com"])
.current_dir(root)
.output()
.unwrap();
std::process::Command::new("git")
.args(["config", "user.name", "Test"])
.current_dir(root)
.output()
.unwrap();
std::process::Command::new("git")
.args(["commit", "--allow-empty", "-m", "init"])
.current_dir(root)
.output()
.unwrap();
}
fn story_with_criteria(n: usize) -> String {
let mut s = "---\nname: Test Story\n---\n\n## Acceptance Criteria\n\n".to_string();
for i in 0..n {
s.push_str(&format!("- [ ] Criterion {i}\n"));
}
s
}
/// Helper to set up a story in the filesystem and content store for tests
/// that use check/add criterion.
fn setup_story_in_fs(root: &std::path::Path, story_id: &str, content: &str) {
let current = root.join(".huskies/work/2_current");
fs::create_dir_all(&current).unwrap();
fs::write(current.join(format!("{story_id}.md")), content).unwrap();
// Also write to the global content store so read_story_content picks up this
// content even when a previous test has left a stale entry for the same ID.
crate::db::ensure_content_store();
crate::db::write_content(story_id, content);
}
// --- create_story integration tests ---
#[test]
fn create_story_writes_correct_content() {
let tmp = tempfile::tempdir().unwrap();
let backlog = tmp.path().join(".huskies/work/1_backlog");
fs::create_dir_all(&backlog).unwrap();
fs::write(backlog.join("36_story_existing.md"), "").unwrap();
let number = super::super::next_item_number(tmp.path()).unwrap();
// The number must be >= 37 (at least higher than the existing "36_story_existing.md"),
// but the global content store may have higher-numbered items from parallel tests.
assert!(number >= 37, "expected number >= 37, got: {number}");
let slug = super::super::slugify_name("My New Feature");
assert_eq!(slug, "my_new_feature");
let filename = format!("{number}_{slug}.md");
let filepath = backlog.join(&filename);
let mut content = String::new();
content.push_str("---\n");
content.push_str("name: \"My New Feature\"\n");
content.push_str("---\n\n");
content.push_str(&format!("# Story {number}: My New Feature\n\n"));
content.push_str("## User Story\n\n");
content.push_str("As a dev, I want this feature\n\n");
content.push_str("## Acceptance Criteria\n\n");
content.push_str("- [ ] It works\n");
content.push_str("- [ ] It is tested\n\n");
content.push_str("## Out of Scope\n\n");
content.push_str("- TBD\n");
fs::write(&filepath, &content).unwrap();
let written = fs::read_to_string(&filepath).unwrap();
assert!(written.starts_with("---\nname: \"My New Feature\"\n---"));
assert!(written.contains(&format!("# Story {number}: My New Feature")));
assert!(written.contains("- [ ] It works"));
assert!(written.contains("- [ ] It is tested"));
assert!(written.contains("## Out of Scope"));
}
#[test]
fn create_story_with_colon_in_name_produces_valid_yaml() {
let tmp = tempfile::tempdir().unwrap();
let name = "Server-owned agent completion: remove report_completion dependency";
let result = create_story_file(tmp.path(), name, None, None, None, false);
assert!(result.is_ok(), "create_story_file failed: {result:?}");
let story_id = result.unwrap();
// Read from content store or filesystem.
let content = crate::db::read_content(&story_id)
.or_else(|| {
let backlog = tmp.path().join(".huskies/work/1_backlog");
fs::read_to_string(backlog.join(format!("{story_id}.md"))).ok()
})
.expect("story content should exist");
let meta = parse_front_matter(&content).expect("front matter should be valid YAML");
assert_eq!(meta.name.as_deref(), Some(name));
}
// ── check_criterion_in_file tests ─────────────────────────────────────────
#[test]
fn check_criterion_marks_first_unchecked() {
let tmp = tempfile::tempdir().unwrap();
setup_git_repo(tmp.path());
setup_story_in_fs(tmp.path(), "1_test", &story_with_criteria(3));
check_criterion_in_file(tmp.path(), "1_test", 0).unwrap();
// Read the updated content.
let contents = read_story_content(tmp.path(), "1_test").unwrap();
assert!(contents.contains("- [x] Criterion 0"), "first should be checked");
assert!(contents.contains("- [ ] Criterion 1"), "second should stay unchecked");
assert!(contents.contains("- [ ] Criterion 2"), "third should stay unchecked");
}
#[test]
fn check_criterion_marks_second_unchecked() {
let tmp = tempfile::tempdir().unwrap();
setup_git_repo(tmp.path());
setup_story_in_fs(tmp.path(), "2_test", &story_with_criteria(3));
check_criterion_in_file(tmp.path(), "2_test", 1).unwrap();
let contents = read_story_content(tmp.path(), "2_test").unwrap();
assert!(contents.contains("- [ ] Criterion 0"), "first should stay unchecked");
assert!(contents.contains("- [x] Criterion 1"), "second should be checked");
assert!(contents.contains("- [ ] Criterion 2"), "third should stay unchecked");
}
#[test]
fn check_criterion_out_of_range_returns_error() {
let tmp = tempfile::tempdir().unwrap();
setup_git_repo(tmp.path());
setup_story_in_fs(tmp.path(), "3_test", &story_with_criteria(2));
let result = check_criterion_in_file(tmp.path(), "3_test", 5);
assert!(result.is_err(), "should fail for out-of-range index");
assert!(result.unwrap_err().contains("out of range"));
}
// ── add_criterion_to_file tests ───────────────────────────────────────────
fn story_with_ac_section(criteria: &[&str]) -> String {
let mut s = "---\nname: Test\n---\n\n## User Story\n\nAs a user...\n\n## Acceptance Criteria\n\n".to_string();
for c in criteria {
s.push_str(&format!("- [ ] {c}\n"));
}
s.push_str("\n## Out of Scope\n\n- N/A\n");
s
}
#[test]
fn add_criterion_appends_after_last_criterion() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "10_test", &story_with_ac_section(&["First", "Second"]));
add_criterion_to_file(tmp.path(), "10_test", "Third").unwrap();
let contents = read_story_content(tmp.path(), "10_test").unwrap();
assert!(contents.contains("- [ ] First\n"));
assert!(contents.contains("- [ ] Second\n"));
assert!(contents.contains("- [ ] Third\n"));
let pos_second = contents.find("- [ ] Second").unwrap();
let pos_third = contents.find("- [ ] Third").unwrap();
assert!(pos_third > pos_second, "Third should appear after Second");
}
#[test]
fn add_criterion_to_empty_section() {
let tmp = tempfile::tempdir().unwrap();
let content = "---\nname: Test\n---\n\n## Acceptance Criteria\n\n## Out of Scope\n\n- N/A\n";
setup_story_in_fs(tmp.path(), "11_test", content);
add_criterion_to_file(tmp.path(), "11_test", "New AC").unwrap();
let contents = read_story_content(tmp.path(), "11_test").unwrap();
assert!(contents.contains("- [ ] New AC\n"), "criterion should be present");
}
#[test]
fn add_criterion_missing_section_returns_error() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "12_test", "---\nname: Test\n---\n\nNo AC section here.\n");
let result = add_criterion_to_file(tmp.path(), "12_test", "X");
assert!(result.is_err());
assert!(result.unwrap_err().contains("Acceptance Criteria"));
}
// ── update_story_in_file tests ─────────────────────────────────────────────
#[test]
fn update_story_replaces_user_story_section() {
let tmp = tempfile::tempdir().unwrap();
let content = "---\nname: T\n---\n\n## User Story\n\nOld text\n\n## Acceptance Criteria\n\n- [ ] AC\n";
setup_story_in_fs(tmp.path(), "20_test", content);
update_story_in_file(tmp.path(), "20_test", Some("New user story text"), None, None).unwrap();
let result = read_story_content(tmp.path(), "20_test").unwrap();
assert!(result.contains("New user story text"), "new text should be present");
assert!(!result.contains("Old text"), "old text should be replaced");
assert!(result.contains("## Acceptance Criteria"), "other sections preserved");
}
#[test]
fn update_story_replaces_description_section() {
let tmp = tempfile::tempdir().unwrap();
let content = "---\nname: T\n---\n\n## Description\n\nOld description\n\n## Acceptance Criteria\n\n- [ ] AC\n";
setup_story_in_fs(tmp.path(), "21_test", content);
update_story_in_file(tmp.path(), "21_test", None, Some("New description"), None).unwrap();
let result = read_story_content(tmp.path(), "21_test").unwrap();
assert!(result.contains("New description"), "new description present");
assert!(!result.contains("Old description"), "old description replaced");
}
#[test]
fn update_story_no_args_returns_error() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "22_test", "---\nname: T\n---\n");
let result = update_story_in_file(tmp.path(), "22_test", None, None, None);
assert!(result.is_err());
assert!(result.unwrap_err().contains("At least one"));
}
#[test]
fn update_story_missing_section_returns_error() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "23_test", "---\nname: T\n---\n\nNo sections here.\n");
let result = update_story_in_file(tmp.path(), "23_test", Some("new text"), None, None);
assert!(result.is_err());
assert!(result.unwrap_err().contains("User Story"));
}
#[test]
fn update_story_sets_agent_front_matter_field() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "24_test", "---\nname: T\n---\n\n## User Story\n\nSome story\n");
let mut fields = HashMap::new();
fields.insert("agent".to_string(), "dev".to_string());
update_story_in_file(tmp.path(), "24_test", None, None, Some(&fields)).unwrap();
let result = read_story_content(tmp.path(), "24_test").unwrap();
assert!(result.contains("agent: \"dev\""), "agent field should be set");
assert!(result.contains("name: T"), "name field preserved");
}
#[test]
fn update_story_sets_arbitrary_front_matter_fields() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "25_test", "---\nname: T\n---\n\n## User Story\n\nSome story\n");
let mut fields = HashMap::new();
fields.insert("qa".to_string(), "human".to_string());
fields.insert("priority".to_string(), "high".to_string());
update_story_in_file(tmp.path(), "25_test", None, None, Some(&fields)).unwrap();
let result = read_story_content(tmp.path(), "25_test").unwrap();
assert!(result.contains("qa: \"human\""), "qa field should be set");
assert!(result.contains("priority: \"high\""), "priority field should be set");
assert!(result.contains("name: T"), "name field preserved");
}
#[test]
fn update_story_front_matter_only_no_section_required() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "26_test", "---\nname: T\n---\n\nNo sections here.\n");
let mut fields = HashMap::new();
fields.insert("agent".to_string(), "dev".to_string());
let result = update_story_in_file(tmp.path(), "26_test", None, None, Some(&fields));
assert!(result.is_ok(), "front-matter-only update should not require body sections");
let contents = read_story_content(tmp.path(), "26_test").unwrap();
assert!(contents.contains("agent: \"dev\""));
}
#[test]
fn update_story_bool_front_matter_written_unquoted() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "27_test", "---\nname: T\n---\n\nNo sections.\n");
let mut fields = HashMap::new();
fields.insert("blocked".to_string(), "false".to_string());
update_story_in_file(tmp.path(), "27_test", None, None, Some(&fields)).unwrap();
let result = read_story_content(tmp.path(), "27_test").unwrap();
assert!(result.contains("blocked: false"), "bool should be unquoted: {result}");
assert!(!result.contains("blocked: \"false\""), "bool must not be quoted: {result}");
}
#[test]
fn update_story_integer_front_matter_written_unquoted() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "28_test", "---\nname: T\n---\n\nNo sections.\n");
let mut fields = HashMap::new();
fields.insert("retry_count".to_string(), "0".to_string());
update_story_in_file(tmp.path(), "28_test", None, None, Some(&fields)).unwrap();
let result = read_story_content(tmp.path(), "28_test").unwrap();
assert!(result.contains("retry_count: 0"), "integer should be unquoted: {result}");
assert!(!result.contains("retry_count: \"0\""), "integer must not be quoted: {result}");
}
#[test]
fn update_story_bool_front_matter_parseable_after_write() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "29_test", "---\nname: My Story\n---\n\nNo sections.\n");
let mut fields = HashMap::new();
fields.insert("blocked".to_string(), "false".to_string());
update_story_in_file(tmp.path(), "29_test", None, None, Some(&fields)).unwrap();
let contents = read_story_content(tmp.path(), "29_test").unwrap();
let meta = parse_front_matter(&contents).expect("front matter should parse");
assert_eq!(meta.name.as_deref(), Some("My Story"), "name preserved after writing bool field");
}
// ── Bug 493 regression tests ──────────────────────────────────────────────
#[test]
fn update_story_depends_on_stored_as_yaml_array_not_quoted_string() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "30_test", "---\nname: T\n---\n\nNo sections.\n");
let mut fields = HashMap::new();
fields.insert("depends_on".to_string(), "[490]".to_string());
update_story_in_file(tmp.path(), "30_test", None, None, Some(&fields)).unwrap();
let result = read_story_content(tmp.path(), "30_test").unwrap();
assert!(result.contains("depends_on: [490]"), "should be unquoted array: {result}");
assert!(!result.contains("depends_on: \"[490]\""), "must not be quoted: {result}");
let meta = parse_front_matter(&result).expect("front matter should parse");
assert_eq!(meta.depends_on, Some(vec![490]));
}
#[test]
fn create_story_with_depends_on_writes_front_matter_array() {
let tmp = tempfile::tempdir().unwrap();
let story_id = create_story_file(
tmp.path(),
"Dependent Story",
None,
None,
Some(&[489]),
false,
)
.unwrap();
let contents = crate::db::read_content(&story_id)
.or_else(|| {
let backlog = tmp.path().join(".huskies/work/1_backlog");
fs::read_to_string(backlog.join(format!("{story_id}.md"))).ok()
})
.expect("story content should exist");
assert!(contents.contains("depends_on: [489]"), "missing front matter: {contents}");
assert!(!contents.contains("- [ ] depends_on"), "must not appear as checkbox: {contents}");
let meta = parse_front_matter(&contents).expect("front matter should parse");
assert_eq!(meta.depends_on, Some(vec![489]));
}
#[test]
fn update_story_depends_on_multi_element_array() {
let tmp = tempfile::tempdir().unwrap();
setup_story_in_fs(tmp.path(), "31_test", "---\nname: T\n---\n\nNo sections.\n");
let mut fields = HashMap::new();
fields.insert("depends_on".to_string(), "[490, 491]".to_string());
update_story_in_file(tmp.path(), "31_test", None, None, Some(&fields)).unwrap();
let result = read_story_content(tmp.path(), "31_test").unwrap();
let meta = parse_front_matter(&result).expect("front matter should parse");
assert_eq!(meta.depends_on, Some(vec![490, 491]));
}
}