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

package/schemas/annotation.cos.yaml

@@ -3,7 +3,7 @@ properties:
     type: string
   resources:
     # `null` deploys the service without any, which every deployment has to state one way
-    # or the other — see `migrations/263.md`.
+    # or the other — see `migrations/262.md`.
     type: object
     nullable: true
     properties:
@@ -76,7 +76,6 @@ properties:
       registration:
         type: string
         enum: [open, closed]
-        default: closed
     required:
       - authorize
     additionalProperties: false
@@ -109,7 +108,6 @@ properties:
       anonymous:
         description: Whether the endpoint answers without a credential
         type: boolean
-        default: false
     required:
       - name
     additionalProperties: false

package/schemas/method.cos.yaml

@@ -12,6 +12,8 @@ properties:
         type: string
       query:
         $ref: query
+      paged:
+        type: boolean
     additionalProperties: false
     type: object
   directives:

package/source/Branch.test.ts

@@ -4,7 +4,7 @@ import assert from 'node:assert/strict'
 import { decide } from './Branch.js'
 import type { Branch, Exposed } from './Branch.js'
 
-function branch (version: string, timestamp: number): Branch {
+function branch(version: string, timestamp: number): Branch {
   return {
     namespace: 'default',
     component: 'one',
@@ -15,7 +15,7 @@ function branch (version: string, timestamp: number): Branch {
   }
 }
 
-function exposed (version: string, timestamp: number): Exposed {
+function exposed(version: string, timestamp: number): Exposed {
   return { version, timestamp, nodes: [] }
 }
 

package/source/Branch.ts

@@ -33,12 +33,10 @@ export interface Exposed {
  * - `superseded`: it came from a tenant that started before the one exposed now
  * - `merge`: everything else
  */
-export function decide (exposed: Exposed, branch: Branch): Decision {
-  if (exposed.version === branch.version)
-    return 'refresh'
+export function decide(exposed: Exposed, branch: Branch): Decision {
+  if (exposed.version === branch.version) return 'refresh'
 
-  if (branch.timestamp < exposed.timestamp)
-    return 'superseded'
+  if (branch.timestamp < exposed.timestamp) return 'superseded'
 
   return 'merge'
 }

package/source/Composition.ts

@@ -6,12 +6,12 @@ import { type Host } from './Factory.js'
 export class Composition extends Connector {
   private readonly host: Host
 
-  public constructor (host: Host) {
+  public constructor(host: Host) {
     super()
     this.host = host
   }
 
-  protected override async open (): Promise<void> {
+  protected override async open(): Promise<void> {
     const paths = find()
     const composition = await this.host.composition(paths)
 
@@ -21,17 +21,17 @@ export class Composition extends Connector {
   }
 }
 
-function find (): string[] {
+function find(): string[] {
   return entries().map((entry) => resolve(ROOT, entry.name))
 }
 
-function entries (): Dirent[] {
+function entries(): Dirent[] {
   const entries = readdirSync(ROOT, { withFileTypes: true })
 
   return entries.filter((entry) => entry.isDirectory())
 }
 
-export function components (): Components {
+export function components(): Components {
   const labels: string[] = []
   const paths: string[] = []
 

package/source/Directive.test.ts

@@ -16,7 +16,10 @@ const families: Array<DirectiveFamily> = [
     mandatory: true,
     create: mock.fn((_0: any, _1: any, _2: any) => generate() as any),
     arrange: mock.fn(),
-    precall: mock.fn(() => { sequence.push('foo'); return null }),
+    precall: mock.fn(() => {
+      sequence.push('foo')
+      return null
+    }),
     settle: mock.fn(),
     dispose: mock.fn()
   },
@@ -25,7 +28,10 @@ const families: Array<DirectiveFamily> = [
     mandatory: true,
     create: mock.fn((_0: any, _1: any, _2: any) => generate() as any),
     arrange: mock.fn(),
-    precall: mock.fn(() => { sequence.push('qux'); return null }),
+    precall: mock.fn(() => {
+      sequence.push('qux')
+      return null
+    }),
     settle: mock.fn(),
     dispose: mock.fn()
   },
@@ -34,7 +40,10 @@ const families: Array<DirectiveFamily> = [
     mandatory: false,
     create: mock.fn((_0: string, _1: any, _2: any) => generate() as any),
     arrange: mock.fn(),
-    precall: mock.fn(() => { sequence.push('bar'); return null }),
+    precall: mock.fn(() => {
+      sequence.push('bar')
+      return null
+    }),
     settle: mock.fn(),
     dispose: mock.fn()
   }
@@ -49,11 +58,18 @@ beforeEach(() => {
   for (const family of families) {
     assert.ok(family.precall !== undefined)
 
-    family.precall.mock.mockImplementation(() => { sequence.push(family.name); return null })
+    family.precall.mock.mockImplementation(() => {
+      sequence.push(family.name)
+      return null
+    })
   }
 
-  factory = new DirectivesFactory(families, {} as unknown as Remotes, {} as unknown as Host,
-    { authorities: {} })
+  factory = new DirectivesFactory(
+    families,
+    {} as unknown as Remotes,
+    {} as unknown as Host,
+    { authorities: {} }
+  )
 })
 
 it('should create directive', async () => {
@@ -95,8 +111,11 @@ it('should throw error if directive family is not found', async () => {
     value: generate()
   }
 
-  assert.throws(() => factory.create([declaration]),
-    (error: Error) => error.message.includes(`Directive family '${declaration.family}' is not found`))
+  assert.throws(
+    () => factory.create([declaration]),
+    (error: Error) =>
+      error.message.includes(`Directive family '${declaration.family}' is not found`)
+  )
 })
 
 it('should apply directive', async () => {
@@ -129,7 +148,7 @@ it('should apply mandatory families', async () => {
 
 describe('order', () => {
   // the order the families actually ran, as each precall recorded it
-  function order (): string[] {
+  function order(): string[] {
     return sequence
   }
 
@@ -145,18 +164,17 @@ describe('order', () => {
     assert.deepStrictEqual(order(), ['foo', 'qux'])
   })
 
-  it('should run a mandatory family before a declared one it is not declared with',
-    async () => {
-      // only `qux` is declared: `foo` still has to run first, not merely first of
-      // whatever had no declarations
-      const directives = factory.create([
-        { family: 'qux', name: generate(), value: generate() }
-      ])
+  it('should run a mandatory family before a declared one it is not declared with', async () => {
+    // only `qux` is declared: `foo` still has to run first, not merely first of
+    // whatever had no declarations
+    const directives = factory.create([
+      { family: 'qux', name: generate(), value: generate() }
+    ])
 
-      await directives.precall(generate() as unknown as Context, [])
+    await directives.precall(generate() as unknown as Context, [])
 
-      assert.deepStrictEqual(order(), ['foo', 'qux'])
-    })
+    assert.deepStrictEqual(order(), ['foo', 'qux'])
+  })
 
   it('should run mandatory families before the rest', async () => {
     const directives = factory.create([
@@ -170,7 +188,7 @@ describe('order', () => {
   })
 })
 
-function resetCalls (target = [families], seen = new Set()) {
+function resetCalls(target = [families], seen = new Set()) {
   if (target === null || typeof target !== 'object' || seen.has(target)) return
 
   seen.add(target)

package/source/Directive.ts

@@ -12,7 +12,7 @@ export class Directives implements RTD.Directives {
   /** the span of a stage depends only on the set, so it is built once per route */
   private readonly spans: Spans[]
 
-  public constructor (sets: RTD.DirectiveSet[]) {
+  public constructor(sets: RTD.DirectiveSet[]) {
     this.sets = sets
     this.spans = sets.map((set) => ({
       precall: options(set, 'precall'),
@@ -21,29 +21,29 @@ export class Directives implements RTD.Directives {
     }))
   }
 
-  public declared<T> (family: string): T[] | undefined {
-    return this.sets.find((set) => set.family.name === family)?.directives as T[] | undefined
+  public declared<T>(family: string): T[] | undefined {
+    return this.sets.find((set) => set.family.name === family)?.directives as
+      | T[]
+      | undefined
   }
 
-  public async precall (context: Context, parameters: RTD.Parameter[]): Promise<Output> {
+  public async precall(context: Context, parameters: RTD.Parameter[]): Promise<Output> {
     let output = null
 
     for (let i = 0; i < this.sets.length; i++) {
       const set = this.sets[i]
 
-      if (set.family.precall === undefined)
-        continue
+      if (set.family.precall === undefined) continue
 
-      const out = await console.span(this.spans[i].precall,
-        async () => await set.family.precall!(set.directives, context, parameters))
+      const out = await console.span(
+        this.spans[i].precall,
+        async () => await set.family.precall!(set.directives, context, parameters)
+      )
 
-      if (out === null)
-        continue
+      if (out === null) continue
 
-      if (output !== null)
-        throw new Error('Multiple precall directives responded')
-      else
-        output = out
+      if (output !== null) throw new Error('Multiple precall directives responded')
+      else output = out
     }
 
     return output
@@ -54,21 +54,23 @@ export class Directives implements RTD.Directives {
    * what the one before it returned, and the first to refuse ends it: a method this caller
    * cannot reach is not described at all.
    */
-  public async explain (context: Context,
-    introspection: Introspection): Promise<Introspection | null> {
+  public async explain(
+    context: Context,
+    introspection: Introspection
+  ): Promise<Introspection | null> {
     let described: Introspection = introspection
 
     for (let i = 0; i < this.sets.length; i++) {
       const set = this.sets[i]
 
-      if (set.family.explain === undefined)
-        continue
+      if (set.family.explain === undefined) continue
 
-      const next = await console.span(this.spans[i].explain,
-        async () => await set.family.explain!(set.directives, context, described))
+      const next = await console.span(
+        this.spans[i].explain,
+        async () => await set.family.explain!(set.directives, context, described)
+      )
 
-      if (next === null)
-        return null
+      if (next === null) return null
 
       described = next
     }
@@ -76,19 +78,20 @@ export class Directives implements RTD.Directives {
     return described
   }
 
-  public async settle (context: Context, response: OutgoingMessage): Promise<void> {
+  public async settle(context: Context, response: OutgoingMessage): Promise<void> {
     for (let i = 0; i < this.sets.length; i++) {
       const set = this.sets[i]
 
       if (set.family.settle !== undefined)
-        await console.span(this.spans[i].settle,
-          async () => await set.family.settle!(set.directives, context, response))
+        await console.span(
+          this.spans[i].settle,
+          async () => await set.family.settle!(set.directives, context, response)
+        )
     }
   }
 
-  public dispose (): void {
-    for (const set of this.sets)
-      set.family.dispose?.(set.directives)
+  public dispose(): void {
+    for (const set of this.sets) set.family.dispose?.(set.directives)
   }
 }
 
@@ -102,14 +105,17 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
   private readonly stages: Stage[] = []
 
   // eslint-disable-next-line max-params
-  public constructor (families: RTD.DirectiveFamily[], remotes: Remotes, host: Host,
-    options: Options) {
+  public constructor(
+    families: RTD.DirectiveFamily[],
+    remotes: Remotes,
+    host: Host,
+    options: Options
+  ) {
     for (const family of families) {
       family.mount?.(host, options)
       this.families[family.name] = family
 
-      if (family.mandatory)
-        this.mandatory.push(family.name)
+      if (family.mandatory) this.mandatory.push(family.name)
 
       this.stages.push({
         family,
@@ -125,22 +131,24 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
    * Request-scoped, before anything is routed, so no directives are passed: a family
    * answers here only for what it does on its own behalf.
    */
-  public async preflight (context: Context): Promise<void> {
+  public async preflight(context: Context): Promise<void> {
     for (const stage of this.stages)
       if (stage.family.preflight !== undefined)
-        await console.span(stage.preflight,
-          async () => { await stage.family.preflight!(context) })
+        await console.span(stage.preflight, async () => {
+          await stage.family.preflight!(context)
+        })
   }
 
   /** Request-scoped, on the message going back. */
-  public async depart (context: Context, response: OutgoingMessage): Promise<void> {
+  public async depart(context: Context, response: OutgoingMessage): Promise<void> {
     for (const stage of this.stages)
       if (stage.family.depart !== undefined)
-        await console.span(stage.depart,
-          async () => { await stage.family.depart!(context, response) })
+        await console.span(stage.depart, async () => {
+          await stage.family.depart!(context, response)
+        })
   }
 
-  public create (declarations: RTD.syntax.Directive[], route: string = ''): Directives {
+  public create(declarations: RTD.syntax.Directive[], route: string = ''): Directives {
     const groups: Record<string, any> = {}
     const mandatory = new Set(this.mandatory)
 
@@ -152,7 +160,12 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
       if (family === undefined)
         throw new Error(`Directive family '${declaration.family}' is not found`)
 
-      const directive = family.create(declaration.name, declaration.value, this.remotes, route)
+      const directive = family.create(
+        declaration.name,
+        declaration.value,
+        this.remotes,
+        route
+      )
 
       groups[family.name] ??= []
       groups[family.name].push(directive)
@@ -184,8 +197,7 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
     sets.sort((a, b) => this.rank(a.family.name) - this.rank(b.family.name))
 
     // whatever order a family needs among its own directives is fixed here, not per request
-    for (const set of sets)
-      set.family.arrange?.(set.directives)
+    for (const set of sets) set.family.arrange?.(set.directives)
 
     const directives = new Directives(sets)
 
@@ -194,20 +206,22 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
     return directives
   }
 
-  public dispose (): void {
-    for (const directives of this.instances)
-      directives.dispose()
+  public dispose(): void {
+    for (const directives of this.instances) directives.dispose()
   }
 
   /** Mandatory families first, in their own order; everything else keeps its own. */
-  private rank (family: string): number {
+  private rank(family: string): number {
     const index = this.mandatory.indexOf(family)
 
     return index === -1 ? this.mandatory.length : index
   }
 }
 
-function options (set: RTD.DirectiveSet, stage: 'precall' | 'settle' | 'explain'): SpanOptions {
+function options(
+  set: RTD.DirectiveSet,
+  stage: 'precall' | 'settle' | 'explain'
+): SpanOptions {
   const options: SpanOptions = { name: `${set.family.name} ${stage}` }
 
   if (set.names !== undefined && set.names.length > 0)

package/source/Endpoint.test.ts

@@ -10,7 +10,7 @@ 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> {
+function remote(): Promise<Remote> {
   const explanation = {
     input: {
       type: 'object',

package/source/Endpoint.ts

@@ -1,8 +1,7 @@
 import { Readable } from 'node:stream'
-import { console } from 'openspan'
 import { Mapping } from './Mapping.js'
 import { take } from './Introspection.js'
-import { redact } from './redact.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'
@@ -19,56 +18,41 @@ export class Endpoint implements RTD.Endpoint {
   /** 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>) {
+  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: redact(request) })
-
     const reply = await this.remote.invoke(this.endpoint, request)
 
-    console.debug('Received reply',
-      { endpoint, reply: reply instanceof Readable ? '[Readable stream]' : redact(reply) })
-
-    if (reply instanceof Error)
-      throw new http.UnprocessableEntity(reply)
+    if (reply instanceof Error) throw new http.UnprocessableEntity(reply)
 
-    const message: http.OutgoingMessage = {}
+    const message: http.OutgoingMessage = { body: reply }
 
-    // etag
-    if (reply !== null && reply !== undefined) {
-      const etag = context.request.headers['if-none-match']
+    // 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
 
-      if (this.conditionalGet(reply, etag, message))
-        return message
-    }
-
-    // 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)
+      const modified = reply.UPDATED ?? reply.CREATED
 
-      message.headers ??= new Headers()
-      message.headers.set('last-modified', date.toUTCString())
+      if (modified !== undefined) message.modified = modified
     }
 
-    message.body = reply
-
     return message
   }
 
-  public async explain (parameters: RTD.Parameter[]): Promise<Introspection> {
+  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
@@ -81,7 +65,7 @@ export class Endpoint implements RTD.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> {
+  private async introspect(parameters: RTD.Parameter[]): Promise<Introspection> {
     this.remote ??= await this.discovery
 
     const operation = structuredClone(await this.remote.explain(this.endpoint))
@@ -97,8 +81,7 @@ export class Endpoint implements RTD.Endpoint {
     for (const parameter of parameters) {
       const schema = take(operation, parameter.name)
 
-      if (schema === undefined)
-        continue
+      if (schema === undefined) continue
 
       route ??= {}
       route[parameter.name] = schema
@@ -107,80 +90,34 @@ export class Endpoint implements RTD.Endpoint {
     const query = this.mapping.explain(operation)
     const introspection: Introspection = {}
 
-    if (route !== null)
-      introspection.route = route
+    if (route !== null) introspection.route = route
 
-    if (query !== null)
-      introspection.query = query
+    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 conditionalGet (reply: unknown, etag: string | undefined, message: http.OutgoingMessage): boolean {
-    message.headers ??= new Headers()
-
-    if (typeof reply === 'object' && reply !== null && '_version' in reply) {
-      const version = reply._version as number
-      const matched = etag === undefined ? null : this.matchVersion(etag)
-
-      if (etag !== undefined && matched !== null && version === matched) {
-        message.status = 304
-        message.headers.set('etag', etag)
-
-        return true
-      }
-
-      message.headers.set('etag', `"${version.toString()}"`)
-
-      return false
-    }
-
-    if (reply instanceof Readable)
-      return false
-
-    /*
-     * A reply that carries no version is tagged with a hash of its body. The body is
-     * serialized anyway when the response is written, so the tag is computed from what
-     * is actually sent rather than from a second serialization of the reply — which
-     * makes it specific to the negotiated representation, hence `vary: accept`.
-     */
-    message.etag = true
-
-    return false
-  }
-
-  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 && this.mapping.queryable)
-      query.version = this.version(etag)
+    if (etag !== undefined && this.mapping.queryable) query.version = this.version(etag)
 
     return query
   }
 
-  private matchVersion (etag: string): number | null {
-    const match = etag.match(ETAG)
+  private version(etag: string): number {
+    const version = parse(etag)
 
-    if (match === null)
-      return null
-
-    return Number.parseInt(match.groups!.version)
-  }
-
-  private version (etag: string): number {
-    const version = this.matchVersion(etag)
-
-    if (version === null)
-      throw new http.BadRequest('Invalid ETag')
+    if (version === null) throw new http.BadRequest('Invalid ETag')
 
     return version
   }
@@ -189,15 +126,15 @@ export class Endpoint implements RTD.Endpoint {
 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')
 
-    const mapping = Mapping.create(method.mapping.query)
+    const mapping = Mapping.create(method.mapping.query, method.mapping.paged)
 
     const branch = context.extension
 
@@ -213,6 +150,4 @@ export class EndpointsFactory implements RTD.EndpointsFactory {
   }
 }
 
-const ETAG = /^(W\/)?"(?<version>\d{1,32})"$/
-
 const INTERRUPT = true