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

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

@@ -0,0 +1,63 @@
+export interface Configuration {
+  key: KeyComponent[]
+  condition?: KeyCondition[]
+  requests: number
+  interval: number
+}
+
+interface Rule<T, K = unknown> {
+  method: T
+  options?: K
+}
+
+export type KeyComponentMethod = 'ip' | 'path' | 'route' | 'identity' | 'segment'
+export type KeyConditionMethod = 'status'
+
+export type KeyComponent = Rule<KeyComponentMethod>
+export type KeyCondition = Rule<KeyConditionMethod>
+
+/** A bare component, or the one that takes an argument. */
+type KeyEntry = KeyComponentMethod | { segment: string }
+type KeyDeclaration = KeyEntry | KeyEntry[]
+
+type ConditionDeclaration =
+  Record<KeyConditionMethod, unknown>
+  | Array<Record<KeyConditionMethod, unknown>>
+
+export interface Declaration extends Omit<Configuration, 'key' | 'condition'> {
+  key: KeyDeclaration
+  condition?: ConditionDeclaration
+}
+
+export function parse (declaration: Declaration): Configuration {
+  const { key, condition, requests, interval } = declaration
+
+  return {
+    key: mapKey(key),
+    condition: mapCondition(condition),
+    requests,
+    interval: interval * 1000
+  }
+}
+
+function mapKey (declaration: KeyDeclaration): KeyComponent[] {
+  const entries = Array.isArray(declaration) ? declaration : [declaration]
+
+  // a bare `path`, or `segment: id` for the ones that take an argument
+  return entries.flatMap((entry): KeyComponent[] =>
+    typeof entry === 'string'
+      ? [{ method: entry }]
+      : Object.entries(entry).map(([method, options]) =>
+        ({ method: method as KeyComponentMethod, options })))
+}
+
+function mapCondition (declaration?: ConditionDeclaration): KeyCondition[] | undefined {
+  if (declaration === undefined)
+    return
+
+  // reduce to a single object, then map entries to rules
+  const conditions = Array.isArray(declaration) ? declaration : [declaration]
+  const single = conditions.reduce((acc, condition) => ({ ...acc, ...condition }), {})
+
+  return Object.entries(single).map(([method, options]) => ({ method, options })) as KeyCondition[]
+}

package/source/directives/io/lib/throttle/Keys.ts

@@ -0,0 +1,41 @@
+import { createHash } from 'node:crypto'
+import { Components, type Component } from './components'
+import { Conditions, type Condition } from './conditions'
+import type { KeyComponent, KeyCondition } from './Configuration'
+import type { Parameter } from '../../../../RTD'
+import type { Input as Context, Output } from '../../../../io'
+
+const NONE: Parameter[] = []
+
+export class Keys {
+  private readonly components: Component[]
+  private readonly conditions?: Condition[]
+
+  public constructor (components: Component[], conditions?: Condition[]) {
+    this.components = components
+    this.conditions = conditions
+  }
+
+  public static create (componentRules: KeyComponent[], conditionRules?: KeyCondition[],
+    route: string = ''): Keys {
+    const components = componentRules.map((rule) =>
+      new Components[rule.method](rule.options, route))
+
+    const conditions = conditionRules?.map((rule) => new Conditions[rule.method](rule.options))
+
+    return new this(components, conditions)
+  }
+
+  public get (context: Context, parameters: Parameter[] = NONE): string {
+    const hash = createHash('sha256')
+
+    for (const component of this.components)
+      hash.update(component.get(context, parameters))
+
+    return hash.digest('hex')
+  }
+
+  public matches (input: Context, output: Output): boolean {
+    return this.conditions?.some((condition) => !condition.match(input, output)) !== true
+  }
+}

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

