From 2a885c88dbf72cd1300e7c7856f43edbe96fe8e4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ey=C3=BE=C3=B3r=20Magn=C3=BAsson?= <eysi09@gmail.com>
Date: Thu, 7 Mar 2019 16:37:19 +0100
Subject: [PATCH] fix: stream container build output and cap max buffer size

---
 .../src/plugins/container/helpers.ts          |  7 ++--
 garden-service/src/util/util.ts               | 36 ++++++++++++++-----
 2 files changed, 31 insertions(+), 12 deletions(-)

diff --git a/garden-service/src/plugins/container/helpers.ts b/garden-service/src/plugins/container/helpers.ts
index a1c30a2750..2421ce7982 100644
--- a/garden-service/src/plugins/container/helpers.ts
+++ b/garden-service/src/plugins/container/helpers.ts
@@ -6,12 +6,10 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import execa = require("execa")
-
 import { pathExists } from "fs-extra"
 import { join } from "path"
 import { ConfigurationError } from "../../exceptions"
-import { splitFirst } from "../../util/util"
+import { splitFirst, spawn } from "../../util/util"
 import { ModuleConfig } from "../../config/module"
 import { ContainerModule, ContainerRegistryConfig, defaultTag, defaultNamespace } from "./config"
 
@@ -147,7 +145,8 @@ export const containerHelpers = {
 
   async dockerCli(module: ContainerModule, args: string[]) {
     // TODO: use dockerode instead of CLI
-    return execa.stdout("docker", args, { cwd: module.buildPath, maxBuffer: 1024 * 1024 })
+    const output = await spawn("docker", args, { cwd: module.buildPath })
+    return output.output || ""
   },
 
   async hasDockerfile(module: ContainerModule) {
diff --git a/garden-service/src/util/util.ts b/garden-service/src/util/util.ts
index de07360349..1c562091b9 100644
--- a/garden-service/src/util/util.ts
+++ b/garden-service/src/util/util.ts
@@ -51,6 +51,8 @@ export type Unpacked<T> =
   : T extends Promise<infer W> ? W
   : T
 
+const MAX_BUFFER_SIZE = 1024 * 1024
+
 export function shutdown(code) {
   // This is a good place to log exitHookNames if needed.
   process.exit(code)
@@ -166,6 +168,21 @@ export interface SpawnOutput {
   proc: any
 }
 
+/**
+ * Truncates the first n characters from a string where n equals the number by
+ * which the string byte length exceeds the MAX_BUFFER_SIZE.
+ *
+ * Note that a utf8 character can be 1-4 bytes so this is a naive but inexpensive approach.
+ */
+function naivelyTruncateBytes(str: string) {
+  const overflow = Buffer.byteLength(str, "utf8") - MAX_BUFFER_SIZE
+  if (overflow > 0) {
+    str = str.substr(overflow)
+  }
+  return str
+}
+
+// TODO Dump output to a log file if it exceeds the MAX_BUFFER_SIZE
 export function spawn(cmd: string, args: string[], opts: SpawnOpts = {}) {
   const { timeout = 0, cwd, data, ignoreError = false, env, tty } = opts
 
@@ -193,14 +210,14 @@ export function spawn(cmd: string, args: string[], opts: SpawnOpts = {}) {
     _process.stdin.setRawMode && _process.stdin.setRawMode(true)
 
   } else {
+    // We ensure the output strings never exceed the MAX_BUFFER_SIZE
     proc.stdout.on("data", (s) => {
-      result.output += s
-      result.stdout! += s
+      result.output = naivelyTruncateBytes(result.output + s)
+      result.stdout! = naivelyTruncateBytes(result.stdout! + s)
     })
 
     proc.stderr.on("data", (s) => {
-      result.output += s
-      result.stderr! += s
+      result.stderr! = naivelyTruncateBytes(result.stderr! + s)
     })
 
     if (data) {
@@ -230,10 +247,13 @@ export function spawn(cmd: string, args: string[], opts: SpawnOpts = {}) {
       if (code === 0 || ignoreError) {
         resolve(result)
       } else {
-        _reject(new RuntimeError(
-          `${cmd} exited with code ${code}. Here is the output:\n\n ${result.output}`,
-          { cmd, args, opts },
-        ))
+        const nLinesToShow = 100
+        const output = result.output.split("\n").slice(-nLinesToShow).join("\n")
+        const msg =
+          `Command failed with code ${code}: ${cmd} ${args.join(" ")}\n\n` +
+          `${result.stderr}\n` +
+          `Here are the last ${nLinesToShow} lines of the output:\n\n ${output}`
+        _reject(new RuntimeError(msg, { cmd, args, opts, result }))
       }
     })
   })