@toa.io/extensions.exposition 1.0.0-alpha.19 → 1.0.0-alpha.190

package/source/Annotation.ts

@@ -1,8 +1,11 @@
+import type { Resources } from '@toa.io/operations'
+
 export interface Annotation {
-  host?: string
+  authorities: Record<string, string>
   class?: string
+  resources?: Resources
   annotations?: Record<string, string>
-  debug: boolean
-  trace: boolean
+  debug?: boolean
+  trace?: boolean
   '/'?: object // parsed and validated by RTD.syntax.parse
 }

package/source/Branch.ts

@@ -5,4 +5,5 @@ export interface Branch {
   component: string
   isolated: boolean
   node: RTD.Node
+  version: string
 }

package/source/Composition.ts

@@ -18,12 +18,6 @@ export class Composition extends Connector {
     await composition.connect()
 
     this.depends(composition)
-
-    console.info('Composition complete.')
-  }
-
-  protected override dispose (): void {
-    console.info('Composition shutdown complete.')
   }
 }
 

package/source/Context.ts

@@ -5,4 +5,5 @@ export type Context = RTD.Context<Extension>
 interface Extension {
   namespace: string
   component: string
+  version: string
 }

package/source/Directive.test.ts

@@ -11,14 +11,16 @@ const families: Array<jest.MockedObjectDeep<DirectiveFamily>> = [
     mandatory: true,
     create: jest.fn((_0: any, _1: any, _2: any) => generate() as any),
     preflight: jest.fn(),
-    settle: jest.fn()
+    settle: jest.fn(),
+    dispose: jest.fn()
   },
   {
     name: 'bar',
     mandatory: false,
     create: jest.fn((_0: string, _1: any, _2: any) => generate() as any),
     preflight: jest.fn(),
-    settle: jest.fn()
+    settle: jest.fn(),
+    dispose: jest.fn()
   }
 ]
 
