Adding bulk dimension add

Author: Alan Churley

packages/metrics/src/Metrics.ts

@@ -32,12 +32,23 @@ class Metrics implements MetricsInterface {
   }
 
   public addDimension(name: string, value: string): void {
-    if (MAX_DIMENSION_COUNT <= (Object.keys(this.dimensions).length + Object.keys(this.defaultDimensions).length)) {
+    if (MAX_DIMENSION_COUNT <= this.getCurrentDimensionsCount()) {
       throw new Error(`Max dimension count of ${MAX_DIMENSION_COUNT} hit`);
     }
     this.dimensions[name] = value;
   }
 
+  public addDimensions(dimensions: {[key: string]: string}): void {
+    const newDimensions = { ...this.dimensions };
+    Object.keys(dimensions).forEach((dimensionName) => {
+      newDimensions[dimensionName] = dimensions[dimensionName];
+    });
+    if (Object.keys(newDimensions).length > MAX_DIMENSION_COUNT) {
+      throw new Error(`Adding ${Object.keys(dimensions).length} dimensions would exceed max dimension count of ${MAX_DIMENSION_COUNT}`);
+    }
+    this.dimensions = newDimensions;
+  }
+
   public addMetadata(key: string, value: string): void {
     this.metadata[key] = value;
   }
@@ -154,6 +165,10 @@ class Metrics implements MetricsInterface {
     singleMetric.addMetric('ColdStart', MetricUnits.Count, 1);
   }
 
+  private getCurrentDimensionsCount(): number {
+    return Object.keys(this.dimensions).length + Object.keys(this.defaultDimensions).length;
+  }
+
   private getCustomConfigService(): ConfigServiceInterface | undefined {
     return this.customConfigService;
   }

packages/metrics/src/MetricsInterface.ts

@@ -6,6 +6,7 @@ interface MetricsInterface {
   clearMetrics(): void
   logMetrics(options?: DecoratorOptions): HandlerMethodDecorator
   addDimension(name: string, value: string): void
+  addDimensions(dimensions: {[key: string]: string}): void
   addMetadata(key: string, value: string): void
   clearMetadata(): void
   clearDimensions(): void

packages/metrics/tests/unit/Metrics.test.ts

@@ -9,6 +9,10 @@ const MAX_DIMENSION_COUNT = 9;
 
 const consoleSpy = jest.spyOn(console, 'log').mockImplementation();
 
+interface LooseObject {
+  [key: string]: string
+}
+
 describe('Class: Metrics', () => {
 
   const originalEnvironmentVariables = process.env;
@@ -75,6 +79,39 @@ describe('Class: Metrics', () => {
         expect(e.message).toBe(`Max dimension count of ${MAX_DIMENSION_COUNT} hit`);
       }
     });
+
+    test('Additional bulk dimensions should be added correctly', () => {
+      const additionalDimensions: LooseObject = { 'dimension2': 'dimension2Value', 'dimension3': 'dimension3Value' };
+      const metrics = new Metrics({ namespace: 'test' });
+
+      metrics.addMetric('test_name', MetricUnits.Seconds, 10);
+      metrics.addDimensions(additionalDimensions);
+      const loggedData = metrics.serializeMetrics();
+
+      expect(loggedData._aws.CloudWatchMetrics[0].Dimensions[0].length).toEqual(2);
+      Object.keys(additionalDimensions).forEach((key) => {
+
+        expect(loggedData[key]).toEqual(additionalDimensions[key]);
+      });
+    });
+
+    test('Bulk Adding more than max dimensions should throw error', () => {
+      expect.assertions(1);
+      const metrics = new Metrics();
+      const additionalDimensions: LooseObject = {};
+
+      metrics.addDimension(`Dimension-Initial`, `Dimension-InitialValue`);
+      for (let x =0; x < MAX_DIMENSION_COUNT ; x++) {
+        additionalDimensions[`dimension${x}`] = `dimension${x}Value`;
+      }
+
+      try {
+        metrics.addDimensions(additionalDimensions);
+      }
+      catch (e) {
+        expect(e.message).toBe(`Adding ${Object.keys(additionalDimensions).length} dimensions would exceed max dimension count of ${MAX_DIMENSION_COUNT}`);
+      }
+    });
   });
 
   describe('Feature: Metadata', () => {
@@ -100,10 +137,6 @@ describe('Class: Metrics', () => {
     test('Adding more than max default dimensions should throw error', () => {
       expect.assertions(1);
 
-      interface LooseObject {
-        [key: string]: string
-      }
-
       const defaultDimensions: LooseObject = {};
       for (let x = 0; x < MAX_DIMENSION_COUNT + 1; x ++) {
         defaultDimensions[`dimension-${x}`] = `value-${x}`;