@toa.io/extensions.exposition 1.0.0-alpha.8 → 1.0.0-alpha.81

package/features/response.feature

@@ -7,11 +7,13 @@ Feature: Response
         io:output: true
         GET:
           anonymous: true
-          dev:stub: hello
+          dev:stub:
+            hello: world
       """
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: application/json
       """
     Then the following reply is sent:
@@ -19,6 +21,37 @@ Feature: Response
       200 OK
       content-type: application/json
       vary: accept
+
+      {"hello":"world"}
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+      vary: accept
+
+      hello: world
+      """
+
+    # default is JSON
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/json
+      vary: accept
+
+      {"hello":"world"}
       """
 
   Scenario: Error as YAML
@@ -32,11 +65,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
@@ -54,11 +88,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:
@@ -94,8 +99,7 @@ Feature: Routes
       """
 
   Scenario: Routes with naming conflicts
-    Given the Gateway is running
-    And the `users` is running with the following manifest:
+    Given the `users` is running with the following manifest:
       """yaml
       exposition:
         /:
@@ -112,6 +116,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 +128,7 @@ Feature: Routes
     When the following request is received:
       """
       POST /users/ HTTP/1.1
+      host: nex.toa.io
       content-type: application/yaml
 
       name: Alice
@@ -131,3 +137,88 @@ Feature: Routes
       """
       201 Created
       """
+
+  Scenario: Routes with default namespace conflicts
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:foo:
+          io:output: true
+          PUT: compute
+      """
+    And the `echo.beacon` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: hello
+      """
+    When the following request is received:
+      """
+      GET /echo/beacon/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+
+  Scenario: Routes with parameters
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:a/:b:
+          io:output: true
+          GET: parameters
+      """
+    When the following request is received:
+      """
+      GET /echo/foo/bar/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      a: foo
+      b: bar
+      """
+
+  Scenario: Route forwarding
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /show/:a/:b:
+          io:output: true
+          GET: parameters
+        /hello: /echo/show/foo/bar
+        /mirror/:a/:b: /echo/show/:a/:b
+      """
+    When the following request is received:
+      """
+      GET /echo/hello/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      a: foo
+      b: bar
+      """
+    When the following request is received:
+      """
+      GET /echo/mirror/bar/baz/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      a: bar
+      b: baz
+      """

package/features/steps/Database.ts

@@ -1,5 +1,6 @@
 import { afterAll, beforeAll, binding, given } from 'cucumber-tsflow'
 import { MongoClient } from 'mongodb'
+import type { Collection } from 'mongodb'
 import type { DataTable } from '@cucumber/cucumber'
 
 @binding()
@@ -8,9 +9,7 @@ export class Database {
 
   @given('the `{word}` database contains:')
   public async upsert (id: string, table: DataTable): Promise<void> {
-    const [name, namespace = 'default'] = id.split('.').reverse()
-    const collection = Database.client.db(namespace).collection(name)
-
+    const collection = this.collection(id)
     const columns = table.raw()[0]
     const rows = table.rows()
     const documents: Document[] = []
@@ -22,7 +21,11 @@ export class Database {
         const str = rows[r][c]
         const int = parseInt(str)
 
-        document[columns[c]] = int.toString() === str ? int : str
+        document[columns[c]] = int.toString() === str
+          ? int
+          : str === 'null'
+            ? null
+            : str
       }
 
       documents.push(document)
@@ -36,10 +39,7 @@ export class Database {
 
   @given('the `{word}` database is empty')
   public async truncate (id: string): Promise<void> {
-    const [name, namespace = 'default'] = id.split('.').reverse()
-    const collection = Database.client.db(namespace).collection(name)
-
-    await collection.deleteMany({})
+    await this.collection(id).deleteMany({})
   }
 
   @beforeAll()
@@ -53,6 +53,13 @@ export class Database {
   public static async disconnect (): Promise<void> {
     await this.client.close()
   }
+
+  private collection (id: string): Collection {
+    const [name, namespace = 'default'] = id.split('.').reverse()
+    const collection = `${namespace}_${name}`.toLowerCase()
+
+    return Database.client.db('toa-dev').collection(collection)
+  }
 }
 
-type Document = Record<string, string | number>
+type Document = Record<string, string | number | null>

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/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!'
+}