@toa.io/extensions.exposition 1.0.0-alpha.0 → 1.0.0-alpha.10

package/source/directives/octets/Store.ts

@@ -1,29 +1,31 @@
-import { Readable } from 'node:stream'
-import { posix } from 'node:path'
+import { PassThrough } from 'node:stream'
 import { match } from 'matchacho'
-import { promex } from '@toa.io/generic'
 import { BadRequest, UnsupportedMediaType } from '../../HTTP'
+import { cors } from '../cors'
 import * as schemas from './schemas'
-import type { Maybe } from '@toa.io/types'
+import { Workflow } from './workflows'
+import { Directive } from './Directive'
+import type { Readable } from 'stream'
+import type { Parameter } from '../../RTD'
+import type { Unit } from './workflows'
 import type { Entry } from '@toa.io/extensions.storages'
 import type { Remotes } from '../../Remotes'
 import type { ErrorType } from 'error-value'
 import type { Component } from '@toa.io/core'
-import type { Output } from '../../Directive'
-import type { Directive, Input } from './types'
+import type { Output } from '../../io'
+import type { Input } from './types'
 
-export class Store implements Directive {
+export class Store extends Directive {
   public readonly targeted = false
 
-  private readonly accept: string | undefined
-  private readonly workflow: Workflow | undefined
+  private readonly accept?: string
+  private readonly workflow?: Workflow
   private readonly discovery: Record<string, Promise<Component>> = {}
-  private readonly remotes: Remotes
-  private readonly components: Record<string, 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,
@@ -31,34 +33,60 @@ export class Store implements Directive {
       Array, (types: string[]) => types.join(','),
       undefined)
 
-    this.workflow = match(options?.workflow,
-      Array, (units: Unit[]) => units,
-      Object, (unit: Unit) => [unit],
-      undefined)
+    if (options?.workflow !== undefined)
+      this.workflow = new Workflow(options.workflow, remotes)
 
     this.discovery.storage = discovery
-    this.remotes = remotes
+
+    cors.allow('content-meta')
   }
 
-  public async apply (storage: string, request: Input): Promise<Output> {
+  public async apply (storage: string, input: Input, parameters: Parameter[]): Promise<Output> {
     this.storage ??= await this.discovery.storage
 
-    const input = { storage, request, accept: this.accept }
-    const entry = await this.storage.invoke('store', { input })
+    const request: StoreRequest = {
+      input: {
+        storage,
+        request: input.request
+      }
+    }
+
+    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)
 
     return match<Output>(entry,
       Error, (error: ErrorType) => this.throw(error),
-      () => this.reply(request, storage, entry))
+      () => this.reply(input, storage, entry, parameters))
   }
 
