deno.land / std@0.50.0 / http / server.ts

server.ts
View Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.import { encode } from "../encoding/utf8.ts";import { BufReader, BufWriter } from "../io/bufio.ts";import { assert } from "../testing/asserts.ts";import { deferred, Deferred, MuxAsyncIterator } from "../async/mod.ts";import { bodyReader, chunkedBodyReader, emptyReader, writeResponse, readRequest,} from "./_io.ts";import Listener = Deno.Listener;import Conn = Deno.Conn;import Reader = Deno.Reader;const { listen, listenTls } = Deno;
export class ServerRequest { url!: string; method!: string; proto!: string; protoMinor!: number; protoMajor!: number; headers!: Headers; conn!: Conn; r!: BufReader; w!: BufWriter; done: Deferred<Error | undefined> = deferred();
private _contentLength: number | undefined | null = undefined; /** * Value of Content-Length header. * If null, then content length is invalid or not given (e.g. chunked encoding). */ get contentLength(): number | null { // undefined means not cached. // null means invalid or not provided. if (this._contentLength === undefined) { const cl = this.headers.get("content-length"); if (cl) { this._contentLength = parseInt(cl); // Convert NaN to null (as NaN harder to test) if (Number.isNaN(this._contentLength)) { this._contentLength = null; } } else { this._contentLength = null; } } return this._contentLength; }
private _body: Deno.Reader | null = null;
/** * Body of the request. * * const buf = new Uint8Array(req.contentLength); * let bufSlice = buf; * let totRead = 0; * while (true) { * const nread = await req.body.read(bufSlice); * if (nread === null) break; * totRead += nread; * if (totRead >= req.contentLength) break; * bufSlice = bufSlice.subarray(nread); * } */ get body(): Deno.Reader { if (!this._body) { if (this.contentLength != null) { this._body = bodyReader(this.contentLength, this.r); } else { const transferEncoding = this.headers.get("transfer-encoding"); if (transferEncoding != null) { const parts = transferEncoding .split(",") .map((e): string => e.trim().toLowerCase()); assert( parts.includes("chunked"), 'transfer-encoding must include "chunked" if content-length is not set' ); this._body = chunkedBodyReader(this.headers, this.r); } else { // Neither content-length nor transfer-encoding: chunked this._body = emptyReader(); } } } return this._body; }
async respond(r: Response): Promise<void> { let err: Error | undefined; try { // Write our response! await writeResponse(this.w, r); } catch (e) { try { // Eagerly close on error. this.conn.close(); } catch {} err = e; } // Signal that this request has been processed and the next pipelined // request on the same connection can be accepted. this.done.resolve(err); if (err) { // Error during responding, rethrow. throw err; } }
private finalized = false; async finalize(): Promise<void> { if (this.finalized) return; // Consume unread body const body = this.body; const buf = new Uint8Array(1024); while ((await body.read(buf)) !== null) {} this.finalized = true; }}
export class Server implements AsyncIterable<ServerRequest> { private closing = false; private connections: Conn[] = [];
constructor(public listener: Listener) {}
close(): void { this.closing = true; this.listener.close(); for (const conn of this.connections) { try { conn.close(); } catch (e) { // Connection might have been already closed if (!(e instanceof Deno.errors.BadResource)) { throw e; } } } }
// Yields all HTTP requests on a single TCP connection. private async *iterateHttpRequests( conn: Conn ): AsyncIterableIterator<ServerRequest> { const reader = new BufReader(conn); const writer = new BufWriter(conn);
while (!this.closing) { let request: ServerRequest | null; try { request = await readRequest(conn, reader); } catch (error) { if ( error instanceof Deno.errors.InvalidData || error instanceof Deno.errors.UnexpectedEof ) { // An error was thrown while parsing request headers. await writeResponse(writer, { status: 400, body: encode(`${error.message}\r\n\r\n`), }); } break; } if (request === null) { break; }
request.w = writer; yield request;
// Wait for the request to be processed before we accept a new request on // this connection. const responseError = await request.done; if (responseError) { // Something bad happened during response. // (likely other side closed during pipelined req) // req.done implies this connection already closed, so we can just return. this.untrackConnection(request.conn); return; } // Consume unread body and trailers if receiver didn't consume those data await request.finalize(); }
this.untrackConnection(conn); try { conn.close(); } catch (e) { // might have been already closed } }
private trackConnection(conn: Conn): void { this.connections.push(conn); }
private untrackConnection(conn: Conn): void { const index = this.connections.indexOf(conn); if (index !== -1) { this.connections.splice(index, 1); } }
// Accepts a new TCP connection and yields all HTTP requests that arrive on // it. When a connection is accepted, it also creates a new iterator of the // same kind and adds it to the request multiplexer so that another TCP // connection can be accepted. private async *acceptConnAndIterateHttpRequests( mux: MuxAsyncIterator<ServerRequest> ): AsyncIterableIterator<ServerRequest> { if (this.closing) return; // Wait for a new connection. let conn: Conn; try { conn = await this.listener.accept(); } catch (error) { if (error instanceof Deno.errors.BadResource) { return; } throw error; } this.trackConnection(conn); // Try to accept another connection and add it to the multiplexer. mux.add(this.acceptConnAndIterateHttpRequests(mux)); // Yield the requests that arrive on the just-accepted connection. yield* this.iterateHttpRequests(conn); }
[Symbol.asyncIterator](): AsyncIterableIterator<ServerRequest> { const mux: MuxAsyncIterator<ServerRequest> = new MuxAsyncIterator(); mux.add(this.acceptConnAndIterateHttpRequests(mux)); return mux.iterate(); }}
/** Options for creating an HTTP server. */export type HTTPOptions = Omit<Deno.ListenOptions, "transport">;
/** * Create a HTTP server * * import { serve } from "https://deno.land/std/http/server.ts"; * const body = "Hello World\n"; * const s = serve({ port: 8000 }); * for await (const req of s) { * req.respond({ body }); * } */export function serve(addr: string | HTTPOptions): Server { if (typeof addr === "string") { const [hostname, port] = addr.split(":"); addr = { hostname, port: Number(port) }; }
const listener = listen(addr); return new Server(listener);}
/** * Start an HTTP server with given options and request handler * * const body = "Hello World\n"; * const options = { port: 8000 }; * listenAndServe(options, (req) => { * req.respond({ body }); * }); * * @param options Server configuration * @param handler Request handler */export async function listenAndServe( addr: string | HTTPOptions, handler: (req: ServerRequest) => void): Promise<void> { const server = serve(addr);
for await (const request of server) { handler(request); }}
/** Options for creating an HTTPS server. */export type HTTPSOptions = Omit<Deno.ListenTlsOptions, "transport">;
/** * Create an HTTPS server with given options * * const body = "Hello HTTPS"; * const options = { * hostname: "localhost", * port: 443, * certFile: "./path/to/localhost.crt", * keyFile: "./path/to/localhost.key", * }; * for await (const req of serveTLS(options)) { * req.respond({ body }); * } * * @param options Server configuration * @return Async iterable server instance for incoming requests */export function serveTLS(options: HTTPSOptions): Server { const tlsOptions: Deno.ListenTlsOptions = { ...options, transport: "tcp", }; const listener = listenTls(tlsOptions); return new Server(listener);}
/** * Start an HTTPS server with given options and request handler * * const body = "Hello HTTPS"; * const options = { * hostname: "localhost", * port: 443, * certFile: "./path/to/localhost.crt", * keyFile: "./path/to/localhost.key", * }; * listenAndServeTLS(options, (req) => { * req.respond({ body }); * }); * * @param options Server configuration * @param handler Request handler */export async function listenAndServeTLS( options: HTTPSOptions, handler: (req: ServerRequest) => void): Promise<void> { const server = serveTLS(options);
for await (const request of server) { handler(request); }}
/** * Interface of HTTP server response. * If body is a Reader, response would be chunked. * If body is a string, it would be UTF-8 encoded by default. */export interface Response { status?: number; headers?: Headers; body?: Uint8Array | Reader | string; trailers?: () => Promise<Headers> | Headers;}
std
Deno standard library
GitHub Repositorydenoland/deno
GitHub Stars
2108

Version Info

Tagged at
a year ago

External Dependencies

No external dependencies 🎉