fix: tests and builds correctly

MrSwitch · MrSwitch · commit 19909a9f782b · 2025-03-07T22:04:38.000Z
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -5,26 +5,25 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-    env:
-      AWS_ACCESS_KEY_ID: foo
-      AWS_SECRET_ACCESS_KEY: bar
     steps:
-      - uses: actions/checkout@v2
-
-      - name: install
-        run: yarn
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+            node-version: 22
+      - name: build
+        run: npm install
 
       - name: build
-        run: yarn run build
+        run: node --run build
 
       - name: run localstack
-        run: docker-compose build
+        run: docker compose build
 
       - name: run localstack
-        run: docker-compose up -d
+        run: docker compose up -d
 
       - name: wait for localstack
         run: ./scripts/wait-for-url.js http://localhost:4566 && sleep 5
 
       - name: test
-        run: yarn test
+        run: node test
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -12,7 +12,7 @@ jobs:
   Publish:
     name: Publish
     runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/main'
     env:
       AWS_ACCESS_KEY_ID: foo
       AWS_SECRET_ACCESS_KEY: bar
@@ -25,7 +25,7 @@ jobs:
 
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 22
           registry-url: https://registry.npmjs.org/
 
       - name: Install node modules
@@ -35,10 +35,10 @@ jobs:
         run: yarn build
 
       - name: run localstack
-        run: docker-compose build
+        run: docker compose build
 
       - name: run localstack
-        run: docker-compose up -d
+        run: docker compose up -d
 
       - name: wait for localstack
         run: ./scripts/wait-for-url.js http://localhost:4566 && sleep 5
@@ -48,8 +48,8 @@ jobs:
 
       - name: Configure CI Git User
         run: |
