feat(lambda): download serverless land patterns in IDE (aws#6612)

Vandita2020 · Vandita Patidar · nkomonen-amazon · commit 919f141c666a · 2025-03-05T15:26:36.000-05:00
## Problem This pull request introduces the functionality to allow users to download the selected pattern from the Serverless Land QuickPick flow into a directory of their choice. ## Solution The key changes made are as follows: 1. The `metadata.json` file was updated to accommodate the addition of an `asset_name` field for each IaC and Runtime pair. 2. Consequently, the way the metadata is extracted in the `metadataManager.ts` file had to be modified to account for these changes in the `metadata.json` file. 3. To enable users to navigate back to the previous QuickPick options, a switch functionality was implemented in the `wizard.ts` file. This helps maintain the state of the current QuickPick and directs the user to the previous QuickPick. --- - Treat all work as PUBLIC. Private `feature/x` branches will not be squash-merged at release time. - Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines). - License: I confirm that my contribution is made under the terms of the Apache 2.0 license. --------- Co-authored-by: Vandita Patidar <vanditap@amazon.com>
diff --git a/packages/core/src/awsService/appBuilder/serverlessLand/main.ts b/packages/core/src/awsService/appBuilder/serverlessLand/main.ts
@@ -6,16 +6,22 @@
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 import * as path from 'path'
+import * as vscode from 'vscode'
 import { getTelemetryReason, getTelemetryResult } from '../../../shared/errors'
 import { getLogger } from '../../../shared/logger/logger'
-import globals from '../../../shared/extensionGlobals'
 import { checklogs } from '../../../shared/localizedText'
 import { Result, telemetry } from '../../../shared/telemetry/telemetry'
-import { CreateServerlessLandWizard } from './wizard'
+import { CreateServerlessLandWizardForm, CreateServerlessLandWizard } from './wizard'
 import { ExtContext } from '../../../shared/extensions'
 import { addFolderToWorkspace } from '../../../shared/utilities/workspaceUtils'
+import { ToolkitError } from '../../../shared/errors'
+import { fs } from '../../../shared/fs/fs'
+import { getPattern } from '../../../shared/utilities/downloadPatterns'
+import { MetadataManager } from './metadataManager'
 
 export const readmeFile: string = 'README.md'
+const serverlessLandOwner = 'aws-samples'
+const serverlessLandRepo = 'serverless-patterns'
 
 /**
  * Creates a new Serverless Land project using the provided extension context
@@ -31,38 +37,33 @@ export const readmeFile: string = 'README.md'
  * 6. Handles errors and emits telemetry
  */
 export async function createNewServerlessLandProject(extContext: ExtContext): Promise<void> {
-    const awsContext = extContext.awsContext
     let createResult: Result = 'Succeeded'
     let reason: string | undefined
+    let metadataManager: MetadataManager
 
     try {
-        const credentials = await awsContext.getCredentials()
-        const defaultRegion = awsContext.getCredentialDefaultRegion()
-
+        metadataManager = MetadataManager.getInstance()
         // Launch the project creation wizard
-        const config = await new CreateServerlessLandWizard({
-            credentials,
-            defaultRegion,
-        }).run()
+        const config = await launchProjectCreationWizard(extContext)
         if (!config) {
             createResult = 'Cancelled'
             reason = 'userCancelled'
             return
         }
+        const assetName = metadataManager.getAssetName(config.pattern, config.runtime, config.iac)
 
-        // Add the project folder to the workspace
+        await downloadPatternCode(config, assetName)
+        await openReadmeFile(config)
         await addFolderToWorkspace(
             {
-                uri: config.location,
-                name: path.basename(config.location.fsPath),
+                uri: vscode.Uri.joinPath(config.location, config.name),
+                name: path.basename(config.name),
             },
             true
         )
     } catch (err) {
         createResult = getTelemetryResult(err)
         reason = getTelemetryReason(err)
-
-        globals.outputChannel.show(true)
         getLogger().error(
             localize(
                 'AWS.serverlessland.initWizard.general.error',
@@ -80,3 +81,66 @@ export async function createNewServerlessLandProject(extContext: ExtContext): Pr
         })
     }
 }
+
+async function launchProjectCreationWizard(
+    extContext: ExtContext
+): Promise<CreateServerlessLandWizardForm | undefined> {
+    const awsContext = extContext.awsContext
+    const credentials = await awsContext.getCredentials()
+    const defaultRegion = awsContext.getCredentialDefaultRegion()
+
+    return new CreateServerlessLandWizard({
+        credentials,
+        defaultRegion,
+    }).run()
+}
+
+async function downloadPatternCode(config: CreateServerlessLandWizardForm, assetName: string): Promise<void> {
+    const fullAssetName = assetName + '.zip'
+    const location = vscode.Uri.joinPath(config.location, config.name)
+    try {
+        await getPattern(serverlessLandOwner, serverlessLandRepo, fullAssetName, location, true)
+    } catch (error) {
+        if (error instanceof ToolkitError) {
+            throw error
+        }
+        throw new ToolkitError(`Failed to download pattern: ${error}`)
+    }
+}
+
+async function openReadmeFile(config: CreateServerlessLandWizardForm): Promise<void> {
+    try {
+        const readmeUri = await getProjectUri(config, readmeFile)
+        if (!readmeUri) {
+            getLogger().warn('README.md file not found in the project directory')
+            return
+        }
+
+        await vscode.commands.executeCommand('workbench.action.focusFirstEditorGroup')
+        await vscode.window.showTextDocument(readmeUri)
+    } catch (err) {
+        getLogger().error(`Error in openReadmeFile: ${err}`)
+        throw new ToolkitError('Error processing README file')
+    }
+}
+
+async function getProjectUri(
+    config: Pick<CreateServerlessLandWizardForm, 'location' | 'name'>,
+    file: string
+): Promise<vscode.Uri | undefined> {
+    if (!file) {
+        throw Error('expected "file" parameter to have at least one item')
+    }
+    const cfnTemplatePath = path.resolve(config.location.fsPath, config.name, file)
+    if (await fs.exists(cfnTemplatePath)) {
+        return vscode.Uri.file(cfnTemplatePath)
+    }
+    void vscode.window.showWarningMessage(
+        localize(
+            'AWS.serverlessLand.initWizard.source.error.notFound',
+            'Project created successfully, but {0} file not found: {1}',
+            file!,
+            cfnTemplatePath!
+        )
+    )
+}
diff --git a/packages/core/src/awsService/appBuilder/serverlessLand/metadata.json b/packages/core/src/awsService/appBuilder/serverlessLand/metadata.json
@@ -3,56 +3,52 @@
         "s3-lambda-resizing-sam": {
             "name": "Resizing image",
             "description": "Lambda, S3 • Python, Javascript, Java, .NET • SAM",
-            "runtimes": [
+            "implementation": [
                 {
-                    "id": "python",
-                    "name": "Python"
+                    "iac": "sam",
+                    "runtime": "python",
+                    "assetName": "s3-lambda-resizing-python"
                 },
                 {
-                    "id": "javascript",
-                    "name": "Javascript"
+                    "iac": "sam",
+                    "runtime": "javascript",
+                    "assetName": "s3-lambda"
                 },
                 {
-                    "id": "dotnet",
-                    "name": "Dotnet"
+                    "iac": "sam",
+                    "runtime": "java",
+                    "assetName": "s3-lambda-resizing-java"
                 },
                 {
-                    "id": "java",
-                    "name": "Java"
-                }
-            ],
-            "iac": [
-                {
-                    "id": "sam",
-                    "name": "SAM"
+                    "iac": "sam",
+                    "runtime": "dotnet",
+                    "assetName": "s3-lambda-dotnet"
                 }
             ]
         },
         "apigw-rest-api-lambda-sam": {
             "name": "Rest API",
             "description": "Lambda, API Gateway • Python, Javascript, Java, .NET • SAM",
-            "runtimes": [
+            "implementation": [
                 {
-                    "id": "python",
-                    "name": "Python"
+                    "iac": "sam",
+                    "runtime": "python",
+                    "assetName": "apigw-rest-api-lambda-python"
                 },
                 {
-                    "id": "javascript",
-                    "name": "Javascript"
+                    "iac": "sam",
+                    "runtime": "javascript",
+                    "assetName": "apigw-rest-api-lambda-node"
                 },
                 {
-                    "id": "dotnet",
-                    "name": "Dotnet"
+                    "iac": "sam",
+                    "runtime": "java",
+                    "assetName": "apigw-rest-api-lambda-java"
                 },
                 {
-                    "id": "java",
-                    "name": "Java"
-                }
-            ],
-            "iac": [
-                {
-                    "id": "sam",
-                    "name": "AWS SAM"
+                    "iac": "sam",
+                    "runtime": "dotnet",
+                    "assetName": "apigw-rest-api-lambda-dotnet"
                 }
             ]
         }
diff --git a/packages/core/src/awsService/appBuilder/serverlessLand/metadataManager.ts b/packages/core/src/awsService/appBuilder/serverlessLand/metadataManager.ts
@@ -4,21 +4,17 @@
  */
 import * as nodefs from 'fs' // eslint-disable-line no-restricted-imports
 import { ToolkitError } from '../../../shared/errors'
+import path from 'path'
 
-interface IaC {
-    id: string
-    name: string
-}
-interface Runtime {
-    id: string
-    name: string
-    version: string
+interface Implementation {
+    iac: string
+    runtime: string
+    assetName: string
 }
 interface PatternData {
     name: string
     description: string
-    runtimes: Runtime[]
-    iac: IaC[]
+    implementation: Implementation[]
 }
 
 export interface ProjectMetadata {
@@ -32,6 +28,14 @@ export interface ProjectMetadata {
 export class MetadataManager {
     private static instance: MetadataManager
     private metadata: ProjectMetadata | undefined
+    private static readonly metadataPath = path.join(
+        path.resolve(__dirname, '../../../../../'),
+        'src',
+        'awsService',
+        'appBuilder',
+        'serverlessLand',
+        'metadata.json'
+    )
 
     private constructor() {}
 
@@ -42,6 +46,14 @@ export class MetadataManager {
         return MetadataManager.instance
     }
 
+    public static initialize(): MetadataManager {
+        const instance = MetadataManager.getInstance()
+        instance.loadMetadata(MetadataManager.metadataPath).catch((err) => {
+            throw new ToolkitError(`Failed to load metadata: ${err}`)
+        })
+        return instance
+    }
+
     /**
      * Loads metadata from a JSON file
      * @param metadataPath Path to the metadata JSON file
@@ -96,11 +108,12 @@ export class MetadataManager {
      */
     public getRuntimes(pattern: string): { label: string }[] {
         const patternData = this.metadata?.patterns?.[pattern]
-        if (!patternData || !patternData.runtimes) {
+        if (!patternData || !patternData.implementation) {
             return []
         }
-        return patternData.runtimes.map((runtime) => ({
-            label: runtime.name,
+        const uniqueRuntimes = new Set(patternData.implementation.map((item) => item.runtime))
+        return Array.from(uniqueRuntimes).map((runtime) => ({
+            label: runtime,
         }))
     }
 
@@ -111,11 +124,22 @@ export class MetadataManager {
      */
     public getIacOptions(pattern: string): { label: string }[] {
         const patternData = this.metadata?.patterns?.[pattern]
-        if (!patternData || !patternData.iac) {
+        if (!patternData || !patternData.implementation) {
             return []
         }
-        return patternData.iac.map((iac) => ({
-            label: iac.name,
+        const uniqueIaCs = new Set(patternData.implementation.map((item) => item.iac))
+        return Array.from(uniqueIaCs).map((iac) => ({
+            label: iac,
         }))
     }
+    public getAssetName(selectedPattern: string, selectedRuntime: string, selectedIaC: string): string {
+        const patternData = this.metadata?.patterns?.[selectedPattern]
+        if (!patternData || !patternData.implementation) {
+            return ''
+        }
+        const matchingImplementation = patternData.implementation.find(
+            (impl) => impl.runtime === selectedRuntime && impl.iac === selectedIaC
+        )
+        return matchingImplementation?.assetName ?? ''
+    }
 }
diff --git a/packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts b/packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts
