Added support for the use container option when running lamdas locally (#913)

gsweetwood · web-flow · commit e1ed2653346f · 2020-01-31T15:05:08.000-08:00
* Added support for the use container option when running lamdas locally * Changed description text to SAM Docker container * Revert "Changed description text to SAM Docker container" This reverts commit 003a889. * Moved and renamed getConfig function Changed terminology in useContainer descripition to be more accurate
diff --git a/src/lambda/config/templates.ts b/src/lambda/config/templates.ts
@@ -15,6 +15,7 @@ import { mkdir } from '../../shared/filesystem'
 import * as fsUtils from '../../shared/filesystemUtilities'
 import { getLogger, Logger } from '../../shared/logger'
 import { getTabSizeSetting } from '../../shared/utilities/editorUtilities'
+import { getNormalizedRelativePath } from '../../shared/utilities/pathUtils'
 import { saveDocumentIfDirty } from '../../shared/utilities/textDocumentUtilities'
 
 const localize = nls.loadMessageBundle()
@@ -40,13 +41,66 @@ export interface HandlerConfig {
         [name: string]: string
     }
     dockerNetwork?: string
+    useContainer?: boolean
 }
 
 export function generateDefaultHandlerConfig(): HandlerConfig {
     return {
         event: {},
         environmentVariables: {},
-        dockerNetwork: undefined
+        dockerNetwork: undefined,
+        useContainer: undefined
+    }
+}
+
+export async function getHandlerConfig(params: {
+    handlerName: string
+    documentUri: vscode.Uri
+    samTemplate: vscode.Uri
+}): Promise<HandlerConfig> {
+    const workspaceFolder = vscode.workspace.getWorkspaceFolder(params.documentUri)
+    if (!workspaceFolder) {
+        return generateDefaultHandlerConfig()
+    }
+
+    const config: HandlerConfig = await getLocalLambdaConfiguration(
+        workspaceFolder,
+        params.handlerName,
+        params.samTemplate
+    )
+
+    return config
+}
+
+async function getLocalLambdaConfiguration(
+    workspaceFolder: vscode.WorkspaceFolder,
+    handler: string,
+    samTemplate: vscode.Uri
+): Promise<HandlerConfig> {
+    try {
+        const configPath: string = getTemplatesConfigPath(workspaceFolder.uri.fsPath)
+        const templateRelativePath = getNormalizedRelativePath(workspaceFolder.uri.fsPath, samTemplate.fsPath)
+
+        await saveDocumentIfDirty(configPath)
+
+        let rawConfig: string = '{}'
+        if (await fsUtils.fileExists(configPath)) {
+            rawConfig = await fsUtils.readFileAsString(configPath)
+        }
+
+        const configPopulationResult = new TemplatesConfigPopulator(rawConfig)
+            .ensureTemplateHandlerSectionExists(templateRelativePath, handler)
+            .getResults()
+
+        const config: TemplatesConfig = loadTemplatesConfigFromJson(configPopulationResult.json)
+
+        return config.templates[templateRelativePath]!.handlers![handler]!
+    } catch (e) {
+        if (e instanceof TemplatesConfigFieldTypeError) {
+            showTemplatesConfigurationError(e)
+        }
+
+        throw e
     }
 }
 
diff --git a/src/lambda/local/configureLocalLambda.ts b/src/lambda/local/configureLocalLambda.ts
@@ -4,19 +4,15 @@
  */
 
 import * as vscode from 'vscode'
-import * as fsUtils from '../../shared/filesystemUtilities'
 import { getLogger, Logger } from '../../shared/logger'
 import { recordLambdaConfigure, Result } from '../../shared/telemetry/telemetry'
 import { getNormalizedRelativePath } from '../../shared/utilities/pathUtils'
 import { getChildrenRange } from '../../shared/utilities/symbolUtilities'
-import { getTabSize, saveDocumentIfDirty } from '../../shared/utilities/textDocumentUtilities'
+import { getTabSize } from '../../shared/utilities/textDocumentUtilities'
 import {
     ensureTemplatesConfigFileExists,
     getTemplatesConfigPath,
-    HandlerConfig,
-    loadTemplatesConfigFromJson,
     showTemplatesConfigurationError,
-    TemplatesConfig,
     TemplatesConfigFieldTypeError,
     TemplatesConfigPopulator
 } from '../config/templates'
@@ -90,38 +86,6 @@ export async function configureLocalLambda(
     }
 }
 
