@toa.io/extensions.exposition 1.0.0-alpha.6 → 1.0.0-alpha.61

package/source/directives/cache/Control.ts

@@ -4,56 +4,82 @@ import type { AuthenticatedContext, Directive } from './types'
 export class Control implements Directive {
   protected readonly value: string
   private cache: string | null = null
+  private vary: boolean = false
 
   public constructor (value: string) {
     this.value = value
   }
 
+  public static disabled (headers: Headers): boolean {
+    const value = headers.get('cache-control')
+
+    if (value === null)
+      return false
+
+    const directives = mask(value)
+
+    return (directives & NO_STORE) === NO_STORE
+  }
+
   public set (context: AuthenticatedContext, headers: Headers): void {
     if (!['GET', 'HEAD', 'OPTIONS'].includes(context.request.method))
       return
 
     this.cache ??= this.resolve(context)
 
+    if (Control.disabled(headers))
+      return
+
     headers.set('cache-control', this.cache)
+
+    if (this.vary !== null)
+      headers.append('vary', 'authorization')
   }
 
   protected resolve (request: AuthenticatedContext): string {
     if (request.identity === null)
       return this.value
 
-    const directives = this.mask()
+    const directives = mask(this.value)
+
+    if ((directives & PRIVATE) === PRIVATE)
+      this.vary = true
 
     if ((directives & (PUBLIC | NO_CACHE)) === PUBLIC)
       return 'no-cache, ' + this.value
 
-    if ((directives & (PUBLIC | PRIVATE)) === 0)
+    if ((directives & (PUBLIC | PRIVATE)) === 0) {
+      this.vary = true
+
       return 'private, ' + this.value
+    }
 
     return this.value
   }
+}
 
-  private mask (): number {
-    const directives = this.value.match(DIRECTIVES_RX)
+function mask (value: string): number {
+  const directives = value.match(DIRECTIVES_RX)
 
-    if (directives === null)
-      return 0
+  if (directives === null)
+    return 0
 
-    let mask = 0
+  let mask = 0
 
-    for (const directive of directives)
-      mask |= match<number>(directive,
-        'private', PRIVATE,
-        'public', PUBLIC,
-        'no-cache', NO_CACHE,
-        0)
+  for (const directive of directives)
+    mask |= match<number>(directive,
+      'private', PRIVATE,
+      'public', PUBLIC,
+      'no-cache', NO_CACHE,
+      'no-store', NO_STORE,
+      0)
 
-    return mask
-  }
+  return mask
 }
 
-const DIRECTIVES_RX = /\b(private|public|no-cache)\b/ig
+const DIRECTIVES_RX = /\b(private|public|no-cache|no-store)\b/ig
 
 const PUBLIC = 1
 const PRIVATE = 2
 const NO_CACHE = 4
+const NO_STORE = 8

package/source/directives/cors/CORS.ts

@@ -14,7 +14,7 @@ export class CORS implements Interceptor {
   ])
 
   private readonly headers = new Headers({
-    'access-control-allow-methods': 'GET, POST, PUT, PATCH, DELETE',
+    'access-control-allow-methods': 'GET, POST, PUT, PATCH, DELETE, LOCK, UNLOCK',
     'access-control-allow-credentials': 'true',
     'access-control-allow-headers': Array.from(this.requestHeaders).join(', '),
     'access-control-max-age': '3600',

package/source/directives/dev/Development.ts

@@ -12,7 +12,7 @@ export class Development implements DirectiveFamily<Directive> {
     const Class = constructors[name]
 
     if (Class === undefined)
-      throw new Error(`Directive '${name}' is not provided by the '${this.name}' family.`)
+      throw new Error(`Directive 'dev:${name}' is not implemented.`)
 
     return new Class(value)
   }

package/source/directives/flow/Fetch.ts

@@ -0,0 +1,88 @@
+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 {
+  public readonly targeted = true
+
+  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:redirect` 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,34 @@
+import { Fetch } from './Fetch'
+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) {
+      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
+}

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

package/source/directives/index.ts

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

package/source/directives/io/Input.ts

@@ -12,7 +12,7 @@ export class Input implements Directive {
   }
 
   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 {
@@ -21,15 +21,15 @@ export class Input implements Directive {
 
   private check (body: unknown): unknown {
     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
   }

package/source/directives/io/Output.ts

@@ -48,7 +48,7 @@ export class Output implements Directive {
         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))

package/source/directives/octets/Context.ts

@@ -1,18 +1,20 @@
-import * as schemas from './schemas'
+import assert from 'node:assert'
+import { Directive } from './Directive'
 import type { Output } from '../../io'
-import type { Directive } from './types'
 
-export class Context implements Directive {
+export class Context extends Directive {
   public readonly targeted = false
   public readonly storage: string
 
   public constructor (value: unknown) {
-    schemas.context.validate(value)
+    super()
+
+    assert.ok(typeof value === 'string', 'Directive \'octets:context\' must must be a string')
 
     this.storage = value
   }
 
-  public apply (): Output {
+  public async apply (): Promise<Output> {
     return null
   }
 }

package/source/directives/octets/Delete.ts

@@ -2,16 +2,17 @@ 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 type { Maybe } from '@toa.io/types'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 import type { Remotes } from '../../Remotes'
 import type { Entry } from '@toa.io/extensions.storages'
 
-export class Delete implements Directive {
+export class Delete extends Directive {
   public readonly targeted = true
 
   private readonly workflow?: Workflow
@@ -19,6 +20,7 @@ export class Delete implements Directive {
   private storage: Component | null = null
 
   public constructor (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
+    super()
     schemas.remove.validate(options)
 
     if (options?.workflow !== undefined)

package/source/directives/octets/Directive.ts

@@ -0,0 +1,10 @@
+import type { Input } from './types'
+import type { Parameter } from '../../RTD'
+import type * as io from '../../io'
+
+export abstract class Directive {
+  public readonly name = 'octets.' + this.constructor.name.toLowerCase()
+  public abstract readonly targeted: boolean
+
+  public abstract apply (storage: string, input: Input, parameters: Parameter[]): Promise<io.Output>
+}

package/source/directives/octets/Fetch.ts

@@ -1,29 +1,31 @@
 import { posix } from 'node:path'
 import { Forbidden, NotFound } from '../../HTTP'
 import * as schemas from './schemas'
+import { Directive } from './Directive'
+import type { Readable } from 'node:stream'
 import type { Maybe } from '@toa.io/types'
 import type { Entry } from '@toa.io/extensions.storages'
-import type { Readable } from 'node:stream'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
+import type { Input } from './types'
 
-import type { Directive, Input } from './types'
-
-export class Fetch implements Directive {
+export class Fetch extends Directive {
   public readonly targeted = true
 
-  private readonly permissions: Required<Permissions> = {
+  private readonly options: Required<Options> = {
     blob: true,
     meta: false
   }
 
   private readonly discovery: Promise<Component>
-  private storage: Component = null as unknown as Component
+  private storage!: Component
+
+  public constructor (options: Options | null, discovery: Promise<Component>) {
+    super()
 
-  public constructor (permissions: Permissions | null, discovery: Promise<Component>) {
-    schemas.fetch.validate(permissions)
+    schemas.fetch.validate(options)
+    Object.assign(this.options, options)
 
-    Object.assign(this.permissions, permissions)
     this.discovery = discovery
   }
 
@@ -34,12 +36,12 @@ export class Fetch implements Directive {
     const metadata = input.subtype === 'octets.entry'
 
     if (!variant && metadata)
-      if (this.permissions.meta)
+      if (this.options.meta)
         return this.get(storage, input)
       else
         throw new Forbidden('Metadata is not accessible.')
 
-    if (!variant && !this.permissions.blob)
+    if (!variant && !this.options.blob)
       throw new Forbidden('BLOB variant must be specified.')
 
     return await this.fetch(storage, input)
@@ -62,7 +64,7 @@ export class Fetch implements Directive {
     const headers = new Headers({
       'content-type': result.type,
       'content-length': result.size.toString(),
-      etag: result.checksum
+      etag: `"${result.checksum}"`
     })
 
     return {
@@ -86,7 +88,7 @@ export class Fetch implements Directive {
   }
 }
 
-export interface Permissions {
+export interface Options {
   blob?: boolean
   meta?: boolean
 }

package/source/directives/octets/List.ts

@@ -1,24 +1,26 @@
 import { posix } from 'node:path'
 import { Forbidden, NotFound } from '../../HTTP'
 import * as schemas from './schemas'
+import { Directive } from './Directive'
 import type { Entry } from '@toa.io/extensions.storages'
 import type { Maybe } from '@toa.io/types'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
 
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 
-export class List implements Directive {
+export class List extends Directive {
   public readonly targeted = false
 
-  private readonly permissions: Required<Permissions> = { meta: false }
+  private readonly options: Required<Options> = { meta: false }
   private readonly discovery: Promise<Component>
   private storage: Component | null = null
 
-  public constructor (permissions: Permissions | null, discovery: Promise<Component>) {
+  public constructor (permissions: Options | null, discovery: Promise<Component>) {
+    super()
     schemas.list.validate(permissions)
 
-    Object.assign(this.permissions, permissions)
+    Object.assign(this.options, permissions)
     this.discovery = discovery
   }
 
@@ -27,7 +29,7 @@ export class List implements Directive {
 
     const metadata = input.subtype === 'octets.entries'
 
-    if (metadata && !this.permissions.meta)
+    if (metadata && !this.options.meta)
       throw new Forbidden('Metadata is not accessible.')
 
     const list = await this.storage.invoke<Maybe<string[]>>('list', {
@@ -65,6 +67,6 @@ export class List implements Directive {
   }
 }
 
-export interface Permissions {
+export interface Options {
   meta?: boolean
 }

package/source/directives/octets/Octets.ts

@@ -4,13 +4,13 @@ import { Store } from './Store'
 import { Fetch } from './Fetch'
 import { List } from './List'
 import { Delete } from './Delete'
-import { Permute } from './Permute'
 import { WorkflowDirective } from './Workflow'
+import type { Directive } from './Directive'
 import type { Output } from '../../io'
 import type { Component } from '@toa.io/core'
 import type { Remotes } from '../../Remotes'
 import type { Parameter, DirectiveFamily } from '../../RTD'
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 
 export class Octets implements DirectiveFamily<Directive> {
   public readonly name: string = 'octets'
@@ -22,7 +22,7 @@ export class Octets implements DirectiveFamily<Directive> {
     const Class = DIRECTIVES[name]
 
     if (Class === undefined)
-      throw new Error(`Directive '${name}' is not provided by the '${this.name}' family.`)
+      throw new Error(`Directive 'octets:${name}' is not implemented.`)
 
     this.discovery ??= remotes.discover('octets', 'storage')
 
@@ -55,7 +55,7 @@ export class Octets implements DirectiveFamily<Directive> {
       throw new NotFound(`Trailing slash is ${action.targeted ? 'redundant' : 'required'}.`)
 
     // noinspection JSObjectNullOrUndefined
-    return action.apply(context.storage, input, parameters)
+    return await input.timing.capture(action.name, action.apply(context.storage, input, parameters))
   }
 }
 
@@ -65,7 +65,6 @@ const DIRECTIVES: Record<string, Constructor> = {
   fetch: Fetch,
   list: List,
   delete: Delete,
-  permute: Permute,
   workflow: WorkflowDirective
 }
 

package/source/directives/octets/Store.ts

@@ -1,9 +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'
@@ -12,19 +14,24 @@ import type { Remotes } from '../../Remotes'
 import type { ErrorType } from 'error-value'
 import type { Component } from '@toa.io/core'
 import type { Output } from '../../io'
-import type { Directive, Input } from './types'
+import type { Input } from './types'
 
-export class Store implements Directive {
+export class Store 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
 
   public constructor
   (options: Options | null, discovery: Promise<Component>, remotes: Remotes) {
-    schemas.store.validate(options)
+    super()
+
+    schemas.store.validate<Options>(options)
 
     this.accept = match(options?.accept,
       String, (value: string) => value,
@@ -34,9 +41,16 @@ export class Store implements 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-location')
   }
 
   public async apply (storage: string, input: Input, parameters: Parameter[]): Promise<Output> {
@@ -45,17 +59,17 @@ export class Store implements 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)
+      request.input.meta = this.meta(meta)
 
     const entry = await this.storage.invoke<Entry>('store', request)
 
@@ -87,12 +101,16 @@ export class Store implements 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 meta (value: string | string[]): Record<string, string> {
     if (Array.isArray(value))
       value = value.join(',')
 
@@ -111,7 +129,9 @@ export class Store implements Directive {
 
 export interface Options {
   accept?: string | string[]
+  limit?: string
   workflow?: Unit[] | Unit
+  trust?: string[]
 }
 
 interface StoreRequest {
@@ -119,6 +139,8 @@ interface StoreRequest {
     storage: string
     request: Input['request']
     accept?: string
+    limit?: number
+    trust?: Array<string | RegExp>
     meta?: Record<string, string>
   }
 }