refactor: lift entity references up to 'records-resources'

* also bump the records-resources dependency

Author: max-moser

invenio_requests/config.py

@@ -1,15 +1,15 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (C) 2021 CERN.
-# Copyright (C) 2021 TU Wien.
+# Copyright (C) 2021 - 2022 TU Wien.
 #
 # Invenio-Requests is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
 
 """Invenio module for generic and customizable requests."""
 
-from .customizations import DefaultRequestType
-from .resolvers.default import UserResolver
+from invenio_records_resources.references.resolvers import UserResolver
+
 from .services.permissions import PermissionPolicy
 
 REQUESTS_PERMISSION_POLICY = PermissionPolicy

invenio_requests/customizations/base/request_types.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2021 TU Wien.
+# Copyright (C) 2021 - 2022 TU Wien.
 # Copyright (C) 2021 CERN.
 #
 # Invenio-Requests is free software; you can redistribute it and/or modify
@@ -16,6 +16,7 @@
 
 import base32_lib as base32
 import marshmallow as ma
+from invenio_records_resources.services.references import EntityReferenceBaseSchema
 
 from ...proxies import current_requests
 
@@ -99,12 +100,10 @@ class RequestType:
     def _create_marshmallow_schema(cls):
         """Create a marshmallow schema for this request type."""
         # Avoid circular imports
-        from invenio_requests.services.schemas import (
-            EntityReferenceBaseSchema as RefBaseSchema,
-        )
         from invenio_requests.services.schemas import RequestSchema
 
         # The reference fields always need to be added
