Improve API Gateway v1 streaming (#6573)

Author: vimtor

examples/aws-apigv1-stream/index.ts

@@ -1,13 +1,17 @@
 export const handler = awslambda.streamifyResponse(
-  async (_event: unknown, responseStream: any) => {
-    responseStream = awslambda.HttpResponseStream.from(responseStream, {
+  async (event, stream) => {
+    stream = awslambda.HttpResponseStream.from(stream, {
       statusCode: 200,
-      headers: { "Content-Type": "text/plain" },
+      headers: {
+        "Content-Type": "text/plain; charset=UTF-8",
+        "X-Content-Type-Options": "nosniff",
+      },
     });
 
-    responseStream.write("Hello");
+    stream.write("Hello ");
     await new Promise((resolve) => setTimeout(resolve, 3000));
-    responseStream.write(" World");
-    responseStream.end();
+    stream.write("World");
+
+    stream.end();
   },
 );

examples/aws-apigv1-stream/package.json

@@ -2,6 +2,7 @@
   "name": "aws-apigv1-stream",
   "version": "1.0.0",
   "dependencies": {
+    "@types/aws-lambda": "^8.10.161",
     "hono": "^4",
     "sst": "^4"
   }

examples/aws-apigv1-stream/sst.config.ts

@@ -6,7 +6,8 @@
  * An example on how to enable streaming for API Gateway REST API routes.
  *
  * ```ts title="sst.config.ts"
- * api.route("GET /", "index.handler", {
+ * api.route("GET /", {
+ *   handler: "index.handler",
  *   streaming: true,
  * });
  * ```
@@ -16,30 +17,24 @@
  *
  * ```ts title="index.ts"
  * export const handler = awslambda.streamifyResponse(
- *   async (_event: unknown, responseStream: any) => {
- *     responseStream = awslambda.HttpResponseStream.from(responseStream, {
+ *   async (event, stream) => {
+ *     stream = awslambda.HttpResponseStream.from(stream, {
  *       statusCode: 200,
- *       headers: { "Content-Type": "text/plain" },
+ *       headers: {
+ *         "Content-Type": "text/plain; charset=UTF-8",
+ *         "X-Content-Type-Options": "nosniff",
+ *       },
  *     });
  *
- *     responseStream.write("Hello");
+ *     stream.write("Hello ");
  *     await new Promise((resolve) => setTimeout(resolve, 3000));
- *     responseStream.write(" World");
- *     responseStream.end();
+ *     stream.write("World");
+ *
+ *     stream.end();
  *   },
  * );
  * ```
  *
- * :::note
- * Streaming is currently not supported in `sst dev`.
- * :::
- *
- * To test this in your terminal, use the `curl` command with the `--no-buffer` option.
- *
- * ```bash "--no-buffer"
- * curl --no-buffer https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/prod
- * ```
- *
  */
 export default $config({
   app(input) {
@@ -51,10 +46,12 @@ export default $config({
   },
   async run() {
     const api = new sst.aws.ApiGatewayV1("MyApi");
-    api.route("GET /", "index.handler", {
+    api.route("GET /", {
+      handler: "index.handler",
       streaming: true,
     });
-    api.route("GET /hono", "hono.handler", {
+    api.route("GET /hono", {
+      handler: "hono.handler",
       streaming: true,
     });
     api.deploy();

examples/aws-lambda-stream/index.ts

@@ -1,18 +1,17 @@
-import { APIGatewayProxyEventV2 } from "aws-lambda";
+export const handler = awslambda.streamifyResponse(
+  async (event, stream) => {
+    stream = awslambda.HttpResponseStream.from(stream, {
+      statusCode: 200,
+      headers: {
+        "Content-Type": "text/plain; charset=UTF-8",
+        "X-Content-Type-Options": "nosniff",
+      },
+    });
 
-export const handler = awslambda.streamifyResponse(myHandler);
+    stream.write("Hello ");
+    await new Promise((resolve) => setTimeout(resolve, 3000));
+    stream.write("World");
 
-async function myHandler(
-  _event: APIGatewayProxyEventV2,
-  responseStream: awslambda.HttpResponseStream
-): Promise<void> {
-  return new Promise((resolve, _reject) => {
-    responseStream.setContentType('text/plain')
-    responseStream.write('Hello')
-    setTimeout(() => {
-      responseStream.write(' World')
-      responseStream.end()
-      resolve()
-    }, 3000)
-  })
-}
+    stream.end();
+  },
+);

examples/aws-lambda-stream/sst.config.ts

@@ -17,34 +17,25 @@
  * `@types/aws-lambda` will augment the global namespace.
  *
  * ```ts title="index.ts"
- * import { APIGatewayProxyEventV2 } from "aws-lambda";
- *
- * export const handler = awslambda.streamifyResponse(myHandler);
- *
- * async function myHandler(
- *   _event: APIGatewayProxyEventV2,
- *   responseStream: awslambda.HttpResponseStream
- * ): Promise<void> {
- *   return new Promise((resolve, _reject) => {
- *     responseStream.setContentType('text/plain')
- *     responseStream.write('Hello')
- *     setTimeout(() => {
- *       responseStream.write(' World')
- *       responseStream.end()
- *       resolve()
- *     }, 3000)
- *   })
- * }
+ * export const handler = awslambda.streamifyResponse(
+ *   async (event, stream) => {
+ *     stream = awslambda.HttpResponseStream.from(stream, {
+ *       statusCode: 200,
+ *       headers: {
+ *         "Content-Type": "text/plain; charset=UTF-8",
+ *         "X-Content-Type-Options": "nosniff",
+ *       },
+ *     });
+ *
+ *     stream.write("Hello ");
+ *     await new Promise((resolve) => setTimeout(resolve, 3000));
+ *     stream.write("World");
+ *
+ *     stream.end();
+ *   },
+ * );
  * ```
  *
- * To test this in your terminal, use the `curl` command with the `--no-buffer` option.
- *
- * ```bash "--no-buffer"
- * curl --no-buffer https://u3dyblk457ghskwbmzrbylpxoi0ayrbb.lambda-url.us-east-1.on.aws
- * ```
- *
- * Streaming is also supported through API Gateway REST API.
- *
  */
 export default $config({
   app(input) {

platform/src/components/aws/apigatewayv1-lambda-route.ts

@@ -48,6 +48,14 @@ export class ApiGatewayV1LambdaRoute extends Component {
 
     const self = this;
     const api = output(args.api);
+    const fnStreaming = output(args.handler).apply((handler) =>
+      handler && typeof handler === "object" && "streaming" in handler
+        ? handler.streaming
+        : undefined,
+    );
+    const streaming = all([output(args.streaming), fnStreaming]).apply(
+      ([routeStreaming, fnStreaming]) => routeStreaming ?? fnStreaming ?? false,
+    );
 
     const method = createMethod(name, args, self);
     const fn = createFunction();
@@ -67,7 +75,7 @@ export class ApiGatewayV1LambdaRoute extends Component {
         args.handler,
         {
           description: interpolate`${api.name} route ${method} ${path}`,
-          streaming: args.streaming,
+          streaming,
         },
         args.handlerTransform,
         { parent: self },
@@ -89,7 +97,6 @@ export class ApiGatewayV1LambdaRoute extends Component {
     }
 
     function createIntegration() {
-      const streaming = output(args.streaming ?? false);
       return new apigateway.Integration(
         ...transform(
           args.transform?.integration,

platform/src/components/aws/apigatewayv1.ts

@@ -620,20 +620,7 @@ export interface ApiGatewayV1RouteArgs {
    */
   apiKey?: Input<boolean>;
   /**
-   * Enable streaming for the route. The route handler must use `awslambda.streamifyResponse`
-   * to stream responses.
-   *
-   * :::note
-   * Streaming is only supported for API Gateway REST APIs, not HTTP APIs.
-   * :::
-   *
-   * @default `false`
-   * @example
-   * ```js
-   * {
-   *   streaming: true
-   * }
-   * ```
+   * @deprecated Set `streaming: true` on the function definition passed to `api.route()` instead.
    */
   streaming?: Input<boolean>;
   /**