specweave 1.0.506 → 1.0.508

package/plugins/specweave/lib/integrations/github/per-us-sync.ts

@@ -0,0 +1,515 @@
+/**
+ * Per-US GitHub Sync (v0.34.0+)
+ *
+ * Syncs each User Story to its explicitly declared project's GitHub repo.
+ * Uses the **Project**: field in spec.md (NOT keyword-based classification).
+ *
+ * Key difference from multi-project-sync:
+ * - Multi-project sync uses keyword/heuristic classification
+ * - Per-US sync uses EXPLICIT **Project**: field from spec.md
+ *
+ * @module per-us-sync
+ * @since v0.34.0
+ */
+
+import { Octokit } from '@octokit/rest';
+import type { UserStoryData } from '../../../../../src/core/living-docs/types.js';
+import type { ProjectMappings, GitHubMapping } from '../../../../../src/core/types/config.js';
+import type { USExternalRef, USExternalRefsMap } from '../../../../../src/core/types/increment-metadata.js';
+import { Logger, consoleLogger } from '../../../../../src/utils/logger.js';
+
+/**
+ * Result of syncing a single US to GitHub
+ */
+export interface USSyncResult {
+  usId: string;
+  projectId: string;
+  repo: string;
+  issueNumber: number;
+  url: string;
+  action: 'created' | 'updated' | 'skipped';
+  error?: string;
+}
+
+/**
+ * Result of syncing all USs in an increment
+ */
+export interface PerUSSyncResult {
+  success: boolean;
+  synced: USSyncResult[];
+  failed: USSyncResult[];
+  externalRefs: USExternalRefsMap;
+  summary: {
+    total: number;
+    created: number;
+    updated: number;
+    skipped: number;
+    failed: number;
+  };
+}
+
+/**
+ * Options for per-US sync
+ */
+export interface PerUSSyncOptions {
+  dryRun?: boolean;
+  force?: boolean;
+  defaultProject?: string;
+  logger?: Logger;
+}
+
+/**
+ * Per-US GitHub Sync
+ *
+ * Syncs each US to its declared project's GitHub repository.
+ */
+export class PerUSGitHubSync {
+  private token: string;
+  private projectMappings: ProjectMappings;
+  private octokit: Octokit;
+  private logger: Logger;
+
+  constructor(
+    token: string,
+    projectMappings: ProjectMappings,
+    options: { logger?: Logger } = {}
+  ) {
+    this.token = token;
+    this.projectMappings = projectMappings;
+    this.octokit = new Octokit({ auth: token });
+    this.logger = options.logger ?? consoleLogger;
+  }
+
+  /**
+   * Sync all user stories to their respective GitHub repos
+   *
+   * @param userStories - User stories with explicit project fields
+   * @param featureId - Feature ID (e.g., "FS-137")
+   * @param options - Sync options
+   */
+  async syncUserStories(
+    userStories: UserStoryData[],
+    featureId: string,
+    options: PerUSSyncOptions = {}
+  ): Promise<PerUSSyncResult> {
+    const synced: USSyncResult[] = [];
+    const failed: USSyncResult[] = [];
+    const externalRefs: USExternalRefsMap = {};
+
+    // Group USs by their declared project
+    const groups = this.groupByProject(userStories, options.defaultProject);
+
+    this.logger.log(`📡 Per-US GitHub Sync: ${userStories.length} USs across ${groups.size} projects`);
+
+    for (const [projectId, stories] of groups) {
+      // Get GitHub mapping for this project
+      const mapping = this.projectMappings[projectId]?.github;
+
+      if (!mapping) {
+        // No GitHub mapping for this project
+        this.logger.warn(`   ⚠️  No GitHub mapping for project "${projectId}" - skipping ${stories.length} USs`);
+        for (const story of stories) {
+          failed.push({
+            usId: story.id,
+            projectId,
+            repo: 'N/A',
+            issueNumber: 0,
+            url: '',
+            action: 'skipped',
+            error: `No GitHub mapping for project "${projectId}"`
+          });
+        }
+        continue;
+      }
+
+      // Sync each US to this project's repo
+      for (const story of stories) {
+        try {
+          const result = await this.syncUserStory(story, mapping, featureId, options);
+          synced.push({
+            ...result,
+            projectId
+          });
+
+          // Build external ref
+          if (!options.dryRun && result.action !== 'skipped') {
+            externalRefs[story.id] = {
+              github: {
+                provider: 'github',
+                issueNumber: result.issueNumber,
+                url: result.url,
+                targetProject: projectId,
+                lastSynced: new Date().toISOString()
+              }
+            };
+          }
+        } catch (error) {
+          failed.push({
+            usId: story.id,
+            projectId,
+            repo: `${mapping.owner}/${mapping.repo}`,
+            issueNumber: 0,
+            url: '',
+            action: 'skipped',
+            error: error instanceof Error ? error.message : String(error)
+          });
+        }
+      }
+    }
+
+    // Calculate summary
+    const created = synced.filter(r => r.action === 'created').length;
+    const updated = synced.filter(r => r.action === 'updated').length;
+    const skipped = synced.filter(r => r.action === 'skipped').length;
+
+    return {
+      success: failed.length === 0,
+      synced,
+      failed,
+      externalRefs,
+      summary: {
+        total: userStories.length,
+        created,
+        updated,
+        skipped,
+        failed: failed.length
+      }
+    };
+  }
+
+  /**
+   * Sync a single user story to GitHub
+   */
+  private async syncUserStory(
+    story: UserStoryData,
+    mapping: GitHubMapping,
+    featureId: string,
+    options: PerUSSyncOptions
+  ): Promise<USSyncResult> {
+    const title = `[${featureId}][${story.id}] ${story.title}`;
+    const body = this.buildIssueBody(story, featureId);
+
+    if (options.dryRun) {
+      this.logger.log(`   🔍 [DRY-RUN] Would sync ${story.id} to ${mapping.owner}/${mapping.repo}`);
+      return {
+        usId: story.id,
+        projectId: story.project || 'unknown',
+        repo: `${mapping.owner}/${mapping.repo}`,
+        issueNumber: 0,
+        url: '',
+        action: 'skipped'
+      };
+    }
+
+    // Check for existing issue
+    const existingIssue = await this.findExistingIssue(mapping, story.id);
+
+    if (existingIssue) {
+      // Update existing issue
+      const response = await this.octokit.issues.update({
+        owner: mapping.owner,
+        repo: mapping.repo,
+        issue_number: existingIssue.number,
+        title,
+        body
+      });
+
+      this.logger.log(`   🔄 Updated ${story.id} → ${mapping.owner}/${mapping.repo}#${response.data.number}`);
+
+      return {
+        usId: story.id,
+        projectId: story.project || 'unknown',
+        repo: `${mapping.owner}/${mapping.repo}`,
+        issueNumber: response.data.number,
+        url: response.data.html_url,
+        action: 'updated'
+      };
+    } else {
+      // Create new issue
+      const response = await this.octokit.issues.create({
+        owner: mapping.owner,
+        repo: mapping.repo,
+        title,
+        body,
+        labels: ['specweave', 'user-story']
+      });
+
+      this.logger.log(`   ✅ Created ${story.id} → ${mapping.owner}/${mapping.repo}#${response.data.number}`);
+
+      return {
+        usId: story.id,
+        projectId: story.project || 'unknown',
+        repo: `${mapping.owner}/${mapping.repo}`,
+        issueNumber: response.data.number,
+        url: response.data.html_url,
+        action: 'created'
+      };
+    }
+  }
+
+  /**
+   * Find existing issue by US ID in title
+   *
+   * Paginates through all issues to avoid missing matches on repos with 100+ issues.
+   * Deduplicates by issue number before returning.
+   */
+  private async findExistingIssue(
+    mapping: GitHubMapping,
+    usId: string
+  ): Promise<{ number: number } | null> {
+    try {
+      const seenNumbers = new Set<number>();
+      let page = 1;
+      const perPage = 100;
+
+      while (true) {
+        const response = await this.octokit.issues.listForRepo({
+          owner: mapping.owner,
+          repo: mapping.repo,
+          labels: 'specweave',
+          state: 'all',
+          per_page: perPage,
+          page,
+        });
+
+        for (const issue of response.data) {
+          if (seenNumbers.has(issue.number)) continue;
+          seenNumbers.add(issue.number);
+          if (issue.title.includes(`[${usId}]`)) {
+            return { number: issue.number };
+          }
+        }
+
+        // No more pages
+        if (response.data.length < perPage) break;
+        page++;
+      }
+
+      return null;
+    } catch {
+      return null;
+    }
+  }
+
+  /**
+   * Build issue body from user story
+   *
+   * Includes full User Story format with description and Acceptance Criteria.
+   * Uses `acceptanceCriteriaFull` if available (v1.0.59+) for AC descriptions,
+   * otherwise falls back to AC IDs only.
+   */
+  private buildIssueBody(story: UserStoryData, featureId: string): string {
+    const lines: string[] = [];
+
+    lines.push(`# ${story.title}`);
+    lines.push('');
+
+    // User Story description (As a... I want... So that...)
+    if (story.description) {
+      lines.push(story.description);
+      lines.push('');
+    }
+
+    // Acceptance Criteria - prefer full descriptions if available
+    if (story.acceptanceCriteriaFull && story.acceptanceCriteriaFull.length > 0) {
+      // Use full AC data with descriptions (v1.0.59+)
+      lines.push('## Acceptance Criteria');
+      lines.push('');
+      for (const ac of story.acceptanceCriteriaFull) {
+        const checkbox = ac.completed ? '[x]' : '[ ]';
+        lines.push(`- ${checkbox} **${ac.id}**: ${ac.description}`);
+      }
+      lines.push('');
+    } else if (story.acceptanceCriteria && story.acceptanceCriteria.length > 0) {
+      // Fallback: AC IDs only (backward compatible)
+      lines.push('## Acceptance Criteria');
+      lines.push('');
+      for (const ac of story.acceptanceCriteria) {
+        lines.push(`- [ ] ${ac}`);
+      }
+      lines.push('');
+    }
+
+    lines.push('---');
+    lines.push('');
+    lines.push(`**Feature**: ${featureId}`);
+    lines.push(`**User Story**: ${story.id}`);
+    if (story.project) {
+      lines.push(`**Project**: ${story.project}`);
+    }
+    if (story.board) {
+      lines.push(`**Board**: ${story.board}`);
+    }
+    return lines.join('\n');
+  }
+
+  /**
+   * Group user stories by their explicit project field
+   */
+  private groupByProject(
+    userStories: UserStoryData[],
+    defaultProject?: string
+  ): Map<string, UserStoryData[]> {
+    const groups = new Map<string, UserStoryData[]>();
+
+    for (const story of userStories) {
+      const project = story.project || defaultProject || 'default';
+
+      if (!groups.has(project)) {
+        groups.set(project, []);
+      }
+      groups.get(project)!.push(story);
+    }
+
+    return groups;
+  }
+}
+
+/**
+ * Sync AC checkbox status from spec.md to an existing GitHub issue.
+ *
+ * CRITICAL FIX (v1.0.59): This method specifically updates AC checkboxes
+ * in GitHub issues when tasks are completed locally. Handles concurrency
+ * by using atomic issue body updates.
+ *
+ * @param token - GitHub token
+ * @param owner - Repo owner
+ * @param repo - Repo name
+ * @param issueNumber - GitHub issue number
+ * @param acStatus - Map of AC ID to completed status
+ * @returns Success/failure result
+ */
+export async function syncACCheckboxesToGitHub(
+  token: string,
+  owner: string,
+  repo: string,
+  issueNumber: number,
+  acStatus: Map<string, boolean>,
+  options: { logger?: Logger; addComment?: boolean } = {}
+): Promise<{ success: boolean; error?: string; updated: string[] }> {
+  const logger = options.logger ?? consoleLogger;
+  const updated: string[] = [];
+
+  try {
+    const octokit = new Octokit({ auth: token });
+
+    // Fetch current issue body
+    const issue = await octokit.issues.get({
+      owner,
+      repo,
+      issue_number: issueNumber
+    });
+
+    let body = issue.data.body || '';
+    const originalBody = body;
+
+    // Update each AC checkbox
+    for (const [acId, completed] of acStatus) {
+      const checkboxState = completed ? 'x' : ' ';
+      const escapedAcId = acId.replace(/-/g, '\\-');
+
+      // Pattern 1: Bold format `- [ ] **AC-US5-01**: Description` (SpecWeave standard)
+      const boldRegex = new RegExp(`(- \\[)[ x](\\] \\*\\*${escapedAcId}\\*\\*:)`, 'g');
+
+      // Pattern 2: Plain format `- [ ] AC-US5-01: Description` (legacy)
+      const plainRegex = new RegExp(`(- \\[)[ x](\\] ${escapedAcId}:)`, 'g');
+
+      const beforeUpdate = body;
+      body = body.replace(boldRegex, `$1${checkboxState}$2`);
+      body = body.replace(plainRegex, `$1${checkboxState}$2`);
+
+      if (body !== beforeUpdate) {
+        updated.push(acId);
+      }
+    }
+
+    // Only update if there are changes
+    if (body === originalBody) {
+      logger.log(`   ⏭️  No AC checkbox changes needed for issue #${issueNumber}`);
+      return { success: true, updated: [] };
+    }
+
+    // Update issue body atomically
+    await octokit.issues.update({
+      owner,
+      repo,
+      issue_number: issueNumber,
+      body
+    });
+
+    logger.log(`   ✅ Updated ${updated.length} AC checkboxes in issue #${issueNumber}`);
+
+    // Optionally add a progress comment
+    if (options.addComment && updated.length > 0) {
+      const completedCount = [...acStatus.values()].filter(v => v).length;
+      const totalCount = acStatus.size;
+      const percentage = Math.round((completedCount / totalCount) * 100);
+
+      const commentBody = `## 📊 Progress Update
+
+**Acceptance Criteria**: ${completedCount}/${totalCount} (${percentage}%)
+
+**Recently completed:**
+${updated.filter(id => acStatus.get(id)).map(id => `- ✅ ${id}`).join('\n')}
+
+---
+🤖 Auto-updated by SpecWeave AC Completion Gate`;
+
+      await octokit.issues.createComment({
+        owner,
+        repo,
+        issue_number: issueNumber,
+        body: commentBody
+      });
+
+      logger.log(`   💬 Added progress comment to issue #${issueNumber}`);
+    }
+
+    return { success: true, updated };
+
+  } catch (error) {
+    const errorMsg = error instanceof Error ? error.message : String(error);
+    logger.warn(`⚠️  Failed to sync AC checkboxes to issue #${issueNumber}: ${errorMsg}`);
+    return { success: false, error: errorMsg, updated: [] };
+  }
+}
+
+/**
+ * Format per-US sync results for display
+ */
+export function formatPerUSSyncResults(result: PerUSSyncResult): string {
+  const lines: string[] = [];
+
+  lines.push('');
+  lines.push('📊 Per-US GitHub Sync Results');
+  lines.push('');
+
+  // Group by project
+  const byProject = new Map<string, USSyncResult[]>();
+  for (const r of [...result.synced, ...result.failed]) {
+    const existing = byProject.get(r.projectId) || [];
+    existing.push(r);
+    byProject.set(r.projectId, existing);
+  }
+
+  for (const [projectId, results] of byProject) {
+    lines.push(`**${projectId}**:`);
+    for (const r of results) {
+      const icon = r.action === 'created' ? '✅' :
+                   r.action === 'updated' ? '🔄' :
+                   r.error ? '❌' : '⏭️';
+      if (r.issueNumber > 0) {
+        lines.push(`  ${icon} ${r.usId} → ${r.repo}#${r.issueNumber}`);
+      } else if (r.error) {
+        lines.push(`  ${icon} ${r.usId}: ${r.error}`);
+      } else {
+        lines.push(`  ${icon} ${r.usId} (${r.action})`);
+      }
+    }
+    lines.push('');
+  }
+
+  lines.push(`📈 Summary: ${result.summary.created} created, ${result.summary.updated} updated, ${result.summary.failed} failed`);
+
+  return lines.join('\n');
+}