@toa.io/extensions.exposition 1.0.0-alpha.28 → 1.0.0-alpha.282

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

@@ -0,0 +1,34 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+
+import * as schemas from './schemas.js'
+
+describe('throttle', () => {
+  const rest = { requests: 1, interval: 1 }
+
+  it('should validate key', () => {
+    assert.doesNotThrow(() => schemas.throttle.validate({ key: 'ip', ...rest }))
+  })
+
+  it('should validate every key component', () => {
+    for (const key of ['ip', 'path', 'route', 'identity'])
+      assert.doesNotThrow(() => schemas.throttle.validate({ key, ...rest }))
+
+    assert.doesNotThrow(() => schemas.throttle.validate({ key: { segment: 'id' }, ...rest }))
+    assert.doesNotThrow(() => schemas.throttle.validate({
+      key: ['route', { segment: 'id' }],
+      ...rest
+    }))
+  })
+
+  it('should reject an unknown key component', () => {
+    assert.throws(() => schemas.throttle.validate({ key: 'header', ...rest }))
+    assert.throws(() => schemas.throttle.validate({ key: { header: 'x-real-ip' }, ...rest }))
+  })
+
+  it('should reject a declaration it no longer honours', () => {
+    // metering earns the budget back rather than locking a key out, so a `cooldown`
+    // left behind is not something to ignore quietly
+    assert.throws(() => schemas.throttle.validate({ key: 'ip', cooldown: 1, ...rest }))
+  })
+})

package/source/directives/io/schemas.ts

@@ -1,12 +1,16 @@
 import { resolve } from 'node:path'
-import schemas, { type Schema } from '@toa.io/schemas'
-import type { Permissions as InputPermissions } from './Input'
-import type { Permissions as OutputPermissions } from './Output'
-import type { Message } from './Message'
+import * as schemas from '@toa.io/schemas'
+import type { Schema } from '@toa.io/schemas'
+import type { Permissions as InputPermissions } from './Input.js'
+import type { Permissions as OutputPermissions } from './Output.js'
+import type { Declaration as ThrottleDeclaration } from './lib/throttle/index.js'
 
-const path = resolve(__dirname, '../../../schemas/io')
+import type { Message } from './Message.js'
+
+const path = resolve(import.meta.dirname, '../../../schemas/io')
 const namespace = schemas.namespace(path)
 
 export const message: Schema<Message | Message[]> = namespace.schema('message')
 export const input: Schema<InputPermissions> = namespace.schema('input')
 export const output: Schema<OutputPermissions> = namespace.schema('output')
+export const throttle: Schema<ThrottleDeclaration> = namespace.schema('throttle')

package/source/directives/map/Authority.ts

@@ -0,0 +1,15 @@
+import assert from 'node:assert'
+import { Mapping } from './Mapping.js'
+import type { Input } from '../../io.js'
+
+export class Authority extends Mapping<string> {
+  public constructor (property: string) {
+    assert.ok(typeof property === 'string', '`map:authority` must be a string')
+
+    super(property)
+  }
+
+  public properties (context: Input): Record<string, string> {
+    return { [this.value]: context.authority }
+  }
+}

package/source/directives/map/Buffer.ts

@@ -0,0 +1,15 @@
+import assert from 'node:assert'
+import { Mapping } from './Mapping.js'
+import type { Input } from '../../io.js'
+
+export class BufferMapping extends Mapping<string> {
+  public constructor (property: string) {
+    assert.ok(typeof property === 'string', '`map:buffer` must be a string')
+
+    super(property)
+  }
+
+  public override async properties (context: Input): Promise<Record<string, string>> {
+    return { [this.value]: (await context.buffer()).toString('utf8') }
+  }
+}

package/source/directives/map/Claims.ts

