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

package/source/Gateway.ts

@@ -5,16 +5,13 @@ import type { Interception } from './Interception'
 import type { Method, Parameter, Tree } from './RTD'
 import type { Label } from './discovery'
 import type { Branch } from './Branch'
-import type { Endpoint } from './Endpoint'
-import type { Directives } from './Directive'
 
 export class Gateway extends Connector {
   private readonly broadcast: Broadcast
-  private readonly tree: Tree<Endpoint, Directives>
+  private readonly tree: Tree
   private readonly interceptor: Interception
 
-  // eslint-disable-next-line max-len
-  public constructor (broadcast: Broadcast, tree: Tree<Endpoint, Directives>, interception: Interception) {
+  public constructor (broadcast: Broadcast, tree: Tree, interception: Interception) {
     super()
 
     this.broadcast = broadcast
@@ -25,7 +22,7 @@ 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)
@@ -34,25 +31,23 @@ export class Gateway extends Connector {
     const match = this.tree.match(context.url.pathname)
 
     if (match === null)
-      throw new http.NotFound()
+      throw new http.NotFound('Route not found')
 
-    const {
-      node,
-      parameters
-    } = match
+    const { node, parameters } = match
 
     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
   }
@@ -60,18 +55,16 @@ 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 async call
-  (method: Method<Endpoint, Directives>, 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()
@@ -79,30 +72,11 @@ export class Gateway extends Connector {
     if (method.endpoint === null)
       throw new http.MethodNotAllowed()
 
-    const body = await context.body()
-    const query = this.query(context)
-
     return await method.endpoint
-      .call(body, query, parameters)
+      .call(context, parameters)
       .catch(rethrow) as http.OutgoingMessage
   }
 
-  private query (context: http.Context): http.Query {
-    const query: http.Query = Object.fromEntries(context.url.searchParams)
-    const etag = context.request.headers['if-match']
-
-    if (etag !== undefined) {
-      const match = etag.match(ETAG)
-
-      if (match === null)
-        throw new http.BadRequest('Invalid ETag.')
-      else
-        query.version = parseInt(match.groups!.version)
-    }
-
-    return query
-  }
-
   private async discover (): Promise<void> {
     await this.broadcast.receive<Branch>('expose', this.merge.bind(this))
     await this.broadcast.transmit<null>('ping', null)
@@ -113,13 +87,11 @@ 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)
     }
   }
 }
 
-const ETAG = /^"(?<version>\d{1,32})"$/
-
 export type Broadcast = bindings.Broadcast<Label>

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 { authorization, ...headers } = request.headers
+
+    if (authorization !== undefined)
+      headers.authorization = authorization.slice(0, 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,28 @@ 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.')
+    if (request.headers.host === undefined || !(request.headers.host in this.authorities)) {
+      response.writeHead(404).end('Unknown authority')
+
+      return
+    }
 
-    const context = new Context(request as IncomingMessage, this.properties.trace)
+    const authority = this.authorities[request.headers.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))
   }
@@ -102,7 +109,7 @@ export class Server extends Connector {
         else
           status = 200
 
-      response.statusCode = status
+      response.statusCode = message.status = status
       write(context, response, message)
     }
   }
@@ -112,17 +119,16 @@ 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 = {}
+      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)
+        message.body =
+          exception instanceof Exception
+            ? exception.body
+            : exception.stack ?? exception.message
 
       write(context, response, message)
     }
@@ -130,29 +136,36 @@ export class Server extends Connector {
 }
 
 // https://github.com/whatwg/fetch/issues/1254
