Add task service for get task API #12

samarpan1738 · 2024-12-20T18:35:17Z

Date: 20 Dec 2024

Developer Name: Samarpan Harit

Important

THIS PR MUST BE MERGED AFTER

Setup a basic view for task api and add query params validator #11

Issue Ticket Number

Closes Create an API to get all the todos #5

Description

Add get tasks api response, task and label DTOs
Add task service which fetches data from DB using repository and prepares the response from it
Add tests for task service and task view
For now using a dummy SYSTEM username. When we add authentication, we'll be using the correct use details here

Success Response

URL - GET http://127.0.0.1:8000/v1/tasks?page=1&limit=1

Response Code: 200

{
    "links": {
        "next": "/v1/tasks?page=2&limit=1"
    },
    "tasks": [
        {
            "id": "672f7c5b775ee9f4471ff1dd",
            "displayId": "#1",
            "title": "created rest api",
            "priority": "HIGH",
            "status": "TODO",
            "assignee": {
                "id": "qMbT6M2GB65W7UHgJS4g",
                "name": "SYSTEM"
            },
            "labels": [
                {
                    "name": "Beginner Friendly",
                    "color": "#fa1e4e"
                }
            ],
            "startedAt": "2024-11-09T15:14:35.724000",
            "dueAt": "2024-11-09T15:14:35.724000",
            "createdAt": "2024-11-09T15:14:35.724000",
            "updatedAt": "2024-10-18T15:55:14.802000Z",
            "createdBy": {
                "id": "xQ1CkCncM8Novk252oAj",
                "name": "SYSTEM"
            },
            "updatedBy": {
                "id": "Kn5N4Z3mdvpkv0HpqUCt",
                "name": "SYSTEM"
            }
        }
    ]
}

Error Response (Incorrect query params)

URL - GET http://127.0.0.1:8000/v1/tasks?page=1&limit=-1

Response Code: 400

{
    "statusCode": 400,
    "message": "Invalid request",
    "errors": [
        {
            "source": {
                "parameter": "limit"
            },
            "detail": "limit must be greater than or equal to 1"
        }
    ]
}

Documentation Updated?

Yes
No

Under Feature Flag

Yes
No

Database Changes

Yes
No

Breaking Changes

Yes
No

Development Tested?

Yes
No

Screenshots

Success Response

Error Response (Incorrect query params)

Test Coverage

Coverage report

Additional Notes

The CI is failing right now because there an issue in the workflow. I have raised a PR to fix this. Once it's merged the CI should pass

Fix the failing CI github workflow #8

pankajjs · 2024-12-25T14:26:43Z

todo/dto/label_dto.py

+    createdAt: datetime | None = None
+    updatedAt: datetime | None = None
+    createdBy: UserDTO | None = None
+    updatedBy: UserDTO | None = None


These values can ever be none?

Yes. This label DTO can be used in other places also
In get tasks API, we only need to send name and color of the label

pankajjs · 2024-12-25T14:28:12Z

todo/dto/responses/get_tasks_response.py

+from todo.dto.task_dto import TaskDTO
+
+
+class GetTasksResponse(PaginatedResponse):


why not TasksResponse?

pankajjs · 2025-02-06T07:45:34Z

todo/dto/label_dto.py

+    createdAt: datetime | None = None
+    updatedAt: datetime | None = None
+    createdBy: UserDTO | None = None
+    updatedBy: UserDTO | None = None


In what scenario, all these fields will be none?

pankajjs · 2025-02-06T07:46:13Z

todo/dto/responses/paginated_response.py

+    next: str | None = None
+    prev: str | None = None


The datatype will be string or number?

pankajjs · 2025-02-06T07:46:59Z

todo/dto/task_dto.py

+    id: str
+    displayId: str


what is the difference b/w id and displayId?

pankajjs · 2025-02-06T07:48:18Z

todo/dto/task_dto.py

+    displayId: str
+    title: str
+    description: str | None = None
+    priority: TaskPriority | None = None


Why priority can be none?

pankajjs · 2025-02-06T07:48:50Z