@@ -0,0 +1,58 @@
+import assert from 'node:assert'
+import { Mapping } from './Mapping.js'
+import type { Component } from '@toa.io/core'
+import type { Remotes } from '../../Remotes.js'
+import type { Input } from '../../io.js'
+
+export class Claims extends Mapping<Record<string, string>> {
+  private readonly discovery!: Promise<Component>
+  private federation: Component | null = null
+
+  public constructor (map: Record<string, string>, remotes: Remotes) {
+    assert.ok(map.constructor === Object, '`map:claims` must be an object')
+
+    assert.ok(Object.values(map).every((value) => typeof value === 'string'),
+      '`map:claims ` must be an object with string values')
+
+    super(map, remotes)
+
+    this.discovery = remotes.discover('identity', 'federation')
+  }
+
+  public override async properties (context: Input): Promise<Record<string, string> | null> {
+    const authentication = context.request.headers.authorization
+
+    if (authentication === undefined)
+      return null
+
+    const claims = await this.claims(authentication)
+
+    if (claims === null)
+      return null
+
+    return Object.entries(this.value).reduce((properties: Record<string, string>, [property, claim]) => {
+      const value = claims[claim]
+
+      if (value !== undefined)
+        properties[property] = value
+
+      return properties
+    }, {})
+  }
+
+  private async claims (authentication: string): Promise<Record<string, string> | null> {
+    const [scheme, credentials] = authentication.split(' ')
+
+    if (scheme !== 'Bearer' || credentials === undefined)
+      return null
+
+    this.federation ??= await this.discovery
+
+    const claims = await this.federation.invoke<Record<string, string> | Error>('decode', { input: credentials })
+
+    if (claims instanceof Error)
+      return null
+
+    return claims
+  }
+}

package/source/directives/map/Directive.ts

@@ -0,0 +1,4 @@
+import type { Mapping } from './Mapping.js'
+import type { Property } from './Properties.js'
+
+export type Directive = Mapping | Property

package/source/directives/map/Headers.ts

@@ -0,0 +1,45 @@
+import assert from 'node:assert'
+import { cors } from '../cors/index.js'
+import { Mapping } from './Mapping.js'
+import type { Input } from '../../io.js'
+
+/**
+ * Forbidden request header names: the browser sets them itself and a script cannot
+ * list them in `Access-Control-Request-Headers`, so there is nothing to advertise
+ * or vary on. The value is still read, it just never reaches CORS.
+ */
+const FORBIDDEN = new Set(['host', 'origin'])
+
+export class Headers extends Mapping<Record<string, string>> {
+  private readonly headers: string[]
+
+  public constructor (map: Record<string, string>) {
+    assert.ok(map.constructor === Object, '`map:headers` must be an object')
+
+    assert.ok(Object.values(map).every((value) => typeof value === 'string'),
+      '`map:headers` must be an object with string values')
+
+    super(map)
+
+    this.headers = Object.values(map).filter((header) => !FORBIDDEN.has(header))
+    this.headers.forEach((header) => cors.allow(header))
+  }
+
+  public properties (context: Input): Record<string, string> {
+    context.pipelines.response.push((response) => {
+      response.headers ??= new global.Headers()
+
+      for (const header of this.headers)
+        response.headers.append('vary', header)
+    })
+
+    return Object.entries(this.value).reduce((properties: Record<string, string>, [property, header]) => {
+      const value = context.request.headers[header]
+
+      if (value !== undefined)
+        properties[property] = Array.isArray(value) ? value.join(', ') : value
+
+      return properties
+    }, {})
+  }
+}

package/source/directives/map/Language.ts

@@ -0,0 +1,42 @@
+import assert from 'node:assert'
+import Negotiator from 'negotiator'
+import { cors } from '../cors/index.js'
+import { Mapping } from './Mapping.js'
+import { Languages } from './Languages.js'
+import type { Input } from '../../io.js'
+import type { Parameter } from '../../RTD/index.js'
+import type { Directive } from './Directive.js'
+
+export class Language extends Mapping<string> {
+  private languages: string[] | null = null
+
+  public constructor (property: string) {
+    assert.ok(typeof property === 'string', '`map:language` must be a string')
+
+    cors.allow('accept-language')
+    super(property)
+  }
+
+  public properties (context: Input, parameters: Parameter[], directives: Directive[]): Record<string, string> {
+    this.languages ??= this.resolve(directives)
+
+    const negotiator = new Negotiator(context.request)
+    const language = negotiator.language(this.languages) ?? this.languages[0]
+
+    context.pipelines.response.push((response) => {
+      response.headers ??= new Headers()
+      response.headers.set('content-language', language)
+      response.headers.append('vary', 'accept-language')
+    })
+
+    return { [this.value]: language }
+  }
+
+  private resolve (directives: Directive[]): string[] {
+    for (const directive of directives)
+      if (directive instanceof Languages)
+        return directive.value
+
+    throw new Error('Supported languages are not defined, add `map:languages` directive')
+  }
+}

