Skip to content

fix: preserve hand-written notes in query benchmark reports #551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlos-alm merged 2 commits into from
Mar 20, 2026
Merged

fix: preserve hand-written notes in query benchmark reports #551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0490bb
fix: preserve hand-written notes in query benchmark reports
carlos-alm Mar 20, 2026
1ef3fc2
Merge branch 'main' into fix/query-benchmark-notes-preservation
carlos-alm Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions generated/benchmarks/QUERY-BENCHMARKS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ Latencies are median over 5 runs. Hub target = most-connected node.
| diffImpact affected functions | 0 |
| diffImpact affected files | 0 |

<!-- NOTES_START -->
**Note (3.3.1):** The ↑157-192% fnDeps/fnImpact deltas for 3.3.1 vs 3.3.0 are not comparable. PR #528 changed the hub target from auto-selected `src/types.ts` (shallow type-barrel) to pinned `buildGraph` (deep orchestration function with 2-3x more edges). There is no engine regression — `diffImpact` improved 20-44% in the same release. Future version comparisons (3.3.1+) are stable and meaningful.
<!-- NOTES_END -->

<!-- QUERY_BENCHMARK_DATA
[
{
Expand Down
13 changes: 13 additions & 0 deletions scripts/update-query-report.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,19 @@ for (const engineKey of ['native', 'wasm']) {
md += `| diffImpact affected files | ${e.diffImpact.affectedFiles} |\n\n`;
}

// ── Preserve hand-written notes from existing file ────────────────────
let notes = '';
if (fs.existsSync(reportPath)) {
const existing = fs.readFileSync(reportPath, 'utf8');
const notesMatch = existing.match(/<!-- NOTES_START -->\n([\s\S]*?)<!-- NOTES_END -->/);
if (notesMatch) {
notes = notesMatch[1];
}
}
if (notes) {
md += `<!-- NOTES_START -->\n${notes}<!-- NOTES_END -->\n\n`;
}

md += `<!-- QUERY_BENCHMARK_DATA\n${JSON.stringify(history, null, 2)}\n-->\n`;

fs.mkdirSync(path.dirname(reportPath), { recursive: true });
Expand Down
Loading