feat: add websocket endpoint to API server

The endpoint forwards any event emitted to `garden.events` to open connections, and allows commands to be executed via the socket as well.
garden-io · Dec 3, 2018 · e6fcc8b · e6fcc8b
1 parent 3c19e36
commit e6fcc8b
Show file tree

Hide file tree

Showing 20 changed files with 779 additions and 169 deletions.
diff --git a/docs/reference/commands.md b/docs/reference/commands.md
@@ -36,13 +36,13 @@ Examples:
 
 ##### Usage
 
-    garden build [module] [options]
+    garden build [modules] [options]
 
 ##### Arguments
 
 | Argument | Required | Description |
 | -------- | -------- | ----------- |
-  | `module` | No | Specify module(s) to build. Use comma as a separator to specify multiple modules.
+  | `modules` | No | Specify module(s) to build. Use comma as a separator to specify multiple modules.
 
 ##### Options
 

diff --git a/garden-service/package-lock.json b/garden-service/package-lock.json
diff --git a/garden-service/package.json b/garden-service/package.json
@@ -23,7 +23,6 @@
   ],
   "dependencies": {
     "@drubin/client-node": "0.7.1-rc1",
-    "@types/koa-bodyparser": "^4.2.1",
     "ansi-escapes": "^3.1.0",
     "async-exit-hook": "^2.0.1",
     "async-lock": "^1.1.3",
@@ -59,6 +58,7 @@
     "koa": "^2.6.2",
     "koa-bodyparser": "^4.2.1",
     "koa-router": "^7.4.0",
+    "koa-websocket": "^5.0.1",
     "lodash": "^4.17.11",
     "log-symbols": "^2.2.0",
     "moment": "^2.22.2",
@@ -69,6 +69,7 @@
     "split": "^1.0.1",
     "string-width": "^2.1.1",
     "strip-ansi": "^5.0.0",
+    "supertest": "^3.3.0",
     "sywac": "^1.2.1",
     "tar": "^4.4.6",
     "terminal-link": "^1.1.0",
@@ -102,7 +103,9 @@
     "@types/json-stringify-safe": "^5.0.0",
     "@types/klaw": "^2.1.1",
     "@types/koa": "^2.0.47",
+    "@types/koa-bodyparser": "^4.2.1",
     "@types/koa-router": "^7.0.35",
+    "@types/koa-websocket": "^5.0.3",
     "@types/lodash": "^4.14.117",
     "@types/log-symbols": "^2.0.0",
     "@types/log-update": "^2.0.0",
@@ -115,6 +118,7 @@
     "@types/path-is-inside": "^1.0.0",
     "@types/prettyjson": "0.0.28",
     "@types/string-width": "^2.0.0",
+    "@types/supertest": "^2.0.6",
     "@types/tar": "^4.0.0",
     "@types/uniqid": "^4.1.2",
     "@types/unzip": "^0.1.1",

diff --git a/garden-service/src/cli/cli.ts b/garden-service/src/cli/cli.ts
@@ -11,7 +11,6 @@ import { intersection, merge, range } from "lodash"
 import { resolve } from "path"
 import { safeDump } from "js-yaml"
 import { coreCommands } from "../commands/commands"
-
 import { DeepPrimitiveMap } from "../config/common"
 import { getEnumKeys, shutdown, sleep } from "../util/util"
 import {
@@ -24,8 +23,7 @@ import {
   StringParameter,
 } from "../commands/base"
 import { GardenError, InternalError, PluginError, toGardenError } from "../exceptions"
-import { ContextOpts, Garden } from "../garden"
-
+import { Garden, GardenOpts } from "../garden"
 import { getLogger, Logger, LoggerType } from "../logger/logger"
 import { LogLevel } from "../logger/log-node"
 import { BasicTerminalWriter } from "../logger/writers/basic-terminal-writer"
@@ -268,7 +266,7 @@ export class GardenCli {
       // entries (i.e. print new lines).
       const log = logger.placeholder()
 
-      const contextOpts: ContextOpts = { env, log }
+      const contextOpts: GardenOpts = { environmentName: env, log }
       if (command.noProject) {
         contextOpts.config = MOCK_CONFIG
       }