fix: exclude undefined cost from providerMetadata (#359)

robert-j-y · devin-ai-integration[bot] · web-flow · commit 85d6633058f8 · 2026-01-27T13:26:38.000-08:00
* fix: exclude undefined cost from providerMetadata When cost is undefined, it should not be included in the providerMetadata object since undefined is not a valid JSON value. This was causing AI SDK validation failures when passing providerMetadata back into subsequent conversation turns. The fix uses conditional spreading/assignment to only include the cost field when it has a defined value, matching the existing pattern used for other optional fields like costDetails. Fixes #262 Co-Authored-By: Robert Yeakel <robert.yeakel@openrouter.ai> * fix: apply same cost fix to embedding model Ensure embedding model also uses conditional spreading for cost field to maintain consistency with chat and completion models. Co-Authored-By: Robert Yeakel <robert.yeakel@openrouter.ai> * fix: add providerMetadata to completion model doGenerate For consistency with chat model and streaming endpoints, the completion model's doGenerate method now returns providerMetadata with usage info. Co-Authored-By: Robert Yeakel <robert.yeakel@openrouter.ai> * fix: add schema validation and provider field to completion/embedding models - Completion doGenerate: use OpenRouterProviderMetadataSchema.parse() with provider field - Completion doStream: track and include provider field in providerMetadata - Completion schema: add provider field - Embedding model: include provider field and full usage structure (promptTokens, completionTokens, totalTokens) - Embedding schema: add provider field - Update embedding test expectations Co-Authored-By: Robert Yeakel <robert.yeakel@openrouter.ai> * fix: add schema validation to embedding model for consistency Co-Authored-By: Robert Yeakel <robert.yeakel@openrouter.ai> * test: add coverage for completion doGenerate providerMetadata Co-Authored-By: Robert Yeakel <robert.yeakel@openrouter.ai> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
diff --git a/.changeset/dark-pens-float.md b/.changeset/dark-pens-float.md
@@ -0,0 +1,5 @@
+---
+"@openrouter/ai-sdk-provider": patch
+---
+
+Fix undefined cost field in providerMetadata causing AI SDK validation failures
diff --git a/src/chat/index.test.ts b/src/chat/index.test.ts
@@ -996,7 +996,6 @@ describe('doStream', () => {
               completionTokens: 227,
               promptTokens: 17,
               totalTokens: 244,
-              cost: undefined,
             },
           },
         },
@@ -1593,7 +1592,6 @@ describe('doStream', () => {
               completionTokens: 17,
               promptTokens: 53,
               totalTokens: 70,
-              cost: undefined,
             },
           },
         },
@@ -1712,7 +1710,6 @@ describe('doStream', () => {
               completionTokens: 17,
               promptTokens: 53,
               totalTokens: 70,
-              cost: undefined,
             },
           },
         },
@@ -1850,7 +1847,6 @@ describe('doStream', () => {
               completionTokens: 17,
               promptTokens: 53,
               totalTokens: 70,
-              cost: undefined,
             },
           },
         },
