@toa.io/extensions.exposition 0.24.0-alpha.9 → 1.0.0-alpha.10

package/features/response.feature

@@ -0,0 +1,68 @@
+Feature: Response
+
+  Scenario: Content negotiation
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        GET:
+          anonymous: true
+          dev:stub: hello
+      """
+    When the following request is received:
+      """
+      GET / HTTP/1.1
+      accept: application/json
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/json
+      vary: accept
+      """
+
+  Scenario: Error as YAML
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: error
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      409 Conflict
+      content-type: application/yaml
+
+      code: CODE
+      message: message
+      """
+
+  Scenario: Error as MessagePack
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: error
+      """
+    When the following request is received:
+      """
+      GET /echo/ HTTP/1.1
+      accept: application/msgpack
+      """
+    Then the following reply is sent:
+      """
+      409 Conflict
+      content-type: application/msgpack
+      """
+    And response body contains MessagePack-encoded value:
+      """yaml
+      code: CODE
+      message: message
+      """

package/features/routes.feature

@@ -6,12 +6,14 @@ 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:
       """
@@ -34,6 +36,7 @@ Feature: Routes
       """yaml
       exposition:
         /:
+          io:output: true
           GET: greet
       """
     When the following request is received:
@@ -52,10 +55,12 @@ 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:
       """
@@ -87,3 +92,42 @@ Feature: Routes
 
       Hello
       """
+
+  Scenario: Routes with naming conflicts
+    Given the Gateway is running
+    And 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
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      newbie: false
+      """
+    When the following request is received:
+      """
+      POST /users/ HTTP/1.1
+      content-type: application/yaml
+
+      name: Alice
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """

package/features/steps/Captures.ts

@@ -0,0 +1,6 @@
+import * as http from '@toa.io/agent'
+import { binding } from 'cucumber-tsflow'
+
+@binding()
+export class Captures extends http.Captures {
+}

package/features/steps/Components.ts

@@ -1,3 +1,4 @@
+import * as assert from 'node:assert'
 import { after, binding, given } from 'cucumber-tsflow'
 import * as boot from '@toa.io/boot'
 import { timeout } from '@toa.io/generic'
@@ -8,7 +9,7 @@ import { Workspace } from './Workspace'
 @binding([Workspace])
 export class Components {
   private readonly workspace: Workspace
-  private composition: Connector | null = null
+  private compositions: Record<string, Connector> = {}
 
   public constructor (workspace: Workspace) {
     this.workspace = workspace
@@ -26,18 +27,29 @@ export class Components {
     await this.runComponent(name, manifest)
   }
 
-  @after()
   @given('the `{word}` is stopped')
-  public async stop (_?: string): Promise<void> {
-    await this.composition?.disconnect()
+  public async stop (name: string): Promise<void> {
+    assert.ok(name in this.compositions, `Composition '${name}' is not running`)
+
+    await this.compositions[name].disconnect()
+    delete this.compositions[name]
+  }
+
+  @after()
+  public async shutdown (): Promise<void> {
+    const promises = Object.values(this.compositions).map((composition) => composition.disconnect())
+
+    await Promise.all(promises)
   }
 
   private async runComponent (name: string, manifest?: object): Promise<void> {
+    assert.ok(!(name in this.compositions), `Composition '${name}' is already running`)
+
     const path = await this.workspace.addComponent(name, manifest)
 
-    this.composition = await boot.composition([path])
+    this.compositions[name] = await boot.composition([path])
 
-    await this.composition.connect()
+    await this.compositions[name].connect()
     await timeout(50) // discovery
   }
 }

package/features/steps/Database.ts

@@ -1,6 +1,6 @@
 import { afterAll, beforeAll, binding, given } from 'cucumber-tsflow'
-import { type DataTable } from '@cucumber/cucumber'
 import { MongoClient } from 'mongodb'
+import type { DataTable } from '@cucumber/cucumber'
 
 @binding()
 export class Database {

package/features/steps/Gateway.ts

@@ -18,8 +18,7 @@ export class Gateway {
     const annotation = parse(yaml)
 
     if ('/' in annotation) {
-      const node = { '/': annotation['/'] }
-      const tree = syntax.parse(node, shortcuts)
+      const tree = syntax.parse(annotation['/'], shortcuts)
 
       process.env.TOA_EXPOSITION = encode(tree)
     }
@@ -27,6 +26,9 @@ export class Gateway {
     if (annotation.debug === true)
       process.env.TOA_EXPOSITION_DEBUG = '1'
 
+    if (annotation.trace === true)
+      process.env.TOA_EXPOSITION_TRACE = '1'
+
     await Gateway.stop()
 
     this.default = false

package/features/steps/HTTP.ts

@@ -1,22 +1,29 @@
+import * as assert from 'node:assert'
+import * as fs from 'node:fs'
+import * as path from 'node:path'
 import { binding, then, when } from 'cucumber-tsflow'
-import * as http from '@toa.io/http'
-import { open } from '../../../storages/source/test/util'
+import * as http from '@toa.io/agent'
+import * as msgpack from 'msgpackr'
+import * as YAML from 'js-yaml'
+import { Captures } from './Captures'
 import { Parameters } from './Parameters'
 import { Gateway } from './Gateway'
+import type { Readable } from 'node:stream'
 
-@binding([Gateway, Parameters])
+@binding([Gateway, Parameters, Captures])
 export class HTTP extends http.Agent {
   private readonly gateway: Gateway
+  private fetched: Response | null = null
 
-  public constructor (gateway: Gateway, parameters: Parameters) {
-    super(parameters.origin)
+  public constructor (gateway: Gateway, parameters: Parameters, captures: Captures) {
+    super(parameters.origin, captures)
     this.gateway = gateway
   }
 
   @when('the following request is received:')
   public override async request (input: string): Promise<any> {
     await this.gateway.start()
-    await super.request(input)
+    this.fetched = await super.request(input)
   }
 
   @then('the following reply is sent:')
@@ -24,6 +31,17 @@ export class HTTP extends http.Agent {
     super.responseIncludes(expected)
   }
 
+  @then('response body contains {word}-encoded value:')
+  public async bodyIs (format: string, yaml: string): Promise<void> {
+    assert.ok(this.fetched !== null, 'Response is null')
+
+    const buf = await this.fetched.arrayBuffer()
+    const value = encoders[format]?.(buf as Buffer)
+    const expected = YAML.load(yaml)
+
+    assert.deepEqual(value, expected, 'Values are not equal')
+  }
+
   @then('the reply does not contain:')
   public override responseExcludes (expected: string): void {
     super.responseExcludes(expected)
@@ -44,3 +62,13 @@ export class HTTP extends http.Agent {
     await super.streamMatch(head, stream)
   }
 }
+
+const FILEDIR = path.resolve(__dirname, '../../../storages/source/test')
+
+function open (filename: string): Readable {
+  return fs.createReadStream(path.join(FILEDIR, filename))
+}
+
+const encoders: Record<string, (buf: Buffer | Uint8Array) => any> = {
+  MessagePack: msgpack.decode
+}

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