simplify code and update docs/comments

pkg/harness/controller/controller.go

@@ -142,14 +142,22 @@ func (in *stackRunController) executables(ctx context.Context) []exec.Executable
 }
 
 func (in *stackRunController) toExecutable(ctx context.Context, step *gqlclient.RunStepFragment) exec.Executable {
+	// synchronize executable and underlying console writer with
+	// the controller to ensure that it does not exit before
+	// ensuring they have completed all work.
 	in.wg.Add(1)
-	consoleWriter := sink.NewConsoleLogWriter(
+
+	consoleWriter := sink.NewConsoleWriter(
 		ctx,
 		in.consoleClient,
 		append(
 			in.sinkOptions,
 			sink.WithID(step.ID),
-			sink.WithOnFinish(in.onLogWriterFinish),
+			sink.WithOnFinish(func() {
+				// Notify controller that all remaining work
+				// has been completed.
+				in.wg.Done()
+			}),
 			sink.WithStopChan(in.stopChan),
 		)...,
 	)
@@ -170,11 +178,6 @@ func (in *stackRunController) toExecutable(ctx context.Context, step *gqlclient.
 	)
 }
 
-func (in *stackRunController) onLogWriterFinish() {
-	klog.V(log.LogLevelTrace).InfoS("log writer finished")
-	in.wg.Done()
-}
-
 func (in *stackRunController) markStackRun(status gqlclient.StackStatus) error {
 	return in.consoleClient.UpdateStackRun(in.stackRunID, gqlclient.StackRunAttributes{
 		Status: status,

pkg/harness/sink/console.go

@@ -123,7 +123,7 @@ func (in *ConsoleWriter) init() io.WriteCloser {
 	return in
 }
 
-func NewConsoleLogWriter(ctx context.Context, client console.Client, options ...Option) io.WriteCloser {
+func NewConsoleWriter(ctx context.Context, client console.Client, options ...Option) io.WriteCloser {
 	result := &ConsoleWriter{
 		ctx:    ctx,
 		buffer: helpers.NewBuffer(),