Update bug tracker workflow

mossy426-cdc · mossy426-cdc · commit e33f03434bc6 · 2026-03-13T12:40:21.000-04:00
diff --git a/.github/workflows/bug-tracker-issues.yml b/.github/workflows/bug-tracker-issues.yml
@@ -11,7 +11,7 @@ permissions:
   issues: write
 
 jobs:
-  create-issues:
+  sync-issues:
     runs-on: ubuntu-latest
     env:
       BUG_TRACKER_ASSIGNEE: ${{ vars.BUG_TRACKER_ASSIGNEE || github.actor }}
@@ -38,14 +38,66 @@ jobs:
           script: |
             const fs = require('fs');
             const issueFile = `${process.env.RUNNER_TEMP}/bug-tracker-issues.json`;
-            const issues = JSON.parse(fs.readFileSync(issueFile, 'utf8'));
+            const payload = JSON.parse(fs.readFileSync(issueFile, 'utf8'));
+            const issues = payload.create || [];
 
             if (!issues.length) {
               core.info('No new bug tracker rows found.');
-              return;
+            } else {
+              const assignee = process.env.BUG_TRACKER_ASSIGNEE;
+
+              for (const issue of issues) {
+                const query = `repo:${context.repo.owner}/${context.repo.repo} is:issue in:title "[Bug Tracker] ${issue.id}"`;
+                const existing = await github.rest.search.issuesAndPullRequests({
+                  q: query,
+                  per_page: 1,
+                });
+
+                if (existing.data.items.length) {
+                  core.info(`Issue already exists for ${issue.id}: ${existing.data.items[0].html_url}`);
+                  continue;
+                }
+
+                let created;
+                try {
+                  created = await github.rest.issues.create({
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    title: issue.title,
+                    body: issue.body,
+                    assignees: assignee ? [assignee] : undefined,
+                  });
+                } catch (error) {
+                  if (assignee) {
+                    core.warning(`Could not assign ${issue.id} to ${assignee}: ${error.message}`);
+                    created = await github.rest.issues.create({
+                      owner: context.repo.owner,
+                      repo: context.repo.repo,
+                      title: issue.title,
+                      body: issue.body,
+                    });
+                  } else {
+                    throw error;
+                  }
+                }
+
+                core.info(`Created ${issue.id}: ${created.data.html_url}`);
+              }
             }
 
-            const assignee = process.env.BUG_TRACKER_ASSIGNEE;
+      - name: Close issues for resolved bug rows
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            const issueFile = `${process.env.RUNNER_TEMP}/bug-tracker-issues.json`;
+            const payload = JSON.parse(fs.readFileSync(issueFile, 'utf8'));
+            const issues = payload.close || [];
+
+            if (!issues.length) {
+              core.info('No bug tracker rows moved to a closed status.');
+              return;
+            }
 
             for (const issue of issues) {
               const query = `repo:${context.repo.owner}/${context.repo.repo} is:issue in:title "[Bug Tracker] ${issue.id}"`;
@@ -54,33 +106,33 @@ jobs:
                 per_page: 1,
               });
 
-              if (existing.data.items.length) {
-                core.info(`Issue already exists for ${issue.id}: ${existing.data.items[0].html_url}`);
+              if (!existing.data.items.length) {
+                core.warning(`No existing GitHub issue found for ${issue.id}; skipping close.`);
                 continue;
               }
 
-              let created;
-              try {
-                created = await github.rest.issues.create({
-                  owner: context.repo.owner,
-                  repo: context.repo.repo,
-                  title: issue.title,
-                  body: issue.body,
-                  assignees: assignee ? [assignee] : undefined,
-                });
-              } catch (error) {
-                if (assignee) {
-                  core.warning(`Could not assign ${issue.id} to ${assignee}: ${error.message}`);
-                  created = await github.rest.issues.create({
-                    owner: context.repo.owner,
-                    repo: context.repo.repo,
-                    title: issue.title,
-                    body: issue.body,
-                  });
-                } else {
-                  throw error;
-                }
+              const current = existing.data.items[0];
+              const issueNumber = current.number;
+
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: issueNumber,
+                body: issue.comment,
+              });
+
+              if (current.state === 'closed') {
+                core.info(`Issue already closed for ${issue.id}: ${current.html_url}`);
+                continue;
               }
 
