@toa.io/extensions.exposition 1.0.0-alpha.7 → 1.0.0-alpha.71

package/features/steps/IdP.ts

@@ -14,7 +14,8 @@ export class IdP {
   private static privateKey?: crypto.KeyObject
   private static issuer?: string
 
-  public constructor (private readonly captures: Captures) {}
+  public constructor (private readonly captures: Captures) {
+  }
 
   @afterAll()
   public static async stop (): Promise<void> {
@@ -29,14 +30,21 @@ export class IdP {
     if (IdP.server instanceof http.Server) return
 
     // creating the key
-    const { publicKey, privateKey } = await util.promisify(crypto.generateKeyPair)('rsa', {
+    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' }) }]
+      keys: [{
+        use: 'sig',
+        alg: 'RS256',
+        ...publicKey.export({ format: 'jwk' })
+      }]
     })
 
     const JWK_URL = '/.well-known/jwks'
@@ -54,24 +62,23 @@ export class IdP {
           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)
-          }
+        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
 
@@ -102,7 +109,7 @@ export class IdP {
       },
       {
         iss: IdP.issuer,
-        sub: `${user}-mock-id`,
+        sub: user,
         aud: 'test',
         iat: Math.floor(Date.now() / 1000),
         exp: Math.floor((Date.now() + 1000 * 60 * 5) / 1000)
@@ -120,8 +127,6 @@ export class IdP {
 
   @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',
@@ -129,7 +134,7 @@ export class IdP {
       },
       {
         iss: IdP.issuer,
-        sub: `${user}-mock-id`,
+        sub: user,
         aud: 'test',
         iat: Math.floor(Date.now() / 1000),
         exp: Math.floor((Date.now() + 1000 * 60 * 5) / 1000)

package/features/steps/Parameters.ts

@@ -1,5 +1,6 @@
 import { setDefaultTimeout } from '@cucumber/cucumber'
 import { encode } from '@toa.io/generic'
+import { console } from 'openspan'
 
 export class Parameters {
   public readonly origin: string
@@ -11,11 +12,13 @@ export class Parameters {
 
 setDefaultTimeout(30 * 1000)
 
+console.configure({ format: 'terminal' })
+
 process.env.TOA_DEV = '1'
 
 process.env.TOA_STORAGES = encode({
   octets: {
     provider: 'tmp',
-    directory: 'exposition'
+    directory: Math.random().toString(36).substring(2)
   }
 })

package/features/steps/Realtime.ts

@@ -0,0 +1,151 @@
+import { EventEmitter, once } from 'node:events'
+import * as assert from 'node:assert'
+import { after, binding, given, afterAll, then } from 'cucumber-tsflow'
+import { Factory } from '@toa.io/extensions.realtime'
+import * as boot from '@toa.io/boot'
+import { encode, match } from '@toa.io/generic'
+import { parse } from '@toa.io/yaml'
+import { Agent } from '@toa.io/agent'
+import { Parameters } from './Parameters'
+import { Gateway } from './Gateway'
+import { Captures } from './Captures'
+import type { Connector } from '@toa.io/core'
+
+@binding([Gateway, Parameters, Captures])
+export class Realtime {
+  private static instance: Connector | null = null
+  private readonly gateway: Gateway
+  private readonly agent: Agent
+  private readonly events = new EventEmitter()
+  private log: Record<string, unknown[]> = {}
+  private aborted = false
+
+  public constructor (gateway: Gateway, parameters: Parameters, captures: Captures) {
+    this.gateway = gateway
+    this.agent = new Agent(parameters.origin, captures)
+  }
+
+  @given('the Realtime is running with the following annotation:')
+  public async start (yaml: string): Promise<void> {
+    await Realtime.stop()
+
+    const annotation = parse(yaml)
+    const routes = []
+
+    for (const [event, property] of Object.entries(annotation))
+      routes.push({ event, properties: [property] })
+
+    process.env.TOA_REALTIME = encode(routes)
+
+    const factory = new Factory(boot)
+
+    Realtime.instance = factory.service()
+
+    void Realtime.instance.connect()
+  }
+
+  @given('the identity {word} is consuming realtime events')
+  public async connect (name: string): Promise<void> {
+    await this.gateway.start()
+
+    const id = await this.createIdentity(name)
+
+    const parts = await this.agent.parts(`
+      GET /realtime/streams/\${{ ${name}.id }}/ HTTP/1.1
+      authorization: Token \${{ ${name}.token }}
+      accept: application/json
+    `) as AsyncIterable<Uint8Array>
+
+    void this.consume(id, parts).catch((e) => {
+      if (!this.aborted)
+        console.debug('Consumption interrupted', e)
+    })
+  }
+
+  @then('the following event `{word}` is received by {word}:')
+  public async received (label: string, name: string, yaml: string): Promise<void> {
+    const id = this.agent.captures.get(`${name}.id`)
+    const tag = `${id}:${label}`
+    const expected = parse(yaml)
+
+    if (this.log[tag] !== undefined)
+      for (const data of this.log[tag])
+        // eslint-disable-next-line max-depth
+        if (match(data, expected))
+          return
+
+    const [event] = await once(this.events, tag)
+
+    assert.ok(match(event, expected), 'Event does not match')
+  }
+
+  @after()
+  public abort (): void {
+    this.aborted = true
+    this.agent.abort()
+    this.log = {}
+    this.events.removeAllListeners()
+  }
+
+  @afterAll()
+  public static async stop (): Promise<void> {
+    if (this.instance === null)
+      return
+
+    await this.instance.disconnect()
+
+    this.instance = null
+    process.env.TOA_REALTIME = undefined
+  }
+
+  private async createIdentity (name: string): Promise<string> {
+    const password = Math.random().toString(36).slice(2)
+    const username = name + Math.random().toString(36).slice(2)
+
+    await this.agent.request(`
+      POST /identity/basic/ HTTP/1.1
+      accept: application/yaml
+      content-type: application/yaml
+
+      username: ${username}
+      password: ${password}
+    `)
+
+    this.agent.responseIncludes(`
+      201 Created
+    `)
+
+    const credentials = Buffer.from(`${username}:${password}`).toString('base64')
+
+    await this.agent.request(`
+      GET /identity/ HTTP/1.1
+      authorization: Basic ${credentials}
+      accept: application/yaml
+    `)
+
+    this.agent.responseIncludes(`
+      200 OK
+      authorization: Token \${{ ${name}.token }}
+
+      id: \${{ ${name}.id }}
+    `)
+
+    return this.agent.captures.get(`${name}.id`)
+  }
+
+  private async consume (id: string, parts: any): Promise<void> {
+    for await (const part of parts) {
+      const text = Buffer.from(part.body).toString('utf8')
+      const event = JSON.parse(text)
+
+      if (typeof event === 'string')
+        continue
+
+      const tag = `${id}:${event.event}`
+
+      this.events.emit(tag, event.data)
+      this.log[tag] ??= []
+      this.log[tag].push(event.data)
+    }
+  }
+}

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

@@ -1,5 +1,4 @@
 name: echo
-version: 0.0.0
 
 operations:
   compute:
@@ -8,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/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/octets.tester/manifest.toa.yaml

@@ -7,9 +7,10 @@ storages: octets
 operations:
   foo: &operation
     input:
+      authority*: string
       storage*: string
       path*: string
-      entry: object
+      entry*: object
       parameters: object
   bar: *operation
   baz: *operation
@@ -17,3 +18,23 @@ operations:
   echo: *operation
   concat: *operation
   diversify: *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/baz.js

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

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

@@ -8,7 +8,9 @@ const lenna = join(__dirname, 'lenna.png')
 async function diversify (input, context) {
   const stream = createReadStream(lenna)
 
-  return context.storages[input.storage].diversify(input.path, 'hello.png', stream)
+  await context.storages[input.storage].diversify(input.path, 'hello.png', stream)
+
+  return 'hello'
 }
 
 exports.effect = diversify

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

@@ -1,7 +1,7 @@
 'use strict'
 
-function foo (input, context) {
-  return context.storages.octets.annotate(input.path, 'foo', 'bar')
+async function foo (input, context) {
+  await context.storages.octets.annotate(input.path, 'foo', 'bar')
 }
 
 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

@@ -3,9 +3,9 @@ version: 0.0.0
 
 entity:
   schema:
-    title: string
-    volume: number
-    temperature?: number
+    title: string(64)
+    volume: number(0, 1000]
+    temperature?: number(0, 300]
 
 operations:
   create:
@@ -15,6 +15,11 @@ operations:
       title*: .
       volume*: .
       temperature: .
+    output:
+      id: .
+    errors:
+      - NO_WAY
+      - WONT_CREATE
   transit:
     concurrency: retry
     input:
@@ -27,3 +32,9 @@ operations:
       title: string
       volume: number
       temperature: number
+  enumerate:
+    output:
+      - id: .
+        title: .
+        volume: .
+        temperature?: .

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

@@ -1,5 +1,4 @@
 name: users
-version: 0.0.0
 
 entity:
   schema:

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

@@ -5,7 +5,7 @@ version: 0.0.0
 entity:
   schema:
     newbie: false
-  dependent: true
+  associated: true
 
 operations:
   transit:

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

@@ -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/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>
         """
@@ -151,6 +156,30 @@ 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
@@ -170,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
         """
@@ -178,3 +208,44 @@ 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
+      """
+    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 the.two.com
+      """