feat: improve response for not found data

- change the status code from 404 to 200 (OK) - use makeRequest function to treat error from endpoint in the frontend - show error message in SectionError component Part of #784
kernelci · Jan 24, 2025 · 2bd510f · 2bd510f
1 parent 7f075dd
commit 2bd510f
Show file tree

Hide file tree

Showing 34 changed files with 142 additions and 109 deletions.
diff --git a/backend/kernelCI_app/views/buildDetailsView.py b/backend/kernelCI_app/views/buildDetailsView.py
@@ -49,7 +49,7 @@ def get(self, request, build_id):
         records = query.select()
         if not records:
             return create_error_response(
-                error_message="Build not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Build not found", status_code=HTTPStatus.OK
             )
 
         return JsonResponse(records[0])
diff --git a/backend/kernelCI_app/views/buildTestsView.py b/backend/kernelCI_app/views/buildTestsView.py
@@ -13,8 +13,8 @@ def get(self, request, build_id):
 
         if not result:
             return create_error_response(
-                error_message="Tests not found for this build",
-                status_code=HTTPStatus.NOT_FOUND,
+                error_message="No tests found for this build",
+                status_code=HTTPStatus.OK,
             )
 
         return JsonResponse(list(result), safe=False)
diff --git a/backend/kernelCI_app/views/hardwareDetailsCommitHistoryView.py b/backend/kernelCI_app/views/hardwareDetailsCommitHistoryView.py
@@ -215,7 +215,7 @@ def post(self, request, hardware_id) -> JsonResponse:
 
         if not commit_history:
             return create_error_response(
-                error_message="Commit history not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Commit history not found", status_code=HTTPStatus.OK
             )
 
         return JsonResponse({"commit_history_table": commit_history}, safe=False)
diff --git a/backend/kernelCI_app/views/hardwareDetailsSummaryView.py b/backend/kernelCI_app/views/hardwareDetailsSummaryView.py
@@ -232,7 +232,7 @@ def post(self, request, hardware_id) -> Response:
 
         if len(records) == 0:
             return Response(
-                data={"error": "Hardware not found"}, status=HTTPStatus.NOT_FOUND
+                data={"error": "Hardware not found"}, status=HTTPStatus.OK
             )
 
         is_all_selected = len(self.selected_commits) == 0

diff --git a/backend/kernelCI_app/views/hardwareDetailsView.py b/backend/kernelCI_app/views/hardwareDetailsView.py
@@ -194,7 +194,7 @@ def post(self, request, hardware_id):
 
         if len(records) == 0:
             return Response(
-                data={"error": "Hardware not found"}, status=HTTPStatus.NOT_FOUND
+                data={"error": "Hardware not found"}, status=HTTPStatus.OK
             )
 
         is_all_selected = len(self.selected_commits) == 0

diff --git a/backend/kernelCI_app/views/hardwareView.py b/backend/kernelCI_app/views/hardwareView.py
@@ -96,7 +96,7 @@ def get(self, request):
 
         if not result["hardware"]:
             return create_error_response(
-                error_message="Hardwares not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="No hardwares found", status_code=HTTPStatus.OK
             )
 
         return JsonResponse(result, safe=False)
