써치 페이지

backend/django_peak/urls.py

@@ -29,4 +29,5 @@
     path("tasks/", include("tasks.urls")),
     path("today/", include("today.urls")),
     path("social/", include("social.urls")),
+    path("search/", include("search.urls")),
 ]

backend/projects/serializers.py

@@ -1,9 +1,10 @@
 from rest_framework import serializers
 
 from .models import Project
+from drawers.models import Drawer
+from tasks.models import Task
 from users.serializers import UserSerializer
 
-
 class ProjectSerializer(serializers.ModelSerializer):
     user = UserSerializer(
         default=serializers.CurrentUserDefault(),
@@ -49,3 +50,19 @@
     class Meta:  # pyright: ignore [reportIncompatibleVariableOverride] -- ModelSerializer.Meta
         model = Project
         exclude = ()
+
+class ProjectSearchSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Project
+        exclude = ()
+
+class DrawerSearchSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Drawer
+        exclude = ()
+
+class TaskSearchSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Task
+        exclude = ()
+

backend/projects/urls.py

@@ -8,7 +8,7 @@
     path("reorder/", views.ProjectReorderView.as_view()),
     path("", views.ProjectList.as_view()),
     path("inbox/", views.InboxProjectDetail.as_view()),
-    path("<str:id>/", views.ProjectDetail.as_view()),
+    path("<str:id>/", views.ProjectDetail.as_view())
 ]
 
 urlpatterns = format_suffix_patterns(urlpatterns)

backend/projects/views.py

@@ -2,9 +2,14 @@
 from rest_framework.response import Response
 from rest_framework.exceptions import ValidationError
 from rest_framework.pagination import PageNumberPagination
+from rest_framework.views import APIView
+
+from django.db.models import Q, F, Value
 
 from .models import Project
-from .serializers import ProjectSerializer, ProjectSerializerForUserProjectList
+from drawers.models import Drawer
+from tasks.models import Task
+from .serializers import ProjectSerializer, ProjectSerializerForUserProjectList, ProjectSearchSerializer, DrawerSearchSerializer, TaskSearchSerializer
 from .exceptions import ProjectNameDuplicate
 
 from api.permissions import IsUserOwner

backend/search/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

backend/search/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class SearchConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'search'

backend/search/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

backend/search/serializers.py

@@ -0,0 +1,25 @@
+from rest_framework import serializers
+
+from projects.models import Project
+from drawers.models import Drawer
+from tasks.models import Task
+
+class ProjectSearchSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Project
+        exclude = ()
+
+class DrawerSearchSerializer(serializers.ModelSerializer):
+    color = serializers.CharField(source="project.color", read_only=True)
+
+    class Meta:
+        model = Drawer
+        exclude = ()
+
+class TaskSearchSerializer(serializers.ModelSerializer):
+    color = serializers.CharField(source="drawer.project.color", read_only=True)
+
+    class Meta:
+        model = Task
+        exclude = ()
+

backend/search/service.py

@@ -0,0 +1,38 @@
+from django.db.models import Q, F, Value
+
+from projects.models import Project
+from drawers.models import Drawer
+from tasks.models import Task
+from .serializers import ProjectSearchSerializer, DrawerSearchSerializer, TaskSearchSerializer
+
+SCOPE_BITMASK = {"task": 1, "drawer": 2, "project": 4}
+SEARCH_PREVIEW_LIMIT = 4
+
+def global_search(query, scope):
+    results = dict()
+
+    # TODO: global한 결과를 내놓기에 각 결과가 FK object 전체를 들고 오는 것보다 필요한 color만 쓰는 것이 낫다 판단함.
+    # 검색 옵션에 따라 project, drawer object를 같이 반환하도록 하는 것을 고려
+    # drawer serializer 참고
+    targets = {
+        "task": {"objects": Task.objects.select_related("drawer__project"), "serializer": TaskSearchSerializer},
+        "drawer": {"objects": Drawer.objects.select_related("project"), "serializer": DrawerSearchSerializer},
+        "project": {"objects": Project.objects, "serializer": ProjectSearchSerializer},
+    }
+
+    for key, value in targets.items():
+        if scope & SCOPE_BITMASK[key]:
+            query_set = value["objects"].filter(
+                Q(name__icontains=query)
+            )
+            count = query_set.count()
+
+            if count > SEARCH_PREVIEW_LIMIT:
+                query_set = query_set[:SEARCH_PREVIEW_LIMIT]
+
+            data = value["serializer"](query_set, many=True).data
+            results[key] = {"data": data, "count": count}
+        else:
+            results[key] = {"data": [], "count": 0}
+
+    return results

backend/search/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

backend/search/urls.py

@@ -0,0 +1,11 @@
+from django.urls import path
+
+from rest_framework.urlpatterns import format_suffix_patterns
+
+from . import views
+
+urlpatterns = [
+    path("", views.GlobalSearchView.as_view()),
+]
+
+urlpatterns = format_suffix_patterns(urlpatterns)

backend/search/views.py

