Add get_changelog_url Method to Objects that Support Changelogs #2049
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
nautobot/core/views/generic.py
Outdated
| @@ -123,7 +126,7 @@ def get(self, request, *args, **kwargs): | |||
| "object": instance, | |||
| "verbose_name": self.queryset.model._meta.verbose_name, | |||
| "verbose_name_plural": self.queryset.model._meta.verbose_name_plural, | |||
| "changelog_url": self.get_changelog_url(instance), | |||
| "changelog_url": instance.get_changelog_url(), # TODO: Remove in 2.0. This information can be retrieved from the object itself now. | |||
There was a problem hiding this comment.
This is going to blow up if instance doesn't have a get_changelog_url method.
There was a problem hiding this comment.
This is probably what's causing CI to fail. This was quick and I wanted to get eyes out there. I'm going to do some proper validation.
…rperate feedback.
bryanculver
commented
Jul 13, 2022
Comment on lines
-347
to
-351
| def get_changelog_url(self, instance): | ||
| """Return the changelog URL.""" | ||
| route = "extras:customfield_changelog" | ||
| return reverse(route, kwargs={"name": getattr(instance, "name")}) | ||
|
|
There was a problem hiding this comment.
Since it's not likely something is subclassing CustomFieldView this should be safe to remove but I'm OK with leaving it and restoring the # TODO: Remove... note.
glennmatthews
approved these changes
Jul 14, 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.
Closes: #DNE
What's Changed
In working with @smk4664 on #1984 it was discovered that more than just the model object is needed to be passed down in context to render the tabs.
Just like we have the
get_absolute_urlmethod on objects in aiding to reverse resolve the URL to the object, this adds theget_changelog_urlmethod to objects that inherit fromChangeLoggedModel.This will eventually eliminate the need for
changelog_urlto be passed down in the view context but is kept for now for backwards compatibility. It is no longer used in the views as the template itself has been updated to referenceobject.get_changelog_url. Existing methods are also kept for the time being.CustomFieldmodels must override this as they key on the name of the Custom Field instead ofpkorslugall other models use (cough lets move that toslugcough).TODO