fix: Move running CDK code in worker

Author: ServerlessLife

package.json

@@ -39,7 +39,7 @@
   "scripts": {
     "typecheck": "tsc --noEmit -p tsconfig.typecheck.json && npx tsc --noEmit -p src/extension/tsconfig.json",
     "add-bang": "sed -i '1s|^|#!/usr/bin/env node\\n|' ./dist/lldebugger.mjs",
-    "build": "tsc -p tsconfig.build.json && cp src/nodeWorkerRunner.mjs dist && node fix-imports.js && npm run add-bang && npm run bundle-extension",
+    "build": "tsc -p tsconfig.build.json && cp src/nodeWorkerRunner.mjs dist && cp src/frameworks/cdkFrameworkWorker.mjs dist/frameworks && node fix-imports.js && npm run add-bang && npm run bundle-extension",
     "bundle-extension": "cd src/extension && npm run build && cd ../../",
     "deploy-github-role": "aws cloudformation deploy --stack-name lld-deploy-role --template-file cloudformation/gitHubDeployRole.yaml --capabilities CAPABILITY_IAM CAPABILITY_NAMED_IAM --profile lldebugger",
     "deploy-tests": "npm run deploy --workspaces",

src/configuration/getConfigFromCliArgs.ts

@@ -20,13 +20,13 @@ export async function getConfigFromCliArgs(
   program.name("lld").description("Lambda Live Debugger").version(version);
   program.option(
     "-r, --remove [option]",
-    "Remove Lambda Live Debugger infrastructure. Options: 'keep-layer' (default), 'remove-all'. The lates also remove the Lambda Layer"
+    "Remove Lambda Live Debugger infrastructure. Options: 'keep-layer' (default), 'remove-all'. The latest also removes the Lambda Layer"
     //validateRemoveOption,
     //"keep-layer"
   );
   program.option(
     "-w, --wizard",
-    "Program interactively asks for each parameter and save it to lldebugger.config.ts"
+    "Program interactively asks for each parameter and saves it to lldebugger.config.ts"
   );
   program.option("-v, --verbose", "Verbose logs");
   program.option(
@@ -38,7 +38,7 @@ export async function getConfigFromCliArgs(
   program.option("-s, --stage <stage>", "Serverless Framework stage");
   program.option(
     "-f, --function <function name>",
-    "Filter by function name. You can use * as wildcard"
+    "Filter by function name. You can use * as a wildcard"
   );
   program.option("-m, --subfolder <subfolder>", "Monorepo subfolder");
   program.option("-o, --observable", "Observable mode");

src/frameworks/cdkFramework.ts

@@ -3,26 +3,15 @@ import * as fs from "fs/promises";
 import * as path from "path";
 import { BundlingType, LambdaResource } from "../types/resourcesDiscovery.js";
 import { outputFolder } from "../constants.js";
-import type { BundlingOptions } from "aws-cdk-lib/aws-lambda-nodejs";
 import { findPackageJson } from "../utils/findPackageJson.js";
 import { IFramework } from "./iFrameworks.js";
 import { CloudFormation } from "../cloudFormation.js";
 import { AwsConfiguration } from "../types/awsConfiguration.js";
 import { LldConfigBase } from "../types/lldConfig.js";
 import { Logger } from "../logger.js";
-
-// this is global variable to store the data from the CDK code once it is executed
-declare global {
-  var lambdas: Array<{
-    code: any;
-    node: any;
-    //cdkPath: string;
-    stackName: string;
-    codePath: string;
-    handler: string;
-    bundling: BundlingOptions;
-  }>;
-}
+import { Worker } from "node:worker_threads";
+import { getModuleDirname } from "../getDirname.js";
+import { Configuration } from "../configuration.js";
 
 /**
  * Support for AWS CDK framework
@@ -219,10 +208,6 @@ export class CdkFramework implements IFramework {
     config: LldConfigBase
   ) {
     const entryFile = await this.getCdkEntryFile(cdkConfigPath);
-
-    // this is global variable to store the data from the CDK code once it is executed
-    global.lambdas = [];
-
     // Define a plugin to prepend custom code to .ts or .tsx files
     const injectCodePlugin: esbuild.Plugin = {
       name: "injectCode",
@@ -319,30 +304,49 @@ export class CdkFramework implements IFramework {
     process.env.CDK_CONTEXT_JSON = JSON.stringify(CDK_CONTEXT_JSON);
     Logger.verbose(`[CDK] context:`, JSON.stringify(CDK_CONTEXT_JSON, null, 2));
 
-    // execute code to get the data into global.lambdas
-    const codeFile = await fs.readFile(compileOutput, "utf8");
-    //const __dirname = path.resolve("x/"); // CDK needs this, pure magic
-    const __dirname = path.resolve("./node_modules/aws-cdk-lib/x/x"); // CDK needs this, pure magic
-    eval(codeFile);
+    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,
+          },
+        }
+      );
 
-    if (global.lambdas.length === 0) {
-      throw new Error("No Lambda functions found in the CDK code");
-    }
+      worker.on("message", (message) => {
+        resolve(message);
+        worker.terminate();
+      });
+
+      worker.on("error", (error) => {
+        reject(
+          new Error(`Error running CDK code in worker: ${error.message}`, {
+            cause: error,
+          })
+        );
+      });
 
-    const lambdasPrettified = global.lambdas.map((lambda: any) => ({
-      stackName: lambda.stackName,
-      codePath: lambda.codePath,
-      handler: lambda.handler,
-      bundling: lambda.bundling,
-    }));
+      worker.on("exit", (code) => {
+        if (code !== 0) {
+          reject(new Error(`CDK worker stopped with exit code ${code}`));
+        }
+      });
+
+      worker.postMessage({
+        compileOutput,
+      });
+    });
 
     Logger.verbose(
       `[CDK] Found the following Lambda functions in the CDK code:`,
-      JSON.stringify(lambdasPrettified, null, 2)
+      JSON.stringify(lambdas, null, 2)
     );
 
     const list = await Promise.all(
-      global.lambdas.map(async (lambda: any) => {
+      lambdas.map(async (lambda: any) => {
         // handler slit into file and file name
         const handlerSplit = lambda.handler.split(".");
 
@@ -375,7 +379,7 @@ export class CdkFramework implements IFramework {
         Logger.verbose(`[CDK] package.json path: ${packageJsonPath}`);
 
         return {
-          cdkPath: lambda.node.defaultChild.node.path,
+          cdkPath: lambda.cdkPath,
           stackName: lambda.stackName,
           packageJsonPath,
           codePath,

src/frameworks/cdkFrameworkWorker.mjs

@@ -0,0 +1,61 @@
+import { createRequire as topLevelCreateRequire } from "module";
+const require = topLevelCreateRequire(import.meta.url);
+
+import { workerData, parentPort } from "node:worker_threads";
+import fs from "fs/promises";
+import path from "path";
+
+import { Logger } from "../logger.mjs";
+
+Logger.setVerbose(workerData.verbose);
+Logger.verbose(`[CDK] [Worker] Started`);
+
+parentPort.on("message", async (data) => {
+  // this is global variable to store the data from the CDK code once it is executed
+  global.lambdas = [];
+
+  Logger.verbose(`[Worker ${workerData.workerId}] Received message`, data);
+
+  // execute code to get the data into global.lambdas
+  const codeFile = await fs.readFile(data.compileOutput, "utf8");
+  const __dirname = path.resolve("./node_modules/aws-cdk-lib/x/x"); // CDK needs this, pure magic
+  eval(codeFile);
+
+  if (global.lambdas.length === 0) {
+    throw new Error("No Lambda functions found in the CDK code");
+  }
+
+  const lambdas = global.lambdas.map((lambda) => ({
+    handler: lambda.handler,
+    stackName: lambda.stackName,
+    codePath: lambda.codePath,
+    code: {
+      path: lambda.code?.path,
+    },
+    cdkPath: lambda.node.defaultChild.node.path,
+    bundling: lambda.bundling,
+  }));
+
+  try {
+    Logger.verbose(
+      `[CDK] [Worker] Sending found lambdas`,
+      JSON.stringify(lambdas, null, 2)
+    );
+    parentPort.postMessage(lambdas);
+  } catch (error) {
+    handleError(error);
+  }
+});
+
+process.on("unhandledRejection", (error) => {
+  Logger.error(`[CDK] [Worker] Unhandled Rejection`, error);
+  handleError(error);
+});
+
+function handleError(error) {
+  parentPort.postMessage({
+    errorType: error.name ?? "Error",
+    errorMessage: error.message,
+    trace: error.stack,
+  });
+}

src/ioTService.ts

@@ -5,6 +5,7 @@ import type {
   AwsCredentialIdentityProvider,
   AwsCredentialIdentity,
 } from "@smithy/types";
+import { Logger } from "./logger.js";
 
 let device: iot.device;
 
@@ -134,24 +135,24 @@ async function connect(props?: {
 
   if (props?.topic) {
     device.subscribe(props.topic, { qos: 1 });
-    console.debug("Subscribed to topic ", props.topic);
+    Logger.verbose("[IoT] Subscribed to topic ", props.topic);
   }
 
   device.on("connect", () => {
-    console.debug("IoT connected");
+    Logger.verbose("[IoT] Connected");
     connectedPromiseResolve();
   });
 
   device.on("error", (err) => {
-    console.debug("IoT error", err);
+    Logger.error("[IoT] Error", err);
   });
 
   device.on("close", () => {
-    console.debug("IoT closed");
+    Logger.verbose("[IoT] Closed");
   });
 
   device.on("reconnect", () => {
-    console.debug("IoT reconnecting...");
+    Logger.verbose("[IoT] Reconnecting...");
   });
 
   if (props?.onMessage) {
@@ -183,6 +184,8 @@ async function connect(props?: {
     device.on("message", messageReceived);
   }
 
+  await connectedPromise;
+
   return {
     publish: async (payload, topic) => {
       await connectedPromise;

src/lldebugger.ts

@@ -97,7 +97,7 @@ async function run() {
   const rootFolderForWarchingChanges = getRootFolder(folders);
   FileWatcher.watchForFileChanges(rootFolderForWarchingChanges);
 
-  LambdaConnection.connect();
+  await LambdaConnection.connect();
   Logger.log("Debugger started!");
 }
 

src/logger.mjs

@@ -0,0 +1,24 @@
+let verboseEnabled = false;
+/**
+ * Log verbose message in verbose logging is enabled
+ * @param args
+ */
+function verbose(...args) {
+    if (verboseEnabled) {
+        console.info(...args);
+    }
+}
+/**
+ *
+ * @param enabled
+ */
+function setVerbose(enabled) {
+    verboseEnabled = enabled;
+}
+export const Logger = {
+    log: console.log,
+    error: console.error,
+    warn: console.warn,
+    verbose,
+    setVerbose,
+};

src/nodeWorkerRunner.mjs

@@ -2,7 +2,7 @@ import { createRequire as topLevelCreateRequire } from "module";
 const require = topLevelCreateRequire(import.meta.url);
 
 import { workerData, parentPort } from "node:worker_threads";
-import { Logger } from "../dist/logger.mjs";
+import { Logger } from "./logger.mjs";
 
 Logger.setVerbose(workerData.verbose);
 Logger.verbose(

test/utils/startDebugger.ts

@@ -46,7 +46,7 @@ async function startDebuggerInternal(folder: string, args: string[] = []) {
     lldProcess.stdout?.on("data", (data) => {
       console.log("LLD: " + data.toString());
       const line = data.toString();
-      if (line.includes("IoT connected")) {
+      if (line.includes("Debugger started!")) {
         resolve(true);
       }
     });