Removing topic ARN look-up and using ARN internal build method (#342)

* Removing topic ARN look up and using ARN building

* Fixing minor issue

* Adding check to avoid possible issues

* Release prepare

Author: CarlosGamero

packages/sns/lib/utils/snsInitter.ts

@@ -15,13 +15,8 @@ import type { SNSSQSQueueLocatorType } from '../sns/AbstractSnsSqsConsumer.ts'
 import { isCreateTopicCommand, type TopicResolutionOptions } from '../types/TopicTypes.ts'
 import type { SNSSubscriptionOptions } from './snsSubscriber.ts'
 import { subscribeToTopic } from './snsSubscriber.ts'
-import {
-  assertTopic,
-  deleteSubscription,
-  deleteTopic,
-  getTopicArnByName,
-  getTopicAttributes,
-} from './snsUtils.ts'
+import { assertTopic, deleteSubscription, deleteTopic, getTopicAttributes } from './snsUtils.ts'
+import { buildTopicArn } from './stsUtils.js'
 
 // biome-ignore lint/complexity/noExcessiveCognitiveComplexity: fixme
 export async function initSnsSqs(
@@ -93,7 +88,7 @@ export async function initSnsSqs(
   const checkPromises: Promise<Either<'not_found', unknown>>[] = []
   // Check for existing resources, using the locators
   const subscriptionTopicArn =
-    locatorConfig.topicArn ?? (await getTopicArnByName(snsClient, locatorConfig.topicName))
+    locatorConfig.topicArn ?? (await buildTopicArn(stsClient, locatorConfig.topicName ?? ''))
   const topicPromise = getTopicAttributes(snsClient, subscriptionTopicArn)
   checkPromises.push(topicPromise)
 
@@ -212,16 +207,21 @@ export async function initSns(
   creationConfig?: SNSCreationConfig,
 ) {
   if (locatorConfig) {
+    if (!locatorConfig.topicArn && !locatorConfig.topicName) {
+      throw new Error(
+        'When locatorConfig for the topic is specified, either topicArn or topicName must be specified',
+      )
+    }
+
     const topicArn =
-      locatorConfig.topicArn ?? (await getTopicArnByName(snsClient, locatorConfig.topicName))
+      locatorConfig.topicArn ?? (await buildTopicArn(stsClient, locatorConfig.topicName ?? ''))
+
     const checkResult = await getTopicAttributes(snsClient, topicArn)
     if (checkResult.error === 'not_found') {
       throw new Error(`Topic with topicArn ${locatorConfig.topicArn} does not exist.`)
     }
 
-    return {
-      topicArn,
-    }
+    return { topicArn }
   }
 
   // create new topic if it does not exist
@@ -236,7 +236,6 @@ export async function initSns(
     allowedSourceOwner: creationConfig.allowedSourceOwner,
     forceTagUpdate: creationConfig.forceTagUpdate,
   })
-  return {
-    topicArn,
-  }
+
+  return { topicArn }
 }

packages/sns/lib/utils/snsSubscriber.ts

@@ -2,6 +2,7 @@ import type { SNSClient, SubscribeCommandInput } from '@aws-sdk/client-sns'
 import { SetSubscriptionAttributesCommand, SubscribeCommand } from '@aws-sdk/client-sns'
 import type { CreateQueueCommandInput, SQSClient } from '@aws-sdk/client-sqs'
 import type { STSClient } from '@aws-sdk/client-sts'
+import { InternalError, stringValueSerializer } from '@lokalise/node-core'
 import type { ExtraParams } from '@message-queue-toolkit/core'
 import type { ExtraSQSCreationParams } from '@message-queue-toolkit/sqs'
 import { assertQueue } from '@message-queue-toolkit/sqs'
@@ -11,7 +12,8 @@ import {
   isSNSTopicLocatorType,
   type TopicResolutionOptions,
 } from '../types/TopicTypes.ts'
-import { assertTopic, findSubscriptionByTopicAndQueue, getTopicArnByName } from './snsUtils.ts'
+import { assertTopic, findSubscriptionByTopicAndQueue } from './snsUtils.ts'
+import { buildTopicArn } from './stsUtils.js'
 
 export type SNSSubscriptionOptions = Omit<
   SubscribeCommandInput,
@@ -24,12 +26,11 @@ async function resolveTopicArnToSubscribeTo(
   topicConfiguration: TopicResolutionOptions,
   extraParams: (ExtraSNSCreationParams & ExtraSQSCreationParams & ExtraParams) | undefined,
 ) {
-  //If topicArn is present, let's use it and return early.
-  if (isSNSTopicLocatorType(topicConfiguration) && topicConfiguration.topicArn) {
-    return topicConfiguration.topicArn
+  if (isSNSTopicLocatorType(topicConfiguration)) {
+    if (topicConfiguration.topicArn) return topicConfiguration.topicArn
+    if (topicConfiguration.topicName) return buildTopicArn(stsClient, topicConfiguration.topicName)
   }
 
-  //If input configuration is capable of creating a topic, let's create it and return its ARN.
   if (isCreateTopicCommand(topicConfiguration)) {
     return await assertTopic(snsClient, stsClient, topicConfiguration, {
       queueUrlsWithSubscribePermissionsPrefix: extraParams?.queueUrlsWithSubscribePermissionsPrefix,
@@ -38,8 +39,11 @@ async function resolveTopicArnToSubscribeTo(
     })
   }
 
-  //Last option: let's not create a topic but resolve a ARN based on the desired topic name.
-  return await getTopicArnByName(snsClient, topicConfiguration.topicName)
+  throw new InternalError({
+    errorCode: 'invalid_topic_configuration',
+    message: 'Invalid topic configuration provided, cannot resolve topic ARN',
+    details: { topicConfiguration: stringValueSerializer(topicConfiguration) },
+  })
 }
 
 export async function subscribeToTopic(

packages/sns/lib/utils/snsUtils.ts

@@ -6,7 +6,6 @@ import {
   GetTopicAttributesCommand,
   ListSubscriptionsByTopicCommand,
   ListTagsForResourceCommand,
-  paginateListTopics,
   SetTopicAttributesCommand,
   type SNSClient,
   TagResourceCommand,
@@ -182,23 +181,6 @@ export async function findSubscriptionByTopicAndQueue(
   })
 }
 
-export async function getTopicArnByName(snsClient: SNSClient, topicName?: string): Promise<string> {
-  if (!topicName) {
-    throw new Error('topicName is not provided')
-  }
-
-  // Use paginator to automatically handle NextToken
-  const paginator = paginateListTopics({ client: snsClient }, {})
-  for await (const page of paginator) {
-    for (const topic of page.Topics || []) {
-      if (topic.TopicArn?.includes(topicName)) {
-        return topic.TopicArn
-      }
-    }
-  }
-  throw new Error(`Failed to resolve topic by name ${topicName}`)
-}
-
 /**
  * Calculates the size of an outgoing SNS message.
  *

packages/sns/package.json

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