@message-queue-toolkit/sns 24.5.0 → 24.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/sns/AbstractSnsService.d.ts +2 -0
- package/dist/sns/AbstractSnsService.js +3 -1
- package/dist/sns/AbstractSnsService.js.map +1 -1
- package/dist/sns/fakes/TestSnsPublisher.d.ts +105 -0
- package/dist/sns/fakes/TestSnsPublisher.js +108 -0
- package/dist/sns/fakes/TestSnsPublisher.js.map +1 -0
- package/dist/utils/snsSubscriber.js +4 -1
- package/dist/utils/snsSubscriber.js.map +1 -1
- package/dist/utils/snsUtils.d.ts +2 -2
- package/dist/utils/snsUtils.js +2 -2
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @message-queue-toolkit/sns
|
|
2
2
|
|
|
3
|
-
AWS SNS (Simple Notification Service) implementation for the message-queue-toolkit. Provides a robust, type-safe
|
|
3
|
+
AWS SNS (Simple Notification Service) implementation for the message-queue-toolkit. Provides a robust, type-safe
|
|
4
|
+
abstraction for publishing messages to SNS topics and consuming them via SQS queue subscriptions, with support for both
|
|
5
|
+
standard and FIFO topics.
|
|
4
6
|
|
|
5
7
|
## Table of Contents
|
|
6
8
|
|
package/dist/index.d.ts
CHANGED
|
@@ -7,6 +7,7 @@ export type { SNSSQSConsumerDependencies, SNSSQSConsumerOptions, SNSSQSCreationC
|
|
|
7
7
|
export { AbstractSnsSqsConsumer } from './sns/AbstractSnsSqsConsumer.ts';
|
|
8
8
|
export * from './sns/CommonSnsPublisherFactory.ts';
|
|
9
9
|
export { FakeConsumer } from './sns/fakes/FakeConsumer.ts';
|
|
10
|
+
export { TestSnsPublisher, type TestSnsPublishOptions } from './sns/fakes/TestSnsPublisher.ts';
|
|
10
11
|
export * from './sns/SnsPublisherManager.ts';
|
|
11
12
|
export type { CommonMessage } from './types/MessageTypes.ts';
|
|
12
13
|
export { generateFilterAttributes, generateTopicSubscriptionPolicy, } from './utils/snsAttributeUtils.ts';
|
package/dist/index.js
CHANGED
|
@@ -4,6 +4,7 @@ export { AbstractSnsService, SNS_MESSAGE_MAX_SIZE } from "./sns/AbstractSnsServi
|
|
|
4
4
|
export { AbstractSnsSqsConsumer } from "./sns/AbstractSnsSqsConsumer.js";
|
|
5
5
|
export * from "./sns/CommonSnsPublisherFactory.js";
|
|
6
6
|
export { FakeConsumer } from "./sns/fakes/FakeConsumer.js";
|
|
7
|
+
export { TestSnsPublisher } from "./sns/fakes/TestSnsPublisher.js";
|
|
7
8
|
export * from "./sns/SnsPublisherManager.js";
|
|
8
9
|
export { generateFilterAttributes, generateTopicSubscriptionPolicy, } from "./utils/snsAttributeUtils.js";
|
|
9
10
|
export { initSns, initSnsSqs, } from "./utils/snsInitter.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAA;AAE/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AAQpE,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAQtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAA;AACxE,cAAc,oCAAoC,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,cAAc,8BAA8B,CAAA;AAE5C,OAAO,EACL,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAGL,OAAO,EACP,UAAU,GACX,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EACL,WAAW,EACX,4BAA4B,EAC5B,kBAAkB,EAClB,WAAW,EACX,+BAA+B,EAC/B,yBAAyB,EACzB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,GACtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAA;AAE/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AAQpE,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAQtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAA;AACxE,cAAc,oCAAoC,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAA8B,MAAM,iCAAiC,CAAA;AAC9F,cAAc,8BAA8B,CAAA;AAE5C,OAAO,EACL,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAGL,OAAO,EACP,UAAU,GACX,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EACL,WAAW,EACX,4BAA4B,EAC5B,kBAAkB,EAClB,WAAW,EACX,+BAA+B,EAC/B,yBAAyB,EACzB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,GACtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA"}
|
|
@@ -3,6 +3,8 @@ import type { STSClient } from '@aws-sdk/client-sts';
|
|
|
3
3
|
import type { BaseQueueLocatorType, QueueDependencies, QueueOptions } from '@message-queue-toolkit/core';
|
|
4
4
|
import { AbstractQueueService } from '@message-queue-toolkit/core';
|
|
5
5
|
import type { SNS_MESSAGE_BODY_TYPE } from '../types/MessageTypes.ts';
|
|
6
|
+
export declare const SNS_MESSAGE_HARD_LIMIT: number;
|
|
7
|
+
export declare const SNS_MESSAGE_ATTRIBUTE_BUFFER: number;
|
|
6
8
|
export declare const SNS_MESSAGE_MAX_SIZE: number;
|
|
7
9
|
export type SNSDependencies = QueueDependencies & {
|
|
8
10
|
snsClient: SNSClient;
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { AbstractQueueService } from '@message-queue-toolkit/core';
|
|
2
2
|
import { deleteSns, initSns } from "../utils/snsInitter.js";
|
|
3
3
|
// https://docs.aws.amazon.com/general/latest/gr/sns.html
|
|
4
|
-
export const
|
|
4
|
+
export const SNS_MESSAGE_HARD_LIMIT = 256 * 1024; // 256KB - AWS SNS total message size limit (body + attributes)
|
|
5
|
+
export const SNS_MESSAGE_ATTRIBUTE_BUFFER = 30 * 1024; // 30KB - reserved space for message attributes and overhead
|
|
6
|
+
export const SNS_MESSAGE_MAX_SIZE = SNS_MESSAGE_HARD_LIMIT - SNS_MESSAGE_ATTRIBUTE_BUFFER; // 226KB - maximum allowed message body size
|
|
5
7
|
export class AbstractSnsService extends AbstractQueueService {
|
|
6
8
|
snsClient;
|
|
7
9
|
stsClient;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractSnsService.js","sourceRoot":"","sources":["../../lib/sns/AbstractSnsService.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAElE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAE3D,yDAAyD;AACzD,MAAM,CAAC,MAAM,
|
|
1
|
+
{"version":3,"file":"AbstractSnsService.js","sourceRoot":"","sources":["../../lib/sns/AbstractSnsService.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAElE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAE3D,yDAAyD;AACzD,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,GAAG,IAAI,CAAA,CAAC,+DAA+D;AAChH,MAAM,CAAC,MAAM,4BAA4B,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,4DAA4D;AAClH,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAAsB,GAAG,4BAA4B,CAAA,CAAC,4CAA4C;AAyCtI,MAAM,OAAgB,kBAKpB,SAAQ,oBAOT;IACoB,SAAS,CAAW;IACpB,SAAS,CAAW;IACvC,mBAAmB;IACT,QAAQ,CAAQ;IAE1B,YAAY,YAA8B,EAAE,OAAuB;QACjE,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAE5B,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAA;QACvC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAA;IACzC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC/C,MAAM,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;QAC3F,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,OAAO,CAC9B,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,cAAc,EACnB,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CACxB,CAAA;QACD,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAA;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;IACvB,CAAC;IAEe,KAAK;QACnB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC1B,CAAC;CACF"}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import type { SNSClient } from '@aws-sdk/client-sns';
|
|
2
|
+
import type { STSClient } from '@aws-sdk/client-sts';
|
|
3
|
+
import type { AbstractSnsPublisher } from '../AbstractSnsPublisher.ts';
|
|
4
|
+
import type { AbstractSnsSqsConsumer } from '../AbstractSnsSqsConsumer.ts';
|
|
5
|
+
/**
|
|
6
|
+
* Options for publishing messages with TestSnsPublisher.
|
|
7
|
+
* Supports multiple mutually exclusive ways to specify the target topic.
|
|
8
|
+
*/
|
|
9
|
+
export type TestSnsPublishOptions = {
|
|
10
|
+
topicArn: string;
|
|
11
|
+
topicName?: never;
|
|
12
|
+
consumer?: never;
|
|
13
|
+
publisher?: never;
|
|
14
|
+
MessageGroupId?: string;
|
|
15
|
+
MessageDeduplicationId?: string;
|
|
16
|
+
} | {
|
|
17
|
+
topicName: string;
|
|
18
|
+
topicArn?: never;
|
|
19
|
+
consumer?: never;
|
|
20
|
+
publisher?: never;
|
|
21
|
+
MessageGroupId?: string;
|
|
22
|
+
MessageDeduplicationId?: string;
|
|
23
|
+
} | {
|
|
24
|
+
consumer: AbstractSnsSqsConsumer<any, any, any>;
|
|
25
|
+
topicArn?: never;
|
|
26
|
+
topicName?: never;
|
|
27
|
+
publisher?: never;
|
|
28
|
+
MessageGroupId?: string;
|
|
29
|
+
MessageDeduplicationId?: string;
|
|
30
|
+
} | {
|
|
31
|
+
publisher: AbstractSnsPublisher<any>;
|
|
32
|
+
topicArn?: never;
|
|
33
|
+
topicName?: never;
|
|
34
|
+
consumer?: never;
|
|
35
|
+
MessageGroupId?: string;
|
|
36
|
+
MessageDeduplicationId?: string;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* TestSnsPublisher - A testing utility for publishing arbitrary messages to SNS topics without validation.
|
|
40
|
+
*
|
|
41
|
+
* This publisher bypasses all message validation, schema checking, deduplication, and payload offloading
|
|
42
|
+
* to enable testing edge cases, invalid messages, and integration scenarios.
|
|
43
|
+
*
|
|
44
|
+
* **IMPORTANT: This is a testing utility only. Do not use in production code.**
|
|
45
|
+
*
|
|
46
|
+
* Features:
|
|
47
|
+
* - Publish any JSON-serializable payload to any SNS topic
|
|
48
|
+
* - No Zod schema validation
|
|
49
|
+
* - No message deduplication
|
|
50
|
+
* - No payload offloading
|
|
51
|
+
* - Accept topicArn string or consumer/publisher instance per publish call
|
|
52
|
+
* - Automatically resolve topicArn from consumer/publisher
|
|
53
|
+
* - Support FIFO topic options (MessageGroupId, MessageDeduplicationId)
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```typescript
|
|
57
|
+
* // Create a single publisher for all topics
|
|
58
|
+
* const publisher = new TestSnsPublisher(snsClient, stsClient)
|
|
59
|
+
*
|
|
60
|
+
* // Publish to different topics
|
|
61
|
+
* await publisher.publish({ any: 'data' }, { topicArn: 'arn:aws:sns:...' })
|
|
62
|
+
* await publisher.publish({ test: 'message' }, { topicName: 'my-topic' })
|
|
63
|
+
* await publisher.publish({ test: 'message' }, { consumer: myConsumer })
|
|
64
|
+
* await publisher.publish({ other: 'data' }, { publisher: myPublisher })
|
|
65
|
+
*
|
|
66
|
+
* // FIFO topic with options
|
|
67
|
+
* await publisher.publish(
|
|
68
|
+
* { test: 'message' },
|
|
69
|
+
* {
|
|
70
|
+
* topicArn: 'arn:aws:sns:.../my-topic.fifo',
|
|
71
|
+
* MessageGroupId: 'group1',
|
|
72
|
+
* MessageDeduplicationId: 'unique-id'
|
|
73
|
+
* }
|
|
74
|
+
* )
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
export declare class TestSnsPublisher {
|
|
78
|
+
private readonly snsClient;
|
|
79
|
+
private readonly stsClient;
|
|
80
|
+
/**
|
|
81
|
+
* Creates a new TestSnsPublisher instance.
|
|
82
|
+
*
|
|
83
|
+
* @param snsClient - AWS SNS client instance
|
|
84
|
+
* @param stsClient - AWS STS client instance (needed for topic name to ARN resolution)
|
|
85
|
+
*/
|
|
86
|
+
constructor(snsClient: SNSClient, stsClient: STSClient);
|
|
87
|
+
/**
|
|
88
|
+
* Publishes a message to an SNS topic without any validation.
|
|
89
|
+
*
|
|
90
|
+
* @param payload - Any JSON-serializable object to publish
|
|
91
|
+
* @param options - Topic and message options
|
|
92
|
+
* @param options.topicArn - Direct topic ARN (mutually exclusive with topicName/consumer/publisher)
|
|
93
|
+
* @param options.topicName - Topic name to resolve to ARN (mutually exclusive with topicArn/consumer/publisher)
|
|
94
|
+
* @param options.consumer - Consumer instance to extract topic ARN from (mutually exclusive with topicArn/topicName/publisher)
|
|
95
|
+
* @param options.publisher - Publisher instance to extract topic ARN from (mutually exclusive with topicArn/topicName/consumer)
|
|
96
|
+
* @param options.MessageGroupId - Required for FIFO topics (topic name ends with .fifo)
|
|
97
|
+
* @param options.MessageDeduplicationId - Optional deduplication ID for FIFO topics
|
|
98
|
+
*
|
|
99
|
+
* @returns Promise that resolves when message is published
|
|
100
|
+
* @throws {Error} If none of topicArn/topicName/consumer/publisher is provided
|
|
101
|
+
* @throws {Error} If consumer/publisher has not been initialized (no topicArn available)
|
|
102
|
+
* @throws {Error} If SNS publish fails
|
|
103
|
+
*/
|
|
104
|
+
publish(payload: unknown, options: TestSnsPublishOptions): Promise<void>;
|
|
105
|
+
}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { PublishCommand } from '@aws-sdk/client-sns';
|
|
2
|
+
import { buildTopicArn } from "../../utils/stsUtils.js";
|
|
3
|
+
/**
|
|
4
|
+
* TestSnsPublisher - A testing utility for publishing arbitrary messages to SNS topics without validation.
|
|
5
|
+
*
|
|
6
|
+
* This publisher bypasses all message validation, schema checking, deduplication, and payload offloading
|
|
7
|
+
* to enable testing edge cases, invalid messages, and integration scenarios.
|
|
8
|
+
*
|
|
9
|
+
* **IMPORTANT: This is a testing utility only. Do not use in production code.**
|
|
10
|
+
*
|
|
11
|
+
* Features:
|
|
12
|
+
* - Publish any JSON-serializable payload to any SNS topic
|
|
13
|
+
* - No Zod schema validation
|
|
14
|
+
* - No message deduplication
|
|
15
|
+
* - No payload offloading
|
|
16
|
+
* - Accept topicArn string or consumer/publisher instance per publish call
|
|
17
|
+
* - Automatically resolve topicArn from consumer/publisher
|
|
18
|
+
* - Support FIFO topic options (MessageGroupId, MessageDeduplicationId)
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```typescript
|
|
22
|
+
* // Create a single publisher for all topics
|
|
23
|
+
* const publisher = new TestSnsPublisher(snsClient, stsClient)
|
|
24
|
+
*
|
|
25
|
+
* // Publish to different topics
|
|
26
|
+
* await publisher.publish({ any: 'data' }, { topicArn: 'arn:aws:sns:...' })
|
|
27
|
+
* await publisher.publish({ test: 'message' }, { topicName: 'my-topic' })
|
|
28
|
+
* await publisher.publish({ test: 'message' }, { consumer: myConsumer })
|
|
29
|
+
* await publisher.publish({ other: 'data' }, { publisher: myPublisher })
|
|
30
|
+
*
|
|
31
|
+
* // FIFO topic with options
|
|
32
|
+
* await publisher.publish(
|
|
33
|
+
* { test: 'message' },
|
|
34
|
+
* {
|
|
35
|
+
* topicArn: 'arn:aws:sns:.../my-topic.fifo',
|
|
36
|
+
* MessageGroupId: 'group1',
|
|
37
|
+
* MessageDeduplicationId: 'unique-id'
|
|
38
|
+
* }
|
|
39
|
+
* )
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export class TestSnsPublisher {
|
|
43
|
+
snsClient;
|
|
44
|
+
stsClient;
|
|
45
|
+
/**
|
|
46
|
+
* Creates a new TestSnsPublisher instance.
|
|
47
|
+
*
|
|
48
|
+
* @param snsClient - AWS SNS client instance
|
|
49
|
+
* @param stsClient - AWS STS client instance (needed for topic name to ARN resolution)
|
|
50
|
+
*/
|
|
51
|
+
constructor(snsClient, stsClient) {
|
|
52
|
+
this.snsClient = snsClient;
|
|
53
|
+
this.stsClient = stsClient;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Publishes a message to an SNS topic without any validation.
|
|
57
|
+
*
|
|
58
|
+
* @param payload - Any JSON-serializable object to publish
|
|
59
|
+
* @param options - Topic and message options
|
|
60
|
+
* @param options.topicArn - Direct topic ARN (mutually exclusive with topicName/consumer/publisher)
|
|
61
|
+
* @param options.topicName - Topic name to resolve to ARN (mutually exclusive with topicArn/consumer/publisher)
|
|
62
|
+
* @param options.consumer - Consumer instance to extract topic ARN from (mutually exclusive with topicArn/topicName/publisher)
|
|
63
|
+
* @param options.publisher - Publisher instance to extract topic ARN from (mutually exclusive with topicArn/topicName/consumer)
|
|
64
|
+
* @param options.MessageGroupId - Required for FIFO topics (topic name ends with .fifo)
|
|
65
|
+
* @param options.MessageDeduplicationId - Optional deduplication ID for FIFO topics
|
|
66
|
+
*
|
|
67
|
+
* @returns Promise that resolves when message is published
|
|
68
|
+
* @throws {Error} If none of topicArn/topicName/consumer/publisher is provided
|
|
69
|
+
* @throws {Error} If consumer/publisher has not been initialized (no topicArn available)
|
|
70
|
+
* @throws {Error} If SNS publish fails
|
|
71
|
+
*/
|
|
72
|
+
async publish(payload, options) {
|
|
73
|
+
let topicArn;
|
|
74
|
+
if (options.topicArn) {
|
|
75
|
+
topicArn = options.topicArn;
|
|
76
|
+
}
|
|
77
|
+
else if (options.topicName) {
|
|
78
|
+
topicArn = await buildTopicArn(this.stsClient, options.topicName);
|
|
79
|
+
}
|
|
80
|
+
else if (options.consumer) {
|
|
81
|
+
// @ts-expect-error - Accessing protected property for testing purposes
|
|
82
|
+
const consumerTopicArn = options.consumer.topicArn;
|
|
83
|
+
if (!consumerTopicArn) {
|
|
84
|
+
throw new Error('Consumer has not been initialized. Call consumer.init() before passing it to TestSnsPublisher.publish().');
|
|
85
|
+
}
|
|
86
|
+
topicArn = consumerTopicArn;
|
|
87
|
+
}
|
|
88
|
+
else if (options.publisher) {
|
|
89
|
+
// @ts-expect-error - Accessing protected property for testing purposes
|
|
90
|
+
const publisherTopicArn = options.publisher.topicArn;
|
|
91
|
+
if (!publisherTopicArn) {
|
|
92
|
+
throw new Error('Publisher has not been initialized. Call publisher.init() or publisher.publish() before passing it to TestSnsPublisher.publish().');
|
|
93
|
+
}
|
|
94
|
+
topicArn = publisherTopicArn;
|
|
95
|
+
}
|
|
96
|
+
else {
|
|
97
|
+
throw new Error('Either topicArn, topicName, consumer, or publisher must be provided in options');
|
|
98
|
+
}
|
|
99
|
+
const command = new PublishCommand({
|
|
100
|
+
TopicArn: topicArn,
|
|
101
|
+
Message: JSON.stringify(payload),
|
|
102
|
+
MessageGroupId: options.MessageGroupId,
|
|
103
|
+
MessageDeduplicationId: options.MessageDeduplicationId,
|
|
104
|
+
});
|
|
105
|
+
await this.snsClient.send(command);
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
//# sourceMappingURL=TestSnsPublisher.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TestSnsPublisher.js","sourceRoot":"","sources":["../../../lib/sns/fakes/TestSnsPublisher.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAGpD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAkDvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,OAAO,gBAAgB;IACV,SAAS,CAAW;IACpB,SAAS,CAAW;IAErC;;;;;OAKG;IACH,YAAY,SAAoB,EAAE,SAAoB;QACpD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,OAAO,CAAC,OAAgB,EAAE,OAA8B;QAC5D,IAAI,QAAgB,CAAA;QAEpB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAC7B,CAAC;aAAM,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YAC7B,QAAQ,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;QACnE,CAAC;aAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC5B,uEAAuE;YACvE,MAAM,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,QAA8B,CAAA;YACxE,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CACb,0GAA0G,CAC3G,CAAA;YACH,CAAC;YACD,QAAQ,GAAG,gBAAgB,CAAA;QAC7B,CAAC;aAAM,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YAC7B,uEAAuE;YACvE,MAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,QAA8B,CAAA;YAC1E,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CACb,mIAAmI,CACpI,CAAA;YACH,CAAC;YACD,QAAQ,GAAG,iBAAiB,CAAA;QAC9B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAA;QACH,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC;YACjC,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAChC,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,sBAAsB,EAAE,OAAO,CAAC,sBAAsB;SACvD,CAAC,CAAA;QAEF,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACpC,CAAC;CACF"}
|
|
@@ -54,9 +54,9 @@ export async function subscribeToTopic(sqsClient, snsClient, stsClient, queueCon
|
|
|
54
54
|
const errMessage = `Error while creating subscription for queue "${queueConfiguration.QueueName}", topic "${isCreateTopicCommand(topicConfiguration)
|
|
55
55
|
? topicConfiguration.Name
|
|
56
56
|
: topicConfiguration.topicName}": ${err.message}`;
|
|
57
|
-
logger.error(errMessage);
|
|
58
57
|
if (subscriptionConfiguration.updateAttributesIfExists &&
|
|
59
58
|
err.message.indexOf('Subscription already exists with different attributes') !== -1) {
|
|
59
|
+
logger.warn(`${errMessage}. Trying to update subscription`);
|
|
60
60
|
const result = await tryToUpdateSubscription(snsClient, topicArn, queueArn, subscriptionConfiguration);
|
|
61
61
|
if (result) {
|
|
62
62
|
return {
|
|
@@ -68,6 +68,9 @@ export async function subscribeToTopic(sqsClient, snsClient, stsClient, queueCon
|
|
|
68
68
|
}
|
|
69
69
|
logger.error('Failed to update subscription');
|
|
70
70
|
}
|
|
71
|
+
else {
|
|
72
|
+
logger.error(errMessage);
|
|
73
|
+
}
|
|
71
74
|
throw new InternalError({
|
|
72
75
|
errorCode: 'sns_subscription_creation_failed',
|
|
73
76
|
message: errMessage,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"snsSubscriber.js","sourceRoot":"","sources":["../../lib/utils/snsSubscriber.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gCAAgC,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAGxF,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAGnF,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAExD,OAAO,EACL,oBAAoB,EACpB,qBAAqB,GAEtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,WAAW,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAO7C,KAAK,UAAU,4BAA4B,CACzC,SAAoB,EACpB,SAAoB,EACpB,kBAA0C,EAC1C,WAAwF;IAExF,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC9C,IAAI,kBAAkB,CAAC,QAAQ;YAAE,OAAO,kBAAkB,CAAC,QAAQ,CAAA;QACnE,IAAI,kBAAkB,CAAC,SAAS;YAAE,OAAO,aAAa,CAAC,SAAS,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAA;IACjG,CAAC;IAED,IAAI,oBAAoB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC7C,OAAO,MAAM,WAAW,CAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE;YACjE,uCAAuC,EAAE,WAAW,EAAE,uCAAuC;YAC7F,kBAAkB,EAAE,WAAW,EAAE,kBAAkB;YACnD,cAAc,EAAE,WAAW,EAAE,cAAc;SAC5C,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,IAAI,aAAa,CAAC;QACtB,SAAS,EAAE,6BAA6B;QACxC,OAAO,EAAE,gEAAgE;QACzE,OAAO,EAAE,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,EAAE;KAC3E,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,SAAoB,EACpB,SAAoB,EACpB,SAAoB,EACpB,kBAA2C,EAC3C,kBAA0C,EAC1C,yBAAiD,EACjD,WAA2E;IAE3E,MAAM,QAAQ,GAAG,MAAM,4BAA4B,CACjD,SAAS,EACT,SAAS,EACT,kBAAkB,EAClB,WAAW,CACZ,CAAA;IAED,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,SAAS,EAAE,kBAAkB,EAAE;QAC9E,qCAAqC,EAAE,WAAW,EAAE,qCAAqC;QACzF,wBAAwB,EAAE,WAAW,EAAE,wBAAwB;QAC/D,cAAc,EAAE,WAAW,EAAE,cAAc;KAC5C,CAAC,CAAA;IAEF,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;QAC5C,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,KAAK;QACf,qBAAqB,EAAE,IAAI;QAC3B,GAAG,yBAAyB;KAC7B,CAAC,CAAA;IAEF,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACjE,OAAO;YACL,eAAe,EAAE,kBAAkB,CAAC,eAAe;YACnD,QAAQ;YACR,QAAQ;YACR,QAAQ;SACT,CAAA;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAAE,MAAM,GAAG,CAAA;QAE5B,MAAM,MAAM,GAAG,WAAW,EAAE,MAAM,IAAI,OAAO,CAAA;QAC7C,MAAM,UAAU,GAAG,gDAAgD,kBAAkB,CAAC,SAAS,aAC7F,oBAAoB,CAAC,kBAAkB,CAAC;YACtC,CAAC,CAAC,kBAAkB,CAAC,IAAI;YACzB,CAAC,CAAC,kBAAkB,CAAC,SACzB,MAAM,GAAG,CAAC,OAAO,EAAE,CAAA;
|
|
1
|
+
{"version":3,"file":"snsSubscriber.js","sourceRoot":"","sources":["../../lib/utils/snsSubscriber.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gCAAgC,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAGxF,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAGnF,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAExD,OAAO,EACL,oBAAoB,EACpB,qBAAqB,GAEtB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,WAAW,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAO7C,KAAK,UAAU,4BAA4B,CACzC,SAAoB,EACpB,SAAoB,EACpB,kBAA0C,EAC1C,WAAwF;IAExF,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC9C,IAAI,kBAAkB,CAAC,QAAQ;YAAE,OAAO,kBAAkB,CAAC,QAAQ,CAAA;QACnE,IAAI,kBAAkB,CAAC,SAAS;YAAE,OAAO,aAAa,CAAC,SAAS,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAA;IACjG,CAAC;IAED,IAAI,oBAAoB,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC7C,OAAO,MAAM,WAAW,CAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE;YACjE,uCAAuC,EAAE,WAAW,EAAE,uCAAuC;YAC7F,kBAAkB,EAAE,WAAW,EAAE,kBAAkB;YACnD,cAAc,EAAE,WAAW,EAAE,cAAc;SAC5C,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,IAAI,aAAa,CAAC;QACtB,SAAS,EAAE,6BAA6B;QACxC,OAAO,EAAE,gEAAgE;QACzE,OAAO,EAAE,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,EAAE;KAC3E,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,SAAoB,EACpB,SAAoB,EACpB,SAAoB,EACpB,kBAA2C,EAC3C,kBAA0C,EAC1C,yBAAiD,EACjD,WAA2E;IAE3E,MAAM,QAAQ,GAAG,MAAM,4BAA4B,CACjD,SAAS,EACT,SAAS,EACT,kBAAkB,EAClB,WAAW,CACZ,CAAA;IAED,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,SAAS,EAAE,kBAAkB,EAAE;QAC9E,qCAAqC,EAAE,WAAW,EAAE,qCAAqC;QACzF,wBAAwB,EAAE,WAAW,EAAE,wBAAwB;QAC/D,cAAc,EAAE,WAAW,EAAE,cAAc;KAC5C,CAAC,CAAA;IAEF,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC;QAC5C,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,KAAK;QACf,qBAAqB,EAAE,IAAI;QAC3B,GAAG,yBAAyB;KAC7B,CAAC,CAAA;IAEF,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACjE,OAAO;YACL,eAAe,EAAE,kBAAkB,CAAC,eAAe;YACnD,QAAQ;YACR,QAAQ;YACR,QAAQ;SACT,CAAA;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAAE,MAAM,GAAG,CAAA;QAE5B,MAAM,MAAM,GAAG,WAAW,EAAE,MAAM,IAAI,OAAO,CAAA;QAC7C,MAAM,UAAU,GAAG,gDAAgD,kBAAkB,CAAC,SAAS,aAC7F,oBAAoB,CAAC,kBAAkB,CAAC;YACtC,CAAC,CAAC,kBAAkB,CAAC,IAAI;YACzB,CAAC,CAAC,kBAAkB,CAAC,SACzB,MAAM,GAAG,CAAC,OAAO,EAAE,CAAA;QAEnB,IACE,yBAAyB,CAAC,wBAAwB;YAClD,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,uDAAuD,CAAC,KAAK,CAAC,CAAC,EACnF,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,iCAAiC,CAAC,CAAA;YAE3D,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAC1C,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,yBAAyB,CAC1B,CAAA;YACD,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO;oBACL,eAAe,EAAE,MAAM,CAAC,eAAe;oBACvC,QAAQ;oBACR,QAAQ;oBACR,QAAQ;iBACT,CAAA;YACH,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC1B,CAAC;QAED,MAAM,IAAI,aAAa,CAAC;YACtB,SAAS,EAAE,kCAAkC;YAC7C,OAAO,EAAE,UAAU;YACnB,OAAO,EAAE,EAAE,SAAS,EAAE,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,CAAC,OAAO,EAAE;YAC1F,KAAK,EAAE,GAAG;SACX,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,uBAAuB,CACpC,SAAoB,EACpB,QAAgB,EAChB,QAAgB,EAChB,yBAAiD;IAEjD,MAAM,YAAY,GAAG,MAAM,+BAA+B,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACzF,IAAI,CAAC,YAAY,IAAI,CAAC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QAC3D,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,iCAAiC,GAAG,MAAM,CAAC,OAAO,CACtD,yBAAyB,CAAC,UAAU,CACrC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACrB,OAAO,IAAI,gCAAgC,CAAC;YAC1C,eAAe,EAAE,YAAY,CAAC,eAAe;YAC7C,aAAa,EAAE,GAAG;YAClB,cAAc,EAAE,KAAK;SACtB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,KAAK,MAAM,OAAO,IAAI,iCAAiC,EAAE,CAAC;QACxD,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC/B,CAAC;IAED,OAAO,YAAY,CAAA;AACrB,CAAC"}
|
package/dist/utils/snsUtils.d.ts
CHANGED
|
@@ -15,8 +15,8 @@ export declare function findSubscriptionByTopicAndQueue(snsClient: SNSClient, to
|
|
|
15
15
|
* Calculates the size of an outgoing SNS message.
|
|
16
16
|
*
|
|
17
17
|
* SNS imposes a 256 KB limit on the total size of a message, which includes both the message body and any metadata (attributes).
|
|
18
|
-
* This function
|
|
19
|
-
*
|
|
18
|
+
* This function computes the size based solely on the message body. The reserved buffer for message attributes and overhead
|
|
19
|
+
* is accounted for in SNS_MESSAGE_ATTRIBUTE_BUFFER, which is subtracted from SNS_MESSAGE_HARD_LIMIT to derive SNS_MESSAGE_MAX_SIZE.
|
|
20
20
|
*
|
|
21
21
|
* Reference: https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html
|
|
22
22
|
*
|
package/dist/utils/snsUtils.js
CHANGED
|
@@ -143,8 +143,8 @@ export async function findSubscriptionByTopicAndQueue(snsClient, topicArn, queue
|
|
|
143
143
|
* Calculates the size of an outgoing SNS message.
|
|
144
144
|
*
|
|
145
145
|
* SNS imposes a 256 KB limit on the total size of a message, which includes both the message body and any metadata (attributes).
|
|
146
|
-
* This function
|
|
147
|
-
*
|
|
146
|
+
* This function computes the size based solely on the message body. The reserved buffer for message attributes and overhead
|
|
147
|
+
* is accounted for in SNS_MESSAGE_ATTRIBUTE_BUFFER, which is subtracted from SNS_MESSAGE_HARD_LIMIT to derive SNS_MESSAGE_MAX_SIZE.
|
|
148
148
|
*
|
|
149
149
|
* Reference: https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html
|
|
150
150
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@message-queue-toolkit/sns",
|
|
3
|
-
"version": "24.
|
|
3
|
+
"version": "24.6.1",
|
|
4
4
|
"private": false,
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "SNS adapter for message-queue-toolkit",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"test:coverage": "npm run test -- --coverage",
|
|
24
24
|
"lint": "biome check . && tsc",
|
|
25
25
|
"lint:fix": "biome check --write .",
|
|
26
|
-
"docker:start": "docker compose up -d localstack
|
|
26
|
+
"docker:start": "docker compose up -d redis && if [ \"$QUEUE_BACKEND\" = \"localstack\" ]; then docker compose up -d --quiet-pull --wait localstack; fi",
|
|
27
27
|
"docker:stop": "docker compose down",
|
|
28
28
|
"prepublishOnly": "npm run lint && npm run build"
|
|
29
29
|
},
|
|
@@ -53,8 +53,9 @@
|
|
|
53
53
|
"@message-queue-toolkit/sqs": "*",
|
|
54
54
|
"@types/node": "^25.0.2",
|
|
55
55
|
"@vitest/coverage-v8": "^4.0.15",
|
|
56
|
-
"awilix": "^
|
|
56
|
+
"awilix": "^13.0.3",
|
|
57
57
|
"awilix-manager": "^6.1.0",
|
|
58
|
+
"fauxqs": "^2.0.0",
|
|
58
59
|
"ioredis": "^5.7.0",
|
|
59
60
|
"rimraf": "^6.0.1",
|
|
60
61
|
"typescript": "^5.9.3",
|