address review comments

Author: W-A-James

test/benchmarks/driver_bench/src/driver.mts

@@ -7,18 +7,22 @@ import process from 'node:process';
 const __dirname = import.meta.dirname;
 const require = module.createRequire(__dirname);
 
-// Special tag that marks a benchmark as a spec-required benchmark
-export const SPEC_TAG = 'spec-benchmark';
-// Special tag that enables our perf monitoring tooling to create alerts when regressions in this
-// benchmark's performance are detected
-export const ALERT_TAG = 'alerting-benchmark';
-// Tag marking a benchmark as being related to cursor performance
-export const CURSOR_TAG = 'cursor-benchmark';
-// Tag marking a benchmark as being related to read performance
-export const READ_TAG = 'read-benchmark';
-// Tag marking a benchmark as being related to write performance
-export const WRITE_TAG = 'write-benchmark';
+export const TAG = {
+  // Special tag that marks a benchmark as a spec-required benchmark
+  spec: 'spec-benchmark',
+  // Special tag that enables our perf monitoring tooling to create alerts when regressions in this
+  // benchmark's performance are detected
+  alert: 'alerting-benchmark',
+  // Tag marking a benchmark as being related to cursor performance
+  cursor: 'cursor-benchmark',
+  // Tag marking a benchmark as being related to read performance
+  read: 'read-benchmark',
+  // Tag marking a benchmark as being related to write performance
+  write: 'write-benchmark'
+};
 