-  private reply (request: Input, storage: string, entry: Entry): Output {
+  // eslint-disable-next-line max-params
+  private reply (input: Input, storage: string, entry: Entry, parameters: Parameter[]): Output {
     const body = this.workflow === undefined
       ? entry
-      : Readable.from(this.execute(request, storage, entry))
+      : this.execute(input, storage, entry, parameters)
 
     return { body }
   }
 
+  // eslint-disable-next-line max-params
+  private execute
+  (input: Input, storage: string, entry: Entry, parameters: Parameter[]): Readable {
+    const stream = new PassThrough({ objectMode: true })
+
+    stream.push(entry)
+
+    this.workflow!.execute(input, storage, entry, parameters).pipe(stream)
+
+    return stream
+  }
+
   private throw (error: ErrorType): never {
     throw match(error.code,
       'NOT_ACCEPTABLE', () => new UnsupportedMediaType(),
@@ -66,93 +94,33 @@ export class Store implements Directive {
       error)
   }
 
-  /* eslint-disable no-useless-return, max-depth */
-
-  /**
-   * Execute workflow units sequentially, steps within a unit in parallel.
-   * Yield results as soon as they come.
-   *
-   * If you need to change this, it may take a while.
-   */
-  private async * execute (request: Input, storage: string, entry: Entry): AsyncGenerator {
-    yield entry
-
-    const path = posix.join(request.path, entry.id)
-    let interrupted = false
-
-    for (const unit of this.workflow as Workflow) {
-      if (interrupted)
-        break
-
-      const steps = Object.keys(unit)
-
-      // unit result promises queue
-      const results = Array.from(steps, promex<unknown>)
-      let next = 0
-
-      // execute steps in parallel
-      for (const step of steps)
-        // these promises are indirectly awaited in the yield loop
-        void (async () => {
-          const endpoint = unit[step]
-          const context: Context = { storage, path, entry }
-          const result = await this.call(endpoint, context)
-
-          if (interrupted)
-            return
-
-          // as a result is received, resolve the next promise from the queue
-          const promise = results[next++]
-
-          if (result instanceof Error) {
-            interrupted = true
-            promise.resolve({ error: { step, ...result } })
-
-            // cancel pending promises
-            results[next].resolve(null)
-          } else
-            promise.resolve({ [step]: result ?? null })
-        })().catch((e) => results[next].reject(e))
-
-      // yield results from the queue as they come
-      for (const promise of results) {
-        const result = await promise
-
-        if (result === null) // canceled promise
-          break
-        else
-          yield result
-      }
-    }
-  }
-
-  private async call (endpoint: string, context: Context): Promise<Maybe<unknown>> {
-    const [operation, component, namespace = 'default'] = endpoint.split('.').reverse()
-    const key = `${namespace}.${component}`
+  private parseMeta (value: string | string[]): Record<string, string> {
+    if (Array.isArray(value))
+      value = value.join(',')
 
-    this.components[key] ??= await this.discover(key, namespace, component)
+    const meta: Record<string, string> = {}
 
-    return await this.components[key].invoke(operation, { input: context })
-  }
+    for (const pair of value.split(',')) {
+      const eq = pair.indexOf('=')
+      const key = (eq === -1 ? pair : pair.slice(0, eq)).trim()
 
-  private async discover (key: string, namespace: string, component: string): Promise<Component> {
-    if (this.discovery[key] === undefined)
-      this.discovery[key] = this.remotes.discover(namespace, component)
+      meta[key] = eq === -1 ? 'true' : pair.slice(eq + 1).trim()
+    }
 
-    return await this.discovery[key]
+    return meta
   }
 }
 
-type Unit = Record<string, string>
-type Workflow = Unit[]
-
-interface Options {
-  accept: string | string[]
-  workflow: Workflow | Unit
+export interface Options {
+  accept?: string | string[]
+  workflow?: Unit[] | Unit
 }
 
-interface Context {
-  storage: string
-  path: string
-  entry: Entry
+interface StoreRequest {
+  input: {
+    storage: string
+    request: Input['request']
+    accept?: string
+    meta?: Record<string, string>
+  }
 }

package/source/directives/octets/Workflow.ts

@@ -0,0 +1,48 @@
+import { NotFound } from '../../HTTP'
+import * as schemas from './schemas'
+import { Workflow } from './workflows'
+import { Directive } from './Directive'
+import type { Unit } from './workflows'
+import type { Input } from './types'
+import type { Component } from '@toa.io/core'
+import type { Output } from '../../io'
+import type { Remotes } from '../../Remotes'
+import type { Maybe } from '@toa.io/types'
+import type { Entry } from '@toa.io/extensions.storages'
+import type { Parameter } from '../../RTD'
+
+export class WorkflowDirective extends Directive {
+  public readonly targeted = true
+
+  private readonly workflow: Workflow
+  private readonly discovery: Promise<Component>
+  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)
+    this.discovery = discovery
+  }
+
+  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',
+      {
+        input: {
+          storage,
+          path: input.request.url
+        }
+      })
+
+    if (entry instanceof Error)
+      throw new NotFound()
+
+    return {
+      status: 202,
+      body: this.workflow.execute(input, storage, entry, parameters)
+    }
+  }
+}

package/source/directives/octets/index.ts

@@ -1,3 +1,3 @@
-import Family from './Family'
+import { Octets } from './Octets'
 
-export = Family
+export const octets = new Octets()

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

@@ -0,0 +1,21 @@
+import * as schemas from './schemas'
+
+describe('workflow', () => {
+  const ok = [
+    { echo: 'hello world' },
+    [{ echo: 'hello world' }, { ok: 'ok' }]
+  ]
+
+  const oh = [
+    { echo: [] },
+    { echo: 'hello world', ok: { not: 'ok' } }
+  ]
+
+  it.each(ok)('should be valid', (workflow) => {
+    expect(() => schemas.workflow.validate(workflow)).not.toThrow()
+  })
+
+  it.each(oh)('should not be valid', (workflow) => {
+    expect(() => schemas.workflow.validate(workflow)).toThrow()
+  })
+})

package/source/directives/octets/schemas.ts

