Merge staging into feature/c9toolkit

Author: aws-toolkit-automation

src/shared/sam/cli/samCliBuild.ts

@@ -8,6 +8,8 @@ import { getLogger, Logger } from '../../logger'
 import { logAndThrowIfUnexpectedExitCode, SamCliProcessInvoker } from './samCliInvokerUtils'
 import { DefaultSamCliProcessInvoker } from './samCliInvoker'
 import { pushIf } from '../../utilities/collectionUtils'
+import { ext } from '../../extensionGlobals'
+import { getChannelLogger } from '../../utilities/vsCodeUtils'
 
 export interface SamCliBuildInvocationArguments {
     /**
@@ -107,6 +109,7 @@ export class SamCliBuildInvocation {
         const childProcessResult = await this.args.invoker.invoke({
             spawnOptions: { env },
             arguments: invokeArgs,
+            channelLogger: getChannelLogger(ext.outputChannel),
         })
 
         logAndThrowIfUnexpectedExitCode(childProcessResult, 0)

src/shared/sam/cli/samCliInvoker.ts

@@ -41,12 +41,13 @@ export class DefaultSamCliProcessInvoker implements SamCliProcessInvoker {
 
     public async invoke(options?: SamCliProcessInvokeOptions): Promise<ChildProcessResult> {
         const invokeOptions = makeRequiredSamCliProcessInvokeOptions(options)
+        const logger = getLogger()
 
         const sam = await this.context.cliConfig.getOrDetectSamCli()
         if (!sam.path) {
-            getLogger().warn('SAM CLI not found and not configured')
+            logger.warn('SAM CLI not found and not configured')
         } else if (sam.autoDetected) {
-            getLogger().info('SAM CLI not configured, using SAM found at: %O', sam.path)
+            logger.info('SAM CLI not configured, using SAM found at: %O', sam.path)
         }
 
         const samCommand = sam.path ? sam.path : 'sam'
@@ -56,6 +57,17 @@ export class DefaultSamCliProcessInvoker implements SamCliProcessInvoker {
             ...invokeOptions.arguments
         )
 
-        return await childProcess.run()
+        options?.channelLogger?.info('AWS.running.command', 'Running command: {0}', `${childProcess}`)
+        logger.verbose(`running: ${childProcess}`)
+        return await childProcess.run(
+            (text: string) => {
+                options?.channelLogger?.emitMessage(text)
+                logger.verbose(`stdout: ${text}`)
+            },
+            (text: string) => {
+                options?.channelLogger?.emitMessage(text)
+                logger.verbose(`stderr: ${text}`)
+            }
+        )
     }
 }

src/shared/sam/cli/samCliInvokerUtils.ts

@@ -6,15 +6,18 @@
 import { SpawnOptions } from 'child_process'
 import { getLogger } from '../../logger'
 import { ChildProcessResult } from '../../utilities/childProcess'
+import { ChannelLogger } from '../../utilities/vsCodeUtils'
 
 export interface SamCliProcessInvokeOptions {
     spawnOptions?: SpawnOptions
     arguments?: string[]
+    /** Optionally log stdout and stderr to the specified logger */
+    channelLogger?: ChannelLogger
 }
 
 export function makeRequiredSamCliProcessInvokeOptions(
     options?: SamCliProcessInvokeOptions
-): Required<SamCliProcessInvokeOptions> {
+): Required<Omit<SamCliProcessInvokeOptions, 'channelLogger'>> {
     options = options || {}
 
     return {

src/shared/sam/cli/samCliLocalInvoke.ts

@@ -5,12 +5,10 @@
 
 import * as child_process from 'child_process'
 import { pushIf } from '../../utilities/collectionUtils'
-import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 import { fileExists } from '../../filesystemUtilities'
 import { getLogger, Logger } from '../../logger'
 import { ChildProcess } from '../../utilities/childProcess'
-import { removeAnsi } from '../../utilities/textUtilities'
 import { Timeout } from '../../utilities/timeoutUtils'
 import { ChannelLogger } from '../../utilities/vsCodeUtils'
 import { DefaultSamCliProcessInvokerContext, SamCliProcessInvokerContext } from './samCliInvoker'
@@ -59,13 +57,13 @@ export class DefaultSamLocalInvokeCommand implements SamLocalInvokeCommand {
 
             await childProcess.start({
                 onStdout: (text: string): void => {
-                    this.emitMessage(text)
+                    this.channelLogger.emitMessage(text)
                     // If we have a timeout (as we do on debug) refresh the timeout as we receive text
                     params.timeout?.refresh()
                     this.logger.verbose(`stdout: ${text}`)
                 },
                 onStderr: (text: string): void => {
-                    this.emitMessage(text)
+                    this.channelLogger.emitMessage(text)
                     // If we have a timeout (as we do on debug) refresh the timeout as we receive text
                     params.timeout?.refresh()
                     this.logger.verbose(`stderr: ${text}`)
@@ -135,13 +133,6 @@ export class DefaultSamLocalInvokeCommand implements SamLocalInvokeCommand {
             }
         })
     }
-
-    private emitMessage(text: string): void {
-        // From VS Code API: If no debug session is active, output sent to the debug console is not shown.
-        // We send text to output channel and debug console to ensure no text is lost.
-        this.channelLogger.channel.append(removeAnsi(text))
-        vscode.debug.activeDebugConsole.append(text)
-    }
 }
 
 export interface SamCliLocalInvokeInvocationArguments {

src/shared/utilities/childProcess.ts

@@ -64,7 +64,10 @@ export class ChildProcess {
     /**
      * Calls `start()` with default listeners that resolve()/reject() on process end.
      */
-    public async run(): Promise<ChildProcessResult> {
+    public async run(
+        onStdout?: (text: string) => void,
+        onStderr?: (text: string) => void
+    ): Promise<ChildProcessResult> {
         return await new Promise<ChildProcessResult>(async (resolve, reject) => {
             await this.start({
                 collect: true,
@@ -79,6 +82,8 @@ export class ChildProcess {
                         resolve(this.processResult)
                     }
                 },
+                onStderr: onStderr,
+                onStdout: onStdout,
             }).catch(reject)
             if (!this.childProcess) {
                 reject('child process not started')

src/shared/utilities/vsCodeUtils.ts

@@ -8,6 +8,7 @@ import * as nls from 'vscode-nls'
 import { getLogger, LogLevel } from '../logger'
 import { Loggable } from '../logger/loggableType'
 import { ext } from '../../shared/extensionGlobals'
+import { removeAnsi } from './textUtilities'
 
 // TODO: Consider NLS initialization/configuration here & have packages to import localize from here
 export const localize = nls.loadMessageBundle()
@@ -58,6 +59,8 @@ export interface ChannelLogger {
     info: TemplateHandler
     warn: TemplateHandler
     error: TemplateHandler
+    /** For when it's necessary to emit non-templated text (e.g. output from a CLI) */
+    emitMessage: (message: string) => void
 }
 
 /**
@@ -115,6 +118,12 @@ export function getChannelLogger(channel: vscode.OutputChannel): ChannelLogger {
                 nlsTemplate,
                 templateTokens,
             }),
+        emitMessage: (text: string) => {
+            // From VS Code API: If no debug session is active, output sent to the debug console is not shown.
+            // We send text to output channel and debug console to ensure no text is lost.
+            channel.append(removeAnsi(text))
+            vscode.debug.activeDebugConsole.append(text)
+        },
     })
 }
 

src/test/shared/fakeChannelLogger.ts

@@ -36,4 +36,6 @@ export class FakeChannelLogger implements ChannelLogger {
     public verbose(nlsKey: string, nlsTemplate: string, ...templateTokens: Loggable[]): void {
         this.loggedVerboseKeys.add(nlsKey)
     }
+
+    public emitMessage(message: string): void {}
 }