diff --git a/backend/kernelCI_app/views/issueDetailsBuildsView.py b/backend/kernelCI_app/views/issueDetailsBuildsView.py
@@ -55,7 +55,7 @@ def get(
 
         if not builds_data:
             return create_error_response(
-                error_message="Builds not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="No builds found for this issue", status_code=HTTPStatus.OK
             )
 
         return JsonResponse(builds_data, safe=False)
diff --git a/backend/kernelCI_app/views/issueDetailsTestsView.py b/backend/kernelCI_app/views/issueDetailsTestsView.py
@@ -51,7 +51,7 @@ def get(
 
         if not tests_data:
             return create_error_response(
-                error_message="Tests not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="No tests found for this issue", status_code=HTTPStatus.OK
             )
 
         return JsonResponse(tests_data, safe=False)
diff --git a/backend/kernelCI_app/views/issueDetailsView.py b/backend/kernelCI_app/views/issueDetailsView.py
@@ -50,7 +50,7 @@ def get(
 
         if not issue_data:
             return create_error_response(
-                error_message="Issue not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Issue not found", status_code=HTTPStatus.OK
             )
 
         return JsonResponse(issue_data)
diff --git a/backend/kernelCI_app/views/issuesView.py b/backend/kernelCI_app/views/issuesView.py
@@ -87,7 +87,7 @@ def get(
             if len(test_issues) == 0:
                 return create_error_response(
                     error_message="No issues were found for this test",
-                    status_code=HTTPStatus.NOT_FOUND,
+                    status_code=HTTPStatus.OK,
                 )
 
             return JsonResponse(test_issues, safe=False)
@@ -97,7 +97,7 @@ def get(
             if len(build_issues) == 0:
                 return create_error_response(
                     error_message="No issues were found for this build",
-                    status_code=HTTPStatus.NOT_FOUND,
+                    status_code=HTTPStatus.OK,
                 )
 
             return JsonResponse(build_issues, safe=False)

diff --git a/backend/kernelCI_app/views/logDownloaderView.py b/backend/kernelCI_app/views/logDownloaderView.py
@@ -65,7 +65,7 @@ def get(self, request):
 
         if not parsed_data['log_files']:
             return create_error_response(
-                error_message="No log files found", status_code=HTTPStatus.NOT_FOUND
+                error_message="No log files found", status_code=HTTPStatus.OK
             )
 
         return JsonResponse(parsed_data)
diff --git a/backend/kernelCI_app/views/testDetailsView.py b/backend/kernelCI_app/views/testDetailsView.py
@@ -70,7 +70,7 @@ def get(self, _request, test_id: str | None):
 
         if len(response) == 0:
             return create_error_response(
-                error_message="Test not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Test not found", status_code=HTTPStatus.OK
             )
 
         return JsonResponse(response, safe=False)
diff --git a/backend/kernelCI_app/views/treeCommitsHistory.py b/backend/kernelCI_app/views/treeCommitsHistory.py
@@ -457,7 +457,7 @@ def get(self, request, commit_hash):
 
         if not rows:
             return create_error_response(
-                error_message="History of tree commits not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="History of tree commits not found", status_code=HTTPStatus.OK
             )
 
         self._process_rows(rows)

diff --git a/backend/kernelCI_app/views/treeDetailsBootsView.py b/backend/kernelCI_app/views/treeDetailsBootsView.py
@@ -74,7 +74,7 @@ def get(self, request, commit_hash: str | None):
 
         if len(rows) == 0:
             return create_error_response(
-                error_message="Tree not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="No boots found for this tree", status_code=HTTPStatus.OK
             )
 
         try:

diff --git a/backend/kernelCI_app/views/treeDetailsBuildsView.py b/backend/kernelCI_app/views/treeDetailsBuildsView.py
@@ -70,7 +70,7 @@ def get(self, request, commit_hash: str | None):
 
         if len(rows) == 0:
             return create_error_response(
-                error_message="Tree not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="No builds found for this tree", status_code=HTTPStatus.OK
             )
 
         try:

diff --git a/backend/kernelCI_app/views/treeDetailsSummaryView.py b/backend/kernelCI_app/views/treeDetailsSummaryView.py
@@ -159,7 +159,7 @@ def get(self, request, commit_hash: str | None):
 
         if len(rows) == 0:
             return create_error_response(
-                error_message="Tree not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Tree not found", status_code=HTTPStatus.OK
             )
 
         self.filters = FilterParams(request)

diff --git a/backend/kernelCI_app/views/treeDetailsTestsView.py b/backend/kernelCI_app/views/treeDetailsTestsView.py
@@ -79,7 +79,7 @@ def get(self, request, commit_hash: str | None):
 
         if len(rows) == 0:
             return create_error_response(
-                error_message="Tree not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="No tests found for this tree", status_code=HTTPStatus.OK
             )
 
         try:

diff --git a/backend/kernelCI_app/views/treeDetailsView.py b/backend/kernelCI_app/views/treeDetailsView.py
@@ -166,7 +166,7 @@ def get(self, request, commit_hash: str | None):
 
         if len(rows) == 0:
             return create_error_response(
-                error_message="Tree not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Tree not found", status_code=HTTPStatus.OK
             )
 
         self._sanitize_rows(rows)

diff --git a/backend/kernelCI_app/views/treeLatest.py b/backend/kernelCI_app/views/treeLatest.py
@@ -60,7 +60,7 @@ def get(self, request, tree_name: str, branch: str) -> JsonResponse:
         if tree_data is None:
             return create_error_response(
                 error_message=tree_not_found_error_message,
-                status_code=HTTPStatus.NOT_FOUND,
+                status_code=HTTPStatus.OK,
             )
 
         base_url = reverse(

diff --git a/backend/kernelCI_app/views/treeView.py b/backend/kernelCI_app/views/treeView.py
@@ -144,7 +144,7 @@ def get(self, request):
 
         if not checkouts:
             return create_error_response(
-                error_message="Trees not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Trees not found", status_code=HTTPStatus.OK
             )
 
         serializer = TreeSerializer(checkouts, many=True)

diff --git a/backend/kernelCI_app/views/treeViewFast.py b/backend/kernelCI_app/views/treeViewFast.py
@@ -58,7 +58,7 @@ def get(self, request):
 
         if not checkouts:
             return create_error_response(
-                error_message="Trees not found", status_code=HTTPStatus.NOT_FOUND
+                error_message="Trees not found", status_code=HTTPStatus.OK
             )
 
         # TODO Use django serializer

diff --git a/dashboard/src/api/buildDetails.ts b/dashboard/src/api/buildDetails.ts
@@ -5,12 +5,16 @@ import type { TBuildDetails } from '@/types/tree/BuildDetails';
 
 import type { TIssue } from '@/types/general';
 
-import http from './api';
+import { RequestData } from './commonRequest';
 
-const fetchTreeDetailData = async (buildId: string): Promise<TBuildDetails> => {
-  const res = await http.get(`/api/build/${buildId}`);
+const fetchBuildDetailsData = async (
+  buildId: string,
+): Promise<TBuildDetails> => {
+  const res = await RequestData.get<TBuildDetails & { _timestamp: string }>(
+    `/api/build/${buildId}`,
+  );
 
-  const { _timestamp, ...data } = res.data;
+  const { _timestamp, ...data } = res;
   data.timestamp = _timestamp;
   return data;
 };
@@ -20,13 +24,14 @@ export const useBuildDetails = (
 ): UseQueryResult<TBuildDetails> => {
   return useQuery({
     queryKey: ['treeData', buildId],
-    queryFn: () => fetchTreeDetailData(buildId),
+    queryFn: () => fetchBuildDetailsData(buildId),
   });
 };
 
 const fetchBuildIssues = async (buildId: string): Promise<TIssue[]> => {
-  const res = await http.get<TIssue[]>(`/api/build/${buildId}/issues`);
-  return res.data;
+  const data = await RequestData.get<TIssue[]>(`/api/build/${buildId}/issues`);
+
+  return data;
 };
 
 export const useBuildIssues = (buildId: string): UseQueryResult<TIssue[]> => {

diff --git a/dashboard/src/api/buildTests.ts b/dashboard/src/api/buildTests.ts
@@ -3,12 +3,14 @@ import { useQuery } from '@tanstack/react-query';
 
 import type { TestHistory } from '@/types/general';
 
-import http from './api';
+import { RequestData } from './commonRequest';
 
 const fetchBuildTestsData = async (buildId: string): Promise<TestHistory[]> => {
-  const res = await http.get(`/api/build/${buildId}/tests`);
+  const data = await RequestData.get<TestHistory[]>(
+    `/api/build/${buildId}/tests`,
+  );
 
-  return res.data;
+  return data;
 };
 
 export const useBuildTests = (

diff --git a/dashboard/src/api/commitHistory.ts b/dashboard/src/api/commitHistory.ts
@@ -8,9 +8,10 @@ import type {
 
 import { mapFiltersKeysToBackendCompatible } from '@/utils/utils';
 
-import { getTargetFilter, type TFilter } from '@/types/general';
+import { getTargetFilter } from '@/types/general';
+import type { TFilter } from '@/types/general';
 
-import http from './api';
+import { RequestData } from './commonRequest';
 
 const fetchCommitHistory = async (
   commitHash: string,
@@ -32,13 +33,14 @@ const fetchCommitHistory = async (
     ...filtersFormatted,
   };
 
-  const res = await http.get<TTreeCommitHistoryResponse>(
+  const data = await RequestData.get<TTreeCommitHistoryResponse>(
     `/api/tree/${commitHash}/commits`,
     {
       params,
     },
   );
-  return res.data;
+
+  return data;
 };
 
 export const useCommitHistory = ({

diff --git a/dashboard/src/api/hardware.ts b/dashboard/src/api/hardware.ts
@@ -7,20 +7,25 @@ import type { HardwareListingResponse } from '@/types/hardware';
 
 import type { TOrigins } from '@/types/general';
 
-import http from './api';
+import { RequestData } from './commonRequest';
+
 const fetchHardwareListing = async (
   origin: TOrigins,
   startTimestampInSeconds: number,
   endTimeStampInSeconds: number,
 ): Promise<HardwareListingResponse> => {
-  const res = await http.get('/api/hardware/', {
-    params: {
-      startTimestampInSeconds,
-      endTimeStampInSeconds,
-      origin,
+  const data = await RequestData.get<HardwareListingResponse>(
+    '/api/hardware/',
+    {
+      params: {
+        startTimestampInSeconds,
+        endTimeStampInSeconds,
+        origin,
+      },
     },
-  });
-  return res.data;
+  );
+
+  return data;
 };
 
 export const useHardwareListing = (

diff --git a/dashboard/src/api/hardwareDetails.ts b/dashboard/src/api/hardwareDetails.ts
@@ -12,7 +12,7 @@ import type {
 import type { TFilter, TOrigins } from '@/types/general';
 import { getTargetFilter } from '@/types/general';
 
-import http from './api';
+import { RequestData } from './commonRequest';
 
 type fetchHardwareDetailsBody = {
   startTimestampInSeconds: number;
@@ -43,12 +43,12 @@ const fetchHardwareDetails = async (
   hardwareId: string,
   body: fetchHardwareDetailsBody,
 ): Promise<THardwareDetails> => {
-  const res = await http.post<THardwareDetails>(
+  const data = await RequestData.post<THardwareDetails>(
     `/api/hardware/${hardwareId}`,
     body,
   );
 
-  return res.data;
+  return data;
 };
 
 const TREE_SELECT_HEAD_VALUE = 'head';
@@ -115,11 +115,12 @@ const fetchCommitHistory = async (
   hardwareId: string,
   body: FetchHardwareDetailsCommitHistoryBody,
 ): Promise<CommitHistoryTable> => {
-  const res = await http.post<CommitHistoryTable>(
+  const data = await RequestData.post<CommitHistoryTable>(
     `/api/hardware/${hardwareId}/commit-history`,
     body,
   );
-  return res.data;
+
+  return data;
 };
 
 export const useHardwareDetailsCommitHistory = (