@@ -1,12 +1,19 @@
 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 DeleteOptions } from './Delete'
+import type { Schema } from '@toa.io/schemas'
+import type { Unit } from './workflows'
 
 const path = resolve(__dirname, '../../../schemas/octets')
 const namespace = schemas.namespace(path)
 
-export const context = namespace.schema('context')
-export const store = namespace.schema('store')
-export const fetch = namespace.schema('fetch')
-export const remove = namespace.schema('delete')
-export const list = namespace.schema('list')
-export const permute = namespace.schema('permute')
+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 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/types.ts

@@ -1,13 +1,7 @@
-import type * as directive from '../../Directive'
-
-export interface Directive {
-  readonly targeted: boolean
-
-  apply: (storage: string, input: Input) => directive.Output | Promise<directive.Output>
-}
+import type * as io from '../../io'
 
 export interface Extension {
   octets?: string
 }
 
-export type Input = directive.Input & Extension
+export type Input = io.Input & Extension

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

@@ -0,0 +1,76 @@
+import { Readable } from 'stream'
+import type { Unit } from './Workflow'
+import type { Remotes } from '../../../Remotes'
+import type { Component } from '@toa.io/core'
+import type { Maybe } from '@toa.io/types'
+import type { Entry } from '@toa.io/extensions.storages'
+
+export class Execution extends Readable {
+  private readonly units: Unit[]
+  private readonly remotes: Remotes
+  private readonly context: Context
+  private readonly components: Record<string, Component> = {}
+  private readonly discovery: Record<string, Promise<Component>> = {}
+  private interrupted = false
+
+  public constructor (context: Context, units: Unit[], remotes: Remotes) {
+    super({ objectMode: true })
+
+    this.context = context
+    this.units = units
+    this.remotes = remotes
+
+    void this.run()
+  }
+
+  public override _read (): void {
+  }
+
+  private async run (): Promise<void> {
+    for (const unit of this.units) {
+      await this.execute(unit)
+
+      if (this.interrupted)
+        break
+    }
+
+    this.push(null)
+  }
+
+  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))
+
+      if (result instanceof Error) {
+        this.push({ error: { step, ...result } })
+        this.interrupted = true
+      } else
+        this.push({ [step]: result ?? null })
+    })
+
+    await Promise.all(promises)
+  }
+
+  private async call (endpoint: string): Promise<Maybe<unknown>> {
+    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 })
+  }
+
+  private async discover (key: string, namespace: string, component: string): Promise<Component> {
+    if (this.discovery[key] === undefined)
+      this.discovery[key] = this.remotes.discover(namespace, component)
+
+    return await this.discovery[key]
+  }
+}
+
+export interface Context {
+  storage: string
+  path: string
+  entry: Entry
+  parameters: Record<string, string>
+}

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

@@ -0,0 +1,37 @@
+import { posix } from 'node:path'
+import { match } from 'matchacho'
+import { Execution } from './Execution'
+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 {
+  private readonly units: Unit[]
+  private readonly remotes: Remotes
+
+  public constructor (units: Unit[] | Unit, remotes: Remotes) {
+    this.units = match<Unit[]>(units,
+      Array, (units: Unit[]) => units,
+      Object, (unit: Unit) => [unit])
+
+    this.remotes = remotes
+  }
+
+  // eslint-disable-next-line max-params
+  public execute
+  (input: Input, storage: string, entry: Entry, params: Parameter[]): Execution {
+    const path = posix.join(input.request.url, entry.id)
+    const parameters: Record<string, string> = {}
+
+    for (const { name, value } of params)
+      parameters[name] = value
+
+    const context: Context = { storage, path, entry, parameters }
+
+    return new Execution(context, this.units, this.remotes)
+  }
+}
+
+export type Unit = Record<string, string>

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

@@ -0,0 +1 @@
+export { Workflow, type Unit } from './Workflow'

package/source/directives/vary/Directive.ts

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

package/source/directives/vary/Embed.ts