package/source/directives/map/Languages.ts

@@ -0,0 +1,11 @@
+import assert from 'node:assert'
+import { Property } from './Properties.js'
+
+export class Languages extends Property<'languages'> {
+  public constructor (value: string[]) {
+    assert.ok(Array.isArray(value) && value.length > 0, '`map:languages` must be a non-empty array of strings')
+    assert.ok(value.every((language) => typeof language === 'string'), '`map:languages` must be an array of strings')
+
+    super('languages', value)
+  }
+}

package/source/directives/map/Map.ts

@@ -0,0 +1,63 @@
+import { match } from 'matchacho'
+import { properties, Property } from './Properties.js'
+import { Mapping } from './Mapping.js'
+import { Headers } from './Headers.js'
+import { Languages } from './Languages.js'
+import { Language } from './Language.js'
+import { Segments } from './Segments.js'
+import { Authority } from './Authority.js'
+import { BufferMapping } from './Buffer.js'
+import { Claims } from './Claims.js'
+import type { Directive } from './Directive.js'
+import type { Properties } from './Properties.js'
+import type { DirectiveFamily, Parameter } from '../../RTD/index.js'
+import type { Input, Output } from '../../io.js'
+import type { Remotes } from '../../Remotes.js'
+
+export class Map implements DirectiveFamily {
+  public readonly name = 'map'
+  public readonly mandatory = false
+
+  private remotes!: Remotes
+
+  public create (name: string, value: unknown, remotes: Remotes): Property | Mapping {
+    this.remotes = remotes
+
+    return match(name,
+      () => properties.has(name), (name: PN) => new Property(name, value as PV),
+      () => name in mappings, (name: keyof typeof mappings) => new mappings[name](value, remotes),
+      () => {
+        throw new Error(`Directive 'map:${name}' is not implemented`)
+      })
+  }
+
+  public async preflight (directives: Directive[], context: Input, parameters: Parameter[]): Promise<Output> {
+    const properties = {}
+
+    for (const directive of directives)
+      if (directive instanceof Mapping)
+        Object.assign(properties, await directive.properties(context, parameters, directives))
+
+    context.pipelines.body.push((body: unknown) => {
+      if (body === undefined || body === null || typeof body !== 'object')
+        return properties
+      else
+        return Object.assign(body, properties)
+    })
+
+    return null
+  }
+}
+
+type PN = keyof Properties
+type PV = Properties[PN]
+
+const mappings: Record<string, new (value: any, remotes: Remotes) => Directive> = {
+  authority: Authority,
+  buffer: BufferMapping,
+  headers: Headers,
+  languages: Languages,
+  language: Language,
+  segments: Segments,
+  claims: Claims
+}

package/source/directives/map/Mapping.ts

@@ -0,0 +1,19 @@
+import type { Remotes } from '../../Remotes.js'
+import type { Directive } from './Directive.js'
+import type { Input } from '../../io.js'
+import type { Parameter } from '../../RTD/index.js'
+
+export abstract class Mapping<T = unknown> {
+  protected value: T
+  protected remotes?: Remotes
+
+  protected constructor (value: T, remotes?: Remotes) {
+    this.value = value
+    this.remotes = remotes
+  }
+
+  public abstract properties (context: Input, parameters: Parameter[], directives: Directive[]): Output
+}
+
+type Properties = Record<string, unknown> | null
+type Output = Properties | Promise<Properties>

package/source/directives/{vary → map}/Properties.ts

