Deconfuse Geomean Metric and geomean aggregate value (#408) (#480)

The metric's "geomean" aggregate value can be easily confused with the top-level Geomean metric (issue #407).

- Don't serialize "geomean" in the JSON data
- Add descriptions to Score, Geomean, and Iteration metrics that are serialized in the JSON data
- Make the detail view titles more descriptive
- Merge of original PR #408

Author: camillobruni

index.html

@@ -82,13 +82,13 @@ <h1>Score</h1>
                     <h1 class="section-header">Detailed Results</h1>
                     <div class="section-content all-metric-results">
                         <div class="aggregated-metric-result">
-                            <h2>Geomean</h2>
+                            <h2>Aggregate Metric</h2>
                             <div id="geomean-chart"></div>
-                            <h2>Tests</h2>
+                            <h2>Test Metrics Overview</h2>
                             <div id="tests-chart"></div>
                         </div>
                         <br />
-                        <h2>Detailed Metrics</h2>
+                        <h2>Test Metrics Details</h2>
                         <div id="metrics-results"></div>
                     </div>
                     <div class="buttons section-footer">

resources/benchmark-runner.mjs

@@ -603,9 +603,9 @@ export class BenchmarkRunner {
             // Prepare all iteration metrics so they are listed at the end of
             // of the _metrics object, before "Total" and "Score".
             for (let i = 0; i < this._iterationCount; i++)
-                iterationTotalMetric(i);
-            getMetric("Geomean");
-            getMetric("Score", "score");
+                iterationTotalMetric(i).description = `Test totals for iteration ${i}`;
+            getMetric("Geomean", "ms").description = "Geomean of test totals";
+            getMetric("Score", "score").description = "Scaled inverse of the Geomean";
         }
 
         const geomean = getMetric("Geomean");

resources/metric.mjs

@@ -10,9 +10,15 @@ export class Metric {
             throw new Error(`Invalid metric.name=${name}, expected string.`);
         this.name = name;
         this.unit = unit;
+        this.description = "";
 
         this.mean = 0.0;
-        this.geomean = 0.0;
+        // Make "geomean" non-enumerable so we don't serialize it with JSON.stringify
+        // and avoid some confusion with the top-level Geomean metric.
+        Object.defineProperty(this, "geomean", {
+            writable: true,
+            value: 0,
+        });
         this.delta = 0.0;
         this.percentDelta = 0.0;
 
@@ -21,7 +27,6 @@ export class Metric {
         this.max = 0.0;
 
         this.values = [];
-        this.children = [];
 
         // Mark properties which refer to other Metric objects as
         // non-enumerable to avoid issue with JSON.stringify due to circular
@@ -31,6 +36,10 @@ export class Metric {
                 writable: true,
                 value: undefined,
             },
+            children: {
+                writable: true,
+                value: [],
+            },
         });
     }