Merge pull request #23 from flowr-analysis/20-add-function-for-lineag…

…e-request

 Extract common code from request function

R/file_analysis.R

@@ -42,12 +42,5 @@ request_file_analysis <- function(con,
       cfg = cfg
     )
   }
-
-  res <- send_request(con, request)
-
-  if (res$type == "error") {
-    return(list(error = res$reason))
-  }
-
-  return(list(id = id, filetoken = filetoken, res = res))
+  return(send_request_handle_response(con, request))
 }

R/lineage.R

@@ -19,11 +19,5 @@ request_lineage <- function(con, filetoken, criterion, id = get_new_id()) {
     filetoken = filetoken,
     criterion = criterion
   )
-  res <- send_request(con, request)
-
-  if (res$type == "error") {
-    return(list(error = res$reason))
-  }
-
-  return(list(id = id, res = res))
+  return(send_request_handle_response(con, request))
 }

R/slice.R

@@ -18,11 +18,5 @@ request_slice <- function(con, filetoken, criteria, id = get_new_id()) {
     filetoken = filetoken,
     criterion = I(criteria)
   )
-  res <- send_request(con, request)
-
-  if (res$type == "error") {
-    return(list(error = res$reason))
-  }
-
-  return(list(id = id, res = res))
+  return(send_request_handle_response(con, request))
 }

R/utils.R

@@ -30,3 +30,40 @@ get_filetoken <- function(filepath = rlang::missing_arg(), content = rlang::miss
   }
   return(token)
 }
+
+#' Checks if the given response was successful or not.
+#'
+#' The function always returns a list with the response's ID. In case of an
+#' error, the list also contains the errors reason. In case of a successful
+#' response, the list also contains the complete response.
+#'
+#' @param res The response to handle
+#'
+#' @return A list with either the error's reason or the complete response
+#' \describe{
+#'   \item{id}{The ID of the response (only in case of success).}
+#'   \item{res}{The complete response object (only in case of success).}
+#' }
+#' or
+#' \describe{
+#'   \item{error}{The reason for the error (only present in case of an error).}
+#' }
+#'
+#' @seealso [send_request()]
+handle_response <- function(res) {
+  if (res$type == "error") {
+    return(list(error = res$reason))
+  }
+  return(list(id = res$id, res = res))
+}
+
+#' Send the given request over the given connection and handle a possible error
+#'
+#' @param con The connection to use
+#' @param request The request to send
+#'
+#' @return See [handle_response()] for possible return values
+send_request_handle_response <- function(con, request) {
+  res <- send_request(con, request)
+  return(handle_response(res))
+}