@toa.io/extensions.exposition 1.0.0-alpha.5 → 1.0.0-alpha.51

package/source/directives/octets/Fetch.ts

@@ -1,29 +1,31 @@
 import { posix } from 'node:path'
 import { Forbidden, NotFound } from '../../HTTP'
 import * as schemas from './schemas'
+import { Directive } from './Directive'
+import type { Readable } from 'node:stream'
 import type { Maybe } from '@toa.io/types'
 import type { Entry } from '@toa.io/extensions.storages'
-import type { Readable } from 'node:stream'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
+import type { Input } from './types'
 
-import type { Directive, Input } from './types'
-
-export class Fetch implements Directive {
+export class Fetch extends Directive {
   public readonly targeted = true
 
-  private readonly permissions: Required<Permissions> = {
+  private readonly options: Required<Options> = {
     blob: true,
     meta: false
   }
 
   private readonly discovery: Promise<Component>
-  private storage: Component = null as unknown as Component
+  private storage!: Component
+
+  public constructor (options: Options | null, discovery: Promise<Component>) {
+    super()
 
-  public constructor (permissions: Permissions | null, discovery: Promise<Component>) {
-    schemas.fetch.validate(permissions)
+    schemas.fetch.validate(options)
+    Object.assign(this.options, options)
 
-    Object.assign(this.permissions, permissions)
     this.discovery = discovery
   }
 
@@ -34,12 +36,12 @@ export class Fetch implements Directive {
     const metadata = input.subtype === 'octets.entry'
 
     if (!variant && metadata)
-      if (this.permissions.meta)
+      if (this.options.meta)
         return this.get(storage, input)
       else
         throw new Forbidden('Metadata is not accessible.')
 
-    if (!variant && !this.permissions.blob)
+    if (!variant && !this.options.blob)
       throw new Forbidden('BLOB variant must be specified.')
 
     return await this.fetch(storage, input)
@@ -86,7 +88,7 @@ export class Fetch implements Directive {
   }
 }
 
-export interface Permissions {
+export interface Options {
   blob?: boolean
   meta?: boolean
 }

package/source/directives/octets/List.ts

@@ -1,24 +1,26 @@
 import { posix } from 'node:path'
 import { Forbidden, NotFound } from '../../HTTP'
 import * as schemas from './schemas'
+import { Directive } from './Directive'
 import type { Entry } from '@toa.io/extensions.storages'
 import type { Maybe } from '@toa.io/types'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
 
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 
-export class List implements Directive {
+export class List extends Directive {
   public readonly targeted = false
 
-  private readonly permissions: Required<Permissions> = { meta: false }
+  private readonly options: Required<Options> = { meta: false }
   private readonly discovery: Promise<Component>
   private storage: Component | null = null
 
-  public constructor (permissions: Permissions | null, discovery: Promise<Component>) {
+  public constructor (permissions: Options | null, discovery: Promise<Component>) {
+    super()
     schemas.list.validate(permissions)
 
-    Object.assign(this.permissions, permissions)
+    Object.assign(this.options, permissions)
     this.discovery = discovery
   }
 
@@ -27,7 +29,7 @@ export class List implements Directive {
 
     const metadata = input.subtype === 'octets.entries'
 
-    if (metadata && !this.permissions.meta)
+    if (metadata && !this.options.meta)
       throw new Forbidden('Metadata is not accessible.')
 
     const list = await this.storage.invoke<Maybe<string[]>>('list', {
@@ -65,6 +67,6 @@ export class List implements Directive {
   }
 }
 
-export interface Permissions {
+export interface Options {
   meta?: boolean
 }

package/source/directives/octets/Octets.ts

@@ -4,13 +4,13 @@ import { Store } from './Store'
 import { Fetch } from './Fetch'
 import { List } from './List'
 import { Delete } from './Delete'
-import { Permute } from './Permute'
 import { WorkflowDirective } from './Workflow'
+import type { Directive } from './Directive'
 import type { Output } from '../../io'
 import type { Component } from '@toa.io/core'
 import type { Remotes } from '../../Remotes'
 import type { Parameter, DirectiveFamily } from '../../RTD'
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 
 export class Octets implements DirectiveFamily<Directive> {
   public readonly name: string = 'octets'
@@ -22,7 +22,7 @@ export class Octets implements DirectiveFamily<Directive> {
     const Class = DIRECTIVES[name]
 
     if (Class === undefined)
-      throw new Error(`Directive '${name}' is not provided by the '${this.name}' family.`)
+      throw new Error(`Directive 'octets:${name}' is not implemented.`)
 
     this.discovery ??= remotes.discover('octets', 'storage')
 
@@ -55,7 +55,7 @@ export class Octets implements DirectiveFamily<Directive> {
       throw new NotFound(`Trailing slash is ${action.targeted ? 'redundant' : 'required'}.`)
 
     // noinspection JSObjectNullOrUndefined
-    return action.apply(context.storage, input, parameters)
+    return await input.timing.capture(action.name, action.apply(context.storage, input, parameters))
   }
 }
 
@@ -65,7 +65,6 @@ const DIRECTIVES: Record<string, Constructor> = {
   fetch: Fetch,
   list: List,
   delete: Delete,
-  permute: Permute,
   workflow: WorkflowDirective
 }
 

package/source/directives/octets/Store.ts

@@ -4,6 +4,7 @@ import { BadRequest, UnsupportedMediaType } from '../../HTTP'
 import { cors } from '../cors'
 import * as schemas from './schemas'
 import { Workflow } from './workflows'
+import { Directive } from './Directive'
 import type { Readable } from 'stream'
 import type { Parameter } from '../../RTD'
 import type { Unit } from './workflows'
@@ -12,9 +13,9 @@ import type { Remotes } from '../../Remotes'
 import type { ErrorType } from 'error-value'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 
-export class Store implements Directive {
+export class Store extends Directive {
   public readonly targeted = false
 
   private readonly accept?: string
@@ -24,6 +25,7 @@ export class Store implements Directive {
 
   public constructor
   (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
+    super()
     schemas.store.validate(options)
 
     this.accept = match(options?.accept,

package/source/directives/octets/Workflow.ts

@@ -1,8 +1,9 @@
 import { NotFound } from '../../HTTP'
 import * as schemas from './schemas'
 import { Workflow } from './workflows'
+import { Directive } from './Directive'
 import type { Unit } from './workflows'
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
 import type { Remotes } from '../../Remotes'
@@ -10,7 +11,7 @@ import type { Maybe } from '@toa.io/types'
 import type { Entry } from '@toa.io/extensions.storages'
 import type { Parameter } from '../../RTD'
 
-export class WorkflowDirective implements Directive {
+export class WorkflowDirective extends Directive {
   public readonly targeted = true
 
   private readonly workflow: Workflow
@@ -18,6 +19,7 @@ export class WorkflowDirective implements Directive {
   private storage: Component | null = null
 
   public constructor (units: Unit[] | Unit, discovery: Promise<Component>, remotes: Remotes) {
+    super()
     schemas.workflow.validate(units)
 
     this.workflow = new Workflow(units, remotes)
@@ -28,7 +30,12 @@ export class WorkflowDirective implements Directive {
     this.storage ??= await this.discovery
 
     const entry = await this.storage.invoke<Maybe<Entry>>('get',
-      { input: { storage, path: input.request.url } })
+      {
+        input: {
+          storage,
+          path: input.request.url
+        }
+      })
 
     if (entry instanceof Error)
       throw new NotFound()

package/source/directives/octets/schemas.ts

@@ -1,7 +1,7 @@
 import { resolve } from 'node:path'
 import schemas from '@toa.io/schemas'
-import type { Permissions as FetchPermissions } from './Fetch'
-import type { Permissions as ListPermissions } from './List'
+import type { Options as FetchOptions } from './Fetch'
+import type { Options as ListOptions } from './List'
 import type { Options as StoreOptions } from './Store'
 import type { Options as DeleteOptions } from './Delete'
 import type { Schema } from '@toa.io/schemas'
@@ -12,8 +12,8 @@ const namespace = schemas.namespace(path)
 
 export const context: Schema<string> = namespace.schema('context')
 export const store: Schema<StoreOptions | null> = namespace.schema('store')
-export const fetch: Schema<FetchPermissions | null> = namespace.schema('fetch')
+export const fetch: Schema<FetchOptions | null> = namespace.schema('fetch')
 export const remove: Schema<DeleteOptions | null> = namespace.schema('delete')
-export const list: Schema<ListPermissions | null> = namespace.schema('list')
+export const list: Schema<ListOptions | null> = namespace.schema('list')
 export const permute: Schema<null> = namespace.schema('permute')
 export const workflow: Schema<Unit[] | Unit> = namespace.schema('workflow')

package/source/directives/octets/types.ts

@@ -1,12 +1,5 @@
-import type { Parameter } from '../../RTD'
 import type * as io from '../../io'
 
-export interface Directive {
-  readonly targeted: boolean
-
-  apply: (storage: string, input: Input, parameters: Parameter[]) => io.Output | Promise<io.Output>
-}
-
 export interface Extension {
   octets?: string
 }

package/source/directives/octets/workflows/Execution.ts

@@ -1,4 +1,4 @@
-import { Readable } from 'stream'
+import { Readable } from 'node:stream'
 import type { Unit } from './Workflow'
 import type { Remotes } from '../../../Remotes'
 import type { Component } from '@toa.io/core'
@@ -39,25 +39,68 @@ export class Execution extends Readable {
 
   private async execute (unit: Unit): Promise<void> {
     const promises = Object.entries(unit).map(async ([step, endpoint]) => {
-      const result = await this.call(endpoint).catch((error: Error) => console.error(error))
+      try {
+        const result = await this.call(endpoint)
 
-      if (result instanceof Error) {
-        this.push({ error: { step, ...result } })
-        this.interrupted = true
-      } else
-        this.push({ [step]: result ?? null })
+        if (result instanceof Readable)
+          return await this.stream(step, result)
+
+        this.report(step, result)
+      } catch (e: unknown) {
+        this.exception(step, e)
+      }
     })
 
     await Promise.all(promises)
   }
 
+  private async stream (step: string, stream: Readable): Promise<void> {
+    try {
+      for await (const result of stream)
+        this.report(step, result, false)
+
+      this.report(step, undefined, true)
+    } catch (e: unknown) {
+      this.exception(step, e)
+    }
+  }
+
+  private report (step: string, result?: Maybe<unknown>, completed = true): void {
+    const report: Report = { step }
+
+    if (completed)
+      report.status = 'completed'
+
+    if (result instanceof Error) {
+      report.error = result
+      this.interrupted = true
+    } else if (result !== undefined)
+      report.output = result
+
+    this.push(report)
+  }
+
+  private exception (step: string, error: unknown): void {
+    this.push({ step, status: 'exception' } satisfies Report)
+    this.interrupted = true
+
+    console.error(error)
+  }
+
   private async call (endpoint: string): Promise<Maybe<unknown>> {
+    let task = false
+
+    if (endpoint.startsWith('task:')) {
+      endpoint = endpoint.slice(5)
+      task = true
+    }
+
     const [operation, component, namespace = 'default'] = endpoint.split('.').reverse()
     const key = `${namespace}.${component}`
 
     this.components[key] ??= await this.discover(key, namespace, component)
 
-    return await this.components[key].invoke(operation, { input: this.context })
+    return this.components[key].invoke(operation, { input: this.context, task })
   }
 
   private async discover (key: string, namespace: string, component: string): Promise<Component> {
@@ -69,8 +112,16 @@ export class Execution extends Readable {
 }
 
 export interface Context {
+  authority: string
   storage: string
   path: string
   entry: Entry
   parameters: Record<string, string>
 }
+
+interface Report {
+  step: string
+  status?: 'completed' | 'exception'
+  output?: unknown
+  error?: Error
+}

package/source/directives/octets/workflows/Workflow.ts

@@ -23,12 +23,13 @@ export class Workflow {
   public execute
   (input: Input, storage: string, entry: Entry, params: Parameter[]): Execution {
     const path = posix.join(input.request.url, entry.id)
+    const authority = input.authority
     const parameters: Record<string, string> = {}
 
     for (const { name, value } of params)
       parameters[name] = value
 
-    const context: Context = { storage, path, entry, parameters }
+    const context: Context = { authority, storage, path, entry, parameters }
 
     return new Execution(context, this.units, this.remotes)
   }

package/source/directives/require/Directive.ts

@@ -0,0 +1,5 @@
+import type { Input } from '../../io'
+
+export interface Directive {
+  preflight: (context: Input) => void
+}

package/source/directives/require/Headers.ts

@@ -0,0 +1,20 @@
+import { BadRequest } from '../../HTTP'
+import type { Input } from '../../io'
+import type { Directive } from './Directive'
+
+export class Headers implements Directive {
+  private readonly headers: string[]
+
+  public constructor (headers: string[]) {
+    if (!Array.isArray(headers))
+      headers = [headers]
+
+    this.headers = headers
+  }
+
+  public preflight (context: Input): void {
+    for (const header of this.headers)
+      if (context.request.headers[header] === undefined)
+        throw new BadRequest(`Header required: ${header}`)
+  }
+}

package/source/directives/require/Require.ts

@@ -0,0 +1,28 @@
+import assert from 'node:assert'
+import { Headers } from './Headers'
+import type { Input } from '../../io'
+import type { Directive } from './Directive'
+import type { DirectiveFamily } from '../../RTD'
+
+export class Require implements DirectiveFamily {
+  public readonly name = 'require'
+  public readonly mandatory = false
+
+  public create (name: string, value: unknown): Directive {
+    assert.ok(name in directives, `Unknown directive: require:${name}`)
+
+    return new directives[name](value)
+  }
+
+  public preflight (instances: Directive[], context: Input): null {
+    for (const instance of instances)
+      instance.preflight(context)
+
+    return null
+  }
+}
+
+const directives: Record<string, new (value: any) => Directive> = {
+  header: Headers,
+  headers: Headers
+}

package/source/directives/require/index.ts

@@ -0,0 +1,3 @@
+import { Require } from './Require'
+
+export const req = new Require()

package/source/directives/vary/Directive.ts

@@ -1,6 +1,7 @@
 import type { Properties } from './Properties'
 import type { Input } from '../../io'
+import type { Parameter } from '../../RTD'
 
 export interface Directive {
-  preflight: (request: Input, properties: Properties) => void
+  preflight: (context: Input, properties: Properties, parameters: Parameter[]) => void
 }

package/source/directives/vary/Embed.ts

@@ -1,9 +1,10 @@
 import assert from 'node:assert'
-import { Header, embeddings } from './embeddings'
+import { Header, embeddings, Parameter } from './embeddings'
 import type { Embedding } from './embeddings'
 import type { Input } from '../../io'
 import type { Directive } from './Directive'
 import type { Properties } from './Properties'
+import type * as RTD from '../../RTD'
 
 export class Embed implements Directive {
   private readonly embeddings: Array<[string, Embedding[]]> = []
@@ -16,6 +17,9 @@ export class Embed implements Directive {
         if (name[0] === ':')
           return new Header(name.slice(1))
 
+        if (name.slice(0, 2) === '/:')
+          return new Parameter(name.slice(2))
+
         assert.ok(name in embeddings, `Unknown embedding: ${name}`)
 
         return new embeddings[name]()
@@ -25,27 +29,29 @@ export class Embed implements Directive {
     }
   }
 
-  public preflight (input: Input, properties: Properties): void {
+  public preflight (context: Input, properties: Properties, parameters: RTD.Parameter[]): void {
     const values: Record<string, unknown> = {}
 
     for (const [key, instances] of this.embeddings)
-      values[key] = this.resolve(instances, input, properties)
+      values[key] = this.resolve(instances, context, properties, parameters)
 
-    input.pipelines.body.push(this.embedding(values))
+    context.pipelines.body.push(this.embedding(values))
   }
 
-  private resolve (instances: Embedding[], input: Input, properties: Properties): unknown {
+  // eslint-disable-next-line max-params
+  private resolve (instances: Embedding[],
+    input: Input,
+    properties: Properties,
+    parameters: RTD.Parameter[]): unknown {
     let value
 
     for (const instance of instances) {
-      value = instance.resolve(input, properties)
+      value = instance.resolve(input, properties, parameters)
 
       if (value !== undefined)
         break
     }
 
-    assert.ok(value !== undefined, 'Neither embedding resolved a value.')
-
     return value
   }
 

package/source/directives/vary/Vary.ts

@@ -3,7 +3,7 @@ import { properties, Property } from './Properties'
 import { Embed } from './Embed'
 import type { Properties } from './Properties'
 import type { Directive } from './Directive'
-import type { DirectiveFamily } from '../../RTD'
+import type { DirectiveFamily, Parameter } from '../../RTD'
 import type { Input, Output } from '../../io'
 
 export class Vary implements DirectiveFamily {
@@ -15,11 +15,13 @@ export class Vary implements DirectiveFamily {
       () => name in properties, (name: PN) => new Property(name, value as PV),
       () => name in directives, (name: keyof typeof directives) => new directives[name](value),
       () => {
-        throw new Error(`Unknown directive 'vary:${name}'`)
+        throw new Error(`Directive 'vary:${name}' is not implemented.`)
       })
   }
 
-  public preflight (instances: Array<Directive | Property>, request: Input): Output {
+  public preflight (instances: Array<Directive | Property>,
+    context: Input,
+    parameters: Parameter[]): Output {
     /*
     To stop constructing `properties` object on each request, Directive Families must be refactored
     from singleton factories to per-Node instances on the Tree.
@@ -34,7 +36,7 @@ export class Vary implements DirectiveFamily {
         directives.push(instance)
 
     for (const directive of directives)
-      directive.preflight(request, properties)
+      directive.preflight(context, properties, parameters)
 
     return null
   }

package/source/directives/vary/embeddings/Authority.ts

@@ -0,0 +1,8 @@
+import type { Embedding } from './Embedding'
+import type { Input } from '../../../io'
+
+export class Authority implements Embedding {
+  public resolve (context: Input): string {
+    return context.authority
+  }
+}

package/source/directives/vary/embeddings/Embedding.ts

@@ -1,6 +1,7 @@
 import type { Properties } from '../Properties'
 import type { Input } from '../../../io'
+import type { Parameter } from '../../../RTD'
 
 export interface Embedding {
-  resolve: (input: Input, properties: Properties) => string | undefined
+  resolve: (input: Input, properties: Properties, parameters: Parameter[]) => string | undefined
 }

package/source/directives/vary/embeddings/Header.ts

@@ -6,9 +6,10 @@ export class Header implements Embedding {
   private readonly name: string
 
   public constructor (name: string) {
-    this.name = name
+    this.name = name.toLowerCase()
 
-    cors.allow(this.name)
+    if (this.name !== 'host')
+      cors.allow(this.name)
   }
 
   public resolve (input: Input): string | undefined {
@@ -17,10 +18,11 @@ export class Header implements Embedding {
     if (value === undefined)
       return value
 
-    input.pipelines.response.push((response) => {
-      response.headers ??= new Headers()
-      response.headers.append('vary', this.name)
-    })
+    if (this.name !== 'host')
+      input.pipelines.response.push((response) => {
+        response.headers ??= new Headers()
+        response.headers.append('vary', this.name)
+      })
 
     if (Array.isArray(value))
       return value.join(', ')

package/source/directives/vary/embeddings/Parameter.ts

@@ -0,0 +1,14 @@
+import type { Embedding } from './Embedding'
+import type * as RTD from '../../../RTD'
+
+export class Parameter implements Embedding {
+  private readonly name: string
+
+  public constructor (name: string) {
+    this.name = name
+  }
+
+  public resolve (_: unknown, __: unknown, parameters: RTD.Parameter[]): string | undefined {
+    return parameters.find((parameter) => parameter.name === this.name)?.value
+  }
+}

package/source/directives/vary/embeddings/index.ts

@@ -1,11 +1,13 @@
 import { Language } from './Language'
-import { Header } from './Header'
-
+import { Authority } from './Authority'
 import type { Embedding } from './Embedding'
 
 export const embeddings: Record<string, new () => Embedding> = {
-  language: Language
+  language: Language,
+  authority: Authority
 }
 
-export { Header }
 export type { Embedding }
+
+export { Header } from './Header'
+export { Parameter } from './Parameter'

package/source/exceptions.ts

@@ -1,17 +1,28 @@
-import { type Exception } from '@toa.io/core'
+import { match } from 'matchacho'
 import * as http from './HTTP'
+import { Exception as HTTPException } from './HTTP'
+import type { Exception } from '@toa.io/core'
 
-export function rethrow (exception: Exception): void {
-  // see /runtime/core/src/exceptions.js
-
-  if ((exception.code >= 200 && exception.code < 210) || exception.code === 221)
-    throw new http.BadRequest(exception.message)
+export function rethrow (exception: Exception | HTTPException): void {
+  if (exception instanceof HTTPException)
+    throw exception
 
-  if (exception.code === 302)
-    throw new http.NotFound()
+  // see /runtime/core/src/exceptions.js
+  throw match(exception.code,
+    badRequest, () => new http.BadRequest(exception.message),
+    302, NOT_FOUND,
+    303, PRECONDITION_FAILED,
+    306, () => new http.Conflict(),
+    () => {
+      console.error(exception)
 
-  if (exception.code === 303)
-    throw new http.PreconditionFailed()
+      return exception
+    })
+}
 
-  throw exception as unknown as Error
+function badRequest (code: number): boolean {
+  return (code >= 200 && code < 210) || code === 221
 }
+
+const NOT_FOUND = new http.NotFound()
+const PRECONDITION_FAILED = new http.PreconditionFailed()