Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909// Copyright 2018-2022 the oak authors. All rights reserved. MIT license.
// deno-lint-ignore-file
import { assert, assertEquals, assertRejects, assertStrictEquals,} from "./test_deps.ts";
import { Application } from "./application.ts";import type { ApplicationErrorEvent, ListenOptions, ListenOptionsTls, State,} from "./application.ts";import { Context } from "./context.ts";import { Status } from "./deps.ts";import { HttpServerNative, NativeRequest } from "./http_server_native.ts";import { httpErrors } from "./httpError.ts";import { KeyStack } from "./keyStack.ts";import type { Data, Server, ServerConstructor } from "./types.d.ts";
const { test } = Deno;
let optionsStack: Array<ListenOptions | ListenOptionsTls> = [];let serverClosed = false;
function teardown() { optionsStack = []; serverClosed = false;}
function setup( ...requests: ([string?, RequestInit?])[]): [ServerConstructor<NativeRequest>, Response[]] { const responseStack: Response[] = [];
function createRequest( url = "http://localhost/index.html", requestInit?: RequestInit, ): NativeRequest { const request = new Request(url, requestInit);
return new NativeRequest({ request, async respondWith(r) { responseStack.push(await r); }, }); }
const mockRequests = requests.map((r) => createRequest(...r));
return [ class MockNativeServer<AS extends State = Record<string, any>> implements Server<NativeRequest> { constructor( _app: Application<AS>, private options: Deno.ListenOptions | Deno.ListenTlsOptions, ) { optionsStack.push(options); }
close(): void { serverClosed = true; }
listen(): Deno.Listener { return { addr: { transport: "tcp", hostname: this.options.hostname, port: this.options.port, }, } as Deno.Listener; }
async *[Symbol.asyncIterator]() { for await (const request of mockRequests) { yield request; } } }, responseStack, ];}
test({ name: "construct App()", fn() { const app = new Application(); assert(app instanceof Application); teardown(); },});
test({ name: "register middleware", async fn() { const [serverConstructor] = setup([]); const app = new Application({ serverConstructor }); let called = 0; app.use((context, next) => { assert(context instanceof Context); assertEquals(typeof next, "function"); called++; });
await app.listen(":8000"); assertEquals(called, 1); teardown(); },});
test({ name: "register middleware - accepts non void", fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); app.use((ctx) => ctx.response.body = "hello world"); teardown(); },});
test({ name: "middleware execution order 1", async fn() { const [serverConstructor] = setup([]); const app = new Application({ serverConstructor }); const callStack: number[] = []; app.use(() => { callStack.push(1); });
app.use(() => { callStack.push(2); });
await app.listen(":8000"); assertEquals(callStack, [1]); teardown(); },});
test({ name: "middleware execution order 2", async fn() { const [serverConstructor] = setup([]); const app = new Application({ serverConstructor }); const callStack: number[] = []; app.use((_context, next) => { callStack.push(1); next(); });
app.use(() => { callStack.push(2); });
await app.listen(":8000"); assertEquals(callStack, [1, 2]); teardown(); },});
test({ name: "middleware execution order 3", async fn() { const [serverConstructor] = setup([]); const app = new Application({ serverConstructor }); const callStack: number[] = []; app.use((_context, next) => { callStack.push(1); next(); callStack.push(2); });
app.use(async () => { callStack.push(3); await Promise.resolve(); callStack.push(4); });
await app.listen(":8000"); assertEquals(callStack, [1, 3, 2, 4]); teardown(); },});
test({ name: "middleware execution order 4", async fn() { const [serverConstructor] = setup([]); const app = new Application({ serverConstructor }); const callStack: number[] = []; app.use(async (_context, next) => { callStack.push(1); await next(); callStack.push(2); });
app.use(async () => { callStack.push(3); await Promise.resolve(); callStack.push(4); });
await app.listen(":8000"); assertEquals(callStack, [1, 3, 4, 2]); teardown(); },});
test({ name: "app.listen", async fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); app.use(() => {}); await app.listen("127.0.0.1:8080"); assertEquals(optionsStack, [{ hostname: "127.0.0.1", port: 8080 }]); teardown(); },});
test({ name: "app.listen native", async fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); app.use(() => {}); await app.listen("127.0.0.1:8080"); assertEquals(optionsStack, [{ hostname: "127.0.0.1", port: 8080 }]); teardown(); },});
test({ name: "app.listen IPv6 Loopback", async fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); app.use(() => {}); await app.listen("[::1]:8080"); assertEquals(optionsStack, [{ hostname: "::1", port: 8080 }]); teardown(); },});
test({ name: "app.listen(options)", async fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); app.use(() => {}); await app.listen({ port: 8000 }); assertEquals(optionsStack, [{ port: 8000 }]); teardown(); },});
test({ name: "app.listenTLS", async fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); app.use(() => {}); await app.listen({ port: 8000, secure: true, certFile: "", keyFile: "", }); assertEquals(optionsStack, [ { port: 8000, secure: true, certFile: "", keyFile: "", }, ]); teardown(); },});
test({ name: "app.state", async fn() { const [serverConstructor] = setup([]); const app = new Application<{ foo?: string }>({ state: {}, serverConstructor, }); app.state.foo = "bar"; let called = false; app.use((context) => { assertEquals(context.state, { foo: "bar" }); called = true; }); await app.listen(":8000"); assert(called); teardown(); },});
test({ name: "app - contextState - clone", async fn() { const [serverConstructor] = setup([]); const app = new Application({ contextState: "clone", state: { a() {}, b: "string", c: /c/, }, serverConstructor, }); let called = false; app.use((ctx) => { assertEquals(ctx.state, { b: "string", c: /c/ }); assert(ctx.state !== ctx.app.state); called = true; }); await app.listen({ port: 8000 }); assert(called); teardown(); },});
test({ name: "app - contextState - prototype", async fn() { const state = { a: "a", b: { c: "c" }, }; const [serverConstructor] = setup([]); const app = new Application({ contextState: "prototype", state, serverConstructor, }); let called = false; app.use<typeof state & { d: string }>((ctx) => { assert(ctx.state !== ctx.app.state); assert(Object.getPrototypeOf(ctx.state) === ctx.app.state); assertEquals(ctx.state.a, "a"); assertEquals(ctx.state.b, { c: "c" }); ctx.state.a = "f"; ctx.state.d = "d"; ctx.state.b.c = "e"; assertEquals(ctx.app.state, { a: "a", b: { c: "e" } }); called = true; }); await app.listen({ port: 8000 }); assert(called); teardown(); },});
test({ name: "app - contextState - alias", async fn() { const [serverConstructor] = setup([]); const app = new Application({ contextState: "alias", state: { a() {}, b: "string", c: /c/, }, serverConstructor, }); let called = false; app.use((ctx) => { assertStrictEquals(ctx.state, ctx.app.state); called = true; }); await app.listen({ port: 8000 }); assert(called); teardown(); },});
test({ name: "app - contextState - empty", async fn() { const [serverConstructor] = setup([]); const app = new Application({ contextState: "empty", state: { a() {}, b: "string", c: /c/, }, serverConstructor, }); let called = false; app.use((ctx) => { assert(ctx.state !== ctx.app.state); assertEquals(Object.entries(ctx.state).length, 0); ctx.state.b = "b"; assertEquals(ctx.app.state.b, "string"); called = true; }); await app.listen({ port: 8000 }); assert(called); teardown(); },});
test({ name: "app.keys undefined", fn() { const app = new Application(); assertEquals(app.keys, undefined); teardown(); },});
test({ name: "app.keys passed as array", fn() { const app = new Application({ keys: ["foo"] }); assert(app.keys instanceof KeyStack); teardown(); },});
test({ name: "app.keys passed as KeyStack-like", fn() { const keys = { sign(_data: Data) { return Promise.resolve(""); }, verify(_data: Data, _digest: string) { return Promise.resolve(true); }, indexOf(_data: Data, _digest: string) { return Promise.resolve(0); }, } as KeyStack; const app = new Application({ keys }); assert(app.keys === keys); teardown(); },});
test({ name: "app.keys set as array", fn() { const app = new Application(); app.keys = ["foo"]; assert(app.keys instanceof KeyStack); teardown(); },});
test({ name: "app.listen({ signal }) no requests in flight", async fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); const abortController = new AbortController(); app.use(() => {}); const p = app.listen({ port: 8000, signal: abortController.signal }); abortController.abort(); await p; assertEquals(serverClosed, true); teardown(); },});
test({ name: "app.listen({ signal }) requests in flight", async fn() { const [serverConstructor] = setup([], [], [], [], []); const app = new Application({ serverConstructor }); const abortController = new AbortController(); let count = 0; app.use(() => { assertEquals(serverClosed, false); count++; if (count === 2) { abortController.abort(); } }); await app.listen({ port: 8000, signal: abortController.signal }); assertEquals(count, 2); assertEquals(serverClosed, true); teardown(); },});
test({ name: "app.addEventListener()", async fn() { const [serverConstructor] = setup([]); const app = new Application({ serverConstructor, logErrors: false, }); app.addEventListener("error", (evt) => { assert(evt.error instanceof httpErrors.InternalServerError); }); app.use((ctx) => { ctx.throw(500, "oops!"); }); await app.listen({ port: 8000 }); teardown(); },});
test({ name: "uncaught errors impact response", async fn() { const [serverConstructor, responseStack] = setup([]); const app = new Application({ serverConstructor, logErrors: false, }); app.use((ctx) => { ctx.throw(404, "File Not Found"); }); await app.listen({ port: 8000 }); const [response] = responseStack; assertEquals(response.status, 404); teardown(); },});
test({ name: "uncaught errors clear headers properly", async fn() { const [serverConstructor, responseStack] = setup([]); const app = new Application({ serverConstructor, logErrors: false, }); app.use((ctx) => { ctx.response.headers.append("a", "b"); ctx.response.headers.append("b", "c"); ctx.response.headers.append("c", "d"); ctx.response.headers.append("d", "e"); ctx.response.headers.append("f", "g"); ctx.throw(500, "Internal Error"); }); await app.listen({ port: 8000 }); const [response] = responseStack; assertEquals([...response.headers], [[ "content-type", "text/plain; charset=utf-8", ]]); teardown(); },});
test({ name: "uncaught errors log by default", async fn() { const errorLogStack: any[][] = []; const originalConsoleError = Object.getOwnPropertyDescriptor( console, "error", ); assert(originalConsoleError); Object.defineProperty(console, "error", { value(...args: any[]) { errorLogStack.push(args); }, configurable: true, }); const [serverConstructor] = setup([]); const app = new Application({ serverConstructor }); app.use((ctx) => { ctx.throw(404, "File Not Found"); }); await app.listen({ port: 8000 }); Object.defineProperty(console, "error", originalConsoleError); assertEquals(errorLogStack.length, 4); assert(errorLogStack[0][0].startsWith("[uncaught application error]")); teardown(); },});
test({ name: "caught errors don't dispatch error events", async fn() { const [serverConstructor, responseStack] = setup([]); const app = new Application({ serverConstructor }); const errStack: any[] = []; app.use(async (_ctx, next) => { try { await next(); } catch (err) { errStack.push(err); } }); app.use((ctx) => { ctx.throw(404, "File Not Found"); }); const errEventStack: ApplicationErrorEvent<any, any>[] = []; app.addEventListener("error", (evt) => { errEventStack.push(evt); }); await app.listen({ port: 8000 }); const [response] = responseStack; assertEquals(response.status, 404); assertEquals(errStack.length, 1); assertEquals(errEventStack.length, 0); teardown(); },});
test({ name: "thrown errors in a catch block", async fn() { const errors: ApplicationErrorEvent<any, any>[] = []; const [serverConstructor, responseStack] = setup([]); const app = new Application({ serverConstructor, logErrors: false, });
app.addEventListener("error", (evt) => { errors.push(evt); });
app.use(async () => { try { throw new Error("catch me"); } catch { throw new Error("caught"); } });
await app.listen({ port: 8000 }); const [response] = responseStack; assertEquals(response.status, 500); assertEquals(errors.length, 1); assertEquals(errors[0].error.message, "caught"); teardown(); },});
test({ name: "errors when generating native response", async fn() { const [serverConstructor, responseStack] = setup([]); const errors: ApplicationErrorEvent<any, any>[] = []; const app = new Application({ serverConstructor, logErrors: false, });
app.addEventListener("error", (evt) => { errors.push(evt); });
app.use(async (ctx) => { ctx.response.body = { a: 4600119228n }; });
await app.listen({ port: 8000 }); const [response] = responseStack; assertEquals(response.status, 500); assertEquals(errors.length, 1); assertEquals( errors[0].error.message, "Do not know how to serialize a BigInt", ); teardown(); },});
test({ name: "app.listen() without middleware", async fn() { const [serverConstructor] = setup([]); const app = new Application({ serverConstructor }); await assertRejects(async () => { await app.listen(":8000"); }, TypeError); teardown(); },});
test({ name: "app.state type handling", fn() { const app = new Application({ state: { id: 1 } }); app.use((ctx: Context<{ session: number }>) => { ctx.state.session = 0; }).use((ctx) => { ctx.state.id = 1; ctx.state.session = 2; // @ts-expect-error ctx.state.bar = 3; ctx.app.state.id = 4; ctx.app.state.session = 5; // @ts-expect-error ctx.app.state.bar = 6; }); teardown(); },});
test({ name: "application listen event", async fn() { const [serverConstructor] = setup(); const app = new Application({ serverConstructor }); let called = 0; app.addEventListener("listen", (evt) => { called++; assertEquals(evt.hostname, "localhost"); assertEquals(evt.port, 80); assertEquals(evt.secure, false); }); app.use((ctx) => { ctx.response.body = "hello world"; }); await app.listen({ hostname: "localhost", port: 80 }); assertEquals(called, 1); teardown(); },});
test({ name: "application doesn't respond on ctx.respond === false", async fn() { const [serverConstructor, responseStack] = setup([]); const app = new Application({ serverConstructor }); app.use((ctx) => { ctx.respond = false; }); await app.listen({ port: 8000 }); assertEquals(responseStack.length, 0); teardown(); },});
test({ name: "application passes proxy", async fn() { const [serverConstructor, responseStack] = setup([ "http://localhost/index.html", { headers: { "host": "10.255.255.255", "x-forwarded-proto": "https", "x-forwarded-for": "10.10.10.10, 192.168.1.1, 10.255.255.255", "x-forwarded-host": "10.10.10.10", }, }, ]); const app = new Application({ serverConstructor, proxy: true, }); let called = false; app.use((ctx) => { called = true; assertEquals(String(ctx.request.url), "https://10.10.10.10/index.html"); }); await app.listen({ port: 8000 }); assert(called); assertEquals(responseStack.length, 1); teardown(); },});
test({ name: "application .handle()", async fn() { const app = new Application(); let called = 0; app.use((context, next) => { assert(context instanceof Context); assertEquals(typeof next, "function"); called++; }); const actual = await app.handle(new Request("http://localhost/index.html")); assertEquals(called, 1); assert(actual); assertEquals(actual.body, null); assertEquals(actual.status, Status.NotFound); assertEquals([...actual.headers], [["content-length", "0"]]); teardown(); },});
test({ name: "application .handle() native request", async fn() { const app = new Application(); let called = 0; app.use((context, next) => { assert(context instanceof Context); assertEquals(context.request.ip, "example.com"); assertEquals(typeof next, "function"); called++; }); const request = new Request("http://localhost:8080/", { method: "POST", body: `{"a":"b"}`, }); const conn = { localAddr: { transport: "tcp", hostname: "localhost", port: 8000 }, remoteAddr: { transport: "tcp", hostname: "example.com", port: 4747 }, rid: 1, } as Deno.Conn; const actual = await app.handle(request, conn); assertEquals(called, 1); assert(actual instanceof Response); assertEquals(actual.body, null); assertEquals(actual.status, Status.NotFound); assertEquals([...actual.headers], [["content-length", "0"]]); teardown(); },});
test({ name: "application .handle() omit connection", async fn() { const app = new Application(); let called = 0; app.use((context, next) => { assert(context instanceof Context); assertEquals(context.request.ip, ""); assertEquals(typeof next, "function"); called++; }); const request = new Request("http://localhost:8080/", { method: "POST", body: `{"a":"b"}`, }); const actual = await app.handle(request); assertEquals(called, 1); assert(actual instanceof Response); assertEquals(actual.body, null); assertEquals(actual.status, Status.NotFound); assertEquals([...actual.headers], [["content-length", "0"]]); teardown(); },});
test({ name: "application .handle() no response", async fn() { const app = new Application(); app.use((context) => { context.respond = false; }); const actual = await app.handle(new Request("http://localhost/index.html")); assertEquals(actual, undefined); teardown(); },});
test({ name: "application .handle() no middleware throws", async fn() { const app = new Application(); await assertRejects(async () => { await app.handle(new Request("http://localhost/index.html")); }, TypeError); teardown(); },});
test({ name: "application.use() - type checking - at least one middleware is passed", fn() { const app = new Application(); try { // @ts-expect-error app.use(); } catch { // } teardown(); },});
test({ name: "new Application() - HttpServerNative", fn() { new Application({ serverConstructor: HttpServerNative }); teardown(); },});
test({ name: "Application - inspecting", fn() { assertEquals( Deno.inspect(new Application()), `Application { "#middleware": [], keys: undefined, proxy: false, state: {} }`, ); teardown(); },});