fix(logger): concat messages when formatting for json

garden-service/src/logger/renderers.ts

@@ -197,10 +197,12 @@ export function cleanWhitespace(str) {
   return str.replace(/\s+/g, " ")
 }
 
-export function formatForJSON(entry: LogEntry): JsonLogEntry {
+// TODO: Include individual message states with timestamp
+export function formatForJson(entry: LogEntry): JsonLogEntry {
   const { data } = entry
+  const { section } = entry.getMessageState()
   const metadata = entry.getMetadata()
-  const { msg, section } = entry.getMessageState()
+  const msg = chainMessages(entry.getMessageStates() || [])
   return {
     msg: cleanForJSON(msg),
     data,

garden-service/src/logger/writers/json-terminal-writer.ts

@@ -10,7 +10,7 @@ import { LogLevel } from "../log-node"
 import { LogEntry, LogEntryMetadata } from "../log-entry"
 import { Logger } from "../logger"
 import { Writer } from "./base"
-import { formatForJSON } from "../renderers"
+import { formatForJson } from "../renderers"
 
 export interface JsonLogEntry {
   msg: string,
@@ -26,7 +26,7 @@ export class JsonTerminalWriter extends Writer {
   render(entry: LogEntry, logger: Logger): string | null {
     const level = this.level || logger.level
     if (level >= entry.level) {
-      const jsonEntry = formatForJSON(entry)
+      const jsonEntry = formatForJson(entry)
       const empty = !(jsonEntry.msg || jsonEntry.data)
       return empty ? null : JSON.stringify(jsonEntry)
     }

garden-service/test/unit/src/logger/log-entry.ts

@@ -74,7 +74,7 @@ describe("LogEntry", () => {
     }
     it("should update entry state", () => {
       const timestamp = freezeTime().valueOf()
-      const taskMetaData: TaskMetadata = {
+      const taskMetadata: TaskMetadata = {
         type: "a",
         key: "a",
         status: "active",
@@ -88,7 +88,7 @@ describe("LogEntry", () => {
         section: "caesar",
         symbol: "info",
         status: "done",
-        metadata: { task: taskMetaData },
+        metadata: { task: taskMetadata },
       })
 
       expect(entry.getMessageStates()).to.eql([{
@@ -100,7 +100,7 @@ describe("LogEntry", () => {
         append: undefined,
         timestamp,
       }])
-      expect(entry.getMetadata()).to.eql({ task: taskMetaData })
+      expect(entry.getMetadata()).to.eql({ task: taskMetadata })
     })
     it("should overwrite previous values", () => {
       const timestamp = freezeTime().valueOf()
@@ -176,27 +176,27 @@ describe("LogEntry", () => {
     })
     it("should update the metadata property", () => {
       const timestamp = freezeTime().valueOf()
-      const taskMetaDataA: TaskMetadata = {
+      const taskMetadataA: TaskMetadata = {
         type: "a",
         key: "a",
         status: "active",
         uid: "1",
         versionString: "123",
       }
-      const taskMetaDataB: TaskMetadata = {
-        ...taskMetaDataA,
+      const taskMetadataB: TaskMetadata = {
+        ...taskMetadataA,
         status: "error",
       }
       const entry = logger.placeholder()
-      entry.setState({ metadata: { task: taskMetaDataA } })
-      expect(entry.getMetadata()).to.eql({ task: taskMetaDataA })
+      entry.setState({ metadata: { task: taskMetadataA } })
+      expect(entry.getMetadata()).to.eql({ task: taskMetadataA })
       // Message states should not change
       expect(entry.getMessageStates()).to.eql([
         { ...emptyState, timestamp },
       ])
 
-      entry.setState({ metadata: { task: taskMetaDataB } })
-      expect(entry.getMetadata()).to.eql({ task: taskMetaDataB })
+      entry.setState({ metadata: { task: taskMetadataB } })
+      expect(entry.getMetadata()).to.eql({ task: taskMetadataB })
       expect(entry.getMessageStates()).to.eql([
         { ...emptyState, timestamp },
         { ...emptyState, timestamp },

garden-service/test/unit/src/logger/renderers.ts

@@ -8,9 +8,11 @@ import {
   formatForTerminal,
   chainMessages,
   renderError,
+  formatForJson,
 } from "../../../../src/logger/renderers"
 import { GardenError } from "../../../../src/exceptions"
 import dedent = require("dedent")
+import { TaskMetadata } from "../../../../src/logger/log-entry"
 
 const logger = getLogger()
 
@@ -108,4 +110,51 @@ describe("renderers", () => {
       expect(formatForTerminal(entry)).to.equal("")
     })
   })
+  describe("formatForJson", () => {
+    it("should return a JSON representation of a log entry", () => {
+      const taskMetadata: TaskMetadata = {
+        type: "a",
+        key: "a",
+        status: "active",
+        uid: "1",
+        versionString: "123",
+      }
+      const entry = logger.info({
+        msg: "hello",
+        emoji: "haircut",
+        symbol: "info",
+        status: "done",
+        section: "c",
+        data: { foo: "bar" },
+        metadata: { task: taskMetadata },
+      })
+      expect(formatForJson(entry)).to.eql({
+        msg: "hello",
+        section: "c",
+        data: { foo: "bar" },
+        metadata: { task: taskMetadata },
+      })
+    })
+    it("should append messages if applicable", () => {
+      const entry = logger.info({
+        msg: "hello",
+      })
+      entry.setState({ msg: "world", append: true })
+      expect(formatForJson(entry)).to.eql({
+        msg: "hello - world",
+        section: "",
+        data: undefined,
+        metadata: undefined,
+      })
+    })
+    it("should handle undefined messages", () => {
+      const entry = logger.placeholder()
+      expect(formatForJson(entry)).to.eql({
+        msg: "",
+        section: "",
+        data: undefined,
+        metadata: undefined,
+      })
+    })
+  })
 })

garden-service/test/unit/src/logger/writers/json-terminal-writer.ts

@@ -3,7 +3,6 @@ import { expect } from "chai"
 import { LogLevel } from "../../../../../src/logger/log-node"
 import { JsonTerminalWriter } from "../../../../../src/logger/writers/json-terminal-writer"
 import { getLogger } from "../../../../../src/logger/logger"
-import { formatForJSON } from "../../../../../src/logger/renderers"
 
 const logger = getLogger()
 
@@ -17,7 +16,14 @@ describe("JsonTerminalWriter", () => {
       const writer = new JsonTerminalWriter()
       const entry = logger.info("hello logger")
       const out = writer.render(entry, logger)
-      expect(out).to.eql(JSON.stringify(formatForJSON(entry)))
+      expect(out).to.eql('{"msg":"hello logger","section":""}')
+    })
+    it("should chain messages with 'append' set to true", () => {
+      const writer = new JsonTerminalWriter()
+      const entry = logger.info("hello logger")
+      entry.setState({ msg: "hello again", append: true })
+      const out = writer.render(entry, logger)
+      expect(out).to.eql('{"msg":"hello logger - hello again","section":""}')
     })
     it("should return null if message is an empty string", () => {
       const writer = new JsonTerminalWriter()
@@ -41,7 +47,7 @@ describe("JsonTerminalWriter", () => {
       const writer = new JsonTerminalWriter({ level: LogLevel.verbose })
       const entry = logger.verbose("cormorant")
       const out = writer.render(entry, logger)
-      expect(out).to.eql(JSON.stringify(formatForJSON(entry)))
+      expect(out).to.eql('{"msg":"cormorant","section":""}')
     })
   })
 })