Merge pull request #48 from mts-ai/fix-duplicates-in-list-response

Fix duplicated entities in list response

Author: mahenzon

docs/changelog.rst

@@ -2,6 +2,21 @@ Changelog
 #########
 
 
+**2.3.2**
+*********
+
+Duplicated entities in response fix
+=======================================
+* fix duplicates in list response `#48 <https://github.com/mts-ai/FastAPI-JSONAPI/pull/48>`_
+
+
+Authors
+"""""""
+
+* `@CosmoV`_
+* `@mahenzon`_
+
+
 **2.3.1**
 *********
 

fastapi_jsonapi/data_layers/sqla_orm.py

@@ -9,6 +9,7 @@
 from sqlalchemy.orm import joinedload, selectinload
 from sqlalchemy.orm.attributes import InstrumentedAttribute
 from sqlalchemy.orm.collections import InstrumentedList
+from sqlalchemy.sql import column, distinct
 
 from fastapi_jsonapi import BadRequest
 from fastapi_jsonapi.data_layers.base import BaseDataLayer
@@ -270,7 +271,8 @@ async def get_collection_count(self, query: "Select", qs: QueryStringManager, vi
         if self.disable_collection_count is True:
             return self.default_collection_count
 
-        return (await self.session.execute(select(func.count()).select_from(query.subquery()))).scalar_one()
+        count_query = select(func.count(distinct(column("id")))).select_from(query.subquery())
+        return (await self.session.execute(count_query)).scalar_one()
 
     async def get_collection(self, qs: QueryStringManager, view_kwargs: Optional[dict] = None) -> Tuple[int, list]:
         """
@@ -299,7 +301,7 @@ async def get_collection(self, qs: QueryStringManager, view_kwargs: Optional[dic
 
         query = self.paginate_query(query, qs.pagination)
 
-        collection = (await self.session.execute(query)).scalars().all()
+        collection = (await self.session.execute(query)).unique().scalars().all()
 
         collection = await self.after_get_collection(collection, qs, view_kwargs)
 

tests/test_api/test_api_sqla_with_includes.py

@@ -1958,6 +1958,55 @@ async def test_filter_with_nested_conditions(
             "meta": {"count": 3, "totalPages": 1},
         }
 
+    async def test_join_by_relationships_does_not_duplicating_response_entities(
+        self,
+        app: FastAPI,
+        async_session: AsyncSession,
+        client: AsyncClient,
+        user_1: User,
+        user_1_post: PostComment,
+    ):
+        text = fake.sentence()
+        comment_1 = PostComment(
+            text=text,
+            post_id=user_1_post.id,
+            author_id=user_1.id,
+        )
+        comment_2 = PostComment(
+            text=text,
+            post_id=user_1_post.id,
+            author_id=user_1.id,
+        )
+        async_session.add_all([comment_1, comment_2])
+        await async_session.commit()
+
+        params = {
+            "filter": dumps(
+                [
+                    {
+                        "name": "posts.comments.text",
+                        "op": "eq",
+                        "val": text,
+                    },
+                ],
+            ),
+        }
+
+        url = app.url_path_for("get_user_list")
+        res = await client.get(url, params=params)
+        assert res.status_code == status.HTTP_200_OK, res.text
+        assert res.json() == {
+            "data": [
+                {
+                    "attributes": UserAttributesBaseSchema.from_orm(user_1),
+                    "id": str(user_1.id),
+                    "type": "user",
+                },
+            ],
+            "jsonapi": {"version": "1.0"},
+            "meta": {"count": 1, "totalPages": 1},
+        }
+
 
 ASCENDING = ""
 DESCENDING = "-"