Add debuginfo()

NAMESPACE

@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 export(convert_to_csv)
+export(debuginfo)
 export(get_call_options)
 export(get_echo)
 export(get_log_level)

NEWS.md

@@ -2,6 +2,8 @@
 
 ## New Features
 * `set_call_options()` offers new option to log condition calls or even the full call stack. `get_call_options()` returns the current settings.
+*  All condition log handlers e.g. `warning()` and `with_loggit()` now support call logging.
+* Added `debuginfo()` as an additional log handler for debugging purposes.
 
 ## Minor Changes
 * `loggit()` now checks the `...` arguments for use of reserved names, currently `log_call` and `timestamp`.

R/handlers_non_base.R

@@ -0,0 +1,32 @@
+#' Debug Log Handler
+#'
+#' This function works like base R's [`warning`][base::warning] ,
+#' but is silent, includes logging of the exception message via `loggit()` and does not allow conditions as input.
+#'
+#' @inherit base::warning params
+#' @inherit message params
+#' @inheritParams loggit
+#'
+#' @return No return value.
+#'
+#' @family handlers
+#'
+#' @examples
+#' \dontrun{
+#'   debuginfo("This is a completely false condition")
+#'
+#'   debuginfo("This is a completely false condition", echo = FALSE)
+#' }
+#'
+#' @details This function is more than just a wrapper around `loggit()` with a log level of "DEBUG".
+#' It has the ability to track the call stack and log it if `call.` is set to `TRUE` and to automatically
+#' translate the input into a message using `.makeMessage()`, like `warning()` does.
+#'
+#' @export
+debuginfo <- function(..., call. = TRUE, .loggit = NA, echo = get_echo()) {
+  # The call of the error must be set manually for loggit_internal
+  call <- if (call.) find_call()
+  if (isTRUE(.loggit) || (!isFALSE(.loggit) && get_log_level() >= 4L)) {
+    loggit_internal(log_lvl = "DEBUG", log_msg = .makeMessage(..., domain = NULL), log_call = call, echo = echo)
+  }
+}

pkgdown/_pkgdown.yml

@@ -21,6 +21,9 @@ reference:
     - "warning"
     - "stop"
     - "stopifnot"
+  - title: Non-base log handlers
+  - contents:
+    - "debuginfo"
   - title: Log functions
   - contents:
     - "loggit"

tests/testthat/test-handlers_non_base.R

@@ -0,0 +1,47 @@
+test_that("debuginfo echos", {
+  expect_output(debuginfo("This is a debug test", echo = TRUE), "This is a debug test")
+})
+cleanup()
+
+test_that("debuginfo logs message at DEBUG level", {
+  # silent output
+  expect_silent(debuginfo("This is a debug test", echo = FALSE))
+
+  logdata <- read_logs()
+  logdata <- logdata[nrow(logdata),]
+
+  expect_identical(logdata[["log_lvl"]], "DEBUG")
+  expect_identical(logdata[["log_msg"]], "This is a debug test")
+})
+cleanup()
+
+test_that("debuginfo concatenates multiple arguments", {
+  expect_silent(debuginfo("This ", "is ", "a debug test", echo = FALSE))
+
+  logdata <- read_logs()
+  logdata <- logdata[nrow(logdata),]
+
+  expect_identical(logdata[["log_lvl"]], "DEBUG")
+  expect_identical(logdata[["log_msg"]], "This is a debug test")
+})
+cleanup()
+
+test_that("debuginfo respects call. argument without error", {
+  # call. = TRUE should not error
+  f <- function() debuginfo("call test", call. = TRUE, echo = FALSE)
+  expect_silent(f())
+
+  # call. = FALSE should not error and still log
+  expect_silent(debuginfo("no call", call. = FALSE, echo = FALSE))
+  logdata <- read_logs()
+  expect_identical(logdata[["log_lvl"]], c("DEBUG", "DEBUG"))
+  expect_identical(logdata[["log_msg"]], c("call test", "no call"))
+})
+cleanup()
+
+test_that("debuginfo does not log on log level below DEBUG", {
+  old_level <- set_log_level(3L, confirm = FALSE)
+  expect_silent(debuginfo("This should not log"))
+  expect_error(read_logs(), "Log file does not exist", fixed = TRUE)
+  set_log_level(old_level, confirm = FALSE)
+})

tests/testthat/test-utils.R

@@ -209,3 +209,14 @@ test_that("call_2_string (full_stack=TRUE) handels call not in current context",
     endsWith(call_2_string(ext_call, full_stack = TRUE), "Original Call:  some_function(1L, 2L)")
   )
 })
+
+test_that("test call_2_string (cut off) via condition handler", {
+  old <- set_call_options(log_call = TRUE, full_stack = TRUE, confirm = FALSE)
+  # Function is needed to create a predictable call stack and a call to cut off
+  f <- function() warning("This is a warning", echo = FALSE)
+  expect_warning(f(), "This is a warning")
+  logdata <- read_logs()
+  expect_true(grepl(logdata[["log_call"]], pattern = "f()"))
+  set_call_options(.arg_list = old, confirm = FALSE)
+})
+cleanup()