feat(lambda): Add Remote debugging support to Lambda Remote Invoke (aws#7678)

## Problem
* Enhanced Developer Experience - Current Remote Lambda debugging
options are limited, primarily relying on print statements. LDK will
significantly improve the developer experience by allowing real-time
inspection of variables and execution flow.
* Authentic Environment Debugging - Customers are eager to debug in the
actual Lambda environment. However, Lambda doesn't allow direct SSH
connections from external sources, making it challenging to access the
runtime for debugging purposes.
* Advantages over Local Debugging - While local debugging is a common
alternative, Remote debugging offers significant benefits: Access to
resources within VPCs, Ability to follow specific IAM rules and
permissions which are typically not possible in a local debugging
solution.
* Efficient Problem Resolution - Debugging in the real Lambda
environment provides the shortest path to identifying and resolving
issues, as it eliminates

[discrepancies](aws/aws-lambda-base-images#112)
between local and real Lambda environments.

## Solution
Remote debugging (LDK) enable developers to remote debug live Lambda
functions from AWS Toolkit for Visual Studio Code. LDK creates a secure
tunnel between a developer’s local computer and a live Lambda function
running in the cloud. With LDK, developers can use Visual Studio Code
debugger to debug a running Lambda function, set break points, inspect
variables, and step through the code.

### File structure
- ldkClient.ts
  - Implement API calls to IoT & Lambda
- localproxy.ts
- Implement the local proxy to connect to the IoT SecureTunneling(ST)
websocket and create a proxy tcp server
- ldkController.ts
  - Control the debug workflow

###  UI update


![image](https://github.com/user-attachments/assets/e526a46d-952c-45c5-aca6-77353d46ca7a)



### Arch


![image](https://github.com/user-attachments/assets/aaf90b74-3060-44b7-bde6-383e15b04910)
### Sequence Diagram


![image](https://github.com/user-attachments/assets/866b61dc-3872-41b0-a140-7b35d0c2a8be)

---

- 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.

Author: roger-zhangg

package-lock.json

@@ -609,8 +609,10 @@
         "whatwg-url": "^14.0.0",
         "winston": "^3.11.0",
         "winston-transport": "^4.6.0",
+        "ws": "^8.16.0",
         "xml2js": "^0.6.1",
         "yaml-cfn": "^0.3.2",
+        "protobufjs": "^7.2.6",
         "@svgdotjs/svg.js": "^3.0.16",
         "svgdom": "^0.1.0",
         "jaro-winkler": "^0.2.8"

packages/core/package.json

@@ -99,7 +99,7 @@
     "AWS.configuration.description.amazonq.workspaceIndexCacheDirPath": "The path to the directory that contains the cache of the index of your workspace files",
     "AWS.configuration.description.amazonq.ignoredSecurityIssues": "Specifies a list of code issue identifiers that Amazon Q should ignore when reviewing your workspace. Each item in the array should be a unique string identifier for a specific code issue. This allows you to suppress notifications for known issues that you've assessed and determined to be false positives or not applicable to your project. Use this setting with caution, as it may cause you to miss important security alerts.",
     "AWS.configuration.description.amazonq.proxy.certificateAuthority": "Path to a Certificate Authority (PEM file) for SSL/TLS verification when using a proxy.",
-    "AWS.command.apig.invokeRemoteRestApi": "Invoke in the cloud",
+    "AWS.command.apig.invokeRemoteRestApi": "Invoke remotely",
     "AWS.command.apig.invokeRemoteRestApi.cn": "Invoke on Amazon",
     "AWS.appBuilder.explorerTitle": "Application Builder",
     "AWS.appBuilder.explorerNode.noApps": "[This resource is not yet supported.]",
@@ -159,11 +159,12 @@
     "AWS.command.aboutToolkit": "About",
     "AWS.command.downloadLambda": "Download...",
     "AWS.command.uploadLambda": "Upload Lambda...",
-    "AWS.command.invokeLambda": "Invoke in the cloud",
+    "AWS.command.invokeLambda": "Invoke Remotely",
     "AWS.command.openLambdaFile": "Open your Lambda code",
     "AWS.command.quickDeployLambda": "Save and deploy your code",
     "AWS.command.openLambdaWorkspace": "Open in a workspace",
     "AWS.command.invokeLambda.cn": "Invoke on Amazon",
+    "AWS.command.remoteDebugging.clearSnapshot": "Reset Lambda Remote Debugging Snapshot",
     "AWS.command.lambda.convertToSam": "Convert to SAM Application",
     "AWS.command.refreshAwsExplorer": "Refresh Explorer",
     "AWS.command.refreshCdkExplorer": "Refresh CDK Explorer",

packages/core/package.nls.json

@@ -27,6 +27,7 @@ import {
     s3BucketType,
 } from '../../../../shared/cloudformation/cloudformation'
 import { ToolkitError } from '../../../../shared/errors'
+import { ResourceTreeEntity } from '../samProject'
 
 const localize = nls.loadMessageBundle()
 export interface DeployedResource {
@@ -77,7 +78,8 @@ export async function generateDeployedNode(
     deployedResource: any,
     regionCode: string,
     stackName: string,
-    resourceTreeEntity: any
+    resourceTreeEntity: ResourceTreeEntity,
+    location?: vscode.Uri
 ): Promise<any[]> {
     let newDeployedResource: any
     const partitionId = globals.regionProvider.getPartitionId(regionCode) ?? defaultPartition
@@ -90,7 +92,13 @@ export async function generateDeployedNode(
                 try {
                     configuration = (await defaultClient.getFunction(deployedResource.PhysicalResourceId))
                         .Configuration as Lambda.FunctionConfiguration
-                    newDeployedResource = new LambdaFunctionNode(lambdaNode, regionCode, configuration)
+                    newDeployedResource = new LambdaFunctionNode(
+                        lambdaNode,
+                        regionCode,
+                        configuration,
+                        undefined,
+                        location ? vscode.Uri.joinPath(location, resourceTreeEntity.CodeUri ?? '').fsPath : undefined
+                    )
                 } catch (error: any) {
                     getLogger().error('Error getting Lambda configuration: %O', error)
                     throw ToolkitError.chain(error, 'Error getting Lambda configuration', {

packages/core/src/awsService/appBuilder/explorer/nodes/deployedNode.ts

@@ -60,7 +60,8 @@ export class ResourceNode implements TreeNode {
                 this.deployedResource,
                 this.region,
                 this.stackName,
-                this.resourceTreeEntity
+                this.resourceTreeEntity,
+                this.location.projectRoot
             )
         }
         if (this.resourceTreeEntity.Type === SERVERLESS_FUNCTION_TYPE) {

packages/core/src/awsService/appBuilder/explorer/nodes/resourceNode.ts

@@ -569,19 +569,24 @@ export async function getLambdaHandlerFile(
         })
     }
 
+    // if this function is used to get handler from a just downloaded lambda function zip. codeUri will be ''
+    if (codeUri !== '') {
+        folderUri = vscode.Uri.joinPath(folderUri, codeUri)
+    }
+
     const handlerParts = handler.split('.')
     // sample: app.lambda_handler -> app.rb
     if (family === RuntimeFamily.Ruby) {
         // Ruby supports namespace/class handlers as well, but the path is
         // guaranteed to be slash-delimited so we can assume the first part is
         // the path
-        return vscode.Uri.joinPath(folderUri, codeUri, handlerParts.slice(0, handlerParts.length - 1).join('/') + '.rb')
+        return vscode.Uri.joinPath(folderUri, handlerParts.slice(0, handlerParts.length - 1).join('/') + '.rb')
     }
 
     // sample:app.lambda_handler -> app.py
     if (family === RuntimeFamily.Python) {
         // Otherwise (currently Node.js and Python) handle dot-delimited paths
-        return vscode.Uri.joinPath(folderUri, codeUri, handlerParts.slice(0, handlerParts.length - 1).join('/') + '.py')
+        return vscode.Uri.joinPath(folderUri, handlerParts.slice(0, handlerParts.length - 1).join('/') + '.py')
     }
 
     // sample: app.handler -> app.mjs/app.js
@@ -591,23 +596,23 @@ export async function getLambdaHandlerFile(
         const handlerPath = path.dirname(handlerName)
         const handlerFile = path.basename(handlerName)
         const pattern = new vscode.RelativePattern(
-            vscode.Uri.joinPath(folderUri, codeUri, handlerPath),
-            `${handlerFile}.{js,mjs}`
+            vscode.Uri.joinPath(folderUri, handlerPath),
+            `${handlerFile}.{js,mjs,cjs,ts}`
         )
         return searchHandlerFile(folderUri, pattern)
     }
     // search directly under Code uri for Dotnet and java
     // sample: ImageResize::ImageResize.Function::FunctionHandler -> Function.cs
     if (family === RuntimeFamily.DotNet) {
         const handlerName = path.basename(handler.split('::')[1].replaceAll('.', '/'))
-        const pattern = new vscode.RelativePattern(vscode.Uri.joinPath(folderUri, codeUri), `${handlerName}.cs`)
+        const pattern = new vscode.RelativePattern(folderUri, `${handlerName}.cs`)
         return searchHandlerFile(folderUri, pattern)
     }
 
     // sample: resizer.App::handleRequest -> App.java
     if (family === RuntimeFamily.Java) {
         const handlerName = handler.split('::')[0].replaceAll('.', '/')
-        const pattern = new vscode.RelativePattern(vscode.Uri.joinPath(folderUri, codeUri), `**/${handlerName}.java`)
+        const pattern = new vscode.RelativePattern(folderUri, `**/${handlerName}.java`)
         return searchHandlerFile(folderUri, pattern)
     }
 }

packages/core/src/awsService/appBuilder/utils.ts

@@ -13,7 +13,6 @@ import { uploadLambdaCommand } from './commands/uploadLambda'
 import { LambdaFunctionNode } from './explorer/lambdaFunctionNode'
 import { downloadLambdaCommand, openLambdaFile } from './commands/downloadLambda'
 import { tryRemoveFolder } from '../shared/filesystemUtilities'
-import { ExtContext } from '../shared/extensions'
 import { invokeRemoteLambda } from './vue/remoteInvoke/invokeLambda'
 import { registerSamDebugInvokeVueCommand, registerSamInvokeVueCommand } from './vue/configEditor/samInvokeBackend'
 import { Commands } from '../shared/vscode/commands2'
@@ -42,6 +41,8 @@ import { registerLambdaUriHandler } from './uriHandlers'
 import globals from '../shared/extensionGlobals'
 
 const localize = nls.loadMessageBundle()
+import { activateRemoteDebugging } from './remoteDebugging/ldkController'
+import { ExtContext } from '../shared/extensions'
 
 async function openReadme() {
     const readmeUri = vscode.Uri.file(await getReadme())
@@ -263,4 +264,6 @@ export async function activate(context: ExtContext): Promise<void> {
 
         registerLambdaUriHandler()
     )
+
+    void activateRemoteDebugging()
 }