-export async function getLocalLambdaConfiguration(
-    workspaceFolder: vscode.WorkspaceFolder,
-    handler: string,
-    samTemplate: vscode.Uri
-): Promise<HandlerConfig> {
-    try {
-        const configPath: string = getTemplatesConfigPath(workspaceFolder.uri.fsPath)
-        const templateRelativePath = getNormalizedRelativePath(workspaceFolder.uri.fsPath, samTemplate.fsPath)
-
-        await saveDocumentIfDirty(configPath)
-
-        let rawConfig: string = '{}'
-        if (await fsUtils.fileExists(configPath)) {
-            rawConfig = await fsUtils.readFileAsString(configPath)
-        }
-
-        const configPopulationResult = new TemplatesConfigPopulator(rawConfig)
-            .ensureTemplateHandlerSectionExists(templateRelativePath, handler)
-            .getResults()
-
-        const config: TemplatesConfig = loadTemplatesConfigFromJson(configPopulationResult.json)
-
-        return config.templates[templateRelativePath]!.handlers![handler]!
-    } catch (e) {
-        if (e instanceof TemplatesConfigFieldTypeError) {
-            showTemplatesConfigurationError(e)
-        }
-
-        throw e
-    }
-}
-
 async function getEventRange(
     editor: vscode.TextEditor,
     relativeTemplatePath: string,
diff --git a/src/shared/codelens/csharpCodeLensProvider.ts b/src/shared/codelens/csharpCodeLensProvider.ts
@@ -7,6 +7,7 @@ import * as path from 'path'
 import * as vscode from 'vscode'
 
 import { access } from 'fs-extra'
+import { getHandlerConfig } from '../../lambda/config/templates'
 import { makeCoreCLRDebugConfiguration } from '../../lambda/local/debugConfiguration'
 import { DefaultDockerClient, DockerClient } from '../clients/dockerClient'
 import { CloudFormation } from '../cloudformation/cloudformation'
@@ -170,12 +171,19 @@ async function onLocalInvokeCommand(
             properties: resource.Properties
         })
 
