Merge pull request #227 from horike37/feature/alarm_name_override

feat: support override for alarm logical id

Author: horike37

lib/deploy/stepFunctions/compileAlarms.js

@@ -47,7 +47,8 @@ function getCloudWatchAlarms(
     const cloudWatchMetricName = cloudWatchMetricNames[metricName];
     const AlarmDescription =
       `${stateMachineName}[${stage}][${region}]: ${alarmDescriptions[metricName]}`;
-    const logicalId = `${stateMachineLogicalId}${cloudWatchMetricName}Alarm`;
+    const defaultLogicalId = `${stateMachineLogicalId}${cloudWatchMetricName}Alarm`;
+    const logicalId = _.get(metric, 'logicalId', defaultLogicalId);
     const treatMissingData = _.get(metric, 'treatMissingData', defaultTreatMissingData);
 
     return {

lib/deploy/stepFunctions/compileAlarms.schema.js

@@ -25,6 +25,7 @@ const simpleMetric = Joi.string()
 
 const complexMetric = Joi.object().keys({
   metric: simpleMetric.required(),
+  logicalId: Joi.string(),
   treatMissingData,
 });
 

lib/deploy/stepFunctions/compileAlarms.test.js

@@ -380,4 +380,43 @@ describe('#compileAlarms', () => {
 
     expect(consoleLogSpy.callCount).equal(0);
   });
+
+  it('should allow alarms to override default logical ID', () => {
+    const genStateMachine = (name) => ({
+      name,
+      definition: {
+        StartAt: 'A',
+        States: {
+          A: {
+            Type: 'Pass',
+            End: true,
+          },
+        },
+      },
+      alarms: {
+        topics: {
+          ok: '${self:service}-${opt:stage}-alerts-ok',
+          alarm: '${self:service}-${opt:stage}-alerts-alarm',
+          insufficientData: '${self:service}-${opt:stage}-alerts-missing',
+        },
+        metrics: [
+          { metric: 'executionsFailed', logicalId: 'MyAlarm', treatMissingData: 'breaching' },
+        ],
+        treatMissingData: 'ignore',
+      },
+    });
+
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine: genStateMachine('stateMachineBeta'),
+      },
+    };
+
+    serverlessStepFunctions.compileAlarms();
+    const resources = serverlessStepFunctions.serverless.service
+      .provider.compiledCloudFormationTemplate.Resources;
+
+    expect(resources).to.have.property('MyAlarm');
+    expect(consoleLogSpy.callCount).equal(0);
+  });
 });