docs(changeset): Removing Interactive Graph Builder and refactoring tests/storybook to use more standardized generator patterns. by SonicScrewdriver · Pull Request #3415 · Khan/perseus

SonicScrewdriver · 2026-03-25T19:59:38Z

Summary:

Remove the old Interactive Graph Builder and refactor our tests to use the same generator patterns as the rest of Perseus.

Issue: LEMS-4008

Test plan:

Tests Pass

claude

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review.

_{Tip: disable this comment in your organization's Code Review settings.}

github-actions · 2026-03-25T20:00:26Z

🗄️ Schema Change: No Changes ✅

github-actions · 2026-03-25T20:00:54Z

Size Change: +208 B (+0.04%)

Total Size: 498 kB

📦 View Changed

Filename	Size	Change
`packages/perseus-core/dist/es/index.js`	25.4 kB	+208 B (+0.83%)

ℹ️ View Unchanged

Filename	Size
`packages/kas/dist/es/index.js`	20.5 kB
`packages/keypad-context/dist/es/index.js`	1 kB
`packages/kmath/dist/es/index.js`	6.36 kB
`packages/math-input/dist/es/index.js`	98.5 kB
`packages/math-input/dist/es/strings.js`	1.61 kB
`packages/perseus-core/dist/es/index.item-splitting.js`	12 kB
`packages/perseus-editor/dist/es/index.js`	102 kB
`packages/perseus-linter/dist/es/index.js`	9.3 kB
`packages/perseus-score/dist/es/index.js`	9.7 kB
`packages/perseus-utils/dist/es/index.js`	403 B
`packages/perseus/dist/es/index.js`	194 kB
`packages/perseus/dist/es/strings.js`	8.27 kB
`packages/pure-markdown/dist/es/index.js`	1.39 kB
`packages/simple-markdown/dist/es/index.js`	6.71 kB

_{compressed-size-action}

github-actions · 2026-03-25T20:00:57Z

🛠️ Item Splitting: No Changes ✅

github-actions · 2026-03-25T20:01:48Z

npm Snapshot: Published

Good news!! We've packaged up the latest commit from this PR (4923c64) and published it to npm. You
can install it using the tag PR3415.

Example:

pnpm add @khanacademy/perseus@PR3415

If you are working in Khan Academy's frontend, you can run the below command.

./dev/tools/bump_perseus_version.ts -t PR3415

If you are working in Khan Academy's webapp, you can run the below command.

./dev/tools/bump_perseus_version.js -t PR3415

SonicScrewdriver · 2026-03-25T22:33:54Z

packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.test.ts

    });
 });
+
+describe("generateIGExponentialGraph", () => {


Decided to round out the tests for the new graphs while I was in here.

SonicScrewdriver · 2026-03-25T22:35:00Z

packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts


 export function generateIGAngleGraph(
-    options?: Partial<PerseusGraphTypeAngle>,
+    options?: Partial<Omit<PerseusGraphTypeAngle, "type">>,


This is just some additional type safety that brings these generators inline with the implementation of the rest of the IG generators.

SonicScrewdriver · 2026-03-25T22:53:43Z

.eslintrc.js

                "*.cypress.ts",
                "*.test.ts",
                "*.test.tsx",
+                "*.testdata.ts",


It made sense to me to add a global override for our test data as it seems reasonable for these files to be exempt, but I'm also happy to remove this and re-add the file-specific override for interactive-graph.testdata.ts.

packages/perseus-editor/src/__testdata__/interactive-graph.testdata.ts

...ges/perseus/src/widgets/interactive-graphs/__docs__/interactive-graph-regression.stories.tsx

packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts

packages/perseus/src/widgets/interactive-graphs/interactive-graph.testdata.ts

...ges/perseus/src/widgets/interactive-graphs/__docs__/interactive-graph-regression.stories.tsx

packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts

packages/perseus/src/widgets/interactive-graphs/interactive-graph.testdata.ts

packages/perseus-editor/src/__testdata__/interactive-graph.testdata.ts

claude · 2026-03-27T22:36:36Z

packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts

+
+export function generateInteractiveGraphQuestion(
+    options?: Partial<PerseusInteractiveGraphWidgetOptions> & {
+        content?: string;
+        isStatic?: boolean;
+    },
+): PerseusRenderer {
+    const {content, isStatic, ...widgetOptions} = options ?? {};
+
+    // The `graph` and `correct` fields share all fields except for
+    // the answers (coords, center, etc.) When only `correct` is provided,
+    // derive `graph` from it by stripping the answer-specific fields.
+    // This allows us to keep our test data more succinct.
+    if (widgetOptions.correct && !widgetOptions.graph) {
+        const {
+            coords: _,
+            coord: __,
+            center: ___,
+            radius: ____,
+            asymptote: _____,
+            match: ______,
+            ...graphConfig
+        } = widgetOptions.correct as Record<string, unknown>;


🟡 The developer architecture notes in logarithm.md (line 322) and tangent.md (line 187) still reference interactive-graph-question-builder.ts, which this PR deletes. Developers following these notes to implement a new graph type will hit a broken file reference; update both notes to point to the replacement module interactive-graph-widget-generator.ts.

Extended reasoning...

What the bug is and how it manifests

This PR deletes packages/perseus/src/widgets/interactive-graphs/interactive-graph-question-builder.ts and replaces it with packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts. However, two developer architecture notes — logarithm.md and tangent.md — were not updated alongside this deletion. Both notes contain explicit file-path references that are now dead.

packages/perseus/src/widgets/interactive-graphs/__docs__/notes/logarithm.md line 322 references ...interactive-graph-question-builder.ts — withLogarithm(), LogarithmGraphConfig

packages/perseus/src/widgets/interactive-graphs/__docs__/notes/tangent.md line 187 references ...interactive-graph-question-builder.ts — Builder

The specific code path that triggers it

These notes are static Markdown documentation files intended to guide developers implementing new graph types. They list the files and functions a developer needs to touch, with interactive-graph-question-builder.ts called out as containing the builder class. Since that file no longer exists in the repository after this PR, any developer following the guide will look for a file that is simply gone.

Why existing code doesn't prevent it

The deletion of the builder was a source-code change; there is no automated tooling that cross-checks prose documentation for file-path accuracy. The notes were written to describe the old architecture and were not updated in this refactor.

What the impact would be

A developer tasked with adding a new interactive graph type (e.g., logarithm or tangent) would consult these notes, encounter the dead reference, and either waste time searching for the file or be left confused about where the builder logic now lives. The correct file is packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts, which is where all the new generator functions (e.g., generateIGExponentialGraph, generateIGAbsoluteValueGraph) live.

How to fix it

In both logarithm.md:322 and tangent.md:187, replace the reference to interactive-graph-question-builder.ts with packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts and update the function/class names cited to match the new generator API (e.g., the generator functions instead of withLogarithm()/LogarithmGraphConfig/Builder).

Step-by-step proof

The PR diff shows interactive-graph-question-builder.ts deleted (entire file removed with --- a/.../interactive-graph-question-builder.ts diff header).

logarithm.md line 322 contains the literal string interactive-graph-question-builder.ts — withLogarithm(), LogarithmGraphConfig — a path that no longer resolves.

tangent.md line 187 contains the literal string interactive-graph-question-builder.ts — Builder — also a dead path.

The new replacement module interactive-graph-widget-generator.ts is added by this PR and exports graph generators such as generateIGTangentGraph, generateIGExponentialGraph, etc.

Neither doc file appears in the PR diff, confirming neither was updated.

ivyolamit · 2026-04-08T16:43:14Z

@SonicScrewdriver just reading the PR description, what do you think of adding an info in our notes as a tip? To ensure that this pattern will be followed moving forward.

🔗 https://github.com/Khan/perseus/blob/main/packages/perseus/src/widgets/interactive-graphs/__docs__/notes/new-graph-type.md#tips

…se similar generator patterns to the rest of Perseus.

…r and refactoring tests/storybook to use more standardized generator patterns.

claude

Previous feedback addressed — critical fixture bugs fixed, intentional display-graph-type changes acknowledged. LGTM.

Extended reasoning...

Overview

This PR removes the class (and its duplicate in the editor package) and replaces all call sites with the functional / generators already exported from @khanacademy/perseus-core. Changes touch test data files, Storybook stories, and test files across three packages; no production widget logic is modified.

Security risks

None. All changes are confined to test utilities, Storybook stories, and test data. No auth, crypto, or user-facing code paths are touched.

Level of scrutiny

This is a large but mechanical refactoring of test/story infrastructure. The main risk is behavioral divergence during migration (old builder had implicit defaults like SegmentGraphConfig as the fallback graph type), which is exactly what the prior review rounds surfaced and which the author has now addressed. The PR is appropriate for bot approval given: (1) the logic being changed is test-only, (2) all identified regressions were fixed, and (3) no new bugs were found.

Other factors

Prior inline comments flagged circle fixture missing center/radius defaults, several segmentWith* fixtures defaulting to a linear graph, segmentWithLockedFunction missing a correct field, and the match field leaking into graph for polygon questions. The current file state confirms all of these were remediated. The author explicitly resolved the display-story graph-type comments as intentional. One minor residual: logarithm.md and tangent.md still reference the deleted builder file path, but that is a documentation-only nit that does not affect runtime behaviour.

SonicScrewdriver self-assigned this Mar 25, 2026

SonicScrewdriver added the olc-5.0.c4fcb label Mar 25, 2026

claude bot reviewed Mar 25, 2026

View reviewed changes

SonicScrewdriver commented Mar 25, 2026

View reviewed changes

claude bot reviewed Mar 26, 2026

View reviewed changes

packages/perseus/src/widgets/interactive-graphs/interactive-graph.testdata.ts Show resolved Hide resolved

...ges/perseus/src/widgets/interactive-graphs/__docs__/interactive-graph-regression.stories.tsx Show resolved Hide resolved

claude bot reviewed Mar 26, 2026

View reviewed changes

packages/perseus-core/src/utils/generators/interactive-graph-widget-generator.ts Outdated Show resolved Hide resolved

SonicScrewdriver mentioned this pull request Mar 27, 2026

[Interactive Graph] Add logarithm graph type definitions and data schema #3420

Merged

8 tasks

claude bot reviewed Mar 27, 2026

View reviewed changes

packages/perseus/src/widgets/interactive-graphs/interactive-graph.testdata.ts Show resolved Hide resolved

claude bot reviewed Mar 27, 2026

View reviewed changes

packages/perseus/src/widgets/interactive-graphs/interactive-graph.testdata.ts Show resolved Hide resolved

claude bot reviewed Mar 27, 2026

View reviewed changes

SonicScrewdriver added 12 commits April 8, 2026 15:35

[maximum-overline] Remove Interactive Graph Builder and refactor to u…

05579e3

…se similar generator patterns to the rest of Perseus.

[maximum-overline] docs(changeset): Removing Interactive Graph Builde…

1c78483

…r and refactoring tests/storybook to use more standardized generator patterns.

[maximum-overline] I HAVE FINALLY FIXED MY LINTER. HUZZAH.

f57524d

[maximum-overline] review fixes

36d0cde

[maximum-overline] cleanup testdata

9587748

[maximum-overline] welp now I have a prettier issue.

e4db322

[maximum-overline] PR review

33b8350

[maximum-overline] Address PR feedback + cleanup comment

8bd3a88

[maximum-overline] fix match

ff121fc

[maximum-overline] match old builder gridstep/snapstep

6a5f6e8

[maximum-overline] claude

6362242

[maximum-overline] sure fine

3706ba0

SonicScrewdriver added 2 commits April 8, 2026 15:39

[maximum-overline] mention the generator (pr feedback)

78173e9

[maximum-overline] Remove angle again.

7f59b85

SonicScrewdriver force-pushed the maximum-overline branch from 040238b to 7f59b85 Compare April 8, 2026 22:59

SonicScrewdriver and others added 4 commits April 9, 2026 11:07

[maximum-overline] PR feedback

a05ade3

Merge branch 'main' into maximum-overline

1112edd

Add extra domains.

6a7c31b

Handle Jest extra domain.

0aa10dd

claude bot reviewed Apr 9, 2026

View reviewed changes

[maximum-overline] updating comment to unstick frozen job

4923c64

Conversation

SonicScrewdriver commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary:

Test plan:

Uh oh!

claude bot left a comment

Choose a reason for hiding this comment

Claude Code Review

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🗄️ Schema Change: No Changes ✅

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛠️ Item Splitting: No Changes ✅

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

npm Snapshot: Published

Uh oh!

SonicScrewdriver Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

SonicScrewdriver Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

SonicScrewdriver Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

claude bot Mar 27, 2026

Choose a reason for hiding this comment

What the bug is and how it manifests

The specific code path that triggers it

Why existing code doesn't prevent it

What the impact would be

How to fix it

Step-by-step proof

Uh oh!

ivyolamit commented Apr 8, 2026

Uh oh!

claude bot left a comment

Choose a reason for hiding this comment

Overview

Security risks

Level of scrutiny

Other factors

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

SonicScrewdriver commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading