refator: rewrite APIRequest

feat: add brotli compress
doc: update jsdoc for types.ts

Author: Je

api.ts

@@ -1,12 +1,14 @@
+import { compress as brotli } from 'https://deno.land/x/[email protected]/mod.ts'
 import { gzipEncode } from 'https://deno.land/x/[email protected]/mod.ts'
 import log from './log.ts'
-import type { ServerRequest } from './std.ts'
-import type { APIRequest, APIRequestURL, Response } from './types.ts'
-
-export class Request implements APIRequest {
-    #req: ServerRequest
-    #url: APIRequestURL
-    #cookies: ReadonlyMap<string, string> = new Map()
+import { ServerRequest } from './std.ts'
+import type { APIRequest } from './types.ts'
+
+export class Request extends ServerRequest implements APIRequest {
+    #pathname: string
+    #params: Record<string, string>
+    #query: URLSearchParams
+    #cookies: ReadonlyMap<string, string>
     #resp = {
         status: 200,
         headers: new Headers({
@@ -16,65 +18,41 @@ export class Request implements APIRequest {
         done: false
     }
 
-    constructor(req: ServerRequest, url: APIRequestURL) {
-        this.#req = req
-        this.#url = url
-    }
-
-    get method(): string {
-        return this.#req.method
-    }
-
-    get proto() {
-        return this.#req.proto
-    }
-
-    get protoMinor() {
-        return this.#req.protoMinor
-    }
-
-    get protoMajor() {
-        return this.#req.protoMajor
-    }
-
-    get conn() {
-        return this.#req.conn
-    }
-
-    get r() {
-        return this.#req.r
-    }
-
-    get w() {
-        return this.#req.w
-    }
-
-    get done() {
-        return this.#req.done
-    }
-
-    get contentLength() {
-        return this.#req.contentLength
-    }
-
-    get body() {
-        return this.#req.body
-    }
-
-    async respond(r: Response) {
-        return this.#req.respond(r)
+    constructor(req: ServerRequest, pathname: string, params: Record<string, string>, query: URLSearchParams) {
+        super()
+        this.conn = req.conn
+        this.r = req.r
+        this.w = req.w
+        this.method = req.method
+        this.url = req.url
+        this.proto = req.proto
+        this.protoMinor = req.protoMinor
+        this.protoMajor = req.protoMajor
+        this.headers = req.headers
+        this.done = req.done
+        this.#pathname = pathname
+        this.#params = params
+        this.#query = query
+        const cookies = new Map()
+        this.headers.get('cookie')?.split(';').forEach(cookie => {
+            const p = cookie.trim().split('=')
+            if (p.length >= 2) {
+                cookies.set(p.shift()!.trim(), decodeURI(p.join('=')))
+            }
+        })
+        this.#cookies = cookies
     }
 
-    async finalize() {
-        return this.#req.finalize()
+    get pathname(): string {
+        return this.#pathname
     }
 
-    get url(): APIRequestURL {
-        return this.#url
+    get params(): Record<string, string> {
+        return this.#params
     }
 
-    get headers(): Headers {
-        return this.#req.headers
+    get query(): URLSearchParams {
+        return this.#query
     }
 
     get cookies(): ReadonlyMap<string, string> {
@@ -102,11 +80,11 @@ export class Request implements APIRequest {
         return this
     }
 
-    json(data: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number) {
-        return this.send(JSON.stringify(data, replacer, space), 'application/json')
+    async json(data: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): Promise<void> {
+        await this.send(JSON.stringify(data, replacer, space), 'application/json; charset=utf-8')
     }
 
-    async send(data: string | Uint8Array | ArrayBuffer, contentType?: string) {
+    async send(data: string | Uint8Array | ArrayBuffer, contentType?: string): Promise<void> {
         if (this.#resp.done) {
             log.warn('ServerRequest: repeat respond calls')
             return
@@ -125,41 +103,36 @@ export class Request implements APIRequest {
             this.#resp.headers.set('Content-Type', contentType)
         } else if (this.#resp.headers.has('Content-Type')) {
             contentType = this.#resp.headers.get('Content-Type')!
+        } else if (typeof data === 'string' && data.length > 0) {
+            contentType = 'text/plain; charset=utf-8'
         }
         let isText = false
         if (contentType) {
             if (contentType.startsWith('text/')) {
                 isText = true
-            } else if (/^application\/(javascript|typecript|json|xml)/.test(contentType)) {
+            } else if (/^application\/(javascript|typecript|json|xml)/i.test(contentType)) {
                 isText = true
-            } else if (/^image\/svg+xml/.test(contentType)) {
+            } else if (/^image\/svg+xml/i.test(contentType)) {
                 isText = true
             }
         }
-        if (isText && body.length > 1024 && this.#req.headers.get('accept-encoding')?.includes('gzip')) {
-            this.#resp.headers.set('Vary', 'Origin')
-            this.#resp.headers.set('Content-Encoding', 'gzip')
-            body = gzipEncode(body)
+        if (isText && body.length > 1024) {
+            if (this.headers.get('accept-encoding')?.includes('br')) {
+                this.#resp.headers.set('Vary', 'Origin')
+                this.#resp.headers.set('Content-Encoding', 'br')
+                body = brotli(body)
+            } else if (this.headers.get('accept-encoding')?.includes('gzip')) {
+                this.#resp.headers.set('Vary', 'Origin')
+                this.#resp.headers.set('Content-Encoding', 'gzip')
+                body = gzipEncode(body)
+            }
         }
         this.#resp.headers.set('Date', (new Date).toUTCString())
         this.#resp.done = true
-        return this.#req.respond({
+        await this.respond({
             status: this.#resp.status,
             headers: this.#resp.headers,
             body
         }).catch(err => log.warn('ServerRequest.respond:', err.message))
     }
-
-    async end(status: number) {
-        if (this.#resp.done) {
-            log.warn('ServerRequest: repeat respond calls')
-            return
-        }
-        this.#resp.headers.set('Date', (new Date).toUTCString())
-        this.#resp.done = true
-        return this.#req.respond({
-            status,
-            headers: this.#resp.headers,
-        }).catch(err => log.warn('ServerRequest.respond:', err.message))
-    }
 }

cli.ts

@@ -127,7 +127,7 @@ async function main() {
                 const port = parseInt(match[2])
                 listenAndServe({ port }, async (req: ServerRequest) => {
                     const url = new URL('http://localhost' + req.url)
-                    const resp = new Request(req, { pathname: util.cleanPath(url.pathname), params: {}, query: url.searchParams })
+                    const resp = new Request(req, util.cleanPath(url.pathname), {}, url.searchParams)
                     const filepath = path.join(cwd, url.pathname)
                     try {
                         const info = await Deno.lstat(filepath)
@@ -148,10 +148,10 @@ async function main() {
                         resp.send(await Deno.readFile(filepath), getContentType(filepath))
                     } catch (err) {
                         if (err instanceof Deno.errors.NotFound) {
-                            resp.status(404).send('file not found', 'text/plain')
+                            resp.status(404).send('file not found')
                             return
                         }
-                        resp.status(500).send(err.message, 'text/plain')
+                        resp.status(500).send(err.message)
                     }
                 })
                 log.info(`Proxy https://deno.land/x/aleph on http://localhost:${port}`)

project.ts

@@ -185,7 +185,7 @@ export class Project {
                 try {
                     const { default: handle } = await import('file://' + this.#modules.get(moduleID)!.jsFile)
                     if (util.isFunction(handle)) {
-                        await handle(new Request(req, url))
+                        await handle(new Request(req, url.pathname, url.params, url.query))
                     } else {
                         req.respond({
                             status: 500,

server.ts

@@ -17,7 +17,7 @@ export async function start(appDir: string, port: number, isDev = false, reload
             for await (const req of s) {
                 const url = new URL('http://localhost/' + req.url)
                 const pathname = util.cleanPath(url.pathname)
-                const resp = new Request(req, { pathname, params: {}, query: url.searchParams })
+                const resp = new Request(req, pathname, {}, url.searchParams)
 
                 try {
                     // serve hmr ws
@@ -76,7 +76,7 @@ export async function start(appDir: string, port: number, isDev = false, reload
                             if (status === 200) {
                                 resp.send(`export default ` + JSON.stringify(data), 'application/javascript; charset=utf-8')
                             } else {
-                                resp.end(status)
+                                resp.status(status).send('')
                             }
                             continue
                         } else if (pathname.endsWith('.css')) {
@@ -92,7 +92,7 @@ export async function start(appDir: string, port: number, isDev = false, reload
                             if (mod) {
                                 const etag = req.headers.get('If-None-Match')
                                 if (etag && etag === mod.hash) {
-                                    resp.end(304)
+                                    resp.status(304).send('')
                                     continue
                                 }
 
@@ -117,7 +117,7 @@ export async function start(appDir: string, port: number, isDev = false, reload
                     if (existsFileSync(filePath)) {
                         const info = await Deno.lstat(filePath)
                         if (info.mtime?.toUTCString() === req.headers.get('If-Modified-Since')) {
-                            resp.end(304)
+                            resp.status(304).send('')
                             continue
                         }
 
@@ -148,5 +148,3 @@ export async function start(appDir: string, port: number, isDev = false, reload
         }
     }
 }
-
-

std.ts

@@ -5,6 +5,7 @@ export { ensureFile } from 'https://deno.land/[email protected]/fs/ensure_file.ts'
 export { walk } from 'https://deno.land/[email protected]/fs/walk.ts'
 export { Sha1 } from 'https://deno.land/[email protected]/hash/sha1.ts'
 export { listenAndServe, serve, ServerRequest } from 'https://deno.land/[email protected]/http/server.ts'
+export type { Response } from 'https://deno.land/[email protected]/http/server.ts'
 export { fromStreamReader } from 'https://deno.land/[email protected]/io/mod.ts'
 export * as path from 'https://deno.land/[email protected]/path/mod.ts'
 export * as ws from 'https://deno.land/[email protected]/ws/mod.ts'