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

package/features/timing.feature

@@ -12,6 +12,7 @@ Feature: Server timing
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
 
       title: Hello
@@ -22,7 +23,7 @@ Feature: Server timing
       server-timing:
       """
 
-  Scenario: Server timing is sent when debug is enabled
+  Scenario: Server timing is sent when `trace` is enabled
     Given the annotation:
       """
       trace: true
@@ -30,6 +31,7 @@ Feature: Server timing
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
 
       title: Hello
@@ -41,3 +43,27 @@ Feature: Server timing
       201 Created
       server-timing:
       """
+
+  Scenario: Octets timing
+    Given the annotation:
+      """yaml
+      trace: true
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:store: ~
+      """
+    When the stream of `lenna.png` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-type: application/octet-stream
+      """
+    # to debug, break it and look at the console
+    Then the following reply is sent:
+      """
+      201 Created
+      server-timing:
+      """

package/features/vary.feature

@@ -5,6 +5,7 @@ Feature: The Vary directive family
       """yaml
       exposition:
         /:
+          io:output: true
           vary:languages: [en, fr]
           GET:
             vary:embed:
@@ -14,6 +15,7 @@ Feature: The Vary directive family
     When the following request is received:
       """
       GET /echo/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       accept-language: <accept>
       """
@@ -43,6 +45,7 @@ Feature: The Vary directive family
       """yaml
       exposition:
         /:
+          io:output: true
           GET:
             anonymous: true
             vary:embed:
@@ -52,6 +55,7 @@ Feature: The Vary directive family
     When the following request is received:
       """
       GET /echo/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       accept-language: fr
       """
@@ -62,12 +66,12 @@ Feature: The Vary directive family
       content-language: fr
       """
 
-
   Scenario: Embedding a value of an arbitrary header
     Given the `echo` is running with the following manifest:
       """yaml
       exposition:
         /:
+          io:output: true
           GET:
             vary:embed:
               name: :foo
@@ -76,6 +80,7 @@ Feature: The Vary directive family
     When the following request is received:
       """
       GET /echo/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       foo: bar
       """
@@ -88,11 +93,39 @@ Feature: The Vary directive family
       Hello bar
       """
 
+  Scenario: Embedding a `host` header value
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET:
+            vary:embed:
+              name: :Host
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      foo: bar
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      vary: accept
+
+      Hello 127.0.0.1:8000
+      """
+
   Scenario Outline: Embedding a value from the list of options
     Given the `echo` is running with the following manifest:
         """yaml
         exposition:
           /:
+            io:output: true
             vary:languages: [en, fr]
             GET:
               vary:embed:
@@ -105,6 +138,7 @@ Feature: The Vary directive family
     When the following request is received:
         """
         GET /echo/ HTTP/1.1
+      host: nex.toa.io
         accept: application/yaml
         <header>: <value>
         """
@@ -122,11 +156,36 @@ Feature: The Vary directive family
       | bar             | baz   |
       | accept-language | en    |
 
+  Scenario: Embedding route parameter
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:friend:
+          io:output: true
+          GET:
+            vary:embed:
+              name: /:friend
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/Ken/ HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello Ken
+      """
+
   Scenario: Adding headers used by defined embeddings to CORS permissions
     Given the `echo` is running with the following manifest:
         """yaml
         exposition:
           /:
+            io:output: true
             vary:languages: [en, fr]
             GET:
               vary:embed:
@@ -140,11 +199,54 @@ Feature: The Vary directive family
     When the following request is received:
         """
         OPTIONS / HTTP/1.1
-        origin: http://example.com
+      host: nex.toa.io
+        origin: https://example.com
         access-control-request-headers: whatever
         """
     Then the following reply is sent:
         """
         204 No Content
-        access-control-allow-headers: accept, authorization, content-type, accept-language, foo, bar
+        access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, accept-language, foo, bar
         """
+
+  Scenario: Embedding authority
+    Given the annotation:
+      """yaml
+      authorities:
+        one: the.one.com
+        two: the.two.com
+      """
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET:
+            vary:embed:
+              name: authority
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: the.one.com
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello one
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      host: the.two.com
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello two
+      """

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.40",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -17,9 +17,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@toa.io/core": "1.0.0-alpha.4",
-    "@toa.io/generic": "1.0.0-alpha.4",
-    "@toa.io/schemas": "1.0.0-alpha.4",
+    "@toa.io/core": "1.0.0-alpha.40",
+    "@toa.io/generic": "1.0.0-alpha.40",
+    "@toa.io/schemas": "1.0.0-alpha.40",
     "bcryptjs": "2.4.3",
     "error-value": "0.3.0",
     "js-yaml": "4.1.0",
