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

Split StatefulMafsGraph and MafsGraph into separate files #1397

Merged
merged 4 commits into from
Jul 9, 2024

Conversation

benchristel
Copy link
Member

Each of these components used different helper functions and types defined
alongside them. I've moved each component into a separate file along with its
associated functions and types. This makes the files more cohesive, so it's
easier to see which groups of entities go together.

Issue: none

Test plan:

yarn test

@khan-actions-bot
Copy link
Contributor

khan-actions-bot commented Jul 9, 2024

Gerald

Required Reviewers
  • @Khan/perseus for changes to .changeset/smooth-rice-speak.md, packages/perseus/src/widgets/interactive-graphs/index.ts, packages/perseus/src/widgets/interactive-graphs/mafs-graph.test.tsx, packages/perseus/src/widgets/interactive-graphs/mafs-graph.tsx, packages/perseus/src/widgets/interactive-graphs/stateful-mafs-graph.test.tsx, packages/perseus/src/widgets/interactive-graphs/stateful-mafs-graph.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 July 9, 2024 19:09
Copy link
Contributor

github-actions bot commented Jul 9, 2024

npm Snapshot: Published

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

Example:

yarn add @khanacademy/perseus@PR1397

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

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

Copy link
Contributor

github-actions bot commented Jul 9, 2024

Size Change: -133 B (-0.02%)

Total Size: 854 kB

Filename Size Change
packages/perseus/dist/es/index.js 414 kB -133 B (-0.03%)
ℹ️ 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.8 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 272 kB
packages/perseus-error/dist/es/index.js 866 B
packages/perseus-linter/dist/es/index.js 21.8 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 Jul 9, 2024

Codecov Report

Attention: Patch coverage is 98.11321% with 3 lines in your changes missing coverage. Please review.

Project coverage is 70.87%. Comparing base (f5711a3) to head (27ef937).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1397      +/-   ##
==========================================
+ Coverage   69.83%   70.87%   +1.04%     
==========================================
  Files         503      508       +5     
  Lines      105124   105212      +88     
  Branches     5339    11340    +6001     
==========================================
+ Hits        73414    74571    +1157     
+ Misses      31594    30641     -953     
+ Partials      116        0     -116     

Impacted file tree graph

Files Coverage Δ
...es/perseus/src/widgets/interactive-graphs/index.ts 100.00% <100.00%> (ø)
...seus/src/widgets/interactive-graphs/mafs-graph.tsx 99.41% <97.05%> (-0.25%) ⬇️
...widgets/interactive-graphs/stateful-mafs-graph.tsx 98.38% <98.38%> (ø)

... and 121 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 f5711a3...27ef937. Read the comment docs.

Copy link
Contributor

@handeyeco handeyeco left a comment

Choose a reason for hiding this comment

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

My understanding is this is just splitting up one file into two. If that's the case and there are no changes to logic, I think this makes a lot of sense.

@benchristel benchristel merged commit 3108f93 into main Jul 9, 2024
11 checks passed
@benchristel benchristel deleted the benc/split-mafs-graph branch July 9, 2024 23:09
benchristel pushed a commit that referenced this pull request Jul 15, 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/[email protected]

### Major Changes

