Don't error maintenance commands on missing library clone folder #125
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
Both the `libraries-repository-engine remove` and `libraries-repository-engine modify --repo-url` commands delete the library's "Git clone folder". Previously, the code for doing this was repeated verbatim for each command. At the time the code was written, this was considered reasonable since it was not a lot of code and the architectural structure of the module does not provide an obvious location for a shared function containing that code. However, it is now planned to add additional code, which tips the balance toward a function. This also enables increasing the unit test coverage of the code.
The maintenance commands `libraries-repository-engine modify` and `libraries-repository-engine remove` are designed in a conservative manner where the operation is to be immediately halted and all affected data restored if any unexpected conditions are encountered. Previously, the absence of a library's "Git clone folder" targeted for deletion was considered such an unexpected condition. Investigation of some failures during the course of maintenance operations revealed that this folder may be absent under certain expected conditions. The reason is that the "sync" operation deletes the folder after a failed `git fetch` operation before trying a `git clone` of a fresh copy of the repository. If that retry fails, the result is that there is no longer a "Git clone folder" for that library on Arduino's server. So the absence of this folder should not be treated as cause for the maintenance command to fail. Instead, the command should warn the user of the situation and then carry on with the operation.
per1234
added
topic: code
Codecov Report
@@ Coverage Diff @@
## main #125 +/- ##
==========================================
+ Coverage 41.58% 42.54% +0.95%
==========================================
Files 26 26
Lines 1450 1455 +5
==========================================
+ Hits 603 619 +16
+ Misses 790 775 -15
- Partials 57 61 +4
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
umbynos
approved these changes
May 27, 2022
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.
The maintenance commands
libraries-repository-engine modifyandlibraries-repository-engine removeare designed in a conservative manner where the operation is to be immediately halted and all affected data restored if any unexpected conditions are encountered.Previously, the absence of a library's "Git clone folder" targeted for deletion was considered such an unexpected condition.
Investigation of some failures during the course of maintenance operations revealed that this folder may be absent under certain expected conditions.
The reason is that the "sync" operation deletes the folder after a failed
git fetchoperation before trying agit cloneof a fresh copy of the repository. If that retry fails, the result is that there is no longer a "Git clone folder" for that library on Arduino's server.libraries-repository-engine/internal/command/sync/sync.go
Lines 167 to 179 in 4fd9cf7
So the absence of this folder should not be treated as cause for the maintenance command to fail. Instead, the command should warn the user (i.e., the library registry backend maintainer) of the situation and then carry on with the operation.