Skip to content

fix(elements): clamp context usage percentage to valid range #461

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.

Sign up for GitHub

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
ephraimduncan wants to merge 1 commit into
base: main
Choose a base branch
from
+57 −5
Open

fix(elements): clamp context usage percentage to valid range #461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions packages/elements/__tests__/context.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,48 @@ describe("context", () => {
expect(screen.getByText("50%")).toBeInTheDocument();
});

it.each([
{ maxTokens: 0, usedTokens: 0 },
{ maxTokens: 0, usedTokens: 50 },
{ maxTokens: 100, usedTokens: -1 },
])(
"clamps to 0% for usedTokens=$usedTokens maxTokens=$maxTokens",
({ maxTokens, usedTokens }) => {
const { container } = render(
<Context maxTokens={maxTokens} usedTokens={usedTokens}>
<ContextTrigger />
</Context>
);
expect(screen.getByText("0%")).toBeInTheDocument();
const ring = container.querySelector("circle[stroke-dashoffset]");
// Empty ring: offset equals the full circumference (2π × r=10 ≈ 62.83)
expect(Number(ring?.getAttribute("stroke-dashoffset"))).toBeCloseTo(
62.83,
1
);
}
);

it("clamps over-budget usage to a full 100% indicator", () => {
const { container } = render(
<Context defaultOpen maxTokens={100} usedTokens={150}>
<ContextTrigger />
<ContextContent>
<ContextContentHeader />
</ContextContent>
</Context>
);
expect(screen.getAllByText("100%").length).toBeGreaterThan(0);
const ring = container.querySelector("circle[stroke-dashoffset]");
// Full ring: zero offset
expect(Number(ring?.getAttribute("stroke-dashoffset"))).toBeCloseTo(0);
const bar = document.querySelector<HTMLElement>(
'[data-slot="progress-indicator"]'
);
// Full bar: no leftward translation (150% used to yield translateX(50%))
expect(bar?.style.transform).toBe("translateX(0%)");
});

it("throws error when components used outside Context provider", () => {
// Suppress console.error for this test
const spy = vi.spyOn(console, "error").mockImplementation(vi.fn());
Expand Down
20 changes: 15 additions & 5 deletions packages/elements/src/context.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
"use client";

import type { LanguageModelUsage } from "ai";
import type { ComponentProps } from "react";

import { Button } from "@repo/shadcn-ui/components/ui/button";
import {
HoverCard,
Expand All @@ -8,8 +11,6 @@ import {
} from "@repo/shadcn-ui/components/ui/hover-card";
import { Progress } from "@repo/shadcn-ui/components/ui/progress";
import { cn } from "@repo/shadcn-ui/lib/utils";
import type { LanguageModelUsage } from "ai";
import type { ComponentProps } from "react";
import { createContext, useContext, useMemo } from "react";
import { getUsage } from "tokenlens";

Expand All @@ -19,6 +20,15 @@ const ICON_VIEWBOX = 24;
const ICON_CENTER = 12;
const ICON_STROKE_WIDTH = 2;

const clampUsedPercent = (usedTokens: number, maxTokens: number) => {
if (
!(Number.isFinite(usedTokens) && Number.isFinite(maxTokens)) ||
maxTokens <= 0
) {
return 0;
}
return Math.min(Math.max(usedTokens / maxTokens, 0), 1);
};
type ModelId = string;

interface ContextSchema {
Expand Down Expand Up @@ -64,7 +74,7 @@ export const Context = ({
const ContextIcon = () => {
const { usedTokens, maxTokens } = useContextValue();
const circumference = 2 * Math.PI * ICON_RADIUS;
const usedPercent = usedTokens / maxTokens;
const usedPercent = clampUsedPercent(usedTokens, maxTokens);
const dashOffset = circumference * (1 - usedPercent);

return (
Expand Down Expand Up @@ -106,7 +116,7 @@ export type ContextTriggerProps = ComponentProps<typeof Button>;

export const ContextTrigger = ({ children, ...props }: ContextTriggerProps) => {
const { usedTokens, maxTokens } = useContextValue();
const usedPercent = usedTokens / maxTokens;
const usedPercent = clampUsedPercent(usedTokens, maxTokens);
const renderedPercent = new Intl.NumberFormat("en-US", {
maximumFractionDigits: 1,
style: "percent",
Expand Down Expand Up @@ -146,7 +156,7 @@ export const ContextContentHeader = ({
...props
}: ContextContentHeaderProps) => {
const { usedTokens, maxTokens } = useContextValue();
const usedPercent = usedTokens / maxTokens;
const usedPercent = clampUsedPercent(usedTokens, maxTokens);
const displayPct = new Intl.NumberFormat("en-US", {
maximumFractionDigits: 1,
style: "percent",
Expand Down