-   [#1411](#1411) [`b0df85a80`](b0df85a) Thanks [@handeyeco](https://github.com/handeyeco)! - Consolidate PerseusError code and move it into perseus-core (deletes the perseus-error package)

### Patch Changes

-   [#1405](#1405) [`a430de4c1`](a430de4) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Fix console errors and warnings printed in tests


-   [#1398](#1398) [`fa19dbc97`](fa19dbc) Thanks [@benchristel](https://github.com/benchristel)! - Internal: move the getLines function to polygon.tsx


-   [#1399](#1399) [`147ab0442`](147ab04) Thanks [@benchristel](https://github.com/benchristel)! - Internal: refactor and test `segmentsIntersect` function


-   [#1394](#1394) [`8ae3d18f1`](8ae3d18) Thanks [@benchristel](https://github.com/benchristel)! - Internal: move angle functions to math/angle.ts


-   [#1391](#1391) [`f5711a331`](f5711a3) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Resolve TODO comments


-   [#1397](#1397) [`3108f933e`](3108f93) Thanks [@benchristel](https://github.com/benchristel)! - Internal: split `MafsGraph` and `StatefulMafsGraph` into separate files.


-   [#1393](#1393) [`e6424d5e7`](e6424d5) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Move and rename test files

-   Updated dependencies \[[`be7f14153`](be7f141), [`b0df85a80`](b0df85a), [`24a72177e`](24a7217)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Major Changes

-   [#1411](#1411) [`b0df85a80`](b0df85a) Thanks [@handeyeco](https://github.com/handeyeco)! - Consolidate PerseusError code and move it into perseus-core (deletes the perseus-error package)

### Patch Changes

-   [#1405](#1405) [`a430de4c1`](a430de4) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Fix console errors and warnings printed in tests

-   Updated dependencies \[[`a430de4c1`](a430de4), [`fa19dbc97`](fa19dbc), [`be7f14153`](be7f141), [`147ab0442`](147ab04), [`8ae3d18f1`](8ae3d18), [`b0df85a80`](b0df85a), [`f5711a331`](f5711a3), [`3108f933e`](3108f93), [`e6424d5e7`](e6424d5)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Major Changes

-   [#1406](#1406) [`24a72177e`](24a7217) Thanks [@handeyeco](https://github.com/handeyeco)! - No longer lint for profanity

### Patch Changes

-   [#1407](#1407) [`be7f14153`](be7f141) Thanks [@handeyeco](https://github.com/handeyeco)! - Updates to README files


-   [#1411](#1411) [`b0df85a80`](b0df85a) Thanks [@handeyeco](https://github.com/handeyeco)! - Consolidate PerseusError code and move it into perseus-core (deletes the perseus-error package)

-   Updated dependencies \[[`b0df85a80`](b0df85a)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Minor Changes

-   [#1411](#1411) [`b0df85a80`](b0df85a) Thanks [@handeyeco](https://github.com/handeyeco)! - Consolidate PerseusError code and move it into perseus-core (deletes the perseus-error package)

## @khanacademy/[email protected]

### Patch Changes

-   [#1407](#1407) [`be7f14153`](be7f141) Thanks [@handeyeco](https://github.com/handeyeco)! - Updates to README files

-   Updated dependencies \[[`b0df85a80`](b0df85a)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

-   [#1407](#1407) [`be7f14153`](be7f141) Thanks [@handeyeco](https://github.com/handeyeco)! - Updates to README files

-   Updated dependencies \[[`b0df85a80`](b0df85a)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

-   [#1407](#1407) [`be7f14153`](be7f141) Thanks [@handeyeco](https://github.com/handeyeco)! - Updates to README files

-   Updated dependencies \[[`b0df85a80`](b0df85a)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

-   [#1407](#1407) [`be7f14153`](be7f141) Thanks [@handeyeco](https://github.com/handeyeco)! - Updates to README files

-   Updated dependencies \[[`be7f14153`](be7f141), [`b0df85a80`](b0df85a)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

-   [#1407](#1407) [`be7f14153`](be7f141) Thanks [@handeyeco](https://github.com/handeyeco)! - Updates to README files

-   Updated dependencies \[[`b0df85a80`](b0df85a)]:
    -   @khanacademy/[email protected]

## @khanacademy/[email protected]

### Patch Changes

-   Updated dependencies \[[`be7f14153`](be7f141), [`b0df85a80`](b0df85a), [`24a72177e`](24a7217)]:
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]
    -   @khanacademy/[email protected]

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, ✅ Jest Coverage (ubuntu-latest, 20.x), ✅ Check builds for changes in size (ubuntu-latest, 20.x), ✅ Lint, Typecheck, Format, and Test (ubuntu-latest, 20.x), ✅ Check for .changeset entries for all changed files (ubuntu-latest, 20.x), ✅ Cypress (ubuntu-latest, 20.x), ✅ gerald

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

3 participants