localLambdaRunner.ts: eliminate executeSamBuild()

"execute sam build" is already abstracted via
`SamCliBuildInvocationArguments`, so `executeSamBuild()` is unnecessary.

Author: justinmk3

src/shared/sam/cli/samCliBuild.ts

@@ -23,7 +23,7 @@ export interface SamCliBuildInvocationArguments {
      */
     templatePath: string
     /**
-     * Environment variables to set on the child process.
+     * Environment variables set when invoking the SAM process (NOT passed to the Lambda).
      */
     environmentVariables?: NodeJS.ProcessEnv
     /**

src/shared/sam/debugger/csharpSamDebug.ts

@@ -56,6 +56,10 @@ export async function makeCsharpConfig(config: SamLaunchRequestArgs): Promise<Sa
 
 /**
  * Launches and attaches debugger to a SAM dotnet (csharp) project.
+ *
+ * We spin up a C# Lambda Docker container, download and build the debugger for
+ * Linux, then mount it with the SAM app on run. User's C# workspace dir will
+ * have a `.vsdbg` dir after the first run.
  */
 export async function invokeCsharpLambda(ctx: ExtContext, config: SamLaunchRequestArgs): Promise<void> {
     config.samLocalInvokeCommand = new DefaultSamLocalInvokeCommand(getChannelLogger(ctx.outputChannel), [

src/shared/sam/debugger/samDebugSession.ts

@@ -59,7 +59,8 @@ export interface SamLaunchRequestArgs extends DebugProtocol.AttachRequestArgumen
     /**
      * SAM/CFN template absolute path used for SAM CLI invoke.
      * - For `target=code` this is the _generated_ template path.
-     * - For `target=template` this is the template found in the workspace.
+     * - For `target=template` this is the _generated_ template path (TODO: in
+     *   the future we may change this to be the template found in the workspace.
      */
     samTemplatePath: string
 

src/shared/sam/localLambdaRunner.ts

@@ -24,7 +24,6 @@ import { ChannelLogger } from '../utilities/vsCodeUtils'
 import { tryGetAbsolutePath } from '../utilities/workspaceUtils'
 import { DefaultValidatingSamCliProcessInvoker } from './cli/defaultValidatingSamCliProcessInvoker'
 import { SamCliBuildInvocation, SamCliBuildInvocationArguments } from './cli/samCliBuild'
-import { SamCliProcessInvoker } from './cli/samCliInvokerUtils'
 import { SamCliLocalInvokeInvocation, SamCliLocalInvokeInvocationArguments } from './cli/samCliLocalInvoke'
 import { SamLaunchRequestArgs } from './debugger/samDebugSession'
 
@@ -117,53 +116,12 @@ export async function makeInputTemplate(config: SamLaunchRequestArgs): Promise<s
     return pathutil.normalize(inputTemplatePath)
 }
 
-export interface ExecuteSamBuildArguments {
-    baseBuildDir: string
-    channelLogger: Pick<ChannelLogger, 'info'>
-    codeDir: string
-    inputTemplatePath: string
-    manifestPath?: string
-    environmentVariables?: NodeJS.ProcessEnv
-    samProcessInvoker: SamCliProcessInvoker
-    useContainer?: boolean
-}
-
-export async function executeSamBuild({
-    baseBuildDir,
-    channelLogger,
-    codeDir,
-    inputTemplatePath,
-    manifestPath,
-    environmentVariables,
-    samProcessInvoker,
-    useContainer,
-}: ExecuteSamBuildArguments): Promise<string> {
-    channelLogger.info('AWS.output.building.sam.application', 'Building SAM Application...')
-
-    const samBuildOutputFolder = path.join(baseBuildDir, 'output')
-
-    const samCliArgs: SamCliBuildInvocationArguments = {
-        buildDir: samBuildOutputFolder,
-        baseDir: codeDir,
-        templatePath: inputTemplatePath,
-        invoker: samProcessInvoker,
-        manifestPath,
-        environmentVariables,
-        useContainer,
-    }
-    await new SamCliBuildInvocation(samCliArgs).execute()
-
-    channelLogger.info('AWS.output.building.sam.application.complete', 'Build complete.')
-
-    return path.join(samBuildOutputFolder, 'template.yaml')
-}
-
 /**
  * Prepares and invokes a lambda function via `sam local invoke`.
  *
  * @param ctx
  * @param config
- * @param onAfterBuild  Called after `executeSamBuild()`
+ * @param onAfterBuild  Called after `SamCliBuildInvocation.execute()`
  */
 export async function invokeLambdaFunction(
     ctx: ExtContext,
@@ -175,25 +133,29 @@ export async function invokeLambdaFunction(
     ctx.chanLogger.info('AWS.output.sam.local.start', 'Preparing to run {0} locally...', config.handlerName)
 
     const processInvoker = new DefaultValidatingSamCliProcessInvoker({})
-    const buildArgs: ExecuteSamBuildArguments = {
-        baseBuildDir: config.baseBuildDir!,
-        channelLogger: ctx.chanLogger,
-        codeDir: config.codeRoot,
-        inputTemplatePath: config.samTemplatePath!,
+
+    ctx.chanLogger.info('AWS.output.building.sam.application', 'Building SAM Application...')
+    const samBuildOutputFolder = path.join(config.baseBuildDir!, 'output')
+    const samCliArgs: SamCliBuildInvocationArguments = {
+        buildDir: samBuildOutputFolder,
+        baseDir: config.codeRoot,
+        templatePath: config.samTemplatePath!,
+        invoker: processInvoker,
         manifestPath: config.manifestPath,
-        samProcessInvoker: processInvoker,
+        environmentVariables: {},
         useContainer: config.sam?.containerBuild || false,
-        environmentVariables: config.lambda?.environmentVariables,
     }
-
     if (!config.noDebug) {
-        buildArgs.environmentVariables = {
+        // Needed at least for dotnet case; harmless for others.
+        samCliArgs.environmentVariables = {
             SAM_BUILD_MODE: 'debug',
         }
     }
+    await new SamCliBuildInvocation(samCliArgs).execute()
+    ctx.chanLogger.info('AWS.output.building.sam.application.complete', 'Build complete.')
 
     // XXX: reassignment
-    config.samTemplatePath = await executeSamBuild(buildArgs)
+    config.samTemplatePath = path.join(samBuildOutputFolder, 'template.yaml')
     delete config.invokeTarget // Must not be used beyond this point.
 
     await onAfterBuild()