Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add response streaming support for Lambda #10

Open
moltar opened this issue Feb 27, 2024 · 3 comments
Open

Add response streaming support for Lambda #10

moltar opened this issue Feb 27, 2024 · 3 comments

Comments

@moltar
Copy link

moltar commented Feb 27, 2024

Almost a year ago now, AWS introduced response streaming:

https://aws.amazon.com/blogs/compute/introducing-aws-lambda-response-streaming/

This works great with CloudFront <- Lambda URL setup, as both support response streaming.

This, however, does not work with API Gateways and ALB yet, and supposedly it is coming later.

Here's a quick PoC I made a while back for streaming pure React code from a Lambda handler. Not sure if this is comprehensive, this was just a quick PoC.

import type { APIGatewayProxyEventV2, Context } from 'aws-lambda';
import { streamifyResponse, ResponseStream } from 'lambda-stream';
import React from 'react';
import { renderToPipeableStream } from 'react-dom/server';
import { App } from './app';

export const handler = async (event: APIGatewayProxyEventV2, stream: ResponseStream, ctx: Context) => {
  stream.setContentType('text/html');

  const { pipe, abort } = renderToPipeableStream(App(event.rawPath), {
    onShellReady() {
      pipe(stream);
    },
    onAllReady() {
      stream.end();
    },
  });

  // https://react.dev/reference/react-dom/server/renderToPipeableStream#aborting-server-rendering
  setTimeout(() => abort(), ctx.getRemainingTimeInMillis() - 500);
};

streamifyResponse(handler);

Where App is:

export function App(path: string) {
  return (
      <html>
        <head>
          <title>App</title>
        </head>
        <body>
			<div>hello</div>
        </body>
      </html>
  );
}
@wingleung
Copy link
Owner

Thanks for kickstarting this 👍
There's a couple of things a developer should setup to be able to use streaming in remix 👉 https://remix.run/docs/en/main/guides/streaming

If they did that, we would probably need to (optionally) turn our sendRemixResponse into streams.
The nodeResponse.body is already a readable stream so I think we could something similar to this https://github.com/remix-run/remix/blob/dev/packages/remix-dev/config/defaults/entry.server.node.tsx#L72C11-L72C65

very interesting!

@moltar
Copy link
Author

moltar commented Mar 11, 2024

I think we could something similar

That's the default server impl btw.

@wingleung
Copy link
Owner

idd, what I'm trying to get at is how we should tackle this

Solution 1: let developer set up streaming in entry.server.ts and try and find a way to pipe the stream in our adapter
Solution 2: do streaming ourselves in sendRemixResponse and/or here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@moltar @wingleung