Add AIResource.contacts with full contact information (#564)

Author: PGijsbers

src/connectors/example/example_connector.py

@@ -1,12 +1,13 @@
 import json
 import pathlib
-from typing import Iterator, TypeVar
+from typing import Iterator, TypeVar, cast, Hashable
 
 from sqlmodel import SQLModel
 
 from connectors.abstract.resource_connector_on_start_up import ResourceConnectorOnStartUp
 from database.model.platform.platform_names import PlatformName
 from database.model.resource_read_and_create import resource_create
+from database.model.concept.concept import AIoDConcept
 
 RESOURCE = TypeVar("RESOURCE", bound=SQLModel)
 
@@ -31,6 +32,6 @@ def platform_name(self) -> PlatformName:
     def fetch(self, limit: int | None = None) -> Iterator[RESOURCE]:
         with open(self.json_path) as f:
             json_data = json.load(f)
-        pydantic_class = resource_create(self.resource_class)
+        pydantic_class = resource_create(cast(Hashable, self.resource_class))
         for json_item in json_data[:limit]:
             yield pydantic_class(**json_item)

src/database/model/agent/organisation.py

@@ -1,7 +1,6 @@
 from datetime import date
 from typing import Optional
 
-from sqlalchemy import Column, Integer, ForeignKey
 from sqlmodel import Field, Relationship
 
 from database.model.agent.agent import AgentBase, Agent

src/database/model/ai_resource/resource.py

@@ -36,6 +36,7 @@
     FindByIdentifierDeserializerList,
     FindByNameDeserializerList,
 )
+from database.model.resource_read_and_create import resource_read
 
 
 class AIResourceBase(AIoDConceptBase, metaclass=abc.ABCMeta):
@@ -80,6 +81,7 @@ class AIResource(AIResourceBase, AIoDConcept, metaclass=abc.ABCMeta):
     scientific_domain: list[ScientificDomain] = Relationship()  # type: ignore[valid-type]
 
     contact: list[Contact] = Relationship()
+    contacts: list[Contact] = Relationship(sa_relationship_kwargs=dict(viewonly=True))
     creator: list[Contact] = Relationship()
 
     media: list = Relationship(sa_relationship_kwargs={"cascade": "all, delete"})
@@ -188,6 +190,13 @@ class RelationshipConfig(AIoDConcept.RelationshipConfig):
             deserializer=FindByIdentifierDeserializerList(Contact),
             default_factory_pydantic=list,
         )
+
+        contacts: list[Contact] = ManyToMany(
+            description="Contact information corresponding to the identifiers found in `contact`.",
+            class_read=list[resource_read(Contact)],  # type: ignore
+            include_in_create=False,
+            default_factory_pydantic=list,
+        )
         creator: list[str] = ManyToMany(
             description="The identifiers of the contact information of the persons and/or "
             "organisations that created this resource.",
@@ -272,6 +281,7 @@ def update_relationships(cls, relationships: dict[str, Any]):
             to_identifier_type=str,
         )
         relationships["contact"].link_model = link_model_contact
+        relationships["contacts"].link_model = link_model_contact
         relationships["creator"].link_model = link_model_creator
 
         relationships["description"].sa_relationship_kwargs = dict(

src/database/model/resource_read_and_create.py

@@ -5,6 +5,7 @@
 request.
 """
 
+import functools
 from typing import Type, Tuple, TYPE_CHECKING
 
 from pydantic import create_model
@@ -57,6 +58,7 @@ def _get_field_definitions_create(
     }
 
 
+@functools.cache  # For Pydantic 'bug', see note at `resource_read`
 def resource_create(resource_class: Type["AIoDConcept"] | Type["Platform"]) -> Type[SQLModel]:
     """
     Create a SQLModel for a Create class of a resource. This Create class is a Pydantic class
@@ -77,6 +79,11 @@ def resource_create(resource_class: Type["AIoDConcept"] | Type["Platform"]) -> T
     return model
 
 
+# We cache this not for performance reason, but because if the model would be created multiple times,
+# this leads to a conflicting state in the Pydantic model map, erasing the older model.
+# Related to https://github.com/fastapi/fastapi/issues/4191 and might be fixed by upgrading to the
+# latest Pydantic version
+@functools.cache
 def resource_read(resource_class: Type["AIoDConcept"] | Type["Platform"]) -> Type[SQLModel]:
     """
     Create a SQLModel for a Read class of a resource. This Read class is a Pydantic class

src/tests/routers/resource_routers/test_router_organisation.py

@@ -28,6 +28,7 @@ def test_happy_path(
 
         body["member"] = [organisation.identifier]
         body["contact_details"] = contact.identifier
+        body["contact"] = [contact.identifier]
 
     response = client.post("/organisations", json=body, headers={"Authorization": "Fake token"})
     assert response.status_code == 200, response.json()
@@ -47,6 +48,15 @@ def test_happy_path(
     assert response_json["type"] == "research institute"
     assert response_json["member"] == body["member"]
     assert response_json["contact_details"] == body["contact_details"]
+    assert response_json["contacts"][0]["name"] == "Aaron Bar"
+    assert response_json["contacts"][0]["telephone"] == ["0032 xxxx xxxx"]
+    assert response_json["contacts"][0]["email"] == ["a@b.com"]
+    assert response_json["contacts"][0]["location"] == [
+        {
+            "address": {"country": "NED", "street": "Street Name 10", "postal_code": "1234AB"},
+            "geo": {"latitude": 37.42242, "longitude": -122.08585, "elevation_millimeters": 2000},
+        }
+    ]
 
     # response = client.delete("/organisations/1", headers={"Authorization": "Fake token"})
     # assert response.status_code == 200
@@ -63,3 +73,27 @@ def test_happy_path(
 
     response = client.delete(f"/organisations/{identifier}", headers={"Authorization": "Fake token"})
     assert response.status_code == 200, response.json()
+
+
+def test_ai_resource_contacts_field_is_ignored(
+        client: TestClient,
+        mocked_privileged_token: Mock,
+        organisation: Organisation,
+        contact: Contact,
+        body_agent: dict,
+        auto_publish: None,
+):
+    with DbSession() as session:
+        session.add(contact)
+        session.commit()
+        session.refresh(contact)
+
+    body = copy.copy(body_agent)
+    body["contacts"] = [contact.json()]
+    response = client.post("/organisations", json=body, headers={"Authorization": "Fake token"})
+    assert response.status_code == 200, response.json()
+    identifier = response.json()['identifier']
+
+    response = client.get(f"/organisations/{identifier}")
+    assert response.status_code == 200, response.json()
+    assert response.json()["contacts"] == []

src/tests/testutils/default_instances.py

@@ -99,6 +99,7 @@ def publication_factory(body_asset: dict) -> Callable[[], Publication]:
 def contact(body_concept, engine: Engine) -> Contact:
     body = copy.deepcopy(body_concept)
     body["email"] = ["a@b.com"]
+    body["name"] = "Aaron Bar"
     body["telephone"] = ["0032 XXXX XXXX"]
     body["location"] = [
         {