Refactor to remove CustomObjectRelations and store object IDs in data for performance

bctiemann · bctiemann · commit 58c7ad2c94ac · 2025-04-09T18:12:31.000-04:00
diff --git a/netbox_custom_objects/api/serializers.py b/netbox_custom_objects/api/serializers.py
@@ -1,4 +1,5 @@
 from django.contrib.contenttypes.models import ContentType
+from django.db.models import Model, QuerySet
 from rest_framework import serializers
 from rest_framework.exceptions import ValidationError
 
@@ -103,10 +104,10 @@ def get_display(self, obj):
         return f'{obj.custom_object_type}: {obj.name}'
 
     def validate(self, attrs):
-        self.relation_fields = {}
-        object_field_types = [CustomFieldTypeChoices.TYPE_OBJECT, CustomFieldTypeChoices.TYPE_MULTIOBJECT]
-        for field in attrs['custom_object_type'].fields.filter(type__in=object_field_types):
-            self.relation_fields[field.name] = attrs['data'].pop(field.name, None)
+        # self.relation_fields = {}
+        # object_field_types = [CustomFieldTypeChoices.TYPE_OBJECT, CustomFieldTypeChoices.TYPE_MULTIOBJECT]
+        # for field in attrs['custom_object_type'].fields.filter(type__in=object_field_types):
+        #     self.relation_fields[field.name] = attrs['data'].pop(field.name, None)
         return super().validate(attrs)
 
     def update_relation_fields(self, instance):
@@ -132,24 +133,29 @@ def update_relation_fields(self, instance):
 
     def create(self, validated_data):
         instance = super().create(validated_data)
-        self.update_relation_fields(instance)
+        # self.update_relation_fields(instance)
         return instance
 
     def update(self, instance, validated_data):
         instance = super().update(instance, validated_data)
-        self.update_relation_fields(instance)
+        # self.update_relation_fields(instance)
         return instance
 
     def get_field_data(self, obj):
         result = {}
         for field_name, value in obj.fields.items():
-            field = obj.custom_object_type.fields.get(name=field_name)
-            if field.type in [CustomFieldTypeChoices.TYPE_OBJECT, CustomFieldTypeChoices.TYPE_MULTIOBJECT]:
-                serializer = get_serializer_for_model(field.model_class)
+            if isinstance(value, Model) or isinstance(value, QuerySet):
+                # serializer = get_serializer_for_model(field.model_class)
+                if isinstance(value, QuerySet):
+                    serializer = get_serializer_for_model(value.model)
+                    many = True
+                else:
+                    serializer = get_serializer_for_model(value._meta.model)
+                    many = False
                 context = {'request': self.context['request']}
-                result[field.name] = serializer(value, nested=True, context=context, many=field.many).data
+                result[field_name] = serializer(value, nested=True, context=context, many=many).data
                 continue
-            result[field_name] = obj.get_field_value(field_name)
+            result[field_name] = obj.data.get(field_name)
         return result
 
 
diff --git a/netbox_custom_objects/migrations/0001_initial.py b/netbox_custom_objects/migrations/0001_initial.py
@@ -0,0 +1,102 @@
+# Generated by Django 5.2b1 on 2025-04-07 20:21
+
+import django.core.validators
+import django.db.models.deletion
+import re
+import taggit.managers
+import utilities.json
+import utilities.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('core', '0012_job_object_type_optional'),
+        ('extras', '0123_journalentry_kind_default'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CustomObjectType',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('name', models.CharField(max_length=100, unique=True)),
+                ('slug', models.SlugField(max_length=100, unique=True)),
+                ('description', models.TextField(blank=True)),
+                ('schema', models.JSONField(blank=True, default=dict)),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'verbose_name': 'Custom Object Type',
+            },
+        ),
+        migrations.CreateModel(
+            name='CustomObject',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('name', models.CharField(max_length=100, unique=True)),
+                ('data', models.JSONField(blank=True, default=dict)),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+                ('custom_object_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='custom_objects', to='netbox_custom_objects.customobjecttype')),
+            ],
+            options={
+                'verbose_name': 'Custom Object',
+            },
+        ),
+        migrations.CreateModel(
+            name='CustomObjectTypeField',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('type', models.CharField(default='text', max_length=50)),
+                ('name', models.CharField(max_length=50, validators=[django.core.validators.RegexValidator(flags=re.RegexFlag['IGNORECASE'], message='Only alphanumeric characters and underscores are allowed.', regex='^[a-z0-9_]+$'), django.core.validators.RegexValidator(flags=re.RegexFlag['IGNORECASE'], inverse_match=True, message='Double underscores are not permitted in custom field names.', regex='__')])),
+                ('label', models.CharField(blank=True, max_length=50)),
+                ('group_name', models.CharField(blank=True, max_length=50)),
+                ('description', models.CharField(blank=True, max_length=200)),
+                ('required', models.BooleanField(default=False)),
+                ('unique', models.BooleanField(default=False)),
+                ('search_weight', models.PositiveSmallIntegerField(default=1000)),
+                ('filter_logic', models.CharField(default='loose', max_length=50)),
+                ('default', models.JSONField(blank=True, null=True)),
+                ('related_object_filter', models.JSONField(blank=True, null=True)),
+                ('weight', models.PositiveSmallIntegerField(default=100)),
+                ('validation_minimum', models.BigIntegerField(blank=True, null=True)),
+                ('validation_maximum', models.BigIntegerField(blank=True, null=True)),
+                ('validation_regex', models.CharField(blank=True, max_length=500, validators=[utilities.validators.validate_regex])),
+                ('ui_visible', models.CharField(default='always', max_length=50)),
+                ('ui_editable', models.CharField(default='yes', max_length=50)),
+                ('is_cloneable', models.BooleanField(default=False)),
+                ('comments', models.TextField(blank=True)),
+                ('choice_set', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='choices_for_object_type', to='extras.customfieldchoiceset')),
+                ('custom_object_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='fields', to='netbox_custom_objects.customobjecttype')),
+                ('related_object_type', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='core.objecttype')),
+            ],
+            options={
+                'verbose_name': 'custom object type field',
+                'verbose_name_plural': 'custom object type fields',
+                'ordering': ['group_name', 'weight', 'name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='CustomObjectRelation',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('object_id', models.PositiveIntegerField(db_index=True)),
+                ('custom_object', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='netbox_custom_objects.customobject')),
+                ('field', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='relations', to='netbox_custom_objects.customobjecttypefield')),
+            ],
+        ),
+        migrations.AddConstraint(
+            model_name='customobjecttypefield',
+            constraint=models.UniqueConstraint(fields=('name', 'custom_object_type'), name='netbox_custom_objects_customobjecttypefield_unique_name'),
+        ),
+    ]
diff --git a/netbox_custom_objects/models.py b/netbox_custom_objects/models.py
@@ -174,18 +174,15 @@ def custom_field_data(self):
     def fields(self):
         result = {}
         for field in self.custom_object_type.fields.all():
