metrics: improve comment

Author: vaind

packages/replay/metrics/configs/ci/process.ts

@@ -6,7 +6,7 @@ import { Result } from '../../src/results/result.js';
 import { ResultsSet } from '../../src/results/results-set.js';
 import { Git } from '../../src/util/git.js';
 import { GitHub } from '../../src/util/github.js';
-import { artifactName,baselineResultsDir, latestResultFile, previousResultsDir } from './env.js';
+import { artifactName, baselineResultsDir, latestResultFile, previousResultsDir } from './env.js';
 
 const latestResult = Result.readFromFile(latestResultFile);
 const branch = await Git.branch;
@@ -25,7 +25,7 @@ if (baseBranch != branch) {
   const baseResults = new ResultsSet(baselineResultsDir);
   await prComment.addCurrentResult(await ResultsAnalyzer.analyze(latestResult, baseResults), 'Baseline');
   await prComment.addAdditionalResultsSet(
-    `Baseline results on branch: ${baseBranch}`,
+    `Baseline results on branch: <code>${baseBranch}</code>`,
     // We skip the first one here because it's already included as `Baseline` column above in addCurrentResult().
     baseResults.items().slice(1, 10)
   );
@@ -34,7 +34,7 @@ if (baseBranch != branch) {
 }
 
 await prComment.addAdditionalResultsSet(
-  `Previous results on branch: ${branch}`,
+  `Previous results on branch: <code>${branch}</code>`,
   previousResults.items().slice(0, 10)
 );
 

packages/replay/metrics/src/results/pr-comment.ts

@@ -47,34 +47,40 @@ export class PrCommentBuilder {
     this._buffer += `
       <h2>${this.title}</h2>
       <table>
-        <thead>
-          <tr>
-            <th rowspan="2">&nbsp;</th>
-            <th colspan="3" align="center">This PR (${await Git.hash})</th>
-            ${maybeOther(() => `<th colspan="3" align="center">${otherName} (${analysis.otherHash})</a></th>`)}
-          </tr>
-          <tr>
-            <th align="right">Plain</th>
-            <th align="right">+Replay</th>
-            <th align="right">Diff</th>
-            ${maybeOther(() => `
-              <th align="right">Plain</th>
-              <th align="right">+Replay</th>
-              <th align="right">Diff</th>`)}
-          </tr>
-        </thead>`
+        <thead>`;
+
+    const headerCols = '<th align="right">Plain</th><th align="right">+Replay</th><th align="right">Diff</th>';
+    if (analysis.otherHash != undefined) {
+      // If "other" is defined, add an aditional row of headers.
+      this._buffer += `
+        <tr>
+          <th rowspan="2">&nbsp;</th>
+          <th colspan="3" align="center">This PR (${await Git.hash})</th>
+          <th colspan="3" align="center">${otherName} (${analysis.otherHash})</a></th>
+        </tr>
+        <tr>
+          ${headerCols}
+          ${headerCols}
+        </tr>`;
+    } else {
+      this._buffer += `
+        <tr>
+          <th>&nbsp;</th>
+          ${headerCols}
+        </tr>`;
+    }
 
     for (const item of analysis.items) {
       this._buffer += `
         <tr>
           <th align="right">${printableMetricName(item.metric)}</th>
           <td align="right">${item.value.a}</td>
           <td align="right">${item.value.b}</td>
-          <td align="right">${item.value.diff}</td>
+          <td align="right"><strong>${item.value.diff}</strong></td>
           ${maybeOther(() => `
             <td align="right">${item.other!.a}</td>
             <td align="right">${item.other!.b}</td>
-            <td align="right">${item.other!.diff}</td>`)}
+            <td align="right"><strong>${item.other!.diff}</strong></td>`)}
         </tr>`
     }