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

Add PhET simulation content editor #1532

Merged
merged 16 commits into from
Aug 21, 2024

Conversation

aemandine
Copy link
Contributor

@aemandine aemandine commented Aug 20, 2024

Summary:

Create the content editor for PhET simulations, allowing users to set:

  • The URL of the simulation
  • A description of the simulation (used to communicate the widget's purpose to screen readers and Khanmigo)

I have documented the Perseus widget creation process here.

Issue: LEMS-2168

Editor page storybook page, displaying PhET widget, which contains an iframe displaying the Projectile Data Lab PhET simulation. The URL of the widget is the URL for Projectile Data Lab, and the description is 'Projectile Data Lab.' Editor page storybook page, displaying PhET widget, which contains an iframe saying 'Sorry, this simulation cannot load.' The URL of the widget is the Google homepage URL, and the description is 'Google.'

Test plan:

  • Verify that the widget content editor shows up appropriately in Storybook's EditorPage (/docs/perseuseditor-editorpage--docs)
  • yarn jest packages/perseus-editor/src/widgets/__tests__/phet-sim-editor.test.tsx

@khan-actions-bot
Copy link
Contributor

khan-actions-bot commented Aug 20, 2024

Gerald

Required Reviewers
  • @Khan/perseus for changes to .changeset/three-ligers-think.md, packages/perseus/src/index.ts, packages/perseus/src/perseus-types.ts, packages/perseus-editor/src/widgets/phet-sim-editor.tsx, packages/perseus/src/widgets/__testdata__/phet-sim.testdata.ts, packages/perseus-editor/src/widgets/__tests__/phet-sim-editor.test.tsx

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

@khan-actions-bot khan-actions-bot requested a review from a team August 20, 2024 21:56
Copy link
Contributor

github-actions bot commented Aug 20, 2024

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1532

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

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

Copy link
Contributor

github-actions bot commented Aug 20, 2024

Size Change: +26 B (0%)

Total Size: 877 kB

Filename Size Change
packages/perseus-editor/dist/es/index.js 277 kB +26 B (+0.01%)
ℹ️ View Unchanged
Filename Size
packages/kas/dist/es/index.js 38.3 kB
packages/keypad-context/dist/es/index.js 760 B
packages/kmath/dist/es/index.js 4.27 kB
packages/math-input/dist/es/index.js 77.7 kB
packages/math-input/dist/es/strings.js 1.79 kB
packages/perseus-core/dist/es/index.js 1.48 kB
packages/perseus-linter/dist/es/index.js 21.8 kB
packages/perseus/dist/es/index.js 434 kB
packages/perseus/dist/es/strings.js 3.34 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 Aug 20, 2024

Codecov Report

Attention: Patch coverage is 85.71429% with 5 lines in your changes missing coverage. Please review.

Please upload report for BASE (phet-widget@ea2a1d9). Learn more about missing BASE report.

Files Patch % Lines
...ges/perseus-editor/src/widgets/phet-sim-editor.tsx 85.29% 5 Missing ⚠️
Additional details and impacted files
@@              Coverage Diff               @@
##             phet-widget    #1532   +/-   ##
==============================================
  Coverage               ?   70.44%           
==============================================
  Files                  ?      520           
  Lines                  ?   106618           
  Branches               ?    10923           
==============================================
  Hits                   ?    75102           
  Misses                 ?    31516           
  Partials               ?        0           

Impacted file tree graph

Files Coverage Δ
packages/perseus/src/index.ts 100.00% <100.00%> (ø)
...ges/perseus-editor/src/widgets/phet-sim-editor.tsx 91.07% <85.29%> (ø)

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 ea2a1d9...e882b93. Read the comment docs.

@aemandine aemandine requested review from SonicScrewdriver, Myranae and a team August 21, 2024 00:08
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.

This looks great! Before we deploy this we have to make sure that the publish pipeline is updated though. 😄

I'll leave this unapproved just so Third and/or Tamara have a chance to look at it.

packages/perseus-editor/src/widgets/phet-sim-editor.tsx Outdated Show resolved Hide resolved
packages/perseus-editor/src/widgets/phet-sim-editor.tsx Outdated Show resolved Hide resolved
packages/perseus/src/widgets/phet-sim.tsx Outdated Show resolved Hide resolved
@khan-actions-bot khan-actions-bot requested a review from a team August 21, 2024 00:43
Copy link
Contributor

@SonicScrewdriver SonicScrewdriver left a comment

Choose a reason for hiding this comment

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

We've been peer reviewing this during our Mentorship pairing sessions! Great job, let's get this moving! :)

