Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404// Copyright 2018-2021 the oak authors. All rights reserved. MIT license.
// deno-lint-ignore-file
import { assert, assertEquals, BufWriter, StringWriter } from "./test_deps.ts";
import type { Application } from "./application.ts";import { Context } from "./context.ts";import { NativeRequest } from "./http_server_native.ts";import type { ServerRequest } from "./http_server_std.ts";import { ServerSentEvent, SSEStdLibTarget, SSEStreamTarget,} from "./server_sent_event.ts";
const { test } = Deno;
const preamble = `HTTP/1.1 200 OKcache-control: no-cacheconnection: Keep-Alivecontent-type: text/event-streamkeep-alive: timeout=9007199254740991
`;
const env = { appTarget: new EventTarget(), appErrorEvents: [] as ErrorEvent[], outWriter: new StringWriter(), connCloseCalled: false, response: undefined as (Response | undefined),};
function createMockApp(): Application { env.appTarget = new EventTarget(); env.appErrorEvents = []; env.appTarget.addEventListener( "error", (evt) => { env.appErrorEvents.push(evt as ErrorEvent); }, ); return env.appTarget as any;}
function createMockServerRequest(): ServerRequest { env.outWriter = new StringWriter(); env.connCloseCalled = false; return { conn: { close() { env.connCloseCalled = true; }, }, w: new BufWriter(env.outWriter), } as any;}
function createMockNativeRequest(): NativeRequest { env.response = undefined; return new NativeRequest({ request: new Request("http://localhost:8000/"), async respondWith(p: Response | Promise<Response>) { env.response = await p; }, }, {} as any);}
test({ name: "ServerSentEvent - construction", fn() { const evt = new ServerSentEvent("message", "foobar"); assertEquals(evt.type, "message"); assertEquals(evt.data, "foobar"); assertEquals(evt.id, undefined); assertEquals(String(evt), `event: message\ndata: foobar\n\n`); },});
test({ name: "ServerSentEvent - data coercion", fn() { const evt = new ServerSentEvent("ping", { hello: true }); assertEquals(evt.type, "ping"); assertEquals(evt.data, `{"hello":true}`); assertEquals(evt.id, undefined); assertEquals(String(evt), `event: ping\ndata: {"hello":true}\n\n`); },});
test({ name: "ServerSentEvent - init id", fn() { const evt = new ServerSentEvent("ping", "foobar", { id: 1234 }); assertEquals(evt.type, "ping"); assertEquals(evt.data, `foobar`); assertEquals(evt.id, 1234); assertEquals( String(evt), `event: ping\nid: 1234\ndata: foobar\n\n`, ); },});
test({ name: "ServerSentEvent - data space", fn() { const evt = new ServerSentEvent("ping", { hello: [1, 2, 3] }, { space: 2 }); assertEquals(evt.type, "ping"); assertEquals(evt.data, `{\n "hello": [\n 1,\n 2,\n 3\n ]\n}`); assertEquals( String(evt), `event: ping\ndata: {\ndata: "hello": [\ndata: 1,\ndata: 2,\ndata: 3\ndata: ]\ndata: }\n\n`, ); },});
test({ name: "ServerSentEvent - __message", fn() { const evt = new ServerSentEvent("__message", { hello: "world" }); assertEquals(evt.type, "__message"); assertEquals(evt.data, `{"hello":"world"}`); assertEquals(String(evt), `data: {"hello":"world"}\n\n`); },});
test({ name: "SSEStdLibTarget - construction", async fn() { const context = new Context(createMockApp(), createMockServerRequest()); const sse = new SSEStdLibTarget(context); assertEquals(sse.closed, false); await sse.close(); assert(env.connCloseCalled); assertEquals(sse.closed, true); const actual = String(env.outWriter); assertEquals(actual, preamble); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStdLibTarget - construction with headers", async fn() { const expected = `HTTP/1.1 200 OK\ncache-control: special\nconnection: Keep-Alive\ncontent-type: text/event-stream\nkeep-alive: timeout=9007199254740991\nx-oak: test\n\n`; const context = new Context(createMockApp(), createMockServerRequest()); const sse = new SSEStdLibTarget( context, { headers: new Headers([["X-Oak", "test"], ["Cache-Control", "special"]]), }, ); await sse.close(); const actual = String(env.outWriter); assertEquals(actual, expected); },});
test({ name: "SSEStdLibTarget - dispatchEvent", async fn() { const context = new Context(createMockApp(), createMockServerRequest()); const sse = new SSEStdLibTarget(context); const evt = new ServerSentEvent("message", "foobar"); sse.dispatchEvent(evt); await sse.close(); assert(env.connCloseCalled); const actual = env.outWriter.toString(); assert(actual.endsWith(`\n\nevent: message\ndata: foobar\n\n`)); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStdLibTarget - dispatchMessage", async fn() { const context = new Context(createMockApp(), createMockServerRequest()); const sse = new SSEStdLibTarget(context); sse.dispatchMessage("foobar"); await sse.close(); assert(env.connCloseCalled); const actual = env.outWriter.toString(); assert(actual.endsWith(`\n\ndata: foobar\n\n`)); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStdLibTarget - dispatchComment", async fn() { const context = new Context(createMockApp(), createMockServerRequest()); const sse = new SSEStdLibTarget(context); sse.dispatchComment("foobar"); await sse.close(); assert(env.connCloseCalled); const actual = env.outWriter.toString(); assert(actual.endsWith(`\n\n: foobar\n\n`)); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStdLibTarget - keep-alive setting", async fn() { const context = new Context(createMockApp(), createMockServerRequest()); const sse = new SSEStdLibTarget(context, { keepAlive: 1000 }); const p = new Promise<void>((resolve, reject) => { setTimeout(async () => { try { await sse.close(); assert(env.connCloseCalled); const actual = env.outWriter.toString(); assert(actual.endsWith(`\n\n: keep-alive comment\n\n`)); assertEquals(env.appErrorEvents.length, 0); resolve(); } catch (e) { reject(e); } }, 1250); }); return p; },});
test({ name: "SSEStdLibTarget - synchronous dispatch", async fn() { const context = new Context(createMockApp(), createMockServerRequest()); const sse = new SSEStdLibTarget(context); sse.dispatchComment("1"); sse.dispatchComment("2"); sse.dispatchComment("3"); sse.dispatchComment("4"); await sse.close(); assert(env.connCloseCalled); const actual = env.outWriter.toString(); assert(actual.endsWith(`\n\n: 1\n\n: 2\n\n: 3\n\n: 4\n\n`)); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStreamTarget - construction", async fn() { const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); const sse = new SSEStreamTarget(context); assertEquals(sse.closed, false); await request.respond(await context.response.toDomResponse()); await sse.close(); assert(env.response); assert(env.response.body); const reader = env.response.body.getReader(); await reader.closed; assertEquals(env.response.status, 200); assertEquals(env.response.headers.get("content-type"), "text/event-stream"); assertEquals(env.response.headers.get("connection"), "Keep-Alive"); assertEquals( env.response.headers.get("keep-alive"), "timeout=9007199254740991", ); },});
test({ name: "SSEStreamTarget - construction with headers", async fn() { const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); const sse = new SSEStreamTarget( context, { headers: new Headers([["X-Oak", "test"], ["Cache-Control", "special"]]), }, ); await request.respond(await context.response.toDomResponse()); await sse.close(); assert(env.response); assertEquals(env.response.headers.get("content-type"), "text/event-stream"); assertEquals(env.response.headers.get("connection"), "Keep-Alive"); assertEquals(env.response.headers.get("x-oak"), "test"); assertEquals(env.response.headers.get("cache-control"), "no-cache"); },});
test({ name: "SSEStreamTarget - dispatchEvent", async fn() { const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); const sse = new SSEStreamTarget(context); await request.respond(await context.response.toDomResponse()); const evt = new ServerSentEvent("message", "foobar"); sse.dispatchEvent(evt); await sse.close(); assert(env.response); assertEquals(await env.response.text(), "event: message\ndata: foobar\n\n"); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStreamTarget - dispatchMessage", async fn() { const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); const sse = new SSEStreamTarget(context); await request.respond(await context.response.toDomResponse()); sse.dispatchMessage("foobar"); await sse.close(); assert(env.response); assertEquals(await env.response.text(), "data: foobar\n\n"); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStreamTarget - dispatchComment", async fn() { const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); const sse = new SSEStreamTarget(context); await request.respond(await context.response.toDomResponse()); sse.dispatchComment("foobar"); await sse.close(); assert(env.response); assertEquals(await env.response.text(), ": foobar\n\n"); assertEquals(env.appErrorEvents.length, 0); },});
test({ name: "SSEStreamTarget - keep-alive setting", async fn() { const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); const sse = new SSEStreamTarget(context, { keepAlive: 1000 }); await request.respond(await context.response.toDomResponse()); const p = new Promise<void>((resolve, reject) => { setTimeout(async () => { try { await sse.close(); assert(env.response); assertEquals(await env.response.text(), ": keep-alive comment\n\n"); assertEquals(env.appErrorEvents.length, 0); resolve(); } catch (e) { reject(e); } }, 1250); }); return p; },});
test({ name: "SSEStreamTarget - connection closed readable stream", async fn() { let closed = false; let errored = false; const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); const sse = new SSEStreamTarget(context); sse.addEventListener("close", () => { closed = true; }); sse.addEventListener("error", () => { errored = true; }); assert(context.response.body instanceof ReadableStream); context.response.body.cancel( new Error("connection closed before message completed"), ); assert(closed); assert(!errored); },});
test({ name: "SSEStdLibTarget - inspecting", fn() { const context = new Context(createMockApp(), createMockServerRequest()); assertEquals( Deno.inspect(new SSEStdLibTarget(context)), `SSEStdLibTarget { closed: false }`, ); },});
test({ name: "SSEStreamTarget - inspecting", fn() { const request = createMockNativeRequest(); const context = new Context(createMockApp(), request); assertEquals( Deno.inspect(new SSEStreamTarget(context)), `SSEStreamTarget {\n "#closed": false,\n "#context": Context {\n app: EventTarget {},\n cookies: Cookies [],\n isUpgradable: false,\n respond: true,\n request: Request {\n hasBody: false,\n headers: Headers {},\n ip: "",\n ips: [],\n method: "GET",\n secure: false,\n url: "http://localhost:8000/"\n},\n response: Response {\n body: ReadableStream { locked: false },\n headers: Headers {\n "cache-control": "no-cache",\n connection: "Keep-Alive",\n "content-type": "text/event-stream",\n "keep-alive": "timeout=9007199254740991"\n},\n status: 200,\n type: undefined,\n writable: true\n},\n socket: undefined,\n state: undefined\n}\n}`, ); },});