Add smiley feedback collector with comment after a completed run (RBT-WP-0004-T12)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Assistant: claude-code
Assistant-Model: sonnet
Assistant-Process: 295952@bnt-lap001
Assistant-Session: e93f64ad-516c-46eb-9666-aad8d300c477

rtut/__main__.py

@@ -45,6 +45,8 @@ def _run(pk, a) -> int:
             R.retry(r, a.step); return 0
         if a.action == "skip":
             R.skip(r, a.step, a.note); return 0
+        if a.action == "feedback":
+            R.add_feedback(r, a.rating or "", a.note); print("recorded"); return 0
         old, new = R.exercise_update(r)
         import difflib
         print("".join(difflib.unified_diff(old.splitlines(True), new.splitlines(True), "pack.yaml", "pack.yaml")))
@@ -63,7 +65,7 @@ def main(argv: list[str] | None = None) -> int:
         sp = sub.add_parser(name)
         sp.add_argument("root", nargs="?", default=".")
     sp = sub.add_parser("run", help="record a run of a native pack")
-    sp.add_argument("action", choices=["new", "list", "status", "cmd", "start", "verify", "done", "fail", "retry", "skip", "finish"])
+    sp.add_argument("action", choices=["new", "list", "status", "cmd", "start", "verify", "done", "fail", "retry", "skip", "finish", "feedback"])
     sp.add_argument("manifest")
     sp.add_argument("run_id", nargs="?")
     sp.add_argument("step", nargs="?")
@@ -71,12 +73,15 @@ def main(argv: list[str] | None = None) -> int:
     sp.add_argument("--param", "-p", action="append", default=[], help="name=value")
     sp.add_argument("--evidence", "-e", action="append", default=[], help="name=value (non-secret)")
     sp.add_argument("--note", default="")
+    sp.add_argument("--rating", choices=["good", "neutral", "poor"], help="feedback: how the runbook felt")
     sp.add_argument("--yes", action="store_true", help="confirm running a verify command")
     sp.add_argument("--pass", dest="passed", action="store_true", help="manual check: operator confirms it passed")
     sp.add_argument("--apply", action="store_true", help="finish: write the exercise-status change")
     sp = sub.add_parser("ui", help="serve the local UI on 127.0.0.1")
     sp.add_argument("roots", nargs="*", default=["."])
     sp.add_argument("--port", type=int, default=8877)
+    sp = sub.add_parser("feedback", help="list the latest feedback of every run of a pack")
+    sp.add_argument("manifest")
     sp = sub.add_parser("launch"); sp.add_argument("manifest")
     sp.add_argument("--timeout", type=float, default=30.0)
     sp = sub.add_parser("show"); sp.add_argument("manifest")
@@ -113,6 +118,11 @@ def main(argv: list[str] | None = None) -> int:
     if not pk.ok:
         print("\n".join(pk.errors), file=sys.stderr)
         return 1
+    if a.cmd == "feedback":
+        from . import run as R
+        for f in R.all_feedback(pk):
+            print(f"{f['at']}  {R.RATINGS[f['rating']]}  {f['operator']}  {f['run_id']}  {f['comment']}")
+        return 0
     if a.cmd == "run":
         return _run(pk, a)
     if a.cmd == "launch":

rtut/run.py

@@ -232,3 +232,33 @@ def exercise_update(run: Run, today: date | None = None) -> tuple[str, str]:
     new = STATUS_LINE.sub(f"exercise_status: exercised {today.isoformat()} by {run.data['operator']}",
                           old, count=1)
     return old, new
+
+
+RATINGS = {"good": ":)", "neutral": ":|", "poor": ":("}
+
+
+def add_feedback(run: Run, rating: str, comment: str = "") -> dict:
+    """Record how the runbook felt. Allowed at any time; the latest entry is the current one."""
+    if rating not in RATINGS:
+        raise RunError(f"rating must be one of {', '.join(RATINGS)}")
+    entry = {"rating": rating, "comment": _clean(comment.strip(), "comment"),
+             "at": datetime.now(timezone.utc).isoformat(timespec="microseconds")}   # sortable even within one second
+    run.data.setdefault("feedback", []).append(entry)
+    run.save()
+    return entry
+
+
+def latest_feedback(run: Run) -> dict | None:
+    fb = run.data.get("feedback") or []
+    return fb[-1] if fb else None
+
+
+def all_feedback(pack: Pack) -> list[dict]:
+    """Latest feedback of every run of this pack, newest first."""
+    out = []
+    for rid in list_runs(pack):
+        r = load(pack, rid)
+        fb = latest_feedback(r)
+        if fb:
+            out.append({"run_id": rid, "operator": r.data["operator"], **fb})
+    return sorted(out, key=lambda x: x["at"], reverse=True)

