feat: add `aws-lambda-edge` preset with CDK by WinterYukky · Pull Request #240 · nitrojs/nitro

WinterYukky · 2022-05-15T08:18:18Z

🔗 Linked issue

aws lambda-edge #79

❓ Type of change

📖 Documentation (updates to the documentation or readme)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality like performance)
✨ New feature (a non-breaking change that adds functionality)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Add AWS Lambda@Edge to the preset.

The current aws-lambda preset is not compatible with the Lambda@Edge format and requires users to create their own wrapper for Lambda@Edge. This PR is needed to resolve this issue.
It would also be very powerful if Lambda@Edge were available in Nitro. It will be quite important for projects that require SSR (e.g Nuxt3) as static assets (.output/public) can be retrieved from AWS S3 and the rest (.output/server) can be resolved by Lambda@Edge.

Resolves #79

📝 Checklist

I have linked an issue or discussion.
I have updated the documentation accordingly.

mirumirumi · 2022-06-11T07:57:52Z

I support this PR :)

(@WinterYukky You might consider a review request?)

WinterYukky · 2022-06-11T14:40:57Z

@mirumirumi Thanks your comment!

Also, thank you @danielroe and @pi0 for reviewing🥰

pi0 · 2022-06-23T21:19:29Z

docs/deploy/providers/aws.md

