[client] Fix creating session file #3212
Merged
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
csordasmarton
added
CLI 💻
zomen2
suggested changes
Feb 24, 2021
csordasmarton
force-pushed
the
fix_create_session_file
branch
from
81b2814 to
a91b7b8
Compare
If we run multiple CodeChecker commands (login, store) which uses the same home directory and the CodeChecker session file (`~/.codechecker.session.json`) does not exist yet the following scenario is possible: - The first command recognizes that this file doesn't exist yet so it will open this file for writing. - Before the first command writes data to the file the second command will be run. It recognizes that the file exists, so it will read up the file. It expects that the file is a valid json file but it is empty. So the `token_dict` variable will be an empty dict, we try to get the `tokens` member of this empty dictionary (`self.__tokens`) which will be `None`, and when we will try to iterate over this directory (which is `None` in our case) the CodeChecker will raise an exception. To solve this problem we will use `portalocker` after we opened the file to lock it, so only one process will be able to read/write this file simultaneously. Also we will handle the use case when this file is still empty.
csordasmarton
force-pushed
the
fix_create_session_file
branch
from
a91b7b8 to
9a59c31
Compare
zomen2
approved these changes
Feb 26, 2021
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.
If we run multiple CodeChecker commands (login, store) which uses the same
home directory and the CodeChecker session file (
~/.codechecker.session.json)does not exist yet the following scenario is possible:
this file for writing.
It recognizes that the file exists, so it will read up the file. It expects that
the file is a valid json file but it is empty. So the
token_dictvariablewill be an empty dict, we try to get the
tokensmember of this emptydictionary (
self.__tokens) which will beNone, and when we will try toiterate over this directory (which is
Nonein our case) the CodeChecker willraise an exception.
To solve this problem we will use
portalockerafter we opened the file tolock it, so only one process will be able to read/write this file simultaneously.
Also we will handle the use case when this file is still empty.