Page MenuHomePhabricator

Option to truncate files on display in diffusion
AbandonedPublic

Authored by epriestley on Jan 23 2014, 10:16 AM.
Tags
None
Referenced Files
F13998355: D8040.id18189.diff
Thu, Oct 24, 9:03 AM
Unknown Object (File)
Wed, Oct 9, 5:27 PM
Unknown Object (File)
Wed, Oct 9, 3:27 PM
Unknown Object (File)
Wed, Oct 9, 10:32 AM
Unknown Object (File)
Oct 1 2024, 11:59 PM
Unknown Object (File)
Oct 1 2024, 9:26 AM
Unknown Object (File)
Oct 1 2024, 9:26 AM
Unknown Object (File)
Oct 1 2024, 9:15 AM

Details

Reviewers
sergey.vfx
Summary

This change adds an option to limit time being spent on
rendering file in diffusion browser. This option is called
diffusion.render-time-limit and measured in seconds.

By default any time limit is disabled.

Useful in cases when there're huge files in the repository
which are really slow to render and which are not really
useful to see the whole content of them. With this change it
is possible to limit render time to less than 30 sec so
script execution is not terminated) and have a nice button
to download the raw file.

Test Plan

Just add a rather huge file to repository and browse it
in the diffusion. For example translations files from

http://git.blender.org/gitweb/gitweb.cgi/blender-translations.git/tree/HEAD:/po

could be used.

Diff Detail

Branch
diffusion_render_timelimit
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 10017
Build 12109: Run Core Tests

Event Timeline

Just letting you know I've seen this -- I think this is good in theory, but want to provide some specific feedback about the implementation. I'll followup later when I have a chance, hopefully today.

@epriestley, sure. It's not that kind of thing when there's a single solution. Getting more feedback and even thinking of better solution would be really cool.

Just thinking loud, maybe it is to be some more generic routine. In theory if someone adds a huge file differential might also hung up..

src/applications/diffusion/controller/DiffusionBrowseFileController.php
640

This is a typo in here actually. Will fix it if/when the idea is accepted in general.

Some general thoughts here:

  • Generally, on all these diff/browse interfaces we have some issues with:
    • Changesets with a large number of files.
    • Files with a large size and/or large number of text changes.
  • The different interfaces handle this to varying degrees. This one does a poor job of it.
  • If possible, I don't want to add config for this. I'd rather try to do something reasonable by default, and add config only if we can't get things working well for most users.
  • This doesn't guarantee that the problem is fixed:
    • If a file is so large that it takes more than 30 seconds to load the raw data, this won't change the behavior.
    • If a file doesn't have any newlines, this won't change the behavior.
    • Highlighting a file is generally much slower than rendering it. This won't change the behavior for large files which take more than 30 seconds to highlight.
  • Users often want to click a button to show the entire file (some of the buttons that exist today are hard to find, and users ask questions about them).

Generally, I think a comprehensive solution should look like this:

  1. Time limit the content query (say, to 15s). If it times out, display an error message (like "The file content timed out while loading.").
  2. Check the total byte length of the content, and limit it if it's over some limit (say, 4MB).
  3. Check the total line length of the content, and limit it if it's over some limit (say, 4K lines).
  4. Check the total byte length of the remaining content, and if it's over some limit (say, 1MB), disable syntax highlighting.
  5. Render the remaining file content.
  6. If we truncated the content in step 2 or 3, add a message ("This file is large (32MB), only the first 4MB are shown. [Show All]").
  7. If we disabled highlighting in step 4, add a message ("This file is large (32MB), so syntax highlighting is disabled. [Enable Highlighting]").

I'd like to do this everywhere that we show diffs. We do some of it in some of the places, but it's not very consistent right now.

However, this is a lot of work. Maybe we could implement some pieces of it to solve your problem, and then I could implement the rest later. For example, truncating the file's lines would probably fix the issue you're running into?

Think the proposed solution is indeed comprehensive. And for sure it'll solve our issues and bet will also help keep servers usage sane for those who also does have huge files in their repos.

The change could be done granularly. Meaning now we can implement truncation based on file size/number of lines and do the rest of the things later.

Think i could prepare patch for this within few days. Don't think there's real hurry with this yet and don't want you to spend lots of time on such a specific issue :)

epriestley abandoned this revision.
epriestley edited reviewers, added: sergey.vfx; removed: epriestley.

This should generally be fixed at HEAD. See also T4474, and this week's changelog and development notes.