@toa.io/extensions.exposition 1.0.0-alpha.30 → 1.0.0-alpha.301

package/features/routes.feature

@@ -1,139 +0,0 @@
-Feature: Routes
-
-  Scenario Outline: Basic routes
-    Given the `greeter` is running with the following manifest:
-      """yaml
-      namespace: basic
-
-      exposition:
-        /:
-          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:
-      """
-      200 OK
-
-      Hello
-      """
-    Examples:
-      | route                 |
-      | /strict/              |
-      | /shortcuts/operation/ |
-
-  Scenario: Basic routes within default namespace
-    Given the `greeter` is running with the following manifest:
-      """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:
-      """
-      200 OK
-
-      Hello
-      """
-
-  Scenario: Wildcard routes
-    Given the `greeter` is running with the following manifest:
-      """yaml
-      exposition:
-        /:
-          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:
-      """
-      200 OK
-
-      Hello
-      """
-    When the following request is received:
-      """
-      GET /greeter/baz/qux/ HTTP/1.1
-      host: nex.toa.io
-      """
-    Then the following reply is sent:
-      """
-      404 Not Found
-      """
-    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:
-      """
-      200 OK
-
-      Hello
-      """
-
-  Scenario: Routes with naming conflicts
-    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:
-      """
-      200 OK
-
-      newbie: false
-      """
-    When the following request is received:
-      """
-      POST /users/ HTTP/1.1
-      host: nex.toa.io
-      content-type: application/yaml
-
-      name: Alice
-      """
-    Then the following reply is sent:
-      """
-      201 Created
-      """

package/features/steps/Captures.ts

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

package/features/steps/Common.ts

@@ -1,10 +0,0 @@
-import { binding, given } from 'cucumber-tsflow'
-import { timeout } from '@toa.io/generic'
-
-@binding()
-export class Common {
-  @given('after {float} second(s)')
-  public async timeout (interval: number): Promise<void> {
-    await timeout(interval * 1000)
-  }
-}

package/features/steps/Components.ts

@@ -1,55 +0,0 @@
-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'
-import { type Connector } from '@toa.io/core'
-import { parse } from '@toa.io/yaml'
-import { Workspace } from './Workspace'
-
-@binding([Workspace])
-export class Components {
-  private readonly workspace: Workspace
-  private compositions: Record<string, Connector> = {}
-
-  public constructor (workspace: Workspace) {
-    this.workspace = workspace
-  }
-
-  @given('the `{word}` is running')
-  public async run (name: string): Promise<void> {
-    await this.runComponent(name)
-  }
-
-  @given('the `{word}` is running with the following manifest:')
-  public async patchAndRun (name: string, yaml: string): Promise<void> {
-    const manifest = parse(yaml)
-
-    await this.runComponent(name, manifest)
-  }
-
-  @given('the `{word}` is stopped')
-  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.compositions[name] = await boot.composition([path])
-
-    await this.compositions[name].connect()
-    await timeout(50) // discovery
-  }
-}

package/features/steps/Database.ts

@@ -1,65 +0,0 @@
-import { afterAll, beforeAll, binding, given } from 'cucumber-tsflow'
-import { MongoClient } from 'mongodb'
-import type { Collection } from 'mongodb'
-import type { DataTable } from '@cucumber/cucumber'
-
-@binding()
-export class Database {
-  private static client: MongoClient
-
-  @given('the `{word}` database contains:')
-  public async upsert (id: string, table: DataTable): Promise<void> {
-    const collection = this.collection(id)
-    const columns = table.raw()[0]
-    const rows = table.rows()
-    const documents: Document[] = []
-
-    for (let r = 0; r < rows.length; r++) {
-      const document: Document = {}
-
-      for (let c = 0; c < columns.length; c++) {
-        const str = rows[r][c]
-        const int = parseInt(str)
-
-        document[columns[c]] = int.toString() === str
-          ? int
-          : str === 'null'
-            ? null
-            : str
-      }
-
-      documents.push(document)
-    }
-
-    await collection.deleteMany({})
-
-    if (documents.length > 0)
-      await collection.insertMany(documents)
-  }
-
-  @given('the `{word}` database is empty')
-  public async truncate (id: string): Promise<void> {
-    await this.collection(id).deleteMany({})
-  }
-
-  @beforeAll()
-  public static async connect (): Promise<void> {
-    this.client = new MongoClient('mongodb://developer:secret@localhost:27017')
-
-    await this.client.connect()
-  }
-
-  @afterAll()
-  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 | null>

package/features/steps/Gateway.ts

@@ -1,132 +0,0 @@
-import { after, afterAll, binding, given } from 'cucumber-tsflow'
-import * as boot from '@toa.io/boot'
-import { type Connector } from '@toa.io/core'
-import { parse } from '@toa.io/yaml'
-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
-
-@binding()
-export class Gateway {
-  private default: boolean = true
-
-  @given('the annotation:')
-  public async annotate (yaml: string): Promise<void> {
-    const annotation = parse(yaml)
-
-    if ('/' in annotation) {
-      const tree = syntax.parse(annotation['/'], shortcuts)
-
-      process.env.TOA_EXPOSITION = encode(tree)
-    }
-
-    const { debug, trace, authorities } = annotation
-    const properties = Object.assign({}, DEFAULT_PROPERTIES)
-
-    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()
-
-    this.default = false
-  }
-
-  @given('the `{word}` configuration:')
-  public async configure (id: string, yaml: string): Promise<void> {
-    const [name, namespace = 'default'] = id.split('.').reverse()
-    const key = `TOA_CONFIGURATION_${namespace.toUpperCase()}_${name.toUpperCase()}`
-    const def = DEFAULT_CONFIGURATION[id] ?? {}
-    const patch: object = parse(yaml)
-    const configuration = Object.assign({}, def, patch)
-
-    process.env[key] = encode(configuration)
-
-    await Gateway.stop()
-
-    this.default = false
-  }
-
-  @given('the Gateway is running')
-  public async start (): Promise<void> {
-    if (instance !== null)
-      return
-
-    process.env.TOA_EXPOSITION ??= DEFAULT_TREE
-    process.env.TOA_EXPOSITION_PROPERTIES ??= encode(DEFAULT_PROPERTIES)
-
-    this.writeConfiguration()
-
-    const factory = new Factory(boot)
-    const service = factory.service()
-
-    if (service === null)
-      throw new Error('?')
-
-    instance = service
-
-    await service.connect()
-    await timeout(50) // resource discovery
-  }
-
-  @after()
-  public async cleanup (): Promise<void> {
-    if (this.default)
-      return
-
-    delete process.env.TOA_EXPOSITION
-    delete process.env.TOA_EXPOSITION_PROPERTIES
-
-    await Gateway.stop()
-  }
-
-  @afterAll()
-  public static async stop (): Promise<void> {
-    await instance?.disconnect()
-    instance = null
-  }
-
-  private writeConfiguration (): void {
-    for (const [id, configuration] of Object.entries(DEFAULT_CONFIGURATION)) {
-      const [name, namespace = 'default'] = id.split('.').reverse()
-      const key = `TOA_CONFIGURATION_${namespace.toUpperCase()}_${name.toUpperCase()}`
-
-      process.env[key] ??= encode(configuration)
-    }
-  }
-}
-
-const DEFAULT_TREE = encode({
-  routes: [],
-  methods: [],
-  directives: [
-    {
-      family: 'auth',
-      name: 'anonymous',
-      value: true
-    }
-  ]
-} 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/HTTP.ts

@@ -1,74 +0,0 @@
-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/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, Captures])
-export class HTTP extends http.Agent {
-  private readonly gateway: Gateway
-  private fetched: Response | null = null
-
-  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()
-    this.fetched = await super.request(input)
-  }
-
-  @then('the following reply is sent:')
-  public override responseIncludes (expected: string): void {
-    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)
-  }
-
-  @when('the stream of `{word}` is received with the following headers:')
-  public async streamRequest (filename: string, head: string): Promise<any> {
-    const stream = open(filename)
-
-    await this.gateway.start()
-    await super.stream(head, stream)
-  }
-
-  @then('the stream equals to `{word}` is sent with the following headers:')
-  public async responseStreamMatch (filename: string, head: string): Promise<any> {
-    const stream = open(filename)
-
-    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

@@ -1,154 +0,0 @@
-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> {
-    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,21 +0,0 @@
-import { setDefaultTimeout } from '@cucumber/cucumber'
-import { encode } from '@toa.io/generic'
-
-export class Parameters {
-  public readonly origin: string
-
-  public constructor () {
-    this.origin = 'http://127.0.0.1:8000'
-  }
-}
-
-setDefaultTimeout(30 * 1000)
-
-process.env.TOA_DEV = '1'
-
-process.env.TOA_STORAGES = encode({
-  octets: {
-    provider: 'tmp',
-    directory: 'exposition'
-  }
-})

package/features/steps/Workspace.ts

@@ -1,41 +0,0 @@
-import { join } from 'node:path'
-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
-
-  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 =
-        await mkdtemp(join(tmpdir(), Math.random().toString(36).slice(2)))
-
-      return method.apply(this, args)
-    }
-
-    return descriptor
-  }
-
-  @Workspace.exists
-  public async addComponent (name: string, patch?: object): Promise<string> {
-    const source = join(__dirname, 'components', name)
-    const target = join(this.root, name)
-
-    await cp(source, target, { force: true, recursive: true })
-
-    if (patch !== undefined)
-      await this.patchManifest(target, patch)
-
-    return target
-  }
-
-  private async patchManifest (target: string, patch: object): Promise<void> {
-    const path = join(target, 'manifest.toa.yaml')
-
-    await yaml.patch(path, patch)
-  }
-}