+        const config =  await getHandlerConfig({
+            handlerName: handlerName,
+            documentUri: documentUri,
+            samTemplate: vscode.Uri.file(lambdaLocalInvokeParams.samTemplate.fsPath)
+        })
+
         const buildArgs: ExecuteSamBuildArguments = {
             baseBuildDir,
             channelLogger,
             codeDir: codeUri,
             inputTemplatePath,
-            samProcessInvoker: processInvoker
+            samProcessInvoker: processInvoker,
+            useContainer: config.useContainer
         }
         if (lambdaLocalInvokeParams.isDebug) {
             buildArgs.environmentVariables = {
diff --git a/src/shared/codelens/localLambdaRunner.ts b/src/shared/codelens/localLambdaRunner.ts
@@ -6,7 +6,6 @@
 import * as path from 'path'
 import * as tcpPortUsed from 'tcp-port-used'
 import * as vscode from 'vscode'
-import { getLocalLambdaConfiguration } from '../../lambda/local/configureLocalLambda'
 import { detectLocalLambdas, LocalLambda } from '../../lambda/local/detectLocalLambdas'
 import { CloudFormation } from '../cloudformation/cloudformation'
 import { makeTemporaryToolkitFolder } from '../filesystemUtilities'
@@ -22,7 +21,7 @@ import { SamTemplateGenerator } from '../templates/sam/samTemplateGenerator'
 import { ExtensionDisposableFiles } from '../utilities/disposableFiles'
 
 import { writeFile } from 'fs-extra'
-import { generateDefaultHandlerConfig, HandlerConfig } from '../../lambda/config/templates'
+import { getHandlerConfig, HandlerConfig } from '../../lambda/config/templates'
 import { DebugConfiguration } from '../../lambda/local/debugConfiguration'
 import { getFamily, RuntimeFamily } from '../../lambda/models/samLambdaRuntime'
 import { getLogger } from '../logger'
@@ -91,12 +90,20 @@ export class LocalLambdaRunner {
             )
 
             const inputTemplate: string = await this.generateInputTemplate(this.codeRootDirectoryPath)
+
+            const config = await getHandlerConfig({
+                handlerName: this.localInvokeParams.handlerName,
+                documentUri: this.localInvokeParams.document.uri,
+                samTemplate: this.localInvokeParams.samTemplate
+            })
+
             const samBuildTemplate: string = await executeSamBuild({
                 baseBuildDir: await this.getBaseBuildFolder(),
                 channelLogger: this.channelLogger,
                 codeDir: this.codeRootDirectoryPath,
                 inputTemplatePath: inputTemplate,
-                samProcessInvoker: this.processInvoker
+                samProcessInvoker: this.processInvoker,
+                useContainer: config.useContainer
             })
 
             await this.invokeLambdaFunction(samBuildTemplate)
@@ -177,7 +184,7 @@ export class LocalLambdaRunner {
 
         const eventPath: string = path.join(await this.getBaseBuildFolder(), 'event.json')
         const environmentVariablePath = path.join(await this.getBaseBuildFolder(), 'env-vars.json')
-        const config = await getConfig({
+        const config = await getHandlerConfig({
             handlerName: this.localInvokeParams.handlerName,
             documentUri: this.localInvokeParams.document.uri,
             samTemplate: this.localInvokeParams.samTemplate
@@ -316,6 +323,7 @@ export interface ExecuteSamBuildArguments {
     manifestPath?: string
     environmentVariables?: NodeJS.ProcessEnv
     samProcessInvoker: SamCliProcessInvoker
+    useContainer?: boolean
 }
 
 export async function executeSamBuild({
@@ -325,7 +333,8 @@ export async function executeSamBuild({
     inputTemplatePath,
     manifestPath,
     environmentVariables,
-    samProcessInvoker
+    samProcessInvoker,
+    useContainer
 }: ExecuteSamBuildArguments): Promise<string> {
     channelLogger.info('AWS.output.building.sam.application', 'Building SAM Application...')
 
@@ -337,7 +346,8 @@ export async function executeSamBuild({
         templatePath: inputTemplatePath,
         invoker: samProcessInvoker,
         manifestPath,
-        environmentVariables
+        environmentVariables,
+        useContainer
     }
     await new SamCliBuildInvocation(samCliArgs).execute()
 
@@ -389,7 +399,7 @@ export async function invokeLambdaFunction(
 
     const eventPath: string = path.join(invokeArgs.baseBuildDir, 'event.json')
     const environmentVariablePath = path.join(invokeArgs.baseBuildDir, 'env-vars.json')
-    const config = await getConfig({
+    const config = await getHandlerConfig({
         handlerName: invokeArgs.originalHandlerName,
         documentUri: invokeArgs.documentUri,
         samTemplate: vscode.Uri.file(invokeArgs.originalSamTemplatePath)
@@ -446,25 +456,6 @@ export async function invokeLambdaFunction(
     }
 }
 
-const getConfig = async (params: {
-    handlerName: string
-    documentUri: vscode.Uri
-    samTemplate: vscode.Uri
-}): Promise<HandlerConfig> => {
-    const workspaceFolder = vscode.workspace.getWorkspaceFolder(params.documentUri)
-    if (!workspaceFolder) {
-        return generateDefaultHandlerConfig()
-    }
-
-    const config: HandlerConfig = await getLocalLambdaConfiguration(
-        workspaceFolder,
-        params.handlerName,
-        params.samTemplate
-    )
-
-    return config
-}
-
 const getEnvironmentVariables = (
     config: Pick<HandlerConfig, 'environmentVariables'>
 ): SAMTemplateEnvironmentVariables => {
diff --git a/src/shared/codelens/pythonCodeLensProvider.ts b/src/shared/codelens/pythonCodeLensProvider.ts
@@ -7,6 +7,7 @@ import { unlink, writeFile } from 'fs-extra'
 import * as os from 'os'
 import * as path from 'path'
 import * as vscode from 'vscode'
+import { getHandlerConfig } from '../../lambda/config/templates'
 import { PythonDebugConfiguration, PythonPathMapping } from '../../lambda/local/debugConfiguration'
 import { CloudFormation } from '../cloudformation/cloudformation'
 import { VSCODE_EXTENSION_ID } from '../extensions'
@@ -262,14 +263,20 @@ export async function initialize({
                 )}`
             )
 
-            const codeDir = samProjectCodeRoot
+            const config = await getHandlerConfig({
+                handlerName: args.handlerName,
+                documentUri: args.document.uri,
+                samTemplate: vscode.Uri.file(args.samTemplate.fsPath)
+            })
+
             const samTemplatePath: string = await executeSamBuild({
                 baseBuildDir,
                 channelLogger,
-                codeDir,
+                codeDir: samProjectCodeRoot,
                 inputTemplatePath,
                 manifestPath,
-                samProcessInvoker: processInvoker
+                samProcessInvoker: processInvoker,
+                useContainer: config.useContainer
             })
 
             const invokeArgs: InvokeLambdaFunctionArguments = {
diff --git a/src/templates/templates.json b/src/templates/templates.json
@@ -43,6 +43,11 @@
                                             "type": "string",
                                             "default": null,
                                             "description": "If specified, adds a --docker-network parameter to the SAM CLI.  If not specified, no parameter will be sent."
+                                        },
+                                        "useContainer": {
+                                            "type": "boolean",
+                                            "default": false,
+                                            "description": "If specified, adds a --use-container parameter to the SAM CLI. If not specified, no parameter will be sent. If your functions depend on packages that have natively compiled dependencies use this flag to build your function inside a SAM Docker container."
                                         }
                                     }
                                 }

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@`
`43`	`43`	`"type": "string",`
`44`	`44`	`"default": null,`
`45`	`45`	`"description": "If specified, adds a --docker-network parameter to the SAM CLI. If not specified, no parameter will be sent."`
	`46`	`+ },`
	`47`	`+ "useContainer": {`
	`48`	`+ "type": "boolean",`
	`49`	`+ "default": false,`
	`50`	`+ "description": "If specified, adds a --use-container parameter to the SAM CLI. If not specified, no parameter will be sent. If your functions depend on packages that have natively compiled dependencies use this flag to build your function inside a SAM Docker container."`
`46`	`51`	`}`
`47`	`52`	`}`
`48`	`53`	`}`