@bifravst/aws-cdk-lambda-helpers 1.2.5 → 1.2.6

package/README.md

@@ -11,4 +11,12 @@ Helper functions which simplify working with TypeScript lambdas for AWS CDK.
 
 ## Installation
 
-    npm i --save --save-exact @bifravst/aws-cdk-lambda-helpers
+    npm i --save-dev --save-exact @bifravst/aws-cdk-lambda-helpers
+
+## Usage
+
+See [the end-to-end test stack](./cdk/e2e.ts).
+
+## Example migrations to `@bifravst/aws-cdk-lambda-helpers`
+
+- [world.thingy.rocks backend](https://github.com/NordicPlayground/thingy-rocks-cloud-aws-js/commit/3ca6e267917db4d8cb09ca63ed54384c0e23f163)

package/dist/src/module-folder-named-like-handler-bug.spec.js

@@ -8,8 +8,12 @@ import os from 'node:os';
 const tmpDir = os.tmpdir();
 void describe('packLambda()', () => {
     // See https://github.com/aws/aws-lambda-nodejs-runtime-interface-client/issues/93#issuecomment-2042201321
-    void it('should fail if it imports from a folder that has the same name as the handler module', async () => assert.rejects(async () => packLambda({
-        sourceFile: path.join(dirname(fileURLToPath(import.meta.url)), 'test-data', 'module-folder-named-like-handler-bug', 'acme.ts'),
+    void it('should fail if it imports from a folder on the same level that has the same name as the handler module', async () => assert.rejects(async () => packLambda({
+        sourceFile: path.join(dirname(fileURLToPath(import.meta.url)), 'test-data', 'module-folder-named-like-handler-bug', 'same-level', 'acme.ts'),
         zipFile: path.join(await fs.mkdtemp(`${tmpDir}${path.sep}`), 'acme.zip'),
     }), ImportFromFolderNameError));
+    void it('should not fail if it a folder with the same name is on a different level', async () => assert.doesNotReject(async () => packLambda({
+        sourceFile: path.join(dirname(fileURLToPath(import.meta.url)), 'test-data', 'module-folder-named-like-handler-bug', 'different-level', 'lambda', 'acme.ts'),
+        zipFile: path.join(await fs.mkdtemp(`${tmpDir}${path.sep}`), 'acme.zip'),
+    })));
 });

package/dist/src/packLambda.js

@@ -27,11 +27,18 @@ export const packLambda = async ({ sourceFile, zipFile, debug, progress, }) => {
     const zipfile = new yazl.ZipFile();
     const stripCommon = removeCommonAncestor(commonParent(lambdaFiles));
     const handler = stripCommon(sourceFile);
-    const folderNames = new Set(deps.map(stripCommon).map((s) => s.split('/')[0]));
-    const handlerName = path.parse(handler).name;
-    if (folderNames.has(handlerName)) {
+    // Make sure that the handler does not import from a folder with the same name in the folder
+    const handlerInfo = path.parse(handler);
+    const handlerName = handlerInfo.name;
+    const handlerDir = handlerInfo.dir;
+    const handlerDepsFromSameDirectory = deps
+        .map(stripCommon)
+        .filter((d) => handlerDir === '' ? true : d.startsWith(`${handlerDir}${path.sep}`));
+    const handlerDepsFolderNames = new Set(handlerDepsFromSameDirectory.map((s) => s.split('/')[0]));
+    if (handlerDepsFolderNames.has(handlerName)) {
         throw new ImportFromFolderNameError(handlerName);
     }
+    // Compile files
     for (const file of lambdaFiles) {
         const compiled = (await swc.transformFile(file, {
             jsc: {

package/dist/src/test-data/module-folder-named-like-handler-bug/different-level/lambda/acme.js

@@ -0,0 +1,2 @@
+import { hello } from '../acme/lib.js';
+export const handler = () => hello();

package/dist/src/test-data/module-folder-named-like-handler-bug/same-level/acme/lib.d.ts

@@ -0,0 +1 @@
+export declare const hello: () => string;

package/dist/src/test-data/module-folder-named-like-handler-bug/same-level/acme/lib.js

@@ -0,0 +1 @@
+export const hello = () => 'Hello World!';

package/dist/src/test-data/module-folder-named-like-handler-bug/same-level/acme.d.ts

@@ -0,0 +1 @@
+export declare const handler: () => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bifravst/aws-cdk-lambda-helpers",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Helper functions which simplify working with TypeScript lambdas for AWS CDK.",
   "exports": {
     ".": {