fix(NODE-6806): move benchmark tags into correct place (#36)

Author: W-A-James

packages/bson-bench/src/common.ts

@@ -175,12 +175,12 @@ export type PerfSendMetricType =
 export type PerfSendResult = {
   info: {
     test_name: string;
-    tags?: string[];
     args: Record<string, number>;
   };
   metrics: {
     name: string;
     value: number;
+    metadata: { tags?: string[]; improvement_direction?: 'up' | 'down' };
     type?: PerfSendMetricType;
     version?: number;
   }[];

packages/bson-bench/src/task.ts

@@ -108,10 +108,10 @@ export class Task {
     };
     const optionsWithNumericFields = convertOptions(this.benchmark.options);
 
+    const metadata = { tags: this.benchmark.tags };
     const perfSendResults: PerfSendResult = {
       info: {
         test_name: this.testName,
-        tags: this.benchmark.tags,
         args: {
           warmup: this.benchmark.warmup,
           iterations: this.benchmark.iterations,
@@ -122,27 +122,32 @@ export class Task {
         {
           name: 'mean_megabytes_per_second',
           type: 'MEAN',
-          value: meanThroughputMBps
+          value: meanThroughputMBps,
+          metadata
         },
         {
           name: 'median_megabytes_per_second',
           type: 'MEDIAN',
-          value: medianThroughputMBps
+          value: medianThroughputMBps,
+          metadata
         },
         {
           name: 'min_megabytes_per_second',
           type: 'MIN',
-          value: minThroughputMBps
+          value: minThroughputMBps,
+          metadata
         },
         {
           name: 'max_megabytes_per_second',
           type: 'MAX',
-          value: maxThroughputMBps
+          value: maxThroughputMBps,
+          metadata
         },
         {
           name: 'stddev_megabytes_per_second',
           type: 'STANDARD_DEVIATION',
-          value: throughputMBpsStddev
+          value: throughputMBpsStddev,
+          metadata
         }
       ]
     };

packages/bson-bench/test/unit/task.test.ts

@@ -51,6 +51,7 @@ describe('Task', function () {
         let task;
 
         beforeEach(function () {
+          if (test.library === '[email protected]') this.skip();
           task = new Task(test);
         });
 
@@ -151,8 +152,10 @@ describe('Task', function () {
       expect(results.info).to.haveOwnProperty('args');
     });
 
-    it('returns the tags in the info.tags field', function () {
-      expect(results.info.tags).to.deep.equal(['test', 'test2']);
+    it('returns the tags in the info.metrics.metadata field', function () {
+      for (const m of results.metrics) {
+        expect(m.metadata.tags).to.deep.equal(['test', 'test2']);
+      }
     });
 
     it('returns options provided in constructor in the info.args field', function () {