feat(cli): add --show-timestamps flag to CLI commands

Enables users to toggle timestamps on/off with log output

core/src/cli/cli.ts

@@ -62,10 +62,20 @@ export async function makeDummyGarden(root: string, gardenOpts: GardenOpts = {})
   return DummyGarden.factory(root, { ...gardenOpts, noEnterprise: true })
 }
 
-function initLogger({ level, loggerType, emoji }: { level: LogLevel; loggerType: LoggerType; emoji: boolean }) {
+function initLogger({
+  level,
+  loggerType,
+  emoji,
+  showTimestamps,
+}: {
+  level: LogLevel
+  loggerType: LoggerType
+  emoji: boolean
+  showTimestamps: boolean
+}) {
   const writer = getWriterInstance(loggerType, level)
   const writers = writer ? [writer] : undefined
-  return Logger.initialize({ level, writers, useEmoji: emoji })
+  return Logger.initialize({ level, writers, showTimestamps, useEmoji: emoji })
 }
 
 export interface RunOutput {
@@ -164,6 +174,7 @@ ${renderCommands(commands)}
     const {
       "logger-type": loggerTypeOpt,
       "log-level": logLevel,
+      "show-timestamps": showTimestamps,
       emoji,
       "env": environmentName,
       silent,
@@ -183,7 +194,7 @@ ${renderCommands(commands)}
 
     // Init logger
     const level = parseLogLevel(logLevel)
-    const logger = initLogger({ level, loggerType, emoji })
+    const logger = initLogger({ level, loggerType, emoji, showTimestamps })
 
     // Currently we initialise empty placeholder entries and pass those to the
     // framework as opposed to the logger itself. This is to give better control over where on

core/src/cli/params.ts

@@ -312,6 +312,10 @@ export const globalOptions = {
     help: "Enable emoji in output (defaults to true if the environment supports it).",
     defaultValue: envSupportsEmoji(),
   }),
+  "show-timestamps": new BooleanParameter({
+    help: "Show timestamps with log output.",
+    defaultValue: false,
+  }),
   "yes": new BooleanParameter({
     alias: "y",
     help: "Automatically approve any yes/no prompts during execution.",

core/src/logger/logger.ts

@@ -73,6 +73,7 @@ export function getWriterInstance(loggerType: LoggerType, level: LogLevel) {
 
 export interface LoggerConfig {
   level: LogLevel
+  showTimestamps?: boolean
   writers?: Writer[]
   useEmoji?: boolean
 }
@@ -81,6 +82,7 @@ export class Logger extends LogNode {
   public writers: Writer[]
   public events: EventBus
   public useEmoji: boolean
+  public showTimestamps: boolean
 
   private static instance: Logger
 
@@ -138,6 +140,7 @@ export class Logger extends LogNode {
     super(config.level)
     this.writers = config.writers || []
     this.useEmoji = config.useEmoji === false ? false : true
+    this.showTimestamps = !!config.showTimestamps
     this.events = new EventBus()
   }
 

core/src/logger/renderers.ts

@@ -51,6 +51,13 @@ export function combineRenders(entry: LogEntry, renderers: RenderFn[]): string {
   return renderers.map((renderer) => renderer(entry)).join("")
 }
 
+/**
+ * Returns a log entries' left margin/offset. Used for determining the spinner's x coordinate.
+ */
+export function getLeftOffset(entry: LogEntry) {
+  return entry.root.showTimestamps ? leftPad(entry).length + renderTimestamp(entry).length : leftPad(entry).length
+}
+
 /**
  * Returns the most recent message's `msg` field if it has `append` set to `false`.
  * Otherwise returns longest chain of messages with `append: true` (starting from the most recent message).
@@ -114,6 +121,15 @@ export function renderSymbol(entry: LogEntry): string {
   return symbol ? `${logSymbols[symbol]} ` : ""
 }
 
+export function renderTimestamp(entry: LogEntry): string {
+  if (!entry.root.showTimestamps) {
+    return ""
+  }
+
+  const timestamp = new Date(entry.timestamp).toISOString()
+  return `[${timestamp}] `
+}
+
 export function renderMsg(entry: LogEntry): string {
   const { fromStdStream } = entry
   const { status } = entry.getMessageState()
@@ -166,7 +182,16 @@ export function formatForTerminal(entry: LogEntry, type: PickFromUnion<LoggerTyp
 
   const symbolRenderFn = type === "basic" ? renderSymbolBasic : renderSymbol
 
-  return combineRenders(entry, [leftPad, symbolRenderFn, renderSection, renderEmoji, renderMsg, renderData, () => "\n"])
+  return combineRenders(entry, [
+    renderTimestamp,
+    leftPad,
+    symbolRenderFn,
+    renderSection,
+    renderEmoji,
+    renderMsg,
+    renderData,
+    () => "\n",
+  ])
 }
 
 export function cleanForJSON(input?: string | string[]): string {

core/src/logger/writers/fancy-terminal-writer.ts

@@ -12,7 +12,7 @@ import elegantSpinner from "elegant-spinner"
 import wrapAnsi from "wrap-ansi"
 import chalk from "chalk"
 
-import { formatForTerminal, leftPad, renderMsg, basicRender } from "../renderers"
+import { formatForTerminal, renderMsg, basicRender, getLeftOffset } from "../renderers"
 import { LogEntry } from "../log-entry"
 import { Logger } from "../logger"
 import { LogLevel } from "../log-node"
@@ -178,11 +178,11 @@ export class FancyTerminalWriter extends Writer {
       .filter((entry) => logger.level >= entry.level)
       .reduce((acc: TerminalEntry[], entry: LogEntry): TerminalEntry[] => {
         let spinnerFrame = ""
-        let spinnerX
+        let spinnerX: number
         let spinnerCoords: Coords | undefined
 
         if (entry.getMessageState().status === "active") {
-          spinnerX = leftPad(entry).length
+          spinnerX = getLeftOffset(entry)
           spinnerFrame = this.tickSpinner(entry.key)
           spinnerCoords = [spinnerX, currentLineNumber]
         } else {

core/test/unit/src/cli/cli.ts

@@ -445,6 +445,7 @@ describe("cli", () => {
           "json",
           "--yes",
           "--emoji=false",
+          "--show-timestamps=false",
           "--force-refresh",
           "--var",
           "my=value,other=something",
@@ -463,6 +464,7 @@ describe("cli", () => {
           "log-level": "4",
           "output": "json",
           "emoji": false,
+          "show-timestamps": false,
           "yes": true,
           "force-refresh": true,
           "var": ["my=value", "other=something"],
@@ -520,6 +522,7 @@ describe("cli", () => {
           "log-level": "info",
           "output": undefined,
           "emoji": envSupportsEmoji(),
+          "show-timestamps": false,
           "yes": false,
           "force-refresh": false,
           "var": undefined,
@@ -588,6 +591,7 @@ describe("cli", () => {
           "log-level": "info",
           "output": undefined,
           "emoji": envSupportsEmoji(),
+          "show-timestamps": false,
           "yes": false,
           "force-refresh": false,
           "var": undefined,

core/test/unit/src/logger/renderers.ts

@@ -196,6 +196,21 @@ describe("renderers", () => {
         expect(formatForTerminal(entry, "fancy")).to.eql("\n")
       })
     })
+    context("logger.showTimestamps is set to true", () => {
+      before(() => {
+        logger.showTimestamps = true
+      })
+      it("should include timestamp with formatted string", () => {
+        // Any cast so we can overwrite read only property
+        const entry = logger.info("hello world") as any
+        entry.timestamp = 1600555650583
+
+        expect(formatForTerminal(entry, "fancy")).to.equal(`[2020-09-19T22:47:30.583Z] ${msgStyle("hello world")}\n`)
+      })
+      after(() => {
+        logger.showTimestamps = false
+      })
+    })
   })
   describe("formatForJson", () => {
     it("should return a JSON representation of a log entry", () => {

docs/reference/commands.md

@@ -27,6 +27,7 @@ The following option flags can be used with any of the CLI commands:
   | `--log-level` | `-l` | `error` `warn` `info` `verbose` `debug` `silly` `0` `1` `2` `3` `4` `5`  | Set logger level. Values can be either string or numeric and are prioritized from 0 to 5 (highest to lowest) as follows: error: 0, warn: 1, info: 2, verbose: 3, debug: 4, silly: 5.
   | `--output` | `-o` | `json` `yaml`  | Output command result in specified format (note: disables progress logging and interactive functionality).
   | `--emoji` |  | boolean | Enable emoji in output (defaults to true if the environment supports it).
+  | `--show-timestamps` |  | boolean | Show timestamps with log output.
   | `--yes` | `-y` | boolean | Automatically approve any yes/no prompts during execution.
   | `--force-refresh` |  | boolean | Force refresh of any caches, e.g. cached provider statuses.
   | `--var` |  | array:string | Set a specific variable value, using the format <key>=<value>, e.g. `--var some-key=custom-value`. This will override any value set in your project configuration. You can specify multiple variables by separating with a comma, e.g. `--var key-a=foo,key-b="value with quotes"`.