-              core.info(`Created ${issue.id}: ${created.data.html_url}`);
+              const updated = await github.rest.issues.update({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: issueNumber,
+                state: 'closed',
+                state_reason: 'completed',
+              });
+
+              core.info(`Closed ${issue.id}: ${updated.data.html_url}`);
             }
diff --git a/docs/2d-network-cypress-bug-log.csv b/docs/2d-network-cypress-bug-log.csv
@@ -1,4 +1,4 @@
-id,area,priority,status,fixtures,observed_behavior,intended_behavior,current_spec,regression_specs,notes,last_reviewed
-BG003,2D Settings,P1,Closed,"nn-angulartesting-tn93-edgelist","The original contract assumed Width By = Distance started in Reciprocal mode; explicit reciprocal toggling now confirms the mapping is correct.","Smallest distance edge should be widest when reciprocal is on and thinnest when it is off.",cypress/e2e/journeys/flows/behavior-contracts.cy.ts,"cypress/e2e/journeys/flows/behavior-contracts.cy.ts; cypress/e2e/journeys/flows/link-label-width.cy.ts","Closed as a test-assumption issue after debugging the live edge width data. The reciprocal toggle path remains covered explicitly.",2026-03-13
-BG001,Filtering,P0,Closed,"AngularTesting_DistanceMatrix_TN93_BS.xlsx; AngularTesting_nodelist_withseqs_TN93_BS.csv","Merged matrix-plus-sequence links treated Genetic Distance as a non-distance fallback origin, so thresholding kept all 91 links visible.","Visible links should drop from 17 to 9 while polygons remain unchanged.",cypress/e2e/journeys/flows/change-link-threshold.cy.ts,"cypress/e2e/journeys/flows/change-link-threshold.cy.ts; cypress/e2e/journeys/flows/behavior-contracts.cy.ts","Fixed by tracking all distance-backed origins on merged links so thresholding no longer preserves Genetic Distance as a fallback origin.",2026-03-13
-BG002,Filtering,P1,Closed,"AngularTesting_seqs_TN93_BS.fasta; AngularTesting_nodelist_withseqs_TN93_BS.csv","Post-launch metric switch previously changed only the threshold widget, leaving sequence-derived link distances in the launch metric.","Post-launch switch should yield coherent visibility: TN93 sequence node-list should return to 11 links under SNPs and fasta should return to 17 links under TN93 in the configured steps.",cypress/e2e/journeys/flows/post-launch-distance-metric-switch.cy.ts,"cypress/e2e/journeys/flows/post-launch-distance-metric-switch.cy.ts","Fixed by rebuilding sequence-derived genetic links when the default distance metric changes; this coverage is now promoted into the regular smoke flow.",2026-03-13
+id,area,priority,status,fixtures,observed_behavior,intended_behavior,current_spec,regression_specs,cause_summary,fix_summary,notes,last_reviewed
+BG003,2D Settings,P1,Closed,"nn-angulartesting-tn93-edgelist","The original contract assumed Width By = Distance started in Reciprocal mode; explicit reciprocal toggling now confirms the mapping is correct.","Smallest distance edge should be widest when reciprocal is on and thinnest when it is off.",cypress/e2e/journeys/flows/behavior-contracts.cy.ts,"cypress/e2e/journeys/flows/behavior-contracts.cy.ts; cypress/e2e/journeys/flows/link-label-width.cy.ts","The contract encoded the wrong default assumption: reciprocal width mapping was not enabled until explicitly toggled.","Corrected the contract to exercise the explicit reciprocal toggle path instead of asserting a nonexistent default state.","Closed as a test-assumption issue after debugging the live edge width data. The reciprocal toggle path remains covered explicitly.",2026-03-13
+BG001,Filtering,P0,Closed,"AngularTesting_DistanceMatrix_TN93_BS.xlsx; AngularTesting_nodelist_withseqs_TN93_BS.csv","Merged matrix-plus-sequence links treated Genetic Distance as a non-distance fallback origin, so thresholding kept all 91 links visible.","Visible links should drop from 17 to 9 while polygons remain unchanged.",cypress/e2e/journeys/flows/change-link-threshold.cy.ts,"cypress/e2e/journeys/flows/change-link-threshold.cy.ts; cypress/e2e/journeys/flows/behavior-contracts.cy.ts","Merged links kept a generic Genetic Distance fallback origin instead of preserving the real distance-backed origins, so threshold filtering never excluded them.","Tracked all distance-backed origins on merged links and thresholded against the active origins instead of the fallback label.","Fixed by tracking all distance-backed origins on merged links so thresholding no longer preserves Genetic Distance as a fallback origin.",2026-03-13
+BG002,Filtering,P1,Closed,"AngularTesting_seqs_TN93_BS.fasta; AngularTesting_nodelist_withseqs_TN93_BS.csv","Post-launch metric switch previously changed only the threshold widget, leaving sequence-derived link distances in the launch metric.","Post-launch switch should yield coherent visibility: TN93 sequence node-list should return to 11 links under SNPs and fasta should return to 17 links under TN93 in the configured steps.",cypress/e2e/journeys/flows/post-launch-distance-metric-switch.cy.ts,"cypress/e2e/journeys/flows/post-launch-distance-metric-switch.cy.ts","Changing the default distance metric after launch updated the widget state but did not rebuild the sequence-derived genetic links in the new metric.","Rebuilt sequence-derived genetic links whenever the default distance metric changes so the rendered links and visibility counts stay coherent.","Fixed by rebuilding sequence-derived genetic links when the default distance metric changes; this coverage is now promoted into the regular smoke flow.",2026-03-13
diff --git a/docs/AGENTS.MD b/docs/AGENTS.MD
@@ -111,7 +111,7 @@ When a test fails, do not immediately weaken the test. First identify which laye
 * For suspected app bugs, document divergence explicitly
 
   * Example: widget changed but SVG did not update, or Cytoscape moved but `session.data.nodes[*].x/y` stayed stale.
