@toa.io/extensions.exposition 1.0.0-alpha.21 → 1.0.0-alpha.22

package/features/octets.workflows.feature

@@ -23,6 +23,7 @@ Feature: Octets storage workflows
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/octet-stream
       """
@@ -49,6 +50,7 @@ Feature: Octets storage workflows
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       accept: application/vnd.toa.octets.entry+yaml
       """
     Then the following reply is sent:
@@ -67,6 +69,7 @@ Feature: Octets storage workflows
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff.hello.png HTTP/1.1
+      host: nex.toa.io
       """
     Then the stream equals to `lenna.png` is sent with the following headers:
       """
@@ -92,6 +95,7 @@ Feature: Octets storage workflows
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/octet-stream
       """
@@ -134,6 +138,7 @@ Feature: Octets storage workflows
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       content-type: application/octet-stream
       """
     Then the following reply is sent:
@@ -143,6 +148,7 @@ Feature: Octets storage workflows
     When the following request is received:
       """
       DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -157,6 +163,7 @@ Feature: Octets storage workflows
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -183,6 +190,7 @@ Feature: Octets storage workflows
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       content-type: application/octet-stream
       """
     Then the following reply is sent:
@@ -192,6 +200,7 @@ Feature: Octets storage workflows
     When the following request is received:
       """
       DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -209,6 +218,7 @@ Feature: Octets storage workflows
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -231,6 +241,7 @@ Feature: Octets storage workflows
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST /hello/world/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/octet-stream
       """
@@ -265,6 +276,7 @@ Feature: Octets storage workflows
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       content-type: application/octet-stream
       """
     Then the following reply is sent:
@@ -274,6 +286,7 @@ Feature: Octets storage workflows
     When the following request is received:
       """
       DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:

package/features/queries.feature

@@ -19,6 +19,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/pot/?id=99988d785d7d445cad45dbf8531f560b HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -42,6 +43,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/?criteria=volume<300&limit=10 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -68,6 +70,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/?omit=1&limit=2 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -94,6 +97,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/?sort=volume:desc&limit=2 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -120,6 +124,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/99988d785d7d445cad45dbf8531f560b/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -146,6 +151,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/big/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -175,6 +181,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/big/?criteria=temperature>50 HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -204,6 +211,7 @@ Feature: Queries
     When the following request is received:
       """
       GET /pots/hottest2/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:

package/features/require.feature

@@ -17,6 +17,7 @@ Feature: Request requirements
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
       accept: application/yaml
 
@@ -33,6 +34,7 @@ Feature: Request requirements
     When the following request is received:
       """
       PUT /pots/<variant>/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
       accept: text/plain
 
@@ -48,6 +50,7 @@ Feature: Request requirements
     When the following request is received:
       """
       PUT /pots/<variant>/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
       accept: text/plain
       if-match: ${{ etag }}

package/features/response.feature

@@ -13,6 +13,7 @@ Feature: Response
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: application/json
       """
     Then the following reply is sent:
@@ -35,11 +36,12 @@ Feature: Response
     When the following request is received:
       """
       GET /echo/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
       """
-      409 Conflict
+      422 Unprocessable Entity
       content-type: application/yaml
 
       code: CODE
@@ -57,11 +59,12 @@ Feature: Response
     When the following request is received:
       """
       GET /echo/ HTTP/1.1
+      host: nex.toa.io
       accept: application/msgpack
       """
     Then the following reply is sent:
       """
-      409 Conflict
+      422 Unprocessable Entity
       content-type: application/msgpack
       """
     And response body contains MessagePack-encoded value:

package/features/routes.feature

@@ -18,6 +18,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /basic/greeter<route> HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -42,6 +43,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /greeter/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -65,6 +67,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /greeter/baz/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -76,6 +79,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /greeter/baz/qux/ HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -84,6 +88,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /greeter/foo/baz/bar/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -112,6 +117,7 @@ Feature: Routes
     When the following request is received:
       """
       GET /users/properties/b5534021e30042259badffbd1831e472/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
@@ -123,6 +129,7 @@ Feature: Routes
     When the following request is received:
       """
       POST /users/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
 
       name: Alice

package/features/steps/Gateway.ts

@@ -6,6 +6,7 @@ import { encode, timeout } from '@toa.io/generic'
 import { Factory } from '../../source'
 import * as syntax from '../../source/RTD/syntax'
 import { shortcuts } from '../../source/Directive'
+import type * as http from '../../source/HTTP'
 
 let instance: Connector | null = null
 
@@ -23,11 +24,19 @@ export class Gateway {
       process.env.TOA_EXPOSITION = encode(tree)
     }
 
-    if (annotation.debug === true)
-      process.env.TOA_EXPOSITION_DEBUG = '1'
+    const { debug, trace, authorities } = annotation
+    const properties = Object.assign({}, DEFAULT_PROPERTIES)
 
-    if (annotation.trace === true)
-      process.env.TOA_EXPOSITION_TRACE = '1'
+    if (debug !== undefined)
+      properties.debug = debug
+
+    if (trace !== undefined)
+      properties.trace = trace
+
+    if (authorities !== undefined)
+      properties.authorities = authorities
+
+    process.env.TOA_EXPOSITION_PROPERTIES = encode(properties)
 
     await Gateway.stop()
 
