fix: improve api error handling for dashboards and folders (#111831)

pkg/api/apierrors/folder_test.go

@@ -21,61 +21,109 @@ func TestToFolderErrorResponse(t *testing.T) {
 		input error
 		want  response.Response
 	}{
+		// --- 400 Bad Request ---
 		{
 			name:  "dashboard error",
-			input: dashboardaccess.DashboardErr{StatusCode: 400, Reason: "Dashboard Error", Status: "error"},
-			want:  response.Error(400, "Dashboard Error", dashboardaccess.DashboardErr{StatusCode: 400, Reason: "Dashboard Error", Status: "error"}),
+			input: dashboardaccess.DashboardErr{StatusCode: http.StatusBadRequest, Reason: "Dashboard Error", Status: "error"},
+			want:  response.Error(http.StatusBadRequest, "Dashboard Error", dashboardaccess.DashboardErr{StatusCode: http.StatusBadRequest, Reason: "Dashboard Error", Status: "error"}),
+		},
+		{
+			name:  "maximum depth reached",
+			input: folder.ErrMaximumDepthReached.Errorf("Maximum nested folder depth reached"),
+			want:  response.Err(folder.ErrMaximumDepthReached.Errorf("Maximum nested folder depth reached")),
+		},
+		{
+			name:  "bad request errors",
+			input: folder.ErrBadRequest.Errorf("Bad request error"),
+			want:  response.Err(folder.ErrBadRequest.Errorf("Bad request error")),
+		},
+		{
+			name:  "conflict error",
+			input: folder.ErrConflict.Errorf("Conflict error"),
+			want:  response.Err(folder.ErrConflict.Errorf("Conflict error")),
+		},
+		{
+			name:  "circular reference error",
+			input: folder.ErrCircularReference.Errorf("Circular reference detected"),
+			want:  response.Err(folder.ErrCircularReference.Errorf("Circular reference detected")),
+		},
+
+		{
+			name:  "folder not empty error",
+			input: folder.ErrFolderNotEmpty.Errorf("Folder cannot be deleted: folder is not empty"),
+			want:  response.Err(folder.ErrFolderNotEmpty.Errorf("Folder cannot be deleted: folder is not empty")),
 		},
 		{
 			name:  "folder title empty",
 			input: dashboards.ErrFolderTitleEmpty,
-			want:  response.Error(400, "folder title cannot be empty", nil),
+			want:  response.Error(http.StatusBadRequest, "folder title cannot be empty", nil),
 		},
 		{
 			name:  "dashboard type mismatch",
 			input: dashboards.ErrDashboardTypeMismatch,
-			want:  response.Error(400, "Dashboard cannot be changed to a folder", dashboards.ErrDashboardTypeMismatch),
+			want:  response.Error(http.StatusBadRequest, "Dashboard cannot be changed to a folder", dashboards.ErrDashboardTypeMismatch),
 		},
 		{
 			name:  "dashboard invalid uid",
 			input: dashboards.ErrDashboardInvalidUid,
-			want:  response.Error(400, "uid contains illegal characters", dashboards.ErrDashboardInvalidUid),
+			want:  response.Error(http.StatusBadRequest, "uid contains illegal characters", dashboards.ErrDashboardInvalidUid),
 		},
 		{
 			name:  "dashboard uid too long",
 			input: dashboards.ErrDashboardUidTooLong,
-			want:  response.Error(400, "uid too long, max 40 characters", dashboards.ErrDashboardUidTooLong),
+			want:  response.Error(http.StatusBadRequest, "uid too long, max 40 characters", dashboards.ErrDashboardUidTooLong),
 		},
+		{
+			name:  "folder cannot be parent of itself",
+			input: folder.ErrFolderCannotBeParentOfItself,
+			want:  response.Error(http.StatusBadRequest, folder.ErrFolderCannotBeParentOfItself.Error(), nil),
+		},
+		// --- 403 Forbidden ---
 		{
 			name:  "folder access denied",
 			input: dashboards.ErrFolderAccessDenied,
 			want:  response.Error(http.StatusForbidden, "Access denied", dashboards.ErrFolderAccessDenied),
 		},
+		// --- 404 Not Found ---
 		{
 			name:  "folder not found",
 			input: dashboards.ErrFolderNotFound,
 			want:  response.JSON(http.StatusNotFound, util.DynMap{"status": "not-found", "message": dashboards.ErrFolderNotFound.Error()}),
 		},
+		// --- 409 Conflict ---
 		{
 			name:  "folder with same uid exists",
 			input: dashboards.ErrFolderWithSameUIDExists,
 			want:  response.Error(http.StatusConflict, dashboards.ErrFolderWithSameUIDExists.Error(), nil),
 		},
+		// --- 412 Precondition Failed ---
 		{
 			name:  "folder version mismatch",
 			input: dashboards.ErrFolderVersionMismatch,
 			want:  response.JSON(http.StatusPreconditionFailed, util.DynMap{"status": "version-mismatch", "message": dashboards.ErrFolderVersionMismatch.Error()}),
 		},
+		// --- 500 Internal Server Error ---
 		{
-			name:  "folder max depth reached",
-			input: folder.ErrMaximumDepthReached,
-			want:  response.JSON(http.StatusBadRequest, util.DynMap{"messageId": "folder.maximum-depth-reached", "message": folder.ErrMaximumDepthReached.Error()}),
+			name:  "target registry srv conflict error",
+			input: folder.ErrTargetRegistrySrvConflict.Errorf("Target registry service conflict"),
+			want:  response.Err(folder.ErrTargetRegistrySrvConflict.Errorf("Target registry service conflict")),
 		},
 		{
-			name:  "fallback error",
-			input: errors.New("some error"),
-			want:  response.ErrOrFallback(http.StatusInternalServerError, "Folder API error", errors.New("some error")),
+			name:  "internal error",
+			input: folder.ErrInternal.Errorf("Internal error"),
+			want:  response.Err(folder.ErrInternal.Errorf("Internal error")),
 		},
+		{
+			name:  "database error",
+			input: folder.ErrDatabaseError.Errorf("Database error"),
+			want:  response.Err(folder.ErrDatabaseError.Errorf("Database error")),
+		},
+		{
+			name:  "fallback error for an unknown error",
+			input: errors.New("an unexpected error"),
+			want:  response.Error(http.StatusInternalServerError, "Folder API error: an unexpected error", errors.New("an unexpected error")),
+		},
+		// --- Kubernetes status errors ---
 		{
 			name: "kubernetes status error",
 			input: &k8sErrors.StatusError{