diff --git a/src/chat/index.ts b/src/chat/index.ts
@@ -485,7 +485,9 @@ export class OpenRouterChatLanguageModel implements LanguageModelV3 {
             totalTokens:
               (usageInfo.inputTokens.total ?? 0) +
               (usageInfo.outputTokens.total ?? 0),
-            cost: response.usage?.cost,
+            ...(response.usage?.cost != null
+              ? { cost: response.usage.cost }
+              : {}),
             ...(response.usage?.prompt_tokens_details?.cached_tokens != null
               ? {
                   promptTokensDetails: {
@@ -701,7 +703,9 @@ export class OpenRouterChatLanguageModel implements LanguageModelV3 {
                 };
               }
 
-              openrouterUsage.cost = value.usage.cost;
+              if (value.usage.cost != null) {
+                openrouterUsage.cost = value.usage.cost;
+              }
               openrouterUsage.totalTokens = value.usage.total_tokens;
               const upstreamInferenceCost =
                 value.usage.cost_details?.upstream_inference_cost;
diff --git a/src/completion/index.test.ts b/src/completion/index.test.ts
@@ -70,19 +70,31 @@ describe('doGenerate', () => {
     },
     logprobs = null,
     finish_reason = 'stop',
+    provider,
   }: {
     content?: string;
     usage?: {
       prompt_tokens: number;
       total_tokens: number;
       completion_tokens: number;
+      cost?: number;
+      prompt_tokens_details?: {
+        cached_tokens: number;
+      };
+      completion_tokens_details?: {
+        reasoning_tokens: number;
+      };
+      cost_details?: {
+        upstream_inference_cost: number;
+      };
     };
     logprobs?: {
       tokens: string[];
       token_logprobs: number[];
       top_logprobs: Record<string, number>[];
     } | null;
     finish_reason?: string;
+    provider?: string;
   }) {
     server.urls['https://openrouter.ai/api/v1/completions']!.response = {
       type: 'json-value',
@@ -91,6 +103,7 @@ describe('doGenerate', () => {
         object: 'text_completion',
         created: 1711363706,
         model: 'openai/gpt-3.5-turbo-instruct',
+        provider,
         choices: [
           {
             text: content,
@@ -146,6 +159,149 @@ describe('doGenerate', () => {
     });
   });
 
+  it('should return providerMetadata with usage and provider', async () => {
+    prepareJsonResponse({
+      content: 'Hello',
+      usage: {
+        prompt_tokens: 10,
+        total_tokens: 20,
+        completion_tokens: 10,
+        cost: 0.0001,
+      },
+      provider: 'openai',
+    });
+
+    const { providerMetadata } = await model.doGenerate({
+      prompt: TEST_PROMPT,
+    });
+
+    expect(providerMetadata).toStrictEqual({
+      openrouter: {
+        provider: 'openai',
+        usage: {
+          promptTokens: 10,
+          completionTokens: 10,
+          totalTokens: 20,
+          cost: 0.0001,
+        },
+      },
+    });
+  });
+
+  it('should omit cost from providerMetadata when undefined', async () => {
+    prepareJsonResponse({
+      content: 'Hello',
+      usage: {
+        prompt_tokens: 10,
+        total_tokens: 20,
+        completion_tokens: 10,
+      },
+      provider: 'google',
+    });
+
+    const { providerMetadata } = await model.doGenerate({
+      prompt: TEST_PROMPT,
+    });
+
+    const openrouterMetadata = providerMetadata?.openrouter as {
+      provider?: string;
+      usage?: { cost?: number };
+    };
+
+    expect(openrouterMetadata?.provider).toBe('google');
+    expect(openrouterMetadata?.usage?.cost).toBeUndefined();
+    expect('cost' in (openrouterMetadata?.usage ?? {})).toBe(false);
+  });
+
+  it('should include cost: 0 in providerMetadata when cost is zero', async () => {
+    prepareJsonResponse({
+      content: 'Hello',
+      usage: {
+        prompt_tokens: 10,
+        total_tokens: 20,
+        completion_tokens: 10,
+        cost: 0,
+      },
+      provider: 'openai',
+    });
+
+    const { providerMetadata } = await model.doGenerate({
+      prompt: TEST_PROMPT,
+    });
+
+    const openrouterMetadata = providerMetadata?.openrouter as {
+      usage?: { cost?: number };
+    };
+
+    expect(openrouterMetadata?.usage?.cost).toBe(0);
+  });
+
+  it('should default provider to empty string when not returned by API', async () => {
+    prepareJsonResponse({
+      content: 'Hello',
+      usage: {
+        prompt_tokens: 10,
+        total_tokens: 20,
+        completion_tokens: 10,
+      },
+    });
+
+    const { providerMetadata } = await model.doGenerate({
+      prompt: TEST_PROMPT,
+    });
+
+    const openrouterMetadata = providerMetadata?.openrouter as {
+      provider?: string;
+    };
+
+    expect(openrouterMetadata?.provider).toBe('');
+  });
+
+  it('should include token details in providerMetadata when provided', async () => {
+    prepareJsonResponse({
+      content: 'Hello',
+      usage: {
+        prompt_tokens: 100,
+        total_tokens: 150,
+        completion_tokens: 50,
+        prompt_tokens_details: {
+          cached_tokens: 80,
+        },
+        completion_tokens_details: {
+          reasoning_tokens: 20,
+        },
+        cost_details: {
+          upstream_inference_cost: 0.005,
+        },
+      },
+      provider: 'anthropic',
+    });
+
+    const { providerMetadata } = await model.doGenerate({
+      prompt: TEST_PROMPT,
+    });
+
+    expect(providerMetadata).toStrictEqual({
+      openrouter: {
+        provider: 'anthropic',
+        usage: {
+          promptTokens: 100,
+          completionTokens: 50,
+          totalTokens: 150,
+          promptTokensDetails: {
+            cachedTokens: 80,
+          },
+          completionTokensDetails: {
+            reasoningTokens: 20,
+          },
+          costDetails: {
+            upstreamInferenceCost: 0.005,
+          },
+        },
+      },
+    });
+  });
+
   it('should extract logprobs', async () => {
     prepareJsonResponse({ logprobs: TEST_LOGPROBS });
 
@@ -341,7 +497,6 @@ describe('doStream', () => {
               promptTokens: 10,
               completionTokens: 362,
               totalTokens: 372,
-              cost: undefined,
             },
           },
         },
diff --git a/src/completion/index.ts b/src/completion/index.ts
@@ -27,6 +27,7 @@ import {
   postJsonToApi,
 } from '@ai-sdk/provider-utils';
 import { openrouterFailedResponseHandler } from '../schemas/error-response';
+import { OpenRouterProviderMetadataSchema } from '../schemas/provider-metadata';
 import {
   createFinishReason,
   mapOpenRouterFinishReason,
@@ -220,6 +221,46 @@ export class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
         raw: (response.usage as JSONObject) ?? undefined,
       },
       warnings: [],
+      providerMetadata: {
+        openrouter: OpenRouterProviderMetadataSchema.parse({
+          provider: response.provider ?? '',
+          usage: {
+            promptTokens: response.usage?.prompt_tokens ?? 0,
+            completionTokens: response.usage?.completion_tokens ?? 0,
+            totalTokens:
+              (response.usage?.prompt_tokens ?? 0) +
+              (response.usage?.completion_tokens ?? 0),
+            ...(response.usage?.cost != null
+              ? { cost: response.usage.cost }
+              : {}),
+            ...(response.usage?.prompt_tokens_details?.cached_tokens != null
+              ? {
+                  promptTokensDetails: {
+                    cachedTokens:
+                      response.usage.prompt_tokens_details.cached_tokens,
+                  },
+                }
+              : {}),
+            ...(response.usage?.completion_tokens_details?.reasoning_tokens !=
+            null
+              ? {
+                  completionTokensDetails: {
+                    reasoningTokens:
+                      response.usage.completion_tokens_details.reasoning_tokens,
+                  },
+                }
+              : {}),
+            ...(response.usage?.cost_details?.upstream_inference_cost != null
+              ? {
+                  costDetails: {
+                    upstreamInferenceCost:
+                      response.usage.cost_details.upstream_inference_cost,
+                  },
+                }
+              : {}),
+          },
+        }),
+      },
       response: {
         headers: responseHeaders,
       },
@@ -278,9 +319,11 @@ export class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
     };
 
     const openrouterUsage: Partial<OpenRouterUsageAccounting> = {};
+    let provider: string | undefined;
 
     // Track raw usage from the API response for usage.raw
     let rawUsage: JSONObject | undefined;
+
     return {
       stream: response.pipeThrough(
         new TransformStream<
@@ -309,6 +352,10 @@ export class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
               return;
             }
 
+            if (value.provider) {
+              provider = value.provider;
+            }
+
             if (value.usage != null) {
               usage.inputTokens.total = value.usage.prompt_tokens;
               usage.outputTokens.total = value.usage.completion_tokens;
@@ -340,7 +387,9 @@ export class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
                 };
               }
 
-              openrouterUsage.cost = value.usage.cost;
+              if (value.usage.cost != null) {
+                openrouterUsage.cost = value.usage.cost;
+              }
               openrouterUsage.totalTokens = value.usage.total_tokens;
               const upstreamInferenceCost =
                 value.usage.cost_details?.upstream_inference_cost;
@@ -370,14 +419,24 @@ export class OpenRouterCompletionLanguageModel implements LanguageModelV3 {
             // Set raw usage before emitting finish event
             usage.raw = rawUsage;
 
+            const openrouterMetadata: {
+              usage: Partial<OpenRouterUsageAccounting>;
+              provider?: string;
+            } = {
+              usage: openrouterUsage,
+            };
+
+            // Only include provider if it's actually set
+            if (provider !== undefined) {
+              openrouterMetadata.provider = provider;
+            }
+
             controller.enqueue({
               type: 'finish',
               finishReason,
               usage,
               providerMetadata: {
-                openrouter: {
-                  usage: openrouterUsage,
-                },
+                openrouter: openrouterMetadata,
               },
             });
           },
diff --git a/src/completion/schemas.ts b/src/completion/schemas.ts
@@ -9,6 +9,7 @@ export const OpenRouterCompletionChunkSchema = z.union([
     .object({
       id: z.string().optional(),
       model: z.string().optional(),
+      provider: z.string().optional(),
       choices: z.array(
         z
           .object({
diff --git a/src/embedding/index.test.ts b/src/embedding/index.test.ts
diff --git a/src/embedding/index.ts b/src/embedding/index.ts
diff --git a/src/embedding/schemas.ts b/src/embedding/schemas.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@openrouter/ai-sdk-provider": patch
 +---
++
 +Fix undefined cost field in providerMetadata causing AI SDK validation failures
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ export const OpenRouterCompletionChunkSchema = z.union([`
`9`	`9`	`.object({`
`10`	`10`	`id: z.string().optional(),`
`11`	`11`	`model: z.string().optional(),`
	`12`	`+ provider: z.string().optional(),`
`12`	`13`	`choices: z.array(`
`13`	`14`	`z`
`14`	`15`	`.object({`