From d7ad8d855ea61713a571083117037e1619a07eb6 Mon Sep 17 00:00:00 2001
From: Jon Edvald <edvald@gmail.com>
Date: Tue, 1 Sep 2020 20:06:26 +0200
Subject: [PATCH] improvement(cli): catch OOM errors and exit with helpful
 error message

This is one of a series of improvements I'm working on, to warn users
about very large projects that probably need better configuration of
includes/excludes/ignores.

This catches the "nuclear" case of running out of heap space, exiting
with a standard code of 137, and printing an error with a link to docs.
---
 cli/bin/garden   | 37 +++++++++++++++++++++++++++++++++++--
 cli/package.json |  4 ++--
 2 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/cli/bin/garden b/cli/bin/garden
index d7e4414657..2affdbfa60 100755
--- a/cli/bin/garden
+++ b/cli/bin/garden
@@ -1,8 +1,41 @@
 #!/usr/bin/env node
 
+const cluster = require("cluster")
+const v8 = require("v8")
 require("source-map-support").install()
 
 const cli = require("../build/src/cli")
+const chalk = require("chalk")
 
-// tslint:disable-next-line: no-floating-promises
-cli.runCli()
+// Wrapping and forking, to catch OOM errors and print helpful message
+// See https://medium.com/@evgeni.leonti/detect-heap-overflow-on-node-js-javascript-heap-out-of-memory-41cb649c6b33
+if (cluster.isMaster) {
+  cluster.fork()
+  cluster.on("exit", (_, workerExitCode) => {
+    process.exit(workerExitCode)
+  })
+} else {
+  // Worker process
+  const totalHeapSizeThreshold = (v8.getHeapStatistics().heap_size_limit * 85) / 100
+
+  let detectHeapOverflow = () => {
+    let stats = v8.getHeapStatistics()
+
+    if (stats.total_heap_size > totalHeapSizeThreshold) {
+      // tslint:disable-next-line: no-console
+      console.error(
+        chalk.red.bold(`
+Process memory threshold reached. This most likely means there are too many files in the project, and that you need to exclude large dependency directories. Please see https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories for information on how to do that.
+
+If this keeps occurring after configuring exclusions, please file an issue at https://github.com/garden-io/garden/issues.
+        `)
+      )
+
+      process.exit(137)
+    }
+  }
+  setInterval(detectHeapOverflow, 1000)
+
+  // tslint:disable-next-line: no-floating-promises
+  cli.runCli()
+}
diff --git a/cli/package.json b/cli/package.json
index c6c1a81808..82c64b4f97 100644
--- a/cli/package.json
+++ b/cli/package.json
@@ -25,14 +25,14 @@
     "@garden-io/core": "*",
     "@garden-io/garden-conftest": "*",
     "@garden-io/garden-conftest-container": "*",
-    "@garden-io/garden-conftest-kubernetes": "*"
+    "@garden-io/garden-conftest-kubernetes": "*",
+    "chalk": "^4.1.0"
   },
   "devDependencies": {
     "@types/chai": "^4.2.12",
     "@types/mocha": "^8.0.3",
     "bluebird": "^3.7.2",
     "chai": "^4.2.0",
-    "chalk": "^4.1.0",
     "execa": "^4.0.3",
     "lodash": "^4.17.20",
     "minimist": "^1.2.5",