added fields tests for other crud operations

Author: CosmoV

fastapi_jsonapi/views/detail_view.py

@@ -12,6 +12,7 @@
     BaseJSONAPIItemInSchema,
     JSONAPIResultDetailSchema,
 )
+from fastapi_jsonapi.views.utils import handle_jsonapi_fields
 from fastapi_jsonapi.views.view_base import ViewBase
 
 if TYPE_CHECKING:
@@ -34,22 +35,24 @@ async def handle_get_resource_detail(
         self,
         object_id: Union[int, str],
         **extra_view_deps,
-    ):
+    ) -> Union[JSONAPIResultDetailSchema, Dict]:
         dl: "BaseDataLayer" = await self.get_data_layer(extra_view_deps)
 
         view_kwargs = {dl.url_id_field: object_id}
         db_object = await dl.get_object(view_kwargs=view_kwargs, qs=self.query_params)
 
-        return self._build_detail_response(db_object)
+        response = self._build_detail_response(db_object)
+        return handle_jsonapi_fields(response, self.query_params, self.jsonapi)
 
     async def handle_update_resource(
         self,
         obj_id: str,
         data_update: BaseJSONAPIItemInSchema,
         **extra_view_deps,
-    ) -> JSONAPIResultDetailSchema:
+    ) -> Union[JSONAPIResultDetailSchema, Dict]:
         dl: "BaseDataLayer" = await self.get_data_layer(extra_view_deps)
-        return await self.process_update_object(dl=dl, obj_id=obj_id, data_update=data_update)
+        response = await self.process_update_object(dl=dl, obj_id=obj_id, data_update=data_update)
+        return handle_jsonapi_fields(response, self.query_params, self.jsonapi)
 
     async def process_update_object(
         self,

fastapi_jsonapi/views/list_view.py

@@ -6,7 +6,7 @@
     JSONAPIResultDetailSchema,
     JSONAPIResultListSchema,
 )
-from fastapi_jsonapi.views.utils import handle_fields
+from fastapi_jsonapi.views.utils import handle_jsonapi_fields
 from fastapi_jsonapi.views.view_base import ViewBase
 
 if TYPE_CHECKING:
@@ -42,15 +42,16 @@ async def handle_get_resource_list(self, **extra_view_deps) -> Union[JSONAPIResu
         total_pages = self._calculate_total_pages(count)
 
         response = self._build_list_response(items_from_db, count, total_pages)
-        return handle_fields(response, query_params, self.jsonapi)
+        return handle_jsonapi_fields(response, query_params, self.jsonapi)
 
     async def handle_post_resource_list(
         self,
         data_create: BaseJSONAPIItemInSchema,
         **extra_view_deps,
-    ) -> JSONAPIResultDetailSchema:
+    ) -> Union[JSONAPIResultDetailSchema, Dict]:
         dl: "BaseDataLayer" = await self.get_data_layer(extra_view_deps)
-        return await self.process_create_object(dl=dl, data_create=data_create)
+        response = await self.process_create_object(dl=dl, data_create=data_create)
+        return handle_jsonapi_fields(response, self.query_params, self.jsonapi)
 
     async def process_create_object(self, dl: "BaseDataLayer", data_create: BaseJSONAPIItemInSchema):
         created_object = await dl.create_object(data_create=data_create, view_kwargs={})
@@ -70,4 +71,5 @@ async def handle_delete_resource_list(self, **extra_view_deps) -> JSONAPIResultL
 
         await dl.delete_objects(items_from_db, {})
 
-        return self._build_list_response(items_from_db, count, total_pages)
+        response = self._build_list_response(items_from_db, count, total_pages)
+        return handle_jsonapi_fields(response, self.query_params, self.jsonapi)

fastapi_jsonapi/views/utils.py

@@ -140,7 +140,7 @@ def _calculate_exclude_fields(
     return exclude_params
 
 
-def handle_fields(
+def handle_jsonapi_fields(
     response: JSONAPIResponse,
     query_params: QueryStringManager,
     jsonapi: RoutersJSONAPI,
@@ -151,6 +151,6 @@ def handle_fields(
     exclude_params = _calculate_exclude_fields(response, query_params, jsonapi)
 
     if exclude_params:
-        return response.dict(exclude=exclude_params)
+        return response.dict(exclude=exclude_params, by_alias=True)
 
     return response

tests/test_api/test_api_sqla_with_includes.py

@@ -207,7 +207,7 @@ async def test_select_custom_fields(
                 },
             ],
             "jsonapi": {"version": "1.0"},
-            "meta": {"count": 2, "total_pages": 1},
+            "meta": {"count": 2, "totalPages": 1},
         }
 
     async def test_select_custom_fields_with_includes(
@@ -277,7 +277,7 @@ async def test_select_custom_fields_with_includes(
                 },
             ],
             "jsonapi": {"version": "1.0"},
-            "meta": {"count": 2, "total_pages": 1},
+            "meta": {"count": 2, "totalPages": 1},
             "included": sorted(
                 [
                     {
@@ -780,6 +780,32 @@ async def test_many_to_many_load_inner_includes_to_parents(
     assert ("child", ViewBase.get_db_item_id(child_4)) not in included_data
 
 
+class TestGetUserDetail:
+    def get_url(self, app: FastAPI, user_id: int) -> str:
+        return app.url_path_for("get_user_detail", obj_id=user_id)
+
+    async def test_select_custom_fields(
+        self,
+        app: FastAPI,
+        client: AsyncClient,
+        user_1: User,
+    ):
+        url = self.get_url(app, user_1.id)
+        params = QueryParams([("fields[user]", "name,age")])
+        response = await client.get(url, params=params)
+
+        assert response.status_code == status.HTTP_200_OK
+        assert response.json() == {
+            "data": {
+                "attributes": UserAttributesBaseSchema.from_orm(user_1).dict(include={"name", "age"}),
+                "id": str(user_1.id),
+                "type": "user",
+            },
+            "jsonapi": {"version": "1.0"},
+            "meta": None,
+        }
+
+
 class TestUserWithPostsWithInnerIncludes:
     @mark.parametrize(
         "include, expected_relationships_inner_relations, expect_user_include",
@@ -1503,6 +1529,34 @@ class ContainsTimestampAttrsSchema(BaseModel):
                 "data": [],
             }
 
+    async def test_select_custom_fields(self, app: FastAPI, client: AsyncClient):
+        user_attrs_schema = UserAttributesBaseSchema(
+            name=fake.name(),
+            age=fake.pyint(),
+            email=fake.email(),
+        )
+        create_user_body = {
+            "data": {
+                "attributes": user_attrs_schema.dict(),
+            },
+        }
+        params = QueryParams([("fields[user]", "name")])
+        url = app.url_path_for("get_user_list")
+        res = await client.post(url, json=create_user_body, params=params)
+        assert res.status_code == status.HTTP_201_CREATED, res.text
+        response_data: dict = res.json()
+
+        assert "data" in response_data
+        assert response_data["data"].pop("id")
+        assert response_data == {
+            "data": {
+                "attributes": user_attrs_schema.dict(include={"name"}),
+                "type": "user",
+            },
+            "jsonapi": {"version": "1.0"},
+            "meta": None,
+        }
+
 
 class TestPatchObjects:
     async def test_patch_object(
@@ -1615,6 +1669,39 @@ async def test_update_schema_has_extra_fields(self, user_1: User, caplog):
         ):
             assert expected in log_message
 
+    async def test_select_custom_fields(
+        self,
+        app: FastAPI,
+        client: AsyncClient,
+        user_1: User,
+    ):
+        new_attrs = UserAttributesBaseSchema(
+            name=fake.name(),
+            age=fake.pyint(),
+            email=fake.email(),
+        )
+
+        patch_user_body = {
+            "data": {
+                "id": user_1.id,
+                "attributes": new_attrs.dict(),
+            },
+        }
+        params = QueryParams([("fields[user]", "name")])
+        url = app.url_path_for("get_user_detail", obj_id=user_1.id)
+        res = await client.patch(url, params=params, json=patch_user_body)
+
+        assert res.status_code == status.HTTP_200_OK, res.text
+        assert res.json() == {
+            "data": {
+                "attributes": new_attrs.dict(include={"name"}),
+                "id": str(user_1.id),
+                "type": "user",
+            },
+            "jsonapi": {"version": "1.0"},
+            "meta": None,
+        }
+
 
 class TestPatchObjectRelationshipsToOne:
     async def test_ok_when_foreign_key_of_related_object_is_nullable(
@@ -2085,6 +2172,34 @@ async def test_delete_objects_many(
             "meta": {"count": 1, "totalPages": 1},
         }
 
+    async def test_select_custom_fields(
+        self,
+        app: FastAPI,
+        client: AsyncClient,
+        user_1: User,
+        user_2: User,
+    ):
+        params = QueryParams([("fields[user]", "name")])
+        url = app.url_path_for("get_user_list")
+        res = await client.delete(url, params=params)
+        assert res.status_code == status.HTTP_200_OK, res.text
+        assert res.json() == {
+            "data": [
+                {
+                    "attributes": UserAttributesBaseSchema.from_orm(user_1).dict(include={"name"}),
+                    "id": str(user_1.id),
+                    "type": "user",
+                },
+                {
+                    "attributes": UserAttributesBaseSchema.from_orm(user_2).dict(include={"name"}),
+                    "id": str(user_2.id),
+                    "type": "user",
+                },
+            ],
+            "jsonapi": {"version": "1.0"},
+            "meta": {"count": 2, "totalPages": 1},
+        }
+
 
 class TestOpenApi:
     def test_openapi_method_ok(self, app: FastAPI):