fix: add to @openai/agents blocklist for IITM exclusions (#6452)

* the loader is broken for openai agents, adds the shim for it as well

* adds a test

* fix esbuild integration test package.json

* remove from esbuild package.json

* alphabetical order

* fix test to actually test

---------

Co-authored-by: Greg Meyer <greg@zingage.com>

Author: sabrenner

initialize.mjs

@@ -36,7 +36,7 @@ ${result.source}`
 const [NODE_MAJOR, NODE_MINOR] = process.versions.node.split('.').map(Number)
 
 const brokenLoaders = NODE_MAJOR === 18 && NODE_MINOR === 0
-const iitmExclusions = [/langsmith/, /openai\/_shims/, /openai\/resources\/chat\/completions\/messages/]
+const iitmExclusions = [/langsmith/, /openai\/_shims/, /openai\/resources\/chat\/completions\/messages/, /openai\/agents-core\/dist\/shims/]
 
 export async function load (url, context, nextLoad) {
   const iitmExclusionsMatch = iitmExclusions.some((exclusion) => exclusion.test(url))

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

@@ -4,7 +4,7 @@ const {
   FakeAgent,
   createSandbox,
   checkSpansForServiceName,
-  spawnPluginIntegrationTestProc
+  spawnPluginIntegrationTestProc,
 } = require('../../../../integration-tests/helpers')
 const { withVersions } = require('../../../dd-trace/test/setup/mocha')
 const { assert } = require('chai')
@@ -17,11 +17,19 @@ describe('esm', () => {
   // limit v4 tests while the IITM issue is resolved or a workaround is introduced
   // this is only relevant for `openai` >=4.0 <=4.1
   // issue link: https://github.com/DataDog/import-in-the-middle/issues/60
-  withVersions('openai', 'openai', '>=3 <4.0.0 || >4.1.0', version => {
+  withVersions('openai', 'openai', '>=3 <4.0.0 || >4.1.0', (version) => {
     before(async function () {
       this.timeout(20000)
-      sandbox = await createSandbox([`'openai@${version}'`, 'nock'], false, [
-        './packages/datadog-plugin-openai/test/integration-test/*'])
+      sandbox = await createSandbox(
+        [
+          `'openai@${version}'`,
+          'nock',
+          '@openai/agents',
+          '@openai/agents-core',
+        ],
+        false,
+        ['./packages/datadog-plugin-openai/test/integration-test/*']
+      )
     })
 
     after(async () => {
@@ -41,12 +49,21 @@ describe('esm', () => {
       const res = agent.assertMessageReceived(({ headers, payload }) => {
         assert.propertyVal(headers, 'host', `127.0.0.1:${agent.port}`)
         assert.isArray(payload)
-        assert.strictEqual(checkSpansForServiceName(payload, 'openai.request'), true)
+        assert.strictEqual(
+          checkSpansForServiceName(payload, 'openai.request'),
+          true
+        )
       })
 
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port, null, {
-        NODE_OPTIONS: '--import dd-trace/register.js'
-      })
+      proc = await spawnPluginIntegrationTestProc(
+        sandbox.folder,
+        'server.mjs',
+        agent.port,
+        null,
+        {
+          NODE_OPTIONS: '--import dd-trace/initialize.mjs',
+        }
+      )
 
       await res
     }).timeout(20000)

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

@@ -1,6 +1,8 @@
-import 'dd-trace/init.js'
 import OpenAI from 'openai'
 
+// load in openai agents to test iitm functionality
+import { Agent, run } from '@openai/agents' // eslint-disable-line no-unused-vars
+
 const params = {
   model: 'gpt-3.5-turbo-instruct',
   prompt: 'Hello, OpenAI!',

packages/dd-trace/test/plugins/versions/package.json

@@ -5,6 +5,8 @@
   "private": true,
   "dependencies": {
     "@ai-sdk/openai": "2.0.27",
+    "@openai/agents": "0.1.0",
+    "@openai/agents-core": "0.1.0",
     "@apollo/gateway": "2.11.2",
     "@apollo/server": "5.0.0",
     "@apollo/subgraph": "2.11.2",

register.js

@@ -6,5 +6,5 @@ const { register } = require('node:module')
 const { pathToFileURL } = require('node:url')
 
 register('./loader-hook.mjs', pathToFileURL(__filename), {
-  data: { exclude: [/langsmith/, /openai\/_shims/, /openai\/resources\/chat\/completions\/messages/] }
+  data: { exclude: [/langsmith/, /openai\/_shims/, /openai\/resources\/chat\/completions\/messages/, /openai\/agents-core\/dist\/shims/] }
 })