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

Defer rendering of large files #7273

Merged

Conversation

ch-iv
Copy link
Contributor

@ch-iv ch-iv commented Oct 30, 2024

Proposed Changes

Fixes #5404 by implementing a client-side limit on the size of the submission files that are rendered in the submission file viewer. The max file size limit prevents the downloading of the file contents on the client. The file sizes are hardcoded in the FileViewer component.

When trying to a load a file that is too large the following message is displayed in the submissions file viewer panel.
image
The styling on the message is minimal, but it matches the style of the already present loading message.

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) x
🐛 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)
🚦 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.)

@coveralls
Copy link
Collaborator

coveralls commented Oct 30, 2024

Pull Request Test Coverage Report for Build 11622037897

Details

  • 43 of 45 (95.56%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.02%) to 91.67%

Changes Missing Coverage Covered Lines Changed/Added Lines %
app/assets/javascripts/Components/Result/file_viewer.jsx 11 13 84.62%
Totals Coverage Status
Change from base Build 11545120245: 0.02%
Covered Lines: 40706
Relevant Lines: 43735

💛 - Coveralls

@ch-iv ch-iv requested a review from david-yz-liu October 30, 2024 18:42
Copy link
Collaborator

@david-yz-liu david-yz-liu left a comment

Choose a reason for hiding this comment

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

@ch-iv nice job!

@david-yz-liu david-yz-liu merged commit b5b63e9 into MarkUsProject:master Nov 2, 2024
6 checks passed
@ch-iv ch-iv deleted the defer-rendering-of-large-files branch December 24, 2024 04:32
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.

Feature request: defer rendering of large files
3 participants