@@ -34,20 +34,21 @@
   },
   "scripts": {
     "test": "jest",
-    "transpile": "tsc && npm run transpile:basic && npm run transpile:tokens && npm run transpile:roles && npm run transpile:federation",
+    "transpile": "tsc && npm run transpile:bans && npm run transpile:basic && npm run transpile:tokens && npm run transpile:roles && npm run transpile:federation",
+    "transpile:bans": "tsc -p ./components/identity.bans",
     "transpile:basic": "tsc -p ./components/identity.basic",
-    "pretranspile:federation": "js-yaml components/identity.federation/manifest.toa.yaml | jq -M '{ type: \"object\", properties: {configuration: .configuration.schema, entity: .entity.schema }, additionalProperties: false}' > schemas.json && json2ts -i schemas.json -o components/identity.federation/source/schemas.ts && rm schemas.json",
-    "transpile:federation": "tsc -p ./components/identity.federation",
     "transpile:tokens": "tsc -p ./components/identity.tokens",
     "transpile:roles": "tsc -p ./components/identity.roles",
-    "features": "cucumber-js"
+    "transpile:federation": "tsc -p ./components/identity.federation",
+    "features": "cucumber-js",
+    "features:security": "cucumber-js --tags @security"
   },
   "devDependencies": {
-    "@toa.io/agent": "1.0.0-alpha.4",
-    "@toa.io/extensions.storages": "1.0.0-alpha.4",
+    "@toa.io/agent": "1.0.0-alpha.40",
+    "@toa.io/extensions.storages": "1.0.0-alpha.40",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
     "@types/negotiator": "0.6.1"
   },
-  "gitHead": "80a91c0d9c167484247a91e69a0c0a3c344f90d0"
+  "gitHead": "973a253abb982ddd6cdd7427ef98331d1157180d"
 }

package/readme.md

@@ -20,7 +20,8 @@ exposition:
 # context.toa.yaml
 
 exposition:
-  host: api.example.com
+  authorities:
+    example: api.example.com
 ```
 
 ```http
@@ -117,33 +118,36 @@ The Exposition annotation declares options for its deployment.
 ```yaml
 annotations:
   '@toa.io/extensions.exposition':
-    host: the.exmaple.com
+    authorities:
+      example: the.example.com
 ```
 
 A shortcut is also available.
 
 ```yaml
 exposition:
-  host: the.example.com
+  authorities:
+    example: 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`.                                                                            |
-| `trace`       | `boolean` | Output [server timing](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing). Default `false`. |
+| Option        | Description                                                                                                       |
+|---------------|-------------------------------------------------------------------------------------------------------------------|
+| `auhorities`  | Mapping of authority identifiers to domain names. See [Authorities](documentation/authorities.md).                |
+| `class`       | Ingress class.                                                                                                    |
+| `annotations` | Ingress annotations.                                                                                              |
+| `debug`       | Output server errors. Default `false`.                                                                            |
+| `trace`       | Output [server timing](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing). Default `false`. |
 
 ### Context resources
 
-Exposition annotaion can contain [resource declaration](documentation/tree.md) under the `/` key.
+Exposition annotation can contain [resource declaration](documentation/tree.md) under the `/` key.
 
 ```yaml
 # context.toa.yaml
 
 exposition:
-  host: the.example.com
+  authorities:
+    example: the.example.com
   /:
     /code:
       GET:
@@ -162,8 +166,9 @@ If component resource branch conflicts with an annotation, the annotation takes
 
 ```yaml
 exposition:
-  host: the.example.com
-  host@staging: the.example.dev
+  authorities:
+    example: the.example.com
+    example@staging: the.example.dev
   class: alb
   debug@staging: true
   annotations:

package/schemas/annotation.cos.yaml

@@ -1,4 +1,4 @@
-host: string
+authorities*: <string>
 class: string
 annotations: <string>
 debug: boolean

package/schemas/io/input.cos.yaml

@@ -0,0 +1,3 @@
+type: array
+items:
+  type: string

package/schemas/io/message.cos.yaml

@@ -0,0 +1,5 @@
+oneOf:
+  - type: object
+  - type: array
+    items:
+      type: object

package/schemas/io/output.cos.yaml

@@ -0,0 +1,5 @@
+oneOf:
+  - type: boolean
+  - type: array
+    items:
+      type: string