-            result[field.name] = self.get_field_value(field.name)
+            result[field.name] = self.get_field_value(field)
         return result
 
-    def get_field_value(self, field_name):
-        custom_object_type_field = self.custom_object_type.fields.get(name=field_name)
-        if custom_object_type_field.type in [CustomFieldTypeChoices.TYPE_OBJECT, CustomFieldTypeChoices.TYPE_MULTIOBJECT]:
-            object_ids = CustomObjectRelation.objects.filter(
-                custom_object=self, field=custom_object_type_field
-            ).values_list('object_id', flat=True)
-            field_objects = custom_object_type_field.model_class.objects.filter(pk__in=object_ids)
-            return field_objects if custom_object_type_field.many else field_objects.first()
-        return self.data.get(field_name)
+    def get_field_value(self, field):
+        if field.type == CustomFieldTypeChoices.TYPE_OBJECT:
+            return field.model_class.objects.filter(pk=self.data.get(field.name))
+        if field.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT:
+            return field.model_class.objects.filter(pk__in=self.data.get(field.name) or [])
+        return self.data.get(field.name)
 
     def get_absolute_url(self):
         return reverse('plugins:netbox_custom_objects:customobject', args=[self.pk])
@@ -423,7 +420,7 @@ def many(self):
         return self.type in ['multiobject', 'multiselect']
 
     def get_child_relations(self, instance):
-        return self.relations.filter(custom_object=instance)
+        return instance.get_field_value(self)
 
     def get_absolute_url(self):
         return reverse('plugins:netbox_custom_objects:customobjecttype', args=[self.custom_object_type.pk])
diff --git a/netbox_custom_objects/templates/netbox_custom_objects/customobject.html b/netbox_custom_objects/templates/netbox_custom_objects/customobject.html
@@ -41,7 +41,7 @@ <h5 class="card-header">{% trans "Custom Objects" %}</h5>
                 <td>
                   {% if field.type == 'object' %}
                     {% with field_values=object|get_child_relations:field %}
-                      {{ field_values.first.instance|linkify }}
+                      {{ field_values.first|linkify }}
                     {% endwith %}
                   {% else %}
                     {{ object|get_field_value:field }}
@@ -67,8 +67,8 @@ <h2 class="card-header">{{ field }}</h2>
                 <table class="table table-hover attr-table">
                   {% for relation in field_values.all %}
                     <tr>
-                        <th scope="row">{{ relation.instance|linkify }}</th>
-                        <td>{{ relation.object_id }}</td>
+                        <th scope="row">{{ relation|linkify }}</th>
+                        <td>{{ relation.id }}</td>
                     </tr>
                   {% endfor %}
                 </table>
diff --git a/netbox_custom_objects/templates/netbox_custom_objects/customobjecttype.html b/netbox_custom_objects/templates/netbox_custom_objects/customobjecttype.html
@@ -94,7 +94,7 @@ <h2 class="card-header">Custom Objects</h2>
                         {% if field.is_single_value %}
                             {% if field.type == 'object' %}
                                 {% with instance|get_child_relations:field as relations %}
-                                    <td>{{ relations.first.instance|linkify }}</td>
+                                    <td>{{ relations.first|linkify }}</td>
                                 {% endwith %}
                             {% else %}
                                 <td>{{ instance|get_field_value:field }}</td>
