@arizeai/openinference-instrumentation-openai 4.2.0 → 4.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/openinference-instrumentation-openai",
-  "version": "4.2.0",
+  "version": "4.2.1",
   "private": false,
   "description": "OpenInference instrumentation for OpenAI",
   "keywords": [],
@@ -28,7 +28,7 @@
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^2.8.0",
     "@opentelemetry/instrumentation": "^0.46.0",
-    "@arizeai/openinference-core": "2.5.3",
+    "@arizeai/openinference-core": "2.5.4",
     "@arizeai/openinference-semantic-conventions": "2.8.0"
   },
   "devDependencies": {

package/src/instrumentation.ts

@@ -99,6 +99,19 @@ export function getProviderFromHost(host: string): LLMProvider | undefined {
  */
 let _isOpenInferencePatched = false;
 
+/**
+ * The OpenAI classes that have already been patched, tracked by identity.
+ * The SDK ships separate CJS and ESM builds with separate class objects, so a
+ * module-global boolean cannot guard them independently: whichever build was
+ * patched first would block the other one forever (#3557). A Set is
+ * scoped to the object, and needs no write to the module, so it also keeps
+ * the double-patch guard working when the module is immutable (e.g. Deno,
+ * webpack) and the `openInferencePatched` property cannot be set. Entries
+ * are removed when their wrappers are removed, so the Set does not retain
+ * unpatched SDK builds.
+ */
+const _patchedModules = new Set<object>();
+
 /**
  * function to check if instrumentation is enabled / disabled
  */
@@ -167,6 +180,7 @@ function getLLMProvider(clientInstance: unknown): LLMProvider | undefined {
   } catch (error) {
     diag.debug("Failed to determine LLM provider from instance", error);
   }
+  return undefined;
 }
 
 /**
@@ -178,6 +192,10 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
   private oiTracer: OITracer;
   private tracerProvider?: TracerProvider;
   private traceConfig?: TraceConfigOptions;
+  private readonly patchedModuleExports = new Map<
+    typeof openai.OpenAI,
+    typeof openai & { openInferencePatched?: boolean }
+  >();
   constructor({
     instrumentationConfig,
     traceConfig,
@@ -230,6 +248,13 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
     this.patch(module);
   }
 
+  disable(): void {
+    super.disable();
+    for (const moduleExports of [...this.patchedModuleExports.values()]) {
+      this.unpatch(moduleExports);
+    }
+  }
+
   get tracer(): Tracer {
     if (this.tracerProvider) {
       return this.tracerProvider.getTracer(this.instrumentationName, this.instrumentationVersion);
@@ -254,7 +279,9 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
     moduleVersion?: string,
   ) {
     diag.debug(`Applying patch for ${MODULE_NAME}@${moduleVersion}`);
-    if (module?.openInferencePatched || _isOpenInferencePatched) {
+    // WeakSet.has() returns false for non-objects, so an unexpected module
+    // shape falls through here and fails loudly below instead.
+    if (module?.openInferencePatched || _patchedModules.has(module.OpenAI)) {
       return module;
     }
     // eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -558,6 +585,8 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
     }
 
     _isOpenInferencePatched = true;
+    _patchedModules.add(module.OpenAI);
+    this.patchedModuleExports.set(module.OpenAI, module);
     try {
       // This can fail if the module is made immutable via the runtime or bundler
       module.openInferencePatched = true;
@@ -579,7 +608,10 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
     this._unwrap(moduleExports.OpenAI.Completions.prototype, "create");
     this._unwrap(moduleExports.OpenAI.Embeddings.prototype, "create");
 
-    _isOpenInferencePatched = false;
+    // Keyed the same way patch() keys it, so a re-patch is possible after.
+    _patchedModules.delete(moduleExports.OpenAI);
+    this.patchedModuleExports.delete(moduleExports.OpenAI);
+    _isOpenInferencePatched = _patchedModules.size > 0;
     try {
       // This can fail if the module is made immutable via the runtime or bundler
       moduleExports.openInferencePatched = false;
@@ -624,7 +656,7 @@ function isPromptStringArray(
  * Converts the body of a chat completions request to LLM input messages
  */
 function getLLMInputMessagesAttributes(body: ChatCompletionCreateParamsBase): Attributes {
-  return body.messages.reduce((acc, message, index) => {
+  return body.messages.reduce<Attributes>((acc, message, index) => {
     const messageAttributes = getChatCompletionInputMessageAttributes(message);
     const indexPrefix = `${SemanticConventions.LLM_INPUT_MESSAGES}.${index}.`;
     // Flatten the attributes on the index prefix
@@ -632,7 +664,7 @@ function getLLMInputMessagesAttributes(body: ChatCompletionCreateParamsBase): At
       acc[`${indexPrefix}${key}`] = value;
     }
     return acc;
-  }, {} as Attributes);
+  }, {});
 }
 
 /**
@@ -780,7 +812,7 @@ function getChatCompletionLLMOutputMessagesAttributes(chatCompletion: ChatComple
   if (!choice) {
     return {};
   }
-  return [choice.message].reduce((acc, message, index) => {
+  return [choice.message].reduce<Attributes>((acc, message, index) => {
     const indexPrefix = `${SemanticConventions.LLM_OUTPUT_MESSAGES}.${index}.`;
     const messageAttributes = getChatCompletionOutputMessageAttributes(message);
     // Flatten the attributes on the index prefix
@@ -788,7 +820,7 @@ function getChatCompletionLLMOutputMessagesAttributes(chatCompletion: ChatComple
       acc[`${indexPrefix}${key}`] = value;
     }
     return acc;
-  }, {} as Attributes);
+  }, {});
 }
 
 /**
@@ -867,11 +899,11 @@ function getEmbeddingTextAttributes(request: EmbeddingCreateParams): Attributes
     request.input.length > 0 &&
     typeof request.input[0] === "string"
   ) {
-    return request.input.reduce((acc, input, index) => {
+    return request.input.reduce<Attributes>((acc, input, index) => {
       const indexPrefix = `${SemanticConventions.EMBEDDING_EMBEDDINGS}.${index}.`;
       acc[`${indexPrefix}${SemanticConventions.EMBEDDING_TEXT}`] = input;
       return acc;
-    }, {} as Attributes);
+    }, {});
   }
   // Ignore other cases where input is a number or an array of numbers
   return {};
@@ -881,11 +913,11 @@ function getEmbeddingTextAttributes(request: EmbeddingCreateParams): Attributes
  * Converts the embedding result payload to embedding attributes
  */
 function getEmbeddingEmbeddingsAttributes(response: CreateEmbeddingResponse): Attributes {
-  return response.data.reduce((acc, embedding, index) => {
+  return response.data.reduce<Attributes>((acc, embedding, index) => {
     const indexPrefix = `${SemanticConventions.EMBEDDING_EMBEDDINGS}.${index}.`;
     acc[`${indexPrefix}${SemanticConventions.EMBEDDING_VECTOR}`] = embedding.embedding;
     return acc;
-  }, {} as Attributes);
+  }, {});
 }
 
 /**

package/src/version.ts

@@ -1,2 +1,2 @@
 // this is an auto-generated file. see js/scripts/version-update.js
-export const VERSION = "4.2.0";
+export const VERSION = "4.2.1";