SAM Step Functions quick start template (#1114)

Authored-by: Vaib Suri <[email protected]>

Author: vaib-amz

package.nls.json

@@ -337,6 +337,7 @@
     "AWS.samcli.initWizard.template.helloWorld.description": "A basic SAM app",
     "AWS.samcli.initWizard.template.eventBridge_helloWorld.description": "Invokes a Lambda for every EC2 instance state change in your account",
     "AWS.samcli.initWizard.template.eventBridge_starterApp.description": "Invokes a Lambda based on a dynamic event trigger for an EventBridge Schema of your choice",
+    "AWS.samcli.initWizard.template.stepFunctionsSampleApp.description": "Orchestrates multiple Lambdas to execute a stock trading workflow on an hourly schedule",
     "AWS.samcli.initWizard.schemas.region.prompt": "Select an EventBridge Schemas Region",
     "AWS.samcli.initWizard.schemas.registry.prompt": "Select a Registry",
     "AWS.samcli.initWizard.schemas.registry.failed_to_load_resources": "Error loading registries.",

src/lambda/commands/createNewSamApp.ts

@@ -25,7 +25,7 @@ import { fileExists } from '../../shared/filesystemUtilities'
 import { getLogger } from '../../shared/logger'
 import { RegionProvider } from '../../shared/regions/regionProvider'
 import { getRegionsForActiveCredentials } from '../../shared/regions/regionUtilities'
-import { getSamCliContext, SamCliContext } from '../../shared/sam/cli/samCliContext'
+import { getSamCliVersion, getSamCliContext, SamCliContext } from '../../shared/sam/cli/samCliContext'
 import { runSamCliInit, SamCliInitArgs } from '../../shared/sam/cli/samCliInit'
 import { throwAndNotifyIfInvalid } from '../../shared/sam/cli/samCliValidationUtils'
 import { SamCliValidator } from '../../shared/sam/cli/samCliValidator'
@@ -99,8 +99,9 @@ export async function createNewSamApplication(
         const currentCredentials = await awsContext.getCredentials()
         const availableRegions = getRegionsForActiveCredentials(awsContext, regionProvider)
         const schemasRegions = availableRegions.filter(region => regionProvider.isServiceInRegion('schemas', region.id))
+        const samCliVersion = await getSamCliVersion(samCliContext)
 
-        const wizardContext = new DefaultCreateNewSamAppWizardContext(currentCredentials, schemasRegions)
+        const wizardContext = new DefaultCreateNewSamAppWizardContext(currentCredentials, schemasRegions, samCliVersion)
         config = await new CreateNewSamAppWizard(wizardContext).run()
 
         if (!config) {

src/lambda/models/samTemplates.ts

@@ -5,35 +5,38 @@
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
+import * as semver from 'semver'
 import { Runtime } from 'aws-sdk/clients/lambda'
 import { Set } from 'immutable'
 import { supportsEventBridgeTemplates } from '../../../src/eventSchemas/models/schemaCodeLangs'
 
 export const helloWorldTemplate = 'AWS SAM Hello World'
 export const eventBridgeHelloWorldTemplate = 'AWS SAM EventBridge Hello World'
 export const eventBridgeStarterAppTemplate = 'AWS SAM EventBridge App from Scratch'
+export const stepFunctionsSampleApp = 'AWS Step Functions Sample App'
 export const repromptUserForTemplate = 'REQUIRES_AWS_CREDENTIALS_REPROMPT_USER_FOR_TEMPLATE'
 
+export const CLI_VERSION_STEP_FUNCTIONS_TEMPLATE = '0.52.0'
+
 export type SamTemplate =
     | 'AWS SAM Hello World'
     | 'AWS SAM EventBridge Hello World'
     | 'AWS SAM EventBridge App from Scratch'
+    | 'AWS Step Functions Sample App'
     | 'REQUIRES_AWS_CREDENTIALS_REPROMPT_USER_FOR_TEMPLATE'
 
-export const validTemplateOptions: Set<SamTemplate> = Set<SamTemplate>([
-    helloWorldTemplate,
-    eventBridgeHelloWorldTemplate,
-    eventBridgeStarterAppTemplate,
-])
-
-export const helloWorldOption: Set<SamTemplate> = Set<SamTemplate>([helloWorldTemplate])
+export function getSamTemplateWizardOption(runtime: Runtime, samCliVersion: string): Set<SamTemplate> {
+    let templateOptions: Array<SamTemplate> = Array<SamTemplate>(helloWorldTemplate)
 
-export function getSamTemplateWizardOption(runtime: Runtime): Set<SamTemplate> {
     if (supportsEventBridgeTemplates(runtime)) {
-        return validTemplateOptions
+        templateOptions.push(eventBridgeHelloWorldTemplate, eventBridgeStarterAppTemplate)
     }
 
-    return helloWorldOption
+    if (supportsStepFuntionsTemplate(samCliVersion)) {
+        templateOptions.push(stepFunctionsSampleApp)
+    }
+
+    return Set<SamTemplate>(templateOptions)
 }
 
 export function getSamCliTemplateParameter(templateSelected: SamTemplate): string {
@@ -44,6 +47,8 @@ export function getSamCliTemplateParameter(templateSelected: SamTemplate): strin
             return 'eventBridge-hello-world'
         case eventBridgeStarterAppTemplate:
             return 'eventBridge-schema-app'
+        case stepFunctionsSampleApp:
+            return 'step-functions-sample-app'
         default:
             throw new Error(`${templateSelected} is not valid sam template`)
     }
@@ -63,7 +68,19 @@ export function getTemplateDescription(template: SamTemplate): string {
                 'AWS.samcli.initWizard.template.eventBridge_starterApp.description',
                 'Invokes a Lambda based on a dynamic event trigger for an EventBridge Schema of your choice'
             )
+        case stepFunctionsSampleApp:
+            return localize(
+                'AWS.samcli.initWizard.template.stepFunctionsSampleApp.description',
+                'Orchestrates multiple Lambdas to execute a stock trading workflow on an hourly schedule'
+            )
         default:
             throw new Error(`No description found for template ${template}`)
     }
 }
+
+export function supportsStepFuntionsTemplate(samCliVersion: string): boolean {
+    if (!samCliVersion) {
+        return false
+    }
+    return semver.gte(samCliVersion, CLI_VERSION_STEP_FUNCTIONS_TEMPLATE)
+}

src/lambda/wizards/samInitWizard.ts

@@ -59,11 +59,13 @@ export class DefaultCreateNewSamAppWizardContext extends WizardContext implement
     private readonly helpButton = createHelpButton(localize('AWS.command.help', 'View Documentation'))
     private readonly currentCredentials: Credentials | undefined
     private readonly schemasRegions: Region[]
+    private readonly samCliVersion: string
 
-    public constructor(currentCredentials: Credentials | undefined, schemasRegions: Region[]) {
+    public constructor(currentCredentials: Credentials | undefined, schemasRegions: Region[], samCliVersion: string) {
         super()
         this.currentCredentials = currentCredentials
         this.schemasRegions = schemasRegions
+        this.samCliVersion = samCliVersion
     }
 
     public async promptUserForRuntime(currRuntime?: Runtime): Promise<Runtime | undefined> {
@@ -104,7 +106,7 @@ export class DefaultCreateNewSamAppWizardContext extends WizardContext implement
         currRuntime: Runtime,
         currTemplate?: SamTemplate
     ): Promise<SamTemplate | undefined> {
-        const templates = getSamTemplateWizardOption(currRuntime)
+        const templates = getSamTemplateWizardOption(currRuntime, this.samCliVersion)
         const quickPick = picker.createQuickPick<vscode.QuickPickItem>({
             options: {
                 ignoreFocusOut: true,

src/test/lambda/models/samTemplates.test.ts

@@ -5,21 +5,35 @@
 
 import * as assert from 'assert'
 import {
+    CLI_VERSION_STEP_FUNCTIONS_TEMPLATE,
     getSamCliTemplateParameter,
     getSamTemplateWizardOption,
     getTemplateDescription,
-    helloWorldOption,
     repromptUserForTemplate,
-    validTemplateOptions,
+    SamTemplate,
+    helloWorldTemplate,
+    eventBridgeHelloWorldTemplate,
+    eventBridgeStarterAppTemplate,
+    stepFunctionsSampleApp,
 } from '../../../lambda/models/samTemplates'
+import { Set } from 'immutable'
 import { assertThrowsError } from '../../../test/shared/utilities/assertUtils'
 
 import { samLambdaRuntimes } from '../../../lambda/models/samLambdaRuntime'
 
+const validTemplateOptions: Set<SamTemplate> = Set<SamTemplate>([
+    helloWorldTemplate,
+    eventBridgeHelloWorldTemplate,
+    eventBridgeStarterAppTemplate,
+    stepFunctionsSampleApp,
+])
+
+const defaultTemplateOptions: Set<SamTemplate> = Set<SamTemplate>([helloWorldTemplate, stepFunctionsSampleApp])
+
 describe('getSamTemplateWizardOption', () => {
     it('should successfully return available templates for specific runtime', () => {
         for (const runtime of samLambdaRuntimes.values()) {
-            const result = getSamTemplateWizardOption(runtime)
+            const result = getSamTemplateWizardOption(runtime, CLI_VERSION_STEP_FUNCTIONS_TEMPLATE)
             switch (runtime) {
                 case 'python3.6':
                 case 'python3.7':
@@ -33,13 +47,20 @@ describe('getSamTemplateWizardOption', () => {
                 default:
                     assert.deepStrictEqual(
                         result,
-                        helloWorldOption,
-                        'Rest of the runtimes support hello-world template only'
+                        defaultTemplateOptions,
+                        'Rest of the runtimes support default templates only'
                     )
                     break
             }
         }
     })
+
+    it('should not return Step Functions templates for a SAM CLI version that does not support them', () => {
+        for (const runtime of samLambdaRuntimes.values()) {
+            const result = getSamTemplateWizardOption(runtime, '0.40.0')
+            assert(!result.contains(stepFunctionsSampleApp))
+        }
+    })
 })
 
 describe('getSamCliTemplateParameter', () => {