Report if Realm::delete_files() actually deleted the Realm file #4771
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
tgoyne
changed the title
nirinchev
reviewed
Jun 18, 2021
| util::File::try_remove(file_path); // Throws | ||
| } | ||
| } | ||
| void Realm::delete_files(const std::string& realm_file_path, bool* did_delete_realm) |
There was a problem hiding this comment.
Why do we need an out parameter vs just returning true/false? Is it because it'll be less obvious to a caller what the return value signifies?
There was a problem hiding this comment.
The function can't return a value if it throws an exception, but the obj-c API does return a value even if it reports an error.
There was a problem hiding this comment.
Ah, I understand - I guess I didn't think through the PR description, but it does make sense!
tgoyne
force-pushed
the
tg/report-if-files-were-deleted
branch
2 times, most recently
from
8a3f67d to
f7ee79e
Compare
Our objective-c API for removing files returns true if the Realm file was deleted, and sets an error out parameter if any errors occurred. This means that even if an exception is thrown when trying to delete one of the auxiliary files we still need to know if the main file was deleted, and that awkwardly requires an out parameter. This also refactors things to eliminate the unordered_map of auxiliary files because none of the things using it actually needed a map, and consolidates the two places where we deleted all the files into one.
tgoyne
force-pushed
the
tg/report-if-files-were-deleted
branch
from
f7ee79e to
427affa
Compare
ironage
approved these changes
Jul 28, 2021
2 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Our objective-c API for removing files returns true if the Realm file was deleted, and sets an error out parameter if any errors occurred. This means that even if an exception is thrown when trying to delete one of the auxiliary files we still need to know if the main file was deleted, and that awkwardly requires an out parameter.
This also refactors things to eliminate the unordered_map of auxiliary files because none of the things using it actually needed a map, and consolidates the two places where we deleted all the files into one.