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

Vandita2020 · 2025-02-18T19:40:29Z

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:

The metadata.json file was updated to accommodate the addition of an asset_name field for each IaC and Runtime pair.
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.
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.
License: I confirm that my contribution is made under the terms of the Apache 2.0 license.

github-actions · 2025-02-18T19:40:43Z

This pull request modifies code in src/* but no tests were added/updated.
- Confirm whether tests should be added or ensure the PR description explains why tests are not required.

roger-zhangg

Questions in Wizard part, also please add test

packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts

roger-zhangg · 2025-02-20T22:05:32Z

packages/core/src/awsService/appBuilder/serverlessLand/main.ts

+    }).run()
+}
+
+async function downloadPatternCode(config: CreateServerlessLandWizardForm): Promise<void> {


Seems you are providing a Official Serverless Land experience here, could you help to update the Download SL logic I have in walkthrough to use your logic here?

If this is going to be used in other places as well, I suggest bringing these function outside of main.py and into another file in this folder for readability.

In this file, I am using the same getPattern() function that is defined in the shared/utilities/downloadPattern. The only difference is that I am appending the .zip extension to the asset_name to ensure the pattern code is downloaded correctly. In the metadata file, I am saving the asset_name without the extension, while for the Getting Started project, the asset_name was saved with the extension. If we plan to use the metadata for the Getting Started patterns in the future, we can update the approach there as well.

roger-zhangg · 2025-02-20T22:06:55Z

packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts

-            if (patterns.length === 0) {
-                throw new ToolkitError('No patterns found in metadata')
-            }
+            let step = 'pattern'


for line 40, IMO we should avoid public override async run(): when possible. Just put all the async prework out of the wizard. the override async run() has cause difficulties in testing as my experience.

The code has been simplified, and the logic that was previously executed within the public override async run() method has been moved to the public constructor. No longer need to override the run() function.

github-actions · 2025-02-20T23:12:58Z

This pull request modifies code in src/* but no tests were added/updated.
- Confirm whether tests should be added or ensure the PR description explains why tests are not required.
This pull request implements a feat or fix, so it must include a changelog entry (unless the fix is for an unreleased feature). Review the changelog guidelines.
- Note: beta or "experiment" features that have active users should announce fixes in the changelog.
- If this is not a feature or fix, use an appropriate type from the title guidelines. For example, telemetry-only changes should use the telemetry type.

packages/core/src/awsService/appBuilder/serverlessLand/main.ts

vicheey · 2025-02-20T23:54:57Z

packages/core/src/awsService/appBuilder/serverlessLand/main.ts

+    }).run()
+}
+
+async function downloadPatternCode(config: CreateServerlessLandWizardForm): Promise<void> {


If this is going to be used in other places as well, I suggest bringing these function outside of main.py and into another file in this folder for readability.

packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts

jpinkney-aws · 2025-02-21T19:24:17Z

packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts

-export class CreateServerlessLandWizard extends Wizard<CreateServerlessLandWizardForm> {
-    private metadataManager: MetadataManager
+async function loadMetadata(): Promise<MetadataManager> {
+    const metadataManager = MetadataManager.getInstance()


does it make sense for this to live inside of the metadataManager? Or do you envision the metadata manager loading multiple different types of metadata

The project will utilize a single metadata file. I have made the changes to utilize loadMetadata() inside the metadataManager.ts file.

jpinkney-aws · 2025-02-21T19:25:19Z

packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts

+        super({
+            exitPrompterProvider: createExitPrompter,
+        })
+        loadMetadata().catch((err: any) => {


shouldn't the form have the metadata before the load the form loads rather than loading it afterwords?

I don't fully understand what you're talking about here. Can you please explain it more? Thanks!

vicheey · 2025-02-25T23:36:57Z

packages/core/src/awsService/appBuilder/serverlessLand/wizard.ts

+                },
+                {
+                    iconPath: new vscode.ThemeIcon('open-preview'),
+                    tooltip: 'Open in Serverless Land',


Suggested change

tooltip: 'Open in Serverless Land',

tooltip: 'Show Serverless Land webview',

We technically show the web view of Serverless Land page in VS Code web view.

does "webview" mean anything to customers?

jpinkney-aws · 2025-02-26T13:34:27Z

packages/core/src/awsService/appBuilder/serverlessLand/metadataManager.ts

    private static instance: MetadataManager
    private metadata: ProjectMetadata | undefined
+    private static readonly metadataPath = path.join(
+        path.resolve(__dirname, '../../../../../'),


you're probably going to wait to integrate with our copyFiles scripts. This path probably exists in the extension debug mode but I don't think it exists in the actual build. Instead, you will need to copy this file to the resources file and pull from that

Yes, I have made the changes in the path with the copyFiles scripts in the next PR and it is working correctly too.

roger-zhangg

LGTM, we should review again once we have the whole feature ready

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. 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 <[email protected]> Building Quick Pick structure Arranging file structure Review revision Download code Updating wizard file Download code

## 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 <[email protected]>

Vandita2020 force-pushed the download_code branch 5 times, most recently from a20965f to 1e35324 Compare February 20, 2025 20:52

Vandita Patidar added 3 commits February 20, 2025 13:02

Building Quick Pick structure

3631142

Arranging file structure

2495b61

Review revision

8a9d285

Vandita2020 force-pushed the download_code branch from 1e35324 to e23a824 Compare February 20, 2025 21:42

Vandita2020 changed the title ~~Download code~~ feat(lambda): download serverless patterns in IDE Feb 20, 2025

Vandita2020 marked this pull request as ready for review February 20, 2025 21:43

Vandita2020 requested a review from a team as a code owner February 20, 2025 21:43

roger-zhangg suggested changes Feb 20, 2025

View reviewed changes

Vandita2020 changed the title ~~feat(lambda): download serverless patterns in IDE~~ feat(lambda): download serverless land patterns in IDE Feb 20, 2025

Download code

c8e7703

Vandita2020 force-pushed the download_code branch from e23a824 to c8e7703 Compare February 20, 2025 23:12

vicheey reviewed Feb 20, 2025

View reviewed changes

packages/core/src/awsService/appBuilder/serverlessLand/main.ts Show resolved Hide resolved

vicheey suggested changes Feb 21, 2025

View reviewed changes

Vandita2020 force-pushed the download_code branch from 3e3a123 to c5104e2 Compare February 21, 2025 05:11

jpinkney-aws reviewed Feb 21, 2025

View reviewed changes

vicheey approved these changes Feb 25, 2025

View reviewed changes

Updating wizard file

c67fc2e

Vandita2020 force-pushed the download_code branch from c5104e2 to c67fc2e Compare February 26, 2025 09:05

jpinkney-aws reviewed Feb 26, 2025

View reviewed changes

roger-zhangg approved these changes Feb 26, 2025

View reviewed changes

jpinkney-aws approved these changes Feb 26, 2025

View reviewed changes

jpinkney-aws merged commit 2335204 into aws:feature/serverlessland Feb 26, 2025
16 of 17 checks passed

	tooltip: 'Open in Serverless Land',
	tooltip: 'Show Serverless Land webview',

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

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

Uh oh!

Conversation

Vandita2020 commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Uh oh!

github-actions bot commented Feb 18, 2025

Uh oh!

roger-zhangg left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roger-zhangg Feb 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 20, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vandita2020 Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roger-zhangg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Vandita2020 commented Feb 18, 2025 •

edited

Loading

roger-zhangg left a comment •

edited

Loading

roger-zhangg Feb 20, 2025 •

edited

Loading

Vandita2020 Feb 25, 2025 •

edited

Loading