fix(esbuild): call the hook function properly in the bundler register (#5934)

* fix hook function

* add test

* call hook function only if it exists

Author: sabrenner

integration-tests/esbuild/build-and-test-openai.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+const fs = require('fs')
+const { spawnSync } = require('child_process')
+
+const ddPlugin = require('../../esbuild') // dd-trace/esbuild
+const esbuild = require('esbuild')
+
+const SCRIPT = './openai-out.js'
+
+esbuild.build({
+  entryPoints: ['openai.js'],
+  bundle: true,
+  outfile: SCRIPT,
+  plugins: [ddPlugin],
+  platform: 'node',
+  target: ['node18'],
+  external: []
+}).then(() => {
+  const { status, stdout, stderr } = spawnSync('node', [SCRIPT])
+  if (stdout.length) {
+    console.log(stdout.toString())
+  }
+  if (stderr.length) {
+    console.error(stderr.toString())
+  }
+  if (status) {
+    throw new Error('generated script failed to run')
+  }
+  console.log('ok')
+}).catch((err) => {
+  console.error(err)
+  process.exit(1)
+}).finally(() => {
+  fs.rmSync(SCRIPT, { force: true })
+})

integration-tests/esbuild/index.spec.js

@@ -77,6 +77,14 @@ esbuildVersions.forEach((version) => {
       })
     })
 
+    it('handles instrumentations where the patching function is a property of the hook', () => {
+      const command = 'node ./build-and-test-openai.js'
+      console.log(command)
+      chproc.execSync(command, {
+        timeout: 1000 * 30
+      })
+    })
+
     describe('ESM', () => {
       afterEach(() => {
         fs.rmSync('./out.mjs', { force: true })

integration-tests/esbuild/openai.js

@@ -0,0 +1,2 @@
+require('../../').init()
+require('openai')

integration-tests/esbuild/package.json

@@ -27,6 +27,7 @@
     "esbuild": "*",
     "express": "^4.16.2",
     "knex": "*",
-    "koa": "*"
+    "koa": "*",
+    "openai": "*"
   }
 }

packages/datadog-instrumentations/src/helpers/bundler-register.js

@@ -26,14 +26,29 @@ if (!dc.unsubscribe) {
   }
 }
 
-dc.subscribe(CHANNEL, (payload) => {
-  try {
-    hooks[payload.package]()
-  } catch (err) {
+function doHook (payload) {
+  const hook = hooks[payload.package]
+  if (!hook) {
     log.error('esbuild-wrapped %s missing in list of hooks', payload.package)
-    throw err
+    return
+  }
+
+  const hookFn = hook.fn ?? hook
+  if (typeof hookFn !== 'function') {
+    log.error('esbuild-wrapped hook %s is not a function', payload.package)
+    return
   }
 
+  try {
+    hookFn()
+  } catch {
+    log.error('esbuild-wrapped %s hook failed', payload.package)
+  }
+}
+
+dc.subscribe(CHANNEL, (payload) => {
+  doHook(payload)
+
   if (!instrumentations[payload.package]) {
     log.error('esbuild-wrapped %s missing in list of instrumentations', payload.package)
     return