more locking functions

Author: arthanson

netbox_custom_objects/__init__.py

@@ -1,12 +1,28 @@
 import sys
+import threading
 import warnings
+from functools import wraps
 
 from django.db import transaction
 from django.db.utils import DatabaseError, OperationalError, ProgrammingError
 from netbox.plugins import PluginConfig
 
 from .constants import APP_LABEL as APP_LABEL
 
+# Global lock for plugin ready method
+_plugin_ready_lock = threading.RLock()
+
+
+def thread_safe_plugin_ready(func):
+    """
+    Decorator to ensure thread-safe plugin ready method execution.
+    """
+    @wraps(func)
+    def wrapper(self, *args, **kwargs):
+        with _plugin_ready_lock:
+            return func(self, *args, **kwargs)
+    return wrapper
+
 
 def is_running_migration():
     """
@@ -51,6 +67,7 @@ class CustomObjectsPluginConfig(PluginConfig):
     required_settings = []
     template_extensions = "template_content.template_extensions"
 
+    @thread_safe_plugin_ready
     def ready(self):
         from .models import CustomObjectType
         from netbox_custom_objects.api.serializers import get_serializer_class

netbox_custom_objects/decorators.py

@@ -0,0 +1,25 @@
+import threading
+from functools import wraps
+
+
+def thread_safe_model_generation(func):
+    """
+    Decorator to ensure thread-safe model generation.
+
+    This decorator prevents race conditions when multiple threads try to generate
+    the same custom object model simultaneously. It uses per-model locks to ensure
+    only one thread can generate a specific model at a time, while allowing
+    different models to be generated concurrently and preventing deadlocks.
+    """
+    @wraps(func)
+    def wrapper(self, *args, **kwargs):
+        # Get or create a lock for this specific model
+        with self._global_lock:
+            if self.id not in self._model_cache_locks:
+                self._model_cache_locks[self.id] = threading.RLock()
+            model_lock = self._model_cache_locks[self.id]
+
+        # Use the per-model lock for thread safety
+        with model_lock:
+            return func(self, *args, **kwargs)
+    return wrapper

netbox_custom_objects/models.py

@@ -2,7 +2,6 @@
 import re
 import threading
 from datetime import date, datetime
-from functools import wraps
 
 import django_filters
 from core.models import ObjectType, ObjectChange
@@ -52,6 +51,7 @@
 from utilities.validators import validate_regex
 
 from netbox_custom_objects.constants import APP_LABEL, RESERVED_FIELD_NAMES
+from netbox_custom_objects.decorators import thread_safe_model_generation
 from netbox_custom_objects.field_types import FIELD_TYPE_CLASS
 from netbox_custom_objects.utilities import generate_model
 
@@ -65,29 +65,6 @@ class UniquenessConstraintTestError(Exception):
 USER_TABLE_DATABASE_NAME_PREFIX = "custom_objects_"
 
 
-def thread_safe_model_generation(func):
-    """
-    Decorator to ensure thread-safe model generation.
-
-    This decorator prevents race conditions when multiple threads try to generate
-    the same custom object model simultaneously. It uses per-model locks to ensure
-    only one thread can generate a specific model at a time, while allowing
-    different models to be generated concurrently and preventing deadlocks.
-    """
-    @wraps(func)
-    def wrapper(self, *args, **kwargs):
-        # Get or create a lock for this specific model
-        with self._global_lock:
-            if self.id not in self._model_cache_locks:
-                self._model_cache_locks[self.id] = threading.RLock()
-            model_lock = self._model_cache_locks[self.id]
-
-        # Use the per-model lock for thread safety
-        with model_lock:
-            return func(self, *args, **kwargs)
-    return wrapper
-
-
 class CustomObject(
     BookmarksMixin,
     ChangeLoggingMixin,
@@ -573,6 +550,14 @@ def wrapped_post_through_setup(self, cls):
 
         return model
 
+    @thread_safe_model_generation
+    def get_model_with_serializer(self):
+        from netbox_custom_objects.api.serializers import get_serializer_class
+        model = self.get_model()
+        get_serializer_class(model)
+        self.register_custom_object_search_index(model)
+        return model
+
     def create_model(self):
         # Get the model and ensure it's registered
         model = self.get_model()

netbox_custom_objects/views.py

@@ -142,14 +142,6 @@ def get_table(self, data, request, bulk_actions=True):
         return super().get_table(data, request, bulk_actions=bulk_actions)
 
 
-class CustomObjectModelMixin:
-    def get_model(self, custom_object_type):
-        model = custom_object_type.get_model()
-        get_serializer_class(model)
-        custom_object_type.register_custom_object_search_index(model)
-        return model
-
-
 #
 # Custom Object Types
 #
@@ -164,17 +156,17 @@ class CustomObjectTypeListView(generic.ObjectListView):
 
 
 @register_model_view(CustomObjectType)
-class CustomObjectTypeView(CustomObjectTableMixin, CustomObjectModelMixin, generic.ObjectView):
+class CustomObjectTypeView(CustomObjectTableMixin, generic.ObjectView):
     queryset = CustomObjectType.objects.all()
 
     def get_table(self, data, request, bulk_actions=True):
         self.custom_object_type = self.get_object(**self.kwargs)
-        model = self.get_model(self.custom_object_type)
+        model = self.custom_object_type.get_model_with_serializer()
         data = model.objects.all()
         return super().get_table(data, request, bulk_actions=False)
 
     def get_extra_context(self, request, instance):
-        model = self.get_model(instance)
+        model = instance.get_model_with_serializer()
 
         # Get fields and group them by group_name
         fields = instance.fields.all().order_by("group_name", "weight", "name")
@@ -202,13 +194,13 @@ class CustomObjectTypeEditView(generic.ObjectEditView):
 
 
 @register_model_view(CustomObjectType, "delete")
-class CustomObjectTypeDeleteView(CustomObjectModelMixin, generic.ObjectDeleteView):
+class CustomObjectTypeDeleteView(generic.ObjectDeleteView):
     queryset = CustomObjectType.objects.all()
     default_return_url = "plugins:netbox_custom_objects:customobjecttype_list"
 
     def _get_dependent_objects(self, obj):
         dependent_objects = super()._get_dependent_objects(obj)
-        model = self.get_model(obj)
+        model = obj.get_model_with_serializer()
         dependent_objects[model] = list(model.objects.all())
 
         # Find CustomObjectTypeFields that reference this CustomObjectType
@@ -235,7 +227,7 @@ class CustomObjectTypeFieldEditView(generic.ObjectEditView):
 
 
 @register_model_view(CustomObjectTypeField, "delete")
-class CustomObjectTypeFieldDeleteView(CustomObjectModelMixin, generic.ObjectDeleteView):
+class CustomObjectTypeFieldDeleteView(generic.ObjectDeleteView):
     template_name = "netbox_custom_objects/field_delete.html"
     queryset = CustomObjectTypeField.objects.all()
 
@@ -252,7 +244,7 @@ def get(self, request, *args, **kwargs):
         obj = self.get_object(**kwargs)
         form = ConfirmationForm(initial=request.GET)
 
-        model = self.get_model(obj.custom_object_type)
+        model = obj.custom_object_type.get_model_with_serializer()
         kwargs = {
             f"{obj.name}__isnull": False,
         }
@@ -289,7 +281,7 @@ def get(self, request, *args, **kwargs):
 
     def _get_dependent_objects(self, obj):
         dependent_objects = super()._get_dependent_objects(obj)
-        model = self.get_model(obj.custom_object_type)
+        model = obj.custom_object_type.get_model_with_serializer()
         kwargs = {
             f"{obj.name}__isnull": False,
         }
@@ -323,7 +315,7 @@ class CustomObjectTypeBulkDeleteView(generic.BulkDeleteView):
 #
 
 
-class CustomObjectListView(CustomObjectTableMixin, CustomObjectModelMixin, generic.ObjectListView):
+class CustomObjectListView(CustomObjectTableMixin, generic.ObjectListView):
     queryset = None
     custom_object_type = None
     template_name = "netbox_custom_objects/custom_object_list.html"
@@ -341,7 +333,7 @@ def get_queryset(self, request):
         self.custom_object_type = get_object_or_404(
             CustomObjectType, slug=custom_object_type
         )
-        model = self.get_model(self.custom_object_type)
+        model = self.custom_object_type.get_model_with_serializer()
         return model.objects.all()
 
     def get_filterset(self):
@@ -379,23 +371,23 @@ def get_extra_context(self, request):
 
 
 @register_model_view(CustomObject)
-class CustomObjectView(CustomObjectModelMixin, generic.ObjectView):
+class CustomObjectView(generic.ObjectView):
     template_name = "netbox_custom_objects/customobject.html"
 
     def get_queryset(self, request):
         custom_object_type = self.kwargs.get("custom_object_type", None)
         object_type = get_object_or_404(
             CustomObjectType, slug=custom_object_type
         )
-        model = self.get_model(object_type)
+        model = object_type.get_model_with_serializer()
         return model.objects.all()
 
     def get_object(self, **kwargs):
         custom_object_type = self.kwargs.get("custom_object_type", None)
         object_type = get_object_or_404(
             CustomObjectType, slug=custom_object_type
         )
-        model = self.get_model(object_type)
+        model = object_type.get_model_with_serializer()
         # Filter out custom_object_type from kwargs for the object lookup
         lookup_kwargs = {
             k: v for k, v in self.kwargs.items() if k != "custom_object_type"
@@ -422,7 +414,7 @@ def get_extra_context(self, request, instance):
 
 
 @register_model_view(CustomObject, "edit")
-class CustomObjectEditView(CustomObjectModelMixin, generic.ObjectEditView):
+class CustomObjectEditView(generic.ObjectEditView):
     template_name = "netbox_custom_objects/customobject_edit.html"
     form = None
     queryset = None
@@ -445,7 +437,7 @@ def get_object(self, **kwargs):
         object_type = get_object_or_404(
             CustomObjectType, slug=custom_object_type
         )
-        model = self.get_model(object_type)
+        model = object_type.get_model_with_serializer()
 
         if not self.kwargs.get("pk", None):
             # We're creating a new object
@@ -583,7 +575,7 @@ def custom_save(self, commit=True):
 
 
 @register_model_view(CustomObject, "delete")
-class CustomObjectDeleteView(CustomObjectModelMixin, generic.ObjectDeleteView):
+class CustomObjectDeleteView(generic.ObjectDeleteView):
     queryset = None
     object = None
     default_return_url = "plugins:netbox_custom_objects:customobject_list"
@@ -603,7 +595,7 @@ def get_object(self, **kwargs):
         object_type = get_object_or_404(
             CustomObjectType, slug=custom_object_type
         )
-        model = self.get_model(object_type)
+        model = object_type.get_model_with_serializer()
         return get_object_or_404(model.objects.all(), **self.kwargs)
 
     def get_return_url(self, request, obj=None):
@@ -624,7 +616,7 @@ def get_return_url(self, request, obj=None):
 
 
 @register_model_view(CustomObject, "bulk_edit", path="edit", detail=False)
-class CustomObjectBulkEditView(CustomObjectTableMixin, CustomObjectModelMixin, generic.BulkEditView):
+class CustomObjectBulkEditView(CustomObjectTableMixin, generic.BulkEditView):
     queryset = None
     custom_object_type = None
     table = None
@@ -643,7 +635,7 @@ def get_queryset(self, request):
         self.custom_object_type = CustomObjectType.objects.get(
             slug=custom_object_type
         )
-        model = self.get_model(self.custom_object_type)
+        model = self.custom_object_type.get_model_with_serializer()
         return model.objects.all()
 
     def get_form(self, queryset):
@@ -683,7 +675,7 @@ def get_form(self, queryset):
 
 
 @register_model_view(CustomObject, "bulk_delete", path="delete", detail=False)
-class CustomObjectBulkDeleteView(CustomObjectTableMixin, CustomObjectModelMixin, generic.BulkDeleteView):
+class CustomObjectBulkDeleteView(CustomObjectTableMixin, generic.BulkDeleteView):
     queryset = None
     custom_object_type = None
     table = None
@@ -701,12 +693,12 @@ def get_queryset(self, request):
         self.custom_object_type = CustomObjectType.objects.get(
             slug=custom_object_type
         )
-        model = self.get_model(self.custom_object_type)
+        model = self.custom_object_type.get_model_with_serializer()
         return model.objects.all()
 
 
 @register_model_view(CustomObject, "bulk_import", path="import", detail=False)
-class CustomObjectBulkImportView(CustomObjectModelMixin, generic.BulkImportView):
+class CustomObjectBulkImportView(generic.BulkImportView):
     queryset = None
     model_form = None
 
@@ -730,7 +722,7 @@ def get_queryset(self, request):
         self.custom_object_type = CustomObjectType.objects.get(
             name__iexact=custom_object_type
         )
-        model = self.get_model(self.custom_object_type)
+        model = self.custom_object_type.get_model_with_serializer()
         return model.objects.all()
 
     def get_model_form(self, queryset):
@@ -766,7 +758,7 @@ def get_model_form(self, queryset):
         return form
 
 
-class CustomObjectJournalView(ConditionalLoginRequiredMixin, CustomObjectModelMixin, View):
+class CustomObjectJournalView(ConditionalLoginRequiredMixin, View):
     """
     Custom journal view for CustomObject instances.
     Shows all journal entries for a custom object.
@@ -782,7 +774,7 @@ def get(self, request, custom_object_type, **kwargs):
         object_type = get_object_or_404(
             CustomObjectType, slug=custom_object_type
         )
-        model = self.get_model(object_type)
+        model = object_type.get_model_with_serializer()
 
         # Get the specific object
         lookup_kwargs = {k: v for k, v in kwargs.items() if k != "custom_object_type"}
@@ -838,7 +830,7 @@ def get(self, request, custom_object_type, **kwargs):
         )
 
 
-class CustomObjectChangeLogView(ConditionalLoginRequiredMixin, CustomObjectModelMixin, View):
+class CustomObjectChangeLogView(ConditionalLoginRequiredMixin, View):
     """
     Custom changelog view for CustomObject instances.
     Shows all changes made to a custom object.
@@ -854,7 +846,7 @@ def get(self, request, custom_object_type, **kwargs):
         object_type = get_object_or_404(
             CustomObjectType, slug=custom_object_type
         )
-        model = self.get_model(object_type)
+        model = object_type.get_model_with_serializer()
 
         # Get the specific object
         lookup_kwargs = {k: v for k, v in kwargs.items() if k != "custom_object_type"}