Skip to content

chore: measure impact of the Graph mixins on tree-shaking [poc]#639

Closed
tbouffard wants to merge 3 commits intomainfrom
chore/tree-shaking_experiments_mixins
Closed

chore: measure impact of the Graph mixins on tree-shaking [poc]#639
tbouffard wants to merge 3 commits intomainfrom
chore/tree-shaking_experiments_mixins

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Jan 17, 2025 •
edited
Loading

DISCLAIMER

  • this PR is for exploration and information only
  • it is not intended to be merged

Context

The Graph class is very large and it has been partially splitted into mixins, to organize the code per feature. However, at runtime, this is the same as having the whole code in the Graph class definition, so some unused elements are sometimes included in an application.
This increase the size of the application. We have a plugin mechanism, that could replace this in the future.

Prior providing ways to improve the tree-shaking in this situation, here are some figures about the impact of the mixins in 2 very simple applications included in this repository.

Disclaimer

The sole purpose of this PR is to measure the impact of removing mixins on the tree-shaking.
The TypeScript compilation pass here but some features are lost or may not work in the 2 examples used to measure the impact of the removals.

Results

Note: initial commit = few commits after tag v0.14.0

ts-example no default

  • start: 441.20 kB
  • only CellsMixin: 388.82 kB (not working, some methods about listeners are missing)
  • mixins required to make the example work: 430.35 kB
  • no mixin: 365.83 kB

js-example no default

  • start: 454.22 kB
  • only CellsMixin: 401.37 kB
  • mixins required to make the example work:443.29 kB
  • no mixin: 379.39 kB

@tbouffard tbouffard added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Jan 17, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jan 17, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@tbouffard
Copy link
Member Author

tbouffard commented Jan 17, 2025

POC completed, so closing

@tbouffard tbouffard closed this Jan 17, 2025
@tbouffard tbouffard deleted the chore/tree-shaking_experiments_mixins branch January 17, 2025 15:39
@tbouffard tbouffard mentioned this pull request Feb 8, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard