@toa.io/extensions.exposition 1.0.0-alpha.2 → 1.0.0-alpha.200

package/source/HTTP/Server.ts

@@ -1,193 +1,270 @@
+import assert from 'node:assert'
 import fs from 'node:fs'
 import os from 'node:os'
-import express from 'express'
+import * as http from 'node:http'
+import { once } from 'node:events'
+import { setTimeout } from 'node:timers/promises'
+import { console } from 'openspan'
 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 * as http from 'node:http'
-import type { Express, Request, Response, NextFunction } from 'express'
+import { Context, type IncomingMessage } from './Context'
 
 export class Server extends Connector {
-  private server?: http.Server
-  private readonly app: Express
-  private readonly debug: boolean
-  private readonly requestedPort: number
-
-  private constructor (app: Express, debug: boolean, port: number) {
+  private readonly server: http.Server = http.createServer()
+  private readonly properties: Properties
+  private readonly authorities: Record<string, string>
+  private process?: Processor
+  private ready: boolean = false
+  private startedAt: number = 0
+
+  private constructor (properties: Properties) {
     super()
 
-    this.app = app
-    this.debug = debug
-    this.requestedPort = port
-  }
-
-  public get port (): number {
-    if (this.server === undefined) return this.requestedPort
+    this.properties = properties
+    this.authorities = Object.fromEntries(Object.entries(properties.authorities).map(([key, value]) => [value, key]))
 
-    const address = this.server.address()
+    this.server.on('request', (req, res) => this.listener(req, res))
 
-    if (address === null || typeof address === 'string')
-      throw new Error('Server is not listening on a port.')
+    this.server.on('clientError', (error, socket) => {
+      console.warn('Client connection error', error)
 
-    return address.port
+      if (socket.writable) socket.end('HTTP/1.1 400 Bad Request\r\n\r\n')
+      else socket.destroy()
+    })
   }
 
-  public static create (options?: Partial<Properties>): Server {
-    const properties = options === undefined
-      ? DEFAULTS
-      : { ...DEFAULTS, ...options }
-
-    const app = express()
-
-    app.disable('x-powered-by')
-    app.use(supportedMethods(properties.methods))
+  public static create (options: Options): Server {
+    const properties: Properties = { ...DEFAULTS, ...options }
 
-    return new Server(app, properties.debug, properties.port)
+    return new Server(properties)
   }
 
-  public attach (process: Processing): void {
-    this.app.use((request: Request, response: Response) => {
-      const message = this.extend(request)
-
-      process(message)
-        .then(this.success(message, response))
-        .catch(this.fail(message, response))
-    })
+  public attach (process: Processor): void {
+    this.process = process
   }
 
   protected override async open (): Promise<void> {
-    const listening = promex()
+    this.startedAt = Date.now()
+    this.server.listen(this.properties.port)
+
+    await once(this.server, 'listening')
 
-    this.server = this.app.listen(this.requestedPort, listening.callback)
+    console.info('HTTP Server is listening')
 
-    await listening
+    await setTimeout(this.properties.delay)
 
-    console.info('HTTP Server is listening.')
+    this.ready = true
+
+    console.info('Ready')
   }
 
   protected override async close (): Promise<void> {
-    const stopped = promex()
-
-    this.server?.close(stopped.callback)
+    this.server.close()
+    this.ready = false
 
-    await stopped
+    console.info('Stopped accepting new connections')
 
-    this.server = undefined
+    await once(this.server, 'close')
 
-    console.info('HTTP Server has been stopped.')
+    console.info('Stopped')
   }
 
-  private extend (request: Request): IncomingMessage {
-    const message = request as IncomingMessage
+  private listener (request: http.IncomingMessage, response: http.ServerResponse): void {
+    request.once('error', (error) => {
+      console.warn('Request error', errorAttributes(request, error))
 
-    negotiate(request, message)
+      if (!response.writableEnded)
+        response.destroy()
+    })
 
-    message.pipelines = { body: [], response: [] }
+    request.socket.once('error', (error) => {
+      console.warn('Socket error', errorAttributes(request, error))
 
-    message.parse = async <T> (): Promise<T> => {
-      const value = await read(request)
+      if (!response.writableEnded)
+        response.destroy()
+    })
 
-      if (message.pipelines.body.length === 0)
-        return value
+    const invalid = validate(request)
 
-      return message.pipelines.body.reduce((value, transform) => transform(value), value)
-    }
+    if (invalid !== null) {
+      console.warn('Invalid request', errorAttributes(request, invalid))
 
-    return message
-  }
+      response.writeHead(400).end()
 
-  private success (request: IncomingMessage, response: Response) {
-    return (message: OutgoingMessage) => {
-      let status = message.status
+      return
+    }
 
-      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
+    if (request.method === undefined || !this.properties.methods.has(request.method)) {
+      response.writeHead(501).end()
 
-      response.status(status)
-      write(request, response, message)
+      return
     }
-  }
 
-  private fail (request: IncomingMessage, response: Response) {
-    return async (exception: Error) => {
-      if (!request.complete)
-        await adam(request)
+    if (request.url === '/.ready') {
+      if (this.ready)
+        response.writeHead(200, { 'cache-control': 'no-store' }).end()
+      else {
+        const remaining = (Math.ceil((Date.now() - this.startedAt) / 1000)).toString()
 
-      const status = exception instanceof Exception
-        ? exception.status
-        : 500
+        response.writeHead(503, { 'retry-after': remaining }).end()
+      }
 
-      response.status(status)
+      return
+    }
 
-      const message: OutgoingMessage = {}
-      const verbose = exception instanceof ClientError || this.debug
+    assert(this.process !== undefined, 'Request processor is not attached')
 
-      if (verbose)
-        message.body = exception instanceof Exception
-          ? exception.body
-          : (exception.stack ?? exception.message)
+    const host = request.headers.host!
+    const authority = this.authorities[host] ?? host
+    const context = new Context(authority, request as IncomingMessage, this.properties)
 
-      write(request, response, message)
-    }
+    this.process(context)
+      .then(this.success(context, response))
+      .catch(this.fail(context, response))
+      .finally(() => {
+        request.removeAllListeners('error')
+        request.socket.removeAllListeners('error')
+      })
   }
-}
 
-function supportedMethods (methods: Set<string>) {
-  return (req: Request, res: Response, next: NextFunction): void => {
-    if (methods.has(req.method)) next()
-    else res.sendStatus(501)
-  }
-}
-
-function negotiate (request: Request, message: IncomingMessage): void {
-  if (request.headers.accept !== undefined) {
-    const match = SUBTYPE.exec(request.headers.accept)
+  private success (context: Context, response: http.ServerResponse) {
+    return async (message: OutgoingMessage) => {
+      let status = message.status
 
-    if (match !== null) {
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      const { type, subtype, suffix } = match.groups!
+      if (status === undefined)
+        if (message.body === null)
+          status = 404
+        else if (context.request.method === 'POST')
+          status = 201
+        else if (message.body === undefined && context.request.method !== 'HEAD')
+          status = 204
+        else
+          status = 200
+
+      message.status = status
+
+      await write(context, response, message)
+    }
+  }
 
-      request.headers.accept = `${type}/${suffix}`
-      message.subtype = subtype
+  private fail (context: Context, response: http.ServerResponse) {
+    return async (exception: Error) => {
+      try {
+        if (!context.request.complete)
+          await adam(context.request)
+
+        if (!response.writableEnded) {
+          response.statusCode = exception instanceof Exception ? exception.status : 500
+
+          const message: OutgoingMessage = { status: response.statusCode }
+
+          // eslint-disable-next-line max-depth
+          if (context.encoder === null)
+            message.body = undefined
+          else if (exception instanceof ClientError || this.properties.debug)
+            message.body =
+              exception instanceof Exception
+                ? exception.body
+                : (this.properties.debug && exception.stack) ?? exception.message
+
+          await write(context, response, message)
+        }
+      } catch (final) {
+        console.error('Error in error handler', final)
+
+        if (!response.writableEnded)
+          try {
+            response.writeHead(500).end()
+          } catch (e) {
+            // Nothing more we can do
+          }
+      }
     }
   }
+}
 
-  const negotiator = new Negotiator(request)
-  const mediaType = negotiator.mediaType(types)
+function validate (request: http.IncomingMessage): null | Error {
+  try {
+    void new URL(request.url!, `https://${request.headers.host}`)
 
-  message.encoder = mediaType === undefined ? null : formats[mediaType]
+    return null
+  } catch (error) {
+    return error as Error
+  }
 }
 
 // https://github.com/whatwg/fetch/issues/1254
-async function adam (request: Request): Promise<void> {
-  const completed = promex()
+async function adam (request: http.IncomingMessage): Promise<void> {
   const devnull = fs.createWriteStream(os.devNull)
 
-  request
-    .on('end', completed.callback)
-    .pipe(devnull)
+  devnull.on('error', () => undefined)
+  request.pipe(devnull).on('error', () => undefined)
 
-  return await completed
+  await once(request, 'end')
 }
 
-const DEFAULTS: Properties = {
-  methods: new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS']),
+function errorAttributes (request: http.IncomingMessage, error: Error & any): RequestErrorAttributes {
+  const attributes: RequestErrorAttributes = {
+    path: request.url!,
+    method: request.method!,
+    name: error.name
+  }
+
+  if (typeof error.code === 'string')
+    attributes.code = error.code
+
+  if (typeof error.stack === 'string')
+    attributes.stack = error.stack
+
+  return attributes
+}
+
+export const PORT = 8000
+export const DELAY = 3 // seconds
+
+const DEFAULTS: Omit<Properties, 'authorities'> = {
+  methods: new Set<string>(['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'DELETE', 'LOCK', 'UNLOCK']),
   debug: false,
-  port: 8000
+  trace: false,
+  port: PORT,
+  delay: DELAY * 1000
 }
 
 interface Properties {
+  authorities: Record<string, string>
   methods: Set<string>
   debug: boolean
+  trace: boolean
   port: number
+  delay: number
+}
+
+export type Options = { authorities: Properties['authorities'] } & {
+  [K in Exclude<keyof Properties, 'authorities'>]?: Properties[K]
 }
 
-export type Processing = (input: IncomingMessage) => Promise<OutgoingMessage>
+export type Processor = (input: Context) => Promise<OutgoingMessage>
+
+interface RequestErrorAttributes {
+  path: string
+  method: string
+  name: string
+  code?: string
+  stack?: string
+}
+
+
+/**
+ * I'm too fucking dumb to figure out how to handle this in a better way.
+ * It can be reproduced by calling `response.destroy()` on the client side while reading 
+ * an empty stream.
+ */
+process.on('uncaughtException', (err: unknown) => {
+  if ((err as { code?: string }).code === 'ECONNRESET') {
+    console.warn('ECONNRESET');
+    return
+  }
 
-const SUBTYPE = /^(?<type>\w{1,32})\/(vnd\.toa\.(?<subtype>\S{1,32})\+)(?<suffix>\S{1,32})$/
+  throw err
+})

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/exceptions.ts

@@ -36,12 +36,6 @@ export class NotFound extends ClientError {
   }
 }
 
-export class Conflict extends ClientError {
-  public constructor (body: any) {
-    super(409, body)
-  }
-}
-
 export class MethodNotAllowed extends ClientError {
   public constructor () {
     super(405)
@@ -54,14 +48,44 @@ export class NotAcceptable extends ClientError {
   }
 }
 
+export class Conflict extends ClientError {
+  public constructor (body?: any) {
+    super(409, body)
+  }
+}
+
+export class PreconditionFailed extends ClientError {
+  public constructor () {
+    super(412)
+  }
+}
+
+export class RequestEntityTooLarge extends ClientError {
+  public constructor (body?: any) {
+    super(413, body)
+  }
+}
+
 export class UnsupportedMediaType extends ClientError {
   public constructor () {
     super(415)
   }
 }
 
-export class PreconditionFailed extends ClientError {
+export class UnprocessableEntity extends ClientError {
+  public constructor (body?: any) {
+    super(422, body)
+  }
+}
+
+export class TooManyRequests extends ClientError {
   public constructor () {
-    super(412)
+    super(429)
+  }
+}
+
+export class ServiceUnavailable extends Exception {
+  public constructor (body?: any) {
+    super(503, body)
   }
 }

package/source/HTTP/formats/index.ts

@@ -1,14 +1,13 @@
-import { type Buffer } from 'node:buffer'
 import * as json from './json'
 import * as yaml from './yaml'
 import * as msgpack from './msgpack'
 import * as text from './text'
 
 export const formats: Record<string, Format> = {
-  [msgpack.type]: msgpack,
-  [yaml.type]: yaml,
   [json.type]: json,
-  [text.type]: text
+  [yaml.type]: yaml,
+  [text.type]: text,
+  [msgpack.type]: msgpack
 }
 
 export const types = Object.keys(formats)

package/source/HTTP/formats/json.ts

@@ -1,5 +1,3 @@
-import { Buffer } from 'node:buffer'
-
 export const type = 'application/json'
 export const multipart = 'multipart/json'
 

package/source/HTTP/formats/msgpack.ts

@@ -1,4 +1,3 @@
-import { type Buffer } from 'node:buffer'
 import { pack, unpack } from 'msgpackr'
 
 export function decode (buffer: Buffer): any {

package/source/HTTP/formats/text.ts

@@ -1,5 +1,3 @@
-import { Buffer } from 'node:buffer'
-
 export const type = 'text/plain'
 export const multipart = 'multipart/text'
 

package/source/HTTP/formats/yaml.ts

@@ -1,4 +1,3 @@
-import { Buffer } from 'node:buffer'
 import * as yaml from 'js-yaml'
 
 export const type = 'application/yaml'

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,14 @@
+import { PassThrough, Readable } from 'node:stream'
+import * as streamConsumers from 'node:stream/consumers'
+import { once } from 'node:events'
 import { generate } from 'randomstring'
 import * as msgpack from 'msgpackr'
-import { read } from './messages'
-import { createRequest } from './Server.fixtures'
+import { multipart, read, type OutgoingMessage } from './messages'
 import { BadRequest, UnsupportedMediaType } from './exceptions'
+import { formats } from './formats'
+import { Timing } from './Timing'
+import type * as http from 'node:http'
+import type { Context } from './Context'
 
 beforeEach(() => {
   jest.clearAllMocks()
@@ -14,8 +20,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 +30,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 +41,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 +51,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 +60,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 +69,65 @@ 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)
   })
+
+  it('should output correct mulitpart format', async () => {
+    const response = new class extends PassThrough {
+      public readonly headers = new Headers()
+
+      public setHeader (key: string, value: string): this {
+        this.headers.set(key, value)
+
+        return this
+      }
+    }()
+
+    const context = { encoder: formats['text/plain'] } as unknown as Context
+    const message = { body: Readable.from(['Hello', 'New', 'World']) } as unknown as OutgoingMessage
+
+    multipart(message, context, response as unknown as http.ServerResponse)
+
+    await once(message.body, 'end')
+
+    const result = await streamConsumers.text(response)
+
+    expect(result).toBe([
+      '--cut',
+      '',
+      'ACK',
+      '--cut',
+      '',
+      'Hello',
+      '--cut',
+      '',
+      'New',
+      '--cut',
+      '',
+      'World',
+      '--cut',
+      '',
+      'FIN',
+      '--cut--'].join('\r\n'))
+  })
 })
+
+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'],
+    url: new URL(url, 'https://host.local'),
+    timing: new Timing(false)
+  }
+
+  return mock as unknown as jest.MockedObject<Context>
+}