Build details page: normalize/trim command paths #9815
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
Small hack to trim/normalize command paths when displaying them to the user under the build detail's page. This is a simple hack and there are more we can do here. Probably, there are some edge cases this is not catching. However, the worst it can happens is the path not being trimmed.
ericholscher
approved these changes
Dec 15, 2022
readthedocs/api/v2/serializers.py
Outdated
| if settings.RTD_DOCKER_COMPOSE: | ||
| docroot = re.sub('/[0-9a-z]+/?$', '', settings.DOCROOT, count=1) | ||
|
|
||
| command = re.sub(f'{docroot}/[0-9a-z]+/{project_slug}/envs/{version_slug}(/bin/)?', '', obj.command, count=1) |
There was a problem hiding this comment.
I wonder if we want to remove count=1, so if we have multiple paths in the command they will be removed? I don't know how often that happens, but seems fine to have this for now, also.
humitos
commented
Dec 16, 2022
|
Ups, I enabled auto-merge, but I didn't add a test case for this. I will add it in another PR. |
humitos
added a commit
that referenced
this pull request
Dec 20, 2022
This commit contains the test that was missing for my other PR: #9815 The test checks the commands' PATH are trimmed before being returned by the API.
ericholscher
added a commit
that referenced
this pull request
Dec 20, 2022
This reverts commit 20533d4.
ericholscher
added a commit
that referenced
this pull request
Dec 20, 2022
This reverts commit 20533d4.
humitos
added a commit
that referenced
this pull request
Dec 21, 2022
Continuation of the work done in #9815 that didn't work as we expected. We weren't saving the commands properly when hitting the API since `serializers.SerializerMethodField` is a read-only field. This commit fixes this problem by using a different Serializer depending if it's a GET request or not, and if it's made by an Admin or not. It overrides the method `BuildViewSet.get_serializer_class` to manage these different cases and return the proper serializer. Done on top of #9815 to be sure the tests for saving commands are passing.
humitos
added a commit
that referenced
this pull request
Dec 21, 2022
Continuation of the work done in #9815 that didn't work as we expected. We weren't saving the commands properly when hitting the API since `serializers.SerializerMethodField` is a read-only field. This commit fixes this problem by using a different Serializer depending if it's a GET request or not, and if it's made by an Admin or not. It overrides the method `BuildViewSet.get_serializer_class` to manage these different cases and return the proper serializer. Done on top of #9827 to be sure the tests for saving commands are passing.
humitos
added a commit
that referenced
this pull request
Dec 21, 2022
This commit contains the test that was missing for my other PR: #9815 The test checks the commands' PATH are trimmed before being returned by the API.
benjaoming
added a commit
that referenced
this pull request
Dec 22, 2022
) * Build details page: normalize/trim command paths (second attempt) Continuation of the work done in #9815 that didn't work as we expected. We weren't saving the commands properly when hitting the API since `serializers.SerializerMethodField` is a read-only field. This commit fixes this problem by using a different Serializer depending if it's a GET request or not, and if it's made by an Admin or not. It overrides the method `BuildViewSet.get_serializer_class` to manage these different cases and return the proper serializer. Done on top of #9827 to be sure the tests for saving commands are passing. * Feedback from review addressed - rename serializer to mention "ReadOnly" on it's class name - add docstrings to these serializers * Typo when accessing the action * Optional builder hash on local instance Old builds don't have the builder hash in the docroot, since that was implmented recently. * Lint * Apply suggestions from code review Co-authored-by: Benjamin Balder Bach <[email protected]> Co-authored-by: Benjamin Balder Bach <[email protected]>
stsewd
added a commit
that referenced
this pull request
Dec 22, 2022
* API V2: test that command is actually saved * Build details page: normalize/trim command paths (second attempt) (#9831) Continuation of the work done in #9815 that didn't work as we expected. We weren't saving the commands properly when hitting the API since `serializers.SerializerMethodField` is a read-only field. This commit fixes this problem by using a different Serializer depending if it's a GET request or not, and if it's made by an Admin or not. It overrides the method `BuildViewSet.get_serializer_class` to manage these different cases and return the proper serializer. Done on top of #9827 to be sure the tests for saving commands are passing. * Feedback from review addressed - rename serializer to mention "ReadOnly" on it's class name - add docstrings to these serializers * Typo when accessing the action * Optional builder hash on local instance Old builds don't have the builder hash in the docroot, since that was implmented recently. Co-authored-by: Manuel Kaufmann <[email protected]> Co-authored-by: Benjamin Balder Bach <[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.
Small hack to trim/normalize command paths when displaying them to the user under the build detail's page.
This is a simple hack and there are more we can do here. Probably, there are some edge cases this is not catching. However, the worst it can happens is the path not being trimmed.
Before
After