R/mantaJob.errors.R

In joyent/mantaRSDK: Joyent Manta Storage Service R Software Development Kit

# Roxygen Comments mantaJob.errors
#' Returns JSON Manta error messages given Manta job identifier.
#'
#' JSON error message return values:\cr
#' \code{Name : Type}. Description.\cr
#' \code{------------------------}\cr
#' \code{id : String}. Job id.\cr
#' \code{phase : Number}. Phase number of the failure.\cr
#' \code{what : String}. A human readable summary of what failed.\cr
#' \code{code : String}. Programmatic error code.\cr
#' \code{message : String}. Human readable error message.\cr
#' \code{stderr : String} (optional). A key that saved the stderr for the given command.\cr
#' \code{key : String} (optional). The input key being processed when
#' the task failed (if the service can determine it).\cr
#'
#' @param jobid character optional. Manta job identifier such as
#' \code{"70c30bab-873b-66da-ebc8-ced12bd35ac4"}. Default uses \code{mantaJobs.tail}
#' to fetch the jobid of the last Manta Job run on the service.
#'
#' @param readable logical. Set to \code{FALSE} to return the JSON error strings, or
#' \code{NULL} if no errors found.
#' Default \code{TRUE} pretty prints JSON to the console.
#'
#' @keywords Manta
#'
#' @family mantaJobs
#'
#' @examples
#' \dontrun{
#' ## Check if the last run Manta job had errors:
#' mantaJob.errors()
#' }
#'
#' @export
mantaJob.errors <-
function(jobid, readable = TRUE) {
  # If this is the first export function called in the library
  if (manta_globals$manta_initialized == FALSE) {
    mantaInitialize(useEnv = TRUE)
  }
  if (missing(jobid)) {
    jobid <- mantaJobs.tail()
  }
  ## Look for live/err
  action <- paste("/",manta_globals$manta_user,"/jobs/",jobid,"/live/err", sep="")
  result <-  mantaAttempt(action, method = "HEAD", returncode = 200,  silent = TRUE, test = TRUE)
  buffer <- FALSE
  if (result == FALSE) {
    ## Look for archived
    action <- paste("/",manta_globals$manta_user,"/jobs/",jobid,"/err.txt", sep="")
    buffer <-  mantaGet(action, buffer = TRUE, info = FALSE)
  } else {
    buffer <-  mantaGet(action, buffer = TRUE, info = FALSE)
  }
  if (length(buffer) != 1) {
    jsonerrs <- rawToChar(buffer)
  } else {
     if (readable == TRUE) {
       cat(paste("Job errors for ", jobid, " not found.\n", sep = ""))
     } 
     return(NULL)
  }

  jsonlines <- strsplit(jsonerrs, split = "\n")
 
  prettyoutput <- function(line) {
     cat(paste(toJSON(fromJSON(line), pretty=TRUE), "\n", sep=""))
  }

  if (readable == TRUE) {
    lapply(jsonlines[[1]], prettyoutput) 
  } else {
    return(jsonlines[[1]])
  }
 cat("\n")
}