Merge pull request #56 from ServerlessLife/cdk-invalid-path

fix: CDK error Cannot find entry file

Author: ServerlessLife

README.md

@@ -324,6 +324,7 @@ If you have a new feature idea, please create and issue.
 
 (alphabetical)
 
+- [Roger Chi](https://rogerchi.com/)
 - ⭐ Your name here for notable code or documentation contributions or sample projects submitted with a bug report that resulted in tool improvement.
 
 ## Disclaimer

src/frameworks/cdkFramework.ts

@@ -212,26 +212,83 @@ export class CdkFramework implements IFramework {
     config: LldConfigBase,
   ) {
     const entryFile = await this.getCdkEntryFile(cdkConfigPath);
-    // Define a plugin to prepend custom code to .ts or .tsx files
+    let isESM = false;
+    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 rootDir = process.cwd();
+
+    // Plugin that:
+    // - Fixes __dirname issues
+    // - Injects code to get the file path of the Lambda function and CDK hierarchy
     const injectCodePlugin: esbuild.Plugin = {
       name: 'injectCode',
       setup(build: esbuild.PluginBuild) {
         build.onLoad({ filter: /.*/ }, async (args: esbuild.OnLoadArgs) => {
-          const absolutePath = path.resolve(args.path);
+          // fix __dirname issues
+          const isWindows = /^win/.test(process.platform);
+          const esc = (p: string) => (isWindows ? p.replace(/\\/g, '/') : p);
+
+          const variables = `
+              const __fileloc = {
+                filename: "${esc(args.path)}",
+                dirname: "${esc(path.dirname(args.path))}",
+                relativefilename: "${esc(path.relative(rootDir, args.path))}",
+                relativedirname: "${esc(
+                  path.relative(rootDir, path.dirname(args.path)),
+                )}",
+                import: { meta: { url: "file://${esc(args.path)}" } }
+              };
+            `;
+
+          let fileContent = new TextDecoder().decode(
+            await fs.readFile(args.path),
+          );
 
-          let source = await fs.readFile(absolutePath, 'utf8');
+          // remove shebang
+          if (fileContent.startsWith('#!')) {
+            const firstNewLine = fileContent.indexOf('\n');
+            fileContent = fileContent.slice(firstNewLine + 1);
+          }
+
+          let contents: string;
+          if (args.path.endsWith('.ts') || args.path.endsWith('.js')) {
+            // add the variables at the top of the file, that contains the file location
+            contents = `${variables}\n${fileContent}`;
+          } else {
+            contents = fileContent;
+          }
 
+          const loader = args.path.split('.').pop() as esbuild.Loader;
+
+          // Inject code to get the file path of the Lambda function and CDK hierarchy
           if (args.path.includes('aws-cdk-lib/aws-lambda/lib/function.')) {
             const codeToFind =
               'try{jsiiDeprecationWarnings().aws_cdk_lib_aws_lambda_FunctionProps(props)}';
 
-            if (!source.includes(codeToFind)) {
+            if (!contents.includes(codeToFind)) {
               throw new Error(`Can not find code to inject in ${args.path}`);
             }
 
             // Inject code to get the file path of the Lambda function and CDK hierarchy
             // path to match it with the Lambda function. Store data in the global variable.
-            source = source.replace(
+            contents = contents.replace(
               codeToFind,
               `;
               global.lambdas = global.lambdas ?? [];
@@ -264,55 +321,28 @@ export class CdkFramework implements IFramework {
           ) {
             const codeToFind = 'super(scope,id),this.requestDestinationArn=!1;';
 
-            if (!source.includes(codeToFind)) {
+            if (!contents.includes(codeToFind)) {
               throw new Error(`Can not find code to inject in ${args.path}`);
             }
 
             // Inject code to prevent deploying the assets
-            source = source.replace(codeToFind, codeToFind + `return;`);
+            contents = contents.replace(codeToFind, codeToFind + `return;`);
           }
 
           return {
-            contents: source,
-            loader: 'default',
+            contents,
+            loader,
           };
         });
       },
     };
 
-    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.${isESM ? 'mjs' : 'cjs'}`,
     );
 
-    const dirname = path.join(
-      ...([getProjectDirname(), config.subfolder, 'x'].filter(
-        (p) => p,
-      ) as string[]),
-    );
-
     try {
       // Build CDK code
       await esbuild.build({
@@ -331,7 +361,6 @@ export class CdkFramework implements IFramework {
               banner: {
                 js: [
                   `import { createRequire as topLevelCreateRequire } from 'module';`,
-                  `import.meta.url = 'file:///${dirname}/cdkFrameworkWorker.mjs';`,
                   `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))`,
@@ -341,10 +370,15 @@ export class CdkFramework implements IFramework {
           : {
               format: 'cjs',
               target: 'node18',
-              banner: {
-                js: [`__dirname = '${dirname}';`].join('\n'),
-              },
             }),
+        define: {
+          // replace __dirname,... with the a variable that contains the file location
+          __filename: '__fileloc.filename',
+          __dirname: '__fileloc.dirname',
+          __relativefilename: '__fileloc.relativefilename',
+          __relativedirname: '__fileloc.relativedirname',
+          'import.meta.url': '__fileloc.import.meta.url',
+        },
       });
     } catch (error: any) {
       throw new Error(`Error building CDK code: ${error.message}`, {

src/frameworks/cdkFrameworkWorker.mjs

@@ -1,12 +1,5 @@
 // @ts-nocheck
-import { createRequire as topLevelCreateRequire } from 'module';
-const require = topLevelCreateRequire(import.meta.url);
-import path from 'path';
-
 import { workerData, parentPort } from 'node:worker_threads';
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import fs from 'fs/promises'; // do not delete this line
-
 import { Logger } from '../logger.mjs';
 
 Logger.setVerbose(workerData.verbose);
@@ -21,7 +14,6 @@ parentPort.on('message', async (data) => {
     Logger.verbose(`[Worker ${workerData.workerId}] Received message`, data);
 
     // execute code to get the data into global.lambdas
-    await fixCdkPaths(workerData.awsCdkLibPath);
     await import(data.compileOutput);
 
     if (!global.lambdas || global.lambdas?.length === 0) {
@@ -43,7 +35,7 @@ parentPort.on('message', async (data) => {
     }));
 
     Logger.verbose(
-      `[CDK] [Worker] Sending found lambdas`,
+      `[CDK] [Worker] Sending found Lambdas`,
       JSON.stringify(lambdas, null, 2),
     );
     parentPort.postMessage(lambdas);
@@ -53,91 +45,6 @@ parentPort.on('message', async (data) => {
   }
 });
 
-/**
- * Some paths are not resolved correctly in the CDK code, so we need to fix them
- */
-async function fixCdkPaths(awsCdkLibPath) {
-  // leave this lines for manual debugging
-  //const awsCdkLibPath = path.resolve("node_modules/aws-cdk-lib");
-  //const path = require("path");
-
-  Logger.verbose(`[CDK] [Worker] aws-cdk-lib PATH ${awsCdkLibPath}`);
-
-  const pathsFix = {
-    'custom-resource-handlers/': `${awsCdkLibPath}/custom-resource-handlers/`,
-    'aws-custom-resource-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/custom-resources/aws-custom-resource-handler`,
-    'auto-delete-objects-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-s3/auto-delete-objects-handler`,
-    'notifications-resource-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-s3/notifications-resource-handler`,
-    'drop-spam-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-ses/drop-spam-handler`,
-    'aws-stepfunctions-tasks/role-policy-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-stepfunctions-tasks/role-policy-handler`,
-    'eval-nodejs-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-stepfunctions-tasks/eval-nodejs-handler`,
-    'cross-account-zone-delegation-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-route53/cross-account-zone-delegation-handler`,
-    'delete-existing-record-set-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-route53/delete-existing-record-set-handler`,
-    'aws-api-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-events-targets/aws-api-handler`,
-    'log-retention-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-logs/log-retention-handler`,
-    'cluster-resource-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-eks/cluster-resource-handler`,
-    'auto-delete-images-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-ecr/auto-delete-images-handler`,
-    'bucket-deployment-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-s3-deployment/bucket-deployment-handler`,
-    'nodejs-entrypoint-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/core/nodejs-entrypoint-handler`,
-    'restrict-default-security-group-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-ec2/restrict-default-security-group-handler`,
-    'dns-validated-certificate-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-certificatemanager/dns-validated-certificate-handler`,
-    'auto-delete-underlying-resources-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-synthetics/auto-delete-underlying-resources-handler`,
-    'replica-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-dynamodb/replica-handler`,
-    'oidc-handler': `${awsCdkLibPath}/custom-resource-handlers/dist/aws-iam/oidc-handler`,
-  };
-
-  // Create a proxy to intercept calls to the path module so we can fix paths
-  const pathProxy = new Proxy(path, {
-    get(target, prop) {
-      if (typeof target[prop] === 'function') {
-        return function (...args) {
-          if (prop === 'resolve') {
-            let resolvedPath = target[prop].apply(target, args);
-
-            for (const [key, value] of Object.entries(pathsFix)) {
-              if (resolvedPath.includes(key)) {
-                // replace the beginning of the path with the value
-                const i = resolvedPath.indexOf(key);
-                const newResolvedPath = `${value}${resolvedPath.substring(i + key.length)}`;
-                Logger.verbose(
-                  `[CDK] [Worker] Fixing path ${resolvedPath} -> ${newResolvedPath}`,
-                );
-                resolvedPath = newResolvedPath;
-              }
-            }
-
-            return resolvedPath;
-          }
-          if (prop === 'join') {
-            let resolvedPath = target[prop].apply(target, args);
-
-            for (const [key, value] of Object.entries(pathsFix)) {
-              if (resolvedPath.includes(key)) {
-                // replace the beginning of the path with the value
-                const i = resolvedPath.indexOf(key);
-                const newResolvedPath = `${value}${resolvedPath.substring(i + key.length)}`;
-                Logger.verbose(
-                  `[CDK] [Worker] Fixing path ${resolvedPath} -> ${newResolvedPath}`,
-                );
-                resolvedPath = newResolvedPath;
-              }
-            }
-
-            return resolvedPath;
-          }
-          return target[prop].apply(target, args);
-        };
-      }
-      return target[prop];
-    },
-  });
-
-  // Override the path module in the require cache
-  require.cache[require.resolve('path')] = {
-    exports: pathProxy,
-  };
-}
-
 process.on('unhandledRejection', (error) => {
   Logger.error(`[CDK] [Worker] Unhandled Rejection`, error);
 });

src/nodeWorkerRunner.mjs

@@ -13,16 +13,16 @@ Logger.verbose(
 
 parentPort.on('message', async (data) => {
   Logger.verbose(`[Worker ${workerData.workerId}] Received message`, data);
-  const mod = await import(workerData.artifactFile);
-  const fn = mod[workerData.handler];
+  try {
+    const mod = await import(workerData.artifactFile);
+    const fn = mod[workerData.handler];
 
-  if (!fn) {
-    throw new Error(
-      `Handler '${workerData.handler}' not found for function '${workerData.functionId}'`,
-    );
-  }
+    if (!fn) {
+      throw new Error(
+        `Handler '${workerData.handler}' not found for function '${workerData.functionId}'`,
+      );
+    }
 
-  try {
     const context = {
       ...data.context,
       getRemainingTimeInMillis: () => 2147483647, // Max 32-bit signed integer

test/cdk-basic.test.ts

@@ -153,6 +153,17 @@ async function getFunctionName(folder: string, functionName: string) {
   const cdkOutputs = JSON.parse(
     await fs.readFile(path.join(folder, 'cdk-outputs.json'), 'utf-8'),
   );
-  const lambdaName = cdkOutputs['test-lld-cdk-basic'][functionName];
+  let lambdaName = cdkOutputs['test-lld-cdk-basic'][functionName];
+
+  if (!lambdaName) {
+    lambdaName = cdkOutputs['test-lld-cdk-basic2'][functionName];
+  }
+
+  if (!lambdaName) {
+    throw new Error(
+      `Lambda name not found for ${functionName} in cdk-outputs.json`,
+    );
+  }
+
   return lambdaName;
 }

test/cdk-basic/bin/cdk-basic.ts

@@ -2,24 +2,16 @@
 import 'source-map-support/register';
 import * as cdk from 'aws-cdk-lib';
 import { CdkbasicStack } from '../lib/cdk-basic-stack';
+import { CdkbasicStack2 } from '../lib/subfolder/cdk-basic-stack2';
 
 const app = new cdk.App();
 
 const environment = 'test';
 
 new CdkbasicStack(app, 'CdkbasicStack', {
   stackName: `${environment}-lld-cdk-basic`,
-  /* If you don't specify 'env', this stack will be environment-agnostic.
-   * Account/Region-dependent features and context lookups will not work,
-   * but a single synthesized template can be deployed anywhere. */
-
-  /* Uncomment the next line to specialize this stack for the AWS Account
-   * and Region that are implied by the current CLI configuration. */
-  // env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION },
-
-  /* Uncomment the next line if you know exactly what Account and Region you
-   * want to deploy the stack to. */
-  // env: { account: '123456789012', region: 'us-east-1' },
+});
 
-  /* For more information, see https://docs.aws.amazon.com/cdk/latest/guide/environments.html */
+new CdkbasicStack2(app, 'CdkbasicStack2', {
+  stackName: `${environment}-lld-cdk-basic2`,
 });