-  * Record it in `docs/2d-network-cypress-bug-log.csv` with the fixture, observed behavior, intended behavior if known, and the regression spec path.
+  * Record it in `docs/2d-network-cypress-bug-log.csv` with the fixture, observed behavior, intended behavior if known, the regression spec path, and fill in `cause_summary` / `fix_summary` before closing the bug row.
 
 Tip: keep diagnostic logs inside the spec while debugging, but remove noisy logging before committing.
 
diff --git a/docs/cypress-architecture.md b/docs/cypress-architecture.md
@@ -93,8 +93,8 @@ Do not leave broken legacy specs under active `*.cy.ts` paths.
 - Prefer retryable assertions over one-shot reads when UI state is expected to change.
 - Use `commonService` as a cross-check, not the primary source of truth, for user-visible 2D behavior.
 - Prelaunch session mutation is allowed only as a narrow fallback inside shared helpers when the UI does not fully persist launch settings yet.
-- When a maintained journey exposes a product bug, record it in `docs/2d-network-cypress-bug-log.csv` with the observed behavior, intended behavior if known, the spec that caught it, and the regression specs that must stay green after a fix.
-- New bug-log rows pushed to GitHub automatically open GitHub issues through `.github/workflows/bug-tracker-issues.yml`. Set the repository variable `BUG_TRACKER_ASSIGNEE` to force assignment to a specific GitHub login; otherwise the workflow assigns the issue to the push actor.
+- When a maintained journey exposes a product bug, record it in `docs/2d-network-cypress-bug-log.csv` with the observed behavior, intended behavior if known, the spec that caught it, the regression specs that must stay green after a fix, and explicit `cause_summary` / `fix_summary` fields once the bug is understood.
+- New bug-log rows pushed to GitHub automatically open GitHub issues through `.github/workflows/bug-tracker-issues.yml`. When a row moves to `Closed`, `Fixed`, or `Resolved`, the workflow comments on the matching issue with the recorded root cause and fix summary, then closes it. Set the repository variable `BUG_TRACKER_ASSIGNEE` to force assignment to a specific GitHub login; otherwise the workflow assigns the issue to the push actor.
 
 ## Maintained Commands
 
diff --git a/scripts/__pycache__/bug_tracker_issue_candidates.cpython-38.pyc b/scripts/__pycache__/bug_tracker_issue_candidates.cpython-38.pyc
diff --git a/scripts/bug_tracker_issue_candidates.py b/scripts/bug_tracker_issue_candidates.py
@@ -67,6 +67,10 @@ def render_bullets(items):
     return "\n".join(f"- {item}" for item in items)
 
 
