chore: correctly filter failed cfn events for displaying error messages (#11815)

* chore: do not filter AWS::CloudFormation::Stack type failure events if they have valid error message

* Update packages/amplify-provider-awscloudformation/src/aws-utils/aws-cfn.js

Author: Amplifiyer

packages/amplify-provider-awscloudformation/src/__tests__/aws-utils/aws-cfn.test.js

@@ -60,4 +60,96 @@ describe('CloudFormation', () => {
     }
     cfn.progressBar.stop();
   });
+
+  describe('filterFailedStackEvents', () => {
+    test('that it does not filter stack events that are in eventToCategories map', async () => {
+      const eventsWithFailure = [
+        {
+          StackId: 'testStackId1',
+          LogicalResourceId: 'testLogicalResourceId1',
+          ResourceType: 'AWS::IAM::Role',
+          ResourceStatusReason: 'Some valid reason',
+        },
+        {
+          StackId: 'testStackId2',
+          LogicalResourceId: 'testLogicalResourceId2',
+          ResourceType: 'AWS::IAM::Role',
+          ResourceStatusReason: 'Some valid reason',
+        },
+      ];
+
+      const eventMap = {
+        rootResources: [],
+        eventToCategories: new Map(),
+        categories: [],
+      };
+      // Only testLogicalResourceId1 is in the eventToCategories Map
+      eventMap.eventToCategories.set('testLogicalResourceId1', 'testLogicalResourceId1-value');
+      const cfn = await new CloudFormation();
+      cfn.eventMap = eventMap;
+      const filteredEvents = cfn.filterFailedStackEvents(eventsWithFailure);
+
+      // Only testStackId1 event should be returned since that's the only one in eventToCategories map
+      expect(filteredEvents).toEqual(eventsWithFailure.filter(e => e.StackId == 'testStackId1'));
+    });
+
+    test('that it filters stack events with cascade failure reasons', async () => {
+      const eventsWithFailure = [
+        {
+          StackId: 'testStackId1',
+          LogicalResourceId: 'testLogicalResourceId1',
+          ResourceType: 'AWS::IAM::Role',
+          ResourceStatusReason: 'Resource creation cancelled',
+        },
+      ];
+
+      const eventMap = {
+        rootResources: [],
+        eventToCategories: new Map(),
+        categories: [],
+      };
+      eventMap.eventToCategories.set('testLogicalResourceId1', 'testLogicalResourceId1-value');
+      const cfn = await new CloudFormation();
+      cfn.eventMap = eventMap;
+      const filteredEvents = cfn.filterFailedStackEvents(eventsWithFailure);
+      expect(filteredEvents).toEqual([]); // empty array
+    });
+
+    test('that it only filters resource of type AWS::CloudFormation::Stack with generic error message', async () => {
+      const eventsWithFailure = [
+        {
+          StackId: 'testStackId1',
+          LogicalResourceId: 'testLogicalResourceId1',
+          ResourceType: 'AWS::CloudFormation::Stack',
+          ResourceStatusReason: 'The following resource(s) failed to create: [LambdaExecutionRole]. ',
+        },
+        {
+          StackId: 'testStackId2',
+          LogicalResourceId: 'testLogicalResourceId2',
+          ResourceType: 'AWS::CloudFormation::Stack',
+          ResourceStatusReason: 'Some valid stack failure message',
+        },
+      ];
+
+      const eventMap = {
+        rootResources: [
+          {
+            category: 'resourceCategory1',
+            key: 'testLogicalResourceId1',
+          },
+          {
+            category: 'resourceCategory2',
+            key: 'testLogicalResourceId2',
+          },
+        ],
+        categories: [],
+      };
+      const cfn = await new CloudFormation();
+      cfn.eventMap = eventMap;
+      const filteredEvents = cfn.filterFailedStackEvents(eventsWithFailure);
+
+      // Should not filter testStackId1 event that has a specific error message
+      expect(filteredEvents).toEqual(eventsWithFailure.filter(e => e.StackId == 'testStackId2'));
+    });
+  });
 });

packages/amplify-provider-awscloudformation/src/aws-utils/aws-cfn.js

@@ -30,6 +30,8 @@ const CNF_ERROR_STATUS = ['CREATE_FAILED', 'DELETE_FAILED', 'UPDATE_FAILED'];
 
 // These are cascade failures caused because of a root failure. Safe to ignore
 const RESOURCE_CASCADE_FAIL_REASONS = ['Resource creation cancelled', 'Resource update cancelled'];
+
+const STACK_RESOURCE_FILTER_FAIL_REASON = 'The following resource(s) failed';
 class CloudFormation {
   constructor(context, userAgentAction, options = {}, eventMap = {}) {
     return (async () => {
@@ -177,8 +179,17 @@ class CloudFormation {
    */
   filterFailedStackEvents(eventsWithFailure) {
     return eventsWithFailure
-      .filter(stack => stack.ResourceType !== 'AWS::CloudFormation::Stack')
-      .filter(stack => this.eventMap['eventToCategories'].has(stack.LogicalResourceId))
+      .filter(
+        stack =>
+          stack.ResourceType !== 'AWS::CloudFormation::Stack' ||
+          (stack.ResourceStatusReason && !stack.ResourceStatusReason.includes(STACK_RESOURCE_FILTER_FAIL_REASON)),
+      )
+      .filter(
+        stack =>
+          (this.eventMap['eventToCategories'] && this.eventMap['eventToCategories'].has(stack.LogicalResourceId)) ||
+          (this.eventMap['rootResources'] &&
+            this.eventMap['rootResources'].some(resource => resource.key === stack.LogicalResourceId)),
+      )
       .filter(stack => !RESOURCE_CASCADE_FAIL_REASONS.includes(stack.ResourceStatusReason));
   }