DRAFT: refactor web integrations

.github/workflows/serverless.yml

@@ -58,7 +58,7 @@ jobs:
       localstack-legacy:
         image: localstack/localstack:1.1.0
         ports:
-          - "127.0.0.1:4567:4567" # Edge
+          - '127.0.0.1:4567:4567' # Edge
         env:
           LOCALSTACK_SERVICES: dynamodb,kinesis,s3,sqs,sns,redshift,route53,logs,serverless
           EXTRA_CORS_ALLOWED_HEADERS: x-amz-request-id,x-amzn-requestid,x-amz-id-2
@@ -88,31 +88,39 @@ jobs:
           suffix: plugins-${{ github.job }}-${{ matrix.node-version }}
       - uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
 
+  aws-apigateway:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: aws-apigateway
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: ./.github/actions/plugins/test-and-upstream
+
   azure-functions:
     runs-on: ubuntu-latest
     services:
-        azurite:
-          image: mcr.microsoft.com/azure-storage/azurite:3.34.0
-          ports:
-              - "127.0.0.1:10000:10000"
-              - "127.0.0.1:10001:10001"
-              - "127.0.0.1:10002:10002"
-        azureservicebusemulator:
-          image: mcr.microsoft.com/azure-messaging/servicebus-emulator:1.1.2
-          ports:
-              - "127.0.0.1:5672:5672"
-              - "127.0.0.1:5300:5300"
-          env:
-              ACCEPT_EULA: "Y"
-              MSSQL_SA_PASSWORD: "Localtestpass1!"
-              SQL_SERVER: azuresqledge
-        azuresqledge:
-          image: mcr.microsoft.com/azure-sql-edge:1.0.7
-          ports:
-              - "127.0.0.1:1433:1433"
-          env:
-              ACCEPT_EULA: "Y"
-              MSSQL_SA_PASSWORD: "Localtestpass1!"
+      azurite:
+        image: mcr.microsoft.com/azure-storage/azurite:3.34.0
+        ports:
+          - '127.0.0.1:10000:10000'
+          - '127.0.0.1:10001:10001'
+          - '127.0.0.1:10002:10002'
+      azureservicebusemulator:
+        image: mcr.microsoft.com/azure-messaging/servicebus-emulator:1.1.2
+        ports:
+          - '127.0.0.1:5672:5672'
+          - '127.0.0.1:5300:5300'
+        env:
+          ACCEPT_EULA: 'Y'
+          MSSQL_SA_PASSWORD: 'Localtestpass1!'
+          SQL_SERVER: azuresqledge
+      azuresqledge:
+        image: mcr.microsoft.com/azure-sql-edge:1.0.7
+        ports:
+          - '127.0.0.1:1433:1433'
+        env:
+          ACCEPT_EULA: 'Y'
+          MSSQL_SA_PASSWORD: 'Localtestpass1!'
     env:
       PLUGINS: azure-functions
       SERVICES: azureservicebusemulator,azuresqledge
@@ -127,22 +135,22 @@ jobs:
   azure-service-bus:
     runs-on: ubuntu-latest
     services:
-        azureservicebusemulator:
-          image: mcr.microsoft.com/azure-messaging/servicebus-emulator:1.1.2
-          ports:
-              - "127.0.0.1:5672:5672"
-              - "127.0.0.1:5300:5300"
-          env:
-              ACCEPT_EULA: "Y"
-              MSSQL_SA_PASSWORD: "Localtestpass1!"
-              SQL_SERVER: azuresqledge
-        azuresqledge:
-          image: mcr.microsoft.com/azure-sql-edge:1.0.7
-          ports:
-              - "127.0.0.1:1433:1433"
-          env:
-              ACCEPT_EULA: "Y"
-              MSSQL_SA_PASSWORD: "Localtestpass1!"
+      azureservicebusemulator:
+        image: mcr.microsoft.com/azure-messaging/servicebus-emulator:1.1.2
+        ports:
+          - '127.0.0.1:5672:5672'
+          - '127.0.0.1:5300:5300'
+        env:
+          ACCEPT_EULA: 'Y'
+          MSSQL_SA_PASSWORD: 'Localtestpass1!'
+          SQL_SERVER: azuresqledge
+      azuresqledge:
+        image: mcr.microsoft.com/azure-sql-edge:1.0.7
+        ports:
+          - '127.0.0.1:1433:1433'
+        env:
+          ACCEPT_EULA: 'Y'
+          MSSQL_SA_PASSWORD: 'Localtestpass1!'
     env:
       PLUGINS: azure-service-bus
       SERVICES: azureservicebusemulator,azuresqledge

