studio/docs
Archived
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

✨(backend) add depth, path and numchild to serialized document

Browse Source 
This information is useful for the frontend to display the document
tree structure and is cheap to expose.
This commit is contained in:
Samuel Paccoud - DINUM
2024-12-17 17:53:05 +01:00
committed by Anthony LC
parent d073a9c9b3
commit 4333b46901
4 changed files with 48 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/backend/core/api/serializers.py
View File

@@ -156,10 +156,13 @@ class ListDocumentSerializer(BaseResourceSerializer):
"abilities", "abilities",
"created_at", "created_at",
"creator", "creator",
"depth",
"is_favorite", "is_favorite",
"link_role", "link_role",
"link_reach", "link_reach",
"nb_accesses", "nb_accesses",
"numchild",
"path",
"title", "title",
"updated_at", "updated_at",
] ]
@@ -168,10 +171,13 @@ class ListDocumentSerializer(BaseResourceSerializer):
"abilities", "abilities",
"created_at", "created_at",
"creator", "creator",
"depth",
"is_favorite", "is_favorite",
"link_role", "link_role",
"link_reach", "link_reach",
"nb_accesses", "nb_accesses",
"numchild",
"path",
"updated_at", "updated_at",
] ]
@@ -189,10 +195,13 @@ class DocumentSerializer(ListDocumentSerializer):
"content", "content",
"created_at", "created_at",
"creator", "creator",
"depth",
"is_favorite", "is_favorite",
"link_role", "link_role",
"link_reach", "link_reach",
"nb_accesses", "nb_accesses",
"numchild",
"path",
"title", "title",
"updated_at", "updated_at",
] ]
@@ -201,10 +210,13 @@ class DocumentSerializer(ListDocumentSerializer):
"abilities", "abilities",
"created_at", "created_at",
"creator", "creator",
"depth",
"is_favorite", "is_favorite",
"link_role", "link_role",
"link_reach", "link_reach",
"nb_accesses", "nb_accesses",
"numchild",
"path",
"updated_at", "updated_at",
] ]

3
src/backend/core/tests/documents/test_api_documents_list.py
View File

@@ -63,10 +63,13 @@ def test_api_documents_list_format():
"abilities": document.get_abilities(user), "abilities": document.get_abilities(user),
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 1,
"is_favorite": True, "is_favorite": True,
"link_reach": document.link_reach, "link_reach": document.link_reach,
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 3, "nb_accesses": 3,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }

27
src/backend/core/tests/documents/test_api_documents_retrieve.py
View File

@@ -44,10 +44,13 @@ def test_api_documents_retrieve_anonymous_public_standalone():
"content": document.content, "content": document.content,
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 1,
"is_favorite": False, "is_favorite": False,
"link_reach": "public", "link_reach": "public",
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 0, "nb_accesses": 0,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -91,10 +94,13 @@ def test_api_documents_retrieve_anonymous_public_parent():
"content": document.content, "content": document.content,
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 3,
"is_favorite": False, "is_favorite": False,
"link_reach": document.link_reach, "link_reach": document.link_reach,
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 0, "nb_accesses": 0,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -171,10 +177,13 @@ def test_api_documents_retrieve_authenticated_unrelated_public_or_authenticated(
"content": document.content, "content": document.content,
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 1,
"is_favorite": False, "is_favorite": False,
"link_reach": reach, "link_reach": reach,
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 0, "nb_accesses": 0,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -225,10 +234,13 @@ def test_api_documents_retrieve_authenticated_public_or_authenticated_parent(rea
"content": document.content, "content": document.content,
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 3,
"is_favorite": False, "is_favorite": False,
"link_reach": document.link_reach, "link_reach": document.link_reach,
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 0, "nb_accesses": 0,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -329,10 +341,13 @@ def test_api_documents_retrieve_authenticated_related_direct():
"content": document.content, "content": document.content,
"creator": str(document.creator.id), "creator": str(document.creator.id),
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"depth": 1,
"is_favorite": False, "is_favorite": False,
"link_reach": document.link_reach, "link_reach": document.link_reach,
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 2, "nb_accesses": 2,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -383,10 +398,13 @@ def test_api_documents_retrieve_authenticated_related_parent():
"content": document.content, "content": document.content,
"creator": str(document.creator.id), "creator": str(document.creator.id),
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"depth": 3,
"is_favorite": False, "is_favorite": False,
"link_reach": "restricted", "link_reach": "restricted",
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 2, "nb_accesses": 2,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -529,10 +547,13 @@ def test_api_documents_retrieve_authenticated_related_team_members(
"content": document.content, "content": document.content,
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 1,
"is_favorite": False, "is_favorite": False,
"link_reach": "restricted", "link_reach": "restricted",
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 5, "nb_accesses": 5,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -585,10 +606,13 @@ def test_api_documents_retrieve_authenticated_related_team_administrators(
"content": document.content, "content": document.content,
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 1,
"is_favorite": False, "is_favorite": False,
"link_reach": "restricted", "link_reach": "restricted",
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 5, "nb_accesses": 5,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }
@@ -642,10 +666,13 @@ def test_api_documents_retrieve_authenticated_related_team_owners(
"content": document.content, "content": document.content,
"created_at": document.created_at.isoformat().replace("+00:00", "Z"), "created_at": document.created_at.isoformat().replace("+00:00", "Z"),
"creator": str(document.creator.id), "creator": str(document.creator.id),
"depth": 1,
"is_favorite": False, "is_favorite": False,
"link_reach": "restricted", "link_reach": "restricted",
"link_role": document.link_role, "link_role": document.link_role,
"nb_accesses": 5, "nb_accesses": 5,
"numchild": 0,
"path": document.path,
"title": document.title, "title": document.title,
"updated_at": document.updated_at.isoformat().replace("+00:00", "Z"), "updated_at": document.updated_at.isoformat().replace("+00:00", "Z"),
} }

6
src/backend/core/tests/documents/test_api_documents_update.py
View File

@@ -158,8 +158,11 @@ def test_api_documents_update_anonymous_or_authenticated_unrelated(
"accesses", "accesses",
"created_at", "created_at",
"creator", "creator",
"depth",
"link_reach", "link_reach",
"link_role", "link_role",
"numchild",
"path",
]: ]:
assert value == old_document_values[key] assert value == old_document_values[key]
elif key == "updated_at": elif key == "updated_at":
@@ -269,9 +272,12 @@ def test_api_documents_update_authenticated_editor_administrator_or_owner(
"id", "id",
"created_at", "created_at",
"creator", "creator",
"depth",
"link_reach", "link_reach",
"link_role", "link_role",
"nb_accesses", "nb_accesses",
"numchild",
"path",
]: ]:
assert value == old_document_values[key] assert value == old_document_values[key]
elif key == "updated_at": elif key == "updated_at":