@@ -1,5 +1,5 @@
 export interface Properties {
-  languages?: string[]
+  languages: string[]
 }
 
 export class Property<K extends keyof Properties = keyof Properties> {
@@ -12,6 +12,4 @@ export class Property<K extends keyof Properties = keyof Properties> {
   }
 }
 
-export const properties: Properties = {
-  languages: []
-}
+export const properties = new Set('languages')

package/source/directives/map/Segments.ts

@@ -0,0 +1,33 @@
+import assert from 'node:assert'
+import { Mapping } from './Mapping.js'
+import type { Parameter } from '../../RTD/index.js'
+
+export class Segments extends Mapping<Record<string, string>> {
+  public constructor (map: Record<string, string>) {
+    assert.ok(map.constructor === Object, '`map:segments` must be an object')
+
+    assert.ok(Object.values(map).every((value) => typeof value === 'string'),
+      '`map:segments ` must be an object with string values')
+
+    super(map)
+  }
+
+  public override properties (_: unknown, parameters: Parameter[]): Record<string, string> {
+    return Object.entries(this.value).reduce((properties: Record<string, string>, [property, parameter]) => {
+      const cut = parameter[0] === '~'
+
+      if (cut) parameter = parameter.slice(1)
+
+      const index = parameters.findIndex(({ name }) => name === parameter)
+
+      assert.ok(index > -1, `Route parameter '${parameter}' is missing`)
+
+      properties[property] = parameters[index].value
+
+      if (cut)
+        parameters.splice(index, 1)
+
+      return properties
+    }, {})
+  }
+}

package/source/directives/map/index.ts

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

package/source/directives/octets/Context.ts

@@ -1,6 +1,6 @@
-import * as schemas from './schemas'
-import { Directive } from './Directive'
-import type { Output } from '../../io'
+import assert from 'node:assert'
+import { Directive } from './Directive.js'
+import type { Output } from '../../io.js'
 
 export class Context extends Directive {
   public readonly targeted = false
@@ -8,7 +8,8 @@ export class Context extends Directive {
 
   public constructor (value: unknown) {
     super()
-    schemas.context.validate(value)
+
+    assert.ok(typeof value === 'string', 'Directive \'octets:context\' must must be a string')
 
     this.storage = value
   }

package/source/directives/octets/Delete.ts

@@ -1,15 +1,15 @@
 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 { NotFound } from '../../HTTP/index.js'
+import * as schemas from './schemas.js'
+import { Workflow } from './workflows/index.js'
+import { Directive } from './Directive.js'
+import type { Parameter } from '../../RTD/index.js'
+import type { Unit, Location } from './workflows/index.js'
 import type { Maybe } from '@toa.io/types'
 import type { Component } from '@toa.io/core'
-import type { Output } from '../../io'
-import type { Input } from './types'
-import type { Remotes } from '../../Remotes'
+import type { Output } from '../../io.js'
+import type { Input } from './types.js'
+import type { Remotes } from '../../Remotes.js'
 import type { Entry } from '@toa.io/extensions.storages'
 
 export class Delete extends Directive {
@@ -17,7 +17,7 @@ export class Delete extends Directive {
 
   private readonly workflow?: Workflow
   private readonly discovery: Promise<Component>
-  private storage: Component | null = null
+  private storage!: Component
 
   public constructor (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
     super()
@@ -32,20 +32,20 @@ export class Delete 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',
-      {
-        input: {
-          storage,
-          path: input.request.url
-        }
-      })
-
-    if (entry instanceof Error)
-      throw new NotFound()
-
     const output: Output = {}
 
     if (this.workflow !== undefined) {
+      const entry = await this.storage.invoke<Maybe<Entry>>('head',
+        {
+          input: {
+            storage,
+            path: input.request.url
+          }
+        })
+
+      if (entry instanceof Error)
+        throw new NotFound()
+
       output.status = 202
       output.body = Readable.from(this.execute(input, storage, entry, parameters))
     } else
@@ -55,8 +55,7 @@ export class Delete extends Directive {
   }
 
   private async delete (storage: string, input: Input): Promise<void> {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    await this.storage!.invoke('delete',
+    await this.storage.invoke('delete',
       {
         input: {
           storage,
@@ -66,10 +65,14 @@ export class Delete extends Directive {
   }
 
   // eslint-disable-next-line max-params
-  private async * execute
-  (input: Input, storage: string, entry: Entry, parameters: Parameter[]): AsyncGenerator {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    for await (const chunk of this.workflow!.execute(input, storage, entry, parameters)) {
+  private async * execute (input: Input, storage: string, entry: Entry, parameters: Parameter[]): AsyncGenerator {
+    const location: Location = {
+      storage,
+      authority: input.authority,
+      path: input.request.url
+    }
+
+    for await (const chunk of this.workflow!.execute(location, entry, parameters)) {
       yield chunk
 
       if (typeof chunk === 'object' && chunk !== null && 'error' in chunk)

package/source/directives/octets/Directive.ts

@@ -1,6 +1,6 @@
-import type { Input } from './types'
-import type { Parameter } from '../../RTD'
-import type * as io from '../../io'
+import type { Input } from './types.js'
+import type { Parameter } from '../../RTD/index.js'
+import type * as io from '../../io.js'
 
 export abstract class Directive {
   public readonly name = 'octets.' + this.constructor.name.toLowerCase()

package/source/directives/octets/Get.ts

@@ -0,0 +1,96 @@
+import { Forbidden, NotFound } from '../../HTTP/index.js'
+import * as schemas from './schemas.js'
+import { Directive } from './Directive.js'
+import type { Maybe } from '@toa.io/types'
+import type { Entry, Stream } from '@toa.io/extensions.storages'
+import type { Component } from '@toa.io/core'
+import type { Output } from '../../io.js'
+import type { Input } from './types.js'
+
+export class Get extends Directive {
+  public readonly targeted = true
+
+  private readonly options: Required<Options> = {
+    meta: false
+  }
+
+  private readonly discovery: Promise<Component>
+  private storage!: Component
+
+  public constructor (options: Options | null, discovery: Promise<Component>) {
+    super()
+
+    schemas.get.validate(options)
+    Object.assign(this.options, options)
+
+    this.discovery = discovery
+  }
+
+  public async apply (storage: string, input: Input): Promise<Output> {
+    this.storage ??= await this.discovery
+
+    if (input.subtype === 'octets.entry')
+      if (this.options.meta)
+        return this.head(storage, input)
+      else
+        throw new Forbidden('Metadata is not accessible')
+    else
+      return await this.get(storage, input)
+  }
+
+  private async get (storage: string, input: Input): Promise<Output> {
+    if ('if-none-match' in input.request.headers)
+      return { status: 304 }
+
+    const endpoint = input.request.method === 'GET' ? 'get' : 'head'
+
+    const entry = await this.storage.invoke<Maybe<Stream>>(endpoint, {
+      input: {
+        storage,
+        path: input.request.url,
+        range: input.request.headers.range,
+        agent: input.request.headers['user-agent']
+      }
+    })
+
+    if (entry instanceof Error)
+      throw new NotFound()
+
+    const headers = new Headers({
+      'content-type': entry.type,
+      etag: `"${entry.checksum}"`
+    })
+
+    if (entry.range !== undefined)
+      headers.set('content-range', entry.range)
+
+    // an absent content-length is what says the length is unknown; naming the encoding
+    // is redundant over HTTP/1.1 and forbidden over HTTP/2
+    if (entry.size !== null)
+      headers.set('content-length', entry.size.toString())
+
+    return {
+      status: entry.partial === true ? 206 : 200,
+      headers,
+      body: endpoint === 'get' ? entry.stream : undefined
+    }
+  }
+
+  private async head (storage: string, input: Input): Promise<Output> {
+    const entry = await this.storage.invoke<Maybe<Entry>>('head', {
+      input: {
+        storage,
+        path: input.request.url
+      }
+    })
+
+    if (entry instanceof Error)
+      throw new NotFound()
+
+    return { body: entry }
+  }
+}
+
+export interface Options {
+  meta?: boolean
+}