nautobot 2.2.0b1__py3-none-any.whl → 2.2.2__py3-none-any.whl

nautobot/extras/models/customfields.py

@@ -724,7 +724,16 @@ class CustomField(BaseModel, ChangeLoggedModel, NotesMixin):
 
         super().delete(*args, **kwargs)
 
-        delete_custom_field_data.delay(self.key, content_types)
+        # Circular Import
+        from nautobot.extras.signals import change_context_state
+
+        change_context = change_context_state.get()
+        if change_context is None:
+            context = None
+        else:
+            context = change_context.as_dict(instance=self)
+            context["context_detail"] = "delete custom field data"
+        delete_custom_field_data.delay(self.key, content_types, context)
 
     def add_prefix_to_cf_key(self):
         return "cf_" + str(self.key)
@@ -783,8 +792,22 @@ class CustomFieldChoice(BaseModel, ChangeLoggedModel):
         super().save(*args, **kwargs)
 
         if self.value != database_object.value:
+            # Circular Import
+            from nautobot.extras.signals import change_context_state
+
+            change_context = change_context_state.get()
+            if change_context is None:
+                context = None
+            else:
+                context = change_context.as_dict(instance=self)
+                context["context_detail"] = "update custom field choice data"
             transaction.on_commit(
-                lambda: update_custom_field_choice_data.delay(self.custom_field.pk, database_object.value, self.value)
+                lambda: update_custom_field_choice_data.delay(
+                    self.custom_field.pk,
+                    database_object.value,
+                    self.value,
+                    context,
+                )
             )
 
     def delete(self, *args, **kwargs):

nautobot/extras/models/datasources.py

@@ -1,4 +1,5 @@
 """Models for representing external data sources."""
+
 from importlib.util import find_spec
 import os
 

nautobot/extras/models/mixins.py

@@ -1,6 +1,7 @@
 """
 Class-modifying mixins that need to be standalone to avoid circular imports.
 """
+
 from django.urls import NoReverseMatch, reverse
 
 from nautobot.core.utils.lookup import get_route_for_model

nautobot/extras/navigation.py

