Improve typing so we don't walk over openai's types when using the

instrumentation directly in cloudflare/vercel-edge

Author: andreiborza

dev-packages/cloudflare-integration-tests/suites/tracing/openai/mocks.ts

@@ -1,8 +1,8 @@
 import type { OpenAiClient } from '@sentry/core';
 
 export class MockOpenAi implements OpenAiClient {
-  public chat?: Record<string, unknown> | undefined;
-  public responses?: {
+  public chat: Record<string, unknown>;
+  public responses: {
     create: (...args: unknown[]) => Promise<unknown>;
   };
 

dev-packages/cloudflare-integration-tests/suites/tracing/openai/test.ts

@@ -1,6 +1,11 @@
 import { expect, it } from 'vitest';
 import { createRunner } from '../../../runner';
 
+// These tests are not exhaustive because the instrumentation is
+// already tested in the node integration tests and we merely
+// want to test that the instrumentation does not break in our
+// cloudflare SDK.
+
 it('traces a basic chat completion request', async () => {
   const runner = createRunner(__dirname)
     .ignore('event')

packages/core/src/utils/openai/index.ts

@@ -24,7 +24,6 @@ import type {
   ChatCompletionChunk,
   InstrumentedMethod,
   OpenAiChatCompletionObject,
-  OpenAiClient,
   OpenAiIntegration,
   OpenAiOptions,
   OpenAiResponse,
@@ -294,7 +293,7 @@ function instrumentMethod<T extends unknown[], R>(
 /**
  * Create a deep proxy for OpenAI client instrumentation
  */
-function createDeepProxy(target: object, currentPath = '', options?: OpenAiOptions): OpenAiClient {
+function createDeepProxy<T extends object>(target: T, currentPath = '', options?: OpenAiOptions): T {
   return new Proxy(target, {
     get(obj: object, prop: string): unknown {
       const value = (obj as Record<string, unknown>)[prop];
@@ -316,13 +315,13 @@ function createDeepProxy(target: object, currentPath = '', options?: OpenAiOptio
 
       return value;
     },
-  });
+  }) as T;
 }
 
 /**
  * Instrument an OpenAI client with Sentry tracing
  * Can be used across Node.js, Cloudflare Workers, and Vercel Edge
  */
-export function instrumentOpenAiClient(client: OpenAiClient, options?: OpenAiOptions): OpenAiClient {
+export function instrumentOpenAiClient<T extends object>(client: T, options?: OpenAiOptions): T {
   return createDeepProxy(client, '', options);
 }

packages/core/src/utils/openai/types.ts

@@ -15,20 +15,20 @@ export type AttributeValue =
 
 export interface OpenAiOptions {
   /**
-   * Enable or disable input recording. Enabled if `sendDefaultPii` is `true`
+   * Enable or disable input recording.
    */
   recordInputs?: boolean;
   /**
-   * Enable or disable output recording. Enabled if `sendDefaultPii` is `true`
+   * Enable or disable output recording.
    */
   recordOutputs?: boolean;
 }
 
 export interface OpenAiClient {
-  responses?: {
+  responses: {
     create: (...args: unknown[]) => Promise<unknown>;
   };
-  chat?: {
+  chat: {
     completions?: {
       create: (...args: unknown[]) => Promise<unknown>;
     };