improvement(dashboard): start dashboard before init and keep same port

We no longer restart the dashboard instance after config changes, and
instead just swap out the Garden instance from the running server.

dashboard/src/context/events.tsx

@@ -9,7 +9,7 @@
 import React from "react"
 
 import { useEffect, useState } from "react"
-import { ServerWebsocketMessage } from "garden-cli/src/server/websocket"
+import { ServerWebsocketMessage } from "garden-cli/src/server/server"
 import { Events, EventName } from "garden-cli/src/events"
 
 import getApiUrl from "../api/get-api-url"

garden-service/package.json

@@ -148,6 +148,7 @@
     "@types/uniqid": "^4.1.2",
     "@types/unzip": "^0.1.1",
     "@types/unzipper": "^0.9.1",
+    "@types/uuid": "^3.4.4",
     "@types/wrap-ansi": "^3.0.0",
     "chai": "^4.2.0",
     "gulp": "^4.0.0",

garden-service/src/cli/cli.ts

@@ -271,8 +271,14 @@ export class GardenCli {
         contextOpts.config = MOCK_CONFIG
       }
       let garden: Garden
-      let result
-      await command.printHeader(log)
+      let result: any
+
+      await command.prepare({
+        log,
+        logFooter,
+        args: parsedArgs,
+        opts: parsedOpts,
+      })
 
       do {
         garden = await Garden.factory(root, contextOpts)

garden-service/src/commands/base.ts

@@ -205,12 +205,15 @@ export interface CommandResult<T = any> {
   errors?: GardenError[]
 }
 
-export interface CommandParams<T extends Parameters = {}, U extends Parameters = {}> {
+export interface PrepareParams<T extends Parameters = {}, U extends Parameters = {}> {
   args: ParameterValues<T>
   opts: ParameterValues<U>
-  garden: Garden
   log: LogEntry
-  logFooter?: LogEntry
+  logFooter: LogEntry
+}
+
+export interface CommandParams<T extends Parameters = {}, U extends Parameters = {}> extends PrepareParams<T, U> {
+  garden: Garden
 }
 
 export abstract class Command<T extends Parameters = {}, U extends Parameters = {}> {
@@ -277,7 +280,7 @@ export abstract class Command<T extends Parameters = {}, U extends Parameters =
    * Called by the CLI before the command's action is run, but is not called again
    * if the command restarts. Useful for commands in watch mode.
    */
-  async printHeader(_: LogEntry) {
+  async prepare(_: PrepareParams<T, U>) {
   }
 
   // Note: Due to a current TS limitation (apparently covered by https://github.com/Microsoft/TypeScript/issues/7011),

garden-service/src/commands/build.ts

@@ -13,12 +13,14 @@ import {
   CommandParams,
   handleTaskResults,
   StringsParameter,
+  PrepareParams,
 } from "./base"
 import { BuildTask } from "../tasks/build"
 import { TaskResults } from "../task-graph"
 import dedent = require("dedent")
 import { processModules } from "../process"
 import { logHeader } from "../logger/util"
+import { startServer, GardenServer } from "../server/server"
 
 const buildArguments = {
   modules: new StringsParameter({
@@ -35,10 +37,10 @@ const buildOptions = {
   }),
 }
 
-type BuildArguments = typeof buildArguments
-type BuildOptions = typeof buildOptions
+type Args = typeof buildArguments
+type Opts = typeof buildOptions
 
-export class BuildCommand extends Command<BuildArguments, BuildOptions> {
+export class BuildCommand extends Command<Args, Opts> {
   name = "build"
   help = "Build your modules."
 
@@ -57,13 +59,23 @@ export class BuildCommand extends Command<BuildArguments, BuildOptions> {
   arguments = buildArguments
   options = buildOptions
 
-  async printHeader(log) {
+  private server: GardenServer
+
+  async prepare({ log, logFooter, opts }: PrepareParams<Args, Opts>) {
     logHeader({ log, emoji: "hammer", command: "Build" })
+
+    if (!!opts.watch) {
+      this.server = await startServer(logFooter)
+    }
   }
 
   async action(
-    { args, opts, garden, log, logFooter }: CommandParams<BuildArguments, BuildOptions>,
+    { args, opts, garden, log, logFooter }: CommandParams<Args, Opts>,
   ): Promise<CommandResult<TaskResults>> {
+    if (this.server) {
+      this.server.setGarden(garden)
+    }
+
     await garden.clearBuilds()
 
     const graph = await garden.getConfigGraph()

garden-service/src/commands/deploy.ts

@@ -16,6 +16,7 @@ import {
   CommandResult,
   handleTaskResults,
   StringsParameter,
+  PrepareParams,
 } from "./base"
 import { getDependantTasksForModule } from "../tasks/helpers"
 import { TaskResults } from "../task-graph"
@@ -24,6 +25,7 @@ import { logHeader } from "../logger/util"
 import { HotReloadTask } from "../tasks/hot-reload"
 import { BaseTask } from "../tasks/base"
 import { getHotReloadServiceNames, validateHotReloadServiceNames } from "./helpers"
+import { startServer, GardenServer } from "../server/server"
 
 const deployArgs = {
   services: new StringsParameter({
@@ -80,11 +82,21 @@ export class DeployCommand extends Command<Args, Opts> {
   arguments = deployArgs
   options = deployOpts
 
-  async printHeader(log) {
+  private server: GardenServer
+
+  async prepare({ log, logFooter, opts }: PrepareParams<Args, Opts>) {
     logHeader({ log, emoji: "rocket", command: "Deploy" })
+
+    if (!!opts.watch) {
+      this.server = await startServer(logFooter)
+    }
   }
 
   async action({ garden, log, logFooter, args, opts }: CommandParams<Args, Opts>): Promise<CommandResult<TaskResults>> {
+    if (this.server) {
+      this.server.setGarden(garden)
+    }
+
     const initGraph = await garden.getConfigGraph()
     const services = await initGraph.getServices(args.services)
 
@@ -94,7 +106,8 @@ export class DeployCommand extends Command<Args, Opts> {
     }
 
     const hotReloadServiceNames = await getHotReloadServiceNames(opts["hot-reload"], initGraph)
-    let watch
+    let watch: boolean
+
     if (hotReloadServiceNames.length > 0) {
       await initGraph.getServices(hotReloadServiceNames) // validate the existence of these services
       const errMsg = await validateHotReloadServiceNames(hotReloadServiceNames, initGraph)

garden-service/src/commands/dev.ts

@@ -23,6 +23,7 @@ import {
   CommandParams,
   StringsParameter,
   handleTaskResults,
+  PrepareParams,
 } from "./base"
 import { STATIC_DIR } from "../constants"
 import { processModules } from "../process"
@@ -31,6 +32,7 @@ import { getTestTasks } from "../tasks/test"
 import { HotReloadTask } from "../tasks/hot-reload"
 import { ConfigGraph } from "../config-graph"
 import { getHotReloadServiceNames, validateHotReloadServiceNames } from "./helpers"
+import { GardenServer, startServer } from "../server/server"
 
 const ansiBannerPath = join(STATIC_DIR, "garden-banner-2.txt")
 
@@ -73,15 +75,21 @@ export class DevCommand extends Command<Args, Opts> {
 
   options = devOpts
 
-  async printHeader(log) {
+  private server: GardenServer
+
+  async prepare({ log, logFooter }: PrepareParams<Args, Opts>) {
     // print ANSI banner image
     const data = await readFile(ansiBannerPath)
     log.info(data.toString())
 
     log.info(chalk.gray.italic(`\nGood ${getGreetingTime()}! Let's get your environment wired up...\n`))
+
+    this.server = await startServer(logFooter)
   }
 
   async action({ garden, log, logFooter, opts }: CommandParams<Args, Opts>): Promise<CommandResult> {
+    this.server.setGarden(garden)
+
     const graph = await garden.getConfigGraph()
     const modules = await graph.getModules()
 

garden-service/src/commands/get/get-tasks.ts

@@ -14,6 +14,7 @@ import {
   CommandResult,
   CommandParams,
   StringsParameter,
+  PrepareParams,
 } from "../base"
 import { logHeader } from "../../logger/util"
 import { Task } from "../../types/task"
@@ -24,7 +25,7 @@ const getTasksArgs = {
   }),
 }
 
-type GetTasksArguments = typeof getTasksArgs
+type Args = typeof getTasksArgs
 
 export function prettyPrintTask(task: Task): string {
   let out = `${chalk.cyan.bold(task.name)}`
@@ -54,17 +55,17 @@ function printField(name: string, value: string | null) {
   return `${chalk.gray(name)}: ${value || ""}`
 }
 
-export class GetTasksCommand extends Command<GetTasksArguments> {
+export class GetTasksCommand extends Command<Args> {
   name = "tasks"
   help = "Lists the tasks defined in your project's modules."
 
   arguments = getTasksArgs
 
-  async printHeader(log) {
+  async prepare({ log }: PrepareParams<Args>) {
     logHeader({ log, emoji: "open_book", command: "Tasks" })
   }
 
-  async action({ args, garden, log }: CommandParams<GetTasksArguments>): Promise<CommandResult> {
+  async action({ args, garden, log }: CommandParams<Args>): Promise<CommandResult> {
     const graph = await garden.getConfigGraph()
     const tasks = await graph.getTasks(args.tasks)
     const taskModuleNames = uniq(tasks.map(t => t.module.name))

garden-service/src/commands/serve.ts

@@ -8,10 +8,10 @@
 
 import dedent = require("dedent")
 import { LoggerType } from "../logger/logger"
-import { IntegerParameter } from "./base"
+import { IntegerParameter, PrepareParams } from "./base"
 import { Command, CommandResult, CommandParams } from "./base"
 import { sleep } from "../util/util"
-import { startServer, DEFAULT_PORT } from "../server/server"
+import { DEFAULT_PORT, GardenServer, startServer } from "../server/server"
 
 const serveArgs = {}
 
@@ -41,8 +41,14 @@ export class ServeCommand extends Command<Args, Opts> {
   arguments = serveArgs
   options = serveOpts
 
-  async action({ garden, log, opts }: CommandParams<Args, Opts>): Promise<CommandResult<{}>> {
-    await startServer(garden, log, opts.port)
+  private server: GardenServer
+
+  async prepare({ logFooter, opts }: PrepareParams<Args, Opts>) {
+    this.server = await startServer(logFooter, opts.port)
+  }
+
+  async action({ garden }: CommandParams<Args, Opts>): Promise<CommandResult<{}>> {
+    this.server.setGarden(garden)
 
     // The server doesn't block, so we need to loop indefinitely here.
     while (true) {

garden-service/src/commands/test.ts

@@ -18,12 +18,14 @@ import {
   handleTaskResults,
   StringOption,
   StringsParameter,
+  PrepareParams,
 } from "./base"
 import { TaskResults } from "../task-graph"
 import { processModules } from "../process"
 import { Module } from "../types/module"
 import { getTestTasks } from "../tasks/test"
 import { logHeader } from "../logger/util"
+import { GardenServer, startServer } from "../server/server"
 
 const testArgs = {
   modules: new StringsParameter({
@@ -72,16 +74,27 @@ export class TestCommand extends Command<Args, Opts> {
   arguments = testArgs
   options = testOpts
 
-  async printHeader(log) {
+  private server: GardenServer
+
+  async prepare({ log, logFooter, opts }: PrepareParams<Args, Opts>) {
     logHeader({
       log,
       emoji: "thermometer",
       command: `Running tests`,
     })
+
+    if (!!opts.watch) {
+      this.server = await startServer(logFooter)
+    }
   }
 
   async action({ garden, log, logFooter, args, opts }: CommandParams<Args, Opts>): Promise<CommandResult<TaskResults>> {
+    if (this.server) {
+      this.server.setGarden(garden)
+    }
+
     const graph = await garden.getConfigGraph()
+
     let modules: Module[]
     if (args.modules) {
       modules = await graph.withDependantModules(await graph.getModules(args.modules))

garden-service/src/process.ts

@@ -17,7 +17,6 @@ import { TaskResults } from "./task-graph"
 import { isModuleLinked } from "./util/ext-source-util"
 import { Garden } from "./garden"
 import { LogEntry } from "./logger/log-entry"
-import { startServer } from "./server/server"
 import { ConfigGraph } from "./config-graph"
 import { dedent } from "./util/string"
 import { ConfigurationError } from "./exceptions"
@@ -169,11 +168,6 @@ export async function processModules(
     })
   })
 
-  // Start HTTP API and dashboard server.
-  // allow overriding automatic port picking
-  const port = Number(process.env.GARDEN_SERVER_PORT) || undefined
-  await startServer(garden, log, port)
-
   await restartPromise
 
   return {

garden-service/src/server/commands.ts

@@ -10,7 +10,6 @@ import Joi = require("joi")
 import Koa = require("koa")
 import { Command, Parameters } from "../commands/base"
 import { validate } from "../config/common"
-import { coreCommands } from "../commands/commands"
 import { mapValues, omitBy } from "lodash"
 import { Garden } from "../garden"
 import { LogLevel } from "../logger/log-node"
@@ -108,6 +107,8 @@ export async function prepareCommands(): Promise<CommandMap> {
     command.getSubCommands().forEach(addCommand)
   }
 
+  // Need to import this here to avoid circular import issues
+  const { coreCommands } = require("../commands/commands")
   coreCommands.forEach(addCommand)
 
   return commands