fix: [#44] CDK ES module

Author: ServerlessLife

.github/workflows/common-test.yml

@@ -72,6 +72,53 @@ jobs:
       - name: Test - observable mode
         run: OBSERVABLE_MODE=true npx vitest --retry 1 test/cdk-basic.test.ts
 
+  test-cdk-esm:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: test-cdk-esm
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.node_version }}
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: npm ci
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        if: ${{ inputs.mode == 'build' }}
+        with:
+          name: dist
+          path: dist
+      - name: Install lambda-live-debugger globally
+        if: ${{ inputs.mode == 'global' }}
+        run: |
+          npm i lambda-live-debugger -g
+        working-directory: test
+      - name: Install lambda-live-debugger locally
+        if: ${{ inputs.mode == 'local' }}
+        run: |
+          npm i lambda-live-debugger
+        working-directory: test
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-region: eu-west-1
+          role-to-assume: ${{ secrets.AWS_ROLE }}
+          role-session-name: GitHubActions
+      - name: Destroy
+        run: npm run destroy
+        working-directory: test/cdk-esm
+        continue-on-error: true
+      - name: Deploy
+        run: npm run deploy
+        working-directory: test/cdk-esm
+      - name: Test
+        run: npx vitest --retry 1 test/cdk-esm.test.ts
+      - name: Test - observable mode
+        run: OBSERVABLE_MODE=true npx vitest --retry 1 test/cdk-esm.test.ts
+
   test-sls-basic:
     runs-on: ubuntu-latest
     concurrency:

.vscode/launch.json

@@ -24,6 +24,26 @@
       "type": "node",
       "cwd": "${workspaceRoot}/test/cdk-basic"
     },
+    {
+      "name": "LLDebugger - CDK ESM",
+      "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",
+      "args": ["../../src/lldebugger.ts", "-c environment=test"],
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal",
+      "type": "node",
+      "cwd": "${workspaceRoot}/test/cdk-esm"
+    },
+    {
+      "name": "LLDebugger - CDK ESM - observable",
+      "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",
+      "args": ["../../src/lldebugger.ts", "-c environment=test", "-o"],
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal",
+      "type": "node",
+      "cwd": "${workspaceRoot}/test/cdk-esm"
+    },
     {
       "name": "LLDebugger - SLS basic",
       "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",

package-lock.json

@@ -49,6 +49,8 @@
     "test": "npm run build && RUN_TEST_FROM_CLI=true vitest run && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run",
     "test-cdk-basic": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/cdk-basic.test.ts",
     "test-cdk-basic-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/cdk-basic.test.ts",
+    "test-cdk-esm": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/cdk-esm.test.ts",
+    "test-cdk-esm-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/cdk-esm.test.ts",
     "test-sls-basic": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/sls-basic.test.ts",
     "test-sls-basic-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/sls-basic.test.ts",
     "test-sls-esbuild-cjs": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/sls-esbuild-cjs.test.ts",
@@ -130,6 +132,7 @@
     "src/extension/*",
     "test",
     "test/cdk-basic",
+    "test/cdk-esm",
     "test/cdk-config",
     "test/sls-basic",
     "test/sls-esbuild",

package.json

@@ -280,21 +280,61 @@ export class CdkFramework implements IFramework {
       },
     };
 
+    let isESM = false;
+    // get packgage.json
+    const packageJsonPath = await findPackageJson(entryFile);
+
+    if (packageJsonPath) {
+      try {
+        const packageJson = JSON.parse(
+          await fs.readFile(packageJsonPath, { encoding: 'utf-8' }),
+        );
+        if (packageJson.type === 'module') {
+          isESM = true;
+          Logger.verbose(`[CDK] Using ESM format`);
+        }
+      } catch (err: any) {
+        Logger.error(
+          `Error reading CDK package.json (${packageJsonPath}): ${err.message}`,
+          err,
+        );
+      }
+    }
+
     const compileOutput = path.join(
       getProjectDirname(),
       outputFolder,
-      `compiledCdk.js`,
+      `compiledCdk.${isESM ? 'mjs' : 'cjs'}`,
     );
+
     try {
       // Build CDK code
       await esbuild.build({
         entryPoints: [entryFile],
         bundle: true,
         platform: 'node',
-        target: 'node18',
+        keepNames: true,
         outfile: compileOutput,
         sourcemap: false,
         plugins: [injectCodePlugin],
+        ...(isESM
+          ? {
+              format: 'esm',
+              target: 'esnext',
+              mainFields: ['module', 'main'],
+              banner: {
+                js: [
+                  `import { createRequire as topLevelCreateRequire } from 'module';`,
+                  `global.require = global.require ?? topLevelCreateRequire(import.meta.url);`,
+                  `import { fileURLToPath as topLevelFileUrlToPath, URL as topLevelURL } from "url"`,
+                  `global.__dirname = global.__dirname ?? topLevelFileUrlToPath(new topLevelURL(".", import.meta.url))`,
+                ].join('\n'),
+              },
+            }
+          : {
+              format: 'cjs',
+              target: 'node18',
+            }),
       });
     } catch (error: any) {
       throw new Error(`Error building CDK code: ${error.message}`, {

src/frameworks/cdkFramework.ts

@@ -4,7 +4,6 @@ const require = topLevelCreateRequire(import.meta.url);
 import path from 'path';
 
 import { workerData, parentPort } from 'node:worker_threads';
-import fs from 'fs/promises';
 
 import { Logger } from '../logger.mjs';
 
@@ -25,11 +24,10 @@ parentPort.on('message', async (data) => {
   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 codeFile = await fs.readFile(data.compileOutput, 'utf8');
   await fixCdkPaths(workerData.awsCdkLibPath);
-
-  eval(codeFile);
+  // eval(codeFile);
+  await import(data.compileOutput);
 
   if (!global.lambdas || global.lambdas?.length === 0) {
     throw new Error('No Lambda functions found in the CDK code');

src/frameworks/cdkFrameworkWorker.mjs

@@ -1,5 +1,5 @@
 {
-  "name": "cdk-basic-test-js-commonjs",
+  "name": "cdk-config-test-js-commonjs",
   "version": "1.0.0",
   "type": "commonjs",
   "dependencies": {

test/cdk-config/services/testJsCommonJs/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "cdk-basic-test-js-esmodule",
+  "name": "cdk-config-test-js-esmodule",
   "version": "1.0.0",
   "type": "module",
   "dependencies": {

test/cdk-config/services/testJsEsModule/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "cdk-basic-test-ts-commonjs",
+  "name": "cdk-config-test-ts-commonjs",
   "version": "1.0.0",
   "type": "commonjs",
   "devDependencies": {

test/cdk-config/services/testTsCommonJs/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "cdk-basic-test-ts-esmodule",
+  "name": "cdk-config-test-ts-esmodule",
   "version": "1.0.0",
   "type": "module",
   "devDependencies": {