feat(cloud): stream command metadata

When logged in, we now stream a command metadata event.
garden-io · Jul 29, 2021 · de925e4 · de925e4
1 parent dd67389
commit de925e4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 9 deletions.
diff --git a/core/src/cli/cli.ts b/core/src/cli/cli.ts
@@ -96,7 +96,7 @@ ${renderCommands(commands)}
     `
   }
 
-  private async initFileWriters(logger: Logger, root: string, gardenDirPath: string) {
+  private async initFileWriters(logger: Logger, gardenDirPath: string) {
     if (this.fileWritersInitialized) {
       return
     }
@@ -204,12 +204,14 @@ ${renderCommands(commands)}
     })
     const dashboardEventStream = new DashboardEventStream({ log, sessionId })
 
+    const commandInfo = {
+      name: command.getFullName(),
+      args: parsedArgs,
+      opts: optionsWithAliasValues(command, parsedOpts),
+    }
+
     const contextOpts: GardenOpts = {
-      commandInfo: {
-        name: command.getFullName(),
-        args: parsedArgs,
-        opts: optionsWithAliasValues(command, parsedOpts),
-      },
+      commandInfo,
       disablePortForwards,
       environmentName,
       log,
@@ -288,11 +290,14 @@ ${renderCommands(commands)}
               },
             ],
           })
+          if (streamEvents) {
+            bufferedEventStream.streamEvent("commandInfo", commandInfo)
+          }
         }
 
         // Register log file writers. We need to do this after the Garden class is initialised because
         // the file writers depend on the project root.
-        await this.initFileWriters(logger, garden.projectRoot, garden.gardenDirPath)
+        await this.initFileWriters(logger, garden.gardenDirPath)
         analytics = await AnalyticsHandler.init(garden, log)
         analytics.trackCommand(command.getFullName())
 

diff --git a/core/src/enterprise/buffered-event-stream.ts b/core/src/enterprise/buffered-event-stream.ts
@@ -262,7 +262,6 @@ export class BufferedEventStream {
     try {
       await Bluebird.map(this.targets, (target) => {
         if (target.enterprise && this.enterpriseApi?.domain) {
-          this.log.silly(`Flushing ${description} to GE /${path}`)
           // Need to cast so the compiler doesn't complain that the two returns from the map
           // aren't equivalent. Shouldn't matter in this case since we're not collecting the return value.
           return this.enterpriseApi.post<any>(path, {

diff --git a/core/src/events.ts b/core/src/events.ts
@@ -15,6 +15,7 @@ import { NamespaceStatus, RunStatus } from "./types/plugin/base"
 import { Omit } from "./util/util"
 import { AuthTokenResponse } from "./enterprise/api"
 import { BuildState } from "./types/plugin/module/build"
+import { CommandInfo } from "./plugin-context"
 
 export type GardenEventListener<T extends EventName> = (payload: Events[T]) => void
 
@@ -115,6 +116,9 @@ export interface Events extends LoggerEvents {
   }
   moduleRemoved: {}
 
+  // Command/project metadata events
+  commandInfo: CommandInfo
+
   // TaskGraph events
   taskPending: {
     addedAt: Date
@@ -253,6 +257,7 @@ export const eventNames: EventName[] = [
   "moduleConfigChanged",
   "moduleSourcesChanged",
   "moduleRemoved",
+  "commandInfo",
   "taskPending",
   "taskProcessing",
   "taskComplete",

diff --git a/core/src/exceptions.ts b/core/src/exceptions.ts
@@ -6,7 +6,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import { isString, omit } from "lodash"
+import { isString } from "lodash"
 
 export interface GardenError {
   type: string