refactor: Improve granularity of stack deployment error codes

serverless · May 19, 2021 · 8057cca · 8057cca
1 parent 4e49c9e
commit 8057cca
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/lib/plugins/aws/lib/monitorStack.js b/lib/plugins/aws/lib/monitorStack.js
@@ -7,6 +7,17 @@ const ServerlessError = require('../../../serverless-error');
 
 const validStatuses = new Set(['CREATE_COMPLETE', 'UPDATE_COMPLETE', 'DELETE_COMPLETE']);
 
+const normalizerPattern = /(?<!^)([A-Z])/g;
+const resourceTypePattern = /^(?<domain>[^:]+)::(?<service>[^:]+)(?:::(?<method>.+))?$/;
+const resourceTypeToErrorCodePostfix = (resourceType) => {
+  const { domain, service, method } = resourceType.match(resourceTypePattern).groups;
+  if (domain !== 'AWS') return `_${domain.replace(normalizerPattern, '_$1').toUpperCase()}`;
+  return `_${service.replace(normalizerPattern, '_$1')}_${method.replace(
+    normalizerPattern,
+    '_$1'
+  )}`.toUpperCase();
+};
+
 module.exports = {
   async checkStackProgress(
     action,
@@ -91,7 +102,17 @@ module.exports = {
                 let errorMessage = 'An error occurred: ';
                 errorMessage += `${stackLatestError.LogicalResourceId} - `;
                 errorMessage += `${stackLatestError.ResourceStatusReason}.`;
-                throw new ServerlessError(errorMessage, 'STACK_OPERATION_FAILURE');
+                const errorCode = (() => {
+                  if (
+                    stackLatestError.ResourceStatusReason.startsWith('Properties validation failed')
+                  ) {
+                    return `AWS_STACK_${action.toUpperCase()}_VALIDATION_ERROR`;
+                  }
+                  return `AWS_STACK_${action.toUpperCase()}${resourceTypeToErrorCodePostfix(
+                    stackLatestError.ResourceType
+                  )}_${stackLatestError.ResourceStatus}`;
+                })();
+                throw new ServerlessError(errorMessage, errorCode);
               }
             },
             (e) => {

diff --git a/test/unit/lib/plugins/aws/lib/monitorStack.test.js b/test/unit/lib/plugins/aws/lib/monitorStack.test.js
@@ -407,7 +407,7 @@ describe('monitorStack', () => {
             EventId: '1e2f3g4h',
             StackName: 'new-service-dev',
             LogicalResourceId: 'mochaS3',
-            ResourceType: 'S3::Bucket',
+            ResourceType: 'AWS::S3::Bucket',
             Timestamp: new Date(),
             ResourceStatus: 'CREATE_FAILED',
             ResourceStatusReason: 'Bucket already exists',