@toa.io/extensions.exposition 1.0.0-alpha.292 → 1.0.0-alpha.293

package/source/Endpoint.ts

@@ -1,157 +0,0 @@
-import { Readable } from 'node:stream'
-import { Mapping } from './Mapping.js'
-import { take } from './Introspection.js'
-import { parse } from './directives/cache/etag.js'
-import * as http from './HTTP/index.js'
-import type { Introspection, Schema } from './Introspection.js'
-import type { Remote } from '@toa.io/core'
-import type { Remotes } from './Remotes.js'
-import type { Context } from './Context.js'
-import type * as RTD from './RTD/index.js'
-
-export class Endpoint implements RTD.Endpoint {
-  private readonly endpoint: string
-  private readonly mapping: Mapping
-  private readonly discovery: Promise<Remote>
-  private remote: Remote | null = null
-
-  /** What the operation says, with what the route takes already split out of it. */
-  private introspection: Introspection | null = null
-
-  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> {
-    const body = await context.body()
-    const query = this.query(context)
-    const request = this.mapping.fit(body, query, parameters)
-
-    this.remote ??= await this.discovery
-
-    const reply = await this.remote.invoke(this.endpoint, request)
-
-    if (reply instanceof Error) throw new http.UnprocessableEntity(reply)
-
-    const message: http.OutgoingMessage = { body: reply }
-
-    // what the reply carries for a cache to validate by; the `cache` family sets the headers
-    if (typeof reply === 'object' && reply !== null && !(reply instanceof Readable)) {
-      if ('VERSION' in reply) message.version = reply.VERSION
-
-      const modified = reply.UPDATED ?? reply.CREATED
-
-      if (modified !== undefined) message.modified = modified
-    }
-
-    return message
-  }
-
-  public selection(): Record<string, Schema> | null {
-    return this.mapping.selection()
-  }
-
-  public async explain(parameters: RTD.Parameter[]): Promise<Introspection> {
-    this.introspection ??= await this.introspect(parameters)
-
-    // what a directive narrows is this caller's answer, not the next caller's
-    return structuredClone(this.introspection)
-  }
-
-  /**
-   * `Remote.explain` answers the contract's own object, whose `input` is the manifest's by
-   * reference. What follows takes properties out of it, and two routes mounting one endpoint
-   * share one remote — so the copy is what keeps the second from describing what the first
-   * took away.
-   */
-  private async introspect(parameters: RTD.Parameter[]): Promise<Introspection> {
-    this.remote ??= await this.discovery
-
-    const operation = structuredClone(await this.remote.explain(this.endpoint))
-
-    // what the operation states it is, is the Introspection's to read and not a resource's:
-    // an operation is written without knowledge of any route, and the same one mounted twice
-    // is two methods. What a method states is what its route states, which `mcp:tool` gives.
-    delete operation.description
-
-    let route: Record<string, Schema> | null = null
-
-    // a variable the operation names is taken by the path, so it is not the body's to send
-    for (const parameter of parameters) {
-      const schema = take(operation, parameter.name)
-
-      if (schema === undefined) continue
-
-      route ??= {}
-      route[parameter.name] = schema
-    }
-
-    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
-
-    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 version = parse(etag)
-
-    if (version === null) throw new http.BadRequest('Invalid ETag')
-
-    return version
-  }
-}
-
-export class EndpointsFactory implements RTD.EndpointsFactory {
-  private readonly remotes: Remotes
-
-  public constructor(remotes: Remotes) {
-    this.remotes = remotes
-  }
-
-  public create(method: RTD.syntax.Method, context: Context): Endpoint {
-    if (method.mapping === undefined)
-      throw new Error('Cannot create Endpoint without mapping')
-
-    const mapping = Mapping.create(method.mapping.query, method.mapping.paged)
-
-    const branch = context.extension
-
-    const namespace = method.mapping.namespace ?? branch?.namespace
-    const component = method.mapping.component ?? branch?.component
-
-    if (namespace === undefined || component === undefined)
-      throw new Error('Annotation endpoints must be fully qualified')
-
-    const discovery = this.remotes.discover(namespace, component, branch?.version)
-
-    return new Endpoint(method.mapping.endpoint, mapping, discovery)
-  }
-}
-
-const INTERRUPT = true

package/source/Factory.ts

@@ -1,42 +0,0 @@
-import { createHash } from 'node:crypto'
-import { Tenant } from './Tenant.js'
-import { CHANNEL } from '@toa.io/definitions/extensions.exposition'
-import type { Branch } from './Branch.js'
-import type { syntax } from './RTD/index.js'
-import type { Broadcast } from './Gateway.js'
-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) {
-    this.host = host
-  }
-
-  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'> = {
-      // 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,
-      version: hash
-    }
-
-    return new Tenant(broadcast, branch)
-  }
-
-  public async service(): Promise<Connector | null> {
-    const { service } = await import('./service.js')
-
-    return await service(this.host)
-  }
-}
-
-// eslint-disable-next-line @typescript-eslint/consistent-type-imports
-export type Host = extensions.Host

