Merge pull request #150 from mapswipe/feat/project-asset-links

Attach AOI geometry to project

Author: susilnem

apps/project/graphql/types/types.py

@@ -157,6 +157,8 @@ class ProjectType(UserResourceTypeMixin, ProjectExportAssetTypeMixin, FirebasePu
     team: ContributorTeamType | None
     is_private: strawberry.auto
     required_results: strawberry.auto
+    aoi_geometry_input_asset: ProjectAssetType | None
+    project_type_specific_output_asset: ProjectAssetType | None
 
     @strawberry_django.field(
         description="No. of unique contributors in this project",

apps/project/migrations/0024_rename_project_type_specific_output_project_project_type_specific_output_asset.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.5 on 2025-09-04 01:48
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('project', '0023_alter_projectasset_file'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='project',
+            old_name='project_type_specific_output',
+            new_name='project_type_specific_output_asset',
+        ),
+    ]

apps/project/migrations/0025_project_aoi_geometry_input_asset.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.2.5 on 2025-09-04 02:48
+
+import django.db.models.deletion
+from django.db import migrations, models
+from utils.common import recursively_find_value
+
+
+def set_aoi_asset(apps, schema_editor):
+    Model = apps.get_model('project', 'Project')
+    for obj in Model.cte_objects.all():
+        aoi_id = recursively_find_value(obj.project_type_specifics, "aoi_geometry")
+        if aoi_id:
+            obj.aoi_geometry_input_asset = int(aoi_id)
+            obj.save(update_fields=['aoi_geometry_input_asset'])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('project', '0024_rename_project_type_specific_output_project_project_type_specific_output_asset'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='project',
+            name='aoi_geometry_input_asset',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='project.projectasset'),
+        ),
+        migrations.RunPython(set_aoi_asset, reverse_code=migrations.RunPython.noop),
+    ]

apps/project/models.py

@@ -337,8 +337,14 @@ class Project(UserResource, FirebasePushResource):
     # Also, used in SQL queries
     project_type_specifics = models.JSONField(blank=True, null=True)
 
-    # FIXME(tnagorra): Do we need to reference this to project table?
-    project_type_specific_output = models.ForeignKey["ProjectAsset | None", "ProjectAsset | None"](
+    aoi_geometry_input_asset = models.ForeignKey["ProjectAsset | None", "ProjectAsset | None"](
+        "project.ProjectAsset",
+        related_name="+",
+        blank=True,
+        null=True,
+        on_delete=models.SET_NULL,
+    )
+    project_type_specific_output_asset = models.ForeignKey["ProjectAsset | None", "ProjectAsset | None"](
         "project.ProjectAsset",
         related_name="+",
         blank=True,
@@ -511,6 +517,7 @@ def input_type_enum(self):
 
     # Type hints
     project_id: int
+    id: int
 
 
 class ProjectTaskGroup(FirebasePushResource):

apps/project/serializers.py

@@ -15,7 +15,7 @@
 from apps.contributor.models import ContributorTeam
 from apps.project.firebase.push import FirebaseOrganizationPush
 from apps.tutorial.models import Tutorial
-from project_types.store import get_project_property
+from project_types.store import get_project_property, get_project_type_handler
 from utils.asset_types.models import AoiGeometryAssetProperty, ObjectImageAssetProperty
 from utils.common import clean_up_none_keys
 from utils.graphql.drf import handle_pydantic_validation_error
@@ -76,7 +76,6 @@ class ProjectUpdateSerializer(UserResourceSerializer[Project]):
     class Meta:  # type: ignore[reportIncompatibleVariableOverride]
         model = Project
         fields = (
-            "project_type",
             "topic",
             "region",
             "project_number",
@@ -156,14 +155,7 @@ def _validate_project_instruction(self, attrs: dict[str, typing.Any]):
     def _validate_project_type_specifics(self, attrs: dict[str, typing.Any]):
         assert self.instance is not None
 
-        project_type = attrs.get("project_type") or self.instance.project_type_enum
-        if project_type is None:
-            raise serializers.ValidationError(
-                {
-                    "project_type": gettext("Project type is required."),
-                },
-            )
-
+        project_type = self.instance.project_type_enum
         project_type_label = ProjectTypeEnum.get_display(project_type)
 
         project_property = get_project_property(project_type)
@@ -221,6 +213,18 @@ def validate(self, attrs: dict[str, typing.Any]):
         self._validate_project_type_specifics(attrs)
         return super().validate(attrs)
 
+    @typing.override
+    def update(self, instance: Project, validated_data: dict[typing.Any, typing.Any]):
+        proj = super().update(instance, validated_data)
+
+        # NOTE: We only need to attach aoi_geometry_input_asset if project_type_specifics is defined
+        if proj.project_type_specifics:
+            project_handler = get_project_type_handler(proj.project_type_enum)(proj)
+            proj.aoi_geometry_input_asset = project_handler.get_aoi_geometry_asset()
+            proj.save(update_fields=["aoi_geometry_input_asset"])
+
+        return proj
+
 
 # NOTE: Make sure this matches with the strawberry Input ./graphql/inputs.py
 class ProcessedProjectSerializer(UserResourceSerializer[Project]):

apps/project/tests/mutation_test.py

@@ -244,6 +244,9 @@ class Mutation:
                 tutorial {
                   id
                 }
+                aoiGeometryInputAsset {
+                  id
+                }
               }
             }
           }
