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

Deprecating Perseus Widgets #1046

Merged
merged 8 commits into from
Mar 5, 2024
Merged

Deprecating Perseus Widgets #1046

merged 8 commits into from
Mar 5, 2024

Conversation

SonicScrewdriver
Copy link
Contributor

@SonicScrewdriver SonicScrewdriver commented Feb 29, 2024

Summary:

Official deprecation and deletion of the Lights Puzzle, Simulator, Reaction Diagram, and Sequence widgets!

This PR deletes the aforementioned widgets and sets them each to be replaced by the Deprecated Stand-in Widget. We moved the logic around slightly for deprecating widgets as well, in order to make deprecating a widget an easier (and safer) process.

Issue: LEMS-1708 & LEMS-1799

Test plan:

automatic tests
manual tests in storybook to confirm that widgets are being replaced

@SonicScrewdriver SonicScrewdriver self-assigned this Feb 29, 2024
Copy link
Contributor

github-actions bot commented Feb 29, 2024

Size Change: -11.6 kB (-1%)

Total Size: 810 kB

Filename Size Change
packages/perseus-editor/dist/es/index.js 262 kB -3.62 kB (-1%)
packages/perseus/dist/es/index.js 386 kB -7.97 kB (-2%)
ℹ️ View Unchanged
Filename Size
packages/kas/dist/es/index.js 38.1 kB
packages/kmath/dist/es/index.js 4.27 kB
packages/math-input/dist/es/index.js 80.3 kB
packages/perseus-core/dist/es/index.js 908 B
packages/perseus-error/dist/es/index.js 878 B
packages/perseus-linter/dist/es/index.js 21.8 kB
packages/pure-markdown/dist/es/index.js 3.68 kB
packages/simple-markdown/dist/es/index.js 12.4 kB

compressed-size-action

Copy link

codecov bot commented Feb 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.68%. Comparing base (bacbb3a) to head (11bcdde).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1046      +/-   ##
==========================================
+ Coverage   64.72%   66.68%   +1.95%     
==========================================
  Files         438      434       -4     
  Lines       97947    96259    -1688     
  Branches     6539    10066    +3527     
==========================================
+ Hits        63393    64187     +794     
+ Misses      34554    32072    -2482     

Impacted file tree graph

Files Coverage Δ
packages/perseus-editor/src/all-editors.ts 100.00% <ø> (ø)
packages/perseus-editor/src/index.ts 100.00% <100.00%> (ø)
...il/register-all-widgets-and-editors-for-testing.ts 100.00% <100.00%> (ø)
packages/perseus/src/extra-widgets.ts 100.00% <ø> (ø)
packages/perseus/src/init.ts 60.71% <100.00%> (ø)
...rseus/src/util/register-all-widgets-for-testing.ts 100.00% <100.00%> (ø)
packages/perseus/src/widgets.ts 87.52% <100.00%> (+4.90%) ⬆️

... and 108 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 bacbb3a...11bcdde. Read the comment docs.

@SonicScrewdriver SonicScrewdriver marked this pull request as ready for review March 1, 2024 20:13
@khan-actions-bot khan-actions-bot requested a review from a team March 1, 2024 20:13
@khan-actions-bot
Copy link
Contributor

khan-actions-bot commented Mar 1, 2024

Gerald

Required Reviewers
  • @Khan/perseus for changes to .changeset/perfect-starfishes-judge.md, packages/perseus/src/extra-widgets.ts, packages/perseus/src/init.ts, packages/perseus/src/perseus-types.ts, packages/perseus/src/widgets.ts, packages/perseus-editor/src/all-editors.ts, packages/perseus-editor/src/index.ts, packages/perseus/src/__tests__/widgets.test.ts, packages/perseus/src/styles/perseus-renderer.less, packages/perseus/src/util/register-all-widgets-for-testing.ts, packages/perseus-editor/src/util/register-all-widgets-and-editors-for-testing.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 Mar 1, 2024

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1046

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

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

Copy link
Collaborator

@jeremywiebe jeremywiebe left a comment

Choose a reason for hiding this comment

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

Very cool to see us using the replaceWidget and replaceEditor to remove more deprecated widgets!!

@@ -0,0 +1,6 @@
---
"@khanacademy/perseus": minor
"@khanacademy/perseus-editor": minor
Copy link
Contributor

Choose a reason for hiding this comment

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

Our version numbers don't mean much, but I would consider this very much a major change.

@SonicScrewdriver SonicScrewdriver merged commit 18a2862 into main Mar 5, 2024
13 checks passed
@SonicScrewdriver SonicScrewdriver deleted the turn-out-the-lights branch March 5, 2024 22:04
SonicScrewdriver added a commit that referenced this pull request Mar 5, 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@20.0.0

### Major Changes

- [#1046](#1046)
[`18a2862a`](18a2862)
Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! -
Deprecation of Lights-Puzzle, Simulator, Reaction Diagram, and Sequence
Widgets.

## @khanacademy/perseus-editor@5.0.0

### Major Changes

- [#1046](#1046)
[`18a2862a`](18a2862)
Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! -
Deprecation of Lights-Puzzle, Simulator, Reaction Diagram, and Sequence
Widgets.

### Patch Changes

- Updated dependencies
\[[`18a2862a`](18a2862)]:
    -   @khanacademy/perseus@20.0.0
nishasy pushed a commit that referenced this pull request Mar 7, 2024
## Summary:
Official deprecation and deletion of the Lights Puzzle, Simulator, Reaction Diagram, and Sequence widgets! 

This PR deletes the aforementioned widgets and sets them each to be replaced by the Deprecated Stand-in Widget. We moved the logic around slightly for deprecating widgets as well, in order to make deprecating a widget an easier (and safer) process. 

Issue: LEMS-1708 & LEMS-1799

## Test plan:
automatic tests 
manual tests in storybook to confirm that widgets are being replaced

Author: SonicScrewdriver

Reviewers: jeremywiebe, handeyeco, nixterrimus, Myranae

Required Reviewers:

Approved By: jeremywiebe

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

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

Successfully merging this pull request may close these issues.

4 participants