Implement optional url prefix the Django way#15080
Merged
chrismeyersfsu merged 1 commit intoApr 10, 2024
Merged
Conversation
39c0c1a to
8f46f39
Compare
* Before, the optional url prefix feature required calling our versioning version of reverse(). This worked _ok_ until we added more and more urls from 3rd party apps. Those 3rd party apps do not call our reverse(), writefully so. * This implementation looks at the incoming request path. If it includes the special optional prefix url, then we register ALL the urls WITH the optional url prefix. If the incoming request path does NOT contain the options url prefix then we register ALL the urls WITHOUT the optional url prefix. * Before this, we were registering BOTH sets of urls and then reverse() + the request as context to decide which url.
8f46f39 to
4b478ae
Compare
TheRealHaoLiu
approved these changes
Apr 10, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
SUMMARY
Performance investigation notes.
As I suspected, an implementation that constructs the urls patterns foreach request is noticeable.
The bottom set of
inclusivetimes are when visiting/api/v2/hosts/vs. the top set are when visiting/awx/v2/<prefix>/hosts/. Theexclusiveentry is isolated to justget_urlpatterns(prefix=settings.OPTIONAL_API_URLPATTERN_PREFIX)Done:
get_urlpatterns(prefix=settings.OPTIONAL_API_URLPATTERN_PREFIX)resultsmaybe calldecided this isn't worth it.get_urlpatterns(prefix=settings.OPTIONAL_API_URLPATTERN_PREFIX)in some sort of init process so we don't pay the penalty on first request. Realistically though, the penalty here isn't that expensive if we do have to pay it 1 time per new uwsgi process.ISSUE TYPE
COMPONENT NAME
AWX VERSION
ADDITIONAL INFORMATION