Added ESM tests for instrumentations without integration tests

Author: pabloerhard

.github/workflows/apm-integrations.yml

@@ -200,6 +200,16 @@ jobs:
           api_key: ${{ secrets.DD_API_KEY }}
           service: dd-trace-js-tests
 
+  crypto:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: crypto
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   confluentinc-kafka-javascript:
     strategy:
       matrix:
@@ -267,6 +277,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  cookie:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: cookie
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   couchbase:
     strategy:
       matrix:
@@ -434,6 +454,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  generic-pool:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: generic-pool
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   graphql:
     runs-on: ubuntu-latest
     env:
@@ -454,6 +484,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  handlebars:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: handlebars
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   hapi:
     runs-on: ubuntu-latest
     env:
@@ -577,6 +617,16 @@ jobs:
           api_key: ${{ secrets.DD_API_KEY }}
           service: dd-trace-js-tests
 
+  knex:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: knex
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   koa:
     runs-on: ubuntu-latest
     env:
@@ -587,6 +637,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  ldapjs:
+    runs-on: 'ubuntu-latest'
+    env:
+      PLUGINS: ldapjs
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   limitd-client:
     runs-on: ubuntu-latest
     services:
@@ -607,6 +667,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  lodash:
+    runs-on: 'ubuntu-latest'
+    env:
+      PLUGINS: lodash
+    steps:
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+    - uses: ./.github/actions/plugins/test
+      with:
+        dd_api_key: ${{ secrets.DD_API_KEY }}
+
   mariadb:
     runs-on: ubuntu-latest
     services:
@@ -712,6 +782,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  multer:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: multer
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   mysql:
     runs-on: ubuntu-latest
     services:
@@ -833,6 +913,16 @@ jobs:
           api_key: ${{ secrets.DD_API_KEY }}
           service: dd-trace-js-tests
 
+  node-serialize:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: node-serialize
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   opensearch:
     runs-on: ubuntu-latest
     services:
@@ -963,6 +1053,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  process:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: process
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   protobufjs:
     runs-on: ubuntu-latest
     env:
@@ -974,6 +1074,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  pug:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: pug
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   redis:
     runs-on: ubuntu-latest
     services:
@@ -1067,6 +1177,16 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  sequelize:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: sequelize
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   sharedb:
     runs-on: ubuntu-latest
     env:
@@ -1130,6 +1250,26 @@ jobs:
         with:
           dd_api_key: ${{ secrets.DD_API_KEY }}
 
+  url:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: url
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
+  vm:
+    runs-on: ubuntu-latest
+    env:
+      PLUGINS: vm
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+      - uses: ./.github/actions/plugins/test
+        with:
+          dd_api_key: ${{ secrets.DD_API_KEY }}
+
   winston:
     runs-on: ubuntu-latest
     env:

packages/datadog-plugin-cookie/test/integration-test/client.spec.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const {
+  sandboxCwd, useSandbox, varySandbox, curl,
+  FakeAgent, spawnPluginIntegrationTestProc
+} = require('../../../../integration-tests/helpers')
+const { assert } = require('chai')
+const { withVersions } = require('../../../dd-trace/test/setup/mocha')
+
+withVersions('cookie', 'cookie', '>=0.4', version => {
+  describe('ESM', () => {
+    let variants, proc, agent
+
+    useSandbox([`'cookie@${version}'`, 'express'], false,
+      ['./packages/datadog-plugin-cookie/test/integration-test/*'])
+
+    before(function () {
+      variants = varySandbox('server.mjs', 'cookie')
+    })
+
+    beforeEach(async () => {
+      agent = await new FakeAgent().start()
+    })
+
+    afterEach(async () => {
+      proc?.kill()
+      await agent.stop()
+    })
+
+    for (const variant of varySandbox.VARIANTS) {
+      it(`is instrumented loaded with ${variant}`, async () => {
+        proc = await spawnPluginIntegrationTestProc(sandboxCwd(), variants[variant], agent.port)
+        const response = await curl(proc)
+        assert.equal(response.headers['x-counter'], '1')
+      })
+    }
+  })
+})