@@ -0,0 +1,382 @@
+import { setTimeout } from 'node:timers/promises'
+import { Quotas } from './Quotas'
+import type { Batch } from './Sync'
+import type { Configuration } from './Configuration'
+import type { Input as Context, Output } from '../../../../io'
+
+let quotas: Quotas
+let configuration: Configuration
+let context: Context
+let output: Output
+
+beforeEach(() => {
+  output = { status: 200 }
+})
+
+describe('common', () => {
+  beforeEach(() => {
+    context = createContext()
+    configuration = createConfiguration()
+    quotas = Quotas.create(configuration)
+  })
+
+  it('should admit a burst of the whole budget', () => {
+    expect(quotas.check(context, [])).toBe(0)
+    expect(quotas.check(context, [])).toBe(0)
+  })
+
+  it('should refuse past the budget', () => {
+    quotas.check(context, [])
+    quotas.check(context, [])
+
+    expect(quotas.check(context, [])).toBeGreaterThan(0)
+  })
+
+  it('should not charge what it refuses', async () => {
+    quotas.check(context, [])
+    quotas.check(context, [])
+    quotas.check(context, [])
+    quotas.check(context, [])
+
+    // a refused request does not push admission further out, so one emission is
+    // all it takes to be admitted again however hard the key is hammered
+    await timeout(configuration.interval / configuration.requests)
+
+    expect(quotas.check(context, [])).toBe(0)
+  })
+
+  it('should earn the budget back over the interval', async () => {
+    quotas.check(context, [])
+    quotas.check(context, [])
+
+    expect(quotas.check(context, [])).toBeGreaterThan(0)
+
+    await timeout(configuration.interval)
+
+    expect(quotas.check(context, [])).toBe(0)
+    expect(quotas.check(context, [])).toBe(0)
+  })
+})
+
+describe('retry', () => {
+  it('should answer the seconds until the request would be admitted', () => {
+    // an emission is 5 seconds, which is what the budget takes to earn one back
+    quotas = Quotas.create(createConfiguration({ requests: 2, interval: 10_000 }))
+    context = createContext()
+
+    quotas.check(context, [])
+    quotas.check(context, [])
+
+    expect(quotas.check(context, [])).toBe(5)
+  })
+
+  it('should never answer zero when it refuses', () => {
+    quotas = Quotas.create(createConfiguration({ requests: 10, interval: 1000 }))
+    context = createContext()
+
+    for (let i = 0; i < 10; i++)
+      quotas.check(context, [])
+
+    // an emission here is a tenth of a second, and `Retry-After` counts in whole ones
+    expect(quotas.check(context, [])).toBe(1)
+  })
+})
+
+describe('group', () => {
+  beforeEach(() => {
+    context = createContext()
+    configuration = createConfiguration()
+    quotas = Quotas.create(configuration)
+  })
+
+  it('should report what it has charged', () => {
+    quotas.check(context, [])
+
+    const batch = flush()
+
+    expect(batch).toHaveLength(1)
+    expect(batch[0].delta).toBe(configuration.interval / configuration.requests)
+    expect(batch[0].quotas).toBe(quotas)
+  })
+
+  it('should refuse on what the group has spent, not on what this process has', () => {
+    quotas.check(context, [])
+
+    const batch = flush()
+
+    // one request here, but the group is already at capacity
+    quotas.settled(batch[0], configuration.interval, Date.now())
+
+    expect(quotas.check(context, [])).toBeGreaterThan(0)
+  })
+
+  it('should not refuse below the capacity', () => {
+    quotas.check(context, [])
+
+    const batch = flush()
+
+    quotas.settled(batch[0], 0, Date.now())
+
+    expect(quotas.check(context, [])).toBe(0)
+  })
+
+  it('should clear what was reported, and keep what was charged since', () => {
+    quotas.check(context, [])
+
+    const batch = flush()
+
+    quotas.check(context, [])
+    quotas.settled(batch[0], 0, Date.now())
+
+    expect(flush()[0].delta).toBe(configuration.interval / configuration.requests)
+  })
+
+  it('should keep what it could not report', () => {
+    quotas.check(context, [])
+
+    const first = flush()
+
+    // no `settled`, as a tick that cannot reach Redis leaves the debt to the next one
+    expect(flush()[0].delta).toBe(first[0].delta)
+  })
+
+  it('should take a debt for a key it has already dropped', () => {
+    quotas.check(context, [])
+
+    const batch = flush()
+
+    quotas.settled(batch[0], 0, Date.now())
+    flush(Date.now() + configuration.interval)
+
+    quotas.settled({ ...batch[0], delta: 0 }, configuration.interval, Date.now())
+
+    expect(quotas.check(context, [])).toBeGreaterThan(0)
+  })
+
+  it('should name keys so that quotas with different budgets never share one', () => {
+    const other = Quotas.create(createConfiguration({ requests: 3 }))
+
+    quotas.check(context, [])
+    other.check(context, [])
+
+    const batch = flush(Date.now(), quotas, other)
+
+    expect(batch[0].key).toBe(batch[1].key)
+    expect(quotas.name(batch[0].key)).not.toBe(other.name(batch[1].key))
+  })
+})
+
+describe('sweeping', () => {
+  beforeEach(() => {
+    context = createContext()
+    configuration = createConfiguration()
+    quotas = Quotas.create(configuration)
+  })
+
+  it('should drop a key that is out of debt with nothing to report', () => {
+    quotas.check(context, [])
+
+    const batch = flush()
+
+    quotas.settled(batch[0], 0, Date.now())
+
+    // once the debt has drained, a key says no more than an absent one
+    expect(flush(Date.now() + configuration.interval)).toHaveLength(0)
+    expect(flush(Date.now() + configuration.interval)).toHaveLength(0)
+    expect(quotas.check(context, [])).toBe(0)
+  })
+
+  it('should keep a key that still owes something', () => {
+    quotas.check(context, [])
+
+    expect(flush(Date.now() + configuration.interval)).toHaveLength(1)
+  })
+})
+
+describe('path', () => {
+  beforeEach(() => {
+    configuration = createConfiguration()
+    quotas = Quotas.create(configuration)
+  })
+
+  it('should have separate quotas', () => {
+    const one = createContext({ url: new URL('http://localhost/one/') })
+    const two = createContext({ url: new URL('http://localhost/two/') })
+
+    quotas.check(one, [])
+    quotas.check(one, [])
+
+    expect(quotas.check(one, [])).toBeGreaterThan(0)
+    expect(quotas.check(two, [])).toBe(0)
+  })
+})
+
+describe('ip', () => {
+  beforeEach(() => {
+    configuration = createConfiguration({ key: [{ method: 'ip' }] })
+    quotas = Quotas.create(configuration)
+  })
+
+  it('should have separate quotas', () => {
+    const one = createContext({ request: { headers: { 'x-forwarded-for': '1.1.1.1' } } })
+    const two = createContext({ request: { headers: { 'x-forwarded-for': '2.2.2.2' } } })
+
+    quotas.check(one, [])
+    quotas.check(one, [])
+
+    expect(quotas.check(one, [])).toBeGreaterThan(0)
+    expect(quotas.check(two, [])).toBe(0)
+  })
+})
+
+describe('route', () => {
+  it('should key on the route, not on the path it came in on', () => {
+    quotas = Quotas.create(createConfiguration({ key: [{ method: 'route' }] }), '/users/:id')
+
+    const one = createContext({ url: new URL('http://localhost/users/1/') })
+    const two = createContext({ url: new URL('http://localhost/users/2/') })
+
+    quotas.check(one, [])
+    quotas.check(two, [])
+
+    // two paths, one route, one quota — which is the whole difference from `path`
+    expect(flush()).toHaveLength(1)
+    expect(quotas.check(one, [])).toBeGreaterThan(0)
+  })
+
+  it('should have separate quotas per route', () => {
+    const users = Quotas.create(createConfiguration({ key: [{ method: 'route' }] }), '/users/:id')
+    const posts = Quotas.create(createConfiguration({ key: [{ method: 'route' }] }), '/posts/:id')
+
+    context = createContext({ url: new URL('http://localhost/users/1/') })
+
+    users.check(context, [])
+    posts.check(context, [])
+
+    const batch = flush(Date.now(), users, posts)
+
+    expect(batch[0].key).not.toBe(batch[1].key)
+  })
+})
+
+describe('segment', () => {
+  beforeEach(() => {
+    configuration = createConfiguration({ key: [{ method: 'segment', options: 'id' }] })
+    quotas = Quotas.create(configuration)
+    context = createContext()
+  })
+
+  it('should have separate quotas per segment value', () => {
+    const one = [{ name: 'id', value: '1' }]
+    const two = [{ name: 'id', value: '2' }]
+
+    quotas.check(context, one)
+    quotas.check(context, one)
+
+    expect(quotas.check(context, one)).toBeGreaterThan(0)
+    expect(quotas.check(context, two)).toBe(0)
+  })
+})
+
+describe('identity', () => {
+  beforeEach(() => {
+    configuration = createConfiguration({ key: [{ method: 'identity' }] })
+    quotas = Quotas.create(configuration)
+  })
+
+  it('should have separate quotas per identity', () => {
+    const one = createContext({ identity: { id: 'one' } })
+    const two = createContext({ identity: { id: 'two' } })
+
+    quotas.check(one, [])
+    quotas.check(one, [])
+
+    expect(quotas.check(one, [])).toBeGreaterThan(0)
+    expect(quotas.check(two, [])).toBe(0)
+  })
+
+  it('should put every anonymous request in one quota', () => {
+    const one = createContext({ identity: null })
+    const two = createContext()
+
+    quotas.check(one, [])
+    quotas.check(two, [])
+
+    expect(quotas.check(one, [])).toBeGreaterThan(0)
+    expect(quotas.check(two, [])).toBeGreaterThan(0)
+  })
+})
+
+describe('status', () => {
+  beforeEach(() => {
+    context = createContext()
+    configuration = createConfiguration({ condition: [{ method: 'status', options: 404 }] })
+    quotas = Quotas.create(configuration)
+  })
+
+  it('should not charge before the response can be matched', () => {
+    quotas.check(context, [])
+    quotas.check(context, [])
+    quotas.check(context, [])
+
+    // only the response tells whether a request counts, so checking cannot charge
+    expect(flush()).toHaveLength(0)
+  })
+
+  it('should not charge what the condition rejects', () => {
+    quotas.check(context, [])
+    quotas.use(context, output)
+
+    expect(flush()).toHaveLength(0)
+    expect(quotas.check(context, [])).toBe(0)
+  })
+
+  it('should charge what the condition accepts', () => {
+    for (let i = 0; i < 2; i++) {
+      quotas.check(context, [])
+      quotas.use(context, { status: 404 })
+    }
+
+    expect(quotas.check(context, [])).toBeGreaterThan(0)
+  })
+
+  it('should charge the key checking saw, which settling cannot recompute', () => {
+    const keys = [{ method: 'segment' as const, options: 'id' }]
+
+    quotas = Quotas.create(createConfiguration({ key: keys, condition: configuration.condition }))
+
+    const one = createContext()
+    const two = createContext()
+
+    quotas.check(one, [{ name: 'id', value: '1' }])
+    quotas.use(one, { status: 404 })
+
+    quotas.check(two, [{ name: 'id', value: '2' }])
+    quotas.use(two, { status: 404 })
+
+    // settling is handed no parameters, so recomputing there would hash an empty
+    // segment both times and the two requests would charge one key
+    expect(flush()).toHaveLength(2)
+  })
+})
+
+function flush (now: number = Date.now(), ...of: Quotas[]): Batch[] {
+  const batch: Batch[] = []
+
+  for (const one of of.length === 0 ? [quotas] : of)
+    one.flush(now, batch)
+
+  return batch
+}
+
+function createConfiguration (properties?: Partial<Configuration>): Configuration {
+  return Object.assign({ key: [{ method: 'path' }], requests: 2, interval: 100 }, properties)
+}
+
+function createContext (properties?: any): Context {
+  return Object.assign({ url: new URL('http://localhost/') }, properties) as unknown as Context
+}
+
+async function timeout (ms: number): Promise<void> {
+  await setTimeout(ms * 1.2)
+}

package/source/directives/io/lib/throttle/Quotas.ts

@@ -0,0 +1,183 @@
+import { Keys } from './Keys'
+import type { Batch } from './Sync'
+import type { Configuration } from './Configuration'
+import type { Parameter } from '../../../../RTD'
+import type { Input as Context, Output } from '../../../../io'
+
+/**
+ * A quota per key, metered by GCRA, decided in this process and shared with the others.
+ *
+ * The state of a key is one theoretical arrival time: the moment the key would be back
+ * at zero if nothing more arrived. An admitted request pushes it `emission` further out,
+ * time drags it back, and a request is admitted while it stays within `capacity` of now.
+ * So `requests` is what a key may spend at once, and `requests / interval` what it earns
+ * back — no window to burst across the edge of, and no lockout to time out of.
+ *
+ * Deciding needs nothing but the local map, which is what keeps the request path free of
+ * I/O. What the other gateways have spent arrives on {@link Sync}'s tick, as a debt in
+ * milliseconds — a duration, so it carries across processes without their clocks having
+ * to agree, and additive, which is what lets each process report only its own increments.
+ */
+export class Quotas {
+  /** How often the debt is worth reconciling with the other gateways, in milliseconds. */
+  public readonly period: number
+
+  /** Milliseconds of debt an admitted request adds, `interval / requests`. */
+  private readonly emission: number
+
+  /** Debt a key may carry before it is refused, `interval` — a burst of `requests`. */
+  private readonly capacity: number
+
+  private readonly keys: Keys
+  private readonly prefix: string
+  private readonly conditional: boolean
+  private readonly entries = new Map<string, Entry>()
+
+  /**
+   * The key computed at preflight, for settle to charge against.
+   *
+   * `segment` reads the route parameters, which settle is not given, and `identity`
+   * can be refreshed between the two — so recomputing there would key a request
+   * differently than it was checked, and throttling would quietly stop working.
+   */
+  private readonly keyed = new WeakMap<Context, string>()
+
+  public constructor (options: Options) {
+    this.keys = options.keys
+    this.conditional = options.conditional
+    this.emission = options.interval / options.requests
+    this.capacity = options.interval
+    this.period = period(options.interval)
+
+    // a key means one budget, so quotas that do not share one must not share a key
+    this.prefix = `t:${options.requests}:${options.interval}:`
+  }
+
+  public static create (configuration: Configuration, route: string = ''): Quotas {
+    const { requests, interval, condition } = configuration
+    const keys = Keys.create(configuration.key, condition, route)
+
+    return new this({ keys, requests, interval, conditional: condition !== undefined })
+  }
+
+  /**
+   * Seconds to wait before the request would be admitted, or zero when it is.
+   *
+   * Charges here when nothing conditions the count, so that the request is metered by
+   * the same call that admits it; otherwise only the response can tell whether it counts,
+   * and {@link use} charges once it can.
+   */
+  public check (context: Context, parameters: Parameter[]): number {
+    const key = this.keys.get(context, parameters)
+
+    this.keyed.set(context, key)
+
+    const now = Date.now()
+    const entry = this.entries.get(key)
+    const tat = Math.max(entry?.tat ?? now, now)
+    const admit = tat + this.emission - this.capacity
+
+    if (admit > now)
+      return Math.ceil((admit - now) / 1000)
+
+    if (!this.conditional)
+      this.charge(key, entry, tat)
+
+    return 0
+  }
+
+  /** Charges what the condition accepts, once the response can be matched against it. */
+  public use (input: Context, output: Output): void {
+    if (!this.conditional || !this.keys.matches(input, output))
+      return
+
+    // preflight always runs first, and a request it refuses never reaches settle
+    const key = this.keyed.get(input) ?? this.keys.get(input)
+    const now = Date.now()
+    const entry = this.entries.get(key)
+    const tat = Math.max(entry?.tat ?? now, now)
+
+    this.charge(key, entry, tat)
+  }
+
+  /**
+   * Adds what is worth reporting to the batch, and drops what has gone quiet.
+   *
+   * The debt is not cleared here but in {@link settled}, so a tick that fails to reach
+   * Redis leaves it to be reported by the next one instead of losing it.
+   */
+  public flush (now: number, batch: Batch[]): void {
+    for (const [key, entry] of this.entries) {
+      const delta = Math.round(entry.debt)
+
+      if (delta > 0) {
+        batch.push({ quotas: this, key, delta })
+
+        continue
+      }
+
+      // out of debt and with nothing left to report, a key says no more than an absent one
+      if (entry.tat <= now)
+        this.entries.delete(key)
+    }
+  }
+
+  /** Takes the group's debt back, and clears what this process contributed to it. */
+  public settled (reported: Batch, debt: number, now: number): void {
+    const entry = this.entries.get(reported.key)
+
+    if (entry === undefined) {
+      if (debt > 0)
+        this.entries.set(reported.key, { tat: now + debt, debt: 0 })
+
+      return
+    }
+
+    entry.debt -= reported.delta
+
+    // the group has spent at least what this process has, so its debt is the one to keep
+    entry.tat = Math.max(entry.tat, now + debt)
+  }
+
+  public name (key: string): string {
+    return this.prefix + key
+  }
+
+  private charge (key: string, entry: Entry | undefined, tat: number): void {
+    if (entry === undefined)
+      this.entries.set(key, { tat: tat + this.emission, debt: this.emission })
+    else {
+      entry.tat = tat + this.emission
+      entry.debt += this.emission
+    }
+  }
+}
+
+/**
+ * How often to reconcile, in milliseconds.
+ *
+ * Reconciling is what bounds the overshoot — between two ticks a gateway is going on
+ * what it alone has spent — so it is worth doing an order of magnitude more often than
+ * the interval, within reason on either end.
+ */
+function period (interval: number): number {
+  return Math.min(Math.max(interval / 10, MIN_PERIOD), MAX_PERIOD)
+}
+
+const MIN_PERIOD = 250
+const MAX_PERIOD = 2000
+
+interface Entry {
+  /** Theoretical arrival time: when the key is back at zero if nothing more arrives. */
+  tat: number
+
+  /** Milliseconds of debt this process has added and not yet reported. */
+  debt: number
+}
+
+interface Options {
+  keys: Keys
+  requests: number
+  interval: number
+  conditional: boolean
+}