@@ -0,0 +1,88 @@
+from rest_framework import mixins, generics, status
+from rest_framework.response import Response
+from rest_framework.exceptions import ValidationError
+from rest_framework.pagination import PageNumberPagination
+from rest_framework.views import APIView
+
+from django.db.models import Q, F, Value
+
+from projects.models import Project
+from drawers.models import Drawer
+from tasks.models import Task
+from .serializers import ProjectSearchSerializer, DrawerSearchSerializer, TaskSearchSerializer
+from .service import global_search
+from projects.exceptions import ProjectNameDuplicate
+
+from api.permissions import IsUserOwner
+from api.exceptions import UnknownError
+from api.serializers import ReorderSerializer
+
+class SearchPagination(PageNumberPagination):
+    page_size = 20
+
+    # page size 조절 가능하게
+    page_size_query_param = "page_size"
+    max_page_size = 100
+
+# 하나의 view에서 여러 serializer를 부를 거라 복잡해도 그냥 APIView가 적합할 거 같음
+# 파라미터 종류가 많아지면 django-filter를 적극적으로 고려해 보자...
+class ProjectSearchView(APIView):
+    def get(self, request, *args, **kwargs):
+        q = request.query_params.get("query", "").strip()
+
+        # query가 비어있으면 빈 결과 반환
+        # TODO: 나중에 프로젝트 페이지와 합치게 되면 전부 보이는 걸로 바뀌어야 할 지도?
+        if not q:
+            return Response({
+                "projects": [],
+                "drawers": [],
+                "tasks": [],
+            })
+
+        project_qs = Project.objects.filter(
+            Q(name__icontains=q)
+        )
+
+        drawer_qs = Drawer.objects.select_related("project").filter(
+            Q(name__icontains=q)
+        )
+
+        task_qs = Task.objects.select_related("drawer__project").filter(
+            Q(name__icontains=q)
+        )
+
+        project_data = ProjectSearchSerializer(project_qs, many=True).data
+        drawer_data = DrawerSearchSerializer(drawer_qs, many=True).data
+        task_data = TaskSearchSerializer(task_qs, many=True).data
+
+        return Response({
+            "projects": project_data,
+            "drawers": drawer_data,
+            "tasks": task_data,
+        })
+
+# GlobalSearchView는 pagination X
+class GlobalSearchView(APIView):
+    def get(self, request, *args, **kwargs):
+        query = request.query_params.get("keyword", "").strip()
+        # bitmask: project / drawer / task
+        scope = request.query_params.get("scope", "7").strip()
+
+        try:
+            scope = int(scope)
+        except ValueError:
+            return Response(
+                {"detail": "search_range must be an integer"},
+                status=status.HTTP_400_BAD_REQUEST
+            )
+
+        # query가 비어있으면 빈 결과 반환
+        if not query:
+            return Response({
+                "projects": {"data": [], "count": 0},
+                "drawers": {"data": [], "count": 0},
+                "tasks": {"data": [], "count": 0},
+            })
+        results = global_search(query, scope)
+
+        return Response(results)

frontend/src/api/search.api.ts

@@ -0,0 +1,39 @@
+import client from "@api/client"
+import type { Base, PaginationData, Privacy } from "@api/common"
+import type { User } from "@api/users.api"
+
+import type { PaletteColorName } from "@assets/palettes"
+import { Project } from "@api/projects.api"
+import { Drawer } from "@api/drawers.api"
+import { Task } from "@api/tasks.api"
+
+export interface DrawerSearchResult extends Drawer {
+    color: PaletteColorName
+}
+
+export type TaskSearchResult = Task & {
+    color: PaletteColorName
+}
+
+type ResultBlock<T> = {
+    data: T[]
+    count: number
+}
+
+export interface SearchResponse {
+    project: ResultBlock<Project>
+    drawer: ResultBlock<DrawerSearchResult>
+    task: ResultBlock<TaskSearchResult>
+}
+
+export type ProjectType = "inbox" | "regular" | "goal"
+
+//export const getGlobalSearchResults = async (query: string, page: string) => {
+export const getGlobalSearchResults = async (query: string) => {
+    const keyword = query
+    const res = await client.get<SearchResponse>(`search/`, {
+        params: { keyword },
+    })
+
+    return res.data
+}

frontend/src/assets/locales/en/translation.json

@@ -427,6 +427,14 @@
             "results_title": "Search results for ‘{{query}}’"
         }
     },
+    "search": {
+        "placeholder": "Search your task",
+        "filter": {
+            "project": "project",
+            "drawer": "drawer",
+            "date": "date"
+        }
+    },
     "update": {
         "message": "New update available.",
         "update": "Update",

frontend/src/assets/locales/ko/translation.json

@@ -427,6 +427,14 @@
             "results_title": "‘{{query}}’에 대한 검색 결과"
         }
     },
+    "search": {
+        "placeholder": "할 일을 검색해 보세요",
+        "filter": {
+            "project": "프로젝트",
+            "drawer": "서랍",
+            "date": "날짜"
+        }
+    },
     "update": {
         "message": "새로운 업데이트가 있습니다.",
         "update": "업데이트",