@toa.io/extensions.exposition 1.0.0-alpha.29 → 1.0.0-alpha.291

package/source/Endpoint.test.ts

@@ -0,0 +1,67 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+
+import { Endpoint } from './Endpoint.js'
+import { Mapping } from './Mapping.js'
+import type { Remote } from '@toa.io/core'
+import type { Parameter } from './RTD/index.js'
+
+/**
+ * What `Remote.explain` answers is the contract's own object, the same one every time and
+ * on every route that mounts the endpoint — which is what this stands in for.
+ */
+function remote(): Promise<Remote> {
+  const explanation = {
+    input: {
+      type: 'object',
+      properties: {
+        a: { type: 'string' },
+        b: { type: 'string' }
+      },
+      required: ['a', 'b']
+    },
+    output: null
+  }
+
+  return Promise.resolve({
+    explain: async () => explanation
+  } as unknown as Remote)
+}
+
+const endpoint = (discovery: Promise<Remote>): Endpoint =>
+  new Endpoint('parameters', Mapping.create(), discovery)
+
+const variable: Parameter[] = [{ name: 'a', value: 'a1b2' }]
+
+describe('explain', () => {
+  it('should state a route variable as the route, not as the input', async () => {
+    const introspection = await endpoint(remote()).explain(variable)
+
+    assert.deepEqual(Object.keys(introspection.route ?? {}), ['a'])
+    assert.deepEqual(Object.keys((introspection.input as any).properties), ['b'])
+    assert.deepEqual((introspection.input as any).required, ['b'])
+  })
+
+  it('should leave the operation for the next route that mounts it', async () => {
+    const discovery = remote()
+
+    await endpoint(discovery).explain(variable)
+
+    // a second route on the same endpoint, taking no variable of its own
+    const introspection = await endpoint(discovery).explain([])
+
+    assert.deepEqual(Object.keys((introspection.input as any).properties), ['a', 'b'])
+    assert.deepEqual((introspection.input as any).required, ['a', 'b'])
+  })
+
+  it('should answer a copy, so what one caller narrows the next still sees', async () => {
+    const one = endpoint(remote())
+    const first = await one.explain(variable)
+
+    delete (first.input as any).properties.b
+
+    const second = await one.explain(variable)
+
+    assert.deepEqual(Object.keys((second.input as any).properties), ['b'])
+  })
+})

package/source/Endpoint.ts

@@ -1,23 +1,33 @@
-import { type Component } from '@toa.io/core'
-import { type Remotes } from './Remotes'
-import { Mapping } from './Mapping'
-import { type Context } from './Context'
-import * as http from './HTTP'
-import type * as RTD from './RTD'
+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<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>) {
+  /** 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> {
+  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)
@@ -26,83 +36,122 @@ export class Endpoint implements RTD.Endpoint {
 
     const reply = await this.remote.invoke(this.endpoint, request)
 
-    if (context.debug)
-      console.debug('Call', `${this.remote.locator.id}.${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
+  }
 
-    if (reply instanceof Error)
-      throw new http.UnprocessableEntity(reply)
+  public selection(): Record<string, Schema> | null {
+    return this.mapping.selection()
+  }
 
-    const message: http.OutgoingMessage = {}
+  public async explain(parameters: RTD.Parameter[]): Promise<Introspection> {
+    this.introspection ??= await this.introspect(parameters)
 
-    if (typeof reply === 'object' && reply !== null && '_version' in reply) {
-      const etag = context.request.headers['if-none-match']
+    // what a directive narrows is this caller's answer, not the next caller's
+    return structuredClone(this.introspection)
+  }
 
-      message.headers ??= new Headers()
+  /**
+   * `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
 
-      if (etag !== undefined && reply._version === this.version(etag)) {
-        message.status = 304
-        message.headers.set('etag', etag)
+    const operation = structuredClone(await this.remote.explain(this.endpoint))
 
-        return message
-      } else
-        message.headers.set('etag', `"${reply._version.toString()}"`)
+    // 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
     }
 
-    message.body = reply
+    const query = this.mapping.explain(operation)
+    const introspection: Introspection = {}
 
-    return message
+    if (route !== null) introspection.route = route
+
+    if (query !== null) introspection.query = query
+
+    Object.assign(introspection, operation)
+
+    return introspection
   }
 
-  public async close (): Promise<void> {
+  public async close(): Promise<void> {
     this.remote ??= await this.discovery
 
     await this.remote.disconnect(INTERRUPT)
   }
 
-  private query (context: http.Context): http.Query {
+  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)
-      query.version = this.version(etag)
+    if (etag !== undefined && this.mapping.queryable) query.version = this.version(etag)
 
     return query
   }
 
-  private version (etag: string): number {
-    const match = etag.match(ETAG)
+  private version(etag: string): number {
+    const version = parse(etag)
 
-    if (match === null)
-      throw new http.BadRequest('Invalid ETag.')
+    if (version === null) throw new http.BadRequest('Invalid ETag')
 
-    return Number.parseInt(match.groups!.version)
+    return version
   }
 }
 
 export class EndpointsFactory implements RTD.EndpointsFactory {
   private readonly remotes: Remotes
 
-  public constructor (remotes: Remotes) {
+  public constructor(remotes: Remotes) {
     this.remotes = remotes
   }
 
-  public create (method: RTD.syntax.Method, context: Context): 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, method.mapping.paged)
 
-    const mapping = Mapping.create(method.mapping.query)
-    const namespace = method.mapping.namespace ?? context.extension?.namespace
-    const component = method.mapping.component ?? context.extension?.component
+    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.')
+      throw new Error('Annotation endpoints must be fully qualified')
 
-    const discovery = this.remotes.discover(namespace, component)
+    const discovery = this.remotes.discover(namespace, component, branch?.version)
 
     return new Endpoint(method.mapping.endpoint, mapping, discovery)
   }
 }
 
-const ETAG = /^"(?<version>\d{1,32})"$/
-
 const INTERRUPT = true

package/source/Factory.ts

@@ -1,60 +1,42 @@
-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 { 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 { Broadcast } from './Gateway'
-import type { Connector, Locator, extensions } from '@toa.io/core'
+import { createHash } from 'node:crypto'
+import { Tenant } from './Tenant.js'
+import { CHANNEL } from './const.js'
+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 boot: Bootloader
+  private readonly host: Host
 
-  public constructor (boot: Bootloader) {
-    this.boot = boot
+  public constructor(host: Host) {
+    this.host = host
   }
 
-  public tenant (locator: Locator, node: syntax.Node): Connector {
-    const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL, locator.id)
-
-    return new Tenant(broadcast, locator, node)
+  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 service (): Connector | null {
-    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, methods: syntax.verbs })
-    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(node, methods, directives)
-
-    const composition = new Composition(this.boot)
-    const gateway = new Gateway(broadcast, tree, interception)
+  public async service(): Promise<Connector | null> {
+    const { service } = await import('./service.js')
 
-    gateway.depends(remotes)
-    gateway.depends(composition)
-
-    server.attach(gateway.process.bind(gateway))
-    server.depends(gateway)
-
-    return server
+    return await service(this.host)
   }
 }
 
-const CHANNEL = 'exposition'
-
 // eslint-disable-next-line @typescript-eslint/consistent-type-imports
-export type Bootloader = typeof import('@toa.io/boot')
+export type Host = extensions.Host