fix: comment not showing on Featured Projects #773

aqsaaqeel · 2023-10-04T00:27:30Z

Summary

The Projects under Featured Projects list are showing comments count now.
Closes #85, Closes #22

Solution

The response from staff-picks API did not have a comments_count field. I have added it under the serializers.py / ProjectSerializer

Screenshots

Requests / Responses

Request

GET /api/projects/staff-picks/

Response

[
    {
        "id": "226bd96d-8f3d-4d85-85df-b07469a4bdc5",
        "title": "Featured Projects",
        "description": "Curated by Unstructured Studio team",
        "projects": {
            "results": [
                {
                    "id": "86a0456d-f86b-4b12-ace8-28d2ed9557fc",
                    "creator": {
                        "id": "b7c4ede2-b2e9-475d-a517-63e3ef407d2f",
                        "username": "aqsacodes",
                        "avatar": "https://robohash.org/aqsacodes",
                        "comments": [
                            {
                                "id": 2,
                                "project": null,
                                "creator": {
                                    "id": "537c5432-daed-412a-8616-b140563ed8a7",
                                    "username": "dummy",
                                    "avatar": "https://robohash.org/dummy"
                                },
                                "text": "hello",
                                "created_on": "2023-10-03T23:31:49.614297Z",
                                "replies": []
                            }
                        ],
                        "bio": "",
                        "followers": [],
                        "following_count": 0,
                        "projects_count": 2,
                        "members_count": null,
                        "tags": [
                            "creator"
                        ],
                        "badges": [
                            "Hatchling"
                        ]
                    },
                    "title": "fvz",
                    "description": "<p>sds</p>",
                    "images": [
                        {
                            "image_url": "http://localhost:8001/project_images/95uDEPJ9_kJP4VJ5m1Tx2",
                            "public_id": "project_images/95uDEPJ9_kJP4VJ5m1Tx2"
                        }
                    ],
                    "video": "",
                    "materials_used": "Paint",
                    "tags": [],
                    "category": [
                        "Toys"
                    ],
                    "likes": [],
                    "saved_by": [],
                    "views_count": 2,
                    "comments": [
                        {
                            "id": 6,
                            "project": "86a0456d-f86b-4b12-ace8-28d2ed9557fc",
                            "creator": {
                                "id": "537c5432-daed-412a-8616-b140563ed8a7",
                                "username": "dummy",
                                "avatar": "https://robohash.org/dummy"
                            },
                            "text": "hello again",
                            "created_on": "2023-10-03T23:36:55.329495Z",
                            "replies": []
                        }
                    ],
                    "created_on": "2023-09-30T16:24:14.918966Z",
                    "publish": {
                        "type": 4,
                        "visible_to": []
                    },
                    "comments_count": 0
                },
                {
                    "id": "9fac8df9-fe5c-46b0-ad50-d077e7f1f388",
                    "creator": {
                        "id": "b7c4ede2-b2e9-475d-a517-63e3ef407d2f",
                        "username": "aqsacodes",
                        "avatar": "https://robohash.org/aqsacodes",
                        "comments": [
                            {
                                "id": 2,
                                "project": null,
                                "creator": {
                                    "id": "537c5432-daed-412a-8616-b140563ed8a7",
                                    "username": "dummy",
                                    "avatar": "https://robohash.org/dummy"
                                },
                                "text": "hello",
                                "created_on": "2023-10-03T23:31:49.614297Z",
                                "replies": []
                            }
                        ],
                        "bio": "",
                        "followers": [],
                        "following_count": 0,
                        "projects_count": 2,
                        "members_count": null,
                        "tags": [
                            "creator"
                        ],
                        "badges": [
                            "Hatchling"
                        ]
                    },
                    "title": "New proj",
                    "description": "<p>jkjbk</p>",
                    "images": [
                        {
                            "image_url": "http://localhost:8001/project_images/dNhIE21WW8XRtnIo61W0f",
                            "public_id": "project_images/dNhIE21WW8XRtnIo61W0f"
                        }
                    ],
                    "video": "",
                    "materials_used": "Glue",
                    "tags": [
                        {
                            "name": "General"
                        }
                    ],
                    "category": [],
                    "likes": [],
                    "saved_by": [
                        "537c5432-daed-412a-8616-b140563ed8a7"
                    ],
                    "views_count": 2,
                    "comments": [
                        {
                            "id": 5,
                            "project": "9fac8df9-fe5c-46b0-ad50-d077e7f1f388",
                            "creator": {
                                "id": "537c5432-daed-412a-8616-b140563ed8a7",
                                "username": "dummy",
                                "avatar": "https://robohash.org/dummy"
                            },
                            "text": "hey",
                            "created_on": "2023-10-03T23:36:25.975529Z",
                            "replies": []
                        },
                        {
                            "id": 4,
                            "project": "9fac8df9-fe5c-46b0-ad50-d077e7f1f388",
                            "creator": {
                                "id": "537c5432-daed-412a-8616-b140563ed8a7",
                                "username": "dummy",
                                "avatar": "https://robohash.org/dummy"
                            },
                            "text": "hello again",
                            "created_on": "2023-10-03T23:33:50.130544Z",
                            "replies": []
                        },
                        {
                            "id": 3,
                            "project": "9fac8df9-fe5c-46b0-ad50-d077e7f1f388",
                            "creator": {
                                "id": "537c5432-daed-412a-8616-b140563ed8a7",
                                "username": "dummy",
                                "avatar": "https://robohash.org/dummy"
                            },
                            "text": "hello",
                            "created_on": "2023-10-03T23:32:44.291663Z",
                            "replies": []
                        },
                        {
                            "id": 1,
                            "project": "9fac8df9-fe5c-46b0-ad50-d077e7f1f388",
                            "creator": {
                                "id": "537c5432-daed-412a-8616-b140563ed8a7",
                                "username": "dummy",
                                "avatar": "https://robohash.org/dummy"
                            },
                            "text": "hello  world",
                            "created_on": "2023-10-03T23:26:15.827164Z",
                            "replies": []
                        }
                    ],
                    "created_on": "2023-09-30T16:18:57.224607Z",
                    "publish": {
                        "type": 4,
                        "visible_to": []
                    },
                    "comments_count": 3
                }
            ],
            "prev": null,
            "next": null,
            "count": 2
        },
        "created_on": "2023-09-30T16:24:14.918966Z"
    }
]

