Added support for AWS Lambda response streaming

lukeshay · Oct 10, 2023 · 942d062 · 942d062
1 parent a96a6c4
commit 942d062
Show file tree

Hide file tree

Showing 33 changed files with 1,302 additions and 1,127 deletions.
diff --git a/.changeset/cool-plants-behave.md b/.changeset/cool-plants-behave.md
@@ -0,0 +1,6 @@
+---
+"@astro-aws/constructs": minor
+"@astro-aws/adapter": minor
+---
+
+Added support for AWS Lambda response streaming
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,11 +1,11 @@
 {
-	"cSpell.words": ["astro"],
+	"cSpell.words": ["astro", "awslambda", "streamify"],
 	"files.associations": {
 		"*.mdx": "markdown"
 	},
 	"search.exclude": {
-		"**/.yarn": true,
-		"**/.pnp.*": true
+		"**/.pnp.*": true,
+		"**/.yarn": true
 	},
 	"typescript.enablePromptUseWorkspaceTsdk": true,
 	"typescript.tsdk": "node_modules/typescript/lib"

diff --git a/apps/docs/package.json b/apps/docs/package.json
@@ -31,7 +31,7 @@
 	},
 	"dependencies": {
 		"@astrojs/starlight": "^0.11.0",
-		"astro": "^3.2.3",
+		"astro": "^3.2.4",
 		"sharp": "^0.32.6"
 	},
 	"devDependencies": {

diff --git a/apps/docs/src/content/docs/guides/01-getting-started.md b/apps/docs/src/content/docs/guides/01-getting-started.md
@@ -87,7 +87,6 @@ export class HelloCdkStack extends Stack {
 		super(scope, id, props)
 
 		new AstroAWSConstruct(this, "AstroAWSConstruct", {
-			output: "server",
 			websiteDir: "../my-astro-project",
 		})
 	}

diff --git a/apps/docs/src/content/docs/reference/packages/adapter.md b/apps/docs/src/content/docs/reference/packages/adapter.md
@@ -52,6 +52,102 @@ export default defineConfig({
 })
 ```
 
+### SSR Usage
+
+1. Install the package.
+
+```
+# Using NPM
+npm install -D @astro-aws/adapter
+
+# Using Yarn
+yarn add -D @astro-aws/adapter
+
+# Using PNPM
+pnpm add -D @astro-aws/adapter
+
+# Using Bun
+bun add -D @astro-aws/adapter
+```
+
+2. Add the following to your `astro.config.mjs` file.
+
+```js
+import { defineConfig } from "astro/config"
+import astroAws from "@astro-aws/adapter"
+
+export default defineConfig({
+	output: "server",
+	adapter: astroAws({
+		mode: "ssr",
+	}),
+})
+```
+
+### SSR Stream Usage
+
+1. Install the package.
+
+```
+# Using NPM
+npm install -D @astro-aws/adapter
+
+# Using Yarn
+yarn add -D @astro-aws/adapter
+
+# Using PNPM
+pnpm add -D @astro-aws/adapter
+
+# Using Bun
+bun add -D @astro-aws/adapter
+```
+
+2. Add the following to your `astro.config.mjs` file.
+
+```js
+import { defineConfig } from "astro/config"
+import astroAws from "@astro-aws/adapter"
+
+export default defineConfig({
+	output: "server",
+	adapter: astroAws({
+		mode: "ssr-stream",
+	}),
+})
+```
+
+### Edge Usage
+
+1. Install the package.
+
+```
+# Using NPM
+npm install -D @astro-aws/adapter
+
+# Using Yarn
+yarn add -D @astro-aws/adapter
+
+# Using PNPM
+pnpm add -D @astro-aws/adapter
+
+# Using Bun
+bun add -D @astro-aws/adapter
+```
+
+2. Add the following to your `astro.config.mjs` file.
+
+```js
+import { defineConfig } from "astro/config"
+import astroAws from "@astro-aws/adapter"
+
+export default defineConfig({
+	output: "server",
+	adapter: astroAws({
+		mode: "edge",
+	}),
+})
+```
+
 ## Example
 
 See [the source code of this site](https://github.com/lukeshay/astro-aws/blob/main/apps/www/astro.config.ts)

diff --git a/apps/docs/src/content/docs/reference/packages/constructs.md b/apps/docs/src/content/docs/reference/packages/constructs.md
@@ -6,7 +6,7 @@ description: "NPM package @astro-aws/constructs"
 
 Constructs for deploying your [Astro](https://astro.build/) project that is built using [@astro-aws/adapter](https://www.npmjs.com/package/@astro-aws/adapter).
 
-## SSR Usage
+## Usage
 
 1. Install this package and it's peer dependencies in your AWS CDK project.
 
@@ -38,85 +38,6 @@ export class MyAstroStack extends Stack {
 		super(scope, id, props)
 
 		new AstroAWS(this, "AstroAWS", {
-			output: "server",
-			websitePath: "..", // Replace with the path to your website code.
-		})
-	}
-}
-```
-
-## SSR Edge Usage
-
-1. Install this package and it's peer dependencies in your AWS CDK project.
-
-```sh
-# Using NPM
-npm install @astro-aws/constructs constructs aws-cdk-lib
-
-# Using Yarn
-yarn add @astro-aws/constructs constructs aws-cdk-lib
-
-# Using PNPM
-pnpm add @astro-aws/constructs constructs aws-cdk-lib
-
-# Using Bun
-bun add @astro-aws/constructs constructs aws-cdk-lib
-```
-
-2. Add the construct to your CDK stack.
-
-```ts
-import { Stack } from "aws-cdk-lib/core"
-import type { StackProps } from "aws-cdk-lib/core"
-import { AstroAWS } from "@astro-aws/constructs"
-
-export interface MyAstroStackProps extends StackProps {}
-
-export class MyAstroStack extends Stack {
-	public constructor(scope: Construct, id: string, props: MyAstroStackProps) {
-		super(scope, id, props)
-
-		new AstroAWS(this, "AstroAWS", {
-			output: "edge",
-			websitePath: "..", // Replace with the path to your website code.
-		})
-	}
-}
-```
-
-## Static Usage
-
-1. Install this package and it's peer dependencies in your AWS CDK project.
-
-```sh
-# Using NPM
-npm install @astro-aws/constructs constructs aws-cdk-lib
-
-# Using Yarn
-yarn add @astro-aws/constructs constructs aws-cdk-lib
-
-# Using PNPM
-pnpm add @astro-aws/constructs constructs aws-cdk-lib
-
-# Using Bun
-bun add @astro-aws/constructs constructs aws-cdk-lib
-```
-
-2. Add the construct to your CDK stack.
-
-```ts
-import { Stack } from "aws-cdk-lib/core"
-import type { StackProps } from "aws-cdk-lib/core"
-import { AstroAWS } from "@astro-aws/constructs"
-
-export interface MyAstroStackProps extends StackProps {}
-
-export class MyAstroStack extends Stack {
-	public constructor(scope: Construct, id: string, props: MyAstroStackProps) {
-		super(scope, id, props)
-
-		new AstroAWS(this, "AstroAWS", {
-			output: "static",
 			websitePath: "..", // Replace with the path to your website code.
 		})
 	}
@@ -144,7 +65,6 @@ export class MyAstroStack extends Stack {
 					memorySize: 1024,
 				},
 			},
-			output: "server",
 			websitePath: "..", // Replace with the path to your website code.
 		})
 

diff --git a/apps/infra/cdk.json b/apps/infra/cdk.json
@@ -1,27 +1,26 @@
 {
 	"app": "node --enable-source-maps --es-module-specifier-resolution node dist/bin/infra.js",
 	"context": {
+		"@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
+		"@aws-cdk/aws-apigateway:disableCloudWatchRole": true,
 		"@aws-cdk/aws-apigateway:usagePlanKeyOrderInsensitiveId": true,
-		"@aws-cdk/core:stackRelativeExports": true,
-		"@aws-cdk/aws-rds:lowercaseDbIdentifier": true,
-		"@aws-cdk/aws-lambda:recognizeVersionProps": true,
-		"@aws-cdk/aws-lambda:recognizeLayerVersion": true,
 		"@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": true,
-		"@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
+		"@aws-cdk/aws-codepipeline:crossAccountKeyAliasStackSafeResourceName": true,
 		"@aws-cdk/aws-ec2:uniqueImdsv2TemplateName": true,
-		"@aws-cdk/core:checkSecretUsage": true,
-		"@aws-cdk/aws-iam:minimizePolicies": true,
 		"@aws-cdk/aws-ecs:arnFormatIncludesClusterName": true,
-		"@aws-cdk/core:validateSnapshotRemovalPolicy": true,
-		"@aws-cdk/aws-codepipeline:crossAccountKeyAliasStackSafeResourceName": true,
+		"@aws-cdk/aws-iam:minimizePolicies": true,
+		"@aws-cdk/aws-lambda:recognizeLayerVersion": true,
+		"@aws-cdk/aws-lambda:recognizeVersionProps": true,
+		"@aws-cdk/aws-rds:lowercaseDbIdentifier": true,
 		"@aws-cdk/aws-s3:createDefaultLoggingPolicy": true,
 		"@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption": true,
-		"@aws-cdk/aws-apigateway:disableCloudWatchRole": true,
+		"@aws-cdk/core:checkSecretUsage": true,
 		"@aws-cdk/core:enablePartitionLiterals": true,
-		"@aws-cdk/core:target-partitions": ["aws", "aws-cn"]
+		"@aws-cdk/core:stackRelativeExports": true,
+		"@aws-cdk/core:target-partitions": ["aws", "aws-cn"],
+		"@aws-cdk/core:validateSnapshotRemovalPolicy": true
 	},
 	"watch": {
-		"include": ["**"],
 		"exclude": [
 			"README.md",
 			"cdk*.json",
@@ -32,6 +31,7 @@
 			"yarn.lock",
 			"node_modules",
 			"test"
-		]
+		],
+		"include": ["**"]
 	}
 }
diff --git a/apps/infra/src/lib/constants/environments.ts b/apps/infra/src/lib/constants/environments.ts
@@ -18,6 +18,7 @@ const Environments = {
 	PERSONAL: "PERSONAL",
 	PROD: "PROD",
 	SSR: "SSR",
+	STREAM: "STREAM",
 } as const
 
 type Environment = (typeof Environments)[keyof typeof Environments]
@@ -33,7 +34,7 @@ const ENVIRONMENT_PROPS: Record<Environment, AstroAWSStackProps> = {
 	[Environments.EDGE]: {
 		...base,
 		alias: "edge.dev",
-		edge: true,
+		distDir: "dist/edge",
 		env: {
 			...base.env,
 			region: "us-east-1",
@@ -56,10 +57,19 @@ const ENVIRONMENT_PROPS: Record<Environment, AstroAWSStackProps> = {
 	[Environments.SSR]: {
 		...base,
 		alias: "ssr.dev",
+		distDir: "dist/ssr",
 		environment: Environments.SSR,
 		hostedZoneName: "astro-aws.org",
 		package: "@astro-aws/examples-base",
 	},
+	[Environments.STREAM]: {
+		...base,
+		alias: "stream.dev",
+		distDir: "dist/ssr-stream",
+		environment: Environments.STREAM,
+		hostedZoneName: "astro-aws.org",
+		package: "@astro-aws/examples-base",
+	},
 } as const
 
 export { Environments, ENVIRONMENT_PROPS, type Environment }