@toa.io/extensions.exposition 1.0.0-alpha.3 → 1.0.0-alpha.4

package/source/HTTP/Server.ts

@@ -1,31 +1,31 @@
 import fs from 'node:fs'
 import os from 'node:os'
-import express from 'express'
+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 * 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 server?: http.Server
-  private readonly app: Express
-  private readonly debug: boolean
-  private readonly requestedPort: number
+  private readonly server: http.Server = http.createServer()
+  private readonly properties: Properties
+  private process?: Processing
 
-  private constructor (app: Express, debug: boolean, port: number) {
+  private constructor (properties: Properties) {
     super()
 
-    this.app = app
-    this.debug = debug
-    this.requestedPort = port
+    this.properties = properties
+
+    this.server.on('request', (req, res) => this.listener(req, res))
   }
 
   public get port (): number {
-    if (this.server === undefined) return this.requestedPort
+    if (this.properties.port !== 0)
+      return this.properties.port
 
     const address = this.server.address()
 
@@ -40,132 +40,97 @@ export class Server extends Connector {
       ? DEFAULTS
       : { ...DEFAULTS, ...options }
 
-    const app = express()
-
-    app.disable('x-powered-by')
-    app.use(supportedMethods(properties.methods))
-
-    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))
-    })
+    this.process = process
   }
 
   protected override async open (): Promise<void> {
-    const listening = promex()
-
-    this.server = this.app.listen(this.requestedPort, 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(stopped.callback)
+    this.server.close()
 
-    await stopped
+    console.info('HTTP Server stopped accepting new connections.')
 
-    this.server = undefined
+    await once(this.server, 'close')
 
     console.info('HTTP Server has been stopped.')
   }
 
-  private extend (request: Request): IncomingMessage {
-    const message = request 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()
 
-    negotiate(request, message)
+      return
+    }
 
-    message.pipelines = { body: [], response: [] }
+    if (request.url === undefined) {
+      response.writeHead(400).end()
 
-    message.parse = async <T> (): Promise<T> => {
-      const value = await read(request)
+      return
+    }
 
-      if (message.pipelines.body.length === 0)
-        return value
+    assert.ok(this.process !== undefined,
+      'No processing function has been attached to the server.')
 
-      return message.pipelines.body.reduce((value, transform) => transform(value), value)
-    }
+    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)
-      write(request, response, message)
+        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 = status
+      write(context, response, message)
     }
   }
 
-  private fail (request: IncomingMessage, response: Response) {
+  private fail (context: Context, response: http.ServerResponse) {
     return async (exception: Error) => {
-      if (!request.complete)
-        await adam(request)
+      if (!context.request.complete)
+        await adam(context.request)
 
-      const status = exception instanceof Exception
+      response.statusCode = exception instanceof Exception
         ? exception.status
         : 500
 
-      response.status(status)
-
       const message: OutgoingMessage = {}
-      const verbose = exception instanceof ClientError || this.debug
+      const verbose = exception instanceof ClientError || this.properties.debug
 
       if (verbose)
         message.body = exception instanceof Exception
           ? exception.body
           : (exception.stack ?? exception.message)
 
-      write(request, response, message)
+      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)
-  }
-}
-
-function negotiate (request: Request, message: IncomingMessage): void {
-  if (request.headers.accept !== undefined) {
-    const match = SUBTYPE.exec(request.headers.accept)
-
-    if (match !== null) {
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      const { type, subtype, suffix } = match.groups!
-
-      request.headers.accept = `${type}/${suffix}`
-      message.subtype = subtype
-    }
-  }
-
-  const negotiator = new Negotiator(request)
-  const mediaType = negotiator.mediaType(types)
-
-  message.encoder = mediaType === undefined ? null : formats[mediaType]
-}
-
 // https://github.com/whatwg/fetch/issues/1254
-async function adam (request: Request): Promise<void> {
+async function adam (request: http.IncomingMessage): Promise<void> {
   const completed = promex()
   const devnull = fs.createWriteStream(os.devNull)
 
@@ -173,21 +138,21 @@ async function adam (request: Request): Promise<void> {
     .on('end', completed.callback)
     .pipe(devnull)
 
-  return await completed
+  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
 }
 
-export type Processing = (input: IncomingMessage) => Promise<OutgoingMessage>
-
-const SUBTYPE = /^(?<type>\w{1,32})\/(vnd\.toa\.(?<subtype>\S{1,32})\+)(?<suffix>\S{1,32})$/
+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/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>
+}

package/source/HTTP/messages.ts

@@ -1,27 +1,26 @@
-import { type IncomingHttpHeaders } from 'node:http'
 import { Readable } from 'node:stream'
-import { type Request, type Response } from 'express'
-import { buffer } from '@toa.io/streams'
+import { buffer } from 'node:stream/consumers'
 import { formats } from './formats'
 import { BadRequest, NotAcceptable, UnsupportedMediaType } from './exceptions'
-import type { ParsedQs } from 'qs'
-import type { Format } from './formats'
+import type { Context } from './Context'
+import type * as http from 'node:http'
 
 export function write
-(request: IncomingMessage, response: Response, message: OutgoingMessage): void {
-  for (const transform of request.pipelines.response)
+(context: Context, response: http.ServerResponse, message: OutgoingMessage): void {
+  for (const transform of context.pipelines.response)
     transform(message)
 
-  message.headers?.forEach((value, key) => response.set(key, value))
+  message.headers?.forEach((value, key) => response.setHeader(key, value))
+  context.timing.append(response)
 
   if (message.body instanceof Readable)
-    stream(message, request, response)
+    stream(message, context, response)
   else
-    send(message, request, response)
+    send(message, context, response)
 }
 
-export async function read (request: Request): Promise<any> {
-  const type = request.headers['content-type']
+export async function read (context: Context): Promise<any> {
+  const type = context.request.headers['content-type']
 
   if (type === undefined)
     return undefined
@@ -30,8 +29,7 @@ export async function read (request: Request): Promise<any> {
     throw new UnsupportedMediaType()
 
   const format = formats[type]
-
-  const buf = await buffer(request)
+  const buf = await context.timing.capture('req:buffer', buffer(context.request))
 
   try {
     return format.decode(buf)
@@ -40,32 +38,33 @@ export async function read (request: Request): Promise<any> {
   }
 }
 
-function send (message: OutgoingMessage, request: IncomingMessage, response: Response): void {
+function send
+(message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
   if (message.body === undefined || message.body === null) {
     response.end()
 
     return
   }
 
-  if (request.encoder === null)
+  if (context.encoder === null)
     throw new NotAcceptable()
 
-  const buf = request.encoder.encode(message.body)
+  const buf = context.encoder.encode(message.body)
 
   response
-    .set('content-type', request.encoder.type)
-    .append('vary', 'accept')
+    .setHeader('content-type', context.encoder.type)
+    .appendHeader('vary', 'accept')
     .end(buf)
 }
 
 function stream
-(message: OutgoingMessage, request: IncomingMessage, response: Response): void {
+(message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
   const encoded = message.headers !== undefined && message.headers.has('content-type')
 
   if (encoded)
-    pipe(message, response)
+    message.body.pipe(response)
   else
-    multipart(message, request, response)
+    multipart(message, context, response)
 
   message.body.on('error', (e: Error) => {
     console.error(e)
@@ -73,54 +72,39 @@ function stream
   })
 }
 
-function pipe (message: OutgoingMessage, response: Response): void {
-  message.headers?.forEach((value, key) => response.set(key, value))
-  message.body.pipe(response)
-}
-
-function multipart (message: OutgoingMessage, request: IncomingMessage, response: Response): void {
-  if (request.encoder === null)
+function multipart
+(message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
+  if (context.encoder === null)
     throw new NotAcceptable()
 
-  const encoder = request.encoder
+  const encoder = context.encoder
 
-  response.set('content-type', `${encoder.multipart}; boundary=${BOUNDARY}`)
+  response.setHeader('content-type', `${encoder.multipart}; boundary=${BOUNDARY}`)
 
   message.body
-    .map((part: unknown) => Buffer.concat([CUT, encoder.encode(part)]))
+    .map((part: unknown) => Buffer.concat([CUT, encoder.encode(part), CRLF]))
     .on('end', () => response.end(FINALCUT))
     .pipe(response)
 }
 
 const BOUNDARY = 'cut'
 const CUT = Buffer.from(`--${BOUNDARY}\r\n`)
+const CRLF = Buffer.from('\r\n')
 const FINALCUT = Buffer.from(`--${BOUNDARY}--`)
 
-export interface IncomingMessage extends Request {
-  method: string
-  path: string
-  url: string
-  headers: IncomingHttpHeaders
-  query: Query
-  parse: <T> () => Promise<T>
-  encoder: Format | null
-  subtype: string | null
-  pipelines: {
-    body: Array<(input: unknown) => unknown>
-    response: Array<(output: OutgoingMessage) => void>
-  }
-}
-
 export interface OutgoingMessage {
   status?: number
   headers?: Headers
   body?: any
 }
 
-export interface Query extends ParsedQs {
+export interface Query {
+  [key: string]: string | number | undefined
+
   id?: string
   criteria?: string
   sort?: string
   omit?: string
   limit?: string
+  version?: number
 }

package/source/Mapping.ts

@@ -29,7 +29,10 @@ class QueryableMapping extends Mapping {
   public fit (input: any, qs: http.Query, parameters: Parameter[]): core.Request {
     const query = this.query.fit(qs, parameters)
 
-    return { input, query }
+    return {
+      input,
+      query
+    }
   }
 }
 
@@ -38,14 +41,10 @@ class InputMapping extends Mapping {
     if (input === undefined && parameters.length > 0)
       input = {}
 
-    if (typeof input === 'object')
-      this.assign(input, parameters)
+    if (typeof input === 'object' && input !== null)
+      for (const parameter of parameters)
+        input[parameter.name] = parameter.value
 
     return { input }
   }
-
-  private assign (input: Record<string, any>, parameters: Parameter[]): void {
-    for (const parameter of parameters)
-      input[parameter.name] = parameter.value
-  }
 }

package/source/deployment.ts

@@ -41,6 +41,12 @@ export function deployment (_: unknown, annotation: Annotation | undefined): Dep
       value: '1'
     })
 
+  if (annotation?.trace === true)
+    service.variables.push({
+      name: 'TOA_EXPOSITION_TRACE',
+      value: '1'
+    })
+
   if (annotation !== undefined)
     schemas.annotaion.validate(annotation)
 

package/source/directives/auth/Anonymous.ts

@@ -8,7 +8,8 @@ export class Anonymous implements Directive {
   }
 
   public authorize (_: any, input: Input): boolean {
-    if ('authorization' in input.headers) return false
-    else return this.allow
+    return 'authorization' in input.request.headers
+      ? false
+      : this.allow
   }
 }

package/source/directives/auth/Authorization.ts

@@ -56,7 +56,7 @@ export class Authorization implements Family<Directive, Extension> {
   public async preflight (directives: Directive[],
     input: Input,
     parameters: Parameter[]): Promise<Output> {
-    const identity = await this.resolve(input.headers.authorization)
+    const identity = await this.resolve(input.request.headers.authorization)
 
     input.identity = identity
 
@@ -67,8 +67,10 @@ export class Authorization implements Family<Directive, Extension> {
         return directive.reply?.(identity) ?? null
     }
 
-    if (identity === null) throw new http.Unauthorized()
-    else throw new http.Forbidden()
+    if (identity === null)
+      throw new http.Unauthorized()
+    else
+      throw new http.Forbidden()
   }
 
   public async settle (directives: Directive[],

package/source/directives/auth/Incept.ts

@@ -15,28 +15,33 @@ export class Incept implements Directive {
   }
 
   public authorize (identity: Identity | null, input: Input): boolean {
-    return identity === null && 'authorization' in input.headers
+    return identity === null && 'authorization' in input.request.headers
   }
 
-  public async settle (request: Input, response: http.OutgoingMessage): Promise<void> {
+  public async settle (input: Input, response: http.OutgoingMessage): Promise<void> {
     const id = response.body?.[this.property]
 
     if (id === undefined)
       throw new http.Conflict('Identity inception has failed as the response body ' +
         ` does not contain the '${this.property}' property.`)
 
-    const [scheme, credentials] = split(request.headers.authorization!)
+    const [scheme, credentials] = split(input.request.headers.authorization!)
     const provider = PROVIDERS[scheme]
 
     this.schemes[scheme] ??= await this.discovery[provider]
 
     const identity = await this.schemes[scheme]
-      .invoke<Maybe<Identity>>('create', { input: { id, credentials } })
+      .invoke<Maybe<Identity>>('create', {
+      input: {
+        id,
+        credentials
+      }
+    })
 
     if (identity instanceof Error)
       throw new http.Conflict(identity)
 
-    request.identity = identity
-    request.identity.scheme = scheme
+    input.identity = identity
+    input.identity.scheme = scheme
   }
 }

package/source/directives/auth/Role.ts

@@ -14,10 +14,12 @@ export class Role implements Directive {
   public static async set (identity: Identity, discovery: Promise<Component>): Promise<void> {
     this.remote ??= await discovery
 
-    const query: Query = { criteria: `identity==${identity.id}`, limit: 1024 }
-    const roles: string[] = await this.remote.invoke('list', { query })
+    const query: Query = {
+      criteria: `identity==${identity.id}`,
+      limit: 1024
+    }
 
-    identity.roles = roles
+    identity.roles = await this.remote.invoke('list', { query })
   }
 
   public async authorize (identity: Identity | null): Promise<boolean> {