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

package/features/steps/IdP.ts

@@ -0,0 +1,149 @@
+import { once } from 'node:events'
+import * as crypto from 'node:crypto'
+import * as http from 'node:http'
+import * as assert from 'node:assert'
+import * as util from 'node:util'
+import { binding, given, afterAll } from 'cucumber-tsflow'
+import { Captures } from './Captures'
+
+import type { AddressInfo } from 'node:net'
+
+@binding([Captures])
+export class IdP {
+  private static server?: http.Server
+  private static privateKey?: crypto.KeyObject
+  private static issuer?: string
+
+  public constructor (private readonly captures: Captures) {}
+
+  @afterAll()
+  public static async stop (): Promise<void> {
+    if (this.server instanceof http.Server) {
+      this.server.close()
+      await once(this.server, 'close')
+    }
+  }
+
+  @given(/local IDP is running/i)
+  public async start (): Promise<void> {
+    if (IdP.server instanceof http.Server) return
+
+    // creating the key
+    const { publicKey, privateKey } = await util.promisify(crypto.generateKeyPair)('rsa', {
+      modulusLength: 2048
+    })
+
+    IdP.privateKey = privateKey
+
+    const jwk = JSON.stringify({
+      keys: [{ use: 'sig', alg: 'RS256', ...publicKey.export({ format: 'jwk' }) }]
+    })
+
+    const JWK_URL = '/.well-known/jwks'
+
+    const server = http.createServer((request, response) => {
+      switch (request.url) {
+        case JWK_URL:
+          response.writeHead(200, {
+            'Content-Type': 'application/json',
+            'Content-Length': jwk.length,
+            'Cache-Control': 'no-cache, no-store, must-revalidate',
+            Pragma: 'no-cache',
+            Expires: '0'
+          })
+          response.end(jwk)
+          break
+
+        case '/.well-known/openid-configuration':
+          {
+            const openIdConfiguration = JSON.stringify({
+              issuer: IdP.issuer,
+              jwks_uri: IdP.issuer + JWK_URL,
+              response_types_supported: ['id_token'],
+              subject_types_supported: ['public'],
+              id_token_signing_alg_values_supported: ['RS256'],
+              scopes_supported: ['openid']
+            })
+
+            response.writeHead(200, {
+              'Content-Type': 'application/json',
+              'Cache-Control': 'public, max-age=3600',
+              'Content-Length': openIdConfiguration.length
+            })
+            response.end(openIdConfiguration)
+          }
+
+          break
+
+        default:
+          response.writeHead(404, 'Not found')
+          response.end()
+      }
+    })
+
+    server.listen(44444, 'localhost')
+    await once(server, 'listening')
+
+    const address = server.address() as AddressInfo
+
+    console.log('IdP is listening on %s:%s', address.address, address.port)
+    IdP.server = server
+    IdP.issuer = `http://localhost:${address.port}`
+  }
+
+  @given('the IDP token for {word} is issued')
+  public async issueToken (user: string): Promise<void> {
+    assert.ok(IdP.privateKey, 'IdP private key is not available')
+
+    const jwt = [
+      {
+        typ: 'JWT',
+        alg: 'RS256'
+      },
+      {
+        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.createSign('RSA-SHA256').end(jwt).sign(IdP.privateKey, 'base64url')
+
+    const idToken = `${jwt}.${signature}`
+
+    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/Parameters.ts

@@ -1,4 +1,5 @@
 import { setDefaultTimeout } from '@cucumber/cucumber'
+import { encode } from '@toa.io/generic'
 
 export class Parameters {
   public readonly origin: string
@@ -9,7 +10,12 @@ export class Parameters {
 }
 
 setDefaultTimeout(30 * 1000)
+
 process.env.TOA_DEV = '1'
 
-// { octets: tmp:///exposition-octets }
-process.env.TOA_STORAGES = '3gABpm9jdGV0c7h0bXA6Ly8vZXhwb3NpdGlvbi1vY3RldHM='
+process.env.TOA_STORAGES = encode({
+  octets: {
+    provider: 'tmp',
+    directory: 'exposition'
+  }
+})

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

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

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/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
 
@@ -9,7 +10,10 @@ operations:
       storage*: string
       path*: string
       entry: object
+      parameters: object
   bar: *operation
   baz: *operation
   err: *operation
+  echo: *operation
+  concat: *operation
   diversify: *operation

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/pots/manifest.toa.yaml

@@ -1,4 +1,5 @@
 name: pots
+version: 0.0.0
 
 entity:
   schema:
@@ -7,11 +8,19 @@ entity:
     temperature?: number
 
 operations:
-  transit:
+  create:
     query: false
+    forward: transit
+    input:
+      title*: .
+      volume*: .
+      temperature: .
+  transit:
+    concurrency: retry
     input:
-      title*: ~
-      volume*: ~
+      title: .
+      volume: .
+      temperature: .
   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/steps/components/users/manifest.toa.yaml

@@ -1,4 +1,5 @@
 name: users
+version: 0.0.0
 
 entity:
   schema:
@@ -9,3 +10,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
+  dependent: 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/timing.feature

@@ -0,0 +1,66 @@
+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:
+      """
+
+  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
+      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

@@ -0,0 +1,180 @@
+Feature: The Vary directive family
+
+  Scenario Outline: Embedding a `<result>` language code
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          vary:languages: [en, fr]
+          GET:
+            vary:embed:
+              name: language  # embed resolved language code as a `name` property of the operation input
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      accept: application/yaml
+      accept-language: <accept>
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      content-language: <result>
+      vary: accept-language, accept
+
+      Hello <result>
+      """
+    Examples:
+      | accept | result |
+      | en     | en     |
+      | en_US  | en     |
+      | fr     | fr     |
+      | sw     | en     |
+
+  Scenario: Listing languages on the root
+    Given the annotation:
+    """
+    /:
+      vary:languages: [en, fr]
+    """
+    And the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET:
+            anonymous: true
+            vary:embed:
+              name: language
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      accept: application/yaml
+      accept-language: fr
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      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
+            endpoint: compute
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      accept: application/yaml
+      foo: bar
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      vary: foo, accept
+
+      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
+      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:
+                name:
+                  - :foo
+                  - :bar
+                  - language
+              endpoint: compute
+        """
+    When the following request is received:
+        """
+        GET /echo/ HTTP/1.1
+        accept: application/yaml
+        <header>: <value>
+        """
+    Then the following reply is sent:
+        """
+        200 OK
+        content-type: application/yaml
+        vary: <header>, accept
+
+        Hello <value>
+        """
+    Examples:
+      | header          | value |
+      | foo             | bar   |
+      | bar             | baz   |
+      | accept-language | en    |
+
+  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:
+                name:
+                  - language
+                  - :foo
+                  - :FOO
+                  - :bar
+              endpoint: compute
+        """
+    When the following request is received:
+        """
+        OPTIONS / HTTP/1.1
+        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, etag, if-match, if-none-match, accept-language, foo, bar
+        """

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.11",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -17,18 +17,14 @@
     "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",
+    "@toa.io/core": "1.0.0-alpha.11",
+    "@toa.io/generic": "1.0.0-alpha.11",
+    "@toa.io/schemas": "1.0.0-alpha.11",
     "bcryptjs": "2.4.3",
-    "cors": "2.8.5",
     "error-value": "0.3.0",
-    "express": "4.18.2",
     "js-yaml": "4.1.0",
     "matchacho": "0.3.5",
-    "msgpackr": "1.9.5",
+    "msgpackr": "1.10.1",
     "negotiator": "0.6.3",
     "paseto": "3.1.4"
   },
@@ -38,20 +34,20 @@
   },
   "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:basic && npm run transpile:tokens && npm run transpile:roles && npm run transpile:federation",
+    "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"
   },
   "devDependencies": {
-    "@toa.io/extensions.storages": "1.0.0-alpha.0",
+    "@toa.io/agent": "1.0.0-alpha.11",
+    "@toa.io/extensions.storages": "1.0.0-alpha.11",
     "@types/bcryptjs": "2.4.3",
     "@types/cors": "2.8.13",
-    "@types/express": "4.17.17",
-    "@types/fs-extra": "11.0.4",
-    "@types/negotiator": "0.6.1",
-    "fs-extra": "11.1.1"
+    "@types/negotiator": "0.6.1"
   },
-  "gitHead": "06c64546f6292cc07c52f74b31415101037f7616"
+  "gitHead": "e343ac81eef12957cfa5e520119b1276b8ec0ad2"
 }

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
 /: ~