fix: open file in read mode and close on cleanup for ElasticsearchPublisher #2023
Conversation
This file contains 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
We only read from the file and therefore should not open it in write mode. Signed-off-by: Cedrik Neumann <[email protected]>
Not closing the file can cause several issues. One of them is that it prevents [temporary directories](https://docs.python.org/3.10/library/tempfile.html#tempfile.TemporaryDirectory) containing the file from automatic deletion. Signed-off-by: Cedrik Neumann <[email protected]>
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. |
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. |
kristenarmes
approved these changes
Jan 3, 2023
|
@m1racoli not sure why the checks are not running, could you try pushing the branch again? |
|
Awesome work, congrats on your first merged pull request! |
B-T-D
pushed a commit
to B-T-D/amundsen
that referenced
this pull request
Mar 29, 2023
…lisher (amundsen-io#2023) * fix(ElasticsearchPublisher): open file in read mode We only read from the file and therefore should not open it in write mode. Signed-off-by: Cedrik Neumann <[email protected]> * fix(ElasticsearchPublisher): close file on cleanup Not closing the file can cause several issues. One of them is that it prevents [temporary directories](https://docs.python.org/3.10/library/tempfile.html#tempfile.TemporaryDirectory) containing the file from automatic deletion. Signed-off-by: Cedrik Neumann <[email protected]> --------- Signed-off-by: Cedrik Neumann <[email protected]> Signed-off-by: Ben Dye <[email protected]>
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.
Summary of Changes
Since we only read from the file, we do not need to open it in write mode. Furthermore we close the file on cleanup in order to avoid issues with open file handlers. In particular this affects the automatic cleanup of temporary directories containing the file.
Continuation of stale PR #1920
Tests
This affects low level aspect of how we open and close files, which might be beyond the scope of tests.
Documentation
Nothing to document as there is not effective change in behaviour.
CheckList
Make sure you have checked all steps below to ensure a timely review.