@toa.io/extensions.exposition 1.0.0-alpha.2 → 1.0.0-alpha.200

package/source/Endpoint.ts

@@ -1,28 +1,119 @@
-import { type Component, type Reply } from '@toa.io/core'
-import { type Remotes } from './Remotes'
+import { Readable } from 'node:stream'
+import { createHash } from 'node:crypto'
+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'
-import type * as http from './HTTP'
 
-export class Endpoint implements RTD.Endpoint<Endpoint> {
+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 (body: any, query: http.Query, parameters: RTD.Parameter[]): Promise<Reply> {
+  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
 
-    return await this.remote.invoke(this.endpoint, request)
+    const endpoint = this.remote.locator.id + '.' + this.endpoint
+
+    console.debug('Calling operation', { endpoint, request })
+
+    const reply = await this.remote.invoke(this.endpoint, request)
+
+    console.debug('Received reply', { endpoint, reply: reply instanceof Readable ? '[Readable stream]' : reply })
+
+    if (reply instanceof Error)
+      throw new http.UnprocessableEntity(reply)
+
+    const message: http.OutgoingMessage = {}
+
+    // etag
+    if (reply !== null && reply !== undefined) {
+      const etag = context.request.headers['if-none-match']
+
+      message.headers ??= new Headers()
+
+      if (typeof reply === 'object' && '_version' in reply)
+        if (etag !== undefined && reply._version === this.version(etag)) {
+          message.status = 304
+          message.headers.set('etag', etag)
+
+          return message
+        } else
+          message.headers.set('etag', `"${reply._version.toString()}"`)
+      else if (!(reply instanceof Readable)) {
+        const hash = `"${createHash('sha256').update(JSON.stringify(reply)).digest('hex')}"`
+
+        if (etag === hash) {
+          message.status = 304
+          message.headers.set('etag', etag)
+
+          return message
+        } else
+          message.headers.set('etag', hash)
+      }
+    }
+
+    // last-modified
+    if (typeof reply === 'object' && reply !== null && ('_updated' in reply || '_created' in reply)) {
+      const timestamp: string = reply._updated ?? reply._created
+      const date = new Date(timestamp)
+
+      message.headers ??= new Headers()
+      message.headers.set('last-modified', date.toUTCString())
+    }
+
+    message.body = reply
+
+    return message
+  }
+
+  public async explain (parameters: RTD.Parameter[]): Promise<Introspection> {
+    this.remote ??= await this.discovery
+
+    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> {
@@ -30,9 +121,28 @@ export class Endpoint implements RTD.Endpoint<Endpoint> {
 
     await this.remote.disconnect(INTERRUPT)
   }
+
+  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 && this.mapping.queryable)
+      query.version = this.version(etag)
+
+    return query
+  }
+
+  private version (etag: string): number {
+    const match = etag.match(ETAG)
+
+    if (match === null)
+      throw new http.BadRequest('Invalid ETag')
+
+    return Number.parseInt(match.groups!.version)
+  }
 }
 