.github/workflows/system-tests.yml

@@ -38,10 +38,11 @@ jobs:
       id-token: write
       packages: write
     with:
+      ref: conti/fix-js-web-err
       library: nodejs
       binaries_artifact: system_tests_binaries
-      desired_execution_time: 300  # 5 minutes
+      desired_execution_time: 300 # 5 minutes
       scenarios_groups: tracer-release
-      excluded_scenarios: APM_TRACING_E2E_OTEL,APM_TRACING_E2E_SINGLE_SPAN  # require AWS and datadog credentials
+      excluded_scenarios: APM_TRACING_E2E_OTEL,APM_TRACING_E2E_SINGLE_SPAN # require AWS and datadog credentials
       parametric_job_count: 8
       skip_empty_scenarios: true

packages/datadog-instrumentations/src/hapi.js

@@ -108,7 +108,7 @@ function onPreResponse (request, h) {
   const req = request.raw.req
 
   if (request.response instanceof Error) {
-    errorChannel.publish(request.response)
+    errorChannel.publish({ req, error: request.response })
   }
 
   if (request.route) {

packages/datadog-plugin-aws-apigateway/src/index.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const InferredProxyPlugin = require('../../datadog-plugin-inferred-proxy/src')
+
+class ApiGatewayPlugin extends InferredProxyPlugin {
+  static id = 'aws-apigateway'
+}
+
+module.exports = ApiGatewayPlugin

packages/dd-trace/test/plugins/util/inferred_proxy.spec.js → packages/datadog-plugin-aws-apigateway/test/index.spec.js

@@ -1,8 +1,6 @@
 'use strict'
 
-require('../../setup/tap')
-
-const agent = require('../agent')
+const agent = require('../../dd-trace/test/plugins/agent')
 const { expect } = require('chai')
 const axios = require('axios')
 const { Agent } = require('http')
@@ -13,62 +11,22 @@ const httpClient = axios.create({
   timeout: 5000
 })
 
-describe('Inferred Proxy Spans', function () {
+describe('Plugin', function () {
   let http
   let appListener
   let controller
   let port
 
-  // tap was throwing timeout errors when trying to use hooks like `before`, so instead we just use this function
-  // and call before the test starts
-  const loadTest = async function ({ inferredProxyServicesEnabled = true } = {}) {
-    const options = {
-      inferredProxyServicesEnabled,
-      service: 'aws-server'
-    }
-
-    await agent.load(
-      ['http', 'dns', 'net'],
-      [{ client: false }, { enabled: false }, { enabled: false }],
-      options
-    )
-
-    // we can't force re-init the tracer, so we have to set the config manually
-    const tracer = require('../../../../dd-trace').init(options)
-    tracer._tracer._config.inferredProxyServicesEnabled = inferredProxyServicesEnabled
-
-    http = require('http')
-
-    const server = new http.Server(async (req, res) => {
-      controller && await controller(req, res)
-      if (req.url === '/error') {
-        res.statusCode = 500
-        res.end(JSON.stringify({ message: 'ERROR' }))
-      } else {
-        res.writeHead(200)
-        res.end(JSON.stringify({ message: 'OK' }))
-      }
-    })
-
-    // Force close connections when server closes
-    const connections = new Set()
-    server.on('connection', (connection) => {
-      connections.add(connection)
-      connection.on('close', () => {
-        connections.delete(connection)
-      })
-    })
-
-    return new Promise((resolve, reject) => {
-      appListener = server.listen(0, '127.0.0.1', () => {
-        port = server.address().port
-        appListener._connections = connections
-        resolve()
-      })
-    })
+  const inferredHeaders = {
+    'x-dd-proxy': 'aws-apigateway',
+    'x-dd-proxy-request-time-ms': '1729780025473',
+    'x-dd-proxy-path': '/test',
+    'x-dd-proxy-httpmethod': 'GET',
+    'x-dd-proxy-domain-name': 'example.com',
+    'x-dd-proxy-stage': 'dev'
   }
 
-  const cleanupTest = async function () {
+  afterEach(async () => {
     controller = null
 
     if (appListener) {
@@ -92,25 +50,54 @@ describe('Inferred Proxy Spans', function () {
     }
 
     await agent.close()
-  }
-
-  const inferredHeaders = {
-    'x-dd-proxy': 'aws-apigateway',
-    'x-dd-proxy-request-time-ms': '1729780025473',
-    'x-dd-proxy-path': '/test',
-    'x-dd-proxy-httpmethod': 'GET',
-    'x-dd-proxy-domain-name': 'example.com',
-    'x-dd-proxy-stage': 'dev'
-  }
-
-  afterEach(async () => {
-    await cleanupTest()
   })
 
   describe('without configuration', () => {
-    it('should create a parent span and a child span for a 200', async () => {
-      await loadTest({})
+    beforeEach(async () => {
+      const options = {
+        inferredProxyServicesEnabled: true,
+        service: 'aws-server'
+      }
+
+      await agent.load(
+        ['http', 'dns', 'net', 'tcp', 'aws-apigateway'],
+        [{ client: false }, { enabled: false }, { enabled: false }, { enabled: false }, { enabled: true }],
+        options
+      )
+
+      require('../../dd-trace').init(options)
+      http = require('http')
+
+      const server = new http.Server(async (req, res) => {
+        controller && await controller(req, res)
+        if (req.url === '/error') {
+          res.statusCode = 500
+          res.end(JSON.stringify({ message: 'ERROR' }))
+        } else {
+          res.writeHead(200)
+          res.end(JSON.stringify({ message: 'OK' }))
+        }
+      })
 
+      // Force close connections when server closes
+      const connections = new Set()
+      server.on('connection', (connection) => {
+        connections.add(connection)
+        connection.on('close', () => {
+          connections.delete(connection)
+        })
+      })
+
+      return new Promise((resolve, reject) => {
+        appListener = server.listen(0, '127.0.0.1', () => {
+          port = server.address().port
+          appListener._connections = connections
+          resolve()
+        })
+      })
+    })
+
+    it('should create a parent span and a child span for a 200', async () => {
       await httpClient.get(`http://127.0.0.1:${port}/`, {
         headers: inferredHeaders
       })
@@ -148,8 +135,6 @@ describe('Inferred Proxy Spans', function () {
     })
 
     it('should create a parent span and a child span for an error', async () => {
-      await loadTest({})
-
       await httpClient.get(`http://127.0.0.1:${port}/error`, {
         headers: inferredHeaders,
         validateStatus: function (status) {
@@ -188,8 +173,6 @@ describe('Inferred Proxy Spans', function () {
     })
 
     it('should not create an API Gateway span if all necessary headers are missing', async () => {
-      await loadTest({})
-
       await httpClient.get(`http://127.0.0.1:${port}/no-aws-headers`, {
         headers: {}
       })
@@ -213,8 +196,6 @@ describe('Inferred Proxy Spans', function () {
     })
 
     it('should not create an API Gateway span if missing the proxy system header', async () => {
-      await loadTest({})
-
       // remove x-dd-proxy from headers
       const { 'x-dd-proxy': _, ...newHeaders } = inferredHeaders
 
@@ -242,9 +223,54 @@ describe('Inferred Proxy Spans', function () {
   })
 
   describe('with configuration', function () {
-    it('should not create a span when configured to be off', async () => {
-      await loadTest({ inferredProxyServicesEnabled: false })
+    beforeEach(async () => {
+      const options = {
+        inferredProxyServicesEnabled: false,
+        service: 'aws-server'
+      }
 
+      // we can't force re-init the tracer, so we have to set the config manually
+      const tracer = require('../../dd-trace').init(options)
+      tracer._tracer._config.inferredProxyServicesEnabled = false
+
+      await agent.load(
+        ['http', 'dns', 'net', 'aws-apigateway'],
+        [{ client: false }, { enabled: false }, { enabled: false }, { enabled: true }],
+        options
+      )
+
+      http = require('http')
+
+      const server = new http.Server(async (req, res) => {
+        controller && await controller(req, res)
+        if (req.url === '/error') {
+          res.statusCode = 500
+          res.end(JSON.stringify({ message: 'ERROR' }))
+        } else {
+          res.writeHead(200)
+          res.end(JSON.stringify({ message: 'OK' }))
+        }
+      })
+
+      // Force close connections when server closes
+      const connections = new Set()
+      server.on('connection', (connection) => {
+        connections.add(connection)
+        connection.on('close', () => {
+          connections.delete(connection)
+        })
+      })
+
+      return new Promise((resolve, reject) => {
+        appListener = server.listen(0, '127.0.0.1', () => {
+          port = server.address().port
+          appListener._connections = connections
+          resolve()
+        })
+      })
+    })
+
+    it('should not create a span when configured to be off', async () => {
       await httpClient.get(`http://127.0.0.1:${port}/configured-off`, {
         headers: inferredHeaders
       })