@@ -0,0 +1,62 @@
+import assert from 'node:assert'
+import { Header, embeddings } from './embeddings'
+import type { Embedding } from './embeddings'
+import type { Input } from '../../io'
+import type { Directive } from './Directive'
+import type { Properties } from './Properties'
+
+export class Embed implements Directive {
+  private readonly embeddings: Array<[string, Embedding[]]> = []
+
+  public constructor (map: Record<string, string | string[]>) {
+    for (const [key, values] of Object.entries(map)) {
+      const names = Array.isArray(values) ? values : [values]
+
+      const instances = names.map((name) => {
+        if (name[0] === ':')
+          return new Header(name.slice(1))
+
+        assert.ok(name in embeddings, `Unknown embedding: ${name}`)
+
+        return new embeddings[name]()
+      })
+
+      this.embeddings.push([key, instances])
+    }
+  }
+
+  public preflight (input: Input, properties: Properties): void {
+    const values: Record<string, unknown> = {}
+
+    for (const [key, instances] of this.embeddings)
+      values[key] = this.resolve(instances, input, properties)
+
+    input.pipelines.body.push(this.embedding(values))
+  }
+
+  private resolve (instances: Embedding[], input: Input, properties: Properties): unknown {
+    let value
+
+    for (const instance of instances) {
+      value = instance.resolve(input, properties)
+
+      if (value !== undefined)
+        break
+    }
+
+    assert.ok(value !== undefined, 'Neither embedding resolved a value.')
+
+    return value
+  }
+
+  private embedding (values: Record<string, unknown>) {
+    return (body: unknown): object => {
+      if (body === undefined || body === null || typeof body !== 'object')
+        return values
+
+      Object.assign(body, values)
+
+      return body
+    }
+  }
+}

package/source/directives/vary/Properties.ts

@@ -0,0 +1,17 @@
+export interface Properties {
+  languages?: string[]
+}
+
+export class Property<K extends keyof Properties = keyof Properties> {
+  public readonly name: K
+  public readonly value: Properties[K]
+
+  public constructor (name: K, value: Properties[K]) {
+    this.name = name
+    this.value = value
+  }
+}
+
+export const properties: Properties = {
+  languages: []
+}

package/source/directives/vary/Vary.ts

@@ -0,0 +1,48 @@
+import { match } from 'matchacho'
+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 { Input, Output } from '../../io'
+
+export class Vary implements DirectiveFamily {
+  public readonly name = 'vary'
+  public readonly mandatory = false
+
+  public create (name: string, value: unknown): Property | Directive {
+    return match(name,
+      () => 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}'`)
+      })
+  }
+
+  public preflight (instances: Array<Directive | Property>, request: Input): Output {
+    /*
+    To stop constructing `properties` object on each request, Directive Families must be refactored
+    from singleton factories to per-Node instances on the Tree.
+     */
+    const properties: Properties = {}
+    const directives: Directive[] = []
+
+    for (const instance of instances)
+      if (instance instanceof Property)
+        properties[instance.name] = instance.value
+      else
+        directives.push(instance)
+
+    for (const directive of directives)
+      directive.preflight(request, properties)
+
+    return null
+  }
+}
+
+type PN = keyof Properties
+type PV = Properties[PN]
+
+const directives: Record<string, new (value: any) => Directive> = {
+  embed: Embed
+}

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

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

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

@@ -0,0 +1,32 @@
+import { cors } from '../../cors'
+import type { Input } from '../../../io'
+import type { Embedding } from './Embedding'
+
+export class Header implements Embedding {
+  private readonly name: string
+
+  public constructor (name: string) {
+    this.name = name.toLowerCase()
+
+    if (this.name !== 'host')
+      cors.allow(this.name)
+  }
+
+  public resolve (input: Input): string | undefined {
+    const value = input.request.headers[this.name]
+
+    if (value === undefined)
+      return value
+
+    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(', ')
+    else
+      return value
+  }
+}

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

@@ -0,0 +1,31 @@
+import assert from 'node:assert'
+import Negotiator from 'negotiator'
+import { cors } from '../../cors'
+import type { Properties } from '../Properties'
+import type { Embedding } from './Embedding'
+import type { Input } from '../../../io'
+
+export class Language implements Embedding {
+  public constructor () {
+    cors.allow('accept-language')
+  }
+
+  public resolve (input: Input, properties: Properties): string | undefined {
+    assert.ok(properties.languages !== undefined,
+      'Supported languages are not defined. Use `vary:languages` directive.')
+
+    assert.ok(properties.languages.length > 0,
+      'List of supported languages is empty.')
+
+    const negotiator = new Negotiator(input.request)
+    const language = negotiator.language(properties.languages) ?? properties.languages[0]
+
+    input.pipelines.response.push((response) => {
+      response.headers ??= new Headers()
+      response.headers.set('content-language', language)
+      response.headers.append('vary', 'accept-language')
+    })
+
+    return language
+  }
+}