Using InternalError to provide detailed info on topic exists issue (#228)

* Using InternalError to provide detailed info when the topic already exists

* patch version

Author: CarlosGamero

packages/sns/lib/utils/snsUtils.ts

@@ -1,5 +1,6 @@
 import {
   type CreateTopicCommandInput,
+  ListTagsForResourceCommand,
   type SNSClient,
   TagResourceCommand,
   paginateListTopics,
@@ -13,7 +14,7 @@ import {
   SetTopicAttributesCommand,
   UnsubscribeCommand,
 } from '@aws-sdk/client-sns'
-import { type Either, isError } from '@lokalise/node-core'
+import { type Either, InternalError, isError } from '@lokalise/node-core'
 import { calculateOutgoingMessageSize as sqsCalculateOutgoingMessageSize } from '@message-queue-toolkit/sqs'
 
 import type { ExtraSNSCreationParams } from '../sns/AbstractSnsService'
@@ -92,12 +93,26 @@ export async function assertTopic(
     const response = await snsClient.send(command)
     if (!response.TopicArn) throw new Error('No topic arn in response')
     topicArn = response.TopicArn
-  } catch (err) {
-    // We only manually build ARN in case of tag update
-    if (!extraParams?.forceTagUpdate) throw err
+  } catch (error) {
+    if (!isError(error)) throw error
     // To build ARN we need topic name and error should be "topic already exist with different tags"
-    if (!topicOptions.Name || !isTopicAlreadyExistWithDifferentTagsError(err)) throw err
+    if (!topicOptions.Name || !isTopicAlreadyExistWithDifferentTagsError(error)) throw error
+
     topicArn = await buildTopicArn(stsClient, topicOptions.Name)
+    if (!extraParams?.forceTagUpdate) {
+      const currentTags = await snsClient.send(
+        new ListTagsForResourceCommand({ ResourceArn: topicArn }),
+      )
+      throw new InternalError({
+        message: `${topicOptions.Name} - ${error.message}`,
+        details: {
+          currentTags: JSON.stringify(currentTags),
+          newTags: JSON.stringify(topicOptions.Tags),
+        },
+        errorCode: 'SNS_TOPIC_ALREADY_EXISTS_WITH_DIFFERENT_TAGS',
+        cause: error,
+      })
+    }
   }
 
   if (extraParams?.queueUrlsWithSubscribePermissionsPrefix || extraParams?.allowedSourceOwner) {

packages/sns/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/sns",
-  "version": "18.0.0",
+  "version": "18.0.1",
   "private": false,
   "license": "MIT",
   "description": "SNS adapter for message-queue-toolkit",

packages/sns/test/consumers/SnsSqsPermissionConsumer.spec.ts

@@ -275,19 +275,19 @@ describe('SnsSqsPermissionConsumer', () => {
         })
 
         await expect(consumer.init()).rejects.toThrowError(
-          /Topic already exists with different tags/,
+          `${topicNome} - Invalid parameter: Tags Reason: Topic already exists with different tags`,
         )
       })
 
       it('updates existing queue and topic tags when update is forced', async () => {
         const initialTopicTags = [
-          { Key: 'project', Value: 'some-project' },
-          { Key: 'service', Value: 'some-service' },
-          { Key: 'leftover', Value: 'some-leftover' },
+          { Key: 'project', Value: 'sns-project' },
+          { Key: 'service', Value: 'sns-service' },
+          { Key: 'leftover', Value: 'sns-leftover' },
         ]
         const newTopicTags = [
-          { Key: 'project', Value: 'some-project' },
-          { Key: 'service', Value: 'changed-service' },
+          { Key: 'project', Value: 'sns-project' },
+          { Key: 'service', Value: 'sns-service-changed' },
           { Key: 'cc', Value: 'some-cc' },
         ]
 
@@ -299,13 +299,13 @@ describe('SnsSqsPermissionConsumer', () => {
         expect(preTopicTags.Tags).toEqual(initialTopicTags)
 
         const initialQueueTags = {
-          project: 'some-project',
-          service: 'some-service',
-          leftover: 'some-leftover',
+          project: 'sqs-project',
+          service: 'sqs-service',
+          leftover: 'sqs-leftover',
         }
         const newQueueTags = {
-          project: 'some-project',
-          service: 'changed-service',
+          project: 'sqs-project',
+          service: 'sqs-service-changed',
           cc: 'some-cc',
         }
         const assertResult = await assertQueue(sqsClient, {
@@ -336,7 +336,7 @@ describe('SnsSqsPermissionConsumer', () => {
         const tags = postTopicTags.Tags
         expect(tags).toHaveLength(4)
         expect(postTopicTags.Tags).toEqual(
-          expect.arrayContaining([...newTopicTags, { Key: 'leftover', Value: 'some-leftover' }]),
+          expect.arrayContaining([...newTopicTags, { Key: 'leftover', Value: 'sns-leftover' }]),
         )
 
         const updateQueueCall = sqsSpy.mock.calls.find((entry) => {
@@ -347,7 +347,7 @@ describe('SnsSqsPermissionConsumer', () => {
         const postQueueTags = await getQueueTags(assertResult.queueUrl)
         expect(postQueueTags.Tags).toEqual({
           ...newQueueTags,
-          leftover: 'some-leftover',
+          leftover: 'sqs-leftover',
         })
       })
     })

packages/sns/test/publishers/SnsPermissionPublisher.spec.ts

@@ -171,7 +171,7 @@ describe('SnsPermissionPublisher', () => {
         })
 
         await expect(newPublisher.init()).rejects.toThrowError(
-          /Topic already exists with different tags/,
+          `${topicNome} - Invalid parameter: Tags Reason: Topic already exists with different tags`,
         )
       })
     })