@bifravst/aws-cdk-lambda-helpers 1.2.4 → 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.4",
+  "version": "1.2.6",
   "description": "Helper functions which simplify working with TypeScript lambdas for AWS CDK.",
   "exports": {
     ".": {
@@ -105,7 +105,7 @@
   },
   "files": [
     "package-lock.json",
-    "dist",
+    "dist/src",
     "LICENSE",
     "README.md"
   ],

package/dist/cdk/TestApp.d.ts

@@ -1,5 +0,0 @@
-import { App } from 'aws-cdk-lib';
-import { TestStack } from './TestStack.js';
-export declare class TestApp extends App {
-    constructor(id: string, args: ConstructorParameters<typeof TestStack>[2]);
-}

package/dist/cdk/TestApp.js

@@ -1,12 +0,0 @@
-import { App } from 'aws-cdk-lib';
-import { TestStack } from './TestStack.js';
-export class TestApp extends App {
-    constructor(id, args) {
-        super({
-            context: {
-                isTest: true,
-            },
-        });
-        new TestStack(this, id, args);
-    }
-}

package/dist/cdk/TestStack.d.ts

@@ -1,12 +0,0 @@
-import { App, Stack } from 'aws-cdk-lib';
-import type { PackedLayer } from '../src/layer.js';
-import type { TestLambdas } from './packTestLambdas.js';
-export declare class TestStack extends Stack {
-    constructor(parent: App, id: string, { lambdaSources, layer, }: {
-        lambdaSources: TestLambdas;
-        layer: PackedLayer;
-    });
-}
-export type StackOutputs = {
-    lambdaURL: string;
-};

package/dist/cdk/TestStack.js

@@ -1,39 +0,0 @@
-import { App, CfnOutput, Duration, aws_lambda as Lambda, Stack, } from 'aws-cdk-lib';
-import { LambdaLogGroup, LambdaSource } from '../src/cdk.js';
-export class TestStack extends Stack {
-    constructor(parent, id, { lambdaSources, layer, }) {
-        super(parent, id, {});
-        const baseLayer = new Lambda.LayerVersion(this, 'baseLayer', {
-            layerVersionName: `${Stack.of(this).stackName}-baseLayer`,
-            code: new LambdaSource(this, {
-                id: 'baseLayer',
-                zipFile: layer.layerZipFile,
-                hash: layer.hash,
-            }).code,
-            compatibleArchitectures: [Lambda.Architecture.ARM_64],
-            compatibleRuntimes: [Lambda.Runtime.NODEJS_20_X],
-        });
-        const fn = new Lambda.Function(this, 'fn', {
-            handler: lambdaSources.test.handler,
-            architecture: Lambda.Architecture.ARM_64,
-            runtime: Lambda.Runtime.NODEJS_20_X,
-            timeout: Duration.seconds(1),
-            memorySize: 1792,
-            code: new LambdaSource(this, lambdaSources.test).code,
-            description: 'Returns a ULID',
-            environment: {
-                NODE_NO_WARNINGS: '1',
-            },
-            layers: [baseLayer],
-            ...new LambdaLogGroup(this, 'fnLogs'),
-        });
-        const url = fn.addFunctionUrl({
-            authType: Lambda.FunctionUrlAuthType.NONE,
-        });
-        new CfnOutput(this, 'lambdaURL', {
-            exportName: `${this.stackName}:lambdaURL`,
-            description: 'API endpoint',
-            value: url.url,
-        });
-    }
-}

package/dist/cdk/baseLayer.d.ts

@@ -1,2 +0,0 @@
-import { type PackedLayer } from '../src/layer.js';
-export declare const pack: () => Promise<PackedLayer>;

package/dist/cdk/baseLayer.js

@@ -1,5 +0,0 @@
-import { packLayer } from '../src/layer.js';
-export const pack = async () => packLayer({
-    id: 'baseLayer',
-    dependencies: ['id128'],
-});

package/dist/cdk/e2e.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cdk/e2e.js

@@ -1,11 +0,0 @@
-import { TestApp } from './TestApp.js';
-import { pack as packBaseLayer } from './baseLayer.js';
-import { packTestLambdas } from './packTestLambdas.js';
-import { fromEnv } from '@nordicsemiconductor/from-env';
-const { stackName } = fromEnv({
-    stackName: 'STACK_NAME',
-})(process.env);
-new TestApp(stackName, {
-    lambdaSources: await packTestLambdas(),
-    layer: await packBaseLayer(),
-});

package/dist/cdk/lambda.d.ts

@@ -1,2 +0,0 @@
-import type { APIGatewayProxyResultV2 } from 'aws-lambda';
-export declare const handler: () => Promise<APIGatewayProxyResultV2>;

package/dist/cdk/lambda.js

@@ -1,5 +0,0 @@
-import id128 from 'id128';
-export const handler = async () => ({
-    statusCode: 201,
-    body: id128.Ulid.generate().toCanonical(),
-});

package/dist/cdk/packTestLambdas.d.ts

@@ -1,5 +0,0 @@
-import type { PackedLambda } from '../src/packLambda.js';
-export type TestLambdas = {
-    test: PackedLambda;
-};
-export declare const packTestLambdas: () => Promise<TestLambdas>;

package/dist/cdk/packTestLambdas.js

@@ -1,4 +0,0 @@
-import { packLambdaFromPath } from '../src/packLambdaFromPath.js';
-export const packTestLambdas = async () => ({
-    test: await packLambdaFromPath('test', 'cdk/lambda.ts'),
-});

package/dist/e2e.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/e2e.spec.js

@@ -1,17 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert/strict';
-import { stackOutput } from '@nordicsemiconductor/cloudformation-helpers';
-import { CloudFormationClient } from '@aws-sdk/client-cloudformation';
-import { fromEnv } from '@nordicsemiconductor/from-env';
-void describe('end-to-end tests', () => {
-    void it('should return an ULID', async () => {
-        const { stackName } = fromEnv({
-            stackName: 'STACK_NAME',
-        })(process.env);
-        const { lambdaURL } = await stackOutput(new CloudFormationClient({}))(stackName);
-        const res = await fetch(new URL(lambdaURL));
-        assert.equal(res.ok, true);
-        assert.equal(res.status, 201);
-        assert.match(await res.text(), /^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$/);
-    });
-});

package/dist/layers/baseLayer/nodejs/node_modules/.package-lock.json

@@ -1,16 +0,0 @@
-{
-  "name": "@bifravst/aws-cdk-lambda-helpers",
-  "version": "0.0.0-development",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "node_modules/id128": {
-      "version": "1.6.6",
-      "resolved": "https://registry.npmjs.org/id128/-/id128-1.6.6.tgz",
-      "integrity": "sha512-ExSXL9qcyQ7X/AfyO4ouARLnztm7Nmry1rwGi1nbrtSM90tjjqKzeMKqJfkw5bDdDX7XqdXIRzYYkVj5PU28Hg==",
-      "engines": {
-        "node": ">=v6.9.0"
-      }
-    }
-  }
-}