+// Constant used to scale normalized_throughput results for ping benchmark to be roughly in the
+// range 0 - 9 to make it easier to work with
 export const NORMALIZED_PING_SCALING_CONST = 1000;
 
 /**

test/benchmarks/driver_bench/src/main.mts

@@ -203,22 +203,16 @@ function calculateNormalizedResults(results: MetricInfo[]): MetricInfo[] {
   const primesBench = results.find(r => r.info.test_name === 'primes');
   const pingBench = results.find(r => r.info.test_name === 'ping');
 
-  if (pingBench) {
-    const pingThroughput = pingBench.metrics[0].value;
-    for (const bench of results) {
-      if (bench.info.test_name === 'ping') {
-        // Compute ping's normalized_throughput against the primes bench if present
-        if (primesBench) {
-          const primesThroughput = primesBench.metrics[0].value;
-          const normalizedThroughput: Metric = { 'name': 'normalized_throughput', value: NORMALIZED_PING_SCALING_CONST * bench.metrics[0].value / primesThroughput };
-          bench.metrics.push(normalizedThroughput);
-        }
-      } else {
-        // Compute normalized_throughput of benchmarks against ping bench
-        const normalizedThroughput: Metric = { 'name': 'normalized_throughput', value: bench.metrics[0].value / pingThroughput };
-        bench.metrics.push(normalizedThroughput);
-      }
-    }
+  assert.ok(pingBench);
+  assert.ok(primesBench);
+  const pingThroughput = pingBench.metrics[0].value;
+  const primesThroughput = primesBench.metrics[0].value;
+  primesBench.metrics.push({ 'name': 'normalized_throughput', value: NORMALIZED_PING_SCALING_CONST * pingThroughput / primesThroughput });
+
+  for (const bench of results) {
+    if (bench.info.test_name === 'ping' || bench.info.test_name === 'primes') continue;
+    // Compute normalized_throughput of benchmarks against ping bench
+    bench.metrics.push({ 'name': 'normalized_throughput', value: bench.metrics[0].value / pingThroughput });
   }
 
   return results;

test/benchmarks/driver_bench/src/runner.mts

@@ -81,7 +81,13 @@ function percentileIndex(percentile: number, count: number) {
 
 const medianExecution = durations[percentileIndex(50, count)];
 const megabytesPerSecond = benchmark.taskSize / medianExecution;
+
 const tags = benchmark.tags;
+if (tags &&
+  (!Array.isArray(tags) || (tags.length > 0 && !tags.every(t => typeof t === 'string')))) {
+
+  throw new Error('If tags is specified, it MUST be an array of strings');
+}
 
 console.log(
   ' '.repeat(3),

test/benchmarks/driver_bench/src/suites/multi_bench/find_many_and_empty_cursor.mts

@@ -1,9 +1,9 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { driver, ALERT_TAG, SPEC_TAG, type mongodb, CURSOR_TAG, READ_TAG } from '../../driver.mjs';
+import { driver, TAG, type mongodb, CURSOR_TAG, READ_TAG } from '../../driver.mjs';
 
 export const taskSize = 16.22;
 
-export const tags = [ALERT_TAG, SPEC_TAG, CURSOR_TAG, READ_TAG];
+export const tags = [TAG.alert, TAG.spec, TAG.cursor, TAG.read];
 
 let collection: mongodb.Collection;
 

test/benchmarks/driver_bench/src/suites/multi_bench/grid_fs_download.mts

@@ -1,11 +1,11 @@
 import { Readable, Writable } from 'node:stream';
 import { pipeline } from 'node:stream/promises';
 
-import { driver, SPEC_TAG, ALERT_TAG, type mongodb, CURSOR_TAG, READ_TAG } from '../../driver.mjs';
+import { driver, type mongodb, TAG } from '../../driver.mjs';
 
 export const taskSize = 52.43;
 
-export const tags = [ALERT_TAG, SPEC_TAG, CURSOR_TAG, READ_TAG];
+export const tags = [TAG.alert, TAG.spec, TAG.cursor, TAG.read];
 
 let bucket: mongodb.GridFSBucket;
 let bin: Uint8Array;

test/benchmarks/driver_bench/src/suites/multi_bench/grid_fs_upload.mts

@@ -1,10 +1,10 @@
 import { Readable } from 'node:stream';
 import { pipeline } from 'node:stream/promises';
 
-import { ALERT_TAG, driver, SPEC_TAG, WRITE_TAG, type mongodb } from '../../driver.mjs';
+import { driver, TAG, type mongodb } from '../../driver.mjs';
 
 export const taskSize = 52.43;
-export const tags = [ALERT_TAG, SPEC_TAG, WRITE_TAG];
+export const tags = [TAG.alert, TAG.spec, TAG.write];
 
 let bucket: mongodb.GridFSBucket;
 let uploadStream: mongodb.GridFSBucketWriteStream;

test/benchmarks/driver_bench/src/suites/multi_bench/large_doc_bulk_insert.mts

@@ -1,7 +1,7 @@
-import { ALERT_TAG, driver, SPEC_TAG, WRITE_TAG, type mongodb } from '../../driver.mjs';
+import { driver, TAG, type mongodb } from '../../driver.mjs';
 
 export const taskSize = 27.31;
-export const tags = [SPEC_TAG, ALERT_TAG, WRITE_TAG];
+export const tags = [TAG.alert, TAG.spec, TAG.write];
 
 let collection: mongodb.Collection;
 let documents: any[];

test/benchmarks/driver_bench/src/suites/multi_bench/small_doc_bulk_insert.mts

@@ -1,7 +1,7 @@
-import { ALERT_TAG, driver, SPEC_TAG, WRITE_TAG, type mongodb } from '../../driver.mjs';
+import { TAG, driver, type mongodb } from '../../driver.mjs';
 
 export const taskSize = 2.75;
-export const tags = [SPEC_TAG, ALERT_TAG, WRITE_TAG];
+export const tags = [TAG.alert, TAG.spec, TAG.write];
 
 let collection: mongodb.Collection;
 let documents: any[];

test/benchmarks/driver_bench/src/suites/node_specific/aggregate_a_million_documents_and_to_array.mts

@@ -1,7 +1,7 @@
-import { ALERT_TAG, CURSOR_TAG, driver, READ_TAG, type mongodb } from '../../driver.mjs';
+import { driver, TAG, type mongodb } from '../../driver.mjs';
 
 export const taskSize = 16;
-export const tags = [ALERT_TAG, CURSOR_TAG, READ_TAG];
+export const tags = [TAG.alert, TAG.cursor, TAG.read];
 
 let db: mongodb.Db;
 

test/benchmarks/driver_bench/src/suites/node_specific/aggregate_a_million_tweets_and_to_array.mts

@@ -1,7 +1,7 @@
-import { ALERT_TAG, driver, READ_TAG, type mongodb } from '../../driver.mjs';
+import {driver, TAG, type mongodb } from '../../driver.mjs';
 
 export const taskSize = 1500;
-export const tags = [ALERT_TAG, CURSOR_TAG, READ_TAG];
+export const tags = [TAG.alert, TAG.cursor, TAG.read];
 
 let db: mongodb.Db;
 let tweet: Record<string, any>;