Deprecate `metadata` in renderer, hint, and Group widget data schemas #2242

benchristel · 2025-02-13T23:56:55Z

We aren't using metadata. As near as I can tell, it was added in 2014 so content
creators could add "tags" to content, but I don't know why it was added or if it was
ever used.

We are seeing Perseus JSON parser errors in webapp because metadata is null in some
exercises. This PR fixes the errors by changing the type of metadata to any, marking
it deprecated, and removing references to it.

Issue: none

Test plan:

Install the build of Perseus from this PR
Visit https://www.khanacademy.dev/internal-courses/test-everything/test-everything-1/te-group/a/group-article
You should be able to view and edit the article without errors.

…up widget data schemas

…er, hint, and Group widget data schemas

github-actions · 2025-02-13T23:59:51Z

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR2242

If you are working in Khan Academy's webapp, you can run:

./dev/tools/bump_perseus_version.sh -t PR2242

github-actions · 2025-02-14T00:00:28Z

Size Change: -105 B (-0.01%)

Total Size: 1.47 MB

Filename	Size	Change
`packages/perseus-core/dist/es/index.js`	48 kB	-42 B (-0.09%)
`packages/perseus-editor/dist/es/index.js`	689 kB	-63 B (-0.01%)

ℹ️ View Unchanged

Filename	Size
`packages/kas/dist/es/index.js`	39 kB
`packages/keypad-context/dist/es/index.js`	760 B
`packages/kmath/dist/es/index.js`	86.9 kB
`packages/math-input/dist/es/index.js`	77.7 kB
`packages/math-input/dist/es/strings.js`	1.79 kB
`packages/perseus-linter/dist/es/index.js`	22.1 kB
`packages/perseus-score/dist/es/index.js`	115 kB
`packages/perseus/dist/es/index.js`	367 kB
`packages/perseus/dist/es/strings.js`	6.57 kB
`packages/pure-markdown/dist/es/index.js`	3.66 kB
`packages/simple-markdown/dist/es/index.js`	12.5 kB

_{compressed-size-action}

handeyeco

Nothing blocking on my end. Looks like a very promising change.

handeyeco · 2025-02-14T19:23:11Z

packages/perseus-editor/src/widgets/group-editor.tsx

-        return _.extend({}, this.editor.current?.serialize(), {
-            metadata: this.props.metadata,
-        });
+        return _.extend({}, this.editor.current?.serialize());


Could this be simplified?

Suggested change

return _.extend({}, this.editor.current?.serialize());

return this.editor.current?.serialize();

Yeah, I was being cautious by not messing with it. Given that it's making a copy and I don't trust the editors not to mutate objects, I'd prefer:

return {...this.editor.current?.serialize()};

handeyeco · 2025-02-14T19:23:59Z

packages/perseus/src/types.ts

+    /**
+     * @deprecated - metadata is no longer used by the Group widget
+     */


We're not able to just get rid of it?

That would be a breaking change — callers of ServerItemRenderer would get errors if they passed a GroupMetadataEditor (and webapp does).

Given the difficulties of release coordination with AX, I'd prefer to avoid breaking changes if at all possible.

handeyeco · 2025-02-14T19:24:24Z

packages/perseus-core/src/parse-perseus-json/perseus-parsers/hint.ts

+    // deprecated
+    metadata: any,


We can't just ignore it? It has to be parsed?

This is probably way too paranoid, but I want to avoid the situation where

we delete metadata from the schema and parser.

5 years from now, someone decides it would be cool if PerseusRenderer had a metadata field.

they get errors in production because legacy content already has metadata, and it's shaped totally differently from whatever new metadata format they came up with.

I guess the parser regression tests should stop them before they get to step 3, though?

handeyeco · 2025-02-14T19:26:15Z

.changeset/tall-llamas-crash.md

@@ -0,0 +1,7 @@
+---
+"@khanacademy/perseus": minor
+"@khanacademy/perseus-core": patch


Isn't this a breaking change in perseus-core? If someone had defined a PerseusRenderer with metadata and upgraded perseus-core they would get a TS error and would be required to change their code?

Yeah, I guess that's true!

I've deprecated metadata rather than removing it outright, and changed all of these version bumps to minor.

benchristel · 2025-02-18T18:29:23Z

I've confirmed that Group widgets can still be rendered and edited after this change.

…mpletely

