1"""Markdown summary renderer for the combined trace analysis."""
2from __future__ import annotations
3 
4 
5def render(result: dict) -> str:
6    lines: list[str] = []
7    trace = result.get("trace", "?")
8    header = result.get("xctrace_version") or ""
9    template = result.get("template") or ""
10    duration_s = result.get("duration_s")
11    lines.append(f"# Instruments Trace Analysis")
12    meta = [p for p in [f"Trace: `{trace}`", header, template] if p]
13    lines.append("  •  ".join(meta))
14    if duration_s is not None:
15        lines.append(f"Recording duration: {duration_s:.2f}s")
16    lines.append("")
17 
18    lanes_by_name = {lane["lane"]: lane for lane in result.get("lanes", [])}
19 
20    _render_time_profiler(lines, lanes_by_name.get("time-profiler"))
21    _render_hangs(lines, lanes_by_name.get("hangs"))
22    _render_hitches(lines, lanes_by_name.get("hitches"))
23    _render_swiftui(lines, lanes_by_name.get("swiftui"))
24    _render_causes(lines, lanes_by_name.get("swiftui-causes"))
25    _render_correlations(lines, result.get("correlations", []))
26 
27    return "\n".join(lines).rstrip() + "\n"
28 
29 
30def _skipped_block(title: str, lane: dict | None) -> list[str]:
31    if lane is None:
32        return [f"## {title} — skipped (lane module not run)", ""]
33    notes = lane.get("notes") or []
34    note_text = f" — {notes[0]}" if notes else ""
35    return [f"## {title} — skipped{note_text}", ""]
36 
37 
38def _render_time_profiler(lines: list[str], lane: dict | None) -> None:
39    if not lane or not lane.get("available"):
40        lines.extend(_skipped_block("Time Profiler", lane))
41        return
42    m = lane["metrics"]
43    lines.append(
44        f"## Time Profiler — {m['total_samples']:,} samples, "
45        f"{m['total_weight_ms']:.0f}ms CPU time"
46    )
47    if m.get("processes"):
48        lines.append(f"Processes: {', '.join(m['processes'])}")
49    lines.append("")
50    if lane["top_offenders"]:
51        lines.append("Top offenders:")
52        for i, o in enumerate(lane["top_offenders"], 1):
53            lines.append(
54                f"{i}. `{_truncate(o['symbol'], 90)}` — "
55                f"{o['percent']:.1f}% ({o['weight_ms']:.0f}ms, "
56                f"{o['samples']} samples, {_short_thread(o['thread'])})"
57            )
58    for note in lane.get("notes") or []:
59        lines.append(f"> {note}")
60    lines.append("")
61 
62 
63def _render_hangs(lines: list[str], lane: dict | None) -> None:
64    if not lane or not lane.get("available"):
65        lines.extend(_skipped_block("Hangs", lane))
66        return
67    m = lane["metrics"]
68    buckets = m["severity_buckets"]
69    lines.append(
70        f"## Hangs — {m['count']} hangs, {m['total_duration_ms']:.0f}ms total, "
71        f"worst {m['worst_duration_ms']:.0f}ms"
72    )
73    lines.append(
74        f"Severity: <250ms={buckets['lt_250ms']}, "
75        f"250ms–1s={buckets['250ms_1s']}, >1s={buckets['gt_1s']}"
76    )
77    lines.append("")
78    for i, h in enumerate(lane["top_offenders"], 1):
79        lines.append(
80            f"{i}. {h['duration_ms']:.0f}ms {h['hang_type']} at "
81            f"{h['start_ms']:.2f}ms on {_short_thread(h['thread'])}"
82        )
83    lines.append("")
84 
85 
86def _render_hitches(lines: list[str], lane: dict | None) -> None:
87    if not lane or not lane.get("available"):
88        lines.extend(_skipped_block("Animation Hitches", lane))
89        return
90    m = lane["metrics"]
91    lines.append(
92        f"## Animation Hitches — {m['count']} hitches, "
93        f"{m['total_hitch_ms']:.0f}ms total, worst {m['worst_hitch_ms']:.0f}ms"
94    )
95    if m.get("per_process"):
96        pp = ", ".join(f"{k}={v}" for k, v in m["per_process"].items())
97        lines.append(f"By process: {pp}")
98    lines.append("")
99    if m.get("narrative_breakdown"):
100        nb = ", ".join(f"{k}={v}" for k, v in m["narrative_breakdown"].items() if k)
101        if nb:
102            lines.append(f"Apple attribution: {nb}")
103    if m.get("system_hitches") is not None:
104        lines.append(
105            f"System vs app: system={m['system_hitches']}, app={m['app_hitches']}"
106        )
107    lines.append("")
108    for i, h in enumerate(lane["top_offenders"], 1):
109        narrative = f" — {h['narrative']}" if h.get("narrative") else ""
110        src = " [system]" if h.get("is_system") else ""
111        proc = f" ({h['process']})" if h.get("process") else ""
112        lines.append(
113            f"{i}. {h['hitch_duration_ms']:.0f}ms at {h['start_ms']:.2f}ms"
114            f"{proc}{src}{narrative}"
115        )
116    lines.append("")
117 
118 
119def _render_swiftui(lines: list[str], lane: dict | None) -> None:
120    if not lane or not lane.get("available"):
121        lines.extend(_skipped_block("SwiftUI", lane))
122        return
123    m = lane["metrics"]
124    lines.append(
125        f"## SwiftUI — {m['total_events']:,} updates across "
126        f"{m['unique_views']} views, {m['total_duration_ms']:.0f}ms total"
127    )
128    if m.get("severity_breakdown"):
129        sb = ", ".join(f"{k}={v}" for k, v in m["severity_breakdown"].items())
130        lines.append(f"Severity: {sb}")
131    if m.get("update_type_breakdown"):
132        ub = ", ".join(f"{k}={v}" for k, v in m["update_type_breakdown"].items())
133        lines.append(f"Update types: {ub}")
134    lines.append("")
135    if lane["top_offenders"]:
136        lines.append("Heaviest views (by total body time):")
137        for i, v in enumerate(lane["top_offenders"], 1):
138            lines.append(
139                f"{i}. `{_truncate(v['view'], 80)}` — {v['total_ms']:.0f}ms total, "
140                f"{v['count']} updates (avg {v['avg_ms']:.2f}ms)"
141            )
142    if lane.get("high_severity_events"):
143        lines.append("")
144        lines.append("High-severity updates:")
145        for i, e in enumerate(lane["high_severity_events"][:5], 1):
146            cat = f" [{e['category']}]" if e.get("category") else ""
147            lines.append(
148                f"{i}. `{_truncate(e['view'], 60)}` — "
149                f"{e['severity']} ({e['duration_ms']:.2f}ms at {e['start_ms']:.2f}ms){cat}"
150            )
151    lines.append("")
152 
153 
154def _render_causes(lines: list[str], lane: dict | None) -> None:
155    if not lane or not lane.get("available"):
156        lines.extend(_skipped_block("SwiftUI Cause Graph", lane))
157        return
158    m = lane["metrics"]
159    lines.append(
160        f"## SwiftUI Cause Graph — {m['total_edges']:,} edges, "
161        f"{m['unique_sources']} sources → {m['unique_destinations']} destinations"
162    )
163    lines.append("")
164    if lane.get("top_sources"):
165        lines.append("Top sources (who's driving the most updates):")
166        for i, s in enumerate(lane["top_sources"][:5], 1):
167            lines.append(f"{i}. `{_truncate(s['source'], 80)}` — {s['edges']:,} edges")
168            for d in s["top_destinations"][:3]:
169                lines.append(
170                    f"    → `{_truncate(d['destination'], 70)}` {d['edges']:,}"
171                )
172    if lane.get("top_destinations"):
173        lines.append("")
174        lines.append("Top destinations (who's being invalidated most):")
175        for i, d in enumerate(lane["top_destinations"][:5], 1):
176            lines.append(f"{i}. `{_truncate(d['destination'], 80)}` — {d['edges']:,} edges")
177            for s in d["top_sources"][:3]:
178                lines.append(
179                    f"    ← `{_truncate(s['source'], 70)}` {s['edges']:,}"
180                )
181    lines.append("")
182 
183 
184def _render_correlations(lines: list[str], correlations: list[dict]) -> None:
185    if not correlations:
186        return
187    lines.append("## Correlations")
188    lines.append("")
189    for c in correlations:
190        t = c["trigger"]
191        head = (
192            f"- **{t['lane']}** at {t['start_ms']:.2f}ms "
193            f"({t['duration_ms']:.0f}ms)"
194        )
195        if t.get("hang_type"):
196            head += f" — {t['hang_type']}"
197        lines.append(head)
198 
199        tp = c.get("time_profiler_main_thread")
200        if tp is not None:
201            cov = tp["main_running_coverage_pct"]
202            lines.append(
203                f"  - Main thread: {tp['samples_on_main']} running samples "
204                f"({cov:.0f}% coverage — "
205                f"{'blocked' if cov < 25 else 'mostly running'})"
206            )
207            for s in tp["hot_symbols"][:3]:
208                lines.append(
209                    f"    · `{_truncate(s['symbol'], 80)}` "
210                    f"{s['percent_of_main']:.0f}% ({s['samples']} samples)"
211                )
212            if not tp["hot_symbols"]:
213                lines.append("    · no main-thread samples in window")
214 
215        sui = c.get("swiftui_overlapping_updates")
216        if sui:
217            for s in sui[:3]:
218                lines.append(
219                    f"  - SwiftUI: `{s['view']}` {s['duration_ms']:.2f}ms "
220                    f"(at {s['start_ms']:.2f}ms)"
221                )
222    lines.append("")
223 
224 
225def _short_thread(name: str) -> str:
226    if not name:
227        return ""
228    if name.startswith("Main Thread") or name == "main":
229        return "main"
230    # "NowPlaying Gigs (0x251990d) (NowPlaying Gigs, pid: 28401)" -> "tid 0x251990d"
231    tid_start = name.find("(0x")
232    if tid_start != -1:
233        start = tid_start + 1
234        end = name.find(")", start)
235        if end != -1:
236            return f"tid {name[start:end]}"
237    return name[:40]
238 
239 
240def _truncate(s: str, n: int) -> str:
241    if len(s) <= n:
242        return s
243    return s[: n - 1] + "…"
244