@@ -14,8 +14,50 @@ menu_items = (
         weight=100,
         groups=(
             NavMenuGroup(
-                name="Metadata",  # TODO: is there a better name for this grouping?
+                name="Contacts",
                 weight=400,
+                items=(
+                    NavMenuItem(
+                        link="extras:contact_list",
+                        name="Contacts",
+                        weight=100,
+                        permissions=["extras.view_contact"],
+                        buttons=[NavMenuAddButton(link="extras:contact_add", permissions=["extras.add_contact"])],
+                    ),
+                    NavMenuItem(
+                        link="extras:team_list",
+                        name="Teams",
+                        weight=200,
+                        permissions=["extras.view_team"],
+                        buttons=[NavMenuAddButton(link="extras:team_add", permissions=["extras.add_team"])],
+                    ),
+                ),
+            ),
+            NavMenuGroup(
+                name="Groups",
+                weight=500,
+                items=(
+                    NavMenuItem(
+                        link="extras:dynamicgroup_list",
+                        name="Dynamic Groups",
+                        weight=100,
+                        permissions=[
+                            "extras.view_dynamicgroup",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="extras:dynamicgroup_add",
+                                permissions=[
+                                    "extras.add_dynamicgroup",
+                                ],
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+            NavMenuGroup(
+                name="Metadata",  # TODO: is there a better name for this grouping?
+                weight=600,
                 items=(
                     NavMenuItem(
                         link="extras:tag_list",
@@ -65,42 +107,6 @@ menu_items = (
                             ),
                         ),
                     ),
-                    NavMenuItem(
-                        link="extras:contact_list",
-                        name="Contacts",
-                        weight=400,
-                        permissions=["extras.view_contact"],
-                        buttons=[NavMenuAddButton(link="extras:contact_add", permissions=["extras.add_contact"])],
-                    ),
-                    NavMenuItem(
-                        link="extras:team_list",
-                        name="Teams",
-                        weight=500,
-                        permissions=["extras.view_team"],
-                        buttons=[NavMenuAddButton(link="extras:team_add", permissions=["extras.add_team"])],
-                    ),
-                ),
-            ),
-            NavMenuGroup(
-                name="Dynamic Groups",
-                weight=500,
-                items=(
-                    NavMenuItem(
-                        link="extras:dynamicgroup_list",
-                        name="Dynamic Groups",
-                        weight=100,
-                        permissions=[
-                            "extras.view_dynamicgroup",
-                        ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="extras:dynamicgroup_add",
-                                permissions=[
-                                    "extras.add_dynamicgroup",
-                                ],
-                            ),
-                        ),
-                    ),
                 ),
             ),
         ),
@@ -276,22 +282,6 @@ menu_items = (
                             ),
                         ),
                     ),
-                    NavMenuItem(
-                        link="extras:relationship_list",
-                        name="Relationships",
-                        weight=200,
-                        permissions=[
-                            "extras.view_relationship",
-                        ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="extras:relationship_add",
-                                permissions=[
-                                    "extras.add_relationship",
-                                ],
-                            ),
-                        ),
-                    ),
                     NavMenuItem(
                         link="extras:note_list",
                         name="Notes",
@@ -389,37 +379,53 @@ menu_items = (
                 ),
             ),
             NavMenuGroup(
-                name="Miscellaneous",
+                name="Data Model",
                 weight=600,
                 items=(
                     NavMenuItem(
-                        link="extras:computedfield_list",
-                        name="Computed Fields",
+                        link="extras:customfield_list",
+                        name="Custom Fields",
                         weight=100,
                         permissions=[
-                            "extras.view_computedfield",
+                            "extras.view_customfield",
                         ],
                         buttons=(
                             NavMenuAddButton(
-                                link="extras:computedfield_add",
+                                link="extras:customfield_add",
                                 permissions=[
-                                    "extras.add_computedfield",
+                                    "extras.add_customfield",
                                 ],
                             ),
                         ),
                     ),
                     NavMenuItem(
-                        link="extras:customfield_list",
-                        name="Custom Fields",
+                        link="extras:relationship_list",
+                        name="Relationships",
                         weight=200,
                         permissions=[
-                            "extras.view_customfield",
+                            "extras.view_relationship",
                         ],
                         buttons=(
                             NavMenuAddButton(
-                                link="extras:customfield_add",
+                                link="extras:relationship_add",
                                 permissions=[
-                                    "extras.add_customfield",
+                                    "extras.add_relationship",
+                                ],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="extras:computedfield_list",
+                        name="Computed Fields",
+                        weight=300,
+                        permissions=[
+                            "extras.view_computedfield",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="extras:computedfield_add",
+                                permissions=[
+                                    "extras.add_computedfield",
                                 ],
                             ),
                         ),
@@ -427,7 +433,7 @@ menu_items = (
                     NavMenuItem(
                         link="extras:customlink_list",
                         name="Custom Links",
-                        weight=300,
+                        weight=400,
                         permissions=[
                             "extras.view_customlink",
                         ],

nautobot/extras/plugins/__init__.py

@@ -4,6 +4,7 @@ from importlib import import_module
 import inspect
 from logging import getLogger
 
+from django.conf import settings
 from django.core.exceptions import ValidationError
 from django.template.loader import get_template
 from django.urls import get_resolver, URLPattern
@@ -147,7 +148,7 @@ class NautobotAppConfig(NautobotConfig):
 
         # Import metrics (if present)
         metrics = import_object(f"{self.__module__}.{self.metrics}")
-        if metrics is not None:
+        if metrics is not None and self.name not in settings.METRICS_DISABLED_APPS:
             register_metrics(metrics)
             self.features["metrics"] = []  # Initialize as empty, to be filled by the signal handler
             # Inject the metrics to discover into the signal handler.

nautobot/extras/plugins/views.py

@@ -2,11 +2,9 @@ from collections import OrderedDict
 
 from django.apps import apps
 from django.conf import settings
-from django.contrib.auth.mixins import LoginRequiredMixin
 from django.http import Http404
 from django.shortcuts import render
 from django.urls.exceptions import NoReverseMatch
-from django.views.generic import View
 from django_tables2 import RequestConfig
 from drf_spectacular.utils import extend_schema
 from rest_framework import permissions
@@ -14,13 +12,14 @@ from rest_framework.response import Response
 from rest_framework.reverse import reverse
 from rest_framework.views import APIView
 
-from nautobot.core.api.views import NautobotAPIVersionMixin
+from nautobot.core.api.views import AuthenticatedAPIRootView, NautobotAPIVersionMixin
 from nautobot.core.forms import TableConfigForm
+from nautobot.core.views.generic import GenericView
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.extras.plugins.tables import InstalledAppsTable
 
 
-class InstalledAppsView(LoginRequiredMixin, View):
+class InstalledAppsView(GenericView):
     """
     View for listing all installed Apps.
     """
@@ -66,7 +65,7 @@ class InstalledAppsView(LoginRequiredMixin, View):
         )
 
 
-class InstalledAppDetailView(LoginRequiredMixin, View):
+class InstalledAppDetailView(GenericView):
     """
     View for showing details of an installed App.
     """
@@ -93,7 +92,6 @@ class InstalledAppsAPIView(NautobotAPIVersionMixin, APIView):
     """
 
     permission_classes = [permissions.IsAdminUser]
-    _ignore_model_permissions = True
 
     def get_view_name(self):
         return "Installed Apps"
@@ -129,11 +127,9 @@ class InstalledAppsAPIView(NautobotAPIVersionMixin, APIView):
         return Response([self._get_app_data(apps.get_app_config(app)) for app in settings.PLUGINS])
 
 
-class AppsAPIRootView(NautobotAPIVersionMixin, APIView):
-    _ignore_model_permissions = True
-
-    def get_view_name(self):
-        return "Apps"
+class AppsAPIRootView(AuthenticatedAPIRootView):
+    name = "Apps"
+    description = "API extension point for installed Nautobot Apps"
 
     @staticmethod
     def _get_app_entry(app_config, request, format_):

nautobot/extras/querysets.py

@@ -3,7 +3,6 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.cache import cache
 from django.db.models import F, Model, OuterRef, Q, Subquery
 from django.db.models.functions import JSONObject
-from django_celery_beat.managers import ExtendedQuerySet
 
 from nautobot.core.models.query_functions import EmptyGroupByJSONBAgg
 from nautobot.core.models.querysets import RestrictedQuerySet
@@ -272,7 +271,7 @@ class JobQuerySet(RestrictedQuerySet):
         )
 
 
-class ScheduledJobExtendedQuerySet(RestrictedQuerySet, ExtendedQuerySet):
+class ScheduledJobExtendedQuerySet(RestrictedQuerySet):
     """
     Base queryset used for the ScheduledJob class
     """

nautobot/extras/secrets/providers.py

@@ -2,6 +2,7 @@
 
 Plugins may define and register additional providers in addition to these.
 """
+
 import os
 
 from django import forms

nautobot/extras/signals.py

@@ -52,7 +52,7 @@ logger = logging.getLogger(__name__)
 #
 
 
-def _get_user_if_authenticated(user, instance):
+def get_user_if_authenticated(user, instance):
     """Return the user object associated with the request if the user is defined.
 
     If the user is not defined, log a warning to indicate that the user couldn't be retrived from the request
@@ -103,7 +103,9 @@ def _handle_changed_object(sender, instance, raw=False, **kwargs):
     if raw:
         return
 
-    if change_context_state.get() is None:
+    change_context = change_context_state.get()
+
+    if change_context is None:
         return
 
     # Determine the type of change being made
@@ -119,36 +121,49 @@ def _handle_changed_object(sender, instance, raw=False, **kwargs):
 
     # Record an ObjectChange if applicable
     if hasattr(instance, "to_objectchange"):
-        user = _get_user_if_authenticated(change_context_state.get().get_user(), instance)
+        user = change_context.get_user(instance)
         # save a copy of this instance's field cache so it can be restored after serialization
         # to prevent unexpected behavior when chaining multiple signal handlers
         original_cache = instance._state.fields_cache.copy()
 
+        changed_object_type = ContentType.objects.get_for_model(instance)
+        changed_object_id = instance.id
+
+        # Generate a unique identifier for this change to stash in the change context
+        # This is used for deferred change logging and for looking up related changes without querying the database
+        unique_object_change_id = f"{changed_object_type.pk}__{changed_object_id}__{user.pk}"
+
         # If a change already exists for this change_id, user, and object, update it instead of creating a new one.
         # If the object was deleted then recreated with the same pk (don't do this), change the action to update.
-        related_changes = ObjectChange.objects.filter(
-            changed_object_type=ContentType.objects.get_for_model(instance),
-            changed_object_id=instance.pk,
-            user=user,
-            request_id=change_context_state.get().change_id,
-        )
-        objectchange = instance.to_objectchange(action)
-        if related_changes.exists():
-            most_recent_change = related_changes.order_by("-time").first()
-            if most_recent_change.action == ObjectChangeActionChoices.ACTION_DELETE:
-                most_recent_change.action = ObjectChangeActionChoices.ACTION_UPDATE
-            most_recent_change.object_data = objectchange.object_data
-            most_recent_change.object_data_v2 = objectchange.object_data_v2
-            most_recent_change.save()
-            objectchange = most_recent_change
+        if unique_object_change_id in change_context.deferred_object_changes:
+            related_changes = ObjectChange.objects.filter(
+                changed_object_type=changed_object_type,
+                changed_object_id=changed_object_id,
+                user=user,
+                request_id=change_context.change_id,
+            )
+
+            # Skip the database check when deferring object changes
+            if not change_context.defer_object_changes and related_changes.exists():
+                objectchange = instance.to_objectchange(action)
+                most_recent_change = related_changes.order_by("-time").first()
+                if most_recent_change.action == ObjectChangeActionChoices.ACTION_DELETE:
+                    most_recent_change.action = ObjectChangeActionChoices.ACTION_UPDATE
+                most_recent_change.object_data = objectchange.object_data
+                most_recent_change.object_data_v2 = objectchange.object_data_v2
+                most_recent_change.save()
+
         else:
-            objectchange.user = user
-            objectchange.request_id = change_context_state.get().change_id
-            objectchange.change_context = change_context_state.get().context
-            objectchange.change_context_detail = change_context_state.get().context_detail[
-                :CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
+            change_context.deferred_object_changes[unique_object_change_id] = [
+                {"action": action, "instance": instance, "user": user}
             ]
-            objectchange.save()
+            if not change_context.defer_object_changes:
+                objectchange = instance.to_objectchange(action)
+                objectchange.user = user
+                objectchange.request_id = change_context.change_id
+                objectchange.change_context = change_context.context
+                objectchange.change_context_detail = change_context.context_detail[:CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL]
+                objectchange.save()
 
         # restore field cache
         instance._state.fields_cache = original_cache
@@ -171,7 +186,9 @@ def _handle_deleted_object(sender, instance, **kwargs):
     """
     Fires when an object is deleted.
     """
-    if change_context_state.get() is None:
+    change_context = change_context_state.get()
+
+    if change_context is None:
         return
 
     if isinstance(instance, BaseModel):
@@ -186,41 +203,58 @@ def _handle_deleted_object(sender, instance, **kwargs):
 
     # Record an ObjectChange if applicable
     if hasattr(instance, "to_objectchange"):
-        user = _get_user_if_authenticated(change_context_state.get().get_user(), instance)
+        user = change_context.get_user(instance)
 
         # save a copy of this instance's field cache so it can be restored after serialization
         # to prevent unexpected behavior when chaining multiple signal handlers
         original_cache = instance._state.fields_cache.copy()
 
+        changed_object_type = ContentType.objects.get_for_model(instance)
+        changed_object_id = instance.id
+
+        # Generate a unique identifier for this change to stash in the change context
+        # This is used for deferred change logging and for looking up related changes without querying the database
+        unique_object_change_id = f"{changed_object_type.pk}__{changed_object_id}__{user.pk}"
+        save_new_objectchange = True
+
         # if a change already exists for this change_id, user, and object, update it instead of creating a new one
         # except in the case that the object was created and deleted in the same change_id
         # we don't want to create a delete change for an object that never existed
-        related_changes = ObjectChange.objects.filter(
-            changed_object_type=ContentType.objects.get_for_model(instance),
-            changed_object_id=instance.pk,
-            user=user,
-            request_id=change_context_state.get().change_id,
-        )
-        objectchange = instance.to_objectchange(ObjectChangeActionChoices.ACTION_DELETE)
-        save_new_objectchange = True
-        if related_changes.exists():
-            most_recent_change = related_changes.order_by("-time").first()
-            if most_recent_change.action != ObjectChangeActionChoices.ACTION_CREATE:
-                most_recent_change.action = ObjectChangeActionChoices.ACTION_DELETE
-                most_recent_change.object_data = objectchange.object_data
-                most_recent_change.object_data_v2 = objectchange.object_data_v2
-                most_recent_change.save()
-                objectchange = most_recent_change
+        if unique_object_change_id in change_context.deferred_object_changes:
+            cached_related_change = change_context.deferred_object_changes[unique_object_change_id][-1]
+            if cached_related_change["action"] != ObjectChangeActionChoices.ACTION_CREATE:
+                cached_related_change["action"] = ObjectChangeActionChoices.ACTION_DELETE
                 save_new_objectchange = False
 
+            related_changes = ObjectChange.objects.filter(
+                changed_object_type=changed_object_type,
+                changed_object_id=changed_object_id,
+                user=user,
+                request_id=change_context.change_id,
+            )
+
+            # Skip the database check when deferring object changes
+            if not change_context.defer_object_changes and related_changes.exists():
+                objectchange = instance.to_objectchange(ObjectChangeActionChoices.ACTION_DELETE)
+                most_recent_change = related_changes.order_by("-time").first()
+                if most_recent_change.action != ObjectChangeActionChoices.ACTION_CREATE:
+                    most_recent_change.action = ObjectChangeActionChoices.ACTION_DELETE
+                    most_recent_change.object_data = objectchange.object_data
+                    most_recent_change.object_data_v2 = objectchange.object_data_v2
+                    most_recent_change.save()
+                    save_new_objectchange = False
+
         if save_new_objectchange:
-            objectchange.user = user
-            objectchange.request_id = change_context_state.get().change_id
-            objectchange.change_context = change_context_state.get().context
-            objectchange.change_context_detail = change_context_state.get().context_detail[
-                :CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL
-            ]
-            objectchange.save()
+            change_context.deferred_object_changes.setdefault(unique_object_change_id, []).append(
+                {"action": ObjectChangeActionChoices.ACTION_DELETE, "instance": instance, "user": user}
+            )
+            if not change_context.defer_object_changes:
+                objectchange = instance.to_objectchange(ObjectChangeActionChoices.ACTION_DELETE)
+                objectchange.user = user
+                objectchange.request_id = change_context.change_id
+                objectchange.change_context = change_context.context
+                objectchange.change_context_detail = change_context.context_detail[:CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL]
+                objectchange.save()
 
         # restore field cache
         instance._state.fields_cache = original_cache
@@ -238,13 +272,23 @@ def handle_cf_removed_obj_types(instance, action, pk_set, **kwargs):
     """
     Handle the cleanup of old custom field data when a CustomField is removed from one or more ContentTypes.
     """
+
+    change_context = change_context_state.get()
+    if change_context is None:
+        context = None
+    else:
+        context = change_context.as_dict(instance=instance)
     if action == "post_remove":
         # Existing content types have been removed from the custom field, delete their data
-        transaction.on_commit(lambda: delete_custom_field_data.delay(instance.key, pk_set))
+        if context:
+            context["context_detail"] = "delete custom field data from existing content types"
+        transaction.on_commit(lambda: delete_custom_field_data.delay(instance.key, pk_set, context))
 
     elif action == "post_add":
         # New content types have been added to the custom field, provision them
-        transaction.on_commit(lambda: provision_field.delay(instance.pk, pk_set))
+        if context:
+            context["context_detail"] = "provision custom field data for new content types"
+        transaction.on_commit(lambda: provision_field.delay(instance.pk, pk_set, context))
 
 
 m2m_changed.connect(handle_cf_removed_obj_types, sender=CustomField.content_types.through)