+        RefBaseSchema = EntityReferenceBaseSchema
         additional_fields = {
             "created_by": ma.fields.Nested(
                 RefBaseSchema.create_from_dict(cls.allowed_creator_ref_types),

invenio_requests/records/api.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2021 TU Wien.
+# Copyright (C) 2021 - 2022 TU Wien.
 # Copyright (C) 2021 Northwestern University.
 #
 # Invenio-Requests is free software; you can redistribute it and/or modify
@@ -17,16 +17,16 @@
 from invenio_records_resources.records.systemfields import IndexField
 from sqlalchemy.orm.exc import MultipleResultsFound, NoResultFound
 
-from ..customizations.base.states import RequestState
+from ..customizations.base.states import RequestState as State
 from .dumpers import CalculatedFieldDumperExt
 from .models import RequestEventModel, RequestMetadata
 from .systemfields import (
+    EntityReferenceField,
     ExpiredStateCalculatedField,
     IdentityField,
-    ReferencedEntityField,
+    RequestStateCalculatedField,
     RequestStatusField,
     RequestTypeField,
-    StateCalculatedField,
 )
 from .systemfields.entity_reference import (
     check_allowed_creators,
@@ -71,22 +71,22 @@ class Request(Record):
     custom request actions are registered.
     """
 
-    topic = ReferencedEntityField("topic", check_allowed_topics)
+    topic = EntityReferenceField("topic", check_allowed_topics)
     """Topic (associated object) of the request."""
 
-    created_by = ReferencedEntityField("created_by", check_allowed_creators)
+    created_by = EntityReferenceField("created_by", check_allowed_creators)
     """The entity that created the request."""
 
-    receiver = ReferencedEntityField("receiver", check_allowed_receivers)
+    receiver = EntityReferenceField("receiver", check_allowed_receivers)
     """The entity that will receive the request."""
 
     status = RequestStatusField("status")
     """The current status of the request."""
 
-    is_closed = StateCalculatedField("status", expected_state=RequestState.CLOSED)
+    is_closed = RequestStateCalculatedField("status", expected_state=State.CLOSED)
     """Whether or not the current status can be seen as a 'closed' state."""
 
-    is_open = StateCalculatedField("status", expected_state=RequestState.OPEN)
+    is_open = RequestStateCalculatedField("status", expected_state=State.OPEN)
     """Whether or not the current status can be seen as an 'open' state."""
 
     expires_at = ModelField("expires_at")
@@ -142,8 +142,8 @@ class RequestEvent(Record):
     check_referenced = partial(
         check_allowed_references,
         lambda r: True,  # for system process for now
-        lambda r: ["user"]  # only users for now
+        lambda r: ["user"],  # only users for now
     )
 
-    created_by = ReferencedEntityField("created_by", check_referenced)
+    created_by = EntityReferenceField("created_by", check_referenced)
     """Who created the event."""

invenio_requests/records/jsonschemas/__init__.py

@@ -6,7 +6,3 @@
 # it under the terms of the MIT License; see LICENSE file for more details.
 
 """JSONSchema directory."""
-
-# TODO it'd be nice to re-use the #agent $ref, but that's defined in
-#      rdm-records
-#      -> move that $ref to a more generic package? records-resources maybe?

invenio_requests/records/jsonschemas/request_events/event-v1.0.0.json

@@ -8,7 +8,7 @@
       "$ref": "local://definitions-v1.0.0.json#/$schema"
     },
     "created_by": {
-      "$ref": "local://requests/definitions-v1.0.0.json#/entity_reference"
+      "$ref": "local://definitions-v1.0.0.json#/entity_reference"
     },
     "id": {
       "$ref": "local://definitions-v1.0.0.json#/identifier"

invenio_requests/records/jsonschemas/requests/definitions-v1.0.0.json

@@ -3,16 +3,6 @@
   "$id": "local://requests/definitions-v1.0.0.json",
   "type": "object",
   "additionalProperties": false,
-  "entity_reference": {
-    "description": "Reference to an entity, with the type as key and ID as value",
-    "type": ["object", "null"],
-    "additionalProperties": false,
-    "patternProperties": {
-      "^[a-z_]+$": {
-        "type": "string"
-      }
-    }
-  },
   "anything": {
     "description": "A very general schema",
     "type": "object",

invenio_requests/records/jsonschemas/requests/request-v1.0.0.json

@@ -26,13 +26,13 @@
       "$ref": "local://requests/definitions-v1.0.0.json#/anything"
     },
     "topic": {
-      "$ref": "local://requests/definitions-v1.0.0.json#/entity_reference"
+      "$ref": "local://definitions-v1.0.0.json#/entity_reference"
     },
     "receiver": {
-      "$ref": "local://requests/definitions-v1.0.0.json#/entity_reference"
+      "$ref": "local://definitions-v1.0.0.json#/entity_reference"
     },
     "created_by": {
-      "$ref": "local://requests/definitions-v1.0.0.json#/entity_reference"
+      "$ref": "local://definitions-v1.0.0.json#/entity_reference"
     },
     "@v": {
       "type": "string"

invenio_requests/records/systemfields/__init__.py

@@ -1,23 +1,24 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2021 TU Wien.
+# Copyright (C) 2021 - 2022 TU Wien.
 #
 # Invenio-Requests is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
 
 """Systemfields for request records."""
 
-from .calculated import ExpiredStateCalculatedField, StateCalculatedField
-from .entity_reference import ReferencedEntityField
+from .entity_reference import EntityReferenceField
+from .expired_state import ExpiredStateCalculatedField
 from .identity import IdentityField
+from .request_state import RequestStateCalculatedField
 from .request_type import RequestTypeField
 from .status import RequestStatusField
 
 __all__ = (
     "ExpiredStateCalculatedField",
     "IdentityField",
-    "ReferencedEntityField",
+    "EntityReferenceField",
+    "RequestStateCalculatedField",
     "RequestStatusField",
     "RequestTypeField",
-    "StateCalculatedField",
 )

invenio_requests/records/systemfields/calculated/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2021 TU Wien.
+# Copyright (C) 2021 - 2022 TU Wien.
 #
 # Invenio-Requests is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
@@ -9,87 +9,17 @@
 
 from functools import partial
 
-from invenio_records.systemfields import SystemField
+from invenio_records_resources.records.systemfields.entity_reference import (
+    ReferencedEntityField,
+    check_allowed_references,
+)
 
-from ...resolvers.base import EntityProxy
 from ...resolvers.registry import ResolverRegistry
 
-
-class ReferencedEntityField(SystemField):
-    """Systemfield for managing the request type."""
-
-    def __init__(self, key=None, reference_check_func=None):
-        """Constructor."""
-        super().__init__(key=key)
-        self._ref_check = reference_check_func
-
-    def _check_reference(self, instance, ref_dict):
-        """Check if the reference is accepted."""
-        if self._ref_check is None:
-            return True
-
-        return self._ref_check(instance, ref_dict)
-
-    def set_obj(self, instance, obj):
-        """Set the referenced entity."""
-        # allow the setter to be used with a reference dict,
-        # an entity proxy, or an actual entity
-        if not isinstance(obj, dict):
-            if isinstance(obj, EntityProxy):
-                obj = obj.reference_dict
-            elif obj is not None:
-                obj = ResolverRegistry.reference_entity(obj, raise_=True)
-
-        # check if the reference is allowed
-        if not self._check_reference(instance, obj):
-            raise ValueError(f"Invalid reference for '{self.key}': {obj}")
-
-        # set dictionary key and reset the cache
-        self.set_dictkey(instance, obj)
-        self._set_cache(instance, None)
-
-    def __set__(self, record, value):
-        """Set the referenced entity."""
-        assert record is not None
-        self.set_obj(record, value)
-
-    def obj(self, instance):
-        """Get the referenced entity as an `EntityProxy`."""
-        obj = self._get_cache(instance)
-        if obj is not None:
-            return obj
-
-        reference_dict = self.get_dictkey(instance)
-        if reference_dict is None:
-            # TODO maybe use a `NullProxy` instead?
-            return None
-
-        obj = ResolverRegistry.resolve_entity_proxy(reference_dict)
-        self._set_cache(instance, obj)
-        return obj
-
-    def __get__(self, record, owner=None):
-        """Get the referenced entity as an `EntityProxy`."""
-        if record is None:
-            # access by class
-            return self
-
-        return self.obj(record)
-
-
-def check_allowed_references(get_allows_none, get_allowed_types, request, ref_dict):
-    """Check the reference according to rules specific to requests.
-
-    In case the ``ref_dict`` is ``None``, it will check if this is allowed for the
-    reference at hand.
-    Otherwise, it will check if the reference dict's key (i.e. the TYPE) is allowed.
-    """
-    if ref_dict is None:
-        return get_allows_none(request)
-
-    ref_type = list(ref_dict.keys())[0]
-    return ref_type in get_allowed_types(request)
-
+EntityReferenceField = partial(
+    ReferencedEntityField, resolver_registry=ResolverRegistry
+)
+"""An opinionated ReferenceEntityField with set ResolverRegistry."""
 
 check_allowed_creators = partial(
     check_allowed_references,

invenio_requests/records/systemfields/calculated/base.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2021 TU Wien.
+# Copyright (C) 2021 - 2022 TU Wien.
 #
 # Invenio-Requests is free software; you can redistribute it and/or modify
 # it under the terms of the MIT License; see LICENSE file for more details.
@@ -11,8 +11,7 @@
 from datetime import datetime
 
 import pytz
-
-from .base import CalculatedField
+from invenio_records_resources.records.systemfields.calculated import CalculatedField
 
 
 class ExpiredStateCalculatedField(CalculatedField):