@toa.io/extensions.exposition 1.0.0-alpha.6 → 1.0.0-alpha.60

package/source/Gateway.ts

@@ -1,8 +1,9 @@
+import assert from 'node:assert'
 import { type bindings, Connector } from '@toa.io/core'
 import * as http from './HTTP'
 import { rethrow } from './exceptions'
 import type { Interception } from './Interception'
-import type { Method, Parameter, Tree } from './RTD'
+import type { Node, Method, Parameter, Tree, Match } from './RTD'
 import type { Label } from './discovery'
 import type { Branch } from './Branch'
 
@@ -22,34 +23,30 @@ export class Gateway extends Connector {
   }
 
   public async process (context: http.Context): Promise<http.OutgoingMessage> {
-    const interception = await context.timing.capture('gate:intercept',
+    const interception = await context.timing.capture('intercept',
       this.interceptor.intercept(context))
 
     if (interception !== null)
       return interception
 
-    const match = this.tree.match(context.url.pathname)
-
-    if (match === null)
-      throw new http.NotFound()
+    const { node, parameters } = this.match(context)
 
-    const {
-      node,
-      parameters
-    } = match
+    if (context.request.method === 'OPTIONS')
+      return await this.explain(node, parameters)
 
     if (!(context.request.method in node.methods))
       throw new http.MethodNotAllowed()
 
     const method = node.methods[context.request.method]
 
-    const interruption = await context.timing.capture('gate:preflight',
-      method.directives.preflight(context, parameters))
+    const interruption = await context.timing.capture('preflight',
+      method.directives.preflight(context, parameters)).catch(rethrow)
 
     const response = interruption ??
-      await context.timing.capture('gate:call', this.call(method, context, parameters))
+      await context.timing.capture('call', this.call(method, context, parameters))
 
-    await context.timing.capture('gate:settle', method.directives.settle(context, response))
+    await context.timing.capture('settle',
+      method.directives.settle(context, response)).catch(rethrow)
 
     return response
   }
@@ -57,17 +54,41 @@ export class Gateway extends Connector {
   protected override async open (): Promise<void> {
     await this.discover()
 
-    console.info('Gateway has started and is awaiting resource branches.')
+    console.info('Gateway has started and is awaiting resource branches')
   }
 
   protected override dispose (): void {
-    console.info('Gateway is closed.')
+    console.info('Gateway is closed')
+  }
+
+  private match (context: http.Context): Match {
+    const match = this.tree.match(context.url.pathname)
+
+    if (match === null)
+      throw new http.NotFound('Route not found')
+
+    if (match.node.forward === null)
+      return match
+
+    const destination = match.node.forward.replace(/\/:([^/]+)/g,
+      (_, name) => {
+        const value = match.parameters.find((parameter) => parameter.name === name)?.value
+
+        assert.ok(value !== undefined, `Forwarded parameter '${name}' not found`)
+
+        return `/${value}`
+      })
+
+    const forward = this.tree.match(destination)
+
+    assert.ok(forward !== null, 'Forwarded route not found')
+
+    return forward
   }
 
-  private async call (method: Method, context: http.Context, parameters: Parameter[]):
-  Promise<http.OutgoingMessage> {
+  private async call (method: Method, context: http.Context, parameters: Parameter[]): Promise<http.OutgoingMessage> {
     if (context.url.pathname[context.url.pathname.length - 1] !== '/')
-      throw new http.NotFound('Trailing slash is required.')
+      throw new http.NotFound('Trailing slash is required')
 
     if (context.encoder === null)
       throw new http.NotAcceptable()
@@ -80,6 +101,14 @@ export class Gateway extends Connector {
       .catch(rethrow) as http.OutgoingMessage
   }
 
+  private async explain (node: Node, parameters: Parameter[]): Promise<http.OutgoingMessage> {
+    const body = await node.explain(parameters)
+    const allow = [...Object.keys(node.methods)].join(', ')
+    const headers = new Headers({ allow })
+
+    return { body, headers }
+  }
+
   private async discover (): Promise<void> {
     await this.broadcast.receive<Branch>('expose', this.merge.bind(this))
     await this.broadcast.transmit<null>('ping', null)
@@ -90,7 +119,7 @@ export class Gateway extends Connector {
       this.tree.merge(branch.node, branch)
 
       console.info('Resource branch of ' +
-        `'${branch.namespace}.${branch.component}' has been merged.`)
+        `'${branch.namespace}.${branch.component}' has been merged`)
     } catch (exception) {
       console.error(exception)
     }

package/source/HTTP/Context.ts

@@ -6,22 +6,29 @@ import type { OutgoingMessage } from './messages'
 import type * as http from 'node:http'
 
 export class Context {
+  public readonly authority: string
   public readonly request: IncomingMessage
   public readonly url: URL
   public readonly subtype: string | null = null
   public readonly encoder: Format | null = null
   public readonly timing: Timing
+  public readonly debug: boolean
 
   public readonly pipelines: Pipelines = {
     body: [],
     response: []
   }
 
-  public constructor (request: IncomingMessage, trace = false) {
+  public constructor (authority: string, request: IncomingMessage, properties: Properties) {
+    this.authority = authority
     this.request = request
 
     this.url = new URL(request.url, `https://${request.headers.host}`)
-    this.timing = new Timing(trace)
+    this.timing = new Timing(properties.trace)
+    this.debug = properties.debug
+
+    if (this.debug)
+      this.log(request)
 
     if (this.request.headers.accept !== undefined) {
       const match = SUBTYPE.exec(this.request.headers.accept)
@@ -52,6 +59,16 @@ export class Context {
       ? value
       : this.pipelines.body.reduce((value, transform) => transform(value), value)
   }
+
+  private log (request: IncomingMessage): void {
+    const message = `${request.method} ${request.url}`
+    const headers = { ...request.headers }
+
+    if (headers.authorization !== undefined)
+      headers.authorization = headers.authorization.slice(0, headers.authorization.indexOf(' '))
+
+    console.debug(message, headers)
+  }
 }
 
 export interface IncomingMessage extends http.IncomingMessage {
@@ -64,4 +81,9 @@ interface Pipelines {
   response: Array<(output: OutgoingMessage) => void>
 }
 
+interface Properties {
+  debug: boolean
+  trace: boolean
+}
+
 const SUBTYPE = /^(?<type>\w{1,32})\/(vnd\.toa\.(?<subtype>\S{1,32})\+)(?<suffix>\S{1,32})$/

package/source/HTTP/Server.ts

@@ -1,10 +1,9 @@
 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 { setTimeout } from 'node:timers/promises'
 import { Connector } from '@toa.io/core'
-import { promex } from '@toa.io/generic'
 import { type OutgoingMessage, write } from './messages'
 import { ClientError, Exception } from './exceptions'
 import { Context } from './Context'
@@ -13,32 +12,22 @@ import type { IncomingMessage } from './Context'
 export class Server extends Connector {
   private readonly server: http.Server = http.createServer()
   private readonly properties: Properties
+  private readonly authorities: Record<string, string>
   private process?: Processing
+  private ready: boolean = false
+  private startedAt: number = 0
 
   private constructor (properties: Properties) {
     super()
 
     this.properties = properties
+    this.authorities = Object.fromEntries(Object.entries(properties.authorities).map(([key, value]) => [value, key]))
 
     this.server.on('request', (req, res) => this.listener(req, res))
   }
 
-  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.')
-
-    return address.port
-  }
-
-  public static create (options?: Partial<Properties>): Server {
-    const properties = options === undefined
-      ? DEFAULTS
-      : { ...DEFAULTS, ...options }
+  public static create (options: Options): Server {
+    const properties: Properties = Object.assign({}, DEFAULTS, options)
 
     return new Server(properties)
   }
@@ -48,21 +37,29 @@ export class Server extends Connector {
   }
 
   protected override async open (): Promise<void> {
+    this.startedAt = Date.now()
     this.server.listen(this.properties.port)
 
     await once(this.server, 'listening')
 
-    console.info('HTTP Server is listening.')
+    console.info('HTTP Server is listening')
+
+    await setTimeout(this.properties.delay)
+
+    this.ready = true
+
+    console.info('Ready')
   }
 
   protected override async close (): Promise<void> {
     this.server.close()
+    this.ready = false
 
-    console.info('HTTP Server stopped accepting new connections.')
+    console.info('HTTP Server stopped accepting new connections')
 
     await once(this.server, 'close')
 
-    console.info('HTTP Server has been stopped.')
+    console.info('HTTP Server has been stopped')
   }
 
   private listener (request: http.IncomingMessage, response: http.ServerResponse): void {
@@ -72,18 +69,23 @@ export class Server extends Connector {
       return
     }
 
-    if (request.url === undefined) {
-      response.writeHead(400).end()
+    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()
+
+        response.writeHead(503, { 'retry-after': remaining }).end()
+      }
 
       return
     }
 
-    assert.ok(this.process !== undefined,
-      'No processing function has been attached to the server.')
-
-    const context = new Context(request as IncomingMessage, this.properties.trace)
+    const host = request.headers.host!
+    const authority = this.authorities[host] ?? host
+    const context = new Context(authority, request as IncomingMessage, this.properties)
 
-    this.process(context)
+    this.process!(context)
       .then(this.success(context, response))
       .catch(this.fail(context, response))
   }
@@ -112,17 +114,15 @@ export class Server extends Connector {
       if (!context.request.complete)
         await adam(context.request)
 
-      response.statusCode = exception instanceof Exception
-        ? exception.status
-        : 500
+      response.statusCode = exception instanceof Exception ? exception.status : 500
 
       const message: OutgoingMessage = { status: response.statusCode }
-      const verbose = exception instanceof ClientError || this.properties.debug
 
-      if (verbose)
-        message.body = exception instanceof Exception
-          ? exception.body
-          : (exception.stack ?? exception.message)
+      if (exception instanceof ClientError || this.properties.debug)
+        message.body =
+          exception instanceof Exception
+            ? exception.body
+            : exception.stack ?? exception.message
 
       write(context, response, message)
     }
@@ -131,28 +131,35 @@ export class Server extends Connector {
 
 // https://github.com/whatwg/fetch/issues/1254
 async function adam (request: http.IncomingMessage): Promise<void> {
-  const completed = promex()
   const devnull = fs.createWriteStream(os.devNull)
 
-  request
-    .on('end', completed.callback)
-    .pipe(devnull)
+  request.pipe(devnull)
 
-  return completed
+  await once(request, 'end')
 }
 
-const DEFAULTS: Properties = {
+export const PORT = 8000
+export const DELAY = 3 // seconds
+
+const DEFAULTS: Omit<Properties, 'authorities'> = {
   methods: new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS']),
   debug: false,
   trace: false,
-  port: 8000
+  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: Context) => Promise<OutgoingMessage>

package/source/HTTP/exceptions.ts

@@ -37,11 +37,17 @@ export class NotFound extends ClientError {
 }
 
 export class Conflict extends ClientError {
-  public constructor (body: any) {
+  public constructor (body?: any) {
     super(409, body)
   }
 }
 
+export class UnprocessableEntity extends ClientError {
+  public constructor (body?: any) {
+    super(422, body)
+  }
+}
+
 export class MethodNotAllowed extends ClientError {
   public constructor () {
     super(405)

package/source/HTTP/formats/index.ts

@@ -5,10 +5,10 @@ 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/messages.test.ts

@@ -1,9 +1,13 @@
-import { Readable } from 'node:stream'
+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 { 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(() => {
@@ -69,6 +73,39 @@ describe('read', () => {
 
     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',
+      '',
+      'Hello',
+      '--cut',
+      '',
+      'New',
+      '--cut',
+      '',
+      'World',
+      '--cut--'].join('\r\n'))
+  })
 })
 
 export function createContext

package/source/HTTP/messages.ts

@@ -29,7 +29,7 @@ export async function read (context: Context): Promise<any> {
     throw new UnsupportedMediaType()
 
   const format = formats[type]
-  const buf = await context.timing.capture('req:buffer', buffer(context.request))
+  const buf = await context.timing.capture('buffer', buffer(context.request))
 
   try {
     return format.decode(buf)
@@ -72,7 +72,7 @@ function stream
   })
 }
 
-function multipart
+export function multipart
 (message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
   if (context.encoder === null)
     throw new NotAcceptable()
@@ -82,7 +82,11 @@ function multipart
   response.setHeader('content-type', `${encoder.multipart}; boundary=${BOUNDARY}`)
 
   message.body
-    .map((part: unknown) => Buffer.concat([CUT, encoder.encode(part), CRLF]))
+    .map((part: unknown) => Buffer.concat([
+      CUT,
+      CRLF /* indicates no boundary headers */,
+      encoder.encode(part),
+      CRLF]))
     .on('end', () => response.end(FINALCUT))
     .pipe(response)
 }

package/source/Introspection.ts

@@ -0,0 +1,11 @@
+import type { Remote } from '@toa.io/core'
+
+export interface Introspection {
+  route?: Record<string, Schema>
+  query?: Record<string, Schema>
+  input?: Schema
+  output?: Schema
+  errors?: string[]
+}
+
+export type Schema = Awaited<ReturnType<Remote['explain']>>['input']

package/source/Mapping.ts

@@ -1,50 +1,92 @@
 import { type Parameter } from './RTD'
 import { Query } from './Query'
+import type { Introspection, Schema } from './Introspection'
+import type { QueryString } from './Query'
 import type * as http from './HTTP'
 import type * as syntax from './RTD/syntax'
 import type * as core from '@toa.io/core'
 
 export abstract class Mapping {
-  public static create (query?: syntax.Query): Mapping {
-    if (query === undefined || query === null)
-      return new InputMapping()
+  protected readonly query: Query
 
-    const q = new Query(query)
+  public constructor (query: Query) {
+    this.query = query
+  }
+
+  public static create (query?: syntax.Query | null): Mapping {
+    const q = new Query(query!)
 
-    return new QueryableMapping(q)
+    return queryable(query)
+      ? new QueryableMapping(q)
+      : new InputMapping(q)
   }
 
-  public abstract fit (input: any, qs: http.Query, parameters: Parameter[]): core.Request
+  public explain (introspection: Introspection): Record<string, Schema> | null {
+    return this.query.explain(introspection)
+  }
+
+  protected assign (input: any, qs: QueryString): void {
+    if (qs.parameters !== null) {
+      if (typeof input !== 'object' || input === null)
+        throw new Error('Input must be an object to embed query parameters')
+
+      Object.assign(input, qs.parameters)
+    }
+  }
+
+  public abstract fit (input: any, query: http.Query, parameters: Parameter[]): core.Request
 }
 
 class QueryableMapping extends Mapping {
-  private readonly query: Query
+  public fit (input: any, query: http.Query, parameters: Parameter[]): core.Request {
+    const request: core.Request = {}
+    const qs = this.query.fit(query, parameters)
 
-  public constructor (query: Query) {
-    super()
+    if (input === undefined && qs.parameters !== null)
+      input = {}
 
-    this.query = query
-  }
+    this.assign(input, qs)
 
-  public fit (input: any, qs: http.Query, parameters: Parameter[]): core.Request {
-    const query = this.query.fit(qs, parameters)
+    if (input !== undefined)
+      request.input = input
 
-    return {
-      input,
-      query
-    }
+    if (qs.query !== null)
+      request.query = qs.query
+
+    return request
   }
 }
 
 class InputMapping extends Mapping {
-  public fit (input: any, _: unknown, parameters: Parameter[]): core.Request {
-    if (input === undefined && parameters.length > 0)
+  public fit (input: any, query: http.Query, parameters: Parameter[]): core.Request {
+    const request: core.Request = {}
+    const qs = this.query.fit(query, parameters)
+
+    if (input === undefined && (parameters.length > 0 || qs.parameters !== null))
       input = {}
 
-    if (typeof input === 'object' && input !== null)
+    if (parameters.length > 0) {
+      if (typeof input !== 'object' || input === null)
+        throw new Error('Input must be an object to embed route parameters')
+
       for (const parameter of parameters)
         input[parameter.name] = parameter.value
+    }
 
-    return { input }
+    this.assign(input, qs)
+
+    if (input !== undefined)
+      request.input = input
+
+    return request
   }
 }
+
+export function queryable (query?: syntax.Query | null): boolean {
+  if (query === undefined || query === null)
+    return false
+
+  const keys = Object.keys(query)
+
+  return !(keys.length === 1 && keys[0] === 'parameters')
+}

package/source/Query.test.ts

@@ -16,7 +16,7 @@ it('should combine request criteria', async () => {
   const instance = new Query(query)
   const result = instance.fit({ criteria: 'qux==4' }, parameters)
 
-  expect(result.criteria).toStrictEqual('(foo==1);(bar==2;baz==3);(qux==4)')
+  expect(result.query!.criteria).toStrictEqual('(bar==2;baz==3);(foo==1);(qux==4)')
 })
 
 it('should set id parameter as query.id', async () => {
@@ -32,6 +32,6 @@ it('should set id parameter as query.id', async () => {
   const instance = new Query(query)
   const result = instance.fit({}, parameters)
 
-  expect(result.criteria).toBeUndefined()
-  expect(result.id).toStrictEqual(id)
+  expect(result.query!.criteria).toBeUndefined()
+  expect(result.query!.id).toStrictEqual(id)
 })