fix: Custom framework implementation

Author: ServerlessLife

README.md

@@ -146,15 +146,6 @@ export default {
 
 The setting are the same as for CLI parameters.
 
-### Custom framework implementation and adjustment
-
-```typescript
-getLambdas: async (foundLambdas) => {
-//you can customize the list of lambdas here or create your own
-//return foundLambdas;
-},
-```
-
 ### Debugging
 
 You might want to configure your development tool for debugging. The wizard automatically configures for VsCode in `.vscode/launch.json`. Here is an example:
@@ -221,6 +212,101 @@ Only the basic setup is supported. Check the [test case](https://github.com/Serv
 
 I am not a Terraform developer, so I only know the basics. Please provide a sample project so I can build better support.
 
+### Custom framework implementation and adjustment
+
+Configuration file `lldebugger.config.ts` enables you to modify the list of Lambdas, change the code path, esBuild configuration, or provide your own list of Lambdas, thereby supporting support **any framework**. For this to work, install Lambda Live Debugger locally in the project.
+
+```typescript
+getLambdas: async (foundLambdas, config) => {
+  //you can customize the list of lambdas here or create your own
+  return foundLambdas;
+},
+```
+
+**Filter list of functions:**
+
+```typescript
+getLambdas: async (foundLambdas, config) => {
+  return foundLambdas?.filter((l) =>
+    l.functionName.includes("myfunction"),
+ );
+},
+```
+
+**Modify code path:**\
+For example, when the framework has only a list of JavaScript files, but you transpiled them from TypeScript with your own solution.
+
+```typescript
+getLambdas: async (foundLambdas, config) => {
+  if (foundLambdas) {
+    for (const lambda of foundLambdas) {
+ lambda.codePath = lambda.codePath
+        .replace("/dist/", "/src/")
+        .replace(".js", ".ts");
+ }
+ }
+},
+```
+
+**Modfiy esBuild configuration:**
+
+```typescript
+import { type EsBuildOptions, type LldConfigTs } from "lambda-live-debugger";
+
+export default {
+  ...
+ getLambdas: async (foundLambdas, config) => {
+    if (foundLambdas) {
+      for (const lambda of foundLambdas) {
+ lambda.esBuildOptions = {
+ target: "node14",
+ };
+ }
+ }
+ },
+} satisfies LldConfigTs;
+```
+
+**Provide your own list of Lambdas and support any framework**:
+
+```typescript
+export default {
+  //framework: <-- you do not need this line
+  ...
+ getLambdas: async (foundLambdas, config) => {
+    return [
+ {
+        // function name as deployed on AWS
+ functionName: "mystack-myfunction",
+ codePath: "/src/myLambda.ts",
+ },
+ ];
+ },
+} satisfies LldConfigTs;
+```
+
+**Modify existing framework support:**
+
+```typescript
+import { CdkFramework, type LldConfigBase, type LldConfigTs } from "lambda-live-debugger";
+
+class MyCdkFramework extends CdkFramework {
+  override getCdkContext(
+ cdkConfigPath: string,
+ config: LldConfigBase,
+ ) {
+    // your implementation
+ }
+}
+
+export default {
+  ...
+ getLambdas: async (foundLambdas, config) => {
+    return new MyCdkFramework().getLambdas(config);
+ }
+} satisfies LldConfigTs;s
+```
+
 ## Know issues
 
 Check the [GitHub issues](https://github.com/ServerlessLife/lambda-live-debugger/issues).
@@ -235,7 +321,7 @@ Check the [GitHub issues](https://github.com/ServerlessLife/lambda-live-debugger
 - Use descriptive titles with prefixes like "bug:", "help:", "feature:", or "discussion:".
 - Enable verbose logging and provide the full log.
 - Describe your setup in detail, or better yet, provide a sample project.
-- Specify exact framework version (CDK, SLS, SAM ...) and exact version of Lambda Live Debugger version.
+- Specify the exact framework version (CDK, SLS, SAM ...) and the exact Lambda Live Debugger version.
 
 ## Authors:
 

src/configuration.ts

@@ -142,7 +142,7 @@ async function discoverLambdas() {
   }
 
   if (config.getLambdas) {
-    lambdasListNew = await config.getLambdas(lambdasListNew);
+    lambdasListNew = await config.getLambdas(lambdasListNew, config);
   }
 
   if (!lambdasListNew) {

src/frameworks/cdkFramework.ts

@@ -11,8 +11,8 @@ import { LldConfigBase } from "../types/lldConfig.js";
 import { Logger } from "../logger.js";
 import { Worker } from "node:worker_threads";
 import { getModuleDirname, getProjectDirname } from "../getDirname.js";
-import { Configuration } from "../configuration.js";
 import { findNpmPath } from "../utils/findNpmPath.js";
+import { type BundlingOptions } from "aws-cdk-lib/aws-lambda-nodejs";
 
 /**
  * Support for AWS CDK framework
@@ -315,14 +315,89 @@ export class CdkFramework implements IFramework {
     );
     Logger.verbose(`[CDK] aws-cdk-lib path: ${awsCdkLibPath}`);
 
+    const lambdas = await this.runCdkCodeAndReturnLambdas({
+      config,
+      awsCdkLibPath,
+      compileCodeFile: compileOutput,
+    });
+
+    const list = await Promise.all(
+      lambdas.map(async (lambda) => {
+        // handler slit into file and file name
+        const handlerSplit = lambda.handler.split(".");
+
+        const handler = handlerSplit.pop();
+        const filename = handlerSplit[0];
+
+        let codePath = lambda.codePath;
+
+        if (!codePath) {
+          const codePathJs = lambda.code?.path
+            ? path.join(lambda.code.path, `${filename}.js`)
+            : undefined;
+          const codePathCjs = lambda.code?.path
+            ? path.join(lambda.code.path, `${filename}.cjs`)
+            : undefined;
+          const codePathMjs = lambda.code?.path
+            ? path.join(lambda.code.path, `${filename}.mjs`)
+            : undefined;
+
+          // get  the first file that exists
+          codePath = [codePathJs, codePathCjs, codePathMjs]
+            .filter((c) => c)
+            .find((file) =>
+              fs
+                .access(file as string)
+                .then(() => true)
+                .catch(() => false),
+            );
+
+          if (!codePath) {
+            throw new Error(
+              `Code file not found for Lambda function ${lambda.code.path}`,
+            );
+          }
+        }
+
+        const packageJsonPath = await findPackageJson(codePath);
+        Logger.verbose(`[CDK] package.json path: ${packageJsonPath}`);
+
+        return {
+          cdkPath: lambda.cdkPath,
+          stackName: lambda.stackName,
+          packageJsonPath,
+          codePath,
+          handler,
+          bundling: lambda.bundling,
+        };
+      }),
+    );
+
+    return list;
+  }
+
+  /**
+   * Run CDK code in a node thread worker and return the Lambda functions
+   * @param param0
+   * @returns
+   */
+  protected async runCdkCodeAndReturnLambdas({
+    config,
+    awsCdkLibPath,
+    compileCodeFile,
+  }: {
+    config: LldConfigBase;
+    awsCdkLibPath: string | undefined;
+    compileCodeFile: string;
+  }) {
     const lambdas: any[] = await new Promise((resolve, reject) => {
       const worker = new Worker(
         path.resolve(
           path.join(getModuleDirname(), "frameworks/cdkFrameworkWorker.mjs"),
         ),
         {
           workerData: {
-            verbose: Configuration.config.verbose,
+            verbose: config.verbose,
             awsCdkLibPath,
             projectDirname: getProjectDirname(),
             moduleDirname: getModuleDirname(),
@@ -350,7 +425,7 @@ export class CdkFramework implements IFramework {
       });
 
       worker.postMessage({
-        compileOutput,
+        compileOutput: compileCodeFile,
       });
     });
 
@@ -359,51 +434,17 @@ export class CdkFramework implements IFramework {
       JSON.stringify(lambdas, null, 2),
     );
 
-    const list = await Promise.all(
-      lambdas.map(async (lambda: any) => {
-        // handler slit into file and file name
-        const handlerSplit = lambda.handler.split(".");
-
-        const handler = handlerSplit.pop();
-        const filename = handlerSplit[0];
-
-        let codePath = lambda.codePath;
-
-        if (!codePath) {
-          const codePathJs = path.join(lambda.code.path, `${filename}.js`);
-          const codePathCjs = path.join(lambda.code.path, `${filename}.cjs`);
-          const codePathMjs = path.join(lambda.code.path, `${filename}.mjs`);
-
-          // get the first file that exists
-          codePath = [codePathJs, codePathCjs, codePathMjs].find((file) =>
-            fs
-              .access(file)
-              .then(() => true)
-              .catch(() => false),
-          );
-
-          if (!codePath) {
-            throw new Error(
-              `Code file not found for Lambda function ${lambda.code.path}`,
-            );
-          }
-        }
-
-        const packageJsonPath = await findPackageJson(codePath);
-        Logger.verbose(`[CDK] package.json path: ${packageJsonPath}`);
-
-        return {
-          cdkPath: lambda.cdkPath,
-          stackName: lambda.stackName,
-          packageJsonPath,
-          codePath,
-          handler,
-          bundling: lambda.bundling,
-        };
-      }),
-    );
-
-    return list;
+    return lambdas as {
+      cdkPath: string;
+      stackName: string;
+      codePath?: string;
+      code: {
+        path?: string;
+      };
+      handler: string;
+      packageJsonPath: string;
+      bundling: BundlingOptions;
+    }[];
   }
 
   /**

src/frameworks/terraformFramework.ts

@@ -8,6 +8,7 @@ import { promisify } from "util";
 import ts from "typescript";
 import { IFramework } from "./iFrameworks.js";
 import { Logger } from "../logger.js";
+import { LldConfigBase } from "../types/lldConfig.js";
 
 export const execAsync = promisify(exec);
 
@@ -57,10 +58,11 @@ export class TerraformFramework implements IFramework {
 
   /**
    * Get Lambda functions
-   * @param config Configuration
+   * @param _config Configuration
    * @returns Lambda functions
    */
-  public async getLambdas(): Promise<LambdaResource[]> {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  public async getLambdas(config: LldConfigBase): Promise<LambdaResource[]> {
     const state = await this.readTerraformState();
     const lambdas = this.extractLambdaInfo(state);
 

src/index.ts

@@ -1,12 +1,13 @@
 // Types exposed to the project, mainly used in lldebugger.config.ts configuraiton file
-export { type LldConfigTs } from "./types/lldConfig.js";
+export { type LldConfigTs, type LldConfigBase } from "./types/lldConfig.js";
 export type {
   EsBuildOptions,
   BundlingType,
-  LambdaResource as LambdaResource,
+  LambdaResource,
 } from "./types/resourcesDiscovery.js";
 export { CdkFramework } from "./frameworks/cdkFramework.js";
 export { SlsFramework } from "./frameworks/slsFramework.js";
 export { SamFramework } from "./frameworks/samFramework.js";
 export { TerraformFramework } from "./frameworks/terraformFramework.js";
-export type { IFramework } from "./frameworks/iFrameworks.js";
+export { type IFramework } from "./frameworks/iFrameworks.js";
+export { type AwsConfiguration } from "./types/awsConfiguration.js";

src/types/lldConfig.ts

@@ -49,6 +49,7 @@ export type LldConfigBase = {
    */
   getLambdas?: (
     foundFunctions?: LambdaResource[],
+    config?: LldConfigBase,
   ) => Promise<LambdaResource[] | undefined>;
 
   /**

test/cdk-config/lldebugger.config.ts

@@ -6,7 +6,7 @@ export default {
   context: ["e=1", "e=2", "e=3", "e=4"],
   observable: false,
   verbose: false,
-  //getLambdas: async (foundLambdas) => {
+  //getLambdas: async (foundLambdas, config) => {
   //  you can customize the list of lambdas here or create your own
   //  return foundLambdas;
   //},