todo/dto/task_dto.py

+    title: str
+    description: str | None = None
+    priority: TaskPriority | None = None
+    status: TaskStatus | None = None


Why status can be none?

pankajjs · 2025-02-06T07:51:34Z

todo/dto/task_dto.py

+    updatedBy: UserDTO | None = None
+
+    class Config:
+        json_encoders = {TaskPriority: lambda x: x.name}


What is it doing?

pankajjs · 2025-02-06T07:52:50Z

todo/services/task_service.py

+    @classmethod
+    def get_tasks(cls, page, limit) -> GetTasksResponse:


Why is it a class method?
what is cls?

pankajjs · 2025-02-06T07:57:32Z

todo/services/task_service.py

+            links_data.prev = f"{cls.tasks_api_base_url}?page={page-1}&limit={limit}"
+
+        if tasks_count > tasks_skip_count + limit:
+            links_data.next = f"{cls.tasks_api_base_url}?page={page+1}&limit={limit}"


Can we create an util function which will create the next and prev link based on given input?

pankajjs · 2025-02-06T07:58:37Z

todo/services/task_service.py

+        if tasks_count > tasks_skip_count + limit:
+            links_data.next = f"{cls.tasks_api_base_url}?page={page+1}&limit={limit}"
+
+        if links_data.prev is not None or links_data.next is not None:


Suggested change

if links_data.prev is not None or links_data.next is not None:

if not links_data.prev or not links_data.next:

pankajjs · 2025-02-06T07:58:55Z

todo/services/task_service.py

+            response.links = links_data
+        return response
+
+    @classmethod


Why is it a class method?

samarpan1738 changed the title ~~Feat get todo api view and service~~ Add task service Dec 20, 2024

samarpan1738 changed the title ~~Add task service~~ Add task service implementing get tasks method Dec 20, 2024

samarpan1738 changed the title ~~Add task service implementing get tasks method~~ Add task service for get task API Dec 20, 2024

samarpan1738 mentioned this pull request Dec 20, 2024

Create an API to get all the todos #5

Open

10 tasks

samarpan1738 force-pushed the feat-get-todo-api-view-and-validator branch from 074fa71 to f91df5a Compare December 22, 2024 19:38

samarpan1738 added 5 commits December 23, 2024 01:08

Add get tasks api response, task and label DTOs

2cde480

Add task service

f58e1b1

Add tests for task service

683b8ee

Use task service in task view

c70b275

Add tests for task view

81848f5

samarpan1738 force-pushed the feat-get-todo-api-view-and-service branch from bf89c2a to 81848f5 Compare December 22, 2024 19:39

pankajjs reviewed Dec 25, 2024

View reviewed changes

rishirishhh self-assigned this Feb 2, 2025

Achintya-Chatterjee assigned Achintya-Chatterjee and rishirishhh and unassigned rishirishhh and Achintya-Chatterjee Feb 3, 2025

pankajjs requested changes Feb 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add task service for get task API #12

Add task service for get task API #12

samarpan1738 commented Dec 20, 2024 •

edited

Loading

pankajjs Dec 25, 2024

samarpan1738 Dec 25, 2024

pankajjs Dec 25, 2024

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025 •

edited

Loading

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025

pankajjs Feb 6, 2025

		from todo.dto.task_dto import TaskDTO


		class GetTasksResponse(PaginatedResponse):

		@classmethod
		def get_tasks(cls, page, limit) -> GetTasksResponse:

	if links_data.prev is not None or links_data.next is not None:
	if not links_data.prev or not links_data.next:

Add task service for get task API #12

Are you sure you want to change the base?

Add task service for get task API #12

Conversation

samarpan1738 commented Dec 20, 2024 • edited Loading

Issue Ticket Number

Description

Documentation Updated?

Under Feature Flag

Database Changes

Breaking Changes

Development Tested?

Screenshots

Test Coverage

Additional Notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pankajjs Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samarpan1738 commented Dec 20, 2024 •

edited

Loading

pankajjs Feb 6, 2025 •

edited

Loading