@aemandine aemandine merged commit 6e102f9 into phet-widget Aug 21, 2024
11 checks passed
@aemandine aemandine deleted the am/lems-2168/phet-content-editor branch August 21, 2024 23:49
aemandine added a commit that referenced this pull request Aug 22, 2024
## Summary:
Releases the PhET Simulation widget.

The [PhET Interactive Simulations](https://phet.colorado.edu/) initiative, run by the University of Colorado Boulder, develops interactive simulations for math and science education that are available for free. These simulations, known as PhET sims, are designed based on comprehensive educational research. They provide a game-like, intuitive platform that encourages students to learn by exploring and discovering concepts on their own.  

## Commit history:
This feature branch PR includes the following review branch PRs:
- Create PhET simulation widget (#1512)
- Add PhET simulation content editor (#1532)
- Design updates (#1542)

Issue: LEMS-XXXX

## Test plan:
Confirm all tests pass.

Author: SonicScrewdriver

Reviewers: Myranae, aemandine

Required Reviewers: 

Approved By: Myranae

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

Pull Request URL: #1546
aemandine pushed a commit that referenced this pull request Aug 22, 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@31.0.0

### Major Changes

-   [#1546](#1546) [`6cbe4947e`](6cbe494) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Release PhET widget

    This PR releases a new PhET simulation widget to Perseus that requires an
    update in order to allow the support of new, upcoming content. Older versions
    of Perseus will be unable to render content that contains this widget.

    PhET simulations come from <https://phet.colorado.edu/>.

### Minor Changes

-   [#1529](#1529) [`0bf2711c0`](0bf2711) Thanks [@nicolecomputer](https://github.com/nicolecomputer)! - Adds unlimited point graph


-   [#1542](#1542) [`a7fc2a3e3`](a7fc2a3) Thanks [@aemandine](https://github.com/aemandine)! - Design update for PhET widget


-   [#1512](#1512) [`4f24be79d`](4f24be7) Thanks [@aemandine](https://github.com/aemandine)! - Add PhET widget


-   [#1532](#1532) [`6e102f9c4`](6e102f9) Thanks [@aemandine](https://github.com/aemandine)! - Add a content editor for the PhET widget


-   [#1533](#1533) [`cc1995daf`](cc1995d) Thanks [@nishasy](https://github.com/nishasy)! - [Locked labels] View locked labels in an Interactive Graph

### Patch Changes

-   [#1539](#1539) [`7805626e1`](7805626) Thanks [@nishasy](https://github.com/nishasy)! - [Locked Labels] Implement adding/editing/deleting a standalone locked label


-   [#1541](#1541) [`36471197c`](3647119) Thanks [@nicolecomputer](https://github.com/nicolecomputer)! - Adds a finite point question to dev gallery

## @khanacademy/perseus-editor@13.0.0

### Major Changes

-   [#1546](#1546) [`6cbe4947e`](6cbe494) Thanks [@SonicScrewdriver](https://github.com/SonicScrewdriver)! - Release PhET widget

    This PR releases a new PhET simulation widget to Perseus that requires an
    update in order to allow the support of new, upcoming content. Older versions
    of Perseus will be unable to render content that contains this widget.

    PhET simulations come from <https://phet.colorado.edu/>.

### Minor Changes

-   [#1539](#1539) [`7805626e1`](7805626) Thanks [@nishasy](https://github.com/nishasy)! - [Locked Labels] Implement adding/editing/deleting a standalone locked label


-   [#1542](#1542) [`a7fc2a3e3`](a7fc2a3) Thanks [@aemandine](https://github.com/aemandine)! - Design update for PhET widget


-   [#1532](#1532) [`6e102f9c4`](6e102f9) Thanks [@aemandine](https://github.com/aemandine)! - Add a content editor for the PhET widget


-   [#1533](#1533) [`cc1995daf`](cc1995d) Thanks [@nishasy](https://github.com/nishasy)! - [Locked labels] View locked labels in an Interactive Graph

### Patch Changes

-   Updated dependencies \[[`7805626e1`](7805626), [`0bf2711c0`](0bf2711), [`a7fc2a3e3`](a7fc2a3), [`4f24be79d`](4f24be7), [`6cbe4947e`](6cbe494), [`36471197c`](3647119), [`6e102f9c4`](6e102f9), [`cc1995daf`](cc1995d)]:
    -   @khanacademy/perseus@31.0.0

## @khanacademy/perseus-dev-ui@3.0.2

### Patch Changes

-   [#1541](#1541) [`36471197c`](3647119) Thanks [@nicolecomputer](https://github.com/nicolecomputer)! - Adds a finite point question to dev gallery

Author: khan-actions-bot

Reviewers: aemandine, #perseus

Required Reviewers:

Approved By: aemandine

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

Pull Request URL: #1544
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