@@ -54,7 +63,8 @@ export class Gateway {
     if (instance !== null)
       return
 
-    process.env.TOA_EXPOSITION ??= DEFAULT_ANNOTATION
+    process.env.TOA_EXPOSITION ??= DEFAULT_TREE
+    process.env.TOA_EXPOSITION_PROPERTIES ??= encode(DEFAULT_PROPERTIES)
 
     this.writeConfiguration()
 
@@ -76,6 +86,7 @@ export class Gateway {
       return
 
     delete process.env.TOA_EXPOSITION
+    delete process.env.TOA_EXPOSITION_PROPERTIES
 
     await Gateway.stop()
   }
@@ -96,7 +107,7 @@ export class Gateway {
   }
 }
 
-const DEFAULT_ANNOTATION = encode({
+const DEFAULT_TREE = encode({
   routes: [],
   methods: [],
   directives: [
@@ -108,6 +119,12 @@ const DEFAULT_ANNOTATION = encode({
   ]
 } satisfies syntax.Node)
 
+const DEFAULT_PROPERTIES: Partial<http.Options> = {
+  authorities: {
+    nex: 'nex.toa.io'
+  }
+}
+
 const DEFAULT_CONFIGURATION: Record<string, object> = {
   'identity.tokens': {
     key0: 'k3.local.pIZT8-9Fa6U_QtfQHOSStfGtmyzPINyKQq2Xk-hd7vA'

package/features/streams.feature

@@ -10,6 +10,7 @@ Feature: Reply streams
     When the following request is received:
       """
       POST /sequences/ HTTP/1.1
+      host: nex.toa.io
       content-type: text/plain
       accept: text/plain
 

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
@@ -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
@@ -56,6 +58,7 @@ Feature: Server timing
     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

package/features/vary.feature

@@ -15,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>
       """
@@ -54,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
       """
@@ -78,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
       """
@@ -104,6 +107,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
       """
@@ -134,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>
         """
@@ -165,6 +170,7 @@ Feature: The Vary directive family
     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:
@@ -193,6 +199,7 @@ Feature: The Vary directive family
     When the following request is received:
         """
         OPTIONS / HTTP/1.1
+      host: nex.toa.io
         origin: https://example.com
         access-control-request-headers: whatever
         """
@@ -201,3 +208,45 @@ Feature: The Vary directive family
         204 No Content
         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.21",
+  "version": "1.0.0-alpha.22",
   "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.21",
-    "@toa.io/generic": "1.0.0-alpha.21",
-    "@toa.io/schemas": "1.0.0-alpha.21",
+    "@toa.io/core": "1.0.0-alpha.22",
+    "@toa.io/generic": "1.0.0-alpha.22",
+    "@toa.io/schemas": "1.0.0-alpha.22",
     "bcryptjs": "2.4.3",
     "error-value": "0.3.0",
     "js-yaml": "4.1.0",
@@ -45,11 +45,11 @@
     "features:security": "cucumber-js --tags @security"
   },
   "devDependencies": {
-    "@toa.io/agent": "1.0.0-alpha.21",
-    "@toa.io/extensions.storages": "1.0.0-alpha.21",
+    "@toa.io/agent": "1.0.0-alpha.22",
+    "@toa.io/extensions.storages": "1.0.0-alpha.22",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
     "@types/negotiator": "0.6.1"
   },
-  "gitHead": "da9f4c278f6ab02a28f65c6e25c713c013cbfce9"
+  "gitHead": "5bc67b81c4c5fbf92db037c805fba84a571ed24b"
 }

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

@@ -28,7 +28,7 @@ export class Endpoint implements RTD.Endpoint {
     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 = {}
 

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 { EndpointsFactory } from './Endpoint'
 import { families, interceptors } from './directives'
 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,12 @@ 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'
-    const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL)
-
-    const server = Server.create({
-      methods: syntax.verbs,
-      debug,
-      trace
-    })
+    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 = http.Server.create({ ...options, methods: syntax.verbs })
     const remotes = new Remotes(this.boot)
     const node = root.resolve()
     const methods = new EndpointsFactory(remotes)

package/source/Gateway.ts

@@ -33,10 +33,7 @@ export class Gateway extends Connector {
     if (match === null)
       throw new http.NotFound('Route not found')
 
-    const {
-      node,
-      parameters
-    } = match
+    const { node, parameters } = match
 
     if (!(context.request.method in node.methods))
       throw new http.MethodNotAllowed()
@@ -65,8 +62,7 @@ export class Gateway extends Connector {
     console.info('Gateway is closed.')
   }
 
-  private async call (method: Method, context: http.Context, parameters: Parameter[]):
-  Promise<http.OutgoingMessage> {
+  private async call (method: Method, context: http.Context, parameters: Parameter[]): Promise<http.OutgoingMessage> {
     if (context.url.pathname[context.url.pathname.length - 1] !== '/')
       throw new http.NotFound('Trailing slash is required.')