packages/datadog-plugin-cookie/test/integration-test/server.mjs

@@ -0,0 +1,23 @@
+import 'dd-trace/init.js'
+import express from 'express'
+import cookie from 'cookie'
+import dc from 'dc-polyfill'
+
+const cookieParseCh = dc.channel('datadog:cookie:parse:finish')
+let counter = 0
+cookieParseCh.subscribe(() => {
+  counter += 1
+})
+
+const app = express()
+
+app.get('/', (req, res) => {
+  cookie.parse('hello=world')
+  res.setHeader('X-Counter', counter)
+  res.end('ok')
+})
+
+const server = app.listen(0, () => {
+  const port = server.address().port
+  process.send({ port })
+})

packages/datadog-plugin-crypto/test/integration-test/client.spec.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const {
+  useSandbox, sandboxCwd, varySandbox, curl,
+  FakeAgent, spawnPluginIntegrationTestProc
+} = require('../../../../integration-tests/helpers')
+const { assert } = require('chai')
+
+describe('ESM', () => {
+  let variants, proc, agent
+
+  useSandbox(['crypto', 'express'], false,
+    ['./packages/datadog-plugin-crypto/test/integration-test/*'])
+
+  before(function () {
+    variants = varySandbox('server.mjs', 'node:crypto', 'createHash')
+  })
+
+  beforeEach(async () => {
+    agent = await new FakeAgent().start()
+  })
+
+  afterEach(async () => {
+    proc?.kill()
+    await agent.stop()
+  })
+
+  for (const variant of varySandbox.VARIANTS) {
+    it(`is instrumented loaded with ${variant}`, async () => {
+      proc = await spawnPluginIntegrationTestProc(sandboxCwd(), variants[variant], agent.port)
+      const response = await curl(proc)
+      assert.equal(response.headers['x-counter'], '1')
+    })
+  }
+})

packages/datadog-plugin-crypto/test/integration-test/server.mjs

@@ -0,0 +1,23 @@
+import 'dd-trace/init.js'
+import express from 'express'
+import { createHash } from 'node:crypto'
+import dc from 'dc-polyfill'
+
+const cryptoHashCh = dc.channel('datadog:crypto:hashing:start')
+let counter = 0
+cryptoHashCh.subscribe(() => {
+  counter += 1
+})
+
+const app = express()
+
+app.get('/', (req, res) => {
+  createHash('sha256')
+  res.setHeader('X-Counter', counter)
+  res.end('ok')
+})
+
+const server = app.listen(0, () => {
+  const port = server.address().port
+  process.send({ port })
+})

packages/datadog-plugin-generic-pool/test/integration-test/client.spec.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const {
+  sandboxCwd, useSandbox, varySandbox, curl,
+  FakeAgent, spawnPluginIntegrationTestProc
+} = require('../../../../integration-tests/helpers')
+const { assert } = require('chai')
+const { withVersions } = require('../../../dd-trace/test/setup/mocha')
+
+withVersions('generic-pool', 'generic-pool', '>=3', version => {
+  describe('ESM', () => {
+    let variants, proc, agent
+
+    useSandbox([`'generic-pool@${version}'`, 'express'], false,
+      ['./packages/datadog-plugin-generic-pool/test/integration-test/*'])
+
+    before(function () {
+      variants = varySandbox('server.mjs', 'genericPool', undefined, 'generic-pool')
+    })
+
+    beforeEach(async () => {
+      agent = await new FakeAgent().start()
+    })
+
+    afterEach(async () => {
+      proc?.kill()
+      await agent.stop()
+    })
+
+    for (const variant of varySandbox.VARIANTS) {
+      it(`is instrumented loaded with ${variant}`, async () => {
+        proc = await spawnPluginIntegrationTestProc(sandboxCwd(), variants[variant], agent.port)
+        const response = await curl(proc)
+        assert.equal(response.headers['x-counter'], '1')
+      })
+    }
+  })
+})