@toa.io/extensions.exposition 1.0.0-alpha.5 → 1.0.0-alpha.51

package/features/response.feature

@@ -4,13 +4,16 @@ Feature: Response
     Given the annotation:
       """yaml
       /:
+        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:
@@ -18,6 +21,8 @@ Feature: Response
       200 OK
       content-type: application/json
       vary: accept
+
+      {"hello":"world"}
       """
 
   Scenario: Error as YAML
@@ -25,16 +30,18 @@ Feature: Response
       """yaml
       exposition:
         /:
+          io:output: true
           GET: error
       """
     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
@@ -46,16 +53,18 @@ Feature: Response
       """yaml
       exposition:
         /:
+          io:output: true
           GET: error
       """
     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

@@ -6,16 +6,19 @@ Feature: Routes
       namespace: basic
 
       exposition:
-        /strict:
-          GET:
-            endpoint: greet
-        /shortcuts:
-          /operation:
-            GET: greet
+        /:
+          io:output: true
+          /strict:
+            GET:
+              endpoint: greet
+          /shortcuts:
+            /operation:
+              GET: greet
       """
     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:
@@ -34,11 +37,13 @@ Feature: Routes
       """yaml
       exposition:
         /:
+          io:output: true
           GET: greet
       """
     When the following request is received:
       """
       GET /greeter/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -52,14 +57,17 @@ Feature: Routes
     Given the `greeter` is running with the following manifest:
       """yaml
       exposition:
-        /*:
-          GET: greet
-        /foo/*/bar:
-          GET: greet
+        /:
+          io:output: true
+          /*:
+            GET: greet
+          /foo/*/bar:
+            GET: greet
       """
     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:
@@ -71,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:
       """
@@ -79,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:
@@ -89,22 +99,24 @@ 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:
         /:
+          io:output: true
           POST: create
       """
     And the `users.properties` is running with the following manifest:
       """yaml
       exposition:
         /:id:
+          io:output: true
           GET: observe
       """
     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:
@@ -116,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
@@ -124,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,6 +1,7 @@
 import { afterAll, beforeAll, binding, given } from 'cucumber-tsflow'
-import { type DataTable } from '@cucumber/cucumber'
 import { MongoClient } from 'mongodb'
+import type { Collection } from 'mongodb'
+import type { DataTable } from '@cucumber/cucumber'
 
 @binding()
 export class Database {
@@ -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/components/echo/manifest.toa.yaml

@@ -1,5 +1,4 @@
 name: echo
-version: 0.0.0
 
 operations:
   compute:
@@ -8,3 +7,15 @@ operations:
   affect:
     input:
       name*: string
+  identity:
+    input:
+      identity:
+        id: string
+        roles: [string]
+  parameters:
+    input: &parameters
+      type: object
+      properties:
+        a: string
+        b: 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