@toa.io/extensions.exposition 1.0.0-alpha.9 → 1.0.0-alpha.91

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/Compose.ts

@@ -0,0 +1,68 @@
+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 expression: Expression
+
+  public constructor (composition: any) {
+    this.expression = compile(composition as object)
+  }
+
+  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.expression($)
+    })
+  }
+
+  private async compose (stream: Readable): Promise<unknown[]> {
+    const $: unknown[] = []
+
+    stream.on('data', (data) => $.push(data))
+
+    await once(stream, 'end')
+
+    return $
+  }
+}
+
+function compile (composition: object): Expression {
+  // eslint-disable-next-line @typescript-eslint/no-implied-eval,no-new-func
+  return new Function('$', `return ${json(composition)}`) 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)).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

@@ -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/IO.ts

@@ -10,7 +10,7 @@ export class IO implements DirectiveFamily<Directive> {
 
   public create (name: string, value: unknown): 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]
 

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

@@ -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'
@@ -40,19 +41,19 @@ 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)
     }

package/source/directives/octets/Context.ts

@@ -1,4 +1,4 @@
-import * as schemas from './schemas'
+import assert from 'node:assert'
 import { Directive } from './Directive'
 import type { Output } from '../../io'
 
@@ -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

@@ -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

package/source/directives/octets/Get.ts

@@ -0,0 +1,84 @@
+import { Forbidden, NotFound } from '../../HTTP'
+import * as schemas from './schemas'
+import { Directive } from './Directive'
+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'
+import type { Input } from './types'
+
+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 entry = await this.storage.invoke<Maybe<Stream>>('get', {
+      input: {
+        storage,
+        path: input.request.url
+      }
+    })
+
+    if (entry instanceof Error)
+      throw new NotFound()
+
+    const headers = new Headers({
+      'content-type': entry.type,
+      'content-length': entry.size.toString(),
+      etag: `"${entry.checksum}"`
+    })
+
+    return {
+      headers,
+      body: entry.stream
+    }
+  }
+
+  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
+}

package/source/directives/octets/Octets.ts

@@ -1,10 +1,8 @@
 import { NotFound } from '../../HTTP'
 import { Context } from './Context'
-import { Store } from './Store'
-import { Fetch } from './Fetch'
-import { List } from './List'
+import { Put } from './Put'
+import { Get } from './Get'
 import { Delete } from './Delete'
-import { Permute } from './Permute'
 import { WorkflowDirective } from './Workflow'
 import type { Directive } from './Directive'
 import type { Output } from '../../io'
@@ -23,7 +21,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')
 
@@ -41,19 +39,19 @@ export class Octets implements DirectiveFamily<Directive> {
       else if (action === null)
         action = directive
       else
-        throw new Error('Octets action is umbiguous.')
+        throw new Error('Octets action is ambiguous')
 
     if (action === null)
       return null
 
     // noinspection PointlessBooleanExpressionJS
     if (context === null)
-      throw new Error('Octets context is not defined.')
+      throw new Error('Octets context is not defined')
 
     const targeted = input.request.url[input.request.url.length - 1] !== '/'
 
     if (targeted !== action.targeted)
-      throw new NotFound(`Trailing slash is ${action.targeted ? 'redundant' : 'required'}.`)
+      throw new NotFound(`Trailing slash is ${action.targeted ? 'redundant' : 'required'}`)
 
     // noinspection JSObjectNullOrUndefined
     return await input.timing.capture(action.name, action.apply(context.storage, input, parameters))
@@ -62,11 +60,9 @@ export class Octets implements DirectiveFamily<Directive> {
 
 const DIRECTIVES: Record<string, Constructor> = {
   context: Context,
-  store: Store,
-  fetch: Fetch,
-  list: List,
+  put: Put,
+  get: Get,
   delete: Delete,
-  permute: Permute,
   workflow: WorkflowDirective
 }