-async function adam (request: http.IncomingMessage): Promise<void> {
-  const completed = promex()
+async function adam (request: http.IncomingMessage): Promise<any> {
   const devnull = fs.createWriteStream(os.devNull)
 
-  request
-    .on('end', completed.callback)
-    .pipe(devnull)
+  request.pipe(devnull)
 
-  return completed
+  return 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/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)

package/source/Mapping.ts

@@ -38,6 +38,8 @@ class QueryableMapping extends Mapping {
 
 class InputMapping extends Mapping {
   public fit (input: any, _: unknown, parameters: Parameter[]): core.Request {
+    const request: core.Request = {}
+
     if (input === undefined && parameters.length > 0)
       input = {}
 
@@ -45,6 +47,9 @@ class InputMapping extends Mapping {
       for (const parameter of parameters)
         input[parameter.name] = parameter.value
 
-    return { input }
+    if (input !== undefined)
+      request.input = input
+
+    return request
   }
 }

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.criteria).toStrictEqual('(bar==2;baz==3);(foo==1);(qux==4)')
 })
 
 it('should set id parameter as query.id', async () => {

package/source/Query.ts

@@ -7,13 +7,20 @@ import type * as core from '@toa.io/core'
 export class Query {
   private readonly query: syntax.Query
   private readonly closed: boolean = false
+  private readonly prepend: ',' | ';' = ';'
 
   public constructor (query: syntax.Query) {
     if (query.criteria !== undefined) {
-      const open = query.criteria[query.criteria.length - 1] === ';'
+      if (query.criteria.endsWith(';'))
+        query.criteria = query.criteria.slice(0, -1)
+      else
+        this.closed = true
 
-      if (open) query.criteria = query.criteria.slice(0, -1)
-      else this.closed = true
+      if (query.criteria.startsWith(',') || query.criteria.startsWith(';')) {
+        this.prepend = query.criteria[0] as ',' | ';'
+
+        query.criteria = query.criteria.slice(1)
+      }
     }
 
     this.query = query
@@ -33,11 +40,7 @@ export class Query {
   }
 
   private fitCriteria (query: http.Query, parameters: Parameter[]): void {
-    const criteria: string[] = []
-
-    if (this.query.criteria !== undefined)
-      criteria.push(this.query.criteria)
-
+    const groups: CriteriaGroup[] = []
     const idx = parameters.findIndex((parameter) => parameter.name === 'id')
 
     if (idx !== -1) {
@@ -47,27 +50,28 @@ export class Query {
     }
 
     if (parameters.length > 0) {
-      const chunks = parameters
+      const criteria = parameters
         .map(({ name, value }) => `${name}==${value}`)
         .join(';')
 
-      criteria.push(chunks)
+      groups.push({ criteria, operator: this.prepend })
     }
 
+    if (this.query.criteria !== undefined)
+      groups.push({ criteria: this.query.criteria, operator: ';' })
+
     if (query.criteria !== undefined)
-      if (this.closed) throw new http.BadRequest('Query criteria is closed.')
-      else criteria.push(query.criteria)
-
-    switch (criteria.length) {
-      case 0:
-        break
-      case 1:
-        query.criteria = criteria[0]
-        break
-      default:
-        query.criteria = '(' + criteria.join(');(') + ')'
-        break
-    }
+      if (this.closed)
+        throw new http.BadRequest('Query criteria is closed')
+      else
+        groups.push({ criteria: query.criteria, operator: WHATEVER })
+
+    if (groups.length > 0)
+      query.criteria = groups.reduce((acc, { criteria, operator }, i) => {
+        return i === groups.length - 1
+          ? `${acc}(${criteria})`
+          : `${acc}(${criteria})${operator}`
+      }, '')
   }
 
   private fitRanges (qs: http.Query): void {
@@ -99,7 +103,14 @@ function fit (string: string, range: [number, number], name: string): number {
 
   if (number < range[0] || number > range[1])
     throw new http.BadRequest(`Query ${name} must be between ` +
-      `${range[0]} and ${range[1]} inclusive.`)
+      `${range[0]} and ${range[1]} inclusive`)
 
   return number
 }
+
+const WHATEVER = ';'
+
+interface CriteriaGroup {
+  criteria: string
+  operator: ',' | ';'
+}

package/source/RTD/Context.ts

@@ -1,16 +1,13 @@
-import { type Directives, type DirectivesFactory } from './Directives'
-import { type Endpoint, type EndpointsFactory } from './Endpoint'
+import { type DirectiveFactory } from './Directives'
+import { type EndpointsFactory } from './Endpoint'
+import type { Directive } from './syntax'
 
-export interface Context<
-  TEndpoint extends Endpoint = any,
-  TDirectives extends Directives<TDirectives> = any,
-  TExtension = any
-> {
+export interface Context<TExtension = any> {
   readonly protected: boolean
-  readonly endpoints: EndpointsFactory<TEndpoint>
+  readonly endpoints: EndpointsFactory
   readonly directives: {
-    readonly factory: DirectivesFactory
-    stack: TDirectives[]
+    readonly factory: DirectiveFactory
+    stack: Directive[]
   }
   readonly extension?: TExtension
 }

package/source/RTD/Directives.ts

@@ -1,9 +1,33 @@
+import type { Parameter } from './Match'
 import type * as syntax from './syntax'
+import type { Context, OutgoingMessage } from '../HTTP'
+import type { Output } from '../io'
 
-export interface Directives<TDirective = any> {
-  merge: (directive: TDirective) => void
+export interface Directives {
+  preflight: (context: Context, parameters: Parameter[]) => Promise<Output>
+  settle: (context: Context, response: OutgoingMessage) => Promise<void>
 }
 
-export interface DirectivesFactory<T = any> {
-  create: (directives: syntax.Directive[]) => T
+export interface DirectiveFactory {
+  create: (directives: syntax.Directive[]) => Directives
+}
+
+export interface DirectiveSet {
+  family: DirectiveFamily
+  directives: any[]
+}
+
+export interface DirectiveFamily<TDirective = any, TExtension = any> {
+  readonly name: string
+  readonly mandatory: boolean
+
+  create: (name: string, ...rest: any[]) => TDirective
+
+  preflight?: (directives: TDirective[],
+    request: Context & TExtension,
+    parameters: Parameter[]) => Output | Promise<Output>
+
+  settle?: (directives: TDirective[],
+    request: Context & TExtension,
+    response: OutgoingMessage) => void | Promise<void>
 }

package/source/RTD/Endpoint.ts

@@ -1,11 +1,13 @@
 import { type Context } from './Context'
+import type * as http from '../HTTP'
 import type * as syntax from './syntax'
+import type * as RTD from './index'
 
-export interface Endpoint<T extends Endpoint = any> {
-  call: T['call']
+export interface Endpoint {
+  call: (context: http.Context, parameters: RTD.Parameter[]) => Promise<http.OutgoingMessage>
   close: () => Promise<void>
 }
 
-export interface EndpointsFactory<T extends Endpoint<T> = any> {
-  create: (method: syntax.Method, context: Context) => T
+export interface EndpointsFactory {
+  create: (method: syntax.Method, context: Context) => Endpoint
 }

package/source/RTD/Match.ts

@@ -1,12 +1,7 @@
 import { type Node } from './Node'
-import { type Directives } from './Directives'
-import { type Endpoint } from './Endpoint'
 
-export interface Match<
-  TEndpoint extends Endpoint<TEndpoint> = any,
-  TDirectives extends Directives<TDirectives> = any
-> {
-  node: Node<TEndpoint, TDirectives>
+export interface Match {
+  node: Node
   parameters: Parameter[]
 }
 

package/source/RTD/Method.ts

@@ -1,14 +1,11 @@
-import { type Directives } from './Directives'
-import { type Endpoint } from './Endpoint'
+import type { Endpoint } from './Endpoint'
+import type { Directives } from './Directives'
 
-export class Method<
-  TEndpoint extends Endpoint<TEndpoint> = any,
-  TDirectives extends Directives<TDirectives> = any
-> {
-  public readonly endpoint: TEndpoint | null
-  public readonly directives: TDirectives
+export class Method {
+  public readonly endpoint: Endpoint | null
+  public readonly directives: Directives
 
-  public constructor (endpoint: TEndpoint | null, directives: TDirectives) {
+  public constructor (endpoint: Endpoint | null, directives: Directives) {
     this.endpoint = endpoint
     this.directives = directives
   }
@@ -18,7 +15,4 @@ export class Method<
   }
 }
 
-export type Methods<
-  TEndpoint extends Endpoint<TEndpoint> = any,
-  TDirectives extends Directives<TDirectives> = any
-> = Record<string, Method<TEndpoint, TDirectives>>
+export type Methods = Record<string, Method>