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

feat: ServerSentEventStream() #3751

Merged
merged 11 commits into from
Nov 8, 2023
Merged

feat: ServerSentEventStream() #3751

merged 11 commits into from
Nov 8, 2023

Conversation

iuioiua
Copy link
Collaborator

@iuioiua iuioiua commented Oct 30, 2023 •
edited
Loading

You can test this via:

import {
  type ServerSentEventMessage,
  ServerSentEventStream,
} from "./http/server_sent_event_stream.ts";

Deno.serve({ port: 8000 }, (req) => {
  if (req.url.endsWith("/")) {
    const body = `
    <!DOCTYPE html>
    <html>
      <head>
        <meta charset=&quot;utf-8&quot; />
      </head>
      <body>
        <script>
          const source = new EventSource('/sse');
          source.onmessage = function(e) {
            document.body.innerHTML += e.data + '<br>';
          };
        </script>
      </body>
    </html>
    `;
    return new Response(body, {
      headers: { "content-type": "text/html; charset=utf-8" },
    });
  }

  if (req.url.endsWith("/sse")) {
    const stream = ReadableStream.from<ServerSentEventMessage>([{
      data: "hello there",
      id: "123",
    }]).pipeThrough(new ServerSentEventStream());
    return new Response(stream, {
      headers: {
        "content-type": "text/event-stream",
        "cache-control": "no-cache",
      },
    });
  }

  return new Response("not found", { status: 404 });
});

My main concern is that the name is too wordy. However, the reason I chose it is because it's clearest and doesn't conflict with the current ServerSentEvent() in std/http.

Closes #3693

@github-actions github-actions bot added the http label Oct 30, 2023
lucacasonato
lucacasonato reviewed Oct 30, 2023
View reviewed changes
Copy link
Member

@lucacasonato lucacasonato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay

http/server_sent_event_message_stream.ts Outdated Show resolved Hide resolved
http/server_sent_event_message_stream.ts Outdated Show resolved Hide resolved
@iuioiua iuioiua changed the title feat: ServerSentEventMessageStream() feat: ServerSentEventStream() Oct 30, 2023
@iuioiua iuioiua marked this pull request as ready for review October 30, 2023 22:47
@iuioiua iuioiua requested a review from kt3k as a code owner October 30, 2023 22:47
lino-levan
lino-levan approved these changes Oct 31, 2023
View reviewed changes
Copy link
Contributor

@lino-levan lino-levan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, looks great! Nice work Asher. Two nits.

http/server_sent_event_stream.ts Outdated Show resolved Hide resolved
http/server_sent_event_stream_test.ts Outdated Show resolved Hide resolved
lino-levan
lino-levan approved these changes Nov 6, 2023
View reviewed changes
Copy link
Contributor

@lino-levan lino-levan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kt3k
Copy link
Member

kt3k commented Nov 8, 2023

How about directly encoding into Uint8Array? Do we ever need string output of SSE?

@iuioiua
Copy link
Collaborator Author

iuioiua commented Nov 8, 2023

Good idea. Done.

kt3k
kt3k approved these changes Nov 8, 2023
View reviewed changes
Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@iuioiua iuioiua merged commit 08f4dbc into main Nov 8, 2023
12 checks passed
@iuioiua iuioiua deleted the server-sent-event-message-stream branch November 8, 2023 18:07
@iuioiua iuioiua mentioned this pull request Nov 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kt3k kt3k kt3k approved these changes

@lino-levan lino-levan lino-levan approved these changes

@lucacasonato lucacasonato Awaiting requested review from lucacasonato

Assignees
No one assigned
Labels
http
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

proposal: replace ServerSentEvent() with ServerSentEventStream()
4 participants
@iuioiua @kt3k @lucacasonato @lino-levan