-export class EndpointsFactory implements RTD.EndpointsFactory<Endpoint> {
+export class EndpointsFactory implements RTD.EndpointsFactory {
   private readonly remotes: Remotes
 
   public constructor (remotes: Remotes) {
@@ -41,19 +151,21 @@ export class EndpointsFactory implements RTD.EndpointsFactory<Endpoint> {
 
   public create (method: RTD.syntax.Method, context: Context): Endpoint {
     if (method.mapping === undefined)
-      throw new Error('Cannot create Endpoint without mapping.')
+      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.')
+      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)
   }
 }
 
+const ETAG = /^(W\/)?"(?<version>\d{1,32})"$/
+
 const INTERRUPT = true

package/source/Factory.ts

@@ -1,14 +1,20 @@
+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 { type Endpoint, EndpointsFactory } from './Endpoint'
+import { Tree } from './RTD'
+import { EndpointsFactory } from './Endpoint'
 import { families, interceptors } from './directives'
-import { type Directives, DirectivesFactory } from './Directive'
+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'
 
 export class Factory implements extensions.Factory {
@@ -18,28 +24,41 @@ export class Factory implements extensions.Factory {
     this.boot = boot
   }
 
-  public tenant (locator: Locator, node: syntax.Node): Connector {
-    const broadcast = this.boot.bindings.broadcast(CHANNEL, locator.id)
+  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 broadcast = this.boot.bindings.broadcast(CHANNEL)
-    const server = Server.create({ methods: syntax.verbs, debug })
+    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)
     const directives = new DirectivesFactory(families, remotes)
     const interception = new Interception(interceptors)
-    const tree = new Tree<Endpoint, Directives>(node, methods, directives)
+    const tree = new Tree(node, methods, directives)
 
     const composition = new Composition(this.boot)
-    const gateway = new Gateway(broadcast, server, tree, interception)
+    const gateway = new Gateway(broadcast, tree, interception)
 
     gateway.depends(remotes)
     gateway.depends(composition)
+
+    server.attach(gateway.process.bind(gateway))
     server.depends(gateway)
 
     return server

package/source/Gateway.ts

@@ -1,95 +1,121 @@
+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 { Interceptor } from './Interception'
-import type { Maybe } from '@toa.io/types'
-import type { Method, Parameter, Tree } from './RTD'
+import type { Interception } from './Interception'
+import type { Node, Method, Parameter, Tree, Match } 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 interceptor: Interceptor
-  private readonly server: Connector
+  private readonly tree: Tree
+  private readonly interceptor: Interception
+  private readonly merged = new Set<string>()
 
-  // eslint-disable-next-line max-params, max-len
-  public constructor (broadcast: Broadcast, server: http.Server, tree: Tree<Endpoint, Directives>, interception: Interceptor) {
+  public constructor (broadcast: Broadcast, tree: Tree, interception: Interception) {
     super()
 
     this.broadcast = broadcast
     this.tree = tree
     this.interceptor = interception
-    this.server = server
 
     this.depends(broadcast)
-    // this.depends(server)
+  }
+
+  public async process (context: http.Context): Promise<http.OutgoingMessage> {
+    const interception = await context.timing.capture('intercept',
+      this.interceptor.intercept(context))
+
+    if (interception !== null)
+      return interception
+
+    const { node, parameters } = this.match(context)
+
+    if (context.request.method === 'OPTIONS')
+      return await this.explain(node, parameters)
+
+    let verb = context.request.method
+
+    if (!(verb in node.methods) && verb === 'HEAD' && 'GET' in node.methods)
+      verb = 'GET'
 
-    server.attach(this.process.bind(this))
+    if (!(verb in node.methods))
+      throw new http.MethodNotAllowed()
+
+    const method = node.methods[verb]
+
+    const interruption = await context.timing.capture('preflight',
+      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)).catch(rethrow)
+
+    return response
   }
 
   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.')
+    this.tree.dispose()
+
+    console.info('Gateway is closed')
   }
 
-  private async process (request: http.IncomingMessage): Promise<http.OutgoingMessage> {
-    const interception = await this.interceptor.intercept(request)
+  private match (context: http.Context): Match {
+    const match = this.tree.match(context.url.pathname)
 
-    if (interception !== null)
-      return interception
+    if (match === null)
+      throw new http.NotFound('Route not found')
 
-    const match = this.tree.match(request.path)
+    if (match.node.forward === null)
+      return match
 
-    if (match === null)
-      throw new http.NotFound()
+    const destination = match.node.forward.replace(/\/:([^/]+)/g,
+      (_, name) => {
+        const value = match.parameters.find((parameter) => parameter.name === name)?.value
 
-    const { node, parameters } = match
+        assert.ok(value !== undefined, `Forwarded parameter '${name}' not found`)
 
-    if (!(request.method in node.methods))
-      throw new http.MethodNotAllowed()
+        return `/${value}`
+      })
 
-    const method = node.methods[request.method]
-    const interruption = await method.directives.preflight(request, parameters)
-    const response = interruption ?? await this.call(method, request, parameters)
+    const forward = this.tree.match(destination)
 
-    await method.directives.settle(request, response)
+    assert.ok(forward !== null, 'Forwarded route not found')
 
-    return response
+    return forward
   }
 
-  private async call
-  (method: Method<Endpoint, Directives>, request: http.IncomingMessage, parameters: Parameter[]):
-  Promise<http.OutgoingMessage> {
-    if (request.path[request.path.length - 1] !== '/')
-      throw new http.NotFound('Trailing slash is required.')
+  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')
 
-    if (request.encoder === null)
+    if (context.encoder === null)
       throw new http.NotAcceptable()
 
     if (method.endpoint === null)
       throw new http.MethodNotAllowed()
 
-    const body = await request.parse()
-
-    if ('embed' in request && typeof body === 'object' && body !== null)
-      Object.assign(body, request.embed)
-
-    const reply = await method.endpoint
-      .call(body, request.query, parameters)
-      .catch(rethrow) as Maybe<unknown>
+    return await method.endpoint
+      .call(context, parameters)
+      .catch(rethrow) as http.OutgoingMessage
+  }
 
-    if (reply instanceof Error)
-      throw new http.Conflict(reply)
+  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: reply }
+    return { body, headers }
   }
 
   private async discover (): Promise<void> {
@@ -98,15 +124,36 @@ export class Gateway extends Connector {
   }
 
   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) {
+      const message = exception instanceof Error ? exception.message : 'Unknown error'
+
+      console.error('Branch merge exception', { message, ...attributes })
     }
   }
 }
 
-type Broadcast = bindings.Broadcast<Label>
+export type Broadcast = bindings.Broadcast<Label>

package/source/HTTP/Context.ts

@@ -0,0 +1,92 @@
+import crypto from 'node:crypto'
+import Negotiator from 'negotiator'
+import { console } from 'openspan'
+import { Timing } from './Timing'
+import { type Format, formats, types } from './formats'
+import { read } from './messages'
+import type { OutgoingMessage } from './messages'
+import type * as http from 'node:http'
+
+export class Context {
+  public readonly id: string
+  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 (authority: string, request: IncomingMessage, properties: Properties) {
+    this.authority = authority
+    this.request = request
+
+    this.id = crypto.randomUUID()
+    this.url = new URL(request.url, `https://${request.headers.host}`)
+    this.timing = new Timing(properties.trace)
+    this.debug = properties.debug
+    this.log(request)
+
+    if (this.request.headers.accept !== undefined) {
+      const match = SUBTYPE.exec(this.request.headers.accept)
+
+      if (match !== null) {
+        const {
+          type,
+          subtype,
+          suffix
+        } = match.groups!
+
+        this.request.headers.accept = `${type}/${suffix}`
+        this.subtype = subtype
+      }
+    }
+
+    const negotiator = new Negotiator(this.request)
+    const mediaType = negotiator.mediaType(types)
+
+    if (mediaType !== undefined)
+      this.encoder = formats[mediaType]
+  }
+
+  public async body<T> (): Promise<T> {
+    let value = await read(this)
+
+    for (const transform of this.pipelines.body)
+      value = await transform(value)
+
+    return 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 {
+  url: string
+  method: string
+}
+
+interface Pipelines {
+  body: Array<(input: unknown) => unknown>
+  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})$/