package/dist/layers/baseLayer/nodejs/node_modules/id128/CHANGES

@@ -1,20 +0,0 @@
-- 0.1.0 : Move extraneous exports from index.js into utils.js.
-- 0.2.0 : Add browser support for Browserify/Webpack.
-- 0.3.0 : Pass named arguments to .generate instead of positional.
-- 1.0.0 : Added support for Uuid V1 and extracted competitive benchmarks.
-- 1.0.1 : Remove lockfile from release.
-- 1.0.2 : Fix bad version push.
-- 1.0.3 : Delete the extra benchmarks for real.
-- 1.1.0 : Performance improvements and renamed resetClockSequence to reset.
-- 1.1.1 : Fixed repo link.
-- 1.2.0 : Added generic UUID factory.
-- 1.3.0 : Added UUID V6 support.
-- 1.4.0 : Exposed encoding verifiers.
-- 1.5.0 : Fixed benchmarks and added support for node +12.5.
-- 1.6.0 : Added Typescript support and top-level id comparators.
-- 1.6.1 : Tweaked random memory allocation and updated benchmarks.
-- 1.6.2 : Fixed docs
-- 1.6.3 : Fixed memory profile by reusing the buffer of random.
-- 1.6.4 : Fixed worker support
-- 1.6.5 : Removed erroneous packaged files
-- 1.6.6 : Fix CHANGES and add credit for worker support

package/dist/layers/baseLayer/nodejs/node_modules/id128/LICENSE

@@ -1,18 +0,0 @@
-Copyright 2018 Aaron Cohen <aarondcohen@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.