Cleanup

Author: kibertoad

packages/core/lib/index.ts

@@ -107,6 +107,8 @@ export { type ParseMessageResult, parseMessage } from './utils/parseUtils.ts'
 export { objectToBuffer } from './utils/queueUtils.ts'
 export {
   isStartupResourcePollingEnabled,
+  type PollingErrorCallback,
+  type PollingErrorContext,
   type StartupResourcePollingCheckResult,
   StartupResourcePollingTimeoutError,
   type WaitForResourceOptions,

packages/core/lib/utils/startupResourcePollingUtils.ts

@@ -4,6 +4,22 @@ import { NO_TIMEOUT, type StartupResourcePollingConfig } from '../types/queueOpt
 
 const DEFAULT_POLLING_INTERVAL_MS = 5000
 
+/**
+ * Context passed to error callbacks indicating whether the error is final.
+ */
+export type PollingErrorContext = {
+  /**
+   * If true, the operation has stopped and will not retry.
+   * If false, this is a transient error and the operation will continue.
+   */
+  isFinal: boolean
+}
+
+/**
+ * Callback invoked when a polling operation fails.
+ */
+export type PollingErrorCallback = (error: Error, context: PollingErrorContext) => void
+
 export type StartupResourcePollingCheckResult<T> =
   | {
       isAvailable: true
@@ -54,7 +70,7 @@ export type WaitForResourceOptions<T> = {
    * This can happen due to polling timeout or unexpected errors during polling.
    * Only used when config.nonBlocking is true.
    */
-  onError?: (error: Error) => void
+  onError?: PollingErrorCallback
 }
 
 export class StartupResourcePollingTimeoutError extends Error {
@@ -314,7 +330,9 @@ export async function waitForResource<T>(
             resourceName,
             error,
           })
-          onError?.(error)
+          // isFinal: true because pollForResource only throws when it gives up
+          // (timeout with throwOnTimeout: true, or unexpected error)
+          onError?.(error, { isFinal: true })
         })
     })
 

packages/sns/README.md

@@ -598,10 +598,16 @@ const result = await initSnsSqs(
       console.log('Queue URL:', queueUrl)
     },
 
-    // Called if background polling fails (e.g., timeout)
-    onResourcesError: (error) => {
-      console.error('Failed to wait for resources:', error.message)
-      // Handle error - maybe alert, retry, or graceful degradation
+    // Called if background polling fails (e.g., timeout or unexpected error)
+    onResourcesError: (error, context) => {
+      if (context.isFinal) {
+        // Polling has stopped and will not retry
+        console.error('Failed to wait for resources:', error.message)
+        // Handle error - maybe alert, retry, or graceful degradation
+      } else {
+        // Transient error, polling will continue
+        console.warn('Transient error while polling:', error.message)
+      }
     },
   },
 )

packages/sns/lib/utils/snsInitter.ts

@@ -2,7 +2,7 @@ import type { CreateTopicCommandInput, SNSClient } from '@aws-sdk/client-sns'
 import type { CreateQueueCommandInput, SQSClient } from '@aws-sdk/client-sqs'
 import type { STSClient } from '@aws-sdk/client-sts'
 import { type Either, isError } from '@lokalise/node-core'
-import type { DeletionConfig, ExtraParams } from '@message-queue-toolkit/core'
+import type { DeletionConfig, ExtraParams, PollingErrorCallback } from '@message-queue-toolkit/core'
 import {
   isProduction,
   isStartupResourcePollingEnabled,
@@ -35,7 +35,7 @@ async function pollForTopic(
   startupResourcePolling: NonNullable<SNSSQSQueueLocatorType['startupResourcePolling']>,
   extraParams?: ExtraParams,
   onResourceAvailable?: () => void,
-  onError?: (error: Error) => void,
+  onError?: PollingErrorCallback,
 ): Promise<TopicPollingResult> {
   const topicResult = await waitForResource({
     config: startupResourcePolling,
@@ -132,7 +132,8 @@ async function createSubscriptionWithPolling(
         topicArn,
         error,
       })
-      extraParams?.onResourcesError?.(error)
+      // Subscription creation failure is final - we don't retry
+      extraParams?.onResourcesError?.(error, { isFinal: true })
     }
   }
 
@@ -181,7 +182,7 @@ async function pollForQueue(
   startupResourcePolling: NonNullable<SNSSQSQueueLocatorType['startupResourcePolling']>,
   extraParams?: ExtraParams,
   onResourceAvailable?: () => void,
-  onError?: (error: Error) => void,
+  onError?: PollingErrorCallback,
 ): Promise<unknown | undefined> {
   return await waitForResource({
     config: startupResourcePolling,
@@ -210,7 +211,7 @@ export type InitSnsSqsExtraParams = ExtraParams & {
    * Callback invoked when background resource polling or subscription creation fails in non-blocking mode.
    * This can happen due to polling timeout or subscription creation failure.
    */
-  onResourcesError?: (error: Error) => void
+  onResourcesError?: PollingErrorCallback
 }
 
 export type InitSnsExtraParams = ExtraParams & {
@@ -339,8 +340,8 @@ export async function initSnsSqs(
         topicAvailable = true
         notifyIfBothReady()
       },
-      (error) => {
-        extraParams?.onResourcesError?.(error)
+      (error, context) => {
+        extraParams?.onResourcesError?.(error, context)
       },
     )
 
@@ -366,8 +367,8 @@ export async function initSnsSqs(
           queueAvailable = true
           notifyIfBothReady()
         },
-        (error) => {
-          extraParams?.onResourcesError?.(error)
+        (error, context) => {
+          extraParams?.onResourcesError?.(error, context)
         },
       ).then((result) => {
         // If queue was immediately available, pollForQueue returns the result

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

@@ -363,6 +363,7 @@ describe('SnsSqsPermissionConsumer - startupResourcePollingConfig', () => {
 
       let errorCallbackInvoked = false
       let callbackError: Error | undefined
+      let callbackContext: { isFinal: boolean } | undefined
 
       const result = await initSnsSqs(
         sqsClient,
@@ -383,9 +384,10 @@ describe('SnsSqsPermissionConsumer - startupResourcePollingConfig', () => {
         undefined,
         undefined,
         {
-          onResourcesError: (error) => {
+          onResourcesError: (error, context) => {
             errorCallbackInvoked = true
             callbackError = error
+            callbackContext = context
           },
         },
       )
@@ -408,6 +410,7 @@ describe('SnsSqsPermissionConsumer - startupResourcePollingConfig', () => {
 
       expect(callbackError).toBeDefined()
       expect(callbackError?.message).toContain('Timeout')
+      expect(callbackContext).toEqual({ isFinal: true })
     })
   })