Fix(docat): Upload of file with name of tag #272
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
Uploading a document failed with the same name as a broken (no reference) tag resulted in a 500 status code and a stacktrace. To fix this, we now check if a symlink with the same name as the uploaded version exists, and fail if it does. We now also return a warning when a tag for a non existing version is created. fixes #124
randombenj
reviewed
Sep 20, 2022
docat/docat/app.py
Outdated
| return ApiResponse(message=f"Tag {new_tag} -> {version} successfully created") | ||
| msg = f"Tag {new_tag} -> {version} successfully created" | ||
|
|
||
| if not source.exists(): |
There was a problem hiding this comment.
I talked with @fliiiix and we came to the conclusion that this should not be possible and should throw an error and not create the symlink.
There was a problem hiding this comment.
also uploading a version on a symlink should not be possible
There was a problem hiding this comment.
@fliiiix Uploading a version with the same name as a symlink is not possible: (app.py L. 130)
if base_path.is_symlink():
# disallow overwriting of tags (symlinks) with new uploads
response.status_code = status.HTTP_409_CONFLICT
return ApiResponse(message="Cannot overwrite existing tag with new version.")
When creating a tag for a non-existent version you now get a 404 status code. See conversation here: #272
Add asserts to check wheter "create_symlink" has been called even though it shouldn't have.
randombenj
approved these changes
Sep 20, 2022
reglim
deleted the
bugfix/124-http-response-on-upload-fail-due-to-broken-tag
branch
fliiiix
reviewed
Sep 21, 2022
|
|
||
| if not source.exists(): | ||
| response.status_code = status.HTTP_404_NOT_FOUND | ||
| return ApiResponse(message=f"Version {version} not found") |
There was a problem hiding this comment.
@reglim can we change that to something like "Could not create tag {new_tag} because there is no Project Version {version}
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.
Uploading a document failed with the same name as a broken (no reference) tag resulted in a 500 status code and a stacktrace. To fix this, we now check if a symlink with the same name as the uploaded version exists, and fail if it does.
Also, it is now impossible to create a tag to a version that doesn't exist.
fixes #124