rtut/ui.py

@@ -34,7 +34,7 @@ def page(title: str, body: str) -> bytes:
             "const f=b.closest('form'),n=f.querySelector('[name=note]'),w=f.querySelector('[data-warn]');"
             "if(n&&!n.value.trim()&&!b.dataset.warned){ev.preventDefault();b.dataset.warned='1';w.hidden=false;n.focus();}}));"
             # keep the operator on the current step after every action
-            "const c=document.getElementById('current');if(c)c.scrollIntoView({block:'center'});"
+            "const c=document.getElementById(location.hash==='#feedback'?'feedback':'current');if(c)c.scrollIntoView({block:'center'});"
             "</script>").encode()
 
 
@@ -42,6 +42,9 @@ def e(s) -> str:
     return html.escape(str(s))
 
 
+SMILEYS = (("good", "🙂", "Went well"), ("neutral", "😐", "So-so"), ("poor", "🙁", "Poor"))
+
+
 class App:
     def __init__(self, roots: list[Path]):
         self.token = secrets.token_urlsafe(16)
@@ -83,6 +86,23 @@ class App:
                     "<p><label>Your name (one word)<br><input name=operator required></label></p>"
                     "<button>Start run</button></form>")
 
+    def feedback_form(self, i: int, rid: str, r) -> str:
+        fb = R.latest_feedback(r)
+        thanks = ""
+        if fb:
+            face = next(f for k, f, _ in SMILEYS if k == fb["rating"])
+            thanks = (f"<p><b>Thank you.</b> Recorded: {face} {e(fb['comment'] or '(no comment)')} "
+                      "<span class=note>You can change it below.</span></p>")
+        btns = " ".join(f"<button name=rating value={k} title='{e(t)}' aria-label='{e(t)}'"
+                        f" style='font-size:1.6rem;padding:.1rem .6rem'>{face}</button>"
+                        for k, face, t in SMILEYS)
+        return (f"<div id=feedback class=step><h2>How was this runbook?</h2>{thanks}"
+                f"<form method=post action='/run/{i}/{e(rid)}/feedback'>{self.hidden()}"
+                "<p class=note>Practicable? Anything that felt strange or unclear, or an idea to make it better. "
+                "Never include secrets.</p>"
+                f"<p><textarea name=comment rows=3 style='width:100%' placeholder='optional comment'>"
+                f"{e(fb['comment']) if fb else ''}</textarea></p><p class=row>{btns}</p></form></div>")
+
     def run_page(self, i: int, rid: str, msg: str = "") -> bytes:
         p = self.packs[i]; r = R.load(p, rid); d = p.data
         out = [f"<h1>{e(d['title'])}</h1><p class=pill>{e(d['exercise_status'])}</p>"
@@ -157,6 +177,8 @@ class App:
         if r.complete:
             out.append("<p><b>All steps done.</b> To record this run as exercising the pack, review and apply: "
                        f"<code>python -m rtut run finish {e(p.path)} {e(rid)} --apply</code></p>")
+        if r.complete:
+            out.append(self.feedback_form(i, rid, r))
         out.append("<h2>Threat checks</h2><ul>" + "".join(f"<li>{e(t)}</li>" for t in d["threat_checks"]) + "</ul>")
         return page(d["title"], "".join(out))
 
@@ -205,6 +227,10 @@ def make_handler(app: App, port_holder: list):
                     params = {k[2:]: v for k, v in form.items() if k.startswith("p_")}
                     r = R.create(p, form.get("operator", ""), params)
                     return self._redirect(f"/run/{i}/{r.data['run_id']}#current")
+                if len(parts) == 4 and parts[0] == "run" and parts[3] == "feedback":
+                    i, rid = int(parts[1]), parts[2]
+                    R.add_feedback(R.load(app.packs[i], rid), form.get("rating", ""), form.get("comment", ""))
+                    return self._redirect(f"/run/{i}/{rid}#feedback")
                 i, rid, sid, action = int(parts[1]), parts[2], parts[3], parts[4]
                 p = app.packs[i]; r = R.load(p, rid)
                 if action == "start": R.start(r, sid)