-
Notifications
You must be signed in to change notification settings - Fork 4
feat: add usage tracking to errored jobs #216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| import type { TokenUsage } from "../types.ts"; | ||
|
|
||
| const TOKEN_USAGE_FIELDS = [ | ||
| "inputTokens", | ||
| "outputTokens", | ||
| "totalTokens", | ||
| "reasoningTokens", | ||
| "cachedInputTokens", | ||
| ] as const; | ||
|
|
||
| type AggregatedTokenUsageField = (typeof TOKEN_USAGE_FIELDS)[number]; | ||
|
|
||
| function isDefinedTokenUsageValue(value: number | undefined): value is number { | ||
| return typeof value === "number"; | ||
| } | ||
|
|
||
| export function aggregateTokenUsage(usages: TokenUsage[]): TokenUsage { | ||
| return TOKEN_USAGE_FIELDS.reduce<TokenUsage>((aggregate, field) => { | ||
| // Only aggregate values that were explicitly reported by the provider so | ||
| // omitted fields stay undefined instead of being coerced to 0. | ||
| const values = usages | ||
| .map(usage => usage[field as AggregatedTokenUsageField]) | ||
| .filter(isDefinedTokenUsageValue); | ||
|
|
||
| if (values.length > 0) { | ||
| // Sum this field independently and write it back only when at least one | ||
| // chunk included real data for it. | ||
| aggregate[field] = values.reduce((total, value) => total + value, 0); | ||
| } | ||
|
|
||
| return aggregate; | ||
| }, {}); | ||
| } | ||
|
|
||
| /** | ||
| * Reads token usage from a thrown error's plain `usage` property (AI SDK | ||
| * errors like `NoObjectGeneratedError`, or errors annotated by | ||
| * {@link rethrowWithTokenUsage}). Falls back to AI SDK v6's nested | ||
| * `inputTokenDetails`/`outputTokenDetails` for cache/reasoning counts. | ||
| */ | ||
| export function getErrorTokenUsage(error: unknown): TokenUsage | undefined { | ||
| if (typeof error !== "object" || error === null) { | ||
| return undefined; | ||
| } | ||
| const usage = (error as { usage?: unknown }).usage; | ||
| if (typeof usage !== "object" || usage === null) { | ||
| return undefined; | ||
| } | ||
|
|
||
| const source = usage as Record<string, unknown>; | ||
| const extracted: TokenUsage = {}; | ||
| for (const field of TOKEN_USAGE_FIELDS) { | ||
| const value = source[field]; | ||
| if (typeof value === "number") { | ||
| extracted[field] = value; | ||
| } | ||
| } | ||
|
|
||
| if (extracted.reasoningTokens === undefined) { | ||
| const reasoningTokens = (source.outputTokenDetails as { reasoningTokens?: unknown } | undefined)?.reasoningTokens; | ||
| if (typeof reasoningTokens === "number") { | ||
| extracted.reasoningTokens = reasoningTokens; | ||
| } | ||
| } | ||
| if (extracted.cachedInputTokens === undefined) { | ||
| const cacheReadTokens = (source.inputTokenDetails as { cacheReadTokens?: unknown } | undefined)?.cacheReadTokens; | ||
| if (typeof cacheReadTokens === "number") { | ||
| extracted.cachedInputTokens = cacheReadTokens; | ||
| } | ||
| } | ||
|
|
||
| return Object.keys(extracted).length > 0 ? extracted : undefined; | ||
| } | ||
|
|
||
| /** | ||
| * Rethrows `error` with the aggregate of `collectedUsage` plus the error's | ||
| * own usage attached as a plain enumerable `usage` property (mirrors the AI | ||
| * SDK's `NoObjectGeneratedError.usage` convention). Rethrows untouched when | ||
| * there is no usage to attach. | ||
| */ | ||
| export function rethrowWithTokenUsage(error: unknown, collectedUsage: TokenUsage[]): never { | ||
| const usages = [...collectedUsage]; | ||
| const errorUsage = getErrorTokenUsage(error); | ||
| if (errorUsage) { | ||
| usages.push(errorUsage); | ||
| } | ||
| if (usages.length > 0 && typeof error === "object" && error !== null) { | ||
| (error as { usage?: TokenUsage }).usage = aggregateTokenUsage(usages); | ||
| } | ||
| throw error; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.