package/source/Annotation.ts

@@ -1,8 +1,8 @@
 export interface Annotation {
-  host?: string
+  authorities: Record<string, string>
   class?: string
   annotations?: Record<string, string>
-  debug: boolean
-  trace: boolean
+  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 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,

package/source/Directive.ts

@@ -3,10 +3,10 @@ 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
   }
 
@@ -17,11 +17,8 @@ export class Directives implements RTD.Directives<Directives> {
 
       const output = await set.family.preflight(set.directives, context, parameters)
 
-      if (output !== null) {
-        await this.settle(context, output)
-
+      if (output !== null)
         return output
-      }
     }
 
     return null
@@ -32,18 +29,14 @@ export class Directives implements RTD.Directives<Directives> {
       if (set.family.settle !== undefined)
         await set.family.settle(set.directives, context, response)
   }
-
-  public merge (directives: Directives): void {
-    this.sets.push(...directives.sets)
-  }
 }
 
-export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
+export class DirectivesFactory implements RTD.DirectiveFactory {
   private readonly remotes: Remotes
-  private readonly families: Record<string, Family> = {}
+  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
 
@@ -74,7 +67,7 @@ export class DirectivesFactory implements RTD.DirectivesFactory<Directives> {
       mandatory.delete(family.name)
     }
 
-    const sets: DirectiveSet[] = []
+    const sets: RTD.DirectiveSet[] = []
 
     for (const family of mandatory)
       sets.push({
@@ -97,27 +90,7 @@ export const shortcuts: RTD.syntax.Shortcuts = new Map([
   ['id', 'auth:id'],
   ['role', 'auth:role'],
   ['rule', 'auth:rule'],
-  ['incept', 'auth:incept']
+  ['incept', 'auth:incept'],
+  ['input', 'io:input'],
+  ['output', 'io:output']
 ])
-
-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: Context & TExtension,
-    parameters: RTD.Parameter[]) => Output | Promise<Output>
-
-  settle?: (directives: TDirective[],
-    request: Context & TExtension,
-    response: OutgoingMessage) => void | Promise<void>
-}
-
-interface DirectiveSet {
-  family: Family
-  directives: any[]
-}

package/source/Endpoint.ts

@@ -5,7 +5,7 @@ import { type Context } from './Context'
 import * as http from './HTTP'
 import type * as RTD from './RTD'
 
-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,25 +17,39 @@ export class Endpoint implements RTD.Endpoint<Endpoint> {
     this.discovery = discovery
   }
 
-  public async call
-  (body: any, query: http.Query, parameters: RTD.Parameter[]): Promise<http.OutgoingMessage> {
+  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
 
+    if (context.debug)
+      console.debug('Call', `${this.remote.locator.id}.${this.endpoint}`, request)
+
     const reply = await this.remote.invoke(this.endpoint, request)
 
     if (reply instanceof Error)
-      throw new http.Conflict(reply)
+      throw new http.UnprocessableEntity(reply)
 
-    const message: http.OutgoingMessage = { body: 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()
-      message.headers.set('etag', `"${reply._version.toString()}"`)
-      delete reply._version
+
+      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()}"`)
     }
 
+    message.body = reply
+
     return message
   }
 
@@ -44,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) {
@@ -70,4 +103,6 @@ export class EndpointsFactory implements RTD.EndpointsFactory<Endpoint> {
   }
 }
 
+const ETAG = /^"(?<version>\d{1,32})"$/
+
 const INTERRUPT = true

package/source/Factory.ts

@@ -1,14 +1,16 @@
+import assert from 'node:assert'
+import { decode } from '@toa.io/generic'
 import { Tenant } from './Tenant'
 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 * as http from './HTTP'
 import type { Broadcast } from './Gateway'
 import type { Connector, Locator, extensions } from '@toa.io/core'
 
@@ -26,16 +28,18 @@ export class Factory implements extensions.Factory {
   }
 
   public service (): Connector | null {
-    const debug = process.env.TOA_EXPOSITION_DEBUG === '1'
-    const trace = process.env.TOA_EXPOSITION_TRACE === '1'
+    assert.ok(process.env.TOA_EXPOSITION_PROPERTIES,
+      'TOA_EXPOSITION_PROPERTIES is undefined')
+
+    const options = decode<http.Options>(process.env.TOA_EXPOSITION_PROPERTIES)
     const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL)
-    const server = Server.create({ methods: syntax.verbs, debug, trace })
+    const server = http.Server.create({ ...options, methods: syntax.verbs })
     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, tree, interception)