Add organization name to client resolve response (#69)

Author: thomas-samoht

app/db/models/client.py

@@ -36,3 +36,7 @@ class ClientEntity(CommonColumns):
     source_id: Mapped[str | None] = mapped_column("source_id", String, nullable=True)
 
     organization: Mapped["OrganizationEntity"] = relationship(back_populates="clients", lazy="raise")
+
+    @property
+    def organization_name(self) -> str | None:
+        return self.organization.name if self.organization else None

app/db/repository/client.py

@@ -3,6 +3,7 @@
 
 from sqlalchemy import ColumnElement, and_, select, update
 from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.orm import joinedload
 
 from app.db.decorator import repository
 from app.db.models.client import ClientEntity
@@ -44,6 +45,7 @@ def get_by_credentials(self, common_name: str, oin: Oin, org_ura: UraNumber) ->
                     ClientEntity.deleted_at.is_(None),
                 )
             )
+            .options(joinedload(ClientEntity.organization))
         )
         return self.db_session.execute(stmt).scalar()
 

app/models/client.py

@@ -11,6 +11,7 @@
 OIN_DESCRIPTION = "The OIN of the client"
 SOURCE_ID_DESCRIPTION = "The optional source ID of the client"
 SCOPES_DESCRIPTION = "The space separated scopes granted to the client"
+ORGANIZATION_NAME_DESCRIPTION = "The name of the organization the client acts on behalf of"
 
 
 class ClientResolveRequest(BaseModel):
@@ -23,6 +24,7 @@ class ClientResolveResponse(BaseModel):
     model_config = ConfigDict(from_attributes=True)
     scopes: str | None = Field(default=None, description=SCOPES_DESCRIPTION)
     source_id: str | None = Field(default=None, description=SOURCE_ID_DESCRIPTION)
+    organization_name: str | None = Field(default=None, description=ORGANIZATION_NAME_DESCRIPTION)
 
 
 class ClientCreate(BaseModel):

tests/conftest.py

@@ -131,14 +131,16 @@ def make_client_entity(
     source_id: str | None = None,
     scopes: str | None = None,
     deleted_at: datetime | None = None,
+    org_entity: OrganizationEntity | None = None,
 ) -> ClientEntity:
     return ClientEntity(
         id=id or uuid4(),
-        organization_id=organization_id or uuid4(),
+        organization_id=organization_id or (org_entity.id if org_entity else uuid4()),
         oin=oin,
         common_name=common_name,
         source_id=source_id,
         scopes=scopes,
         created_at=FIXED_CREATED_AT,
         deleted_at=deleted_at,
+        organization=org_entity,
     )

tests/db/test_client.py

@@ -7,7 +7,7 @@
 from app.db.models.client import ClientEntity
 from app.db.repository.client import ClientRepository
 from app.models.ura import UraNumber
-from tests.conftest import TEST_COMMON_NAME, TEST_OIN, TEST_REGISTER_ID
+from tests.conftest import TEST_COMMON_NAME, TEST_OIN, TEST_ORG_NAME, TEST_REGISTER_ID
 
 
 def test_add_one(
@@ -167,6 +167,7 @@ def test_get_by_credentials_matches_via_organization_register_id(
         )
         assert result is not None
         assert result.id == client_entity.id
+        assert result.organization.name == TEST_ORG_NAME
 
 
 def test_get_by_credentials_unknown_org_ura_returns_none(

tests/routers/test_resolve.py

@@ -3,7 +3,7 @@
 import pytest
 from fastapi.testclient import TestClient
 
-from tests.conftest import TEST_REGISTER_ID, VALID_OIN, make_client_entity
+from tests.conftest import TEST_REGISTER_ID, VALID_OIN, make_client_entity, make_organization_entity
 
 RESOLVE = "/clients/resolve"
 
@@ -16,25 +16,29 @@ def _body(**overrides: object) -> dict[str, object]:
 
 @pytest.mark.parametrize("scopes", ["read write", "read", ""])
 def test_resolve_returns_scopes_and_source_id(api: TestClient, mock_client_service: MagicMock, scopes: str) -> None:
-    mock_client_service.resolve.return_value = make_client_entity(scopes=scopes, source_id="source-1")
+    org_entity = make_organization_entity(name="Test Organization")
+    client_entity = make_client_entity(scopes=scopes, source_id="source-1", org_entity=org_entity)
+    mock_client_service.resolve.return_value = client_entity
 
     response = api.post(RESOLVE, json=_body())
 
     assert response.status_code == 200
-    assert response.json() == {"scopes": scopes, "source_id": "source-1"}
+    assert response.json() == {"scopes": scopes, "source_id": "source-1", "organization_name": "Test Organization"}
     call = mock_client_service.resolve.call_args
     assert str(call.kwargs["oin"]) == str(VALID_OIN)
     assert call.kwargs["common_name"] == "Client"
     assert str(call.kwargs["org_ura"]) == str(TEST_REGISTER_ID)
 
 
 def test_resolve_returns_no_source_id_when_absent(api: TestClient, mock_client_service: MagicMock) -> None:
-    mock_client_service.resolve.return_value = make_client_entity(scopes="read", source_id=None)
+    org_entity = make_organization_entity(name="Test Organization")
+    client_entity = make_client_entity(scopes="read", source_id=None, org_entity=org_entity)
+    mock_client_service.resolve.return_value = client_entity
 
     response = api.post(RESOLVE, json=_body())
 
     assert response.status_code == 200
-    assert response.json() == {"scopes": "read"}
+    assert response.json() == {"scopes": "read", "organization_name": "Test Organization"}
 
 
 def test_resolve_unknown_client_returns_404(api: TestClient, mock_client_service: MagicMock) -> None: