@toa.io/extensions.exposition 1.0.0-alpha.0 → 1.0.0-alpha.100

package/features/steps/Workspace.ts

@@ -1,17 +1,17 @@
 import { join } from 'node:path'
-import { tmpdir } from 'node:os'
-import { mkdtemp, copy } from 'fs-extra'
+import { tmpdir, devNull } from 'node:os'
+import { mkdtemp, cp } from 'node:fs/promises'
 import * as yaml from '@toa.io/yaml'
 
 export class Workspace {
-  private root: string = devnull
+  private root: string = devNull
 
   public static exists
   (_0: unknown, _1: unknown, descriptor: PropertyDescriptor): PropertyDescriptor {
     const method = descriptor.value
 
     descriptor.value = async function (this: Workspace, ...args: any[]): Promise<any> {
-      if (this.root === devnull) this.root =
+      if (this.root === devNull) this.root =
         await mkdtemp(join(tmpdir(), Math.random().toString(36).slice(2)))
 
       return method.apply(this, args)
@@ -25,7 +25,7 @@ export class Workspace {
     const source = join(__dirname, 'components', name)
     const target = join(this.root, name)
 
-    await copy(source, target)
+    await cp(source, target, { force: true, recursive: true })
 
     if (patch !== undefined)
       await this.patchManifest(target, patch)
@@ -39,5 +39,3 @@ export class Workspace {
     await yaml.patch(path, patch)
   }
 }
-
-const devnull = '/dev/null'

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

@@ -7,3 +7,17 @@ operations:
   affect:
     input:
       name*: string
+  identity:
+    input:
+      identity:
+        id: string
+        roles: [string]
+  parameters:
+    input: &parameters
+      type: object
+      properties:
+        a:
+          type: string
+        b:
+          type: string
+    output: *parameters

package/features/steps/components/echo/operations/error.js

@@ -0,0 +1,11 @@
+'use strict'
+
+function computation () {
+  const err = { code: 'CODE', message: 'message' }
+
+  Object.setPrototypeOf(err, Error.prototype)
+
+  return err
+}
+
+exports.computation = computation

package/features/steps/components/echo/operations/identity.js

@@ -0,0 +1,7 @@
+'use strict'
+
+function computation (input) {
+  return input
+}
+
+exports.computation = computation

package/features/steps/components/echo/operations/parameters.js

@@ -0,0 +1,7 @@
+'use strict'
+
+function computation (input) {
+  return input
+}
+
+exports.computation = computation

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

@@ -0,0 +1,2 @@
+namespace: echo
+name: beacon

package/features/steps/components/echo.beacon/operations/hello.js

@@ -0,0 +1,5 @@
+'use strict'
+
+exports.computation = () => {
+  return 'Hello!'
+}

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,15 +1,39 @@
 namespace: octets
 name: tester
+version: 0.0.0
 
 storages: octets
 
 operations:
   foo: &operation
     input:
+      authority*: string
       storage*: string
       path*: string
-      entry: object
+      entry*: object
+      parameters: object
   bar: *operation
   baz: *operation
   err: *operation
-  diversify: *operation
+  echo: *operation
+  concat: *operation
+  yield: *operation
+  yex: *operation
+  authority: *operation
+  redirect:
+    input:
+      authority*: string
+      path*: string
+      parameters: <string>
+    output:
+      type: object
+      properties:
+        url: string
+        options:
+          type: object
+          properties:
+            method: string
+            headers: object
+            body: string
+      required:
+        - url

package/features/steps/components/octets.tester/operations/authority.js

@@ -0,0 +1,7 @@
+'use strict'
+
+function computation (input) {
+  return input.authority
+}
+
+exports.computation = computation

package/features/steps/components/octets.tester/operations/bar.js

@@ -4,7 +4,6 @@ import { setTimeout } from 'node:timers/promises'
 
 async function bar (input, context) {
   await setTimeout(10)
-  await context.storages.octets.annotate(input.path, 'bar', 'baz')
 
   return { bar: 'baz' }
 }

package/features/steps/components/octets.tester/operations/baz.js

@@ -4,8 +4,6 @@ import { setTimeout } from 'node:timers/promises'
 
 async function baz (input, context) {
   await setTimeout(30)
-
-  return context.storages.octets.annotate(input.path, 'baz', 'qux')
 }
 
 exports.effect = baz

package/features/steps/components/octets.tester/operations/concat.js

@@ -0,0 +1,7 @@
+'use strict'
+
+function concat (input) {
+  return input.parameters.a + ' ' + input.parameters.b
+}
+
+exports.computation = concat

package/features/steps/components/octets.tester/operations/echo.js

@@ -0,0 +1,7 @@
+'use strict'
+
+function echo (input) {
+  return input.entry.id
+}
+
+exports.computation = echo

package/features/steps/components/octets.tester/operations/foo.js

@@ -1,7 +1,6 @@
 'use strict'
 
-function foo (input, context) {
-  return context.storages.octets.annotate(input.path, 'foo', 'bar')
+async function foo (input, context) {
 }
 
 exports.effect = foo

package/features/steps/components/octets.tester/operations/redirect.js

@@ -0,0 +1,12 @@
+'use strict'
+
+function redirect (input) {
+  return input.parameters.type in urls ? { url: urls[input.parameters.type] } : new Error()
+}
+
+const urls = {
+  'rfc': 'https://www.rfc-editor.org/rfc/rfc9564.txt',
+  'img': 'https://www.w3.org/assets/logos/w3c/w3c-no-bars.svg'
+}
+
+exports.computation = redirect

package/features/steps/components/octets.tester/operations/yex.js

@@ -0,0 +1,16 @@
+'use strict'
+
+import { setTimeout } from 'node:timers/promises'
+
+async function * effect (_) {
+  await setTimeout(10)
+  yield 'hello'
+
+  await setTimeout(10)
+  yield 'world'
+
+  await setTimeout(10)
+  throw new Error('Oops!')
+}
+
+exports.effect = effect

package/features/steps/components/octets.tester/operations/yield.js

@@ -0,0 +1,13 @@
+'use strict'
+
+import { setTimeout } from 'node:timers/promises'
+
+async function * effect (_) {
+  await setTimeout(10)
+  yield 'hello'
+
+  await setTimeout(10)
+  yield 'world'
+}
+
+exports.effect = effect

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

@@ -1,20 +1,40 @@
 name: pots
+version: 0.0.0
 
 entity:
   schema:
-    title: string
-    volume: number
-    temperature?: number
+    title: string(64)
+    volume: number(0, 1000]
+    temperature?: number(0, 300]
 
 operations:
-  transit:
+  create:
     query: false
+    forward: transit
     input:
-      title*: ~
-      volume*: ~
+      title*: .
+      volume*: .
+      temperature: .
+    output:
+      id: .
+    errors:
+      - NO_WAY
+      - WONT_CREATE
+  transit:
+    concurrency: retry
+    input:
+      title: .
+      volume: .
+      temperature: .
   observe:
     output:
       id: string
       title: string
       volume: number
       temperature: number
+  enumerate:
+    output:
+      - id: .
+        title: .
+        volume: .
+        temperature?: .

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

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

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

@@ -9,3 +9,6 @@ operations:
     concurrency: retry
     input:
       name*: ~
+  create:
+    query: false
+    forward: transit

package/features/steps/components/users.properties/manifest.toa.yaml

@@ -0,0 +1,14 @@
+namespace: users
+name: properties
+version: 0.0.0
+
+entity:
+  schema:
+    newbie: false
+  associated: true
+
+operations:
+  transit:
+    concurrency: retry
+    input:
+      newbie*: .

package/features/steps/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "target": "ESNext",
-    "outDir": "/dev/null",
+    "noEmit": true,
     "moduleResolution": "node",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true

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
 
@@ -20,11 +21,15 @@ Feature: Reply streams
       201 Created
       content-type: multipart/text; boundary=cut
 
+      --cut
+      ACK
       --cut
       0
       --cut
       1
       --cut
       2
+      --cut
+      FIN
       --cut--
       """

package/features/timing.feature

@@ -0,0 +1,69 @@
+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
+      host: nex.toa.io
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the reply does not contain:
+      """
+      server-timing:
+      """
+
+  Scenario: Server timing is sent when `trace` is enabled
+    Given the annotation:
+      """
+      trace: true
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      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:
+      """
+
+  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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.100",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -17,41 +17,46 @@
     "access": "public"
   },
   "dependencies": {
-    "@toa.io/core": "1.0.0-alpha.0",
-    "@toa.io/generic": "1.0.0-alpha.0",
-    "@toa.io/http": "1.0.0-alpha.0",
-    "@toa.io/schemas": "1.0.0-alpha.0",
-    "@toa.io/streams": "1.0.0-alpha.0",
+    "@isaacs/ttlcache": "1.4.1",
+    "@toa.io/core": "1.0.0-alpha.93",
+    "@toa.io/generic": "1.0.0-alpha.93",
+    "@toa.io/schemas": "1.0.0-alpha.93",
     "bcryptjs": "2.4.3",
-    "cors": "2.8.5",
     "error-value": "0.3.0",
-    "express": "4.18.2",
+    "http-cache-semantics": "4.1.1",
     "js-yaml": "4.1.0",
     "matchacho": "0.3.5",
-    "msgpackr": "1.9.5",
+    "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": "rm -rf transpiled && npx tsc && npm run transpile:basic && npm run transpile:tokens && npm run transpile:roles",
-    "transpile:basic": "rm -rf ./components/identity.basic/operations && npx tsc -p ./components/identity.basic",
-    "transpile:tokens": "rm -rf ./components/identity.tokens/operations && npx tsc -p ./components/identity.tokens",
-    "transpile:roles": "rm -rf ./components/identity.roles/operations && npx tsc -p ./components/identity.roles",
-    "features": "npx cucumber-js"
+    "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",
+    "transpile:tokens": "tsc -p ./components/identity.tokens",
+    "transpile:roles": "tsc -p ./components/identity.roles",
+    "transpile:federation": "tsc -p ./components/identity.federation",
+    "features": "cucumber-js",
+    "features:security": "cucumber-js --tags @security",
+    "features:octets": "cucumber-js features/octets.*"
   },
   "devDependencies": {
-    "@toa.io/extensions.storages": "1.0.0-alpha.0",
+    "@toa.io/agent": "1.0.0-alpha.97",
+    "@toa.io/extensions.storages": "1.0.0-alpha.94",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
-    "@types/express": "4.17.17",
-    "@types/fs-extra": "11.0.4",
+    "@types/http-cache-semantics": "4.0.4",
     "@types/negotiator": "0.6.1",
-    "fs-extra": "11.1.1"
+    "jest-esbuild": "0.3.0"
   },
-  "gitHead": "06c64546f6292cc07c52f74b31415101037f7616"
+  "gitHead": "b3f19f25d196753c111624c9226219d1bbe5f3a8"
 }

package/readme.md

@@ -20,7 +20,8 @@ exposition:
 # context.toa.yaml
 
 exposition:
-  host: api.example.com
+  authorities:
+    example: api.example.com
 ```
 
 ```http
@@ -117,32 +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`.                           |
+| 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:
@@ -161,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,5 +1,6 @@
-host: string
+authorities*: <string>
 class: string
 annotations: <string>
 debug: boolean
+trace: 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/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/delete.cos.yaml

@@ -1 +1,2 @@
-~
+workflow+: <string>
+_: true

package/schemas/octets/{fetch.cos.yaml → get.cos.yaml}

@@ -1,3 +1,2 @@
-blob: boolean
 meta: boolean
 _: true

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/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'