tuxology

Thanks 👍 LGTM 🌈

tuxology · 2023-10-04T20:13:54Z

@aqsaaqeel Can you rebase this to current master branch?

aqsaaqeel · 2023-10-04T20:48:19Z

@aqsaaqeel Can you rebase this to current master branch?

I have rebased

tuxology · 2023-10-04T21:08:37Z

@aqsaaqeel Can you pull the latest master branch and then rebase? I see conflicts in zubhub_backend/zubhub/projects/serializers.py

benndip · 2023-10-05T12:48:51Z

Hello @aqsaaqeel nice work, but I really don't think the backend was missing a comment_count field because you see that your comments_count result and your comments are different. Above you have a comment_count of 3, but there are 4 comments. Same with the one above. And in your image.

Now if we go to the backend code of models.py, you will see that, StaffPick is related to Project and Project is related to Comment with a related name of comments. So that is the count already. So this issue is to be solved from the frontend as it's just one line of code to adjust.

@tuxology @srish I will release a PR that reloves this from the front end as it was just a missing key somewhere.

benndip · 2023-10-05T13:23:36Z

Please this is what I mean @aqsaaqeel and @tuxology . Projects and Staff Picked Projects have different response structures. as seen below these screenshots

Staff-Picked has the comments field on that particular project

so we can pick the length of comments from there

Projects have a comments_count field for the number of comments for that project

Hence the backend had no issue. It was just for the front end to reference both differently according to the fields from the backend, and the issue will be resolved.

benndip · 2023-10-05T13:57:53Z

PR here:
https://github.com/unstructuredstudio/zubhub/pull/799

tuxology · 2023-10-05T14:22:00Z

@benndip Ok, this is a good observation! I guess I was too quick in approving the PR 😅 @aqsaaqeel Sorry, we will close this since this will be resolved via #799 Thanks for your efforts!

rak16 · 2023-10-05T15:46:53Z

@benndip If comments_count is not returning the correct value then isn't that something we should look into and resolve? Fixing it on the frontend with a conditional is merely a bandage, and not a well-rounded solution.

What do you think @tuxology ?

