fix(enterprise): whitelist commands for streaming

We now only stream events and log entries to GE for whitelisted
commands.

core/src/cli/cli.ts

@@ -237,6 +237,7 @@ ${renderCommands(commands)}
     })
 
     contextOpts.persistent = persistent
+    const { streamEvents, streamLogEntries } = command
 
     do {
       try {
@@ -262,7 +263,7 @@ ${renderCommands(commands)}
 
           // Connect the dashboard event streamer (making sure it doesn't stream to the local server)
           const commandServerUrl = command.server?.getUrl() || undefined
-          dashboardEventStream.connect({ garden, ignoreHost: commandServerUrl })
+          dashboardEventStream.connect({ garden, ignoreHost: commandServerUrl, streamEvents, streamLogEntries })
           const runningServers = await dashboardEventStream.updateTargets()
 
           if (persistent && command.server) {
@@ -284,15 +285,15 @@ ${renderCommands(commands)}
           log.silly(`Connecting Garden instance to GE BufferedEventStream`)
           bufferedEventStream.connect({
             garden,
+            streamEvents,
+            streamLogEntries,
             targets: [
               {
                 host: enterpriseContext.enterpriseDomain,
                 clientAuthToken: enterpriseContext.clientAuthToken,
               },
             ],
           })
-        } else {
-          log.silly(`Skip connecting Garden instance to GE BufferedEventStream`)
         }
 
         // Register log file writers. We need to do this after the Garden class is initialised because

core/src/commands/base.ts

@@ -78,6 +78,8 @@ export abstract class Command<T extends Parameters = {}, U extends Parameters =
   noProject: boolean = false
   protected: boolean = false
   workflows: boolean = false // Set to true to whitelist for executing in workflow steps
+  streamEvents: boolean = false // Set to true to whitelist for streaming events
+  streamLogEntries: boolean = false // Set to true to whitelist for streaming log entries
   server: GardenServer | undefined = undefined
 
   constructor(private parent?: CommandGroup) {

core/src/commands/build.ts

@@ -48,6 +48,8 @@ export class BuildCommand extends Command<Args, Opts> {
 
   protected = true
   workflows = true
+  streamEvents = true
+  streamLogEntries = true
 
   description = dedent`
     Builds all or specified modules, taking into account build dependency order.

core/src/commands/call.ts

@@ -46,6 +46,8 @@ export class CallCommand extends Command<Args> {
   name = "call"
   help = "Call a service ingress endpoint."
 
+  streamEvents = true
+
   description = dedent`
     Resolves the deployed ingress endpoint for the given service and path, calls the given endpoint and
     outputs the result.

core/src/commands/delete.ts

@@ -82,6 +82,7 @@ export class DeleteEnvironmentCommand extends Command {
 
   protected = true
   workflows = true
+  streamEvents = true
 
   description = dedent`
     This will delete all services in the specified environment, and trigger providers to clear up any other resources
@@ -132,6 +133,7 @@ export class DeleteServiceCommand extends Command {
 
   protected = true
   workflows = true
+  streamEvents = true
 
   description = dedent`
     Deletes (i.e. un-deploys) the specified services. Note that this command does not take into account any

core/src/commands/deploy.ts

@@ -64,6 +64,8 @@ export class DeployCommand extends Command<Args, Opts> {
 
   protected = true
   workflows = true
+  streamEvents = true
+  streamLogEntries = true
 
   description = dedent`
     Deploys all or specified services, taking into account service dependency order.

core/src/commands/dev.ts

@@ -66,6 +66,9 @@ export class DevCommand extends Command<DevCommandArgs, DevCommandOpts> {
   // Currently it doesn't make sense to do file watching except in the CLI
   cliOnly = true
 
+  streamEvents = true
+  streamLogEntries = true
+
   description = dedent`
     The Garden dev console is a combination of the \`build\`, \`deploy\` and \`test\` commands.
     It builds, deploys and tests all your modules and services, and re-builds, re-deploys and re-tests

core/src/commands/get/get-status.ts

@@ -50,6 +50,7 @@ export class GetStatusCommand extends Command {
   help = "Outputs the full status of your environment."
 
   workflows = true
+  streamEvents = true
 
   outputsSchema = () =>
     joi.object().keys({

core/src/commands/get/get-task-result.ts

@@ -37,6 +37,7 @@ export class GetTaskResultCommand extends Command<Args> {
   help = "Outputs the latest execution result of a provided task."
 
   workflows = true
+  streamEvents = true
 
   arguments = getTaskResultArgs
 

core/src/commands/get/get-test-result.ts

@@ -41,6 +41,7 @@ export class GetTestResultCommand extends Command<Args> {
   help = "Outputs the latest execution result of a provided test."
 
   workflows = true
+  streamEvents = true
 
   arguments = getTestResultArgs
 

core/src/commands/publish.ts

@@ -58,6 +58,8 @@ export class PublishCommand extends Command<Args, Opts> {
   help = "Build and publish module(s) to a remote registry."
 
   workflows = true
+  streamEvents = true
+  streamLogEntries = true
 
   description = dedent`
     Publishes built module artifacts for all or specified modules.

core/src/commands/run/task.ts

@@ -56,6 +56,8 @@ export class RunTaskCommand extends Command<Args, Opts> {
   help = "Run a task (in the context of its parent module)."
 
   workflows = true
+  streamEvents = true
+  streamLogEntries = true
 
   description = dedent`
     This is useful for re-running tasks ad-hoc, for example after writing/modifying database migrations.

core/src/commands/run/test.ts

@@ -72,6 +72,8 @@ export class RunTestCommand extends Command<Args, Opts> {
   help = "Run the specified module test."
 
   workflows = true
+  streamEvents = true
+  streamLogEntries = true
 
   description = dedent`
     This can be useful for debugging tests, particularly integration/end-to-end tests.

core/src/commands/run/workflow.ts

@@ -48,6 +48,9 @@ export class RunWorkflowCommand extends Command<Args, {}> {
   name = "workflow"
   help = "Run a workflow."
 
+  streamEvents = true
+  streamLogEntries = true
+
   description = dedent`
     Runs the commands and/or scripts defined in the workflow's steps, in sequence.
 

core/src/commands/test.ts

@@ -62,6 +62,8 @@ export class TestCommand extends Command<Args, Opts> {
 
   protected = true
   workflows = true
+  streamEvents = true
+  streamLogEntries = true
 
   description = dedent`
     Runs all or specified tests defined in the project. Also builds modules and dependencies,

core/src/enterprise/buffered-event-stream.ts

@@ -48,8 +48,12 @@ interface StreamTarget {
   clientAuthToken: string
 }
 
+export type StreamRecordType = "event" | "logEntry"
+
 export interface ConnectBufferedEventStreamParams {
   targets?: StreamTarget[]
+  streamEvents: boolean
+  streamLogEntries: boolean
   garden: Garden
 }
 
@@ -85,6 +89,8 @@ export class BufferedEventStream {
   public sessionId: string
 
   protected targets: StreamTarget[]
+  protected streamEvents: boolean
+  protected streamLogEntries: boolean
 
   protected garden: Garden
   private workflowRunUid: string | undefined
@@ -118,7 +124,7 @@ export class BufferedEventStream {
     this.targets = []
   }
 
-  connect({ garden, targets }: ConnectBufferedEventStreamParams) {
+  connect({ garden, targets, streamEvents, streamLogEntries }: ConnectBufferedEventStreamParams) {
     if (this.intervalId) {
       clearInterval(this.intervalId)
     }
@@ -127,6 +133,9 @@ export class BufferedEventStream {
       this.targets = targets
     }
 
+    this.streamEvents = streamEvents
+    this.streamLogEntries = streamLogEntries
+
     if (this.garden) {
       // We unsubscribe from the old event bus' events.
       this.unsubscribeFromGardenEvents(this.garden.events)
@@ -187,15 +196,19 @@ export class BufferedEventStream {
       return
     }
 
-    this.bufferedEvents.push({
-      name,
-      payload,
-      timestamp: new Date(),
-    })
+    if (this.streamEvents) {
+      this.bufferedEvents.push({
+        name,
+        payload,
+        timestamp: new Date(),
+      })
+    }
   }
 
   streamLogEntry(logEntry: LogEntryEvent) {
-    this.bufferedLogEntries.push(logEntry)
+    if (this.streamLogEntries) {
+      this.bufferedLogEntries.push(logEntry)
+    }
   }
 
   private getHeaders(target: StreamTarget) {

core/test/unit/src/cli/cli.ts

@@ -336,6 +336,8 @@ describe("cli", () => {
       class TestCommand extends Command {
         name = "test-command"
         help = "halp!"
+        streamEvents = true
+        streamLogEntries = true
 
         async action({ garden }: CommandParams) {
           garden.events.emit("_test", "funky functional test")

core/test/unit/src/enterprise/buffered-event-stream.ts

@@ -20,6 +20,8 @@ function makeDummyRecord(sizeKb: number) {
 describe("BufferedEventStream", () => {
   const getConnectionParams = (garden: Garden) => ({
     garden,
+    streamEvents: true,
+    streamLogEntries: true,
     targets: [
       {
         host: "dummy-platform_url",

core/test/unit/src/server/dashboard-event-stream.ts

@@ -64,6 +64,8 @@ describe("DashboardEventStream", () => {
     streamer = new DashboardEventStream(garden.log, garden.sessionId!)
     streamer.connect({
       garden,
+      streamEvents: true,
+      streamLogEntries: true,
       targets: [
         { host: serverA.getUrl(), clientAuthToken: serverA.authKey },
         { host: serverB.getUrl(), clientAuthToken: serverB.authKey },
@@ -111,6 +113,8 @@ describe("DashboardEventStream", () => {
       streamer = new DashboardEventStream(garden.log, garden.sessionId!)
       streamer.connect({
         garden,
+        streamEvents: true,
+        streamLogEntries: true,
         targets: [],
       })
 
@@ -139,6 +143,8 @@ describe("DashboardEventStream", () => {
       streamer = new DashboardEventStream(garden.log, garden.sessionId!)
       streamer.connect({
         garden,
+        streamEvents: true,
+        streamLogEntries: true,
         targets: [],
       })
 
@@ -166,6 +172,8 @@ describe("DashboardEventStream", () => {
       streamer = new DashboardEventStream(garden.log, garden.sessionId!)
       streamer.connect({
         garden,
+        streamEvents: true,
+        streamLogEntries: true,
         targets: [],
       })
 
@@ -194,6 +202,8 @@ describe("DashboardEventStream", () => {
       streamer.connect({
         garden,
         targets: [],
+        streamEvents: true,
+        streamLogEntries: true,
         ignoreHost: values.serverHost,
       })
 
@@ -215,6 +225,8 @@ describe("DashboardEventStream", () => {
     streamer = new DashboardEventStream(garden.log, garden.sessionId!)
     streamer.connect({
       garden,
+      streamEvents: true,
+      streamLogEntries: true,
       targets: [],
     })