@@ -65,7 +67,7 @@ it('should throw error if directive family is not found', async () => {
   }
 
   expect(() => factory.create([declaration]))
-    .toThrowError(`Directive family '${declaration.family}' is not found.`)
+    .toThrow(`Directive family '${declaration.family}' is not found`)
 })
 
 it('should apply directive', async () => {

package/source/Directive.ts

@@ -11,17 +11,24 @@ export class Directives implements RTD.Directives {
   }
 
   public async preflight (context: Context, parameters: RTD.Parameter[]): Promise<Output> {
+    let output = null
+
     for (const set of this.sets) {
       if (set.family.preflight === undefined)
         continue
 
-      const output = await set.family.preflight(set.directives, context, parameters)
+      const out = await set.family.preflight(set.directives, context, parameters)
+
+      if (out === null)
+        continue
 
       if (output !== null)
-        return output
+        throw new Error('Multiple preflight directives responded')
+      else
+        output = out
     }
 
-    return null
+    return output
   }
 
   public async settle (context: Context, response: OutgoingMessage): Promise<void> {
@@ -29,12 +36,18 @@ export class Directives implements RTD.Directives {
       if (set.family.settle !== undefined)
         await set.family.settle(set.directives, context, response)
   }
+
+  public dispose (): void {
+    for (const set of this.sets)
+      set.family.dispose?.(set.directives)
+  }
 }
 
 export class DirectivesFactory implements RTD.DirectiveFactory {
   private readonly remotes: Remotes
   private readonly families: Record<string, RTD.DirectiveFamily> = {}
   private readonly mandatory: string[] = []
+  private readonly instances: Directives[] = []
 
   public constructor (families: RTD.DirectiveFamily[], remotes: Remotes) {
     for (const family of families) {
@@ -58,7 +71,7 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
       const family = this.families[declaration.family]
 
       if (family === undefined)
-        throw new Error(`Directive family '${declaration.family}' is not found.`)
+        throw new Error(`Directive family '${declaration.family}' is not found`)
 
       const directive = family.create(declaration.name, declaration.value, this.remotes)
 
@@ -81,16 +94,27 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
         directives
       })
 
-    return new Directives(sets)
+    const directives = new Directives(sets)
+
+    this.instances.push(directives)
+
+    return directives
+  }
+
+  public dispose (): void {
+    for (const directives of this.instances)
+      directives.dispose()
   }
 }
 
 export const shortcuts: RTD.syntax.Shortcuts = new Map([
   ['anonymous', 'auth:anonymous'],
+  ['anyone', 'auth:anyone'],
   ['id', 'auth:id'],
   ['role', 'auth:role'],
   ['rule', 'auth:rule'],
   ['incept', 'auth:incept'],
   ['input', 'io:input'],
-  ['output', 'io:output']
+  ['output', 'io:output'],
+  ['languages', 'map:languages']
 ])

package/source/Endpoint.ts

@@ -1,49 +1,80 @@
-import { type Component } 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'
 
 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
 
+    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.Conflict(reply)
+      throw new http.UnprocessableEntity(reply)
 
     const message: http.OutgoingMessage = {}
 
-    if (typeof reply === 'object' && reply !== null && '_version' in reply) {
+    // etag
+    if (reply !== null && reply !== undefined) {
       const etag = context.request.headers['if-none-match']
 
       message.headers ??= new Headers()
 
-      if (etag !== undefined && reply._version === this.version(etag)) {
-        message.status = 304
-        message.headers.set('etag', etag)
+      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)
 
-        return message
-      } else
-        message.headers.set('etag', `"${reply._version.toString()}"`)
+      message.headers ??= new Headers()
+      message.headers.set('last-modified', date.toUTCString())
     }
 
     message.body = reply
@@ -51,6 +82,40 @@ export class Endpoint implements RTD.Endpoint {
     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> {
     this.remote ??= await this.discovery
 
@@ -61,7 +126,7 @@ export class Endpoint implements RTD.Endpoint {
     const query: http.Query = Object.fromEntries(context.url.searchParams)
     const etag = context.request.headers['if-match']
 
-    if (etag !== undefined)
+    if (etag !== undefined && this.mapping.queryable)
       query.version = this.version(etag)
 
     return query
@@ -71,7 +136,7 @@ export class Endpoint implements RTD.Endpoint {
     const match = etag.match(ETAG)
 
     if (match === null)
-      throw new http.BadRequest('Invalid ETag.')
+      throw new http.BadRequest('Invalid ETag')
 
     return Number.parseInt(match.groups!.version)
   }
@@ -86,21 +151,21 @@ export class EndpointsFactory implements RTD.EndpointsFactory {
 
   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 = /^"(?<version>\d{1,32})"$/
+const ETAG = /^(W\/)?"(?<version>\d{1,32})"$/
 
 const INTERRUPT = true

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,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('Route not found')
+    if (context.request.method === 'OPTIONS')
+      return await this.explain(node, parameters)
+
+    let verb = context.request.method
 
-    const {
-      node,
-      parameters
-    } = match
+    if (!(verb in node.methods) && verb === 'HEAD' && 'GET' in node.methods)
+      verb = 'GET'
 
-    if (!(context.request.method in node.methods))
+    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,43 @@ 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.')
+    this.tree.dispose()
+
+    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()
@@ -81,19 +110,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,6 @@
+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'
@@ -6,22 +8,29 @@ 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 (request: IncomingMessage, trace = false) {
+  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(trace)
+    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)
@@ -46,11 +55,22 @@ export class Context {
   }
 
   public async body<T> (): Promise<T> {
-    const value = await read(this)
+    let value = await read(this)
 
-    return this.pipelines.body.length === 0
-      ? value
-      : this.pipelines.body.reduce((value, transform) => transform(value), value)
+    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 })
   }
 }
 
@@ -61,7 +81,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})$/