Add support for excluded_properties to LayoutJson (and exclude rawMsg by

  default)

Author: s-fleck

NEWS.md

@@ -13,6 +13,9 @@
   Before, `NULL` values would have resulted in empty log messages. (#51)
 
 * Support transformers for `LoggerGlue` (see `?glue::glue`) (#51)
+
+* Add support for `excluded_properties` to LayoutJson (and exclude rawMsg by
+  default)
 
 * updated README
 

R/Layout.R

@@ -1,3 +1,6 @@
+# Layout ------------------------------------------------------------------
+
+
 #' Abstract Class for Layouts
 #'
 #' [Appenders] pass [LogEvents][LogEvent] to a Layout which formats it for
@@ -331,14 +334,17 @@ LayoutJson <- R6::R6Class(
 
     initialize = function(
       toJSON_args = list(auto_unbox = TRUE),
-      timestamp_fmt = NULL
+      timestamp_fmt = NULL,
+      excluded_properties = "rawMsg"
     ){
       self$set_toJSON_args(toJSON_args)
       self$set_timestamp_fmt(timestamp_fmt)
+      self$set_excluded_properties(excluded_properties)
     },
 
     format_event = function(event) {
       vals <- get("values", event)
+      vals <- vals[!names(vals) %in% self$excluded_properties]
       fmt  <- get("timestamp_fmt", self)
 
       if (!is.null(fmt)){
@@ -360,6 +366,9 @@ LayoutJson <- R6::R6Class(
       invisible(self)
     },
 
+
+    # . . setters -------------------------------------------------------------
+
     #' @description Set a format that this Layout will apply to timestamps.
     #'
     #' @param x
@@ -375,6 +384,14 @@ LayoutJson <- R6::R6Class(
       invisible(self)
     },
 
+    set_excluded_properties = function(x){
+      assert(is.null(x) || is.character(x))
+      private$.excluded_properties <- x
+      invisible(self)
+    },
+
+    #  . . methods ----------------------------------------------------------------
+
     toString = function() {
       fmt_class(class(self)[[1]])
     },
@@ -406,23 +423,40 @@ LayoutJson <- R6::R6Class(
 
   ),
 
+
+  #  . . active fields ------------------------------------------------------
+
   active = list(
     #' @field toJSON_args a list of values passed on to [jsonlite::toJSON()]
-    toJSON_args   = function() get(".toJSON_args", private),
+    toJSON_args = function() {
+      get(".toJSON_args", private)
+    },
 
     #' @field timestamp_fmt Used by  `$format_event()` to format timestamps.
-    timestamp_fmt = function() get(".timestamp_fmt", private)
+    timestamp_fmt = function() {
+      get(".timestamp_fmt", private)
+    },
+
+    #' @field excluded_properties Used by  `$format_event()` to exclude selected
+    #' properties before serialization
+    excluded_properties = function() {
+      get(".excluded_properties", private)
+    }
   ),
 
+  # . . private --------------------------------------------------------------
   private = list(
     .toJSON_args = NULL,
-    .timestamp_fmt = NULL
+    .timestamp_fmt = NULL,
+    .excluded_properties = NULL
   )
 )
 
 
 
 
+# utils -------------------------------------------------------------------
+
 fmt_timestamp = function(x, fmt){
   if (is.character(fmt)){
     format(x, fmt)

tests/testthat/test_Layout.R

@@ -6,7 +6,8 @@ tevent <- LogEvent$new(
   level = 200L,
   timestamp = as.POSIXct(1541175573.9308, origin = "1970-01-01", tz = "UTC"),
   caller = NA_character_,
-  msg = "foo bar"
+  msg = "foo bar",
+  rawMsg = "foo raw"
 )
 
 
@@ -67,13 +68,38 @@ test_that("LayoutJson works as expected", {
   json <- lo$format_event(x)
   tres <- jsonlite::fromJSON(json)
 
+  expected_values <- c("level", "timestamp", "logger", "caller", "msg", "foo")  # rawMsg is excluded by default
+
+  tres[sapply(tres, is.null)] <- NA_character_
+  expect_setequal(expected_values, names(tres))
+  expect_identical(tres[["level"]], eres[["level"]])
+  expect_identical(tres[["msg"]], eres[["msg"]])
+  expect_identical(tres[["caller"]], eres[["caller"]])
+  expect_equal(as.POSIXct(tres[["timestamp"]], tz = "UTC"), eres[["timestamp"]], tolerance = 1)
+  expect_equal(tres[["foo"]], "bar")
+})
+
+
+test_that("LayoutJson `exclude_properties` works as expected", {
+  lo <- LayoutJson$new(excluded_properties = NULL)
+
+  x <- tevent$clone()
+  x$foo <- "bar"
+
+  eres <- x$values
+  json <- lo$format_event(x)
+  tres <- jsonlite::fromJSON(json)
+
+  expected_values <- c("level", "timestamp", "logger", "caller", "msg", "foo", "rawMsg")
+
   tres[sapply(tres, is.null)] <- NA_character_
-  expect_setequal(c(names(eres), "foo"), names(tres))
+  expect_setequal(expected_values, names(tres))
   expect_identical(tres[["level"]], eres[["level"]])
   expect_identical(tres[["msg"]], eres[["msg"]])
   expect_identical(tres[["caller"]], eres[["caller"]])
   expect_equal(as.POSIXct(tres[["timestamp"]], tz = "UTC"), eres[["timestamp"]], tolerance = 1)
   expect_equal(tres[["foo"]], "bar")
+  expect_equal(tres[["rawMsg"]], "foo raw")
 })