@toa.io/extensions.exposition 1.0.0-alpha.9 → 1.0.0-alpha.91

package/source/directives/octets/{Store.ts → Put.ts}

@@ -1,10 +1,11 @@
 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 { toBytes } from './bytes'
 import type { Readable } from 'stream'
 import type { Parameter } from '../../RTD'
 import type { Unit } from './workflows'
@@ -15,10 +16,13 @@ import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
 import type { Input } from './types'
 
-export class Store extends Directive {
+export class Put extends Directive {
   public readonly targeted = false
 
   private readonly accept?: string
+  private readonly limit: number
+  private readonly limitString: string
+  private readonly trust?: Array<string | RegExp>
   private readonly workflow?: Workflow
   private readonly discovery: Record<string, Promise<Component>> = {}
   private storage: Component | null = null
@@ -26,7 +30,8 @@ export class Store extends Directive {
   public constructor
   (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
     super()
-    schemas.store.validate(options)
+
+    schemas.put.validate<Options>(options)
 
     this.accept = match(options?.accept,
       String, (value: string) => value,
@@ -36,9 +41,16 @@ export class Store extends 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.limitString = options?.limit ?? '64MiB'
+    this.limit = toBytes(this.limitString)
     this.discovery.storage = discovery
 
-    cors.allow('content-meta')
+    cors.allow('content-attributes')
+    cors.allow('content-location')
   }
 
   public async apply (storage: string, input: Input, parameters: Parameter[]): Promise<Output> {
@@ -47,19 +59,14 @@ export class Store extends Directive {
     const request: StoreRequest = {
       input: {
         storage,
-        request: input.request
+        request: input.request,
+        accept: this.accept,
+        limit: this.limit,
+        trust: this.trust
       }
     }
 
-    const meta = input.request.headers['content-meta']
-
-    if (this.accept !== undefined)
-      request.input.accept = this.accept
-
-    if (meta !== undefined)
-      request.input.meta = this.parseMeta(meta)
-
-    const entry = await this.storage.invoke<Entry>('store', request)
+    const entry = await this.storage.invoke<Entry>('put', request)
 
     return match<Output>(entry,
       Error, (error: ErrorType) => this.throw(error),
@@ -89,31 +96,37 @@ export class Store extends 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(),
+      'LIMIT_EXCEEDED', () => new http.RequestEntityTooLarge(`Size limit is ${this.limitString}`),
+      '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 attributes (value: string | string[]): Record<string, string> {
     if (Array.isArray(value))
       value = value.join(',')
 
-    const meta: Record<string, string> = {}
+    const attributes: Record<string, string> = {}
 
     for (const pair of value.split(',')) {
       const eq = pair.indexOf('=')
       const key = (eq === -1 ? pair : pair.slice(0, eq)).trim()
 
-      meta[key] = eq === -1 ? 'true' : pair.slice(eq + 1).trim()
+      attributes[key] = eq === -1 ? 'true' : pair.slice(eq + 1).trim()
     }
 
-    return meta
+    return attributes
   }
 }
 
 export interface Options {
   accept?: string | string[]
+  limit?: string
   workflow?: Unit[] | Unit
+  trust?: string[]
 }
 
 interface StoreRequest {
@@ -121,6 +134,8 @@ interface StoreRequest {
     storage: string
     request: Input['request']
     accept?: string
-    meta?: Record<string, string>
+    limit?: number
+    trust?: Array<string | RegExp>
+    attributes?: Record<string, string>
   }
 }

package/source/directives/octets/Workflow.ts

@@ -29,7 +29,7 @@ export class WorkflowDirective extends Directive {
   public async apply (storage: string, input: Input, parameters: Parameter[]): Promise<Output> {
     this.storage ??= await this.discovery
 
-    const entry = await this.storage.invoke<Maybe<Entry>>('get',
+    const entry = await this.storage.invoke<Maybe<Entry>>('head',
       {
         input: {
           storage,

package/source/directives/octets/bytes.test.ts

@@ -0,0 +1,30 @@
+import { toBytes } from './bytes'
+
+it('should parse bytes', async () => {
+  expect(toBytes('10')).toBe(10)
+  expect(toBytes('10B')).toBe(10)
+})
+
+it('should parse binary prefix', async () => {
+  expect(toBytes('10KiB')).toBe(10240)
+  expect(toBytes('10MiB')).toBe(10485760)
+  expect(toBytes('10GiB')).toBe(10737418240)
+  expect(toBytes('10TiB')).toBe(10995116277760)
+})
+
+it('should parse decimal prefix', async () => {
+  expect(toBytes('10kB')).toBe(10000)
+  expect(toBytes('10MB')).toBe(10000000)
+  expect(toBytes('10GB')).toBe(10000000000)
+  expect(toBytes('10TB')).toBe(10000000000000)
+})
+
+it('should parse incorrect value as binary', async () => {
+  expect(toBytes('10b')).toBe(10)
+  expect(toBytes('10kb')).toBe(10240)
+  expect(toBytes('10kib')).toBe(10240)
+  expect(toBytes('10mb')).toBe(10485760)
+  expect(toBytes('10gb')).toBe(10737418240)
+  expect(toBytes('10tib')).toBe(10995116277760)
+  expect(toBytes('10Mb')).toBe(10485760)
+})

package/source/directives/octets/bytes.ts

@@ -0,0 +1,18 @@
+import assert from 'node:assert'
+
+export function toBytes (input: string): number {
+  const match = RX.exec(input)
+
+  assert.ok(match !== null, `Invalid bytes format: ${input}`)
+
+  const value = parseFloat(match.groups!.value)
+  const prefix = match.groups!.prefix?.[0].toLowerCase() ?? ''
+  const binary = match.groups!.binary !== undefined || match.groups!.unit === 'b'
+  const base = binary ? 1024 : 1000
+  const power = POWERS.indexOf(prefix)
+
+  return value * Math.pow(base, power)
+}
+
+const POWERS = ['', 'k', 'm', 'g', 't']
+const RX = /^(?<value>(\d+)(\.\d+)?)(?<prefix>[kmgt](?<binary>i)?)?(?<unit>b)?$/i

package/source/directives/octets/schemas.ts

@@ -1,8 +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 StoreOptions } from './Store'
+import type { Options as GetOptions } from './Get'
+import type { Options as PutOptions } from './Put'
 import type { Options as DeleteOptions } from './Delete'
 import type { Schema } from '@toa.io/schemas'
 import type { Unit } from './workflows'
@@ -10,10 +9,7 @@ import type { Unit } from './workflows'
 const path = resolve(__dirname, '../../../schemas/octets')
 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 put: Schema<PutOptions | null> = namespace.schema('put')
+export const get: Schema<GetOptions | null> = namespace.schema('get')
 export const remove: Schema<DeleteOptions | null> = namespace.schema('delete')
-export const list: Schema<ListPermissions | 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/workflows/Execution.ts

@@ -1,4 +1,5 @@
-import { Readable } from 'stream'
+import { Readable } from 'node:stream'
+import { console } from 'openspan'
 import type { Unit } from './Workflow'
 import type { Remotes } from '../../../Remotes'
 import type { Component } from '@toa.io/core'
@@ -39,25 +40,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('Workflow exception', error as 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 +113,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

@@ -1,10 +1,10 @@
 import { posix } from 'node:path'
 import { match } from 'matchacho'
 import { Execution } from './Execution'
+import type { Entry } from '@toa.io/extensions.storages'
 import type { Context } from './Execution'
 import type { Parameter } from '../../../RTD'
 import type { Input } from '../types'
-import type { Entry } from '@toa.io/extensions.storages'
 import type { Remotes } from '../../../Remotes'
 
 export class Workflow {
@@ -20,15 +20,15 @@ export class Workflow {
   }
 
   // eslint-disable-next-line max-params
-  public execute
-  (input: Input, storage: string, entry: Entry, params: Parameter[]): Execution {
+  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/Language.ts

@@ -12,10 +12,10 @@ export class Language implements Embedding {
 
   public resolve (input: Input, properties: Properties): string | undefined {
     assert.ok(properties.languages !== undefined,
-      'Supported languages are not defined. Use `vary:languages` directive.')
+      'Supported languages are not defined. Use `vary:languages` directive')
 
     assert.ok(properties.languages.length > 0,
-      'List of supported languages is empty.')
+      'List of supported languages is empty')
 
     const negotiator = new Negotiator(input.request)
     const language = negotiator.language(properties.languages) ?? properties.languages[0]

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,22 +1,28 @@
-import { type Exception } from '@toa.io/core'
 import { match } from 'matchacho'
+import { console } from 'openspan'
 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
+export function rethrow (exception: Exception | HTTPException): void {
+  if (exception instanceof HTTPException)
+    throw exception
 
-  throw match<Error>(exception.code,
-    badRequest(exception), () => new http.BadRequest(exception.message),
+  // 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(exception.message),
-    () => exception)
+    306, () => new http.Conflict(),
+    () => {
+      console.error('Request processing exception', exception)
+
+      return exception
+    })
 }
 
-function badRequest (exception: Exception) {
-  return (code: number): boolean => {
-    return (exception.code >= 200 && exception.code < 210) || exception.code === 221
-  }
+function badRequest (code: number): boolean {
+  return (code >= 200 && code < 210) || code === 221
 }
 
 const NOT_FOUND = new http.NotFound()