@toa.io/extensions.exposition 1.0.0-alpha.3 → 1.0.0-alpha.5

package/features/timing.feature

@@ -0,0 +1,43 @@
+Feature: Server timing
+
+  Background:
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          POST: create
+      """
+
+  Scenario: Server timing is not available by default
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the reply does not contain:
+      """
+      server-timing:
+      """
+
+  Scenario: Server timing is sent when debug is enabled
+    Given the annotation:
+      """
+      trace: true
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    # to debug, break it and look at the console
+    Then the following reply is sent:
+      """
+      201 Created
+      server-timing:
+      """

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.5",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -17,13 +17,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@toa.io/core": "1.0.0-alpha.3",
-    "@toa.io/generic": "1.0.0-alpha.3",
-    "@toa.io/schemas": "1.0.0-alpha.3",
-    "@toa.io/streams": "1.0.0-alpha.3",
+    "@toa.io/core": "1.0.0-alpha.5",
+    "@toa.io/generic": "1.0.0-alpha.5",
+    "@toa.io/schemas": "1.0.0-alpha.5",
     "bcryptjs": "2.4.3",
     "error-value": "0.3.0",
-    "express": "4.18.2",
     "js-yaml": "4.1.0",
     "matchacho": "0.3.5",
     "msgpackr": "1.10.1",
@@ -45,12 +43,11 @@
     "features": "cucumber-js"
   },
   "devDependencies": {
-    "@toa.io/agent": "1.0.0-alpha.3",
-    "@toa.io/extensions.storages": "1.0.0-alpha.3",
+    "@toa.io/agent": "1.0.0-alpha.5",
+    "@toa.io/extensions.storages": "1.0.0-alpha.5",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
-    "@types/express": "4.17.17",
     "@types/negotiator": "0.6.1"
   },
-  "gitHead": "e36ac7871fc14d15863aaf8f9bbdeace8bdfa9f0"
+  "gitHead": "1e4bb4ac28a6dddff1f4b8c5be7224fcdc47b847"
 }

package/readme.md

@@ -127,12 +127,13 @@ exposition:
   host: the.example.com
 ```
 
-| Option        | Type      | Description                                                      |
-|---------------|-----------|------------------------------------------------------------------|
-| `host`        | `string`  | Domain name to be used for the corresponding Kubernetes Ingress. |
-| `class`       | `string`  | Ingress class                                                    |
-| `annotations` | `object`  | Ingress annotations                                              |
-| `debug`       | `boolean` | Output server errors. Default `false`.                           |
+| Option        | Type      | Description                                                                                                       |
+|---------------|-----------|-------------------------------------------------------------------------------------------------------------------|
+| `host`        | `string`  | Domain name to be used for the corresponding Kubernetes Ingress.                                                  |
+| `class`       | `string`  | Ingress class                                                                                                     |
+| `annotations` | `object`  | Ingress annotations                                                                                               |
+| `debug`       | `boolean` | Output server errors. Default `false`.                                                                            |
+| `trace`       | `boolean` | Output [server timing](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing). Default `false`. |
 
 ### Context resources
 

package/schemas/annotation.cos.yaml

@@ -2,4 +2,5 @@ host: string
 class: string
 annotations: <string>
 debug: boolean
+trace: boolean
 /: ~

package/schemas/querystring.cos.yaml

@@ -3,3 +3,4 @@ criteria: string
 sort: string
 omit: number
 limit: number
+version: number

package/source/Annotation.ts

@@ -3,5 +3,6 @@ export interface Annotation {
   class?: string
   annotations?: Record<string, string>
   debug: boolean
+  trace: boolean
   '/'?: object // parsed and validated by RTD.syntax.parse
 }

package/source/Context.ts

@@ -1,6 +1,8 @@
-import { type Endpoint } from './Endpoint'
-import { type Directives } from './Directive'
-import { type Branch } from './Branch'
 import type * as RTD from './RTD'
 
-export type Context = RTD.Context<Endpoint, Directives, Branch>
+export type Context = RTD.Context<Extension>
+
+interface Extension {
+  namespace: string
+  component: string
+}

package/source/Directive.test.ts

@@ -1,11 +1,11 @@
 import assert from 'node:assert'
 import { generate } from 'randomstring'
-import { DirectivesFactory, type Family } from './Directive'
-import { type syntax } from './RTD'
-import { type IncomingMessage } from './HTTP'
-import { type Remotes } from './Remotes'
+import { DirectivesFactory } from './Directive'
+import type { syntax, DirectiveFamily } from './RTD'
+import type { Remotes } from './Remotes'
+import type { Context } from './HTTP'
 
-const families: Array<jest.MockedObjectDeep<Family>> = [
+const families: Array<jest.MockedObjectDeep<DirectiveFamily>> = [
   {
     name: 'foo',
     mandatory: true,
@@ -76,7 +76,7 @@ it('should apply directive', async () => {
   }
 
   const directives = factory.create([declaration])
-  const request = generate() as unknown as IncomingMessage
+  const request = generate() as unknown as Context
   const directive = families[0].create.mock.results[0].value
 
   await directives.preflight(request, [])
@@ -89,7 +89,7 @@ it('should apply directive', async () => {
 
 it('should apply mandatory families', async () => {
   const directives = factory.create([])
-  const request = generate() as unknown as IncomingMessage
+  const request = generate() as unknown as Context
 
   await directives.preflight(request, [])
 

package/source/Directive.ts

@@ -1,24 +1,24 @@
-import type { IncomingMessage, OutgoingMessage } from './HTTP'
+import type { Context, OutgoingMessage } from './HTTP'
 import type { Remotes } from './Remotes'
 import type { Output } from './io'
 import type * as RTD from './RTD'
 
-export class Directives implements RTD.Directives<Directives> {
-  private readonly sets: DirectiveSet[]
+export class Directives implements RTD.Directives {
+  private readonly sets: RTD.DirectiveSet[]
 
-  public constructor (sets: DirectiveSet[]) {
+  public constructor (sets: RTD.DirectiveSet[]) {
     this.sets = sets
   }
 
-  public async preflight (request: IncomingMessage, parameters: RTD.Parameter[]): Promise<Output> {
+  public async preflight (context: Context, parameters: RTD.Parameter[]): Promise<Output> {
     for (const set of this.sets) {
       if (set.family.preflight === undefined)
         continue
 
-      const output = await set.family.preflight(set.directives, request, parameters)
+      const output = await set.family.preflight(set.directives, context, parameters)
 
       if (output !== null) {
-        await this.settle(request, output)
+        await this.settle(context, output)
 
         return output
       }
@@ -27,23 +27,19 @@ export class Directives implements RTD.Directives<Directives> {
     return null
   }
 
-  public async settle (request: IncomingMessage, response: OutgoingMessage): Promise<void> {
+  public async settle (context: Context, response: OutgoingMessage): Promise<void> {
     for (const set of this.sets)
       if (set.family.settle !== undefined)
-        await set.family.settle(set.directives, request, response)
-  }
-
-  public merge (directives: Directives): void {
-    this.sets.push(...directives.sets)
+        await set.family.settle(set.directives, context, response)
   }
 }
 
-export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
-  private readonly remtoes: Remotes
-  private readonly families: Record<string, Family> = {}
+export class DirectivesFactory implements RTD.DirectiveFactory {
+  private readonly remotes: Remotes
+  private readonly families: Record<string, RTD.DirectiveFamily> = {}
   private readonly mandatory: string[] = []
 
-  public constructor (families: Family[], remotes: Remotes) {
+  public constructor (families: RTD.DirectiveFamily[], remotes: Remotes) {
     for (const family of families) {
       this.families[family.name] = family
 
@@ -51,7 +47,7 @@ export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
         this.mandatory.push(family.name)
     }
 
-    this.remtoes = remotes
+    this.remotes = remotes
   }
 
   public create (declarations: RTD.syntax.Directive[]): Directives {
@@ -67,14 +63,14 @@ export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
       if (family === undefined)
         throw new Error(`Directive family '${declaration.family}' is not found.`)
 
-      const directive = family.create(declaration.name, declaration.value, this.remtoes)
+      const directive = family.create(declaration.name, declaration.value, this.remotes)
 
       groups[family.name] ??= []
       groups[family.name].push(directive)
       mandatory.delete(family.name)
     }
 
-    const sets: DirectiveSet[] = []
+    const sets: RTD.DirectiveSet[] = []
 
     for (const family of mandatory)
       sets.push({
@@ -99,25 +95,3 @@ export const shortcuts: RTD.syntax.Shortcuts = new Map([
   ['rule', 'auth:rule'],
   ['incept', 'auth:incept']
 ])
-
-export interface Family<TDirective = any, TExtension = any> {
-  readonly name: string
-  readonly mandatory: boolean
-
-  // produce: (declarations: RTD.syntax.Directive[], remotes: Remotes) => TDirective[]
-
-  create: (name: string, value: any, remotes: Remotes) => TDirective
-
-  preflight?: (directives: TDirective[],
-    request: IncomingMessage & TExtension,
-    parameters: RTD.Parameter[]) => Output | Promise<Output>
-
-  settle?: (directives: TDirective[],
-    request: IncomingMessage & TExtension,
-    response: OutgoingMessage) => void | Promise<void>
-}
-
-interface DirectiveSet {
-  family: Family
-  directives: any[]
-}

package/source/Endpoint.ts

@@ -1,11 +1,11 @@
-import { type Component, type Reply } from '@toa.io/core'
+import { type Component } from '@toa.io/core'
 import { type Remotes } from './Remotes'
 import { Mapping } from './Mapping'
 import { type Context } from './Context'
+import * as http from './HTTP'
 import type * as RTD from './RTD'
-import type * as http from './HTTP'
 
-export class Endpoint implements RTD.Endpoint<Endpoint> {
+export class Endpoint implements RTD.Endpoint {
   private readonly endpoint: string
   private readonly mapping: Mapping
   private readonly discovery: Promise<Component>
@@ -17,12 +17,40 @@ export class Endpoint implements RTD.Endpoint<Endpoint> {
     this.discovery = discovery
   }
 
-  public async call (body: any, query: http.Query, parameters: RTD.Parameter[]): Promise<Reply> {
+  public async call
+  (context: http.Context, parameters: RTD.Parameter[]): Promise<http.OutgoingMessage> {
+    const body = await context.body()
+    const query = this.query(context)
     const request = this.mapping.fit(body, query, parameters)
 
     this.remote ??= await this.discovery
 
-    return await this.remote.invoke(this.endpoint, request)
+    const reply = await this.remote.invoke(this.endpoint, request)
+
+    if (reply instanceof Error)
+      throw new http.Conflict(reply)
+
+    const message: http.OutgoingMessage = {}
+
+    if (typeof reply === 'object' && reply !== null && '_version' in reply) {
+      const etag = context.request.headers['if-none-match']
+
+      message.headers ??= new Headers()
+
+      if (etag !== undefined && reply._version === this.version(etag)) {
+        message.status = 304
+        message.headers.set('etag', etag)
+
+        return message
+      } else {
+        message.headers.set('etag', `"${reply._version.toString()}"`)
+        delete reply._version
+      }
+    }
+
+    message.body = reply
+
+    return message
   }
 
   public async close (): Promise<void> {
@@ -30,9 +58,28 @@ export class Endpoint implements RTD.Endpoint<Endpoint> {
 
     await this.remote.disconnect(INTERRUPT)
   }
+
+  private query (context: http.Context): http.Query {
+    const query: http.Query = Object.fromEntries(context.url.searchParams)
+    const etag = context.request.headers['if-match']
+
+    if (etag !== undefined)
+      query.version = this.version(etag)
+
+    return query
+  }
+
+  private version (etag: string): number {
+    const match = etag.match(ETAG)
+
+    if (match === null)
+      throw new http.BadRequest('Invalid ETag.')
+
+    return Number.parseInt(match.groups!.version)
+  }
 }
 
-export class EndpointsFactory implements RTD.EndpointsFactory<Endpoint> {
+export class EndpointsFactory implements RTD.EndpointsFactory {
   private readonly remotes: Remotes
 
   public constructor (remotes: Remotes) {
@@ -56,4 +103,6 @@ export class EndpointsFactory implements RTD.EndpointsFactory<Endpoint> {
   }
 }
 
+const ETAG = /^"(?<version>\d{1,32})"$/
+
 const INTERRUPT = true

package/source/Factory.ts

@@ -3,12 +3,13 @@ import { Gateway } from './Gateway'
 import { Remotes } from './Remotes'
 import { Tree, syntax } from './RTD'
 import { Server } from './HTTP'
-import { type Endpoint, EndpointsFactory } from './Endpoint'
+import { EndpointsFactory } from './Endpoint'
 import { families, interceptors } from './directives'
-import { type Directives, DirectivesFactory } from './Directive'
+import { DirectivesFactory } from './Directive'
 import { Composition } from './Composition'
 import * as root from './root'
 import { Interception } from './Interception'
+import type { Broadcast } from './Gateway'
 import type { Connector, Locator, extensions } from '@toa.io/core'
 
 export class Factory implements extensions.Factory {
@@ -19,27 +20,36 @@ export class Factory implements extensions.Factory {
   }
 
   public tenant (locator: Locator, node: syntax.Node): Connector {
-    const broadcast = this.boot.bindings.broadcast(CHANNEL, locator.id)
+    const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL, locator.id)
 
     return new Tenant(broadcast, locator, node)
   }
 
   public service (): Connector | null {
     const debug = process.env.TOA_EXPOSITION_DEBUG === '1'
-    const broadcast = this.boot.bindings.broadcast(CHANNEL)
-    const server = Server.create({ methods: syntax.verbs, debug })
+    const trace = process.env.TOA_EXPOSITION_TRACE === '1'
+    const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL)
+
+    const server = Server.create({
+      methods: syntax.verbs,
+      debug,
+      trace
+    })
+
     const remotes = new Remotes(this.boot)
     const node = root.resolve()
     const methods = new EndpointsFactory(remotes)
     const directives = new DirectivesFactory(families, remotes)
     const interception = new Interception(interceptors)
-    const tree = new Tree<Endpoint, Directives>(node, methods, directives)
+    const tree = new Tree(node, methods, directives)
 
     const composition = new Composition(this.boot)
-    const gateway = new Gateway(broadcast, server, tree, interception)
+    const gateway = new Gateway(broadcast, tree, interception)
 
     gateway.depends(remotes)
     gateway.depends(composition)
+
+    server.attach(gateway.process.bind(gateway))
     server.depends(gateway)
 
     return server

package/source/Gateway.ts

@@ -1,95 +1,83 @@
 import { type bindings, Connector } from '@toa.io/core'
 import * as http from './HTTP'
 import { rethrow } from './exceptions'
-import type { Interceptor } from './Interception'
-import type { Maybe } from '@toa.io/types'
+import type { Interception } from './Interception'
 import type { Method, Parameter, Tree } from './RTD'
 import type { Label } from './discovery'
 import type { Branch } from './Branch'
-import type { Endpoint } from './Endpoint'
-import type { Directives } from './Directive'
 
 export class Gateway extends Connector {
   private readonly broadcast: Broadcast
-  private readonly tree: Tree<Endpoint, Directives>
-  private readonly interceptor: Interceptor
-  private readonly server: Connector
+  private readonly tree: Tree
+  private readonly interceptor: Interception
 
-  // eslint-disable-next-line max-params, max-len
-  public constructor (broadcast: Broadcast, server: http.Server, tree: Tree<Endpoint, Directives>, interception: Interceptor) {
+  public constructor (broadcast: Broadcast, tree: Tree, interception: Interception) {
     super()
 
     this.broadcast = broadcast
     this.tree = tree
     this.interceptor = interception
-    this.server = server
 
     this.depends(broadcast)
-    // this.depends(server)
-
-    server.attach(this.process.bind(this))
-  }
-
-  protected override async open (): Promise<void> {
-    await this.discover()
-
-    console.info('Gateway has started and is awaiting resource branches.')
   }
 
-  protected override dispose (): void {
-    console.info('Gateway is closed.')
-  }
-
-  private async process (request: http.IncomingMessage): Promise<http.OutgoingMessage> {
-    const interception = await this.interceptor.intercept(request)
+  public async process (context: http.Context): Promise<http.OutgoingMessage> {
+    const interception = await context.timing.capture('gate:intercept',
+      this.interceptor.intercept(context))
 
     if (interception !== null)
       return interception
 
-    const match = this.tree.match(request.path)
+    const match = this.tree.match(context.url.pathname)
 
     if (match === null)
       throw new http.NotFound()
 
-    const { node, parameters } = match
+    const {
+      node,
+      parameters
+    } = match
 
-    if (!(request.method in node.methods))
+    if (!(context.request.method in node.methods))
       throw new http.MethodNotAllowed()
 
-    const method = node.methods[request.method]
-    const interruption = await method.directives.preflight(request, parameters)
-    const response = interruption ?? await this.call(method, request, parameters)
+    const method = node.methods[context.request.method]
 
-    await method.directives.settle(request, response)
+    const interruption = await context.timing.capture('gate:preflight',
+      method.directives.preflight(context, parameters))
+
+    const response = interruption ??
+      await context.timing.capture('gate:call', this.call(method, context, parameters))
+
+    await context.timing.capture('gate:settle', method.directives.settle(context, response))
 
     return response
   }
 
-  private async call
-  (method: Method<Endpoint, Directives>, request: http.IncomingMessage, parameters: Parameter[]):
+  protected override async open (): Promise<void> {
+    await this.discover()
+
+    console.info('Gateway has started and is awaiting resource branches.')
+  }
+
+  protected override dispose (): void {
+    console.info('Gateway is closed.')
+  }
+
+  private async call (method: Method, context: http.Context, parameters: Parameter[]):
   Promise<http.OutgoingMessage> {
-    if (request.path[request.path.length - 1] !== '/')
+    if (context.url.pathname[context.url.pathname.length - 1] !== '/')
       throw new http.NotFound('Trailing slash is required.')
 
-    if (request.encoder === null)
+    if (context.encoder === null)
       throw new http.NotAcceptable()
 
     if (method.endpoint === null)
       throw new http.MethodNotAllowed()
 
-    const body = await request.parse()
-
-    if ('embed' in request && typeof body === 'object' && body !== null)
-      Object.assign(body, request.embed)
-
-    const reply = await method.endpoint
-      .call(body, request.query, parameters)
-      .catch(rethrow) as Maybe<unknown>
-
-    if (reply instanceof Error)
-      throw new http.Conflict(reply)
-
-    return { body: reply }
+    return await method.endpoint
+      .call(context, parameters)
+      .catch(rethrow) as http.OutgoingMessage
   }
 
   private async discover (): Promise<void> {
@@ -109,4 +97,4 @@ export class Gateway extends Connector {
   }
 }
 
-type Broadcast = bindings.Broadcast<Label>
+export type Broadcast = bindings.Broadcast<Label>

package/source/HTTP/Context.ts

@@ -0,0 +1,67 @@
+import Negotiator from 'negotiator'
+import { Timing } from './Timing'
+import { type Format, formats, types } from './formats'
+import { read } from './messages'
+import type { OutgoingMessage } from './messages'
+import type * as http from 'node:http'
+
+export class Context {
+  public readonly request: IncomingMessage
+  public readonly url: URL
+  public readonly subtype: string | null = null
+  public readonly encoder: Format | null = null
+  public readonly timing: Timing
+
+  public readonly pipelines: Pipelines = {
+    body: [],
+    response: []
+  }
+
+  public constructor (request: IncomingMessage, trace = false) {
+    this.request = request
+
+    this.url = new URL(request.url, `https://${request.headers.host}`)
+    this.timing = new Timing(trace)
+
+    if (this.request.headers.accept !== undefined) {
+      const match = SUBTYPE.exec(this.request.headers.accept)
+
+      if (match !== null) {
+        const {
+          type,
+          subtype,
+          suffix
+        } = match.groups!
+
+        this.request.headers.accept = `${type}/${suffix}`
+        this.subtype = subtype
+      }
+    }
+
+    const negotiator = new Negotiator(this.request)
+    const mediaType = negotiator.mediaType(types)
+
+    if (mediaType !== undefined)
+      this.encoder = formats[mediaType]
+  }
+
+  public async body<T> (): Promise<T> {
+    const value = await read(this)
+
+    return this.pipelines.body.length === 0
+      ? value
+      : this.pipelines.body.reduce((value, transform) => transform(value), value)
+  }
+}
+
+export interface IncomingMessage extends http.IncomingMessage {
+  url: string
+  method: string
+}
+
+interface Pipelines {
+  body: Array<(input: unknown) => unknown>
+  response: Array<(output: OutgoingMessage) => void>
+}
+
+const SUBTYPE = /^(?<type>\w{1,32})\/(vnd\.toa\.(?<subtype>\S{1,32})\+)(?<suffix>\S{1,32})$/

package/source/HTTP/Server.test.ts

@@ -41,8 +41,8 @@ it('should send 501 on unknown method', async () => {
 })
 
 it('should stop HTTP server', async () => {
+  await server.connect()
   await server.disconnect()
-  expect(server.port).toBe(0)
   expect(server.connected).toBeFalsy()
 })