support tags

Author: W-A-James

packages/bson-bench/src/common.ts

@@ -134,6 +134,7 @@ export type BenchmarkSpecification = {
    * local package */
   library: string;
   installLocation?: string;
+  tags?: string[];
 };
 
 export interface RunBenchmarkMessage {

packages/bson-bench/src/task.ts

@@ -22,6 +22,7 @@ export class Task {
   benchmark: Omit<BenchmarkSpecification, 'installLocation'> & { installLocation: string };
   taskName: string;
   testName: string;
+  tags?: string[];
   /** @internal */
   children: ChildProcess[];
   /** @internal */
@@ -33,6 +34,7 @@ export class Task {
     this.result = undefined;
     this.children = [];
     this.hasRun = false;
+    this.tags = benchmarkSpec.tags;
     this.benchmark = { ...benchmarkSpec, installLocation: Task.packageInstallLocation };
 
     this.taskName = `${path.basename(this.benchmark.documentPath, 'json')}_${
@@ -119,6 +121,7 @@ export class Task {
     const perfSendResults: PerfSendResult = {
       info: {
         test_name: this.testName,
+        tags: this.tags,
         args: {
           warmup: this.benchmark.warmup,
           iterations: this.benchmark.iterations,

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

@@ -88,7 +88,8 @@ describe('Suite', function () {
         warmup: 10,
         iterations: 10,
         library: '[email protected]',
-        options: {}
+        options: {},
+        tags: ['test']
       };
       suite
         .task({

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

@@ -42,7 +42,8 @@ describe('Task', function () {
           operation,
           warmup: 100,
           iterations: 100,
-          options: {}
+          options: {},
+          tags: ['test']
         }
       ];
     })
@@ -77,6 +78,10 @@ describe('Task', function () {
           expect(task.testName).to.not.include(test.library);
           expect(task.testName).to.match(/bson|bson-ext/);
         });
+
+        it('collects the tags correctly', function() {
+          expect(task.tags).to.deep.equal(['test']);
+        });
       });
     }