Improve ResourceXResource field and related names #11869 (#11976)

Co-authored-by: Galen <[email protected]>

Author: jacobtylerwalls

arches/app/models/migrations/11869_rename_resxres_fields.py

@@ -0,0 +1,128 @@
+# Generated by Django 5.2 on 2025-04-15 09:08
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("models", "11873_model_ordering"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="resourcexresource",
+            old_name="nodeid",
+            new_name="node",
+        ),
+        migrations.RenameField(
+            model_name="resourcexresource",
+            old_name="resourceinstanceidfrom",
+            new_name="from_resource",
+        ),
+        migrations.RenameField(
+            model_name="resourcexresource",
+            old_name="resourceinstancefrom_graphid",
+            new_name="from_resource_graph",
+        ),
+        migrations.RenameField(
+            model_name="resourcexresource",
+            old_name="resourceinstanceidto",
+            new_name="to_resource",
+        ),
+        migrations.RenameField(
+            model_name="resourcexresource",
+            old_name="resourceinstanceto_graphid",
+            new_name="to_resource_graph",
+        ),
+        migrations.RenameField(
+            model_name="resourcexresource",
+            old_name="tileid",
+            new_name="tile",
+        ),
+        migrations.AlterField(
+            model_name="resourcexresource",
+            name="node",
+            field=models.ForeignKey(
+                blank=True,
+                db_column="nodeid",
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="resxres",
+                to="models.node",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="resourcexresource",
+            name="from_resource",
+            field=models.ForeignKey(
+                blank=True,
+                db_column="resourceinstanceidfrom",
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="from_resxres",
+                to="models.resourceinstance",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="resourcexresource",
+            name="from_resource_graph",
+            field=models.ForeignKey(
+                blank=True,
+                db_column="resourceinstancefrom_graphid",
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="from_resxres",
+                to="models.graphmodel",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="resourcexresource",
+            name="to_resource",
+            field=models.ForeignKey(
+                blank=True,
+                db_column="resourceinstanceidto",
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="to_resxres",
+                to="models.resourceinstance",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="resourcexresource",
+            name="to_resource_graph",
+            field=models.ForeignKey(
+                blank=True,
+                db_column="resourceinstanceto_graphid",
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="to_resxres",
+                to="models.graphmodel",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="resourcexresource",
+            name="tile",
+            field=models.ForeignKey(
+                blank=True,
+                db_column="tileid",
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="resxres",
+                to="models.tilemodel",
+            ),
+        ),
+        migrations.RemoveField(
+            model_name="resourcexresource",
+            name="datestarted",
+        ),
+        migrations.RemoveField(
+            model_name="resourcexresource",
+            name="dateended",
+        ),
+    ]

arches/app/models/models.py

@@ -1241,93 +1241,91 @@ class ResourceXResource(SaveSupportsBlindOverwriteMixin, models.Model):
     resourcexid = models.UUIDField(
         primary_key=True, default=uuid.uuid4, db_default=UUID4()
     )
-    resourceinstanceidfrom = models.ForeignKey(
+    from_resource = models.ForeignKey(
         "ResourceInstance",
         db_column="resourceinstanceidfrom",
         blank=True,
         null=True,
-        related_name="resxres_resource_instance_ids_from",
+        related_name="from_resxres",
         on_delete=models.CASCADE,
         db_constraint=False,
     )
-    resourceinstancefrom_graphid = models.ForeignKey(
+    from_resource_graph = models.ForeignKey(
         "GraphModel",
         db_column="resourceinstancefrom_graphid",
         blank=True,
         null=True,
-        related_name="resxres_resource_instance_fom_graph_id",
+        related_name="from_resxres",
         on_delete=models.CASCADE,
         db_constraint=False,
     )
-    resourceinstanceidto = models.ForeignKey(
+    to_resource = models.ForeignKey(
         "ResourceInstance",
         db_column="resourceinstanceidto",
         blank=True,
         null=True,
-        related_name="resxres_resource_instance_ids_to",
+        related_name="to_resxres",
         on_delete=models.CASCADE,
         db_constraint=False,
     )
-    resourceinstanceto_graphid = models.ForeignKey(
+    to_resource_graph = models.ForeignKey(
         "GraphModel",
         db_column="resourceinstanceto_graphid",
         blank=True,
         null=True,
-        related_name="resxres_resource_instance_to_graph_id",
+        related_name="to_resxres",
         on_delete=models.CASCADE,
         db_constraint=False,
     )
 
     notes = models.TextField(blank=True, null=True)
     relationshiptype = models.TextField(blank=True, null=True)
     inverserelationshiptype = models.TextField(blank=True, null=True)
-    tileid = models.ForeignKey(
+    tile = models.ForeignKey(
         "TileModel",
         db_column="tileid",
         blank=True,
         null=True,
-        related_name="resxres_tile_id",
+        related_name="resxres",
         on_delete=models.CASCADE,
     )
-    nodeid = models.ForeignKey(
+    node = models.ForeignKey(
         "Node",
         db_column="nodeid",
         blank=True,
         null=True,
-        related_name="resxres_node_id",
+        related_name="resxres",
         on_delete=models.CASCADE,
     )
-    datestarted = models.DateField(blank=True, null=True)
-    dateended = models.DateField(blank=True, null=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
 
     def delete(self, *args, **kwargs):
         # update the resource-instance tile by removing any references to a deleted resource
         deletedResourceId = kwargs.pop("deletedResourceId", None)
-        if deletedResourceId and self.tileid and self.nodeid:
+        if deletedResourceId and self.tile and self.node:
             newTileData = []
-            data = self.tileid.data[str(self.nodeid_id)]
+            data = self.tile.data[str(self.node_id)]
             if type(data) != list:
                 data = [data]
             for relatedresourceItem in data:
                 if relatedresourceItem:
                     if relatedresourceItem["resourceId"] != str(deletedResourceId):
                         newTileData.append(relatedresourceItem)
-            self.tileid.data[str(self.nodeid_id)] = newTileData
-            self.tileid.save()
+            self.tile.data[str(self.node_id)] = newTileData
+            self.tile.save()
 
         super(ResourceXResource, self).delete()
 
     def save(self, **kwargs):
         # during package/csv load the ResourceInstance models are not always available
         try:
-            self.resourceinstancefrom_graphid = self.resourceinstanceidfrom.graph
+            self.from_resource_graph = self.from_resource.graph
         except:
             pass
 
         try:
-            self.resourceinstanceto_graphid = self.resourceinstanceidto.graph
+            self.to_resource_graph = self.to_resource.graph
         except:
             pass
 

arches/app/models/resource.py

@@ -713,8 +713,8 @@ def delete(self, user={}, index=True, transaction_id=None):
 
         if permit_deletion is True:
             for related_resource in models.ResourceXResource.objects.filter(
-                Q(resourceinstanceidfrom=self.resourceinstanceid)
-                | Q(resourceinstanceidto=self.resourceinstanceid)
+                Q(from_resource_id=self.resourceinstanceid)
+                | Q(to_resource_id=self.resourceinstanceid)
             ):
                 related_resource.delete(deletedResourceId=self.resourceinstanceid)
 
@@ -875,17 +875,17 @@ def get_relations(
             limit,
             resourceinstance_graphid=None,
         ):
-            final_query = Q(resourceinstanceidfrom_id=resourceinstanceid) | Q(
-                resourceinstanceidto_id=resourceinstanceid
+            final_query = Q(from_resource_id=resourceinstanceid) | Q(
+                to_resource_id=resourceinstanceid
             )
 
             if resourceinstance_graphid:
-                to_graph_id_filter = Q(
-                    resourceinstancefrom_graphid_id=str(self.graph_id)
-                ) & Q(resourceinstanceto_graphid_id=resourceinstance_graphid)
+                to_graph_id_filter = Q(from_resource_graph_id=str(self.graph_id)) & Q(
+                    to_resource_graph_id=resourceinstance_graphid
+                )
                 from_graph_id_filter = Q(
-                    resourceinstancefrom_graphid_id=resourceinstance_graphid
-                ) & Q(resourceinstanceto_graphid_id=str(self.graph_id))
+                    from_resource_graph_id=resourceinstance_graphid
+                ) & Q(to_resource_graph_id=str(self.graph_id))
                 final_query = final_query & (to_graph_id_filter | from_graph_id_filter)
 
             return (
@@ -916,8 +916,8 @@ def get_relations(
         )
         all_resource_ids = set()
         for relation in resource_relations["relations"]:
-            all_resource_ids.add(str(relation.resourceinstanceidto_id))
-            all_resource_ids.add(str(relation.resourceinstanceidfrom_id))
+            all_resource_ids.add(str(relation.to_resource_id))
+            all_resource_ids.add(str(relation.from_resource_id))
         exclusive_set, filtered_instances = get_filtered_instances(
             user, se, resources=list(all_resource_ids)
         )
@@ -926,13 +926,13 @@ def get_relations(
 
         for relation in resource_relations["relations"]:
             relation = model_to_dict(relation)
-            resourceid_to = relation["resourceinstanceidto"]
-            resourceid_from = relation["resourceinstanceidfrom"]
-            resourceinstanceto_graphid = relation["resourceinstanceto_graphid"]
-            resourceinstancefrom_graphid = relation["resourceinstancefrom_graphid"]
+            to_resource = relation["to_resource"]
+            from_resource = relation["from_resource"]
+            to_resource_graph = relation["to_resource_graph"]
+            from_resource_graph = relation["from_resource_graph"]
 
-            resourceid_to_permission = str(resourceid_to) not in filtered_instances
-            resourceid_from_permission = str(resourceid_from) not in filtered_instances
+            resourceid_to_permission = str(to_resource) not in filtered_instances
+            resourceid_from_permission = str(from_resource) not in filtered_instances
 
             if exclusive_set:
                 resourceid_to_permission = not (resourceid_to_permission)
@@ -941,8 +941,8 @@ def get_relations(
             if (
                 resourceid_to_permission
                 and resourceid_from_permission
-                and str(resourceinstanceto_graphid) in readable_graphids
-                and str(resourceinstancefrom_graphid) in readable_graphids
+                and str(to_resource_graph) in readable_graphids
+                and str(from_resource_graph) in readable_graphids
             ):
                 permitted_relation_dicts.append(relation)
             else:
@@ -991,8 +991,8 @@ def get_relations(
             )
 
             ret["resource_relationships"].append(relation)
-            instanceids.add(str(resourceid_to))
-            instanceids.add(str(resourceid_from))
+            instanceids.add(str(to_resource))
+            instanceids.add(str(from_resource))
 
         if str(self.resourceinstanceid) in instanceids:
             instanceids.remove(str(self.resourceinstanceid))
@@ -1009,8 +1009,8 @@ def get_relations(
                     models.ResourceInstance.objects.filter(pk__in=related_resource_ids)
                     .annotate(
                         total_relations=(
-                            Count("resxres_resource_instance_ids_from", distinct=True)
-                            + Count("resxres_resource_instance_ids_to", distinct=True)
+                            Count("from_resxres", distinct=True)
+                            + Count("to_resxres", distinct=True)
                         )
                     )
                     .only("pk")

arches/app/utils/data_management/resources/formats/csvfile.py

@@ -305,15 +305,13 @@ def write_resource_relations(self, file_name):
             dest = StringIO()
             csv_header = [
                 "resourcexid",
-                "resourceinstanceidfrom",
-                "resourceinstanceidto",
+                "from_resource",
+                "to_resource",
                 "relationshiptype",
-                "resourceinstancefrom_graphid",
-                "resourceinstanceto_graphid",
-                "nodeid",
-                "tileid",
-                "datestarted",
-                "dateended",
+                "from_resource_graph",
+                "to_resource_graph",
+                "node",
+                "tile",
                 "notes",
             ]
             csvwriter = csv.DictWriter(dest, delimiter=",", fieldnames=csv_header)
@@ -322,19 +320,10 @@ def write_resource_relations(self, file_name):
             relations_file.append({"name": csv_name, "outputfile": dest})
 
             relations = ResourceXResource.objects.filter(
-                Q(resourceinstanceidfrom__in=resourceids)
-                | Q(resourceinstanceidto__in=resourceids),
-                tileid__isnull=True,
+                Q(from_resource_id__in=resourceids) | Q(to_resource_id__in=resourceids),
+                tile__isnull=True,
             ).values(*csv_header)
             for relation in relations:
-                relation["datestarted"] = (
-                    relation["datestarted"]
-                    if relation["datestarted"] is not None
-                    else ""
-                )
-                relation["dateended"] = (
-                    relation["dateended"] if relation["dateended"] is not None else ""
-                )
                 relation["notes"] = (
                     relation["notes"] if relation["notes"] is not None else ""
                 )