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

Improve textviewer rendering speed #7211

Conversation

david-yz-liu
Copy link
Contributor

@david-yz-liu david-yz-liu commented Sep 4, 2024

Proposed Changes

(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)

When the text viewer renders large files, the run_syntax_highlighter function currently takes a significant amount of time, and causes the page to freeze. A user reported this after uploading a CSV file with over 7000 lines.

The issue was not with Prism.js (the syntax highlighting library we're using), but rather with the code that was modifying the result of the syntax highlighting to make it compatible with our own source code glower. I refactored this code to improve its performance, mostly by making better use of Node/Element methods.

Screenshots of your changes (if applicable)
Associated documentation repository pull request (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
🎨 User interface change (change to user interface; provide screenshots)
♻️ Refactoring (internal change to codebase, without changing functionality) X
🚦 Test update (change that only adds or modifies tests)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have updated the project Changelog (this is required for all changes).
  • I have verified that the pre-commit.ci checks have passed.
  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

(Include any questions or comments you have regarding your changes.)

@david-yz-liu david-yz-liu added this to the v2.5.2 milestone Sep 4, 2024
@coveralls
Copy link
Collaborator

coveralls commented Sep 4, 2024

Pull Request Test Coverage Report for Build 10694123344

Details

  • 17 of 17 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.04%) to 91.488%

Totals Coverage Status
Change from base Build 10656295102: 0.04%
Covered Lines: 40237
Relevant Lines: 43310

💛 - Coveralls

@david-yz-liu david-yz-liu merged commit d8ef632 into MarkUsProject:master Sep 4, 2024
6 checks passed
@david-yz-liu david-yz-liu deleted the syntax-highlighting-large-files branch September 4, 2024 23:42
pretendWhale pushed a commit to pretendWhale/Markus that referenced this pull request Sep 25, 2024
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.

2 participants