@benchristel

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @khanacademy/perseus@54.1.0 ### Minor Changes - [#2242](#2242) [`e187c6b67`](e187c6b) Thanks [@benchristel](https://github.com/benchristel)! - Deprecate the `metadata` field in renderer, hint, and Group widget data schemas. - [#2156](#2156) [`cbd5a6528`](cbd5a65) Thanks [@Myranae](https://github.com/Myranae)! - Implement a widget export function to filter out rubric data from widget options for the Matcher widget ### Patch Changes - [#2215](#2215) [`62ed407b8`](62ed407) Thanks [@Myranae](https://github.com/Myranae)! - Update Sorter's public widget option function to use Math.random and shuffle - Updated dependencies \[[`bae77a63c`](bae77a6), [`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-linter@1.2.18 - @khanacademy/perseus-core@3.7.0 - @khanacademy/kas@0.4.16 - @khanacademy/keypad-context@1.0.19 - @khanacademy/kmath@0.3.5 - @khanacademy/math-input@22.2.6 - @khanacademy/perseus-score@2.2.2 - @khanacademy/pure-markdown@0.3.27 - @khanacademy/simple-markdown@0.13.20 ## @khanacademy/perseus-core@3.7.0 ### Minor Changes - [#2246](#2246) [`e63f83d0d`](e63f83d) Thanks [@benchristel](https://github.com/benchristel)! - Update `parseAndMigratePerseusItem` and `parseAndMigratePerseusArticle` to accept legacy data formats observed in production - [#2242](#2242) [`e187c6b67`](e187c6b) Thanks [@benchristel](https://github.com/benchristel)! - Deprecate the `metadata` field in renderer, hint, and Group widget data schemas. - [#2215](#2215) [`62ed407b8`](62ed407) Thanks [@Myranae](https://github.com/Myranae)! - Update Sorter's public widget option function to use Math.random and shuffle - [#2156](#2156) [`cbd5a6528`](cbd5a65) Thanks [@Myranae](https://github.com/Myranae)! - Implement a widget export function to filter out rubric data from widget options for the Matcher widget ## @khanacademy/perseus-editor@17.7.0 ### Minor Changes - [#2242](#2242) [`e187c6b67`](e187c6b) Thanks [@benchristel](https://github.com/benchristel)! - Deprecate the `metadata` field in renderer, hint, and Group widget data schemas. ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 - @khanacademy/perseus@54.1.0 - @khanacademy/kas@0.4.16 - @khanacademy/keypad-context@1.0.19 - @khanacademy/kmath@0.3.5 - @khanacademy/math-input@22.2.6 - @khanacademy/perseus-score@2.2.2 - @khanacademy/pure-markdown@0.3.27 ## @khanacademy/kas@0.4.16 ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 ## @khanacademy/keypad-context@1.0.19 ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 ## @khanacademy/kmath@0.3.5 ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 ## @khanacademy/math-input@22.2.6 ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 - @khanacademy/keypad-context@1.0.19 ## @khanacademy/perseus-linter@1.2.18 ### Patch Changes - [#2240](#2240) [`bae77a63c`](bae77a6) Thanks [@mark-fitzgerald](https://github.com/mark-fitzgerald)! - [Linter] Remove Math Font Size rule from editor linter - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 ## @khanacademy/perseus-score@2.2.2 ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 - @khanacademy/kas@0.4.16 - @khanacademy/kmath@0.3.5 ## @khanacademy/pure-markdown@0.3.27 ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 - @khanacademy/simple-markdown@0.13.20 ## @khanacademy/simple-markdown@0.13.20 ### Patch Changes - Updated dependencies \[[`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-core@3.7.0 ## @khanacademy/perseus-dev-ui@5.2.2 ### Patch Changes - Updated dependencies \[[`bae77a63c`](bae77a6), [`e63f83d0d`](e63f83d), [`e187c6b67`](e187c6b), [`62ed407b8`](62ed407), [`cbd5a6528`](cbd5a65)]: - @khanacademy/perseus-linter@1.2.18 - @khanacademy/perseus-core@3.7.0 - @khanacademy/kas@0.4.16 - @khanacademy/kmath@0.3.5 - @khanacademy/math-input@22.2.6 - @khanacademy/pure-markdown@0.3.27 - @khanacademy/simple-markdown@0.13.20

benchristel added 2 commits February 13, 2025 15:53

[benc/delete-metadata] Delete 'metadata' from renderer, hint, and Gro…

0d75a30

…up widget data schemas

[benc/delete-metadata] docs(changeset): Delete 'metadata' from render…

354000e

…er, hint, and Group widget data schemas

benchristel self-assigned this Feb 13, 2025

benchristel requested review from handeyeco and jeremywiebe February 13, 2025 23:56

handeyeco approved these changes Feb 14, 2025

View reviewed changes

[benc/delete-metadata] Deprecate 'metadata' instead of removing it co…

8162367

…mpletely

benchristel changed the title ~~Delete 'metadata' from renderer, hint, and Group widget data schemas~~ Deprecate metadata in renderer, hint, and Group widget data schemas Feb 18, 2025

benchristel merged commit e187c6b into main Feb 18, 2025
11 of 18 checks passed

benchristel deleted the benc/delete-metadata branch February 18, 2025 19:33

khan-actions-bot mentioned this pull request Feb 18, 2025

Version Packages #2247

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `metadata` in renderer, hint, and Group widget data schemas #2242

Deprecate `metadata` in renderer, hint, and Group widget data schemas #2242

benchristel commented Feb 13, 2025 •

edited

Loading

github-actions bot commented Feb 13, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

handeyeco left a comment

handeyeco Feb 14, 2025

benchristel Feb 14, 2025

handeyeco Feb 14, 2025

benchristel Feb 14, 2025 •

edited

Loading

handeyeco Feb 14, 2025

benchristel Feb 14, 2025

handeyeco Feb 14, 2025

benchristel Feb 14, 2025

benchristel Feb 18, 2025

benchristel commented Feb 18, 2025

	return _.extend({}, this.editor.current?.serialize());
	return this.editor.current?.serialize();

Deprecate metadata in renderer, hint, and Group widget data schemas #2242

Deprecate metadata in renderer, hint, and Group widget data schemas #2242

Conversation

benchristel commented Feb 13, 2025 • edited Loading

Test plan:

github-actions bot commented Feb 13, 2025 • edited Loading

npm Snapshot: Published

github-actions bot commented Feb 14, 2025 • edited Loading

handeyeco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benchristel Feb 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benchristel commented Feb 18, 2025

Deprecate `metadata` in renderer, hint, and Group widget data schemas #2242

Deprecate `metadata` in renderer, hint, and Group widget data schemas #2242

benchristel commented Feb 13, 2025 •

edited

Loading

github-actions bot commented Feb 13, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

benchristel Feb 14, 2025 •

edited

Loading