-
Notifications
You must be signed in to change notification settings - Fork 1.3k
fix(usage): dedup provider-wide notes and add report-level notes field #3312
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
Open
oldschoola
wants to merge
5
commits into
can1357:main
Choose a base branch
from
oldschoola:fix/usage-provider-notes-dedup-3268-clean
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6c3f35d
fix(usage): dedup provider-wide notes and add report-level notes field
oldschoola 76bbd77
fix(usage): sanitize report-level notes before TUI rendering
oldschoola 12511ca
fix(usage): sanitize provider notes in usage-report and usage-cli
oldschoola 04c3199
fix(usage): normalize newlines in provider notes before rendering
oldschoola cbbdfda
fix: normalize tabs in usage notes rendering
oldschoola 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /** | ||
| * Regression for #3268: provider-level `notes` on `UsageReport` must survive | ||
| * the broker wire schema. The broker client validates `/v1/usage` responses | ||
| * against `usageResponseSchema`, which uses `"+": "reject"` — unknown fields | ||
| * at the envelope level are rejected, not silently stripped. Both the | ||
| * `usage.ts` schema and the `auth-broker/wire-schemas.ts` copy must declare | ||
| * `notes?: string[]` at the report level, or the field is lost on | ||
| * deserialization. `usageReportSchema` (the non-broker copy) must also accept | ||
| * the field so local `AuthStorage.fetchUsageReports` results type-check. | ||
| */ | ||
|
|
||
| import { describe, expect, it } from "bun:test"; | ||
| import { usageReportSchema } from "@oh-my-pi/pi-ai"; | ||
| import { usageResponseSchema } from "@oh-my-pi/pi-ai/auth-broker/wire-schemas"; | ||
| import { type } from "arktype"; | ||
|
|
||
| const DISCLAIMER = "OMP-observed spend only; OpenCode usage outside OMP is not included."; | ||
|
|
||
| function reportWithNotes() { | ||
| return { | ||
| provider: "opencode-go", | ||
| fetchedAt: Date.now(), | ||
| limits: [ | ||
| { | ||
| id: "rolling-5h", | ||
| label: "5 Hour limit", | ||
| scope: { provider: "opencode-go", windowId: "rolling-5h" }, | ||
| window: { id: "rolling-5h", label: "5 Hour", durationMs: 5 * 3_600_000 }, | ||
| amount: { used: 3, limit: 12, remaining: 9, usedFraction: 0.25, remainingFraction: 0.75, unit: "usd" }, | ||
| status: "ok", | ||
| }, | ||
| ], | ||
| notes: [DISCLAIMER], | ||
| metadata: { planType: "OpenCode Go" }, | ||
| }; | ||
| } | ||
|
|
||
| describe("usage report notes wire schema", () => { | ||
| it("usageReportSchema accepts report-level notes and preserves them", () => { | ||
| const validated = usageReportSchema(reportWithNotes()); | ||
| expect(validated).not.toBeInstanceOf(type.errors); | ||
| expect(validated).toHaveProperty("notes", [DISCLAIMER]); | ||
| }); | ||
|
|
||
| it("usageResponseSchema preserves report-level notes through the broker reject gate", () => { | ||
| const response = { | ||
| generatedAt: Date.now(), | ||
| reports: [reportWithNotes()], | ||
| }; | ||
| const validated = usageResponseSchema(response); | ||
| expect(validated).not.toBeInstanceOf(type.errors); | ||
| expect(validated).toHaveProperty("reports"); | ||
| if (validated instanceof type.errors) throw new Error("expected valid response"); | ||
| const reports = validated.reports; | ||
| expect(reports[0]).toHaveProperty("notes", [DISCLAIMER]); | ||
| }); | ||
| }); |
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.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should-fix: This is the only changed path that deduplicates per-limit notes across the TUI aggregate groups, but the added test coverage is in
formatUsageBreakdown()and explicitly expects two occurrences for the same note. A regression here would still pass. Please add coverage through/usage/handleUsageCommand(or another exported TUI path) asserting oneOverage requests: 5when two reports share the same provider/window group.