@toa.io/extensions.exposition 1.0.0-alpha.12 → 1.0.0-alpha.120

package/source/Gateway.ts

@@ -1,8 +1,10 @@
+import assert from 'node:assert'
+import { console } from 'openspan'
 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'
 
@@ -10,6 +12,7 @@ export class Gateway extends Connector {
   private readonly broadcast: Broadcast
   private readonly tree: Tree
   private readonly interceptor: Interception
+  private readonly merged = new Set<string>()
 
   public constructor (broadcast: Broadcast, tree: Tree, interception: Interception) {
     super()
@@ -28,20 +31,20 @@ export class Gateway extends Connector {
     if (interception !== null)
       return interception
 
-    const match = this.tree.match(context.url.pathname)
+    const { node, parameters } = this.match(context)
 
-    if (match === null)
-      throw new http.NotFound()
+    if (context.request.method === 'OPTIONS')
+      return await this.explain(node, parameters)
 
-    const {
-      node,
-      parameters
-    } = match
+    let verb = context.request.method
 
-    if (!(context.request.method in node.methods))
+    if (!(verb in node.methods) && verb === 'HEAD' && 'GET' in node.methods)
+      verb = 'GET'
+
+    if (!(verb in node.methods))
       throw new http.MethodNotAllowed()
 
-    const method = node.methods[context.request.method]
+    const method = node.methods[verb]
 
     const interruption = await context.timing.capture('preflight',
       method.directives.preflight(context, parameters)).catch(rethrow)
@@ -58,17 +61,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 started')
   }
 
   protected override dispose (): void {
-    console.info('Gateway is closed.')
+    console.info('Gateway is closed')
   }
 
-  private async call (method: Method, context: http.Context, parameters: Parameter[]):
-  Promise<http.OutgoingMessage> {
+  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> {
     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()
@@ -81,19 +108,46 @@ 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)
   }
 
   private merge (branch: Branch): void {
+    const id = branch.namespace + '.' + branch.component + '@' + branch.version
+
+    if (this.merged.has(id)) {
+      console.debug('Branch already merged, ignoring', {
+        namespace: branch.namespace,
+        component: branch.component,
+        version: branch.version
+      })
+
+      return
+    }
+
+    this.merged.add(id)
+
+    const attributes = {
+      namespace: branch.namespace,
+      component: branch.component,
+      version: branch.version
+    }
+
     try {
       this.tree.merge(branch.node, branch)
 
-      console.info('Resource branch of ' +
-        `'${branch.namespace}.${branch.component}' has been merged.`)
-    } catch (exception) {
-      console.error(exception)
+      console.info('Branch merged', attributes)
+    } catch (exception: unknown) {
+      console.error('Branch merge exception', { exception, ...attributes })
     }
   }
 }

package/source/HTTP/Context.ts

@@ -1,4 +1,5 @@
 import Negotiator from 'negotiator'
+import { console } from 'openspan'
 import { Timing } from './Timing'
 import { type Format, formats, types } from './formats'
 import { read } from './messages'
@@ -6,22 +7,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)
@@ -46,11 +54,22 @@ export class Context {
   }
 
   public async body<T> (): Promise<T> {
-    const value = await read(this)
+    let value = await read(this)
+
+    for (const transform of this.pipelines.body)
+      value = await transform(value)
+
+    return value
+  }
 
-    return this.pipelines.body.length === 0
-      ? value
-      : this.pipelines.body.reduce((value, transform) => transform(value), value)
+  private log (request: IncomingMessage): void {
+    const headers = { ...request.headers }
+
+    if (headers.authorization !== undefined)
+      // only scheme
+      headers.authorization = headers.authorization.slice(0, headers.authorization.indexOf(' '))
+
+    console.debug('Received request', { method: request.method, url: request.url, headers })
   }
 }
 
@@ -61,7 +80,12 @@ export interface IncomingMessage extends http.IncomingMessage {
 
 interface Pipelines {
   body: Array<(input: unknown) => unknown>
-  response: Array<(output: OutgoingMessage) => void>
+  response: Array<(output: OutgoingMessage) => void | Promise<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,11 @@
+import assert from 'node:assert'
 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 { console } from 'openspan'
 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,75 +14,97 @@ import type { IncomingMessage } from './Context'
 export class Server extends Connector {
   private readonly server: http.Server = http.createServer()
   private readonly properties: Properties
-  private process?: Processing
+  private readonly authorities: Record<string, string>
+  private process?: Processor
+  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
+    if (this.properties.debug)
+      this.server.on('connection', (socket) =>
+        console.debug('Connected', { address: socket.remoteAddress }))
   }
 
-  public static create (options?: Partial<Properties>): Server {
-    const properties = options === undefined
-      ? DEFAULTS
-      : { ...DEFAULTS, ...options }
+  public static create (options: Options): Server {
+    const properties: Properties = { ...DEFAULTS, ...options }
 
     return new Server(properties)
   }
 
-  public attach (process: Processing): void {
+  public attach (process: Processor): void {
     this.process = process
   }
 
   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('Stopped accepting new connections')
 
     await once(this.server, 'close')
 
-    console.info('HTTP Server has been stopped.')
+    console.info('Stopped')
   }
 
   private listener (request: http.IncomingMessage, response: http.ServerResponse): void {
+    const invalid = validate(request)
+
+    if (invalid !== null) {
+      console.warn('Invalid request', errorAttributes(request, invalid))
+
+      response.writeHead(400).end()
+
+      return
+    }
+
+    request.on('error', (error) => console.warn('Request error', errorAttributes(request, error)))
+    response.on('error', (error) => console.warn('Response error', errorAttributes(request, error)))
+
     if (request.method === undefined || !this.properties.methods.has(request.method)) {
       response.writeHead(501).end()
 
       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.')
+    assert(this.process !== undefined, 'Request processor is not attached')
 
-    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)
       .then(this.success(context, response))
@@ -89,7 +112,7 @@ export class Server extends Connector {
   }
 
   private success (context: Context, response: http.ServerResponse) {
-    return (message: OutgoingMessage) => {
+    return async (message: OutgoingMessage) => {
       let status = message.status
 
       if (status === undefined)
@@ -97,13 +120,13 @@ export class Server extends Connector {
           status = 404
         else if (context.request.method === 'POST')
           status = 201
-        else if (message.body === undefined)
+        else if (message.body === undefined && context.request.method !== 'HEAD')
           status = 204
         else
           status = 200
 
       response.statusCode = message.status = status
-      write(context, response, message)
+      await write(context, response, message)
     }
   }
 
@@ -112,47 +135,88 @@ 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 (context.encoder === null)
+        message.body = undefined
+      else if (exception instanceof ClientError || this.properties.debug)
+        message.body =
+          exception instanceof Exception
+            ? exception.body
+            : exception.stack ?? exception.message
 
-      write(context, response, message)
+      await write(context, response, message)
     }
   }
 }
 
+function validate (request: http.IncomingMessage): null | Error {
+  try {
+    void new URL(request.url!, `https://${request.headers.host}`)
+
+    return null
+  } catch (error) {
+    return error as Error
+  }
+}
+
 // 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 = {
-  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,
   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 Processing = (input: Context) => Promise<OutgoingMessage>
+export type Options = { authorities: Properties['authorities'] } & {
+  [K in Exclude<keyof Properties, 'authorities'>]?: Properties[K]
+}
+
+export type Processor = (input: Context) => Promise<OutgoingMessage>
+
+interface RequestErrorAttributes {
+  path: string
+  method: string
+  name: string
+  code?: string
+  stack?: string
+}

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)
@@ -65,3 +71,9 @@ export class PreconditionFailed extends ClientError {
     super(412)
   }
 }
+
+export class RequestEntityTooLarge extends ClientError {
+  public constructor (body?: any) {
+    super(413, body)
+  }
+}

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,45 @@ 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',
+      '',
+      'ACK',
+      '--cut',
+      '',
+      'Hello',
+      '--cut',
+      '',
+      'New',
+      '--cut',
+      '',
+      'World',
+      '--cut',
+      '',
+      'FIN',
+      '--cut--'].join('\r\n'))
+  })
 })
 
 export function createContext

package/source/HTTP/messages.ts

@@ -1,18 +1,30 @@
 import { Readable } from 'node:stream'
 import { buffer } from 'node:stream/consumers'
+import { console } from 'openspan'
 import { formats } from './formats'
 import { BadRequest, NotAcceptable, UnsupportedMediaType } from './exceptions'
 import type { Context } from './Context'
 import type * as http from 'node:http'
 
-export function write
-(context: Context, response: http.ServerResponse, message: OutgoingMessage): void {
+const server = `Exposition/${require('../../package.json').version}` +
+  ((process.env.TOA_CONTEXT === undefined ? '' : ` ${process.env.TOA_CONTEXT}`) +
+    (process.env.TOA_ENV === undefined ? '' : `/${process.env.TOA_ENV}`))
+
+export async function write
+(context: Context, response: http.ServerResponse, message: OutgoingMessage): Promise<void> {
   for (const transform of context.pipelines.response)
-    transform(message)
+    await transform(message)
 
+  response.setHeader('server', server)
   message.headers?.forEach((value, key) => response.setHeader(key, value))
   context.timing.append(response)
 
+  if (context.request.destroyed) {
+    console.warn('Request destroyed prematurely', { path: context.url.pathname })
+
+    return
+  }
+
   if (message.body instanceof Readable)
     stream(message, context, response)
   else
@@ -41,6 +53,7 @@ export async function read (context: Context): Promise<any> {
 function send
 (message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
   if (message.body === undefined || message.body === null) {
+    response.setHeader('content-length', '0')
     response.end()
 
     return
@@ -53,6 +66,7 @@ function send
 
   response
     .setHeader('content-type', context.encoder.type)
+    .setHeader('content-length', buf.length.toString())
     .appendHeader('vary', 'accept')
     .end(buf)
 }
@@ -66,13 +80,13 @@ function stream
   else
     multipart(message, context, response)
 
-  message.body.on('error', (e: Error) => {
-    console.error(e)
+  message.body.on('error', (exception: Error) => {
+    console.error('Stream error', { path: context.url.pathname, exception })
     response.end()
   })
 }
 
-function multipart
+export function multipart
 (message: OutgoingMessage, context: Context, response: http.ServerResponse): void {
   if (context.encoder === null)
     throw new NotAcceptable()
@@ -81,9 +95,26 @@ function multipart
 
   response.setHeader('content-type', `${encoder.multipart}; boundary=${BOUNDARY}`)
 
+  response.write(Buffer.concat([
+    CUT,
+    CRLF,
+    encoder.encode('ACK'),
+    CRLF,
+    CUT
+  ]))
+
   message.body
-    .map((part: unknown) => Buffer.concat([CUT, encoder.encode(part), CRLF]))
-    .on('end', () => response.end(FINALCUT))
+    .map((part: unknown) => Buffer.concat([
+      CRLF /* indicates no boundary headers */,
+      encoder.encode(part),
+      CRLF,
+      CUT]))
+    .on('end', () => response.end(Buffer.concat([
+      CRLF,
+      encoder.encode('FIN'),
+      CRLF,
+      FINALCUT
+    ])))
     .pipe(response)
 }