@toa.io/extensions.exposition 1.0.0-alpha.11 → 1.0.0-alpha.110

package/features/timestamps.feature

@@ -0,0 +1,41 @@
+Feature: Entity timestamp
+
+  Scenario: Last-Modified
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          POST: create
+          /:id:
+            GET: observe
+            PUT: transit
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      last-modified: #{{ utc | set created }}
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      HEAD /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      last-modified: ${{ created }}
+      content-length: 149
+      """

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
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "1.0.0-alpha.11",
+  "version": "1.0.0-alpha.110",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -17,37 +17,49 @@
     "access": "public"
   },
   "dependencies": {
-    "@toa.io/core": "1.0.0-alpha.11",
-    "@toa.io/generic": "1.0.0-alpha.11",
-    "@toa.io/schemas": "1.0.0-alpha.11",
+    "@isaacs/ttlcache": "1.4.1",
+    "@toa.io/core": "1.0.0-alpha.110",
+    "@toa.io/generic": "1.0.0-alpha.93",
+    "@toa.io/schemas": "1.0.0-alpha.93",
     "bcryptjs": "2.4.3",
-    "error-value": "0.3.0",
+    "error-value": "0.4.1",
+    "http-cache-semantics": "4.1.1",
     "js-yaml": "4.1.0",
+    "lru-cache": "11.0.1",
     "matchacho": "0.3.5",
+    "minimatch": "10.0.1",
     "msgpackr": "1.10.1",
     "negotiator": "0.6.3",
+    "openspan": "1.0.0-alpha.93",
     "paseto": "3.1.4"
   },
   "jest": {
-    "preset": "ts-jest",
+    "transform": {
+      "^.+\\.ts$": "jest-esbuild"
+    },
     "testEnvironment": "node"
   },
   "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 && npm run transpile:keys",
+    "transpile:bans": "tsc -p ./components/identity.bans",
     "transpile:basic": "tsc -p ./components/identity.basic",
     "transpile:tokens": "tsc -p ./components/identity.tokens",
     "transpile:roles": "tsc -p ./components/identity.roles",
-    "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",
-    "features": "cucumber-js"
+    "transpile:keys": "tsc -p ./components/identity.keys",
+    "features": "cucumber-js",
+    "features:security": "cucumber-js --tags @security",
+    "features:octets": "cucumber-js features/octets.*"
   },
   "devDependencies": {
-    "@toa.io/agent": "1.0.0-alpha.11",
-    "@toa.io/extensions.storages": "1.0.0-alpha.11",
+    "@toa.io/agent": "1.0.0-alpha.107",
+    "@toa.io/extensions.storages": "1.0.0-alpha.106",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
-    "@types/negotiator": "0.6.1"
+    "@types/http-cache-semantics": "4.0.4",
+    "@types/negotiator": "0.6.1",
+    "jest-esbuild": "0.3.0"
   },
-  "gitHead": "e343ac81eef12957cfa5e520119b1276b8ec0ad2"
+  "gitHead": "579e0243a9e783d9492c3616d6279f64862305c7"
 }

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

@@ -1,4 +1,4 @@
-verb: /^(GET|POST|PUT|PATCH|DELETE)$/
+verb: /^(GET|HEAD|POST|PUT|PATCH|DELETE|LOCK|UNLOCK)$/
 mapping:
   namespace: string
   component: string

package/schemas/node.cos.yaml

@@ -1,5 +1,7 @@
 protected: boolean
 isolated: boolean
+forward: string
 routes: [ref:route]
 methods: [ref:method]
 directives: [ref:directive]
+version: string

package/schemas/octets/put.cos.yaml

@@ -0,0 +1,25 @@
+type: object
+nullable: true
+properties:
+  accept:
+    anyOf:
+      - type: string
+      - type: array
+        items:
+          type: string
+  limit:
+    type: string
+    pattern: ^(\d+(\.\d+)?)([kmgtKMBGT]i?)?[bB]?$
+  trust:
+    type: array
+    items:
+      type: string
+  workflow:
+    anyOf:
+      - &unit
+        type: object
+        patternProperties:
+          ^.+$:
+            type: string
+      - type: array
+        items: *unit

package/schemas/query.cos.yaml

@@ -1,17 +1,11 @@
-_: true
 id?: string
 criteria?: string
 sort?: string
-omit:
+omit?:
   $ref: range
-  default:
-    value: 0
-    range: [0, 1000]
-limit:
+limit?:
   $ref: range
-  default:
-    value: 10
-    range: [1, 1000]
-  required: [value]
 selectors?: [string]
 projection?: [string]
+parameters?: [string]
+_: true

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

@@ -5,4 +5,5 @@ export interface Branch {
   component: string
   isolated: boolean
   node: RTD.Node
+  version: string
 }

package/source/Composition.ts

@@ -18,12 +18,6 @@ export class Composition extends Connector {
     await composition.connect()
 
     this.depends(composition)
-
-    console.info('Composition complete.')
-  }
-
-  protected override dispose (): void {
-    console.info('Composition shutdown complete.')
   }
 }
 

package/source/Context.ts

@@ -5,4 +5,5 @@ export type Context = RTD.Context<Extension>
 interface Extension {
   namespace: string
   component: string
+  version: string
 }

package/source/Directive.test.ts

@@ -65,7 +65,7 @@ it('should throw error if directive family is not found', async () => {
   }
 
   expect(() => factory.create([declaration]))
-    .toThrowError(`Directive family '${declaration.family}' is not found.`)
+    .toThrowError(`Directive family '${declaration.family}' is not found`)
 })
 
 it('should apply directive', async () => {

package/source/Directive.ts

@@ -17,11 +17,8 @@ export class Directives implements RTD.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
@@ -61,7 +58,7 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
       const family = this.families[declaration.family]
 
       if (family === undefined)
-        throw new Error(`Directive family '${declaration.family}' is not found.`)
+        throw new Error(`Directive family '${declaration.family}' is not found`)
 
       const directive = family.create(declaration.name, declaration.value, this.remotes)
 
@@ -90,8 +87,12 @@ export class DirectivesFactory implements RTD.DirectiveFactory {
 
 export const shortcuts: RTD.syntax.Shortcuts = new Map([
   ['anonymous', 'auth:anonymous'],
+  ['anyone', 'auth:anyone'],
   ['id', 'auth:id'],
   ['role', 'auth:role'],
   ['rule', 'auth:rule'],
-  ['incept', 'auth:incept']
+  ['incept', 'auth:incept'],
+  ['input', 'io:input'],
+  ['output', 'io:output'],
+  ['languages', 'map:languages']
 ])

package/source/Endpoint.ts

@@ -1,37 +1,45 @@
-import { type Component } from '@toa.io/core'
-import { type Remotes } from './Remotes'
+import { console } from 'openspan'
 import { Mapping } from './Mapping'
-import { type Context } from './Context'
 import * as http from './HTTP'
+import type { Introspection, Schema } from './Introspection'
+import type { Remote } from '@toa.io/core'
+import type { Remotes } from './Remotes'
+import type { Context } from './Context'
 import type * as RTD from './RTD'
 
 export class Endpoint implements RTD.Endpoint {
   private readonly endpoint: string
   private readonly mapping: Mapping
-  private readonly discovery: Promise<Component>
-  private remote: Component | null = null
+  private readonly discovery: Promise<Remote>
+  private remote: Remote | null = null
 
-  public constructor (endpoint: string, mapping: Mapping, discovery: Promise<Component>) {
+  public constructor (endpoint: string, mapping: Mapping, discovery: Promise<Remote>) {
     this.endpoint = endpoint
     this.mapping = mapping
     this.discovery = discovery
   }
 
-  public async call
-  (context: http.Context, 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('Calling operation', {
+        endpoint: 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 = {}
 
+    // etag
     if (typeof reply === 'object' && reply !== null && '_version' in reply) {
       const etag = context.request.headers['if-none-match']
 
@@ -46,11 +54,55 @@ export class Endpoint implements RTD.Endpoint {
         message.headers.set('etag', `"${reply._version.toString()}"`)
     }
 
+    // last-modified
+    if (typeof reply === 'object' && reply !== null && ('_updated' in reply || '_created' in reply)) {
+      const timestamp = reply._updated ?? reply._created
+      const date = new Date(timestamp)
+
+      message.headers ??= new Headers()
+      message.headers.set('last-modified', date.toUTCString())
+    }
+
     message.body = reply
 
     return message
   }
 
+  public async explain (parameters: RTD.Parameter[]): Promise<Introspection> {
+    this.remote ??= await this.discovery
+
+    // eslint-disable-next-line @typescript-eslint/await-thenable
+    const operation = await this.remote.explain(this.endpoint)
+
+    let route: Record<string, Schema> | null = null
+
+    if (operation.input?.type === 'object')
+      for (const parameter of parameters) {
+        const schema = operation.input.properties[parameter.name]
+
+        // eslint-disable-next-line max-depth
+        if (schema !== undefined) {
+          route ??= {}
+          route[parameter.name] = schema
+
+          delete operation.input.properties[parameter.name]
+        }
+      }
+
+    const query = this.mapping.explain(operation)
+    const introspection: Introspection = {}
+
+    if (route !== null)
+      introspection.route = route
+
+    if (query !== null)
+      introspection.query = query
+
+    Object.assign(introspection, operation)
+
+    return introspection
+  }
+
   public async close (): Promise<void> {
     this.remote ??= await this.discovery
 
@@ -61,7 +113,7 @@ export class Endpoint implements RTD.Endpoint {
     const query: http.Query = Object.fromEntries(context.url.searchParams)
     const etag = context.request.headers['if-match']
 
-    if (etag !== undefined)
+    if (etag !== undefined && this.mapping.queryable)
       query.version = this.version(etag)
 
     return query
@@ -71,7 +123,7 @@ export class Endpoint implements RTD.Endpoint {
     const match = etag.match(ETAG)
 
     if (match === null)
-      throw new http.BadRequest('Invalid ETag.')
+      throw new http.BadRequest('Invalid ETag')
 
     return Number.parseInt(match.groups!.version)
   }
@@ -86,21 +138,21 @@ export class EndpointsFactory implements RTD.EndpointsFactory {
 
   public create (method: RTD.syntax.Method, context: Context): Endpoint {
     if (method.mapping === undefined)
-      throw new Error('Cannot create Endpoint without mapping.')
+      throw new Error('Cannot create Endpoint without mapping')
 
     const mapping = Mapping.create(method.mapping.query)
-    const namespace = method.mapping.namespace ?? context.extension?.namespace
-    const component = method.mapping.component ?? context.extension?.component
+    const namespace = method.mapping.namespace ?? context.extension.namespace
+    const component = method.mapping.component ?? context.extension.component
 
     if (namespace === undefined || component === undefined)
-      throw new Error('Annotation endpoints must be fully qualified.')
+      throw new Error('Annotation endpoints must be fully qualified')
 
-    const discovery = this.remotes.discover(namespace, component)
+    const discovery = this.remotes.discover(namespace, component, context.extension.version)
 
     return new Endpoint(method.mapping.endpoint, mapping, discovery)
   }
 }
 
-const ETAG = /^"(?<version>\d{1,32})"$/
+const ETAG = /^(W\/)?"(?<version>\d{1,32})"$/
 
 const INTERRUPT = true

package/source/Factory.ts

@@ -1,14 +1,19 @@
+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 { Tree } from './RTD'
 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 { Manifest } from '@toa.io/norm'
+import type { Branch } from './Branch'
+import type { syntax } from './RTD'
 import type { Broadcast } from './Gateway'
 import type { Connector, Locator, extensions } from '@toa.io/core'
 
@@ -19,23 +24,27 @@ export class Factory implements extensions.Factory {
     this.boot = boot
   }
 
-  public tenant (locator: Locator, node: syntax.Node): Connector {
+  public tenant (locator: Locator, node: syntax.Node, manifest: Manifest): Connector {
     const broadcast: Broadcast = this.boot.bindings.broadcast(CHANNEL, locator.id)
 
-    return new Tenant(broadcast, locator, node)
+    const branch: Branch = {
+      namespace: locator.namespace,
+      component: locator.name,
+      isolated: locator.namespace === 'identity',
+      node,
+      version: manifest.version
+    }
+
+    return new Tenant(broadcast, branch)
   }
 
   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 })
     const remotes = new Remotes(this.boot)
     const node = root.resolve()
     const methods = new EndpointsFactory(remotes)