@toa.io/extensions.exposition 1.0.0-alpha.8 → 1.0.0-alpha.81

package/source/Endpoint.ts

@@ -1,34 +1,41 @@
-import { type Component } from '@toa.io/core'
-import { type Remotes } from './Remotes'
+import { console } from 'openspan'
 import { Mapping } from './Mapping'
-import { type Context } from './Context'
 import * as http from './HTTP'
+import type { Introspection, Schema } from './Introspection'
+import type { Remote } from '@toa.io/core'
+import type { Remotes } from './Remotes'
+import type { Context } from './Context'
 import type * as RTD from './RTD'
 
 export class Endpoint implements RTD.Endpoint {
   private readonly endpoint: string
   private readonly mapping: Mapping
-  private readonly discovery: Promise<Component>
-  private remote: Component | null = null
+  private readonly discovery: Promise<Remote>
+  private remote: Remote | null = null
 
-  public constructor (endpoint: string, mapping: Mapping, discovery: Promise<Component>) {
+  public constructor (endpoint: string, mapping: Mapping, discovery: Promise<Remote>) {
     this.endpoint = endpoint
     this.mapping = mapping
     this.discovery = discovery
   }
 
-  public async call
-  (context: http.Context, parameters: RTD.Parameter[]): Promise<http.OutgoingMessage> {
+  public async call (context: http.Context, parameters: RTD.Parameter[]): Promise<http.OutgoingMessage> {
     const body = await context.body()
     const query = this.query(context)
     const request = this.mapping.fit(body, query, parameters)
 
     this.remote ??= await this.discovery
 
+    if (context.debug)
+      console.debug('Calling operation', {
+        endpoint: this.remote.locator.id + '.' + this.endpoint,
+        request
+      })
+
     const reply = await this.remote.invoke(this.endpoint, request)
 
     if (reply instanceof Error)
-      throw new http.Conflict(reply)
+      throw new http.UnprocessableEntity(reply)
 
     const message: http.OutgoingMessage = {}
 
@@ -42,10 +49,8 @@ export class Endpoint implements RTD.Endpoint {
         message.headers.set('etag', etag)
 
         return message
-      } else {
+      } else
         message.headers.set('etag', `"${reply._version.toString()}"`)
-        delete reply._version
-      }
     }
 
     message.body = reply
@@ -53,6 +58,41 @@ export class Endpoint implements RTD.Endpoint {
     return message
   }
 
+  public async explain (parameters: RTD.Parameter[]): Promise<Introspection> {
+    this.remote ??= await this.discovery
+
+    // eslint-disable-next-line @typescript-eslint/await-thenable
+    const operation = await this.remote.explain(this.endpoint)
+
+    let route: Record<string, Schema> | null = null
+
+    if (operation.input?.type === 'object')
+      for (const parameter of parameters) {
+        const schema = operation.input.properties[parameter.name]
+
+        // eslint-disable-next-line max-depth
+        if (schema !== undefined) {
+          route ??= {}
+          route[parameter.name] = schema
+
+          delete operation.input.properties[parameter.name]
+        }
+      }
+
+    const query = this.mapping.explain(operation)
+    const introspection: Introspection = {}
+
+    if (route !== null)
+      introspection.route = route
+
+    if (query !== null)
+      introspection.query = query
+
+    Object.assign(introspection, operation)
+
+    return introspection
+  }
+
   public async close (): Promise<void> {
     this.remote ??= await this.discovery
 
@@ -91,13 +131,13 @@ export class EndpointsFactory implements RTD.EndpointsFactory {
       throw new Error('Cannot create Endpoint without mapping.')
 
     const mapping = Mapping.create(method.mapping.query)
-    const namespace = method.mapping.namespace ?? context.extension?.namespace
-    const component = method.mapping.component ?? context.extension?.component
+    const namespace = method.mapping.namespace ?? context.extension.namespace
+    const component = method.mapping.component ?? context.extension.component
 
     if (namespace === undefined || component === undefined)
       throw new Error('Annotation endpoints must be fully qualified.')
 
-    const discovery = this.remotes.discover(namespace, component)
+    const discovery = this.remotes.discover(namespace, component, context.extension.version)
 
     return new Endpoint(method.mapping.endpoint, mapping, discovery)
   }

package/source/Factory.ts

@@ -1,14 +1,19 @@
+import assert from 'node:assert'
+import { decode } from '@toa.io/generic'
 import { Tenant } from './Tenant'
 import { Gateway } from './Gateway'
 import { Remotes } from './Remotes'
-import { Tree, syntax } from './RTD'
-import { Server } from './HTTP'
+import { Tree } from './RTD'
 import { EndpointsFactory } from './Endpoint'
 import { families, interceptors } from './directives'
 import { DirectivesFactory } from './Directive'
 import { Composition } from './Composition'
 import * as root from './root'
 import { Interception } from './Interception'
+import * as http from './HTTP'
+import type { Manifest } from '@toa.io/norm'
+import type { Branch } from './Branch'
+import type { syntax } from './RTD'
 import type { Broadcast } from './Gateway'
 import type { Connector, Locator, extensions } from '@toa.io/core'
 
@@ -19,23 +24,27 @@ export class Factory implements extensions.Factory {
     this.boot = boot
   }
 
-  public tenant (locator: Locator, node: syntax.Node): Connector {
+  public tenant (locator: Locator, node: syntax.Node, manifest: Manifest): Connector {
     const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL, locator.id)
 
-    return new Tenant(broadcast, locator, node)
+    const branch: Branch = {
+      namespace: locator.namespace,
+      component: locator.name,
+      isolated: locator.namespace === 'identity',
+      node,
+      version: manifest.version
+    }
+
+    return new Tenant(broadcast, branch)
   }
 
   public service (): Connector | null {
-    const debug = process.env.TOA_EXPOSITION_DEBUG === '1'
-    const trace = process.env.TOA_EXPOSITION_TRACE === '1'
-    const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL)
-
-    const server = Server.create({
-      methods: syntax.verbs,
-      debug,
-      trace
-    })
+    assert.ok(process.env.TOA_EXPOSITION_PROPERTIES,
+      'TOA_EXPOSITION_PROPERTIES is undefined')
 
+    const options = decode<http.Options>(process.env.TOA_EXPOSITION_PROPERTIES)
+    const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL)
+    const server = http.Server.create({ ...options })
     const remotes = new Remotes(this.boot)
     const node = root.resolve()
     const methods = new EndpointsFactory(remotes)

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,15 +31,10 @@ export class Gateway extends Connector {
     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()
@@ -44,12 +42,13 @@ export class Gateway extends Connector {
     const method = node.methods[context.request.method]
 
     const interruption = await context.timing.capture('preflight',
-      method.directives.preflight(context, parameters))
+      method.directives.preflight(context, parameters)).catch(rethrow)
 
     const response = interruption ??
       await context.timing.capture('call', this.call(method, context, parameters))
 
-    await context.timing.capture('settle', method.directives.settle(context, response))
+    await context.timing.capture('settle',
+      method.directives.settle(context, response)).catch(rethrow)
 
     return response
   }
@@ -57,17 +56,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()
@@ -80,19 +103,44 @@ 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)
+
     try {
       this.tree.merge(branch.node, branch)
 
-      console.info('Resource branch of ' +
-        `'${branch.namespace}.${branch.component}' has been merged.`)
+      console.info('Branch merged', {
+        namespace: branch.namespace,
+        component: branch.component,
+        version: branch.version
+      })
     } catch (exception) {
-      console.error(exception)
+      console.error('Branch merge exception', exception as Error)
     }
   }
 }

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)
@@ -52,6 +60,16 @@ export class Context {
       ? 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 })
+  }
 }
 
 export interface IncomingMessage extends http.IncomingMessage {
@@ -64,4 +82,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,10 @@
 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,32 +13,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 +38,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('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 {
@@ -72,18 +70,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 +115,17 @@ 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)
     }
@@ -131,28 +134,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 = {
-  methods: new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS']),
+export const PORT = 8000
+export const DELAY = 3 // seconds
+
+const DEFAULTS: Omit<Properties, 'authorities'> = {
+  methods: new Set<string>(['OPTIONS', 'GET', '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 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)
@@ -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