Support OpenAI v5

Author: timokoessler

README.md

@@ -102,7 +102,7 @@ See list above for supported database drivers.
 
 Zen instruments the following AI SDKs to track which models are used and how many tokens are consumed, allowing you to monitor your AI usage and costs:
 
-* ✅ [`openai`](https://www.npmjs.com/package/openai) 4.x
+* ✅ [`openai`](https://www.npmjs.com/package/openai) 5.x, 4.x
 * ✅ [`@aws-sdk/client-bedrock-runtime`](https://www.npmjs.com/package/@aws-sdk/client-bedrock-runtime) 3.x
 
 _Note: Prompt injection attacks are currently not covered by Zen._

library/package-lock.json

@@ -102,6 +102,8 @@
     "mysql2-v3.12": "npm:mysql2@3.12",
     "needle": "^3.3.1",
     "node-fetch": "^2",
+    "openai-v4": "npm:openai@^4.104.0",
+    "openai-v5": "npm:openai@^5.7.0",
     "percentile": "^1.6.0",
     "pg": "^8.11.3",
     "postgres": "^3.4.4",

library/package.json

@@ -0,0 +1,75 @@
+import * as t from "tap";
+import { startTestAgent } from "../helpers/startTestAgent";
+import { OpenAI as OpenAISink } from "./OpenAI";
+import { getMajorNodeVersion } from "../helpers/getNodeVersion";
+import { setTimeout } from "timers/promises";
+
+export function createOpenAITests(openAiPkgName: string) {
+  t.test(
+    "It works",
+    {
+      skip:
+        !process.env.OPENAI_API_KEY || getMajorNodeVersion() < 22
+          ? "OpenAI API key not set or Node version < 22"
+          : undefined,
+    },
+    async (t) => {
+      const agent = startTestAgent({
+        wrappers: [new OpenAISink()],
+        rewrite: {
+          openai: openAiPkgName,
+        },
+      });
+
+      const { OpenAI } = require(openAiPkgName) as typeof import("openai-v5");
+
+      const client = new OpenAI();
+
+      const model = "gpt-4.1-nano";
+
+      const response = await client.responses.create({
+        model: model,
+        instructions: "Only return one word.",
+        input: "What is the capital of Belgium?",
+      });
+
+      t.same(response.output_text, "Brussels");
+
+      t.match(agent.getAIStatistics().getStats(), [
+        {
+          provider: "openai",
+          calls: 1,
+          tokens: {
+            input: 23,
+            output: 3,
+            total: 26,
+          },
+        },
+      ]);
+
+      t.match(agent.getAIStatistics().getStats()[0].model, model); // Model name starts with the used model but may include additional information
+
+      await setTimeout(100);
+
+      const completion = await client.chat.completions.create({
+        model: model,
+        messages: [
+          { role: "developer", content: "Only return one word." },
+          { role: "user", content: "What is the capital of Norway?" },
+        ],
+      });
+
+      t.same(completion.choices[0].message.content, "Oslo");
+
+      t.match(agent.getAIStatistics().getStats(), [
+        {
+          provider: "openai",
+          calls: 2,
+          tokens: {
+            input: 46,
+          },
+        },
+      ]);
+    }
+  );
+}

library/sinks/OpenAI.tests.ts

@@ -113,14 +113,37 @@ export class OpenAI implements Wrapper {
     return "openai";
   }
 
+  private getResponsesClass(exports: any) {
+    if (exports.Responses) {
+      return exports.Responses;
+    }
+    if (exports.OpenAI && exports.OpenAI.Responses) {
+      return exports.OpenAI.Responses;
+    }
+  }
+
+  private getCompletionsClass(exports: any) {
+    if (exports.Chat && exports.Chat.Completions) {
+      return exports.Chat.Completions;
+    }
+    if (
+      exports.OpenAI &&
+      exports.OpenAI.Chat &&
+      exports.OpenAI.Chat.Completions
+    ) {
+      return exports.OpenAI.Chat.Completions;
+    }
+  }
+
   wrap(hooks: Hooks) {
     // Note: Streaming is not supported yet
     hooks
       .addPackage("openai")
-      .withVersion("^4.0.0")
+      .withVersion("^5.0.0 || ^4.0.0")
       .onRequire((exports, pkgInfo) => {
-        if (exports.Responses) {
-          wrapExport(exports.Responses.prototype, "create", pkgInfo, {
+        const responsesClass = this.getResponsesClass(exports);
+        if (responsesClass) {
+          wrapExport(responsesClass.prototype, "create", pkgInfo, {
             kind: "ai_op",
             modifyReturnValue: (_, returnValue, agent, subject) => {
               if (returnValue instanceof Promise) {
@@ -143,8 +166,9 @@ export class OpenAI implements Wrapper {
           });
         }
 
-        if (exports.Chat.Completions) {
-          wrapExport(exports.Chat.Completions.prototype, "create", pkgInfo, {
+        const completionsClass = this.getCompletionsClass(exports);
+        if (completionsClass) {
+          wrapExport(completionsClass.prototype, "create", pkgInfo, {
             kind: "ai_op",
             modifyReturnValue: (_, returnValue, agent, subject) => {
               if (returnValue instanceof Promise) {

library/sinks/OpenAI.ts

@@ -0,0 +1,3 @@
+import { createOpenAITests } from "./OpenAI.tests";
+
+createOpenAITests("openai-v4");

library/sinks/OpenAI.v4.test.ts

@@ -0,0 +1,3 @@
+import { createOpenAITests } from "./OpenAI.tests";
+
+createOpenAITests("openai-v5");