fix(cli): edge-case error when writing error logs

garden-io · Feb 24, 2020 · 29fe3aa · 29fe3aa
1 parent 5145d3f
commit 29fe3aa
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/garden-service/src/logger/renderers.ts b/garden-service/src/logger/renderers.ts
@@ -18,7 +18,7 @@ import hasAnsi = require("has-ansi")
 import { LogEntry, MessageState } from "./log-entry"
 import { JsonLogEntry } from "./writers/json-terminal-writer"
 import { highlightYaml, deepFilter, PickFromUnion } from "../util/util"
-import { isNumber } from "util"
+import { isNumber, isBuffer } from "util"
 import { printEmoji, sanitizeObject } from "./util"
 import { LoggerType, Logger } from "./logger"
 
@@ -91,8 +91,8 @@ export function renderError(entry: LogEntry) {
     let out = stack || message
 
     // We recursively filter out internal fields (i.e. having names starting with _).
-    const filteredDetail = deepFilter(detail, (_, key: string | number) => {
-      return isNumber(key) || !key.startsWith("_")
+    const filteredDetail = deepFilter(detail, (_: any, key: string | number) => {
+      return !isNumber(key) && !key.startsWith("_")
     })
 
     if (!isEmpty(filteredDetail)) {

diff --git a/garden-service/src/logger/util.ts b/garden-service/src/logger/util.ts
@@ -11,6 +11,8 @@ import chalk from "chalk"
 import CircularJSON from "circular-json"
 import { LogNode } from "./log-node"
 import { LogEntry, LogEntryParams, EmojiName } from "./log-entry"
+import { isBuffer } from "util"
+import { deepMap } from "../util/util"
 
 export interface Node {
   children: any[]
@@ -140,5 +142,8 @@ export function printWarningMessage(log: LogEntry, text: string) {
  * Strips undefined values and circular references from an object.
  */
 export function sanitizeObject(obj: any) {
+  obj = deepMap(obj, (value: any) => {
+    return isBuffer(value) ? "<Buffer>" : value
+  })
   return JSON.parse(CircularJSON.stringify(obj))
 }
diff --git a/garden-service/test/unit/src/logger/util.ts b/garden-service/test/unit/src/logger/util.ts
@@ -8,7 +8,7 @@
 
 import { expect } from "chai"
 
-import { getChildNodes } from "../../../../src/logger/util"
+import { getChildNodes, sanitizeObject } from "../../../../src/logger/util"
 
 describe("util", () => {
   describe("getChildNodes", () => {
@@ -41,4 +41,15 @@ describe("util", () => {
       expect(nodeList.map((n) => n.id)).to.eql([1, 2, 3, 4, 5, 6])
     })
   })
+
+  describe("sanitizeObject", () => {
+    it("should replace any buffer values", () => {
+      const obj = {
+        something: "test",
+        buffer: Buffer.from("bla"),
+      }
+
+      expect(sanitizeObject(obj)).to.eql({ something: "test", buffer: "<Buffer>" })
+    })
+  })
 })