@posthog/ai 4.2.1 → 4.3.1

package/src/vercel/middleware.ts

@@ -14,7 +14,7 @@ interface ClientOptions {
   posthogModelOverride?: string
   posthogProviderOverride?: string
   posthogCostOverride?: CostOverride
-  fullDebug?: boolean
+  posthogCaptureImmediate?: boolean
 }
 
 interface CreateInstrumentationMiddlewareOptions {
@@ -26,7 +26,7 @@ interface CreateInstrumentationMiddlewareOptions {
   posthogModelOverride?: string
   posthogProviderOverride?: string
   posthogCostOverride?: CostOverride
-  fullDebug?: boolean
+  posthogCaptureImmediate?: boolean
 }
 
 interface PostHogInput {
@@ -128,7 +128,9 @@ const mapVercelPrompt = (prompt: LanguageModelV1Prompt): PostHogInput[] => {
     // Trim the inputs array until its JSON size fits within MAX_OUTPUT_SIZE
     let serialized = JSON.stringify(inputs)
     let removedCount = 0
-    while (Buffer.byteLength(serialized, 'utf8') > MAX_OUTPUT_SIZE && inputs.length > 0) {
+    // We need to keep track of the initial size of the inputs array because we're going to be mutating it
+    let initialSize = inputs.length
+    for (let i = 0; i < initialSize && Buffer.byteLength(serialized, 'utf8') > MAX_OUTPUT_SIZE; i++) {
       inputs.shift()
       removedCount++
       serialized = JSON.stringify(inputs)
@@ -136,7 +138,7 @@ const mapVercelPrompt = (prompt: LanguageModelV1Prompt): PostHogInput[] => {
     if (removedCount > 0) {
       // Add one placeholder to indicate how many were removed
       inputs.unshift({
-        role: 'assistant',
+        role: 'posthog',
         content: `[${removedCount} message${removedCount === 1 ? '' : 's'} removed due to size limit]`,
       })
     }
@@ -224,7 +226,7 @@ export const createInstrumentationMiddleware = (
               }
             : {}),
         }
-        sendEventToPosthog({
+        await sendEventToPosthog({
           client: phClient,
           distinctId: options.posthogDistinctId,
           traceId: options.posthogTraceId,
@@ -241,13 +243,13 @@ export const createInstrumentationMiddleware = (
             outputTokens: result.usage.completionTokens,
             ...additionalTokenValues,
           },
-          fullDebug: options.fullDebug,
+          captureImmediate: options.posthogCaptureImmediate,
         })
 
         return result
       } catch (error: any) {
         const modelId = model.modelId
-        sendEventToPosthog({
+        await sendEventToPosthog({
           client: phClient,
           distinctId: options.posthogDistinctId,
           traceId: options.posthogTraceId,
@@ -265,7 +267,7 @@ export const createInstrumentationMiddleware = (
           },
           isError: true,
           error: truncate(JSON.stringify(error)),
-          fullDebug: options.fullDebug,
+          captureImmediate: options.posthogCaptureImmediate,
         })
         throw error
       }
@@ -317,9 +319,9 @@ export const createInstrumentationMiddleware = (
             controller.enqueue(chunk)
           },
 
-          flush() {
+          flush: async () => {
             const latency = (Date.now() - startTime) / 1000
-            sendEventToPosthog({
+            await sendEventToPosthog({
               client: phClient,
               distinctId: options.posthogDistinctId,
               traceId: options.posthogTraceId,
@@ -332,7 +334,7 @@ export const createInstrumentationMiddleware = (
               params: mergedParams as any,
               httpStatus: 200,
               usage,
-              fullDebug: options.fullDebug,
+              captureImmediate: options.posthogCaptureImmediate,
             })
           },
         })
@@ -342,7 +344,7 @@ export const createInstrumentationMiddleware = (
           ...rest,
         }
       } catch (error: any) {
-        sendEventToPosthog({
+        await sendEventToPosthog({
           client: phClient,
           distinctId: options.posthogDistinctId,
           traceId: options.posthogTraceId,
@@ -360,7 +362,7 @@ export const createInstrumentationMiddleware = (
           },
           isError: true,
           error: truncate(JSON.stringify(error)),
-          fullDebug: options.fullDebug,
+          captureImmediate: options.posthogCaptureImmediate,
         })
         throw error
       }

package/tests/openai.test.ts

@@ -1,19 +1,65 @@
 import { PostHog } from 'posthog-node'
 import PostHogOpenAI from '../src/openai'
+import openaiModule from 'openai'
+
+let mockOpenAiChatResponse: any = {}
+let mockOpenAiEmbeddingResponse: any = {}
 
 jest.mock('posthog-node', () => {
   return {
     PostHog: jest.fn().mockImplementation(() => {
       return {
         capture: jest.fn(),
+        captureImmediate: jest.fn(),
         privacyMode: false,
       }
     }),
   }
 })
 
-let mockOpenAiChatResponse: any = {}
-let mockOpenAiEmbeddingResponse: any = {}
+jest.mock('openai', () => {
+  // Mock Completions class – `create` is declared on the prototype so that
+  // subclasses can safely `super.create(...)` without it being shadowed by an
+  // instance field (which would overwrite the subclass implementation).
+  class MockCompletions {
+    constructor() {}
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    create(..._args: any[]): any {
+      /* will be stubbed in beforeEach */
+      return undefined
+    }
+  }
+
+  // Mock Chat class
+  class MockChat {
+    constructor() {}
+    static Completions = MockCompletions
+  }
+
+  // Mock OpenAI class
+  class MockOpenAI {
+    chat: any
+    embeddings: any
+    constructor() {
+      this.chat = {
+        completions: {
+          create: jest.fn(),
+        },
+      }
+      this.embeddings = {
+        create: jest.fn(),
+      }
+    }
+    static Chat = MockChat
+  }
+
+  return {
+    __esModule: true,
+    default: MockOpenAI,
+    OpenAI: MockOpenAI,
+    Chat: MockChat,
+  }
+})
 
 describe('PostHogOpenAI - Jest test suite', () => {
   let mockPostHogClient: PostHog
@@ -79,6 +125,9 @@ describe('PostHogOpenAI - Jest test suite', () => {
         total_tokens: 10,
       },
     }
+
+    const ChatMock: any = openaiModule.Chat
+    ;(ChatMock.Completions as any).prototype.create = jest.fn().mockResolvedValue(mockOpenAiChatResponse)
   })
 
   // Wrap each test with conditional skip
@@ -261,4 +310,18 @@ describe('PostHogOpenAI - Jest test suite', () => {
     expect(properties['$ai_reasoning_tokens']).toBe(15)
     expect(properties['$ai_cache_read_input_tokens']).toBe(5)
   })
+
+  // New test: ensure captureImmediate is used when flag is set
+  conditionalTest('captureImmediate flag', async () => {
+    await client.chat.completions.create({
+      model: 'gpt-4',
+      messages: [{ role: 'user', content: 'Hello' }],
+      posthogDistinctId: 'test-id',
+      posthogCaptureImmediate: true,
+    })
+
+    // captureImmediate should be called once, and capture should not be called
+    expect(mockPostHogClient.captureImmediate).toHaveBeenCalledTimes(1)
+    expect(mockPostHogClient.capture).toHaveBeenCalledTimes(0)
+  })
 })

package/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "incremental": false,
-    "types": ["node"],
+    "types": ["node", "jest"],
     "typeRoots": ["./node_modules/@types", "../node_modules/@types"],
     "moduleResolution": "node",
     "skipLibCheck": true,