package/source/Gateway.ts

@@ -1,390 +0,0 @@
-import assert from 'node:assert'
-import { setTimeout } from 'node:timers/promises'
-import { console } from 'openspan'
-import { Connector } from '@toa.io/core'
-import type { bindings } from '@toa.io/core/types'
-import * as http from './HTTP/index.js'
-import { DISCOVERY, MCP, RPC } from '@toa.io/definitions/extensions.exposition'
-import { rethrow } from './exceptions.js'
-import { decide } from './Branch.js'
-import { describing } from './Introspection.js'
-import { Explorer, looking } from './Discovery/index.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 { Label } from './discovery.js'
-import type { Branch, Exposed } from './Branch.js'
-
-export class Gateway extends Connector {
-  private readonly broadcast: Broadcast
-  private readonly tree: Tree
-  private readonly interceptor: Interception
-  private readonly directives: DirectiveFactory
-
-  /** JSON-RPC is served only where the annotation asked for it. */
-  private readonly dispatcher: Dispatcher | null
-
-  /** And the same of MCP. */
-  private readonly mcp: Server | null
-
-  /** The tree, for every route at once. Served always, and so not nullable. */
-  private readonly explorer: Explorer
-  private readonly branches = new Map<string, Exposed>()
-  private lastMerge = 0
-  private widestGap = 0
-  private lastPing = 0
-  private stopped = false
-  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
-  ) {
-    super()
-
-    this.broadcast = broadcast
-    this.tree = tree
-    this.interceptor = interception
-    this.directives = directives
-    this.dispatcher = dispatcher
-    this.mcp = mcp
-    this.explorer = new Explorer(tree)
-
-    this.depends(broadcast)
-  }
-
-  public async process(context: http.Context): Promise<http.OutgoingMessage> {
-    const interception = await this.interceptor.intercept(context)
-
-    if (interception !== null) return interception
-
-    // request-scoped, before anything is routed: this is where a credential is read
-    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 this.directives.depart(context, response).catch(rethrow)
-
-    return response
-  }
-
-  /**
-   * 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> {
-    const route: http.Processor = async (call) => await this.route(call)
-
-    if (this.dispatcher !== null && context.url.pathname === RPC)
-      return await this.dispatcher.dispatch(context, route)
-
-    if (this.mcp !== null && context.url.pathname === MCP)
-      return await this.mcp.process(context, route)
-
-    // the page under this prefix is an interceptor's, and has already answered
-    if (context.url.pathname === DISCOVERY || context.url.pathname === DISCOVERY + '/')
-      return await this.explorer.process(context)
-
-    // a browser that asked for the trunk of an API is looking for the page, and where the
-    // application answers there itself, that is what answers
-    if (context.url.pathname === '/' && !this.serves(context)) {
-      const page = looking(context)
-
-      if (page !== null) return page
-    }
-
-    return await this.route(context)
-  }
-
-  /** Whether the application serves the trunk with the verb the request was made with. */
-  private serves(context: http.Context): boolean {
-    const match = this.tree.match('/')
-
-    return match !== null && context.request.method in match.node.methods
-  }
-
-  /**
-   * 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> {
-    const { node, parameters } = this.match(context)
-
-    if (context.request.method === 'OPTIONS')
-      return await this.explain(context, node, parameters)
-
-    let verb = context.request.method
-
-    if (!(verb in node.methods) && verb === 'HEAD' && 'GET' in node.methods) verb = 'GET'
-
-    if (!(verb in node.methods)) throw new http.MethodNotAllowed()
-
-    const method = node.methods[verb]
-
-    const interruption = await method.directives
-      .precall(context, parameters)
-      .catch(rethrow)
-    const response = interruption ?? (await this.call(method, context, parameters))
-
-    await method.directives.settle(context, response).catch(rethrow)
-
-    return response
-  }
-
-  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.mcp !== null) pinned.push(MCP)
-
-    console.info('Gateway started', {
-      endpoints: pinned.length === 0 ? 'none' : pinned.join(' ')
-    })
-  }
-
-  /**
-   * Both of these reach into components, and a dependency is torn down only once this has
-   * returned — where `dispose` runs after every one of them already has. The throttling
-   * 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> {
-    this.stopped = true
-
-    this.tree.dispose()
-  }
-
-  protected override dispose(): void {
-    console.info('Gateway is closed')
-  }
-
-  private match(context: http.Context): Match {
-    const match = this.tree.match(context.url.pathname)
-
-    if (match === null) {
-      // the route may be missing because an expose has been lost
-      this.reping()
-
-      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')
-
-    if (context.encoder === null) throw new http.NotAcceptable()
-
-    if (method.endpoint === null) throw new http.MethodNotAllowed()
-
-    return (await method.endpoint
-      .call(context, parameters)
-      .catch(rethrow)) as http.OutgoingMessage
-  }
-
-  private async explain(
-    context: http.Context,
-    node: Node,
-    parameters: Parameter[]
-  ): Promise<http.OutgoingMessage> {
-    const { described, methods } = await node.explain(describing(context), parameters)
-    const verbs = Object.keys(methods)
-
-    // what a caller may not use is not a resource to them, and describing it would be the leak
-    if (verbs.length === 0 && Object.keys(node.methods).length > 0)
-      throw new http.Forbidden()
-
-    // what the resource is, beside the methods it serves; a verb is upper case and cannot
-    // collide with either key
-    return {
-      body: { ...described, ...methods },
-      headers: new Headers({ allow: verbs.join(', ') })
-    }
-  }
-
-  private async discover(): Promise<void> {
-    const first = new Promise<void>((resolve) => {
-      this.resolveFirstMerge = resolve
-    })
-
-    await this.broadcast.receive<Branch>('expose', this.merge.bind(this))
-
-    void this.knock()
-
-    await this.settled(first)
-  }
-
-  /**
-   * 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> {
-    for (const delay of KNOCK_DELAYS) {
-      if (this.stopped) return
-
-      if (delay > 0) await setTimeout(delay, undefined, { ref: false })
-
-      await this.ping()
-    }
-  }
-
-  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 })
-      )
-  }
-
-  private reping(): void {
-    if (Date.now() - this.lastPing < PING_COOLDOWN) return
-
-    void this.ping()
-  }
-
-  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()
-      })
-      .catch(() => {})
-
-    if (this.lastMerge === 0) {
-      console.warn('Discovery timed out waiting for the first expose')
-
-      return
-    }
-
-    while (Date.now() - this.lastMerge < this.quiet()) {
-      if (Date.now() >= deadline) break
-
-      await setTimeout(SETTLE_POLL)
-    }
-  }
-
-  /**
-   * How long the branches must stay quiet before discovery counts as settled.
-   *
-   * Every tenant of a local composition answers the first ping at once, so a short window
-   * 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 {
-    const adaptive = this.widestGap * SETTLE_QUIET_FACTOR
-
-    return Math.min(Math.max(adaptive, SETTLE_QUIET_MIN), SETTLE_QUIET_MAX)
-  }
-
-  private merge(branch: Branch): void {
-    const id = branch.namespace + '.' + branch.component
-
-    const attributes = {
-      namespace: branch.namespace,
-      component: branch.component,
-      version: branch.version
-    }
-
-    const exposed = this.branches.get(id)
-
-    if (exposed !== undefined)
-      switch (decide(exposed, branch)) {
-        // rebuilding an identical branch would only tear down its live endpoints
-        case 'refresh':
-          this.tree.refresh(exposed.nodes)
-          console.trace('Branch refreshed', attributes)
-
-          return
-
-        case 'superseded':
-          console.debug('Branch superseded', {
-            ...attributes,
-            timestamp: branch.timestamp,
-            exposed: exposed.timestamp
-          })
-
-          return
-      }
-
-    let nodes: Node[]
-
-    try {
-      nodes = this.tree.merge(branch.node, branch)
-    } catch (exception: unknown) {
-      const message = exception instanceof Error ? exception.message : 'Unknown error'
-
-      console.error('Branch merge exception', { message, ...attributes })
-
-      return
-    }
-
-    this.branches.set(id, { version: branch.version, timestamp: branch.timestamp, nodes })
-
-    if (this.lastMerge !== 0)
-      this.widestGap = Math.max(this.widestGap, Date.now() - this.lastMerge)
-
-    this.lastMerge = Date.now()
-    this.resolveFirstMerge?.()
-    this.resolveFirstMerge = null
-
-    console.info('Branch merged', attributes)
-  }
-}
-
-export type Broadcast = bindings.Broadcast<Label>
-
-const SETTLE_QUIET_MIN = 500
-const SETTLE_QUIET_MAX = 10_000
-const SETTLE_QUIET_FACTOR = 2
-const SETTLE_TIMEOUT = 30_000
-const SETTLE_POLL = 50
-const KNOCK_DELAYS = [0, 500, 1000, 1500]
-const PING_COOLDOWN = 5_000