Skip to content
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

[🔥AUDIT🔥] Add TODO comment #1358

Merged
merged 2 commits into from
Jun 27, 2024
Merged

[🔥AUDIT🔥] Add TODO comment #1358

merged 2 commits into from
Jun 27, 2024

Conversation

benchristel
Copy link
Member

@benchristel benchristel commented Jun 18, 2024

🖍 This is an audit! 🖍

The skipMathJax parameter to Perseus.init() controls whether MathJax 2 gets configured
during the init call. This is gross because Perseus doesn't even import MathJax 2: it
depends on a global MathJax variable existing whenever skipMathJax is not passed.

skipMathJax is almost always being passed in webapp, except in a couple cases in the
exercise editor where we need to use the legacy KaTeX+MathJax2 math renderer. The
story referenced in the TODO comment is about removing that legacy renderer from webapp
once all mobile app versions that use it have been deprecated. Once MathJax 2 is gone for
good, we should be able to remove skipMathJax and the code it controls from Perseus.

Issue: none

Test plan:

All CI checks should pass.

@benchristel benchristel self-assigned this Jun 18, 2024
@khan-actions-bot khan-actions-bot requested a review from a team June 18, 2024 15:54
@khan-actions-bot
Copy link
Contributor

khan-actions-bot commented Jun 18, 2024

Gerald

Required Reviewers
  • @Khan/perseus for changes to .changeset/lazy-readers-live.md, packages/perseus/src/init.ts

Don't want to be involved in this pull request? Comment #removeme and we won't notify you of further changes.

Copy link
Contributor

github-actions bot commented Jun 18, 2024

Size Change: 0 B

Total Size: 845 kB

ℹ️ View Unchanged
Filename Size
packages/kas/dist/es/index.js 38.2 kB
packages/kmath/dist/es/index.js 4.26 kB
packages/math-input/dist/es/index.js 80.1 kB
packages/math-input/dist/es/strings.js 1.73 kB
packages/perseus-core/dist/es/index.js 906 B
packages/perseus-editor/dist/es/index.js 271 kB
packages/perseus-error/dist/es/index.js 866 B
packages/perseus-linter/dist/es/index.js 21.8 kB
packages/perseus/dist/es/index.js 407 kB
packages/perseus/dist/es/strings.js 3.21 kB
packages/pure-markdown/dist/es/index.js 3.67 kB
packages/simple-markdown/dist/es/index.js 12.4 kB

compressed-size-action

Copy link

codecov bot commented Jun 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.70%. Comparing base (92990f1) to head (65afe1a).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1358      +/-   ##
==========================================
+ Coverage   69.42%   70.70%   +1.28%     
==========================================
  Files         488      493       +5     
  Lines      103287   103448     +161     
  Branches     5211    10510    +5299     
==========================================
+ Hits        71702    73147    +1445     
+ Misses      31469    30301    -1168     
+ Partials      116        0     -116     

Impacted file tree graph

Files Coverage Δ
packages/perseus/src/init.ts 62.06% <100.00%> (+1.35%) ⬆️

... and 141 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 92990f1...65afe1a. Read the comment docs.

Copy link
Contributor

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1358

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

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

Copy link
Contributor

@Myranae Myranae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this!

@benchristel benchristel merged commit 93eeda1 into main Jun 27, 2024
13 checks passed
@benchristel benchristel deleted the benc/add-todo branch June 27, 2024 18:45
benchristel pushed a commit that referenced this pull request Jul 1, 2024
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@24.1.0

### Minor Changes

-   [#1376](#1376) [`3ee100add`](3ee100a) Thanks [@benchristel](https://github.com/benchristel)! - Implement the protractor for Mafs interactive graphs


-   [#1381](#1381) [`26dceb8d7`](26dceb8) Thanks [@benchristel](https://github.com/benchristel)! - Make the `mafs.point` flag control whether point graphs with fixed numbers of points should use Mafs. Previously, turning on the `mafs.point` flag would enable Mafs for point graphs with unlimited points as well.

### Patch Changes

-   [#1358](#1358) [`93eeda1e2`](93eeda1) Thanks [@benchristel](https://github.com/benchristel)! - Add TODO comment


-   [#1379](#1379) [`685fa9048`](685fa90) Thanks [@nishasy](https://github.com/nishasy)! - [Interactive Graph Editor] Moving around/renaming components so they make more sense for the upcoming hint mode work


-   [#1370](#1370) [`48e879ace`](48e879a) Thanks [@benchristel](https://github.com/benchristel)! - Internal: copy Mafs' implementation of useMovable into our own useDraggable hook.

## @khanacademy/perseus-editor@7.0.1

### Patch Changes

-   [#1375](#1375) [`a8b3aa9c0`](a8b3aa9) Thanks [@nishasy](https://github.com/nishasy)! - [Interactive Graph Editor] Fix the broken storybook preview for segments, points, and polygons


-   [#1379](#1379) [`685fa9048`](685fa90) Thanks [@nishasy](https://github.com/nishasy)! - [Interactive Graph Editor] Moving around/renaming components so they make more sense for the upcoming hint mode work

-   Updated dependencies \[[`3ee100add`](3ee100a), [`93eeda1e2`](93eeda1), [`685fa9048`](685fa90), [`48e879ace`](48e879a), [`26dceb8d7`](26dceb8)]:
    -   @khanacademy/perseus@24.1.0

Author: khan-actions-bot

Reviewers: benchristel

Required Reviewers:

Approved By: benchristel

Checks: ✅ codecov/project, ✅ codecov/patch, ✅ Upload Coverage (ubuntu-latest, 20.x), ⏭️  Publish npm snapshot, ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ Jest Coverage (ubuntu-latest, 20.x), ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ gerald

Pull Request URL: #1377
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants