@toa.io/extensions.exposition 1.0.0-alpha.6 → 1.0.0-alpha.60

package/source/directives/flow/Fetch.ts

@@ -0,0 +1,88 @@
+import { Readable } from 'node:stream'
+import assert from 'node:assert'
+import { match } from 'matchacho'
+import { NotFound } from '../../HTTP'
+import type { Directive } from './types'
+import type { ReadableStream } from 'node:stream/web'
+import type { Remotes } from '../../Remotes'
+import type { Maybe } from '@toa.io/types'
+import type { Component } from '@toa.io/core'
+import type { Output } from '../../io'
+import type { Input } from '../octets/types'
+import type { Parameter } from '../../RTD'
+
+export class Fetch implements Directive {
+  public readonly targeted = true
+
+  private readonly connecting: Promise<Component>
+  private remote: Component | null = null
+  private readonly operation: string
+
+  public constructor (endpoint: string, discovery: Remotes) {
+    assert.equal(typeof endpoint, 'string', '`flow:redirect` must be a string')
+
+    const [operation, name, namespace = 'default'] = endpoint.split('.').reverse()
+
+    this.operation = operation
+    this.connecting = discovery.discover(namespace, name)
+  }
+
+  public async apply (input: Input, parameters: Parameter[]): Promise<Output> {
+    if ('if-none-match' in input.request.headers)
+      return { status: 304 }
+
+    this.remote ??= await this.connecting
+
+    const request = await this.remote.invoke<Maybe<Request | string>>(this.operation, {
+      input: {
+        authority: input.authority,
+        path: input.request.url,
+        parameters: Object.fromEntries(parameters.map(({ name, value }) => [name, value]))
+      }
+    })
+
+    if (request instanceof Error)
+      throw new NotFound(request)
+
+    const { url, options } = match<Request>(request,
+      String, { url: request },
+      (request: Request): Request => ({
+        url: request.url,
+        options: {
+          method: request.options?.method ?? 'GET',
+          body: request.options?.body,
+          headers: request.options?.headers
+        }
+      }))
+
+    const response = await fetch(url, options)
+
+    if (!response.ok)
+      throw new NotFound()
+
+    const headers = new Headers()
+
+    for (const header of ['content-type', 'content-length', 'etag']) {
+      const value = response.headers.get(header)
+
+      if (value !== null)
+        headers.set(header, value)
+    }
+
+    return {
+      headers,
+      body: response.body === null ? null : Readable.fromWeb(response.body as ReadableStream)
+    }
+  }
+}
+
+interface Request {
+  url: string
+  options?: RequestOptions
+}
+
+interface RequestOptions {
+  method?: string
+  body?: string
+  headers?: Record<string, string>
+}

package/source/directives/flow/Flow.ts

@@ -0,0 +1,34 @@
+import { Fetch } from './Fetch'
+import type { Directive } from './types'
+import type { Input, Output } from '../../io'
+import type { DirectiveFamily, Parameter } from '../../RTD'
+import type { Remotes } from '../../Remotes'
+
+export class Flow implements DirectiveFamily<Directive> {
+  public readonly name: string = 'flow'
+  public readonly mandatory: boolean = false
+
+  public create (name: string, value: unknown, remotes: Remotes): Directive {
+    const Class = constructors[name]
+
+    if (Class === undefined)
+      throw new Error(`Directive '${this.name}:${name}' is not implemented.`)
+
+    return new Class(value, remotes)
+  }
+
+  public async preflight (directives: Directive[], input: Input, parameters: Parameter[]): Promise<Output> {
+    for (const directive of directives) {
+      const output = await directive.apply(input, parameters)
+
+      if (output !== null)
+        return output
+    }
+
+    return null
+  }
+}
+
+const constructors: Record<string, new (value: any, discovery: Remotes) => Directive> = {
+  fetch: Fetch
+}

package/source/directives/flow/index.ts

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

package/source/directives/flow/types.ts

@@ -0,0 +1,6 @@
+import type { Input, Output } from '../../io'
+import type { Parameter } from '../../RTD'
+
+export interface Directive {
+  apply: (input: Input, parameters: Parameter[]) => Promise<Output>
+}

package/source/directives/index.ts

@@ -5,8 +5,10 @@ import { dev } from './dev'
 import { octets } from './octets'
 import { io } from './io'
 import { vary } from './vary'
+import { req } from './require'
+import { flow } from './flow'
 import type { DirectiveFamily } from '../RTD'
 import type { Interceptor } from '../Interception'
 
-export const families: DirectiveFamily[] = [authorization, io, cache, vary, octets, dev]
+export const families: DirectiveFamily[] = [authorization, io, cache, vary, req, flow, octets, dev]
 export const interceptors: Interceptor[] = [cors]

package/source/directives/io/Input.ts

@@ -23,13 +23,13 @@ export class Input implements Directive {
     try {
       schemas.message.validate(body)
     } catch {
-      throw new BadRequest('Invalid request body.')
+      throw new BadRequest('Invalid request body')
     }
 
     const property = this.violation(body)
 
     if (property !== undefined)
-      throw new BadRequest(`Unexpected input: ${property}.`)
+      throw new BadRequest(`Unexpected input: ${property}`)
 
     return body
   }

package/source/directives/octets/Context.ts

@@ -1,18 +1,19 @@
 import * as schemas from './schemas'
+import { Directive } from './Directive'
 import type { Output } from '../../io'
-import type { Directive } from './types'
 
-export class Context implements Directive {
+export class Context extends Directive {
   public readonly targeted = false
   public readonly storage: string
 
   public constructor (value: unknown) {
+    super()
     schemas.context.validate(value)
 
     this.storage = value
   }
 
-  public apply (): Output {
+  public async apply (): Promise<Output> {
     return null
   }
 }

package/source/directives/octets/Delete.ts

@@ -2,16 +2,17 @@ import { Readable } from 'stream'
 import { NotFound } from '../../HTTP'
 import * as schemas from './schemas'
 import { Workflow } from './workflows'
+import { Directive } from './Directive'
 import type { Parameter } from '../../RTD'
 import type { Unit } from './workflows'
 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'
 import type { Remotes } from '../../Remotes'
 import type { Entry } from '@toa.io/extensions.storages'
 
-export class Delete implements Directive {
+export class Delete extends Directive {
   public readonly targeted = true
 
   private readonly workflow?: Workflow
@@ -19,6 +20,7 @@ export class Delete implements Directive {
   private storage: Component | null = null
 
   public constructor (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
+    super()
     schemas.remove.validate(options)
 
     if (options?.workflow !== undefined)

package/source/directives/octets/Directive.ts

@@ -0,0 +1,10 @@
+import type { Input } from './types'
+import type { Parameter } from '../../RTD'
+import type * as io from '../../io'
+
+export abstract class Directive {
+  public readonly name = 'octets.' + this.constructor.name.toLowerCase()
+  public abstract readonly targeted: boolean
+
+  public abstract apply (storage: string, input: Input, parameters: Parameter[]): Promise<io.Output>
+}

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

@@ -1,9 +1,10 @@
 import { PassThrough } from 'node:stream'
 import { match } from 'matchacho'
-import { BadRequest, UnsupportedMediaType } from '../../HTTP'
+import * as http 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,18 +13,20 @@ 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
+  private readonly trust?: Array<string | RegExp>
   private readonly workflow?: Workflow
   private readonly discovery: Record<string, Promise<Component>> = {}
   private storage: Component | null = null
 
   public constructor
   (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
+    super()
     schemas.store.validate(options)
 
     this.accept = match(options?.accept,
@@ -34,6 +37,10 @@ export class Store implements Directive {
     if (options?.workflow !== undefined)
       this.workflow = new Workflow(options.workflow, remotes)
 
+    if (options?.trust !== undefined)
+      this.trust = options.trust.map((value: string) =>
+        value.startsWith('/') ? new RegExp(value.slice(1, -1)) : value)
+
     this.discovery.storage = discovery
 
     cors.allow('content-meta')
@@ -45,7 +52,8 @@ export class Store implements Directive {
     const request: StoreRequest = {
       input: {
         storage,
-        request: input.request
+        request: input.request,
+        trust: this.trust
       }
     }
 
@@ -55,7 +63,7 @@ export class Store implements Directive {
       request.input.accept = this.accept
 
     if (meta !== undefined)
-      request.input.meta = this.parseMeta(meta)
+      request.input.meta = this.meta(meta)
 
     const entry = await this.storage.invoke<Entry>('store', request)
 
@@ -87,12 +95,15 @@ export class Store implements Directive {
 
   private throw (error: ErrorType): never {
     throw match(error.code,
-      'NOT_ACCEPTABLE', () => new UnsupportedMediaType(),
-      'TYPE_MISMATCH', () => new BadRequest(),
+      'NOT_ACCEPTABLE', () => new http.UnsupportedMediaType(),
+      'TYPE_MISMATCH', () => new http.BadRequest(),
+      'LOCATION_UNTRUSTED', () => new http.Forbidden(error.message),
+      'LOCATION_LENGTH', () => new http.BadRequest(error.message),
+      'LOCATION_UNAVAILABLE', () => new http.NotFound(error.message),
       error)
   }
 
-  private parseMeta (value: string | string[]): Record<string, string> {
+  private meta (value: string | string[]): Record<string, string> {
     if (Array.isArray(value))
       value = value.join(',')
 
@@ -112,6 +123,7 @@ export class Store implements Directive {
 export interface Options {
   accept?: string | string[]
   workflow?: Unit[] | Unit
+  trust?: string[]
 }
 
 interface StoreRequest {
@@ -119,6 +131,7 @@ interface StoreRequest {
     storage: string
     request: Input['request']
     accept?: string
+    trust?: Array<string | RegExp>
     meta?: Record<string, string>
   }
 }

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)
   }