+The following code is an example of deploying a Nuxt3 project to CloudFront and Lambda@Edge with [AWS CDK](https://github.com/aws/aws-cdk). Using this stack, paths under `_nuxt/` (static assets) will get their data from the S3 origin, and all other paths will be resolved by Lambda@Edge.
+
+```ts
+import { spawnSync } from "child_process";


I think we can auto generate this script to the .output. avoiding to hardcode things like public path to the example.

You mean the app build part? I'd like that. Maybe the output could be an object containing the key locations and configs that can be used for cloud specific deployments (for example configuring the S3 bucket and cloudfront caching):

{ "serverHandler": ".output/server", "assets": ".output/assets" "public": ".output/public" }

Thanks for the review.
This script is not a simple script, it is IaC, so it may be difficult to put it in the .output from a DX perspective.
I think a developer wants more freedom to customize it.

Is the key here that the developer needs to be aware of the public and server paths?

Surely developers can always override to customize. We can export smaller utils even for better flexibility.

Is the key here that the developer needs to be aware of the public and server paths?

Yes. Such things shouldn't be hardcoded into the repository code or docs but auto-generated even considering customization needs.

I've been considering various use cases and interfaces for the past week, but I think I've been overthinking things a bit.
As @chris-visser mentioned, it might be better to just include the serverDir and publicDir in nitro.json.
What do you think of that idea, @pi0?

On the other hand. These settings are easily extracted from the nuxt.config.ts since they are either Nuxt's defaults or set in that config. So maybe its not even needed.

Yes I can agree your thinking @chris-visser. However to find configuration like nuxt.config.ts or nitro.config.ts and more... is a bit difficult for CDK apps.
Also maybe understood @pi0's thinking. His goal would be a Zero-Config Providers. Certainly that is one of the important features so I will try implemantation for auto generate this script to the .output.

pi0 · 2022-06-23T21:21:50Z

Hi @WinterYukky Thanks for your works on this pull request and sorry review took long.

I will have to try the deployment and probably pushing some improvements to automate as much as possible for sdk use. (Hense self assigned).

WinterYukky · 2022-07-09T13:29:40Z

Hi @pi0.
I updated to automatically generate CDK code to the .output. Can you please re-review it?

ennioVisco · 2023-06-26T09:55:35Z

@danielroe @pi0 I've noticed that there's 2 PR open for aws-lamba-edge

feat: add aws-lambda-edge preset #240

feat(preset): Aws lambda edge #1075

Which one should get merged ?

the other one is newer, although it seems very similar to this one, while this one also has CDK and github action setup, which is very interesting!

jdevdevdev · 2023-06-26T16:25:28Z

Users deploying through IaC (SST/Terraform/Pulumi/Cloudformation) other than CDK and would find Cloudfront wrapper useful. It would require decoupling it from the CDK deployment.

Possible solutions could be to:

Alter this pr to make CDK deployment optional and keep the Cloudfront handler wrapper.
Create two presets (possibly extend one off the other):

aws-lambda-edge
aws-lambda-edge-cdk

Hebilicious

Amazing work @WinterYukky
The documentation added here is incredible, and will be extremely useful for cdk support #1387

@pi0 I believe a good course of action here would be to merge
#1075 over this PR, and use this one as the base for CDK support both in lambda and lambda-edge

Hebilicious · 2023-07-03T18:12:18Z

src/runtime/entries/aws-lambda-edge.ts

+    headers: normalizeIncomingHeaders(request.headers),
+    method: request.method,
+    query: request.querystring,
+    body: request.body,


body should be normalized

I added normalizing process.
https://github.com/unjs/nitro/pull/240/files#diff-5fa960f11af36c2206bfabf27bfef0d7cde8708f59d37df8855d12e5953f93a7R37-R44

Hebilicious · 2023-07-03T18:12:27Z

test/presets/aws-lambda-edge.test.ts

+        ]
+      }
+      const res: CloudFrontResultResponse = await handler(event)
+      // responsed CloudFrontHeaders are special, so modify them for testing.


Hebilicious · 2023-07-03T18:13:29Z

src/presets/aws-lambda-edge.ts

+
+export const awsLambdaEdge = defineNitroPreset({
+  entry: "#internal/nitro/entries/aws-lambda-edge",
+  externals: true,


this can't be a boolean

It was unnecessary property so remove it.

Hebilicious · 2023-07-03T18:14:51Z

src/presets/aws-lambda-edge.ts

+  await writeFile(
+    resolve(cdkDir, "cdk.json"),
+    JSON.stringify({
+      app: "npx ts-node --prefer-ts-exts bin/nitro-lambda-edge.ts",


could use jiti instead of ts-node here

I didn't know jiti before I had recieve this comment! Thank you!!

Hebilicious · 2023-07-03T18:16:05Z

src/presets/aws-lambda-edge.ts

+      this,
+      "EdgeFunction",
+      {
+        runtime: lambda.Runtime.NODEJS_16_X,


should use NODEJS_18_X

WinterYukky · 2023-07-04T11:36:35Z

Thanks for your reviewing @Hebilicious.
I'm busy this week, so I'll fix this PR next week in line with your comments 😉.

…/add-aws-lambda-edge-preset

WinterYukky · 2023-11-04T14:18:19Z

@Hebilicious Thanks your reviewing!!
I fixed lined by your comment. However I'm not understand your strategy about to merge two PRs. Should I merge to this PR from #1075?

WinterYukky added 2 commits May 14, 2022 16:40

feat: add aws-lambda-edge preset

bce1771

docs(aws-lambda-edge): add documentation

c87fde6

vercel bot deployed to Preview May 15, 2022 08:18 View deployment

docs(aws-lambda-edge): fix broken alert

69049af

vercel bot deployed to Preview May 15, 2022 08:24 View deployment

danielroe requested a review from pi0 June 11, 2022 08:08

pi0 reviewed Jun 23, 2022

View reviewed changes

pi0 self-assigned this Jun 23, 2022

feat(prest): add deployment code generater

81759fc

vercel bot deployed to Preview July 7, 2022 14:29 View deployment

WinterYukky added 2 commits July 7, 2022 16:16

fix(preset): fix empty public dir

7e5deb1

docs(preset): update to Zero Config Provider

12b179a

vercel bot deployed to Preview July 7, 2022 16:18 View deployment

WinterYukky added 2 commits July 7, 2022 17:23

docs(preset): do not use REGION env

8dd657a

fix(preset): add @types/node

a7a7af1

vercel bot deployed to Preview July 7, 2022 17:24 View deployment

docs(preset): add aws to Zero-Config Providers

d0264ab

vercel bot deployed to Preview July 7, 2022 17:40 View deployment

docs(preset): fix message title

6024e2e

vercel bot deployed to Preview July 7, 2022 17:43 View deployment

feat(preset): nitro-asset to npm package

97a89fe

vercel bot deployed to Preview July 9, 2022 05:14 View deployment

docs(preset): update customization example

f174d66

vercel bot deployed to Preview July 9, 2022 09:01 View deployment

docs(preset): update deploy page composition

ab707c9

vercel bot deployed to Preview July 9, 2022 13:16 View deployment

jdevdevdev mentioned this pull request Jun 18, 2023

Nuxt 3 SSR Constuct - or Generic SSR Construct as base? anomalyco/sst#2314

Closed

Hebilicious added the preset:aws-lambda-edge label Jun 30, 2023

Hebilicious self-assigned this Jul 1, 2023

Hebilicious self-requested a review July 1, 2023 07:15

Hebilicious changed the title ~~feat: add aws-lambda-edge preset~~ feat: add aws-lambda-edge preset with CDK Jul 1, 2023

Hebilicious mentioned this pull request Jul 3, 2023

aws lambda-edge #79

Closed

Hebilicious reviewed Jul 3, 2023

View reviewed changes

Hebilicious added the pending label Jul 3, 2023

Hebilicious mentioned this pull request Jul 5, 2023

aws lambda nitrojs/nitro-deploys#47

Closed

1 task

Hebilicious mentioned this pull request Aug 9, 2023

feat: add edge support to aws-lambda presets #1557

Closed

8 tasks

WinterYukky and others added 10 commits November 4, 2023 04:19

doc: fix test comment

35139d6

build: bump to NODEJS_18_X

4fae105

fix: remove externals property

f93e91c

fix: unnormalized body

cf7e69f

feat: support dynamic path resolve

7b387af

build: use jiti

84555a2

Merge branch 'main' of https://github.com/WinterYukky/nitro into feat…

52cf689

…/add-aws-lambda-edge-preset

chore: apply automated fixes

9ea6ed7

test: fix to pass the new tests

144d35a

doc: add AWS Lambda@Edge

08a5111

AlbertSabate pushed a commit to AlbertSabate/nitro that referenced this pull request Dec 23, 2023

Trying with code from PR nitrojs#240

c559789

pi0 marked this pull request as draft February 27, 2024 17:14

ennioVisco mentioned this pull request Mar 9, 2024

SST-Ion zero-config provider #2236

Closed

pi0 mentioned this pull request Jan 7, 2025

Preset support tracker #2973

Open

pi0 deleted the branch nitrojs:main March 18, 2025 12:36

pi0 closed this Mar 18, 2025

Uh oh!

Conversation

WinterYukky commented May 15, 2022

🔗 Linked issue

❓ Type of change

📚 Description

📝 Checklist

Uh oh!

mirumirumi commented Jun 11, 2022

Uh oh!

WinterYukky commented Jun 11, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pi0 Jun 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pi0 commented Jun 23, 2022

Uh oh!

WinterYukky commented Jul 9, 2022

Uh oh!

ennioVisco commented Jun 26, 2023

Uh oh!

jdevdevdev commented Jun 26, 2023

Uh oh!

Hebilicious left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WinterYukky Nov 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WinterYukky commented Jul 4, 2023

Uh oh!

WinterYukky commented Nov 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

pi0 Jun 27, 2022 •

edited

Loading

Hebilicious left a comment •

edited

Loading

WinterYukky Nov 4, 2023 •

edited

Loading