Implement timeout and memory limits for pandoc in scope.sh #3004
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add a timeout of 10 seconds to pandoc commands to prevent indefinite execution. - Introduce a memory limit of 500MB using ulimit to restrict pandoc's memory usage. - Update relevant sections in scope.sh where pandoc is invoked, including handling OpenDocument, HTML, DOCX, ePub, and FB2 files. - Implement error handling for cases where pandoc exceeds the timeout or memory limit, ensuring the script exits gracefully with an appropriate message. - Improve the robustness of file previews in ranger by preventing pandoc from causing system instability due to excessive resource consumption.
toonn
reviewed
Jan 4, 2025
Comment on lines
+90
to
+98
| ulimit -v 500000 # Limit to 500MB | ||
| timeout 10s pandoc -s -t markdown -- "${FILE_PATH}" && exit 5 | ||
| if [ $? -eq 124 ]; then | ||
| echo "Pandoc timed out or was terminated due to excessive memory usage" >&2 | ||
| exit 1 | ||
| elif [ $? -ne 0 ]; then | ||
| echo "Pandoc failed" >&2 | ||
| exit 1 | ||
| fi |
There was a problem hiding this comment.
Let's wrap this in a function instead.
| @@ -87,7 +87,15 @@ handle_extension() { | |||
| ## Preview as text conversion | |||
| odt2txt "${FILE_PATH}" && exit 5 | |||
| ## Preview as markdown conversion | |||
| pandoc -s -t markdown -- "${FILE_PATH}" && exit 5 | |||
| ulimit -v 500000 # Limit to 500MB | |||
There was a problem hiding this comment.
This doesn't work on macOS, ulimit can only set the maximum file size there.
Either way it would have to be reset afterwards though.
Other commands should be free to use however much memory they want if they can do so quickly and it should be possible for other alternatives to be tried after Pandoc.
| @@ -87,7 +87,15 @@ handle_extension() { | |||
| ## Preview as text conversion | |||
| odt2txt "${FILE_PATH}" && exit 5 | |||
| ## Preview as markdown conversion | |||
| pandoc -s -t markdown -- "${FILE_PATH}" && exit 5 | |||
| ulimit -v 500000 # Limit to 500MB | |||
| timeout 10s pandoc -s -t markdown -- "${FILE_PATH}" && exit 5 | |||
There was a problem hiding this comment.
timeout is part of Coreutils so it's not available on macOS and I'm not sure it's part of BusyBox.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ISSUE TYPE
RUNTIME ENVIRONMENT
ranger version: ranger 1.9.3
Operating system and version:
macOS 15.0.0
Terminal emulator and version:
Apple Terminal (Version 453)
Python version:
Python version: 3.11.9 (main, Apr 2 2024, 08:25:04) [Clang 15.0.0 (clang-1500.3.9.4)]
Ranger version/commit:
bd9b37f
Locale:
Locale: en_US.UTF-8
CHECKLIST
CONTRIBUTINGdocument has been read [REQUIRED]DESCRIPTION
This pull request introduces a timeout and memory limit for the
pandoccommands used inscope.shto prevent indefinite execution and excessive memory consumption.Specifically:
A timeout of 10 seconds is added to the
pandoccommands.Memory usage is limited to 500MB using ulimit.
These changes are applied to sections handling OpenDocument, HTML, DOCX, ePub, and FB2 files.
Error handling is included for cases where pandoc exceeds the timeout or memory limit, ensuring the script exits gracefully with an appropriate message.
MOTIVATION AND CONTEXT
These changes are required to improve the stability and robustness of file previews in
rangerwhen handling files that requirepandocfor conversion. Without these limits,pandoccan cause system instability by running indefinitely or consuming excessive resources, especially with large or complex files.TESTING
Manual tests were conducted with various document types and sizes to ensure that
pandocis correctly terminated when exceeding the specified timeout or memory limits. The changes were verified to work without impacting other areas of the codebase. (more testing may be advised)