@@ -685,7 +688,7 @@ def test_project_update(self, mock_requests):
             project_instruction="Buildings",
             additional_info_url="https://hi-there/about.html",
             description="The new **project** from hi-there.",
-            project_type_specifics=None,
+            project_type_specifics={},
         )
 
         project_data = {
@@ -724,6 +727,7 @@ def test_project_update(self, mock_requests):
                 clientId=latest_project.client_id,
                 projectType=self.genum(ProjectTypeEnum.FIND),
                 requestingOrganizationId=self.gID(latest_project.requesting_organization.pk),
+                aoiGeometryInputAsset=None,
                 requestingOrganization=dict(
                     id=self.gID(latest_project.requesting_organization.pk),
                     name=latest_project.requesting_organization.name,
@@ -915,6 +919,8 @@ def test_project_update(self, mock_requests):
 
         latest_project.refresh_from_db()
         assert latest_project.image_id == int(image_asset["id"])
+        assert latest_project.aoi_geometry_input_asset
+        assert latest_project.aoi_geometry_input_asset.id == int(aoi_geometry_asset["id"])
         assert latest_project.project_type_specifics == {
             "zoom_level": 15,
             "aoi_geometry": aoi_geometry_asset["id"],
@@ -1336,6 +1342,8 @@ def test_project_compare(self, mock_requests):
         assert latest_project.created_by_id == self.user.pk
         assert latest_project.modified_by_id == self.user.pk
         assert latest_project.image_id == int(image_asset["id"])
+        assert latest_project.aoi_geometry_input_asset
+        assert latest_project.aoi_geometry_input_asset.id == int(aoi_geometry_asset["id"])
         assert latest_project.project_type_specifics == {
             "aoi_geometry": aoi_geometry_asset["id"],
             "zoom_level": 15,
@@ -1629,6 +1637,8 @@ def test_project_street(self, mock_requests):
         assert latest_project.modified_by_id == self.user.pk
         assert latest_project.image_id == int(image_asset["id"])
         assert latest_project.project_type_specifics is not None
+        assert latest_project.aoi_geometry_input_asset
+        assert latest_project.aoi_geometry_input_asset.id == int(aoi_geometry_asset["id"])
 
         street_project.StreetProjectProperty.model_validate(
             latest_project.project_type_specifics,

project_types/base/project.py

@@ -86,6 +86,9 @@ def __init_subclass__(cls, **kwargs):
         super().__init_subclass__(**kwargs)
         cls._inheritance_checks()
 
+    def get_aoi_geometry_asset(self) -> ProjectAsset | None:
+        return None
+
     def analyze_groups(self):
         # Update number_of_tasks
         self.project.update_processing_status(Project.ProcessingStatus.ANALYZING_GROUPS_AND_TASK, True)

project_types/street/project.py

@@ -71,17 +71,23 @@ def __init__(self, project: Project):
         if typing.TYPE_CHECKING:
             assert project.project_type == ProjectTypeEnum.STREET, f"{type(self)} is defined for STREET"
 
+    @typing.override
+    def get_aoi_geometry_asset(self) -> ProjectAsset | None:
+        return ProjectAsset.usable_objects().get(
+            id=int(self.project_type_specifics.aoi_geometry),
+            type=ProjectAsset.Type.INPUT,
+            input_type=ProjectAssetInputTypeEnum.AOI_GEOMETRY,
+            project_id=self.project.pk,
+        )
+
     @typing.override
     def validate(self) -> Grouping[StreetFeature]:
         """Validate project before creating groups."""
         self.project.update_processing_status(Project.ProcessingStatus.VALIDATING_GEOMETRY, True)
 
-        aoi_asset = ProjectAsset.usable_objects().get(
-            id=self.project_type_specifics.aoi_geometry,
-            type=AssetTypeEnum.INPUT,
-            input_type=ProjectAssetInputTypeEnum.AOI_GEOMETRY,
-            project_id=self.project.pk,
-        )
+        aoi_asset = self.project.aoi_geometry_input_asset
+        if not aoi_asset:
+            raise Exception("Could not find AOI geometry asset")
 
         with aoi_asset.file.open() as aoi_file:
             aoi_geojson = json.loads(aoi_file.read())
@@ -203,8 +209,8 @@ def get_feature(task: ProjectTask):
             created_by=self.project.modified_by,
             modified_by=self.project.modified_by,
         )
-        self.project.project_type_specific_output = asset
-        self.project.save(update_fields=("project_type_specific_output",))
+        self.project.project_type_specific_output_asset = asset
+        self.project.save(update_fields=("project_type_specific_output_asset",))
 
     @typing.override
     def get_max_time_spend_percentile(self) -> float:

project_types/tile_map_service/base/project.py

@@ -8,7 +8,7 @@
 from django.conf import settings
 from django.contrib.gis.geos import GEOSGeometry
 from django.core.files.base import ContentFile
-from pydantic import BaseModel, ValidationInfo, model_validator
+from pydantic import BaseModel
 from pyfirebase_mapswipe import extended_models as firebase_ext_models
 from pyfirebase_mapswipe import models as firebase_models
 from ulid import ULID
@@ -39,29 +39,6 @@ class TileMapServiceProjectProperty(base_project.BaseProjectProperty):
     tile_server_property: RasterTileServerConfig
     aoi_geometry: custom_fields.PydanticId
 
-    @model_validator(mode="after")
-    def check_aoi_geometry_exists(self, info: ValidationInfo) -> typing.Self:
-        if not isinstance(info.context, dict):
-            # Skipping validation in case context is not defined
-            return self
-
-        project_id = info.context.get("project_id")
-        asset_exists = (
-            ProjectAsset.usable_objects()
-            .filter(
-                id=self.aoi_geometry,
-                type=AssetTypeEnum.INPUT,
-                input_type=ProjectAssetInputTypeEnum.AOI_GEOMETRY,
-                project_id=project_id,
-            )
-            .exists()
-        )
-
-        # FIXME(tnagorra): Handle error
-        if not asset_exists:
-            raise ValueError(f"ProjectAsset with id {self.aoi_geometry} is invalid or does not exist.")
-        return self
-
 
 class TileMapServiceProjectTaskGroupProperty(base_project.BaseProjectTaskGroupProperty):
     x_max: int
@@ -92,6 +69,15 @@ class TileMapServiceBaseProject[
     def __init__(self, project: Project):
         super().__init__(project)
 
+    @typing.override
+    def get_aoi_geometry_asset(self) -> ProjectAsset | None:
+        return ProjectAsset.usable_objects().get(
+            id=int(self.project_type_specifics.aoi_geometry),
+            type=ProjectAsset.Type.INPUT,
+            input_type=ProjectAssetInputTypeEnum.AOI_GEOMETRY,
+            project_id=self.project.pk,
+        )
+
     @typing.override
     def post_create_groups(self):
         # NOTE: Create a geojson from the tasks (useful for tutorial creation)
@@ -142,8 +128,8 @@ def get_feature(task: ProjectTask):
             created_by=self.project.modified_by,
             modified_by=self.project.modified_by,
         )
-        self.project.project_type_specific_output = asset
-        self.project.save(update_fields=("project_type_specific_output",))
+        self.project.project_type_specific_output_asset = asset
+        self.project.save(update_fields=("project_type_specific_output_asset",))
 
         # TODO(thenav56): Calculate centroid, bounding box, etc.
         # TODO(thenav56): Calculate: total_area, time_spent_max_allowed
@@ -222,13 +208,9 @@ def validate(self):
         """Validate project before creating groups."""
         self.project.update_processing_status(Project.ProcessingStatus.VALIDATING_GEOMETRY, True)
 
-        aoi_asset = ProjectAsset.usable_objects().get(
-            id=self.project_type_specifics.aoi_geometry,
-            type=AssetTypeEnum.INPUT,
-            input_type=ProjectAssetInputTypeEnum.AOI_GEOMETRY,
-            mimetype=AssetMimetypeEnum.GEOJSON,
-            project_id=self.project.pk,
-        )
+        aoi_asset = self.project.aoi_geometry_input_asset
+        if not aoi_asset:
+            raise Exception("Could not find AOI geometry asset")
 
         extension = Path(aoi_asset.file.name).suffix
         with tempfile.NamedTemporaryFile(suffix=extension, dir=settings.TEMP_DIR) as temp_file:

project_types/validate/project.py

@@ -124,6 +124,20 @@ class ValidateProject(
     def __init__(self, project: Project):
         super().__init__(project)
 
+    @typing.override
+    def get_aoi_geometry_asset(self) -> ProjectAsset | None:
+        if self.project_type_specifics.object_source.source_type != ValidateObjectSourceTypeEnum.AOI_GEOJSON_FILE:
+            return None
+        if not self.project_type_specifics.object_source.aoi_geometry:
+            return None
+
+        return ProjectAsset.usable_objects().get(
+            id=int(self.project_type_specifics.object_source.aoi_geometry),
+            type=ProjectAsset.Type.INPUT,
+            input_type=ProjectAssetInputTypeEnum.AOI_GEOMETRY,
+            project_id=self.project.pk,
+        )
+
     def _process_polygons(self, geojson_data: dict[str, Any]) -> list[ValidFeature]:
         """We only want polygon and multipolygon features."""
         try:
@@ -164,12 +178,9 @@ def _validate_aoi_geojson_file(self):
         if self.project_type_specifics.object_source.ohsome_filter is None:
             raise Exception("Ohsome filter is missing for validate geojson file")
 
-        aoi_asset = ProjectAsset.usable_objects().get(
-            id=self.project_type_specifics.object_source.aoi_geometry,
-            type=AssetTypeEnum.INPUT,
-            input_type=ProjectAssetInputTypeEnum.AOI_GEOMETRY,
-            project_id=self.project.pk,
-        )
+        aoi_asset = self.project.aoi_geometry_input_asset
+        if not aoi_asset:
+            raise Exception("Could not find AOI geometry asset")
 
         with aoi_asset.file.open() as aoi_file:
             aoi_geojson = json.loads(aoi_file.read())
@@ -355,8 +366,8 @@ def get_feature(task: ProjectTask):
             created_by=self.project.modified_by,
             modified_by=self.project.modified_by,
         )
-        self.project.project_type_specific_output = asset
-        self.project.save(update_fields=("project_type_specific_output",))
+        self.project.project_type_specific_output_asset = asset
+        self.project.save(update_fields=("project_type_specific_output_asset",))
 
     @typing.override
     def get_max_time_spend_percentile(self) -> float: