@toa.io/extensions.exposition 1.0.0-alpha.2 → 1.0.0-alpha.4

package/features/octets.workflows.feature

@@ -246,3 +246,41 @@ Feature: Octets storage workflows
       concat: hello world
       --cut--
       """
+
+  Scenario: Executing a workflow with `octets:workflow`
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+        /*:
+          DELETE:
+            octets:workflow:
+              echo: octets.tester.echo
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      202 Accepted
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+      echo: 10cf16b458f759e0d617f2f3d83599ff
+      --cut--
+      """

package/features/steps/Gateway.ts

@@ -26,6 +26,9 @@ export class Gateway {
     if (annotation.debug === true)
       process.env.TOA_EXPOSITION_DEBUG = '1'
 
+    if (annotation.trace === true)
+      process.env.TOA_EXPOSITION_TRACE = '1'
+
     await Gateway.stop()
 
     this.default = false

package/features/steps/IdP.ts

@@ -117,4 +117,33 @@ export class IdP {
 
     this.captures.set(`${user}.id_token`, idToken)
   }
+
+  @given('the IDP {word} token for {word} is issued with following secret:')
+  public async issueSymmetricToken (alg: string, user: string, secret: string): Promise<void> {
+    console.log('Sym token for %s with secret "%s"', user, secret)
+
+    const jwt = [
+      {
+        typ: 'JWT',
+        alg
+      },
+      {
+        iss: IdP.issuer,
+        sub: `${user}-mock-id`,
+        aud: 'test',
+        iat: Math.floor(Date.now() / 1000),
+        exp: Math.floor((Date.now() + 1000 * 60 * 5) / 1000)
+      }
+    ]
+      .map((v) => Buffer.from(JSON.stringify(v)).toString('base64url'))
+      .join('.')
+
+    const signature = crypto.createHmac(alg.replace(/^HS(\d{3})$/, 'sha$1'), secret)
+      .update(jwt)
+      .digest('base64url')
+
+    const idToken = `${jwt}.${signature}`
+
+    this.captures.set(`${user}.id_token`, idToken)
+  }
 }

package/features/steps/components/echo/manifest.toa.yaml

@@ -1,4 +1,5 @@
 name: echo
+version: 0.0.0
 
 operations:
   compute:

package/features/steps/components/greeter/manifest.toa.yaml

@@ -1,4 +1,5 @@
 name: greeter
+version: 0.0.0
 
 exposition:
   /:

package/features/steps/components/octets.tester/manifest.toa.yaml

@@ -1,5 +1,6 @@
 namespace: octets
 name: tester
+version: 0.0.0
 
 storages: octets
 

package/features/steps/components/pots/manifest.toa.yaml

@@ -1,4 +1,5 @@
 name: pots
+version: 0.0.0
 
 entity:
   schema:
@@ -7,11 +8,17 @@ entity:
     temperature?: number
 
 operations:
-  transit:
+  create:
     query: false
+    forward: transit
+    input:
+      title*: .
+      volume*: .
+  transit:
+    concurrency: retry
     input:
-      title*: ~
-      volume*: ~
+      title: .
+      volume: .
   observe:
     output:
       id: string

package/features/steps/components/sequences/manifest.toa.yaml

@@ -1,4 +1,5 @@
 name: sequences
+version: 0.0.0
 
 operations:
   numbers:

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.2",
+  "version": "1.0.0-alpha.4",
   "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.2",
-    "@toa.io/generic": "1.0.0-alpha.2",
-    "@toa.io/schemas": "1.0.0-alpha.2",
-    "@toa.io/streams": "1.0.0-alpha.2",
+    "@toa.io/core": "1.0.0-alpha.4",
+    "@toa.io/generic": "1.0.0-alpha.4",
+    "@toa.io/schemas": "1.0.0-alpha.4",
     "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.2",
-    "@toa.io/extensions.storages": "1.0.0-alpha.2",
+    "@toa.io/agent": "1.0.0-alpha.4",
+    "@toa.io/extensions.storages": "1.0.0-alpha.4",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
-    "@types/express": "4.17.17",
     "@types/negotiator": "0.6.1"
   },
-  "gitHead": "7688e6e980a65c82ac2e459be4e355eebf406cd0"
+  "gitHead": "80a91c0d9c167484247a91e69a0c0a3c344f90d0"
 }

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/octets/workflow.cos.yaml

@@ -0,0 +1,12 @@
+definitions:
+  unit:
+    type: object
+    patternProperties:
+      ^[a-zA-Z0-9_]+$:
+        type: string
+
+oneOf:
+  - $ref: '#/definitions/unit'
+  - type: array
+    items:
+      $ref: '#/definitions/unit'

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/Directive.test.ts

@@ -2,8 +2,8 @@ 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 type { Context } from './HTTP'
 
 const families: Array<jest.MockedObjectDeep<Family>> = [
   {
@@ -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,4 +1,4 @@
-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'
@@ -10,15 +10,15 @@ export class Directives implements RTD.Directives<Directives> {
     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,10 +27,10 @@ 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)
+        await set.family.settle(set.directives, context, response)
   }
 
   public merge (directives: Directives): void {
@@ -39,7 +39,7 @@ export class Directives implements RTD.Directives<Directives> {
 }
 
 export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
-  private readonly remtoes: Remotes
+  private readonly remotes: Remotes
   private readonly families: Record<string, Family> = {}
   private readonly mandatory: string[] = []
 
@@ -51,7 +51,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,7 +67,7 @@ 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)
@@ -109,11 +109,11 @@ export interface Family<TDirective = any, TExtension = any> {
   create: (name: string, value: any, remotes: Remotes) => TDirective
 
   preflight?: (directives: TDirective[],
-    request: IncomingMessage & TExtension,
+    request: Context & TExtension,
     parameters: RTD.Parameter[]) => Output | Promise<Output>
 
   settle?: (directives: TDirective[],
-    request: IncomingMessage & TExtension,
+    request: Context & TExtension,
     response: OutgoingMessage) => void | Promise<void>
 }
 

package/source/Endpoint.ts

@@ -1,9 +1,9 @@
-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> {
   private readonly endpoint: string
@@ -17,12 +17,26 @@ 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
+  (body: any, query: http.Query, parameters: RTD.Parameter[]): Promise<http.OutgoingMessage> {
     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 = { body: reply }
+
+    if (typeof reply === 'object' && reply !== null && '_version' in reply) {
+      message.headers ??= new Headers()
+      message.headers.set('etag', `"${reply._version.toString()}"`)
+      delete reply._version
+    }
+
+    return message
   }
 
   public async close (): Promise<void> {

package/source/Factory.ts

@@ -9,6 +9,7 @@ import { type Directives, 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,15 +20,16 @@ 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)
@@ -36,10 +38,12 @@ export class Factory implements extensions.Factory {
     const tree = new Tree<Endpoint, Directives>(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,8 +1,7 @@
 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'
@@ -12,84 +11,96 @@ 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 interceptor: Interception
 
-  // eslint-disable-next-line max-params, max-len
-  public constructor (broadcast: Broadcast, server: http.Server, tree: Tree<Endpoint, Directives>, interception: Interceptor) {
+  // eslint-disable-next-line max-len
+  public constructor (broadcast: Broadcast, tree: Tree<Endpoint, Directives>, 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
   }
 
+  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<Endpoint, Directives>, request: http.IncomingMessage, parameters: Parameter[]):
+  (method: Method<Endpoint, Directives>, 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()
+    const body = await context.body()
+    const query = this.query(context)
+
+    return await method.endpoint
+      .call(body, query, parameters)
+      .catch(rethrow) as http.OutgoingMessage
+  }
 
-    if ('embed' in request && typeof body === 'object' && body !== null)
-      Object.assign(body, request.embed)
+  private query (context: http.Context): http.Query {
+    const query: http.Query = Object.fromEntries(context.url.searchParams)
+    const etag = context.request.headers['if-match']
 
-    const reply = await method.endpoint
-      .call(body, request.query, parameters)
-      .catch(rethrow) as Maybe<unknown>
+    if (etag !== undefined) {
+      const match = etag.match(ETAG)
 
-    if (reply instanceof Error)
-      throw new http.Conflict(reply)
+      if (match === null)
+        throw new http.BadRequest('Invalid ETag.')
+      else
+        query.version = parseInt(match.groups!.version)
+    }
 
-    return { body: reply }
+    return query
   }
 
   private async discover (): Promise<void> {
@@ -109,4 +120,6 @@ export class Gateway extends Connector {
   }
 }
 
-type Broadcast = bindings.Broadcast<Label>
+const ETAG = /^"(?<version>\d{1,32})"$/
+
+export type Broadcast = bindings.Broadcast<Label>