test: convert sqs.test.js over to use localstack for end-to-end tests (similar to s3.test.js) (elastic#3334)

- update to the latest localstack
- restore testing of recent releases of aws-sdk (skipping the "bad" 2.1372.0 release that attempted to switch SQS over to the new "JSON protocol")
- changes the SQS "integration tests" to run use-sqs.js against localstack, instead of just against a local mock SQS server with canned responses

Fixes: elastic#3324

Author: trentm

.ci/docker/docker-compose.yml

@@ -119,14 +119,13 @@ services:
 
   localstack:
     # https://hub.docker.com/r/localstack/localstack/tags
-    image: localstack/localstack:0.12.12
+    image: localstack/localstack:2.1.0
     environment:
-      - LOCALSTACK_SERVICES=s3
       - DATA_DIR=/var/lib/localstack
     ports:
       - "4566:4566"
     healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:4566/health"]
+      test: ["CMD", "curl", "-f", "http://localhost:4566/_localstack/health"]
       interval: 30s
       timeout: 10s
       retries: 5

.github/workflows/test.yml

@@ -114,9 +114,8 @@ jobs:
           - nodeesdata:/usr/share/elasticsearch/data
 
       localstack:
-        image: localstack/localstack:0.12.12
+        image: localstack/localstack:2.1.0
         env:
-          LOCALSTACK_SERVICES: 's3'
           DATA_DIR: '/var/lib/localstack'
         ports:
           - "4566:4566"

.tav.yml

@@ -496,20 +496,19 @@ memcached:
 
 aws-sdk:
   # We want this version range:
-  #   versions: '>=2.858 <3'
+  #   versions: '>=2.858 <2.1372.0 || >2.1372.0 <3'
   # However, awk-sdk releases *very* frequently (almost every day) and there
   # is no need to test *all* those releases. Instead we statically list a subset
   # of versions to test.
   #
+  # - v2.1372.0 changed the SQS client protocol from "query" to "json", which
+  #   isn't supported in localstack. It was reverted in v2.1373.0.
+  #
   # Maintenance note: This should be updated periodically using:
   #   ./dev-utils/aws-sdk-tav-versions.sh
   #
-  # Test v2.858.0, every N=102 of 515 releases, and current latest.
-  #
-  # Workaround note: Until localstack supports SQS using the JSON protocol
-  # we cannot test against >=2.1372.0. Cap the versions tested for now.
-  # See https://github.com/elastic/apm-agent-nodejs/issues/3324
-  versions: '2.858.0 || 2.960.0 || 2.1062.0 || 2.1164.0 || 2.1266.0 || 2.1368.0 || 2.1371.0'
+  # Test v2.858.0, every N=108 of 542 releases, and current latest.
+  versions: '2.858.0 || 2.966.0 || 2.1074.0 || 2.1182.0 || 2.1290.0 || 2.1399.0 || 2.1400.0 || >2.1400.0 <3'
   commands:
     - node test/instrumentation/modules/aws-sdk/aws4-retries.test.js
     - node test/instrumentation/modules/aws-sdk/s3.test.js

dev-utils/aws-sdk-tav-versions.sh

@@ -9,12 +9,13 @@
 npm info -j aws-sdk | node -e '
     var semver = require("semver");
     var chunks = [];
+    var wantVerRange = ">=2.858 <2.1372.0 || >2.1372.0 <3"
     process.stdin
         .resume()
         .on("data", (chunk) => { chunks.push(chunk) })
         .on("end", () => {
             var input = JSON.parse(chunks.join(""));
-            var vers = input.versions.filter(v => semver.satisfies(v, ">=2.858.0 <3"));
+            var vers = input.versions.filter(v => semver.satisfies(v, wantVerRange));
             var modulus = Math.floor((vers.length - 2) / 5);
             console.log("  # Test v2.858.0, every N=%d of %d releases, and current latest.", modulus, vers.length);
             vers = vers.filter((v, idx, arr) => idx % modulus === 0 || idx === arr.length - 1);

docs/supported-technologies.asciidoc

@@ -139,7 +139,7 @@ The Node.js agent will automatically instrument the following modules to give yo
 [options="header"]
 |=======================================================================
 |Module |Version |Note
-|https://www.npmjs.com/package/aws-sdk[aws-sdk] |>1 <3 |Will instrument SQS send/receive/delete messages, all S3 methods, all DynamoDB methods, and the SNS publish method
+|https://www.npmjs.com/package/aws-sdk[aws-sdk] |>=2.858.0 <3 |Will instrument SQS send/receive/delete messages, all S3 methods, all DynamoDB methods, and the SNS publish method
 |https://www.npmjs.com/package/@aws-sdk/client-s3[@aws-sdk/client-s3] |>=3.15.0 <4 |Will instrument all S3 methods
 |https://www.npmjs.com/package/cassandra-driver[cassandra-driver] |>=3.0.0 <5 |Will instrument all queries
 |https://www.npmjs.com/package/elasticsearch[elasticsearch] |>=8.0.0 |Will instrument all queries

examples/trace-sqs-send-message.js

@@ -66,12 +66,16 @@ sqs.getQueueUrl({ QueueName: queueName }, function (err, data) {
   const queueUrl = data.QueueUrl
   // console.log('queueUrl:', queueUrl)
 
+  const rand = Math.random()
   const params = {
     QueueUrl: queueUrl,
-    MessageBody: `this is my message (${Math.random()})`,
+    MessageBody: `this is my message (${rand}})`,
     MessageAttributes: {
       foo: { DataType: 'String', StringValue: 'bar' }
-    }
+    },
+    // Only used for FIFO queues.
+    MessageGroupId: 'example-trace-sqs',
+    MessageDeduplicationId: rand.toString()
   }
   console.log('Sending message with body: %j', params.MessageBody)
   sqs.sendMessage(params, function (err, data) {

package-lock.json

@@ -16,7 +16,7 @@
     "lint:tav": "./dev-utils/lint-tav-json.js",
     "coverage": "COVERAGE=true ./test/script/run_tests.sh",
     "test": "./test/script/run_tests.sh",
-    "test:deps": "dependency-check index.js start.js start-next.js 'lib/**/*.js' 'test/**/*.js' '!test/activation-method/fixtures' '!test/instrumentation/azure-functions/fixtures' '!test/instrumentation/modules/next/a-nextjs-app' '!test/opentelemetry-bridge' '!test/opentelemetry-metrics/fixtures' --no-dev -i async_hooks -i perf_hooks -i node:http -i @azure/functions-core -i worker_threads",
+    "test:deps": "dependency-check index.js start.js start-next.js 'lib/**/*.js' 'test/**/*.js' '!test/activation-method/fixtures' '!test/instrumentation/azure-functions/fixtures' '!test/instrumentation/modules/next/a-nextjs-app' '!test/opentelemetry-bridge' '!test/opentelemetry-metrics/fixtures' --no-dev -i async_hooks -i perf_hooks -i node:http -i @azure/functions-core -i worker_threads -i timers",
     "test:tav": "(cd test/opentelemetry-metrics/fixtures && tav --quiet) && (cd test/opentelemetry-bridge && tav --quiet) && (cd test/instrumentation/modules/next/a-nextjs-app && tav --quiet) && tav --quiet",
     "test:types": "tsc --project test/types/tsconfig.json && tsc --project test/types/transpile/tsconfig.json && node test/types/transpile/index.js && tsc --project test/types/transpile-default/tsconfig.json && node test/types/transpile-default/index.js  # requires node >=14.17",
     "test:babel": "babel test/babel/src.js --out-file test/babel/out.js && cd test/babel && node out.js",
@@ -136,7 +136,7 @@
     "ajv": "^7.2.4",
     "apollo-server-core": "^3.0.0",
     "apollo-server-express": "^3.0.0",
-    "aws-sdk": "^2.622.0",
+    "aws-sdk": "^2.1400.0",
     "backport": "^5.1.2",
     "benchmark": "^2.1.4",
     "bluebird": "^3.7.2",

package.json

@@ -119,14 +119,13 @@ services:
 
   localstack:
     # https://hub.docker.com/r/localstack/localstack/tags
-    image: localstack/localstack:0.12.12
+    image: localstack/localstack:2.1.0
     environment:
-      - "LOCALSTACK_SERVICES=s3"
       - "DATA_DIR=/var/lib/localstack"
     ports:
       - "4566:4566"
     healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:4566/health"]
+      test: ["CMD", "curl", "-f", "http://localhost:4566/_localstack/health"]
       interval: 30s
       timeout: 10s
       retries: 5

test/docker-compose.yml

@@ -130,7 +130,7 @@ tape.test('simple S3 V3 usage scenario', function (t) {
               cloud: { region: 'us-east-2' },
               service: { type: '', name: '', resource: 's3' }
             },
-            http: { status_code: 200 }
+            http: { status_code: 200, response: { encoded_body_size: 222 } }
           },
           outcome: 'success'
         }, 'listAllBuckets produced expected span')
@@ -148,7 +148,7 @@ tape.test('simple S3 V3 usage scenario', function (t) {
               cloud: { region: 'us-east-2' },
               service: { type: '', name: '', resource: 'elasticapmtest-bucket-3' }
             },
-            http: { status_code: 200, response: { encoded_body_size: 177 } }
+            http: { status_code: 200, response: { encoded_body_size: 61 } }
           },
           otel: {
             attributes: { 'aws.s3.bucket': 'elasticapmtest-bucket-3' }
@@ -190,7 +190,7 @@ tape.test('simple S3 V3 usage scenario', function (t) {
               cloud: { region: 'us-east-2' },
               service: { type: '', name: '', resource: 'elasticapmtest-bucket-3' }
             },
-            http: { status_code: 200, response: { encoded_body_size: 0 } }
+            http: { status_code: 200, response: { encoded_body_size: 58 } }
           },
           otel: {
             attributes: {
@@ -315,7 +315,7 @@ tape.test('simple S3 V3 usage scenario', function (t) {
               cloud: { region: 'us-east-2' },
               service: { type: '', name: '', resource: 'elasticapmtest-bucket-3' }
             },
-            http: { status_code: 204, response: { encoded_body_size: 0 } }
+            http: { status_code: 204 }
           },
           otel: {
             attributes: {
@@ -339,7 +339,7 @@ tape.test('simple S3 V3 usage scenario', function (t) {
               cloud: { region: 'us-east-2' },
               service: { type: '', name: '', resource: 'elasticapmtest-bucket-3' }
             },
-            http: { status_code: 204, response: { encoded_body_size: 0 } }
+            http: { status_code: 204 }
           },
           otel: {
             attributes: { 'aws.s3.bucket': 'elasticapmtest-bucket-3' }

test/instrumentation/modules/@aws-sdk/client-s3.test.js

@@ -44,7 +44,7 @@ const apm = require('../../../../..').start({
   serviceName: 'use-s3',
   captureExceptions: false,
   centralConfig: false,
-  metricsInterval: 0,
+  metricsInterval: '0s',
   cloudProvider: 'none',
   stackTraceLimit: 4, // get it smaller for reviewing output
   logLevel: 'info'