udata 9.1.2.dev30472__py2.py3-none-any.whl → 9.1.2.dev30483__py2.py3-none-any.whl

udata/api_fields.py

@@ -5,8 +5,17 @@ from bson import ObjectId
 
 import udata.api.fields as custom_restx_fields
 from udata.api import api
+from udata.mongo.engine import db
 from udata.mongo.errors import FieldValidationError
 
+lazy_reference = api.model(
+    "LazyReference",
+    {
+        "class": restx_fields.Raw(attribute=lambda ref: ref.document_type.__name__),
+        "id": restx_fields.Raw(attribute=lambda ref: ref.pk),
+    },
+)
+
 
 def convert_db_to_field(key, field, info={}):
     """
@@ -60,6 +69,10 @@ def convert_db_to_field(key, field, info={}):
         )
         constructor_read = lambda **kwargs: restx_fields.List(field_read, **kwargs)
         constructor_write = lambda **kwargs: restx_fields.List(field_write, **kwargs)
+    elif isinstance(
+        field, (mongo_fields.GenericReferenceField, mongoengine.fields.GenericLazyReferenceField)
+    ):
+        constructor = lambda **kwargs: restx_fields.Nested(lazy_reference, **kwargs)
     elif isinstance(field, mongo_fields.ReferenceField):
         # For reference we accept while writing a String representing the ID of the referenced model.
         # For reading, if the user supplied a `nested_fields` (RestX model), we use it to convert
@@ -289,8 +302,21 @@ def patch(obj, request):
             ):
                 # TODO `wrap_primary_key` do Mongo request, do a first pass to fetch all documents before calling it (to avoid multiple queries).
                 value = [wrap_primary_key(key, model_attribute.field, id) for id in value]
-            if isinstance(model_attribute, mongoengine.fields.ReferenceField):
+            elif isinstance(model_attribute, mongoengine.fields.ReferenceField):
                 value = wrap_primary_key(key, model_attribute, value)
+            elif isinstance(
+                model_attribute,
+                (
+                    mongoengine.fields.GenericReferenceField,
+                    mongoengine.fields.GenericLazyReferenceField,
+                ),
+            ):
+                value = wrap_primary_key(
+                    key,
+                    model_attribute,
+                    value["id"],
+                    document_type=db.resolve_model(value["class"]),
+                )
 
             info = getattr(model_attribute, "__additional_field_info__", {})
 
@@ -305,24 +331,39 @@ def patch(obj, request):
     return obj
 
 
-def wrap_primary_key(field_name: str, foreign_field: mongoengine.fields.ReferenceField, value: str):
+def wrap_primary_key(
+    field_name: str,
+    foreign_field: mongoengine.fields.ReferenceField | mongoengine.fields.GenericReferenceField,
+    value: str,
+    document_type: type = None,
+):
     """
     We need to wrap the `String` inside an `ObjectId` most of the time. If the foreign ID is a `String` we need to get
     a `DBRef` from the database.
 
     TODO: we only check the document reference if the ID is a `String` field (not in the case of a classic `ObjectId`).
     """
-    document_type = foreign_field.document_type()
-    id_field_name = document_type.__class__._meta["id_field"]
+    document_type = document_type or foreign_field.document_type().__class__
+    id_field_name = document_type._meta["id_field"]
 
-    id_field = getattr(document_type.__class__, id_field_name)
+    id_field = getattr(document_type, id_field_name)
 
     # Get the foreign document from MongoDB because the othewise it fails during read
     # Also useful to get a DBRef for non ObjectId references (see below)
-    foreign_document = document_type.__class__.objects(**{id_field_name: value}).first()
+    foreign_document = document_type.objects(**{id_field_name: value}).first()
     if foreign_document is None:
         raise FieldValidationError(field=field_name, message=f"Unknown reference '{value}'")
 
+    # GenericReferenceField only accepts document (not dbref / objectid)
+    if isinstance(
+        foreign_field,
+        (
+            mongoengine.fields.GenericReferenceField,
+            mongoengine.fields.GenericLazyReferenceField,
+        ),
+    ):
+        return foreign_document
+
     if isinstance(id_field, mongoengine.fields.ObjectIdField):
         return ObjectId(value)
     elif isinstance(id_field, mongoengine.fields.StringField):
@@ -336,5 +377,5 @@ def wrap_primary_key(field_name: str, foreign_field: mongoengine.fields.Referenc
         return foreign_document.to_dbref()
     else:
         raise ValueError(
-            f"Unknown ID field type {id_field.__class__} for {document_type.__class__} (ID field name is {id_field_name}, value was {value})"
+            f"Unknown ID field type {id_field.__class__} for {document_type} (ID field name is {id_field_name}, value was {value})"
         )

udata/core/reports/constants.py

@@ -1,4 +1,8 @@
+from udata.core.dataservices.models import Dataservice
 from udata.core.dataset.models import Dataset
+from udata.core.discussions.models import Discussion
+from udata.core.organization.models import Organization
+from udata.core.reuse.models import Reuse
 from udata.i18n import lazy_gettext as _
 
 REASON_PERSONAL_DATA = "personal_data"
@@ -25,4 +29,4 @@ def reports_reasons_translations() -> list:
 
 
 REPORT_REASONS_CHOICES: list[str] = [item["value"] for item in reports_reasons_translations()]
-REPORTABLE_MODELS = [Dataset]
+REPORTABLE_MODELS = [Dataset, Reuse, Discussion, Organization, Dataservice]

udata/core/reports/models.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 
-from mongoengine import NULLIFY, signals
+from bson import DBRef
+from mongoengine import DO_NOTHING, NULLIFY, signals
 
 from udata.api_fields import field, generate_fields
 from udata.core.user.api_fields import user_ref_fields
@@ -20,9 +21,13 @@ class Report(db.Document):
         allow_null=True,
     )
 
-    object_type = field(db.StringField(choices=[m.__name__ for m in REPORTABLE_MODELS]))
-    object_id = field(db.ObjectIdField())
-    object_deleted_at = field(
+    # Here we use the lazy version of `GenericReferenceField` because we could point to a
+    # non existant model (if it was deleted we want to keep the report data).
+    subject = field(
+        db.GenericLazyReferenceField(reverse_delete_rule=DO_NOTHING, choices=REPORTABLE_MODELS)
+    )
+
+    subject_deleted_at = field(
         db.DateTimeField(),
         allow_null=True,
         readonly=True,
@@ -42,15 +47,25 @@ class Report(db.Document):
 
     @classmethod
     def mark_as_deleted_soft_delete(cls, sender, document, **kwargs):
-        if document.deleted:
-            Report.objects(
-                object_type=sender.__name__, object_id=document.id, object_deleted_at=None
-            ).update(object_deleted_at=datetime.utcnow)
+        """
+        Called when updating a model (maybe updating the `deleted` date)
+        Some documents like Discussion do not have a `deleted` attribute.
+        """
+        if hasattr(document, "deleted") and document.deleted:
+            Report.objects(subject=document, subject_deleted_at=None).update(
+                subject_deleted_at=datetime.utcnow
+            )
 
-    def mark_as_deleted_hard_delete(cls, document, **kwargs):
+    @classmethod
+    def mark_as_deleted_hard_delete(cls, sender, document, **kwargs):
+        """
+        Call when really deleting a model from the database.
+        """
+        # Here we are forced to do a manual `DBRef(sender.__name__.lower(), document.id)`
+        # because the document doesn't exist anymore…
         Report.objects(
-            object_type=document.__class__.__name__, object_id=document.id, object_deleted_at=None
-        ).update(object_deleted_at=datetime.utcnow)
+            subject=DBRef(sender.__name__.lower(), document.id), subject_deleted_at=None
+        ).update(subject_deleted_at=datetime.utcnow)
 
 
 for model in REPORTABLE_MODELS:

udata/tests/api/test_reports_api.py

@@ -1,4 +1,5 @@
 from flask import url_for
+from mongoengine.base.datastructures import LazyReference
 
 from udata.core.dataset.factories import DatasetFactory
 from udata.core.dataset.models import Dataset
@@ -35,8 +36,10 @@ class ReportsAPITest(APITestCase):
         response = self.post(
             url_for("api.reports"),
             {
-                "object_type": "Dataset",
-                "object_id": illegal_dataset.id,
+                "subject": {
+                    "class": "Dataset",
+                    "id": illegal_dataset.id,
+                },
                 "message": "This is not appropriate",
                 "reason": REASON_ILLEGAL_CONTENT,
             },
@@ -49,8 +52,10 @@ class ReportsAPITest(APITestCase):
         response = self.post(
             url_for("api.reports"),
             {
-                "object_type": "Dataset",
-                "object_id": spam_dataset.id,
+                "subject": {
+                    "class": "Dataset",
+                    "id": spam_dataset.id,
+                },
                 "message": "This is spammy",
                 "reason": REASON_SPAM,
             },
@@ -59,14 +64,14 @@ class ReportsAPITest(APITestCase):
         self.assertEqual(Report.objects.count(), 2)
 
         reports: list[Report] = list(Report.objects())
-        self.assertEqual(Dataset.__name__, reports[0].object_type)
-        self.assertEqual(illegal_dataset.id, reports[0].object_id)
+        self.assertEqual(Dataset, reports[0].subject.document_type)
+        self.assertEqual(illegal_dataset.id, reports[0].subject.pk)
         self.assertEqual("This is not appropriate", reports[0].message)
         self.assertEqual(REASON_ILLEGAL_CONTENT, reports[0].reason)
         self.assertIsNone(reports[0].by)
 
-        self.assertEqual(Dataset.__name__, reports[1].object_type)
-        self.assertEqual(spam_dataset.id, reports[1].object_id)
+        self.assertEqual(Dataset, reports[1].subject.document_type)
+        self.assertEqual(spam_dataset.id, reports[1].subject.pk)
         self.assertEqual("This is spammy", reports[1].message)
         self.assertEqual(REASON_SPAM, reports[1].reason)
         self.assertEqual(user.id, reports[1].by.id)
@@ -75,27 +80,42 @@ class ReportsAPITest(APITestCase):
         self.assert204(response)
 
         reports[0].reload()
-        self.assertEqual(Dataset.__name__, reports[0].object_type)
-        self.assertEqual(illegal_dataset.id, reports[0].object_id)
+        self.assertEqual(Dataset, reports[0].subject.document_type)
+        self.assertEqual(illegal_dataset.id, reports[0].subject.pk)
         self.assertEqual("This is not appropriate", reports[0].message)
         self.assertEqual(REASON_ILLEGAL_CONTENT, reports[0].reason)
         self.assertIsNone(reports[0].by)
-        self.assertIsNotNone(reports[0].object_deleted_at)
+        self.assertIsNotNone(reports[0].subject_deleted_at)
 
         reports[1].reload()
-        self.assertEqual(Dataset.__name__, reports[1].object_type)
-        self.assertEqual(spam_dataset.id, reports[1].object_id)
+        self.assertEqual(Dataset, reports[1].subject.document_type)
+        self.assertEqual(spam_dataset.id, reports[1].subject.pk)
         self.assertEqual("This is spammy", reports[1].message)
         self.assertEqual(REASON_SPAM, reports[1].reason)
         self.assertEqual(user.id, reports[1].by.id)
-        self.assertIsNone(reports[1].object_deleted_at)
+        self.assertIsNone(reports[1].subject_deleted_at)
 
-        # We should take action on manual delete in the database too
         spam_dataset.delete()
 
         reports[1].reload()
-        self.assertIsNotNone(reports[1].object_deleted_at)
+        self.assertIsNotNone(reports[1].subject_deleted_at)
 
         response = self.get(url_for("api.reports"))
         self.assert200(response)
-        self.assertEqual(len(response.json["data"]), 2)
+
+        reports = response.json["data"]
+        self.assertEqual(len(reports), 2)
+
+        self.assertEqual("Dataset", reports[0]["subject"]["class"])
+        self.assertEqual(str(illegal_dataset.id), reports[0]["subject"]["id"])
+        self.assertEqual("This is not appropriate", reports[0]["message"])
+        self.assertEqual(REASON_ILLEGAL_CONTENT, reports[0]["reason"])
+        self.assertIsNone(reports[0]["by"])
+        self.assertIsNotNone(reports[0]["subject_deleted_at"])
+
+        self.assertEqual("Dataset", reports[1]["subject"]["class"])
+        self.assertEqual(str(spam_dataset.id), reports[1]["subject"]["id"])
+        self.assertEqual("This is spammy", reports[1]["message"])
+        self.assertEqual(REASON_SPAM, reports[1]["reason"])
+        self.assertEqual(str(user.id), reports[1]["by"]["id"])
+        self.assertIsNotNone(reports[1]["subject_deleted_at"])

{udata-9.1.2.dev30472.dist-info → udata-9.1.2.dev30483.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata
-Version: 9.1.2.dev30472
+Version: 9.1.2.dev30483
 Summary: Open data portal
 Home-page: https://github.com/opendatateam/udata
 Author: Opendata Team
@@ -143,6 +143,7 @@ It is collectively taken care of by members of the
 - Revamp CORS: remove flask-cors to always returns 204 on OPTIONS request [#3074](https://github.com/opendatateam/udata/pull/3074)
 - Update pinned dependencies according to project dependencies, without updating any project dependencies [#3089](https://github.com/opendatateam/udata/pull/3089)
 - Add "run" button to harvesters (configurable with `HARVEST_ENABLE_MANUAL_RUN`) [#3092](https://github.com/opendatateam/udata/pull/3092)
+- Move from `object_type` / `object_id` to `subject_type` / `subject_id` in reports API [#3094](https://github.com/opendatateam/udata/pull/3094)
 - Allow to report without being authenticated [#3096](https://github.com/opendatateam/udata/pull/3096)
 
 ## 9.1.1 (2024-07-16)

{udata-9.1.2.dev30472.dist-info → udata-9.1.2.dev30483.dist-info}/RECORD

@@ -1,7 +1,7 @@
 tasks/__init__.py,sha256=oZ9yTY3eyOXRbN18_83l1b4BpqjIBVqw-FqD1LFWGxo,8122
 tasks/helpers.py,sha256=0a9iXzVe2GC2f6ouFoXDfMGN2s1eu4urTUuM9CCTZP8,994
 udata/__init__.py,sha256=y6WWIlMmNt4ADXtwHIWm-Dzb-txi6Y8hxw0fqe5TJwU,101
-udata/api_fields.py,sha256=YRLHniJYoRRI6cNJNgB-0U9A049_g1yV-Tp5u8VcLQs,14148
+udata/api_fields.py,sha256=y9ZWNbIbG4HYIsfSypzE_QNGiHuTgnIBzONR5N45tm4,15437
 udata/app.py,sha256=lMxCLveZyMmaimkryDjD-VpHBC5OMEgd95VszM84y-8,7284
 udata/assets.py,sha256=jGxFWVu6JvDLK1SXBZC-rY-DGkGxguF3LFikOklyzdE,645
 udata/cors.py,sha256=QyhlcnkLo9SmJhgK3FRjLcD5YC-03bU514UVMAHfbSc,2995
@@ -164,8 +164,8 @@ udata/core/post/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 udata/core/post/tests/test_api.py,sha256=y4fXgjC0y9tqR4iOWHin9rADSPdo1BJjXJGilnqL23c,3946
 udata/core/reports/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/reports/api.py,sha256=wrHJempfYupq0etLWM-RPq6-f3LqXWw3hulnoPHb5v4,1376
-udata/core/reports/constants.py,sha256=g0c_Uj0qEQknj20mz_PrCp0EIu3a6dX5hHvg4YoqLwU,983
-udata/core/reports/models.py,sha256=a0Xfwt3T7lsTnGGRIv_PQmDcAZzYZx11MRVXYLra8Ys,1858
+udata/core/reports/constants.py,sha256=LRZSX3unyqZeB4yQjK3ws_hGbJcXYk4bu1Rhnhi5DEs,1235
+udata/core/reports/models.py,sha256=qgWXjiwMJ5w5uDdjM9K-f-h4mb-dJ8Che83MmIJ7pNg,2474
 udata/core/reuse/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/reuse/activities.py,sha256=mAdHhqqpUF5zSh4e5AEo0J7alc3RflTbudDaKOzyTQw,1406
 udata/core/reuse/api.py,sha256=zVck4XV6jm0A2tkL1bHQuW7fKkVE0LI_szsnmqnAPxY,10195
@@ -607,7 +607,7 @@ udata/tests/api/test_fields.py,sha256=OW85Z5MES5HeWOpapeem8OvR1cIcrqW-xMWpdZO4LZ
 udata/tests/api/test_follow_api.py,sha256=fccgVNfcqET221PPS3p7qzb9hpvbBBUGhV-l4UeOpyk,3352
 udata/tests/api/test_me_api.py,sha256=ZJKGH9fFv-4cSGcYAGd6IJA_PwPjVGIqWNy_DhFA8ms,13827
 udata/tests/api/test_organizations_api.py,sha256=5hBs7-gsMfy4IFsrLYyUMGyxhtCs71K4QvPFAXyDsz4,35049
-udata/tests/api/test_reports_api.py,sha256=ee_Hrcs-rpbdUlV80ITmyrhtIC2cfg7rSwwVb3uXJgk,3604
+udata/tests/api/test_reports_api.py,sha256=4BHpCxDOkmbxe2xd2qCd0xXUjdAqgom7PP9117V8Bds,4515
 udata/tests/api/test_reuses_api.py,sha256=v9RJcJ_fdR8dgnq6H7j58_7n83BhoFJJ9YOd7CJwsyw,16769
 udata/tests/api/test_swagger.py,sha256=eE6La9qdTYTIUFevRVPJgtj17Jq_8uOlsDwzCNR0LL8,760
 udata/tests/api/test_tags_api.py,sha256=MgSmKZeQ8L-fO-LwOGlDm_YN7lmEyvTpkDgaPiENHw8,2429
@@ -698,9 +698,9 @@ udata/translations/pt/LC_MESSAGES/udata.mo,sha256=yfwqLHV-_mGNaDklP7T0pQP4i1y__s
 udata/translations/pt/LC_MESSAGES/udata.po,sha256=E45ZRCW2bpedoWOztkgJ9gwBlg2L1pTcHmCXgqSdhT0,44979
 udata/translations/sr/LC_MESSAGES/udata.mo,sha256=w_x0mh_WagUuQ5QFweqHg5-HtDrsoyL66HVmUxrdR0U,28500
 udata/translations/sr/LC_MESSAGES/udata.po,sha256=LfaUQzhrfDClLdBo_U2erasp2XR1z1_V132cewvZ9C8,51548
-udata-9.1.2.dev30472.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
-udata-9.1.2.dev30472.dist-info/METADATA,sha256=JROSC0pBFhtzFFgA6_Ic_TpQyd8e7OKQbz9rrXj5zLM,126704
-udata-9.1.2.dev30472.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-udata-9.1.2.dev30472.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
-udata-9.1.2.dev30472.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
-udata-9.1.2.dev30472.dist-info/RECORD,,
+udata-9.1.2.dev30483.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
+udata-9.1.2.dev30483.dist-info/METADATA,sha256=opfzZHL_6Xo7XmPscPW7Qwr1tmJsrz1yiJZf--Wwy7Y,126849
+udata-9.1.2.dev30483.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+udata-9.1.2.dev30483.dist-info/entry_points.txt,sha256=3SKiqVy4HUqxf6iWspgMqH8d88Htk6KoLbG1BU-UddQ,451
+udata-9.1.2.dev30483.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
+udata-9.1.2.dev30483.dist-info/RECORD,,