benndip · 2023-10-05T15:57:31Z

No it's not an issue. The backend has an architecture.... it's the way the Frontend was designed by the Project component. The Project component us being used for two different structures of data so that is why the issue came up. If we two different components to handle the two different structures of projects and staff-picked projects, it will be okay. But the conditional statement still works fine as it shows a little of SOLID PRINCIPLES in React.

…

On Thu, 5 Oct 2023, 16:47 Ravish Ahmad, ***@***.***> wrote: @benndip <https://github.com/benndip> If the comments_count is not returning the correct value then isn't that something we should look into and resolve? Fixing it on the frontend with a conditional is merely a bandage, and not a well-rounded solution. What do you think @tuxology <https://github.com/tuxology> ? — Reply to this email directly, view it on GitHub <#773 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMF2EGH5D2TUAMTZBIE2VHTX53I7TAVCNFSM6AAAAAA5RYTAR6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBZGE3DSNZUGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

rak16 · 2023-10-05T18:16:46Z

I feel this is a consistency issue and we should fix it on the backend. Nevertheless, even if we are okay with this, why is comments_count not the correct value if comments array is showing the right set of comments. Something is definitely not right on the backed side and should be addressed.

benndip · 2023-10-05T19:26:36Z

Hello Ravish, I understand your concern, but I'm also a backend developer, and I have tested well that there's no inconsistency with it. It's just a code misunderstanding :). We could connect better and I'll show you what I mean.

…

On Thu, 5 Oct 2023, 19:16 Ravish Ahmad, ***@***.***> wrote: I feel this is a consistency issue and we should fix it on the backend. Nevertheless, even if we are okay with this, why is comments_count not the correct value if comments array is showing the right set of comments. Something is definitely not right on the backed side and should be addressed. — Reply to this email directly, view it on GitHub <#773 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMF2EGE2YV7GEYMPWDA3SVLX532RTAVCNFSM6AAAAAA5RYTAR6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBZGQYTSNBTGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

rak16 · 2023-10-05T20:04:25Z

Sure, let's connect.

benndip · 2023-10-05T20:12:27Z

Are you available now @rak16 you can join here https://meet.google.com/uvn-dybq-gwp

fix: comment not showing on Featured Projects

2c13b2e

aqsaaqeel requested review from NdibeRaymond and tuxology as code owners October 4, 2023 00:27

tuxology approved these changes Oct 4, 2023

View reviewed changes

aqsaaqeel force-pushed the fix/#670 branch from 8f9919a to 2c13b2e Compare October 5, 2023 11:04

tuxology closed this Oct 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: comment not showing on Featured Projects #773

fix: comment not showing on Featured Projects #773

aqsaaqeel commented Oct 4, 2023 •

edited

Loading

tuxology left a comment

tuxology commented Oct 4, 2023

aqsaaqeel commented Oct 4, 2023

tuxology commented Oct 4, 2023

benndip commented Oct 5, 2023

benndip commented Oct 5, 2023

benndip commented Oct 5, 2023

tuxology commented Oct 5, 2023

rak16 commented Oct 5, 2023 •

edited

Loading

benndip commented Oct 5, 2023 via email

rak16 commented Oct 5, 2023

benndip commented Oct 5, 2023 via email

rak16 commented Oct 5, 2023

benndip commented Oct 5, 2023

fix: comment not showing on Featured Projects #773

fix: comment not showing on Featured Projects #773

Conversation

aqsaaqeel commented Oct 4, 2023 • edited Loading

Summary

Solution

Screenshots

Requests / Responses

tuxology left a comment

Choose a reason for hiding this comment

tuxology commented Oct 4, 2023

aqsaaqeel commented Oct 4, 2023

tuxology commented Oct 4, 2023

benndip commented Oct 5, 2023

benndip commented Oct 5, 2023

benndip commented Oct 5, 2023

tuxology commented Oct 5, 2023

rak16 commented Oct 5, 2023 • edited Loading

benndip commented Oct 5, 2023 via email

rak16 commented Oct 5, 2023

benndip commented Oct 5, 2023 via email

rak16 commented Oct 5, 2023

benndip commented Oct 5, 2023

aqsaaqeel commented Oct 4, 2023 •

edited

Loading

rak16 commented Oct 5, 2023 •

edited

Loading