@toa.io/extensions.exposition 1.0.0-alpha.284 → 1.0.0-alpha.286

package/source/Factory.ts

@@ -18,22 +18,24 @@ import * as http from './HTTP/index.js'
 import type { Branch } from './Branch.js'
 import type { syntax } from './RTD/index.js'
 import type { Broadcast } from './Gateway.js'
-import type { Connector, Locator, extensions } from '@toa.io/core'
+import type { Connector, Locator } from '@toa.io/core'
+import type { extensions } from '@toa.io/core/types'
 
 export class Factory implements extensions.Factory {
   private readonly host: Host
 
-  public constructor (host: Host) {
+  public constructor(host: Host) {
     this.host = host
   }
 
-  public async tenant (locator: Locator, node: syntax.Node): Promise<Connector> {
+  public async tenant(locator: Locator, node: syntax.Node): Promise<Connector> {
     const broadcast: Broadcast = await this.host.broadcast(CHANNEL, locator.id)
     const hash = createHash('sha256').update(JSON.stringify(node)).digest('hex')
 
     // no timestamp: the tenant stamps each announcement with its own start time
     const branch: Omit<Branch, 'timestamp'> = {
-      namespace: locator.namespace,
+      // boot only ever hands a tenant a component's locator, which always has a namespace
+      namespace: locator.namespace!,
       component: locator.name,
       isolated: locator.namespace === 'identity',
       node,
@@ -43,9 +45,11 @@ export class Factory implements extensions.Factory {
     return new Tenant(broadcast, branch)
   }
 
-  public async service (): Promise<Connector | null> {
-    assert.ok(process.env.TOA_EXPOSITION_PROPERTIES,
-      'TOA_EXPOSITION_PROPERTIES is undefined')
+  public async service(): Promise<Connector | null> {
+    assert.ok(
+      process.env.TOA_EXPOSITION_PROPERTIES,
+      'TOA_EXPOSITION_PROPERTIES is undefined'
+    )
 
     configureLogs()
 
@@ -62,7 +66,14 @@ export class Factory implements extensions.Factory {
     const composition = new Composition(this.host)
     const dispatcher = options.rpc === undefined ? null : new Dispatcher(options.rpc)
     const mcp = options.mcp === undefined ? null : new Model(options.mcp, tree)
-    const gateway = new Gateway(broadcast, tree, interception, directives, dispatcher, mcp)
+    const gateway = new Gateway(
+      broadcast,
+      tree,
+      interception,
+      directives,
+      dispatcher,
+      mcp
+    )
 
     gateway.depends(remotes)
     gateway.depends(composition)
@@ -80,16 +91,19 @@ const CHANNEL = 'exposition'
 const LOGS_PREFIX = 'TOA_TELEMETRY_LOGS'
 const TRACES_ENV = 'TOA_TELEMETRY_TRACES'
 
-function configureLogs (): void {
+function configureLogs(): void {
   const globEnv = process.env[LOGS_PREFIX]
   const level: LevelName = process.env.TOA_DEV === '1' ? 'trace' : 'info'
-  const options = globEnv === undefined ? { level } : JSON.parse(globEnv) as { level?: LevelName }
+  const options =
+    globEnv === undefined ? { level } : (JSON.parse(globEnv) as { level?: LevelName })
 
   console.configure({ level: options.level ?? level })
 
   const tracesEnv = process.env[TRACES_ENV]
 
-  traces(tracesEnv === undefined ? development() : JSON.parse(tracesEnv) as TracesOptions)
+  traces(
+    tracesEnv === undefined ? development() : (JSON.parse(tracesEnv) as TracesOptions)
+  )
 }
 
 /**
@@ -101,7 +115,7 @@ function configureLogs (): void {
  * The gateway boots without the telemetry extension, hence the copy of
  * `extensions/telemetry/source/extension.ts`.
  */
-function development (): TracesOptions {
+function development(): TracesOptions {
   const local = process.env.TOA_DEV === '1' || process.env.TOA_BOOT_TRACE === '1'
 
   return local ? { exporters: { console: {} } } : {}

package/source/Gateway.ts

@@ -1,7 +1,8 @@
 import assert from 'node:assert'
 import { setTimeout } from 'node:timers/promises'
 import { console } from 'openspan'
-import { type bindings, Connector } from '@toa.io/core'
+import { Connector } from '@toa.io/core'
+import type { bindings } from '@toa.io/core/types'
 import * as http from './HTTP/index.js'
 import { MCP, RPC } from './const.js'
 import { rethrow } from './exceptions.js'
@@ -9,7 +10,14 @@ import { decide } from './Branch.js'
 import type { Interception } from './Interception.js'
 import type { Dispatcher } from './RPC/index.js'
 import type { Server } from './MCP/index.js'
-import type { DirectiveFactory, Method, Node, Parameter, Tree, Match } from './RTD/index.js'
+import type {
+  DirectiveFactory,
+  Method,
+  Node,
+  Parameter,
+  Tree,
+  Match
+} from './RTD/index.js'
 import type { Label } from './discovery.js'
 import type { Branch, Exposed } from './Branch.js'
 
@@ -32,8 +40,14 @@ export class Gateway extends Connector {
   private resolveFirstMerge: (() => void) | null = null
 
   // eslint-disable-next-line max-params
-  public constructor (broadcast: Broadcast, tree: Tree, interception: Interception,
-    directives: DirectiveFactory, dispatcher: Dispatcher | null, mcp: Server | null) {
+  public constructor(
+    broadcast: Broadcast,
+    tree: Tree,
+    interception: Interception,
+    directives: DirectiveFactory,
+    dispatcher: Dispatcher | null,
+    mcp: Server | null
+  ) {
     super()
 
     this.broadcast = broadcast
@@ -46,22 +60,18 @@ export class Gateway extends Connector {
     this.depends(broadcast)
   }
 
-  public async process (context: http.Context): Promise<http.OutgoingMessage> {
-    const interception = await context.timing.capture('intercept',
-      this.interceptor.intercept(context))
+  public async process(context: http.Context): Promise<http.OutgoingMessage> {
+    const interception = await this.interceptor.intercept(context)
 
-    if (interception !== null)
-      return interception
+    if (interception !== null) return interception
 
     // request-scoped, before anything is routed: this is where a credential is read
-    await context.timing.capture('preflight',
-      this.directives.preflight(context)).catch(rethrow)
+    await this.directives.preflight(context).catch(rethrow)
 
     const response = await this.endpoint(context)
 
     // request-scoped, on whatever is going back: this is where a credential is re-issued
-    await context.timing.capture('depart',
-      this.directives.depart(context, response)).catch(rethrow)
+    await this.directives.depart(context, response).catch(rethrow)
 
     return response
   }
@@ -70,14 +80,14 @@ export class Gateway extends Connector {
    * What answers the request: a pinned endpoint that makes calls of its own, or the route
    * the path names.
    */
-  private async endpoint (context: http.Context): Promise<http.OutgoingMessage> {
+  private async endpoint(context: http.Context): Promise<http.OutgoingMessage> {
     const route: http.Processor = async (call) => await this.route(call)
 
     if (this.dispatcher !== null && context.url.pathname === RPC)
-      return await context.timing.capture('rpc', this.dispatcher.dispatch(context, route))
+      return await this.dispatcher.dispatch(context, route)
 
     if (this.mcp !== null && context.url.pathname === MCP)
-      return await context.timing.capture('mcp', this.mcp.process(context, route))
+      return await this.mcp.process(context, route)
 
     return await this.route(context)
   }
@@ -86,7 +96,7 @@ export class Gateway extends Connector {
    * One call: everything that needs a node. A request makes one of these, and a request
    * that carries several calls makes one per call.
    */
-  private async route (context: http.Context): Promise<http.OutgoingMessage> {
+  private async route(context: http.Context): Promise<http.OutgoingMessage> {
     const { node, parameters } = this.match(context)
 
     if (context.request.method === 'OPTIONS')
@@ -94,39 +104,35 @@ export class Gateway extends Connector {
 
     let verb = context.request.method
 
-    if (!(verb in node.methods) && verb === 'HEAD' && 'GET' in node.methods)
-      verb = 'GET'
+    if (!(verb in node.methods) && verb === 'HEAD' && 'GET' in node.methods) verb = 'GET'
 
-    if (!(verb in node.methods))
-      throw new http.MethodNotAllowed()
+    if (!(verb in node.methods)) throw new http.MethodNotAllowed()
 
     const method = node.methods[verb]
 
-    const interruption = await context.timing.capture('precall',
-      method.directives.precall(context, parameters)).catch(rethrow)
+    const interruption = await method.directives
+      .precall(context, parameters)
+      .catch(rethrow)
+    const response = interruption ?? (await this.call(method, context, parameters))
 
-    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)
+    await method.directives.settle(context, response).catch(rethrow)
 
     return response
   }
 
-  protected override async open (): Promise<void> {
+  protected override async open(): Promise<void> {
     await this.discover()
 
     // what is served besides the tree, so that turning one on can be seen to have worked
     const pinned: string[] = []
 
-    if (this.dispatcher !== null)
-      pinned.push(RPC)
+    if (this.dispatcher !== null) pinned.push(RPC)
 
-    if (this.mcp !== null)
-      pinned.push(MCP)
+    if (this.mcp !== null) pinned.push(MCP)
 
-    console.info('Gateway started', { endpoints: pinned.length === 0 ? 'none' : pinned.join(' ') })
+    console.info('Gateway started', {
+      endpoints: pinned.length === 0 ? 'none' : pinned.join(' ')
+    })
   }
 
   /**
@@ -135,17 +141,17 @@ export class Gateway extends Connector {
    * ticker firing in between calls an endpoint that has just been unbound, and reports the
    * refusal as a failure to reconcile.
    */
-  protected override async close (): Promise<void> {
+  protected override async close(): Promise<void> {
     this.stopped = true
 
     this.tree.dispose()
   }
 
-  protected override dispose (): void {
+  protected override dispose(): void {
     console.info('Gateway is closed')
   }
 
-  private match (context: http.Context): Match {
+  private match(context: http.Context): Match {
     const match = this.tree.match(context.url.pathname)
 
     if (match === null) {
@@ -155,17 +161,15 @@ export class Gateway extends Connector {
       throw new http.NotFound('Route not found')
     }
 
-    if (match.node.forward === null)
-      return match
+    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
+    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`)
+      assert.ok(value !== undefined, `Forwarded parameter '${name}' not found`)
 
-        return `/${value}`
-      })
+      return `/${value}`
+    })
 
     const forward = this.tree.match(destination)
 
@@ -174,23 +178,28 @@ export class Gateway extends Connector {
     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')
 
-    if (context.encoder === null)
-      throw new http.NotAcceptable()
+    if (context.encoder === null) throw new http.NotAcceptable()
 
-    if (method.endpoint === null)
-      throw new http.MethodNotAllowed()
+    if (method.endpoint === null) throw new http.MethodNotAllowed()
 
-    return await method.endpoint
+    return (await method.endpoint
       .call(context, parameters)
-      .catch(rethrow) as http.OutgoingMessage
+      .catch(rethrow)) as http.OutgoingMessage
   }
 
-  private async explain (context: http.Context, node: Node,
-    parameters: Parameter[]): Promise<http.OutgoingMessage> {
+  private async explain(
+    context: http.Context,
+    node: Node,
+    parameters: Parameter[]
+  ): Promise<http.OutgoingMessage> {
     const body = await node.explain(context, parameters)
     const verbs = Object.keys(body)
 
@@ -201,7 +210,7 @@ export class Gateway extends Connector {
     return { body, headers: new Headers({ allow: verbs.join(', ') }) }
   }
 
-  private async discover (): Promise<void> {
+  private async discover(): Promise<void> {
     const first = new Promise<void>((resolve) => {
       this.resolveFirstMerge = resolve
     })
@@ -217,43 +226,46 @@ export class Gateway extends Connector {
    * A single ping is enough only if every tenant is listening by then, which is
    * not the case while the deployment is still rolling out.
    */
-  private async knock (): Promise<void> {
+  private async knock(): Promise<void> {
     for (const delay of KNOCK_DELAYS) {
-      if (this.stopped)
-        return
+      if (this.stopped) return
 
-      if (delay > 0)
-        await setTimeout(delay, undefined, { ref: false })
+      if (delay > 0) await setTimeout(delay, undefined, { ref: false })
 
       await this.ping()
     }
   }
 
-  private async ping (): Promise<void> {
-    if (this.stopped)
-      return
+  private async ping(): Promise<void> {
+    if (this.stopped) return
 
     this.lastPing = Date.now()
 
-    await this.broadcast.transmit<null>('ping', null)
-      .catch((exception: Error) => console.error('Discovery ping failed',
-        { message: exception.message }))
+    await this.broadcast
+      .transmit<null>('ping', null)
+      .catch((exception: Error) =>
+        console.error('Discovery ping failed', { message: exception.message })
+      )
   }
 
-  private reping (): void {
-    if (Date.now() - this.lastPing < PING_COOLDOWN)
-      return
+  private reping(): void {
+    if (Date.now() - this.lastPing < PING_COOLDOWN) return
 
     void this.ping()
   }
 
-  private async settled (first: Promise<void>): Promise<void> {
+  private async settled(first: Promise<void>): Promise<void> {
     const deadline = Date.now() + SETTLE_TIMEOUT
     const abort = new AbortController()
 
     // an uncancelled timer keeps the process alive long after the race is won
-    await Promise.race([first, setTimeout(SETTLE_TIMEOUT, undefined, { signal: abort.signal })])
-      .finally(() => { abort.abort() })
+    await Promise.race([
+      first,
+      setTimeout(SETTLE_TIMEOUT, undefined, { signal: abort.signal })
+    ])
+      .finally(() => {
+        abort.abort()
+      })
       .catch(() => {})
 
     if (this.lastMerge === 0) {
@@ -263,8 +275,7 @@ export class Gateway extends Connector {
     }
 
     while (Date.now() - this.lastMerge < this.quiet()) {
-      if (Date.now() >= deadline)
-        break
+      if (Date.now() >= deadline) break
 
       await setTimeout(SETTLE_POLL)
     }
@@ -277,13 +288,13 @@ export class Gateway extends Connector {
    * is enough; a rolling deployment brings them up seconds apart, and the window grows with
    * the widest gap seen so far to keep waiting for the ones still starting.
    */
-  private quiet (): number {
+  private quiet(): number {
     const adaptive = this.widestGap * SETTLE_QUIET_FACTOR
 
     return Math.min(Math.max(adaptive, SETTLE_QUIET_MIN), SETTLE_QUIET_MAX)
   }
 
-  private merge (branch: Branch): void {
+  private merge(branch: Branch): void {
     const id = branch.namespace + '.' + branch.component
 
     const attributes = {

package/source/HTTP/Context.ts

@@ -1,4 +1,3 @@
-import crypto from 'node:crypto'
 import { buffer } from 'node:stream/consumers'
 import Negotiator from 'negotiator'
 import { console } from 'openspan'
@@ -10,7 +9,6 @@ import type { OutgoingMessage } from './messages.js'
 import type { IncomingMessage } from './types.js'
 
 export class Context {
-  public readonly id: string
   public readonly authority: string
   public readonly request: IncomingMessage
 
@@ -20,7 +18,6 @@ export class Context {
   public readonly subtype: string | null = null
   public readonly encoder: Format | null = null
   public readonly timing: Timing
-  public readonly debug: boolean
 
   /**
    * Whether this is a procedure a request made, rather than the request. What forks one
@@ -37,17 +34,19 @@ export class Context {
   private consumed = false
 
   // eslint-disable-next-line max-params
-  public constructor (authority: string, request: IncomingMessage, properties: Properties,
-    url: URL) {
+  public constructor(
+    authority: string,
+    request: IncomingMessage,
+    properties: Properties,
+    url: URL
+  ) {
     this.authority = authority
     this.request = request
     this.ip = address(request, properties.ip)
 
-    this.id = crypto.randomUUID()
     // parsed by the server, which had to parse it anyway to know the request is valid
     this.url = url
     this.timing = new Timing()
-    this.debug = properties.debug
     this.log(request)
 
     const accept = this.request.headers.accept
@@ -56,11 +55,7 @@ export class Context {
       const match = SUBTYPE.exec(accept)
 
       if (match !== null) {
-        const {
-          type,
-          subtype,
-          suffix
-        } = match.groups!
+        const { type, subtype, suffix } = match.groups!
 
         this.request.headers.accept = `${type}/${suffix}`
         this.subtype = subtype
@@ -69,11 +64,10 @@ export class Context {
 
     const encoder = negotiate(this.request)
 
-    if (encoder !== undefined)
-      this.encoder = encoder
+    if (encoder !== undefined) this.encoder = encoder
   }
 
-  public async buffer (): Promise<Buffer> {
+  public async buffer(): Promise<Buffer> {
     this.consumed = true
 
     return await buffer(this.request)
@@ -82,19 +76,21 @@ export class Context {
   public async body<T>(): Promise<T> {
     let value = this.consumed ? null : await read(this)
 
-    for (const transform of this.pipelines.body)
-      value = await transform(value)
+    for (const transform of this.pipelines.body) value = await transform(value)
 
     return value
   }
 
-  private log (request: IncomingMessage): void {
-    const headers = { ...request.headers }
+  private log(request: IncomingMessage): void {
+    // built only when the line is written, which at `info` it is not
+    console.debug('Received request', () => {
+      const headers = { ...request.headers }
 
-    if (headers.authorization !== undefined)
-      headers.authorization = SCHEME.exec(headers.authorization)?.[1] ?? '[malformed]'
+      if (headers.authorization !== undefined)
+        headers.authorization = SCHEME.exec(headers.authorization)?.[1] ?? '[malformed]'
 
-    console.debug('Received request', { method: request.method, url: request.url, headers })
+      return { method: request.method, url: request.url, headers }
+    })
   }
 }
 
@@ -107,8 +103,6 @@ interface Pipelines {
 }
 
 interface Properties {
-  debug: boolean
-
   /** the header the client address is read from; the connection's without one */
   ip?: string
 }
@@ -117,18 +111,16 @@ interface Properties {
  * Negotiation parses the header and sorts the candidates, and the value repeats:
  * clients send one of a handful of `accept` strings. Bounded, the header is theirs.
  */
-function negotiate (request: IncomingMessage): Format | undefined {
+function negotiate(request: IncomingMessage): Format | undefined {
   const accept = request.headers.accept ?? ''
   const known = NEGOTIATED.get(accept)
 
-  if (known !== undefined)
-    return known === NONE ? undefined : known
+  if (known !== undefined) return known === NONE ? undefined : known
 
   const mediaType = new Negotiator(request).mediaType(types)
   const encoder = mediaType === undefined ? undefined : formats[mediaType]
 
-  if (NEGOTIATED.size >= NEGOTIATED_LIMIT)
-    NEGOTIATED.clear()
+  if (NEGOTIATED.size >= NEGOTIATED_LIMIT) NEGOTIATED.clear()
 
   NEGOTIATED.set(accept, encoder ?? NONE)
 
@@ -140,4 +132,5 @@ const NONE = Symbol('not acceptable') as unknown as Format
 const NEGOTIATED = new Map<string, Format>()
 const NEGOTIATED_LIMIT = 1024
 
-const SUBTYPE = /^(?<type>\w{1,32})\/(vnd\.toa\.(?<subtype>\S{1,32})\+)(?<suffix>\S{1,32})$/
+const SUBTYPE =
+  /^(?<type>\w{1,32})\/(vnd\.toa\.(?<subtype>\S{1,32})\+)(?<suffix>\S{1,32})$/

package/source/HTTP/Probe.ts

@@ -21,14 +21,14 @@ export class Probe {
   private listening = false
   private skipped = false
 
-  public constructor (port: number, path: string = PATH) {
+  public constructor(port: number, path: string = PATH) {
     this.port = port
     this.path = path
 
     this.server.on('request', (request, response) => this.listener(request, response))
   }
 
-  public async listen (): Promise<void> {
+  public async listen(): Promise<void> {
     this.startedAt = Date.now()
 
     try {
@@ -59,7 +59,7 @@ export class Probe {
   }
 
   /** The gateway is listening and has routes: answer `200`. */
-  public complete (): void {
+  public complete(): void {
     this.ready = true
 
     // the IPC signal is not tied to the probe: a process that gave up the shared port is
@@ -67,11 +67,10 @@ export class Probe {
     process.send?.('ready')
   }
 
-  public async close (): Promise<void> {
+  public async close(): Promise<void> {
     this.ready = false
 
-    if (!this.listening || this.skipped)
-      return
+    if (!this.listening || this.skipped) return
 
     this.listening = false
 
@@ -81,15 +80,14 @@ export class Probe {
     await new Promise<void>((resolve) => this.server.close(() => resolve()))
   }
 
-  private listener (request: http.IncomingMessage, response: http.ServerResponse): void {
+  private listener(request: http.IncomingMessage, response: http.ServerResponse): void {
     if (request.url !== this.path) {
       response.writeHead(404).end()
 
       return
     }
 
-    if (this.ready)
-      response.writeHead(200, { 'cache-control': 'no-store' }).end()
+    if (this.ready) response.writeHead(200, { 'cache-control': 'no-store' }).end()
     else {
       const remaining = Math.ceil((Date.now() - this.startedAt) / 1000).toString()