-          git config --global user.name '@aspecto-system'
-          git config --global user.email 'aspecto-system@users.noreply.github.com'
+          git config --global user.email "bot@5app.com"
+          git config --global user.name "UI release bot"
 
       - name: Update yarn commit message
         run: yarn config set version-git-message "chore(release) - publish v%s"
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
-![Build](https://github.com/aspecto-io/sns-sqs-big-payload/workflows/Build/badge.svg) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![TypeScript](https://badgen.net/npm/types/env-var)](http://www.typescriptlang.org/) [![NPM version](https://img.shields.io/npm/v/sns-sqs-big-payload.svg)](https://www.npmjs.com/package/sns-sqs-big-payload)
+![Build](https://github.com/5app/sns-sqs-big-payload/workflows/Build/badge.svg) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![TypeScript](https://badgen.net/npm/types/env-var)](http://www.typescriptlang.org/) [![NPM version](https://img.shields.io/npm/v/@5app/sns-sqs-big-payload.svg)](https://www.npmjs.com/package/@5app/sns-sqs-big-payload)
 
 # sns-sqs-big-payload
 
 SQS/SNS producer/consumer library. Provides an ability to pass payloads though s3.
 
 ## Motivation
 
-[Aspecto](https://www.aspecto.io/?utm_source=github&utm_medium=sqs-sns-big-payload&utm_campaign=readme-p1&utm_content=v1) helps modern development teams solve production issues before they evolve. We collect real production data and perform deep API analysis over it to autogenerate tests and monitor services stability. As a result, we often need to handle large payloads which can't be used with SQS & SNS due to the hard size limit. This library was developed to overcome this challenge - it enables you to manage Amazon SNS & SQS message payloads with Amazon S3 when dealing with payloads larger than 256KB. Key functionality includes:
+> From Original Author...
+> [Aspecto](https://www.aspecto.io/?utm_source=github&utm_medium=sqs-sns-big-payload&utm_campaign=readme-p1&utm_content=v1) helps modern development teams solve production issues before they evolve. We collect real production data and perform deep API analysis over it to autogenerate tests and monitor services stability. As a result, we often need to handle large payloads which can't be used with SQS & SNS due to the hard size limit. This library was developed to overcome this challenge - it enables you to manage Amazon SNS & SQS message payloads with Amazon S3 when dealing with payloads larger than 256KB. Key functionality includes:
 
 -   Controlling whether message payloads are always stored in Amazon S3 or only when a message's size exceeds 256KB.
 -   Send a message that references a single message object stored in an Amazon S3 bucket.
@@ -16,13 +17,9 @@ SQS/SNS producer/consumer library. Provides an ability to pass payloads though s
 ## Installation
 
 ```
-npm install sns-sqs-big-payload
+npm install @5app/sns-sqs-big-payload
 ```
 
-Important:
-
-> Make sure you also have `aws-sdk` installed, because it's listed as a peer dependency, so won't be installed automatically.
-
 ## Usage
 
 The library exports 3 clients:
@@ -36,7 +33,7 @@ All 3 clients are under the same repository since they share a similar contract
 ### SNS Producer
 
 ```ts
-import { SnsProducer } from 'sns-sqs-big-payload';
+import { SnsProducer } from '@5app/sns-sqs-big-payload';
 
 const snsProducer = SnsProducer.create({
     topicArn: '<topic-arn>',
@@ -58,7 +55,7 @@ await snsProducer.sendJSON({
 ### SQS Producer
 
 ```ts
-import { SqsProducer } from 'sns-sqs-big-payload';
+import { SqsProducer } from '@5app/sns-sqs-big-payload';
 
 const sqsProducer = SqsProducer.create({
     queueUrl: '...',
@@ -80,7 +77,7 @@ await sqsProducer.sendJSON({
 ### SQS Consumer
 
 ```ts
-import { SqsConsumer, SqsConsumerEvents } from 'sns-sqs-big-payload';
+import { SqsConsumer, SqsConsumerEvents } from '@5app/sns-sqs-big-payload';
 
 const sqsConsumer = SqsConsumer.create({
     queueUrl: '...',
@@ -149,7 +146,7 @@ export AWS_ACCESS_KEY_ID=...
 If you need to specify your credentials manually, you can use a pre-configured instance of the [AWS SQS](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html) client:
 
 ```ts
-import { SqsConsumer } from 'sns-sqs-big-payload';
+import { SqsConsumer } from '@5app/sns-sqs-big-payload';
 import * as aws from 'aws-sdk';
 
 aws.config.update({
@@ -224,7 +221,7 @@ Since this library heavily relies on AWS APIs, it is less relevant to run an iso
 To run localstack on mac:
 
 ```sh
-TMPDIR=/private$TMPDIR docker-compose up
+TMPDIR=/private$TMPDIR docker compose up
 ```
 
 To run unit tests:
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -3,15 +3,14 @@ version: '2.1'
 services:
     localstack:
         container_name: '${LOCALSTACK_DOCKER_NAME-localstack_main}'
-        image: localstack/localstack:0.12.5
+        image: localstack/localstack:3.3
         ports:
-            - '4566:4566'
-            - '${PORT_WEB_UI-8080}:${PORT_WEB_UI-8080}'
+            - '127.0.0.1:4566:4566' # LocalStack Gateway
+            - '127.0.0.1:4510-4559:4510-4559' # external services port range
         environment:
             - SERVICES=${SERVICES- }
             - DEBUG=${DEBUG- }
             - DATA_DIR=${DATA_DIR- }
-            - PORT_WEB_UI=${PORT_WEB_UI- }
             - LAMBDA_EXECUTOR=${LAMBDA_EXECUTOR- }
             - KINESIS_ERROR_PROBABILITY=${KINESIS_ERROR_PROBABILITY- }
             - DOCKER_HOST=unix:///var/run/docker.sock
diff --git a/package.json b/package.json
@@ -1,38 +1,39 @@
 {
-    "name": "sns-sqs-big-payload",
+    "name": "@5app/sns-sqs-big-payload",
     "version": "0.1.4",
     "license": "Apache-2.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
         "test": "jest",
-        "build": "yarn clean && tsc",
+        "build": "node --run clean && tsc",
         "clean": "rm -rf ./dist/*",
-        "prepublishOnly": "yarn build"
+        "prepublishOnly": "node --run build"
     },
     "dependencies": {
-        "@aws-sdk/client-s3": "^3.591.0",
-        "@aws-sdk/client-sns": "^3.590.0",
-        "@aws-sdk/client-sqs": "^3.590.0",
-        "@aws-sdk/lib-storage": "^3.591.0",
-        "@smithy/smithy-client": "^3.1.1",
-        "uuid": "^7.0.2"
+        "@aws-sdk/client-s3": "^3.758.0",
+        "@aws-sdk/client-sns": "^3.758.0",
+        "@aws-sdk/client-sqs": "^3.758.0",
+        "@aws-sdk/lib-storage": "^3.758.0",
+        "@smithy/smithy-client": "^4.1.6",
+        "uuid": "^11.1.0"
     },
     "devDependencies": {
-        "@types/jest": "^29.4.0",
-        "@types/node": "^13.13.52",
+        "@tsconfig/node22": "^22.0.0",
+        "@types/jest": "^29.5.14",
+        "@types/node": "^22.13.9",
         "jest": "^29.7.0",
-        "ts-jest": "^29.0.5",
-        "typescript": "4.4.4"
+        "ts-jest": "^29.2.6",
+        "typescript": "^5.8.2"
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/aspecto-io/sns-sqs-big-payload"
+        "url": "https://github.com/5app/sns-sqs-big-payload"
     },
     "bugs": {
-        "url": "https://github.com/aspecto-io/sns-sqs-big-payload/issues"
+        "url": "https://github.com/5app/sns-sqs-big-payload/issues"
     },
-    "homepage": "https://github.com/aspecto-io/sns-sqs-big-payload",
+    "homepage": "https://github.com/5app/sns-sqs-big-payload",
     "prepublish": "tsc",
     "jest": {
         "preset": "ts-jest",
diff --git a/src/sqs-consumer.ts b/src/sqs-consumer.ts
@@ -276,7 +276,7 @@ export class SqsConsumer {
                         Bucket: s3PayloadMeta.Bucket,
                         Key: s3PayloadMeta.Key,
                     });
-                    return { rawPayload: s3Response.Body, s3PayloadMeta };
+                    return { rawPayload: await s3Response.Body.transformToString(), s3PayloadMeta };
                 } catch (err) {
                     this.events.emit(SqsConsumerEvents.s3PayloadError, {
                         err,
diff --git a/src/util.ts b/src/util.ts
@@ -1,14 +1,14 @@
-import { MessageAttributeMap } from 'aws-sdk/clients/sns';
+import { type SendMessageRequest } from '@aws-sdk/client-sqs';
 import { S3PayloadMeta, PayloadMeta, SqsExtendedPayloadMeta } from './types';
 import { AMAZON_EXTENDED_CLIENT_PAYLOAD_OFFLOADING_REFERENCE, SQS_LARGE_PAYLOAD_SIZE_ATTRIBUTE } from './constants';
 
-export function createExtendedCompatibilityAttributeMap(msgSize: number): MessageAttributeMap {
-    const result = {};
-    result[SQS_LARGE_PAYLOAD_SIZE_ATTRIBUTE] = {
-        StringValue: '' + msgSize,
-        DataType: 'Number',
-    };
-    return result;
+export function createExtendedCompatibilityAttributeMap(msgSize: number): SendMessageRequest["MessageAttributes"] {
+    return {
+        [SQS_LARGE_PAYLOAD_SIZE_ATTRIBUTE] : {
+            StringValue: '' + msgSize,
+            DataType: 'Number',
+        }
+    }
 }
 
 export function buildS3Payload(s3PayloadMeta: S3PayloadMeta): string {
diff --git a/tests/sns-sqs.spec.ts b/tests/sns-sqs.spec.ts
@@ -9,15 +9,20 @@ import {
     SqsMessage,
 } from '../src';
 
+import { describe, it, expect, beforeEach, afterEach, beforeAll } from '@jest/globals';
+
 import { S3 } from '@aws-sdk/client-s3';
 import { SNS } from '@aws-sdk/client-sns';
-import { SQS } from '@aws-sdk/client-sqs';
+import { SQS, GetQueueAttributesCommand } from '@aws-sdk/client-sqs';
 import { v4 as uuid } from 'uuid';
 import { S3PayloadMeta } from '../src/types';
 
 // Real AWS services (for dev testing)
 // const TEST_TOPIC_ARN = 'arn:aws:sns:eu-west-1:731241200085:test-sns-producer';
 // const TEST_REGION = 'eu-west-1';
+process.env.AWS_ACCESS_KEY_ID='test';
+process.env.AWS_SECRET_ACCESS_KEY='test';
+
 
 // Localstack AWS services
 const QUEUE_NAME = 'test-consumer-producer';
@@ -61,12 +66,17 @@ async function initAws() {
         await sqs.createQueue({ QueueName: QUEUE_NAME }),
         await sqs.createQueue({ QueueName: QUEUE_2_NAME }),
     ]);
+
     testQueueUrl = res[1].QueueUrl || 'error';
     testQueue2Url = res[2].QueueUrl || 'error';
+
+    const getQueueAttributesCommand = new GetQueueAttributesCommand({ QueueUrl: testQueueUrl, AttributeNames: ['QueueArn']})
+    const getQueueAttributesResponse = await sqs.send(getQueueAttributesCommand);
+
     await sns.subscribe({
         Protocol: 'sqs',
         TopicArn: TEST_TOPIC_ARN,
-        Endpoint: testQueueUrl,
+        Endpoint: getQueueAttributesResponse?.Attributes?.QueueArn,
     });
 }
 
@@ -187,7 +197,7 @@ async function receiveMessages(
             clearTimeout(timeoutId);
         });
 
-        sqsConsumer.on(SqsConsumerEvents.processingError, () => {
+        sqsConsumer.on(SqsConsumerEvents.processingError, (e) => {
             sqsConsumer.stop();
             clearTimeout(timeoutId);
             resolve([]);
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,7 @@
 {
+    "extends": "@tsconfig/node22/tsconfig.json",
     "compilerOptions": {
-        "target": "ES2017",
+        "target": "esnext",
         "lib": ["ES2017"],
         "rootDir": "./src",
         "outDir": "dist",
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
	`2`	`+ "extends": "@tsconfig/node22/tsconfig.json",`
`2`	`3`	`"compilerOptions": {`
`3`		`- "target": "ES2017",`
	`4`	`+ "target": "esnext",`
`4`	`5`	`"lib": ["ES2017"],`
`5`	`6`	`"rootDir": "./src",`
`6`	`7`	`"outDir": "dist",`