Avoid NoReverseMatch exception during app startup if navigation has a bad link #789
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.
Fixes: #N/A
If a
navigation.py
(core app or plugin-defined) defines nav menu items with an invalid link name (one that cannot be successfullyreverse()
d), as implemented Nautobot startup will fail with aNoReverseMatch
exception:Additionally it's not ideal for us to be calling
reverse()
during initial AppConfig loading at all, as there may be some timing or sequencing issues wherein an app is ready before all urlpatterns have been fully registered (this was my working theory on investigating #785 that led to this fix).The solution delivered here is to remove the init-time
reverse()
check, and additionally handle bad URLs in the rendering of the nav-menu template, rather than failing the entire template rendering and throwing an exception to the user. If a bad URL is registered in the nav menu, the UI will now show this: