fix: only send 'activation_method' to APM server >=8.7.1 (#3231)

This works around an issue in APM server 8.7.0 which had problems
receiving metadata with activation_method.

Closes: #3230

Author: trentm

CHANGELOG.asciidoc

@@ -31,6 +31,7 @@ Notes:
 [[release-notes-3.x]]
 === Node.js Agent version 3.x
 
+
 ==== Unreleased
 
 [float]
@@ -45,16 +46,17 @@ Notes:
 [float]
 ===== Bug fixes
 
+* Ensure `metadata.service.agent.activation_method` is only sent for APM
+  server version 8.7.1 or later. APM server 8.7.0 included a bug where
+  receiving `activation_method` is harmful. ({issues}3230[#3230])
+
 [float]
 ===== Chores
 
 
 [[release-notes-3.43.0]]
 ==== 3.43.0 2023/03/02
 
-[float]
-===== Breaking changes
-
 [float]
 ===== Features
 
@@ -72,7 +74,7 @@ Notes:
 
 * Make `Agent.flush()` return a `Promise` if no callback is passed as param.
   This means that flush is now `await`able: `await apm.flush()`.
-  ({issues}2857(#2857))
+  ({issues}2857[#2857])
 
 [float]
 ===== Bug fixes

lib/instrumentation/azure-functions.js

@@ -252,7 +252,7 @@ function getAzureFunctionsExtraMetadata () {
         // Passing this service.framework.name to Client#setExtraMetadata()
         // ensures that it "wins" over a framework name from
         // `agent.setFramework()`, because in the client `_extraMetadata`
-        // wins over `_conf.metadata`.
+        // wins over `_conf.frameworkName`.
         name: 'Azure Functions',
         version: process.env.FUNCTIONS_EXTENSION_VERSION
       },

lib/lambda.js

@@ -58,7 +58,7 @@ function getMetadata (agent, cloudAccountId) {
         // Passing this service.framework.name to Client#setExtraMetadata()
         // ensures that it "wins" over a framework name from
         // `agent.setFramework()`, because in the client `_extraMetadata`
-        // wins over `_conf.metadata`.
+        // wins over `_conf.frameworkName`.
         name: 'AWS Lambda'
       },
       runtime: {

package-lock.json

@@ -15,7 +15,7 @@
     "lint:yaml-files": "./dev-utils/lint-yaml-files.sh  # requires node >=10",
     "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/modules/next/a-nextjs-app' --no-dev -i async_hooks -i perf_hooks -i node:http -i @azure/functions-core",
+    "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' --no-dev -i async_hooks -i perf_hooks -i node:http -i @azure/functions-core",
     "test:tav": "tav --quiet && (cd test/instrumentation/modules/next/a-nextjs-app && tav --quiet)",
     "test:docs": "./test/script/docker/run_docs.sh",
     "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 >=12.20",
@@ -95,7 +95,7 @@
     "cookie": "^0.5.0",
     "core-util-is": "^1.0.2",
     "debug": "^4.1.1",
-    "elastic-apm-http-client": "11.2.0",
+    "elastic-apm-http-client": "11.3.1",
     "end-of-stream": "^1.4.4",
     "error-callsites": "^2.0.4",
     "error-stack-parser": "^2.0.6",

package.json

@@ -98,6 +98,10 @@ class CapturingTransport {
     return true
   }
 
+  supportsActivationMethodField () {
+    return true
+  }
+
   // Inherited from Writable, called in agent.js.
   destroy () {}
 }

test/_capturing_transport.js

@@ -69,6 +69,9 @@ module.exports = function (expected, done) {
     },
     supportsKeepingUnsampledTransaction () {
       return true
+    },
+    supportsActivationMethodField () {
+      return true
     }
   }
 

test/_mock_http_client.js

@@ -50,6 +50,9 @@ module.exports = function (expectations = [], done) {
     },
     supportsKeepingUnsampledTransaction () {
       return true
+    },
+    supportsActivationMethodField () {
+      return true
     }
   }
 }

test/_mock_http_client_states.js

@@ -107,7 +107,7 @@ tape.test('metadata.system.agent.activation_method fixtures', function (suite) {
 
     const envStr = c.env ? Object.keys(c.env).map(k => `${k}="${c.env[k]}"`).join(' ') : ''
     suite.test(`${envStr} node ${(c.nodeOpts || []).join(' ')} ${c.script}`, t => {
-      const server = new MockAPMServer()
+      const server = new MockAPMServer({ apmServerVersion: '8.7.1' })
       const args = c.nodeOpts || []
       args.push(c.script)
       server.start(function (serverUrl) {

test/activation-method/activation-method.test.js

@@ -34,7 +34,10 @@ const agentOpts = {
   metricsInterval: '0s',
   cloudProvider: 'none',
   spanStackTraceMinDuration: 0, // Always have span stacktraces.
-  logLevel: 'warn'
+  logLevel: 'warn',
+  // Ensure the APM client's `GET /` requests do not get in the way of test
+  // asserts. Also ensure it is new enough to include 'activation_method'.
+  apmServerVersion: '8.7.1'
 }
 const agentOptsNoopTransport = Object.assign(
   {},
@@ -574,12 +577,7 @@ test('filters', function (t) {
       filterAgentOpts = Object.assign(
         {},
         agentOpts,
-        {
-          serverUrl,
-          // Ensure the APM client's `GET /` requests do not get in the way of
-          // the test asserts below.
-          apmServerVersion: '8.0.0'
-        }
+        { serverUrl }
       )
       t.end()
     })