+def is_closed_status(value: str):
+    return (value or "").strip().lower() in {"closed", "fixed", "resolved"}
+
+
 def build_issue(row, csv_path: str, repository: str, branch: str, commit_sha: str, actor: str):
     bug_id = row["id"].strip()
     area = (row.get("area") or "").strip()
@@ -78,6 +82,8 @@ def build_issue(row, csv_path: str, repository: str, branch: str, commit_sha: st
     regression_specs = as_list(row.get("regression_specs") or "")
     fixtures = as_list(row.get("fixtures") or "")
     notes = (row.get("notes") or "").strip()
+    cause_summary = (row.get("cause_summary") or "").strip()
+    fix_summary = (row.get("fix_summary") or "").strip()
     reviewed = (row.get("last_reviewed") or "").strip()
     line_number = row["_line_number"]
 
@@ -122,6 +128,12 @@ def build_issue(row, csv_path: str, repository: str, branch: str, commit_sha: st
 **Intended behavior**
 {intended or "Not recorded"}
 
+**Root cause**
+{cause_summary or "Not recorded"}
+
+**Fix summary**
+{fix_summary or "Not recorded"}
+
 **Notes**
 {notes or "None recorded"}
 """
@@ -133,6 +145,41 @@ def build_issue(row, csv_path: str, repository: str, branch: str, commit_sha: st
     }
 
 
+def build_close_payload(row, csv_path: str, repository: str, branch: str, commit_sha: str, actor: str):
+    bug_id = row["id"].strip()
+    line_number = row["_line_number"]
+    status = (row.get("status") or "").strip()
+    cause_summary = (row.get("cause_summary") or "").strip()
+    fix_summary = (row.get("fix_summary") or "").strip()
+    reviewed = (row.get("last_reviewed") or "").strip()
+
+    tracker_url = (
+        f"https://github.com/{repository}/blob/{commit_sha}/{csv_path}#L{line_number}"
+        if repository and commit_sha
+        else csv_path
+    )
+
+    comment = f"""Bug tracker row updated to `{status or "Closed"}`.
+
+**Root cause**
+{cause_summary or "Not recorded"}
+
+**Fix summary**
+{fix_summary or "Not recorded"}
+
+- Tracker row: [{csv_path}#L{line_number}]({tracker_url})
+- Branch: `{branch}`
+- Commit: `{commit_sha}`
+- Updated by: `{actor}`
+- Last reviewed: `{reviewed or "Unspecified"}`
+"""
+
+    return {
+        "id": bug_id,
+        "comment": comment,
+    }
+
+
 def main():
     parser = argparse.ArgumentParser()
     parser.add_argument("--csv-path", required=True)
@@ -149,8 +196,7 @@ def main():
     previous_rows = read_rows_from_git(args.before, args.csv_path)
 
     new_bug_ids = [bug_id for bug_id in current_rows if bug_id not in previous_rows]
-    closed_statuses = {"closed", "fixed", "resolved"}
-    issues = [
+    create_issues = [
         build_issue(
             current_rows[bug_id],
             args.csv_path,
@@ -160,11 +206,29 @@ def main():
             args.actor,
         )
         for bug_id in new_bug_ids
-        if (current_rows[bug_id].get("status") or "").strip().lower() not in closed_statuses
+        if not is_closed_status(current_rows[bug_id].get("status") or "")
+    ]
+
+    close_issues = [
+        build_close_payload(
+            current_rows[bug_id],
+            args.csv_path,
+            args.repository,
+            args.branch,
+            args.commit_sha,
+            args.actor,
+        )
+        for bug_id, row in current_rows.items()
+        if is_closed_status(row.get("status") or "")
+        and bug_id in previous_rows
+        and not is_closed_status(previous_rows[bug_id].get("status") or "")
     ]
 
     output_path = Path(args.output)
-    output_path.write_text(json.dumps(issues, indent=2), encoding="utf-8")
+    output_path.write_text(
+        json.dumps({"create": create_issues, "close": close_issues}, indent=2),
+        encoding="utf-8",
+    )
 
 
 if __name__ == "__main__":
