@toa.io/extensions.exposition 1.0.0-alpha.27 → 1.0.0-alpha.271

package/source/directives/dev/Sleep.ts

@@ -0,0 +1,55 @@
+import assert from 'node:assert'
+import { setTimeout } from 'node:timers/promises'
+import { console } from 'openspan'
+import { cors } from '../cors'
+import { BadRequest } from '../../HTTP'
+import type { Directive } from './types'
+import type { Input, Output } from '../../io'
+
+export class Sleep implements Directive {
+  private static warned = false
+  private readonly maximum: number
+
+  public constructor (value: number) {
+    assert.ok(Number.isInteger(value), '`dev:sleep` directive value must be an integer')
+
+    if (!Sleep.warned) {
+      console.warn('Sleep directive is enabled', { maximum: value })
+      Sleep.warned = true
+    }
+
+    cors.allow('sleep')
+    this.maximum = value
+  }
+
+  public async apply (input: Input): Promise<Output> {
+    const value = input.request.headers.sleep as string | undefined
+
+    if (value === undefined)
+      return null
+
+    const [min, max] = this.parse(value)
+
+    if (min < 0 || max < 0 || min > max || max > this.maximum)
+      throw new BadRequest('Invalid sleep duration')
+
+    const duration = Math.floor(Math.random() * (max - min)) + min
+
+    await setTimeout(duration)
+
+    return null
+  }
+
+  private parse (value: string): [number, number] {
+    try {
+      const pair = JSON.parse(value) as [number, number]
+
+      if (!Array.isArray(pair) || pair.length !== 2)
+        throw new Error()
+
+      return pair
+    } catch (error) {
+      throw new BadRequest('Invalid sleep duration value')
+    }
+  }
+}

package/source/directives/dev/types.ts

@@ -1,5 +1,5 @@
 import type { Input, Output } from '../../io'
 
 export interface Directive {
-  apply: (input: Input) => Output
+  apply: (input: Input) => Promise<Output> | Output
 }

package/source/directives/flow/Compose.ts

@@ -0,0 +1,92 @@
+import { once } from 'node:events'
+import * as assert from 'node:assert'
+import { Readable } from 'node:stream'
+import { console } from 'openspan'
+import type { Directive } from './types'
+import type { Input as Context } from '../../io'
+import type { OutgoingMessage } from '../../HTTP'
+
+export class Compose implements Directive {
+  private readonly expressions: Expression[]
+
+  public constructor (composition: any) {
+    this.expressions = build(composition)
+  }
+
+  public attach (context: Context): void {
+    context.pipelines.response.push(async (message: OutgoingMessage) => {
+      if (!(message.body instanceof Readable)) {
+        console.warn('Response body is not a stream, skipping composition')
+
+        return
+      }
+
+      assert.ok(message.body instanceof Readable, 'Response body is not a stream')
+
+      // @ts-expect-error -- objectMode is not defined in the type definition
+      assert.ok(message.body._readableState.objectMode, 'Response stream is not in object mode')
+
+      const $ = await this.compose(message.body)
+
+      message.body = this.execute($)
+    })
+  }
+
+  private async compose (stream: Readable): Promise<unknown[]> {
+    const $: unknown[] = []
+
+    stream.on('data', (data) => $.push(data))
+
+    await once(stream, 'end')
+
+    return $
+  }
+
+  private execute ($: unknown[]): unknown {
+    let exception: Error | undefined
+
+    for (const expression of this.expressions)
+      try {
+        return expression($)
+      } catch (e: unknown) {
+        exception = e as Error
+        console.debug('Chunks composition failed', { cause: exception.message })
+      }
+
+    throw exception!
+  }
+}
+
+function build (composition: any): Expression[] {
+  return Array.isArray(composition)
+    ? composition.map((variant) => compile(variant as object | string))
+    : [compile(composition as object | string)]
+}
+
+function compile (composition: object | string): Expression {
+  const text = typeof composition === 'string'
+    ? `return ${composition}`
+    : `return ${json(composition)}`
+
+  // eslint-disable-next-line @typescript-eslint/no-implied-eval,no-new-func
+  return new Function('$', text) as Expression
+}
+
+function json (node: object | string): string {
+  if (typeof node === 'string')
+    if (node.startsWith('\\'))
+      return `"${node}"`
+    else
+      return node
+
+  if (Array.isArray(node))
+    return `[${node.map((v) => json(v as object | string)).join(',')}]`
+
+  if (node.constructor !== Object)
+    return JSON.stringify(node)
+
+  return '{' + Object.entries(node)
+    .map(([key, value]) => `"${key}": ${json(value as object | string)}`).join(',') + '}'
+}
+
+type Expression = ($: unknown[]) => unknown

package/source/directives/flow/Fetch.ts

@@ -0,0 +1,86 @@
+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 {
+  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:fetch` 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,42 @@
+import { Fetch } from './Fetch'
+import { Compose } from './Compose'
+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) {
+      if (directive.attach !== undefined)
+        directive.attach(input)
+
+      if (directive.apply === undefined)
+        continue
+
+      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,
+  compose: Compose
+}

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,7 @@
+import type { Input as Context, Input, Output } from '../../io'
+import type { Parameter } from '../../RTD'
+
+export interface Directive {
+  apply?: (input: Input, parameters: Parameter[]) => Promise<Output>
+  attach?: (context: Context) => void
+}

package/source/directives/index.ts

@@ -4,10 +4,11 @@ import { cors } from './cors'
 import { dev } from './dev'
 import { octets } from './octets'
 import { io } from './io'
-import { vary } from './vary'
+import { map } from './map'
 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, req, octets, dev]
+export const families: DirectiveFamily[] = [authorization, io, cache, map, req, flow, octets, dev]
 export const interceptors: Interceptor[] = [cors]

package/source/directives/io/Directive.ts

@@ -1,11 +1,17 @@
-import type { Input } from '../../io'
+import type { Sync } from './lib/throttle'
+import type { Parameter } from '../../RTD'
+import type { Input as Context } from '../../io'
+import type * as http from '../../HTTP'
 
 export interface Directive {
-  attach: (context: Input) => void
+  preflight: (context: Context, parameters: Parameter[]) => void
+
+  /** Synchronous by contract: settling holds the response, and none of it needs I/O. */
+  settle?: (context: Context, response: http.OutgoingMessage) => void
 }
 
 export interface Constructor {
   validate: (value: unknown) => void
 
-  new (value: any): Directive
+  new (value: any, sync: Sync, route: string): Directive
 }

package/source/directives/io/IO.ts

@@ -1,43 +1,71 @@
 import { Output } from './Output'
 import { Input } from './Input'
+import { Throttle } from './Throttle'
+import { Sync } from './lib/throttle'
+import type * as http from '../../HTTP'
+import type { Parameter, DirectiveFamily } from '../../RTD'
+import type { Remotes } from '../../Remotes'
 import type { Constructor, Directive } from './Directive'
-import type { Input as Context } from '../../io'
-import type { DirectiveFamily } from '../../RTD'
 
 export class IO implements DirectiveFamily<Directive> {
   public readonly name = 'io'
   public readonly mandatory = true
 
-  public create (name: string, value: unknown): Directive {
+  /** Throttling reconciles through a component, because only a component has a stash aspect. */
+  private sync: Sync | null = null
+
+  // eslint-disable-next-line max-params
+  public create (name: string, value: unknown, remotes: Remotes, route: string): Directive {
     if (!(name in constructors))
-      throw new Error(`Directive 'io:${name}' is not implemented.`)
+      throw new Error(`Directive 'io:${name}' is not implemented`)
 
     const Directive = constructors[name]
 
     Directive.validate(value)
 
-    return new Directive(value)
+    // discovering boots the component, so nothing is discovered until something throttles
+    if (name === 'throttle')
+      this.sync ??= new Sync(remotes.discover('exposition', 'stash'))
+
+    return new Directive(value, this.sync!, route)
   }
 
-  public preflight (directives: Directive[], context: Context): null {
+  public preflight (directives: Directive[], context: http.Context,
+    parameters: Parameter[]): null {
     let restricted = false
 
     for (const directive of directives) {
       restricted ||= directive instanceof Output
 
-      directive.attach(context)
+      directive.preflight(context, parameters)
     }
 
     if (!restricted)
-      DENIAL.attach(context)
+      DENIAL.preflight(context, parameters)
 
     return null
   }
+
+  public settle (directives: Directive[], context: http.Context,
+    output: http.OutgoingMessage): void {
+    for (const directive of directives)
+      directive.settle?.(context, output)
+  }
+
+  /**
+   * The ticker belongs to the family rather than to any route's directives, and the
+   * factory disposes every route it made — so this runs once per route at shutdown,
+   * and disposing an already stopped ticker is what makes that harmless.
+   */
+  public dispose (): void {
+    this.sync?.dispose()
+  }
 }
 
 const constructors: Record<string, Constructor> = {
+  input: Input,
   output: Output,
-  input: Input
+  throttle: Throttle
 }
 
-const DENIAL: Output = new Output([])
+const DENIAL: Directive = new Output([])

package/source/directives/io/Input.ts

@@ -5,38 +5,45 @@ import type { Directive } from './Directive'
 import type { Input as Context } from '../../io'
 
 export class Input implements Directive {
-  private readonly permissions: Permissions
+  private readonly allowed: Set<string>
 
   public constructor (permissions: Permissions) {
-    this.permissions = permissions
+    this.allowed = new Set(permissions)
   }
 
   public static validate (permissions: unknown): asserts permissions is Permissions {
-    schemas.input.validate(permissions, 'Incorrect \'io:input\' format')
+    schemas.input.validate<Permissions>(permissions, 'Incorrect \'io:input\' format')
   }
 
-  public attach (context: Context): void {
-    context.pipelines.body.push((body) => this.check(body))
+  public preflight (context: Context): void {
+    // Restrictions are on what the client sent, so the check goes to the front of the
+    // pipeline whatever order the families ran in: `auth:delegate` embeds the identity
+    // and `map:*` assigns mapped properties, and those additions are the server's own,
+    // not input to be restricted.
+    context.pipelines.body.unshift((body) => this.check(body))
   }
 
-  private check (body: unknown): unknown {
+  private check (body: unknown): Message | Message[] | undefined {
+    if (body === undefined)
+      return body
+
     try {
-      schemas.message.validate(body)
+      schemas.message.validate<Message | Message[]>(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
   }
 
   private violation (value: Message | Message[]): string | undefined {
     if (!Array.isArray(value))
-      return Object.keys(value).find((key) => !this.permissions.includes(key))
+      return Object.keys(value).find((key) => !this.allowed.has(key))
 
     for (const item of value) {
       const property = this.violation(item)

package/source/directives/io/Output.ts

@@ -1,4 +1,5 @@
 import { Stream } from 'node:stream'
+import { console } from 'openspan'
 import * as schemas from './schemas'
 import type { Message } from './Message'
 import type { Directive } from './Directive'
@@ -9,6 +10,7 @@ export class Output implements Directive {
   private readonly disabled: boolean = false
   private readonly omitted: boolean = true
   private readonly permissions: string[] = []
+  private readonly allowed: Set<string>
 
   public constructor (permissions: Permissions) {
     if (typeof permissions === 'boolean')
@@ -19,13 +21,15 @@ export class Output implements Directive {
 
     else
       this.permissions = permissions
+
+    this.allowed = new Set(this.permissions)
   }
 
   public static validate (permissions: unknown): asserts permissions is Permissions {
     schemas.output.validate(permissions, 'Incorrect \'io:output\' format')
   }
 
-  public attach (context: Context): void {
+  public preflight (context: Context): void {
     context.pipelines.response.push(this.restriction(context))
   }
 
@@ -40,29 +44,34 @@ export class Output implements Directive {
 
       if (typeof message.body !== 'object' || this.permissions.length === 0) {
         if (this.omitted)
-          console.warn('Permissions for \'io:output\' are not specified properly ' +
-            `(${context.request.url}). Response omitted.`)
+          console.warn('Permissions for \'io:output\' are not specified properly, response omitted',
+            { path: context.url.pathname })
 
         delete message.body
 
         return
       }
 
-      schemas.message.validate(message.body,
+      schemas.message.validate<Message>(message.body,
         '\'io:output\' expects response to be an object or array of objects')
 
       if (Array.isArray(message.body))
-        message.body = message.body.map((entity) => this.fit(entity))
+        message.body = message.body.map((entity) => this.fit(entity as Message))
       else
         message.body = this.fit(message.body)
     }
   }
 
-  private fit (message: Message): Message | undefined {
-    const entries = Object.entries(message)
-      .filter(([key]) => this.permissions.includes(key))
+  /** Runs per entity of a collection, hence the set and the absence of intermediates. */
+  private fit (message: Message): Message {
+    const output: Message = {}
+
+    // the keys of the entity, so that the response keeps the order it was built in
+    for (const key of Object.keys(message))
+      if (this.allowed.has(key))
+        output[key] = message[key]
 
-    return Object.fromEntries(entries)
+    return output
   }
 }
 

package/source/directives/io/Throttle.ts

@@ -0,0 +1,31 @@
+import { TooManyRequests } from '../../HTTP'
+import * as schemas from './schemas'
+import { parse, Quotas, type Declaration, type Sync } from './lib/throttle'
+import type * as http from '../../HTTP'
+import type { Parameter } from '../../RTD'
+import type { Directive } from './Directive'
+
+export class Throttle implements Directive {
+  private readonly quotas: Quotas
+
+  public constructor (declaration: Declaration, sync: Sync, route: string) {
+    this.quotas = Quotas.create(parse(declaration), route)
+
+    sync.register(this.quotas)
+  }
+
+  public static validate (declaration: unknown): asserts declaration is Declaration {
+    schemas.throttle.validate(declaration, 'Incorrect \'io:throttle\' format')
+  }
+
+  public preflight (context: http.Context, parameters: Parameter[]): void {
+    const retry = this.quotas.check(context, parameters)
+
+    if (retry > 0)
+      throw new TooManyRequests(retry)
+  }
+
+  public settle (context: http.Context, output: http.OutgoingMessage): void {
+    this.quotas.use(context, output)
+  }
+}

package/source/directives/io/lib/throttle/Configuration.test.ts

@@ -0,0 +1,60 @@
+import { parse, type Configuration } from './Configuration'
+
+const rest: Omit<Configuration, 'key' | 'condition'> = {
+  interval: 1,
+  requests: 1
+}
+
+it('should convert key', () => {
+  const result: Partial<Configuration> = {
+    key: [
+      {
+        method: 'ip'
+      }
+    ]
+  }
+
+  expect(parse({ key: 'ip', ...rest })).toMatchObject(result)
+  expect(parse({ key: ['ip'], ...rest })).toMatchObject(result)
+})
+
+it('should convert condition', () => {
+  expect(parse({ key: ['ip', 'path'], condition: { status: '404' }, ...rest })).toMatchObject({
+    condition: [
+      {
+        method: 'status',
+        options: '404'
+      }
+    ]
+  })
+
+  expect(parse({ key: 'ip', condition: { status: '404' }, ...rest })).toMatchObject({
+    condition: [
+      {
+        method: 'status',
+        options: '404'
+      }
+    ]
+  })
+})
+
+it('should convert a key component that takes an argument', () => {
+  expect(parse({ key: { segment: 'id' }, ...rest })).toMatchObject({
+    key: [
+      {
+        method: 'segment',
+        options: 'id'
+      }
+    ]
+  })
+})
+
+it('should convert a mixed key', () => {
+  expect(parse({ key: ['route', { segment: 'id' }, 'identity'], ...rest })).toMatchObject({
+    key: [
+      { method: 'route' },
+      { method: 'segment', options: 'id' },
+      { method: 'identity' }
+    ]
+  })
+})