@toa.io/extensions.exposition 1.0.0-alpha.0 → 1.0.0-alpha.11

package/source/HTTP/Server.test.ts

@@ -1,199 +1,126 @@
+import { randomUUID } from 'node:crypto'
 import { Connector } from '@toa.io/core'
-import { immediate } from '@toa.io/generic'
-import { generate } from 'randomstring'
 import { type Processing, Server } from './Server'
 import { type OutgoingMessage } from './messages'
-import { express, cors, createRequest, res, next } from './Server.fixtures'
 import { BadRequest } from './exceptions'
-import type { Express, Request, RequestHandler } from 'express'
-import type { CorsOptions } from 'cors'
-import type http from 'node:http'
-
-jest.mock('express', () => () => express())
-jest.mock('cors', () => (options: CorsOptions) => cors(options))
 
 let server: Server
-let app: jest.MockedObject<Express>
-
-beforeEach(() => {
-  jest.clearAllMocks()
 
-  server = Server.create()
-  app = express.mock.results[0]?.value
+beforeAll(() => {
+  server = Server.create({ port: 0 })
 })
 
 it('should instance of connector', async () => {
   expect(server).toBeInstanceOf(Connector)
 })
 
-it('should create express app', async () => {
-  expect(express).toHaveBeenCalled()
-  expect(app.disable).toHaveBeenCalledWith('x-powered-by')
-})
-
-it('should support cors', async () => {
-  expect(cors).toHaveBeenCalledWith({ allowedHeaders: ['content-type'] } satisfies CorsOptions)
-
-  const middleware = cors.mock.results[0].value
-
-  expect(app.use).toHaveBeenCalledWith(middleware)
-})
-
 it('should start HTTP server', async () => {
-  const stared = server.connect()
-
-  await immediate()
-
-  expect(app.listen).toHaveBeenCalledWith(8000, expect.anything())
-
-  const done = app.listen.mock.calls[0][1]
-
-  if (done !== undefined) done()
+  await server.connect()
 
-  await stared
-})
-
-it('should stop HTTP server', async () => {
-  const started = server.connect()
-
-  await immediate()
-
-  app.listen.mock.calls[0][1]?.() // `listen` callback
-
-  await started
-
-  const stopped = server.disconnect()
-  const httpServer: jest.MockedObject<http.Server> = app.listen.mock.results[0].value
-
-  await immediate()
-
-  expect(httpServer.close).toHaveBeenCalled()
-
-  httpServer.close.mock.calls[0][0]?.() // `close` callback
-
-  await stopped
+  expect(server.connected).toBeTruthy()
+  expect(server.port).toBeGreaterThan(0)
 })
 
 it('should register request handler', async () => {
-  const process = jest.fn(async () => ({})) as unknown as Processing
-  const req = createRequest()
+  const process: Processing = jest.fn().mockResolvedValue(undefined)
 
   server.attach(process)
 
-  await use(req)
+  const res = await fetch(`http://localhost:${server.port}`)
+
+  await res.text()
 
-  expect(process).toHaveBeenCalled()
+  expect(process).toHaveBeenCalledTimes(1)
 })
 
 it('should send 501 on unknown method', async () => {
-  const req = createRequest({ method: generate() })
+  const head = await fetch(`http://localhost:${server.port}/`, { method: 'COPY' })
 
-  await use(req)
+  await head.text()
+  expect(head.status).toBe(501)
+})
 
-  expect(res.sendStatus).toHaveBeenCalledWith(501)
+it('should stop HTTP server', async () => {
+  await server.connect()
+  await server.disconnect()
+  expect(server.connected).toBeFalsy()
 })
 
 describe('result', () => {
-  it('should send status code 200 if the result has a value', async () => {
-    const req = createRequest()
+  beforeEach(async () => {
+    server = Server.create({ port: 0 })
+    await server.connect()
+  })
+
+  afterEach(async () => {
+    await server.disconnect()
+  })
 
+  it('should send status code 200 if the result has a value', async () => {
     server.attach(async (): Promise<OutgoingMessage> => ({
-      headers: new Headers(), body: generate()
+      headers: new Headers(), body: randomUUID()
     }))
-    await use(req)
 
-    expect(res.status).toHaveBeenCalledWith(200)
+    const res = await fetch(`http://localhost:${server.port}/`)
+
+    await res.text()
+    expect(res.status).toBe(200)
   })
 
   it('should send status code 204 if the result has no value', async () => {
-    const req = createRequest()
-
     server.attach(async (): Promise<OutgoingMessage> => ({ headers: new Headers() }))
-    await use(req)
 
-    expect(res.status).toHaveBeenCalledWith(204)
+    const res = await fetch(`http://localhost:${server.port}/`)
+
+    await res.text()
+    expect(res.status).toBe(204)
   })
 
   it('should send result', async () => {
-    const body = { [generate()]: generate() }
-    const json = JSON.stringify(body)
-    const buf = Buffer.from(json)
-    const req = createRequest({ headers: { accept: 'application/json' } })
+    const body = { [randomUUID()]: randomUUID() }
 
-    server.attach(async (): Promise<OutgoingMessage> => ({ headers: new Headers(), body }))
-    await use(req)
+    server.attach(async (): Promise<OutgoingMessage> =>
+      ({ headers: new Headers(), body }))
 
-    expect(res.end).toHaveBeenCalledWith(buf)
-  })
+    const res = await fetch(`http://localhost:${server.port}/`,
+      { headers: { accept: 'application/json' } })
 
-  it('should return 500 on exception', async () => {
-    async function process (): Promise<OutgoingMessage> {
-      throw new Error('Bad')
-    }
+    const result = await res.json()
 
-    const req = createRequest()
-
-    server.attach(process)
-    await use(req)
-
-    expect(res.status).toHaveBeenCalledWith(500)
+    expect(result).toEqual(body)
   })
 
-  it('should output exception message if debug is enabled', async () => {
-    jest.clearAllMocks()
-
-    server = Server.create({ debug: true })
-    app = express.mock.results[0]?.value
-
-    const message = generate()
-    const req = createRequest()
-
-    async function process (): Promise<OutgoingMessage> {
-      throw new Error(message)
-    }
+  it('should return 500 on exception', async () => {
+    server.attach(jest.fn().mockRejectedValue(new Error('Bad')))
 
-    server.attach(process)
-    await use(req)
+    const res = await fetch(`http://localhost:${server.port}/`)
 
-    expect(res.status).toHaveBeenCalledWith(500)
+    await res.text()
+    expect(res.status).toBe(500)
   })
 
   it('should send client error', async () => {
-    const req = createRequest()
-    const message = generate()
+    const message = randomUUID()
 
-    async function process (): Promise<OutgoingMessage> {
-      throw new BadRequest(message)
-    }
+    server.attach(jest.fn().mockRejectedValueOnce(new BadRequest(message)))
 
-    server.attach(process)
-    await use(req)
+    const res = await fetch(`http://localhost:${server.port}/`)
+    const text = await res.text()
 
-    expect(res.status).toHaveBeenCalledWith(400)
+    expect(res.status).toBe(400)
+    expect(text).toContain(message)
   })
 })
 
 describe('options', () => {
   it('should send 501 on unspecified method', async () => {
-    jest.clearAllMocks()
+    server = Server.create({ methods: new Set(['COPY']), port: 0 })
+    await server.connect()
 
-    server = Server.create({ methods: new Set(['COPY']) })
-    app = express.mock.results[0]?.value
+    const res = await fetch(`http://localhost:${server.port}/`)
 
-    const req = createRequest({ method: 'GET' })
-
-    await use(req)
-
-    expect(res.sendStatus).toHaveBeenCalledWith(501)
+    await res.text()
+    await server.disconnect()
+    expect(res.status).toBe(501)
   })
 })
-
-async function use (req: Request): Promise<void> {
-  for (const call of app.use.mock.calls) {
-    const usage = call[0] as unknown as RequestHandler
-
-    usage(req, res, next)
-  }
-
-  await immediate()
-}

package/source/HTTP/Server.ts

@@ -1,149 +1,158 @@
-import express from 'express'
-import cors from 'cors'
+import fs from 'node:fs'
+import os from 'node:os'
+import * as http from 'node:http'
+import assert from 'node:assert'
+import { once } from 'node:events'
 import { Connector } from '@toa.io/core'
 import { promex } from '@toa.io/generic'
-import Negotiator from 'negotiator'
-import { read, write, type IncomingMessage, type OutgoingMessage } from './messages'
+import { type OutgoingMessage, write } from './messages'
 import { ClientError, Exception } from './exceptions'
-import { formats, types } from './formats'
-import type { Format } from './formats'
-import type * as http from 'node:http'
-import type { Express, Request, Response, NextFunction } from 'express'
+import { Context } from './Context'
+import type { IncomingMessage } from './Context'
 
 export class Server extends Connector {
-  private readonly debug: boolean
-  private readonly app: Express
-  private server?: http.Server
+  private readonly server: http.Server = http.createServer()
+  private readonly properties: Properties
+  private process?: Processing
 
-  private constructor (app: Express, debug: boolean) {
+  private constructor (properties: Properties) {
     super()
 
-    this.app = app
-    this.debug = debug
+    this.properties = properties
+
+    this.server.on('request', (req, res) => this.listener(req, res))
   }
 
-  public static create (options: Partial<Properties> = {}): Server {
-    const properties: Properties = Object.assign({}, defaults(), options)
+  public get port (): number {
+    if (this.properties.port !== 0)
+      return this.properties.port
+
+    const address = this.server.address()
+
+    if (address === null || typeof address === 'string')
+      throw new Error('Server is not listening on a port.')
 
-    const app = express()
+    return address.port
+  }
 
-    app.disable('x-powered-by')
-    app.use(cors({ allowedHeaders: ['content-type'] }))
-    app.use(supportedMethods(properties.methods))
+  public static create (options?: Partial<Properties>): Server {
+    const properties = options === undefined
+      ? DEFAULTS
+      : { ...DEFAULTS, ...options }
 
-    return new Server(app, properties.debug)
+    return new Server(properties)
   }
 
   public attach (process: Processing): void {
-    this.app.use((request: any, response: Response): void => {
-      this.extend(request)
-        .then(process)
-        .then(this.success(request, response))
-        .catch(this.fail(request, response))
-    })
+    this.process = process
   }
 
   protected override async open (): Promise<void> {
-    const listening = promex()
-
-    this.server = this.app.listen(8000, listening.callback)
+    this.server.listen(this.properties.port)
 
-    await listening
+    await once(this.server, 'listening')
 
     console.info('HTTP Server is listening.')
   }
 
   protected override async close (): Promise<void> {
-    const stopped = promex()
+    this.server.close()
 
-    this.server?.close(stopped.callback)
+    console.info('HTTP Server stopped accepting new connections.')
 
-    await stopped
-  }
+    await once(this.server, 'close')
 
-  protected override dispose (): void {
     console.info('HTTP Server has been stopped.')
   }
 
-  private async extend (request: IncomingMessage): Promise<IncomingMessage> {
-    const message = request as unknown as IncomingMessage
+  private listener (request: http.IncomingMessage, response: http.ServerResponse): void {
+    if (request.method === undefined || !this.properties.methods.has(request.method)) {
+      response.writeHead(501).end()
+
+      return
+    }
+
+    if (request.url === undefined) {
+      response.writeHead(400).end()
+
+      return
+    }
+
+    assert.ok(this.process !== undefined,
+      'No processing function has been attached to the server.')
 
-    message.encoder = negotiate(request)
-    message.parse = async <T> (): Promise<T> => await read(request)
+    const context = new Context(request as IncomingMessage, this.properties.trace)
 
-    return message
+    this.process(context)
+      .then(this.success(context, response))
+      .catch(this.fail(context, response))
   }
 
-  private success (request: IncomingMessage, response: Response) {
+  private success (context: Context, response: http.ServerResponse) {
     return (message: OutgoingMessage) => {
       let status = message.status
 
       if (status === undefined)
-        if (message.body === null) status = 404
-        else if (request.method === 'POST') status = 201
-        else if (message.body === undefined) status = 204
-        else status = 200
-
-      response.status(status)
-      message.headers?.forEach((value, key) => response.set(key, value))
-
-      if (message.body !== undefined && message.body !== null)
-        write(request, response, message)
-      else
-        response.end()
+        if (message.body === null)
+          status = 404
+        else if (context.request.method === 'POST')
+          status = 201
+        else if (message.body === undefined)
+          status = 204
+        else
+          status = 200
+
+      response.statusCode = message.status = status
+      write(context, response, message)
     }
   }
 
-  private fail (request: IncomingMessage, response: Response) {
-    return (exception: Error) => {
-      const status = exception instanceof Exception
+  private fail (context: Context, response: http.ServerResponse) {
+    return async (exception: Error) => {
+      if (!context.request.complete)
+        await adam(context.request)
+
+      response.statusCode = exception instanceof Exception
         ? exception.status
         : 500
 
-      response.status(status)
-
-      const outputAllowed = exception instanceof ClientError || this.debug
+      const message: OutgoingMessage = { status: response.statusCode }
+      const verbose = exception instanceof ClientError || this.properties.debug
 
-      if (outputAllowed) {
-        const body = exception instanceof Exception
+      if (verbose)
+        message.body = exception instanceof Exception
           ? exception.body
           : (exception.stack ?? exception.message)
 
-        write(request, response, { body })
-      } else
-        response.end()
-
-      // stop accepting request
-      if (!request.complete)
-        request.destroy()
+      write(context, response, message)
     }
   }
 }
 
-function supportedMethods (methods: Set<string>) {
-  return (req: Request, res: Response, next: NextFunction): void => {
-    if (methods.has(req.method)) next()
-    else res.sendStatus(501)
-  }
-}
+// https://github.com/whatwg/fetch/issues/1254
+async function adam (request: http.IncomingMessage): Promise<void> {
+  const completed = promex()
+  const devnull = fs.createWriteStream(os.devNull)
 
-function negotiate (request: Request): Format | null {
-  const negotiator = new Negotiator(request)
-  const mediaType = negotiator.mediaType(types)
+  request
+    .on('end', completed.callback)
+    .pipe(devnull)
 
-  return mediaType === undefined ? null : formats[mediaType]
+  return completed
+}
+
+const DEFAULTS: Properties = {
+  methods: new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS']),
+  debug: false,
+  trace: false,
+  port: 8000
 }
 
 interface Properties {
   methods: Set<string>
   debug: boolean
+  trace: boolean
+  port: number
 }
 
-function defaults (): Properties {
-  return {
-    methods: new Set<string>(['GET', 'OPTIONS', 'POST', 'PUT', 'PATCH', 'DELETE']),
-    debug: false
-  }
-}
-
-export type Processing = (input: IncomingMessage) => Promise<OutgoingMessage>
+export type Processing = (input: Context) => Promise<OutgoingMessage>

package/source/HTTP/Timing.ts

@@ -0,0 +1,40 @@
+import { performance } from 'node:perf_hooks'
+import type { ServerResponse } from 'node:http'
+
+export class Timing {
+  private readonly skip: boolean
+  private readonly start = performance.now()
+  private readonly breakpoints: Breakpoint[] = []
+
+  public constructor (enabled: boolean) {
+    this.skip = !enabled
+  }
+
+  public async capture<T> (id: string, promise: Promise<T>): Promise<T> {
+    if (this.skip)
+      return promise
+
+    const start = performance.now()
+    const result = promise instanceof Promise ? await promise : promise
+
+    this.breakpoints.push({ id, duration: performance.now() - start })
+
+    return result
+  }
+
+  public append (response: ServerResponse): void {
+    if (this.skip)
+      return
+
+    this.breakpoints.push({ id: 'total', duration: performance.now() - this.start })
+
+    for (const breakpoint of this.breakpoints)
+      response.appendHeader('server-timing',
+        `${breakpoint.id};dur=${breakpoint.duration.toFixed(3)}`)
+  }
+}
+
+interface Breakpoint {
+  id: string
+  duration: number
+}

package/source/HTTP/formats/msgpack.ts

@@ -1,13 +1,16 @@
 import { type Buffer } from 'node:buffer'
-import * as msgpack from 'msgpackr'
-
-export const type = 'application/msgpack'
-export const multipart = 'multipart/msgpack'
+import { pack, unpack } from 'msgpackr'
 
 export function decode (buffer: Buffer): any {
-  return msgpack.decode(buffer)
+  return unpack(buffer)
 }
 
 export function encode (value: any): Buffer {
-  return msgpack.encode(value)
+  if (typeof value === 'object' && value !== null)
+    Object.setPrototypeOf(value, null)
+
+  return pack(value)
 }
+
+export const type = 'application/msgpack'
+export const multipart = 'multipart/msgpack'

package/source/HTTP/formats/text.ts

@@ -7,6 +7,6 @@ export function decode (buffer: Buffer): any {
   return buffer.toString()
 }
 
-export function encode (value: any): Buffer {
+export function encode (value: { toString: () => string }): Buffer {
   return Buffer.from(value.toString())
 }

package/source/HTTP/formats/yaml.ts

@@ -11,7 +11,7 @@ export function decode (buffer: Buffer): any {
 }
 
 export function encode (value: any): Buffer {
-  const text = yaml.dump(value)
+  const text = yaml.dump(value, { lineWidth: -1, noRefs: true })
 
   return Buffer.from(text)
 }

package/source/HTTP/index.ts

@@ -1,3 +1,4 @@
 export * from './Server'
 export * from './messages'
 export * from './exceptions'
+export * from './Context'

package/source/HTTP/messages.test.ts

@@ -1,8 +1,10 @@
+import { Readable } from 'node:stream'
 import { generate } from 'randomstring'
 import * as msgpack from 'msgpackr'
 import { read } from './messages'
-import { createRequest } from './Server.fixtures'
 import { BadRequest, UnsupportedMediaType } from './exceptions'
+import { Timing } from './Timing'
+import type { Context } from './Context'
 
 beforeEach(() => {
   jest.clearAllMocks()
@@ -14,8 +16,8 @@ describe('read', () => {
     const headers = { 'content-type': 'application/json' }
     const input = { [generate()]: generate() }
     const json = JSON.stringify(input)
-    const request = createRequest({ path, headers }, json)
-    const output = await read(request)
+    const context = createContext(path, headers, json)
+    const output = await read(context)
 
     expect(output).toStrictEqual(input)
   })
@@ -24,7 +26,7 @@ describe('read', () => {
     const path = generate()
     const headers = { 'content-type': 'application/yaml' }
     const yaml = 'foo: 1'
-    const request = createRequest({ path, headers }, yaml)
+    const request = createContext(path, headers, yaml)
     const value = await read(request)
 
     expect(value).toStrictEqual({ foo: 1 })
@@ -35,7 +37,7 @@ describe('read', () => {
     const headers = { 'content-type': 'application/msgpack' }
     const input = { [generate()]: generate() }
     const msg = msgpack.encode(input)
-    const request = createRequest({ path, headers }, msg)
+    const request = createContext(path, headers, msg)
     const output = await read(request)
 
     expect(output).toStrictEqual(input)
@@ -45,7 +47,7 @@ describe('read', () => {
     const path = generate()
     const headers = { 'content-type': 'text/plain' }
     const input = generate()
-    const request = createRequest({ path, headers }, input)
+    const request = createContext(path, headers, input)
     const output = await read(request)
 
     expect(output).toStrictEqual(input)
@@ -54,7 +56,7 @@ describe('read', () => {
   it('should throw on unsupported request media type', async () => {
     const path = generate()
     const headers = { 'content-type': 'wtf/' + generate() }
-    const request = createRequest({ path, headers })
+    const request = createContext(path, headers)
 
     await expect(read(request)).rejects.toThrow(UnsupportedMediaType)
   })
@@ -63,8 +65,25 @@ describe('read', () => {
     const path = generate()
     const text = '{ "foo": "val... oops '
     const headers = { 'content-type': 'application/json' }
-    const request = createRequest({ path, headers }, text)
+    const request = createContext(path, headers, text)
 
     await expect(read(request)).rejects.toThrow(BadRequest)
   })
 })
+
+export function createContext
+(url: string, headers: Record<string, string> = {}, content: string | Buffer = ''):
+jest.MockedObject<Context> {
+  const buffer = Buffer.isBuffer(content) ? content : Buffer.from(content)
+  const stream = Readable.from(buffer)
+
+  const mock: Partial<Context> = {
+    request: Object.assign(stream, {
+      url,
+      headers
+    }) as unknown as Context['request'],
+    timing: new Timing(false)
+  }
+
+  return mock as unknown as jest.MockedObject<Context>
+}