@toa.io/extensions.exposition 1.0.0-alpha.272 → 1.0.0-alpha.274

package/features/require.feature

@@ -27,7 +27,7 @@ Feature: Request requirements
     Then the following reply is sent:
       """
       201 Created
-      etag: ${{ etag }}
+      etag: "${{ etag }}"
 
       id: ${{ id }}
       """
@@ -53,7 +53,7 @@ Feature: Request requirements
       host: nex.toa.io
       content-type: application/yaml
       accept: text/plain
-      if-match: ${{ etag }}
+      if-match: "${{ etag }}"
 
       title: Bye
       """

package/features/response.feature

@@ -19,8 +19,8 @@ Feature: Response
     Then the following reply is sent:
       """
       200 OK
+      vary: origin, accept
       content-type: application/json
-      vary: accept
 
       {"hello":"world"}
       """
@@ -33,8 +33,8 @@ Feature: Response
     Then the following reply is sent:
       """
       200 OK
+      vary: origin, accept
       content-type: application/yaml
-      vary: accept
 
       hello: world
       """
@@ -48,8 +48,8 @@ Feature: Response
     Then the following reply is sent:
       """
       200 OK
+      vary: origin, accept
       content-type: application/json
-      vary: accept
 
       {"hello":"world"}
       """

package/features/steps/Components.ts

@@ -1,21 +1,26 @@
 import * as assert from 'node:assert'
+import { dirname, join } from 'node:path'
 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 { load as parse } from 'js-yaml'
+import { Gateway } from './Gateway'
 import { Workspace } from './Workspace'
 import { components as map } from './map'
 
 const MAP = 'introspection'
+const VALUES = 'configuration'
 
-@binding([Workspace])
+@binding([Workspace, Gateway])
 export class Components {
   private readonly workspace: Workspace
+  private readonly gateway: Gateway
   private compositions: Record<string, Connector> = {}
 
-  public constructor (workspace: Workspace) {
+  public constructor (workspace: Workspace, gateway: Gateway) {
     this.workspace = workspace
+    this.gateway = gateway
   }
 
   @given('the `{word}` is running')
@@ -25,7 +30,7 @@ export class Components {
 
   @given('the `{word}` is running with the following manifest:')
   public async patchAndRun (name: string, yaml: string): Promise<void> {
-    const manifest = parse(yaml)
+    const manifest = parse(yaml) as object
 
     await this.runComponent(name, manifest)
   }
@@ -41,6 +46,25 @@ export class Components {
     await timeout(50) // discovery
   }
 
+  /** The values component, as the configuration extension ships it; the service hosts it alone. */
+  @given('the configuration values are running')
+  public async runValues (): Promise<void> {
+    assert.ok(!(VALUES in this.compositions), `Composition '${VALUES}' is already running`)
+
+    await this.gateway.start()
+
+    this.compositions[VALUES] = await boot.composition([values()])
+
+    await this.compositions[VALUES].connect()
+    await timeout(50) // discovery
+  }
+
+  /** What the deployment would tell the values service, as the scenario needs it. */
+  @given('the configuration values are deployed:')
+  public deployValues (yaml: string): void {
+    process.env.TOA_CONFIGURATION_VALUES = JSON.stringify(parse(yaml))
+  }
+
   @given('the `{word}` is stopped')
   public async stop (name: string): Promise<void> {
     assert.ok(name in this.compositions, `Composition '${name}' is not running`)
@@ -54,11 +78,18 @@ export class Components {
     const promises = Object.values(this.compositions).map((composition) => composition.disconnect())
 
     await Promise.all(promises)
+
+    delete process.env.TOA_CONFIGURATION_VALUES
   }
 
   private async runComponent (name: string, manifest?: object): Promise<void> {
     assert.ok(!(name in this.compositions), `Composition '${name}' is already running`)
 
+    // the gateway first: a component announces itself when it opens, and that only
+    // reaches a gateway that is already listening. Started the other way round, the
+    // component waits for a knock, which the request that follows does not.
+    await this.gateway.start()
+
     const path = await this.workspace.addComponent(name, manifest)
 
     this.compositions[name] = await boot.composition([path])
@@ -67,3 +98,9 @@ export class Components {
     await timeout(50) // discovery
   }
 }
+
+function values (): string {
+  const root = dirname(require.resolve('@toa.io/extensions.configuration/package.json'))
+
+  return join(root, 'components', 'configuration.values')
+}

package/features/steps/Gateway.ts

@@ -1,8 +1,8 @@
 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 { load as parse } from 'js-yaml'
+import { timeout } from '@toa.io/generic'
 import { Factory } from '../../source'
 import * as syntax from '../../source/RTD/syntax'
 import { shortcuts } from '../../source/Directive'
@@ -14,15 +14,16 @@ let instance: Connector | null = null
 @binding()
 export class Gateway {
   private default: boolean = true
+  private written: string[] = []
 
   @given('the annotation:')
   public async annotate (yaml: string): Promise<void> {
-    const annotation = parse(yaml)
+    const annotation = parse(yaml) as Partial<http.Options> & { '/'?: object }
 
-    if ('/' in annotation) {
+    if (annotation['/'] !== undefined) {
       const tree = syntax.parse(annotation['/'], shortcuts)
 
-      process.env.TOA_EXPOSITION = encode(tree)
+      process.env.TOA_EXPOSITION = JSON.stringify(tree)
     }
 
     const { debug, authorities } = annotation
@@ -34,7 +35,7 @@ export class Gateway {
     if (authorities !== undefined)
       properties.authorities = authorities
 
-    process.env.TOA_EXPOSITION_PROPERTIES = encode(properties)
+    process.env.TOA_EXPOSITION_PROPERTIES = JSON.stringify(properties)
 
     await Gateway.stop()
 
@@ -47,7 +48,15 @@ export class Gateway {
    */
   @given('the annotation of the introspection map')
   public async annotateMap (): Promise<void> {
-    const tree: syntax.Node = { routes: [], methods: [], directives: [] }
+    await this.annotateMapUnder()
+  }
+
+  /** The same routes under a root of the scenario's own: what an application declares around the map. */
+  @given('the annotation of the introspection map under:')
+  public async annotateMapUnder (yaml?: string): Promise<void> {
+    const tree: syntax.Node = yaml === undefined
+      ? { routes: [], methods: [], directives: [] }
+      : syntax.parse((parse(yaml) as { '/': object })['/'], shortcuts)
 
     for (const manifest of await manifests()) {
       const node = manifest.extensions?.[EXPOSITION] as syntax.Node | undefined
@@ -58,8 +67,8 @@ export class Gateway {
       tree.routes.push(...node.routes)
     }
 
-    process.env.TOA_EXPOSITION = encode(tree)
-    process.env.TOA_EXPOSITION_PROPERTIES = encode(DEFAULT_PROPERTIES)
+    process.env.TOA_EXPOSITION = JSON.stringify(tree)
+    process.env.TOA_EXPOSITION_PROPERTIES = JSON.stringify(DEFAULT_PROPERTIES)
 
     await Gateway.stop()
 
@@ -71,10 +80,25 @@ export class Gateway {
     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 patch = parse(yaml) as object
     const configuration = Object.assign({}, def, patch)
 
-    process.env[key] = encode(configuration)
+    process.env[key] = JSON.stringify(configuration)
+
+    await Gateway.stop()
+
+    this.default = false
+  }
+
+  /** The secrets a scenario's configuration refers to. */
+  @given('the configuration secrets:')
+  public async secrets (yaml: string): Promise<void> {
+    const secrets = parse(yaml) as Record<string, string>
+
+    for (const [name, value] of Object.entries(secrets)) {
+      this.written.push(SECRET + name)
+      process.env[SECRET + name] = value
+    }
 
     await Gateway.stop()
 
@@ -96,7 +120,7 @@ export class Gateway {
       return
 
     process.env.TOA_EXPOSITION ??= DEFAULT_TREE
-    process.env.TOA_EXPOSITION_PROPERTIES ??= encode(DEFAULT_PROPERTIES)
+    process.env.TOA_EXPOSITION_PROPERTIES ??= JSON.stringify(DEFAULT_PROPERTIES)
 
     this.writeConfiguration()
 
@@ -116,6 +140,11 @@ export class Gateway {
   public async cleanup (): Promise<void> {
     delete process.env.__TESTING_EXPOSITION_BRANCH_TTL
 
+    for (const key of this.written)
+      delete process.env[key]
+
+    this.written = []
+
     if (this.default)
       return
 
@@ -136,14 +165,18 @@ export class Gateway {
       const [name, namespace = 'default'] = id.split('.').reverse()
       const key = `TOA_CONFIGURATION_${namespace.toUpperCase()}_${name.toUpperCase()}`
 
-      process.env[key] ??= encode(configuration)
+      process.env[key] ??= JSON.stringify(configuration)
     }
+
+    for (const [name, value] of Object.entries(DEFAULT_SECRETS))
+      process.env[SECRET + name] ??= value
   }
 }
 
 const EXPOSITION = '@toa.io/extensions.exposition'
+const SECRET = 'TOA_CONFIGURATION__'
 
-const DEFAULT_TREE = encode({
+const DEFAULT_TREE = JSON.stringify({
   routes: [],
   methods: [],
   directives: [
@@ -161,18 +194,23 @@ const DEFAULT_PROPERTIES: Partial<http.Options> = {
   }
 }
 
+// the identity components boot inside the gateway, and without a variable each would wait
+// for the values service, which these features do not run
 const DEFAULT_CONFIGURATION: Record<string, object> = {
+  'identity.basic': {},
+  'identity.federation': {},
+  'identity.otp': {},
+  'identity.passkeys': {},
   'identity.tokens': {
     keys: [
-      {
-        id: 'key0',
-        key: 'sTxL6qVOadKkUJwh3FveU53XgTEo3Sdfg7k2FfiIKfs'
-      },
-      {
-        id: 'legacy0',
-        key: 'k3.local.pIZT8-9Fa6U_QtfQHOSStfGtmyzPINyKQq2Xk-hd7vA',
-        format: 'paseto'
-      }
+      { id: 'key0', key: '$IDENTITY_TOKENS_KEY0' },
+      { id: 'legacy0', key: '$IDENTITY_TOKENS_LEGACY0', format: 'paseto' }
     ]
   }
 }
+
+// a secret is given as a reference, and comes to the component as an object
+const DEFAULT_SECRETS: Record<string, string> = {
+  IDENTITY_TOKENS_KEY0: 'sTxL6qVOadKkUJwh3FveU53XgTEo3Sdfg7k2FfiIKfs',
+  IDENTITY_TOKENS_LEGACY0: 'k3.local.pIZT8-9Fa6U_QtfQHOSStfGtmyzPINyKQq2Xk-hd7vA'
+}

package/features/steps/HTTP.ts

@@ -13,7 +13,6 @@ 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)
@@ -24,7 +23,7 @@ export class HTTP extends http.Agent {
   public override async request (input: string): Promise<any> {
     await this.gateway.start()
 
-    this.fetched = await super.request(input)
+    await super.request(input)
   }
 
   @then('the following reply is sent:')
@@ -34,10 +33,9 @@ export class HTTP extends http.Agent {
 
   @then('response body contains {word}-encoded value:')
   public async bodyIs (format: string, yaml: string): Promise<void> {
-    assert.ok(this.fetched !== null, 'Response is null')
+    assert.ok(this.bytes !== null, 'Response body is not available')
 
-    const buf = await this.fetched.arrayBuffer()
-    const value = encoders[format]?.(buf as unknown as Buffer)
+    const value = encoders[format]?.(this.bytes)
     const expected = YAML.load(yaml)
 
     assert.deepEqual(value, expected, 'Values are not equal')

package/features/steps/Parameters.ts

@@ -1,7 +1,6 @@
 import { join } from 'node:path'
 import * as dotenv from 'dotenv'
 import { setDefaultTimeout } from '@cucumber/cucumber'
-import { encode } from '@toa.io/generic'
 
 dotenv.config({ path: join(__dirname, '.env') })
 
@@ -19,14 +18,14 @@ process.env.TOA_DEV = '1'
 
 // export traces to the local Tempo (`docker compose up tempo grafana`),
 // unavailability of the endpoint is harmless
-process.env.TOA_TELEMETRY_TRACES ??= encode({
+process.env.TOA_TELEMETRY_TRACES ??= JSON.stringify({
   exporters: {
     console: null,
     otlp: { endpoint: 'http://localhost:4318' }
   }
 })
 
-process.env.TOA_STORAGES = encode({
+process.env.TOA_STORAGES = JSON.stringify({
   octets: {
     provider: 'tmp',
     directory: Math.random().toString(36).substring(2)

package/features/steps/Realtime.ts

@@ -3,8 +3,8 @@ 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 { match } from '@toa.io/generic'
+import { load as parse } from 'js-yaml'
 import { Agent } from '@toa.io/agent'
 import { Parameters } from './Parameters'
 import { Gateway } from './Gateway'
@@ -29,13 +29,13 @@ export class Realtime {
   public async start (yaml: string): Promise<void> {
     await Realtime.stop()
 
-    const annotation = parse(yaml)
+    const annotation = parse(yaml) as Record<string, string>
     const routes = []
 
     for (const [event, property] of Object.entries(annotation))
       routes.push({ event, properties: [property] })
 
-    process.env.TOA_REALTIME = encode(routes)
+    process.env.TOA_REALTIME = JSON.stringify(routes)
 
     const factory = new Factory(boot)
 

package/features/steps/Workspace.ts

@@ -1,7 +1,8 @@
 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'
+import { mkdtemp, cp, readFile, writeFile } from 'node:fs/promises'
+import { load, dump } from 'js-yaml'
+import { overwrite } from '@toa.io/generic'
 
 export class Workspace {
   private root: string = devNull
@@ -35,6 +36,10 @@ export class Workspace {
   private async patchManifest (target: string, patch: object): Promise<void> {
     const path = join(target, 'manifest.toa.yaml')
 
-    await yaml.patch(path, patch)
+    const manifest = load(await readFile(path, 'utf8')) as object
+
+    overwrite(manifest, patch)
+
+    await writeFile(path, dump(manifest, { noRefs: true, lineWidth: -1 }), 'utf8')
   }
 }

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

@@ -3,11 +3,18 @@ name: audit
 operations:
   record:
     input:
-      id: string
-      title: string
-      volume: number
-      price: number
-    output: undefined
+      properties:
+        id:
+          type: string
+        title:
+          type: string
+        volume:
+          type: number
+        price:
+          type: number
+      type: object
+    output:
+      {}
 
 receivers:
   orders.created: record

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

@@ -3,24 +3,48 @@ name: echo
 operations:
   compute:
     input:
-      name*: string
+      properties:
+        name:
+          type: string
+      type: object
+      required:
+        - name
   affect:
     input:
-      name*: string
+      properties:
+        name:
+          type: string
+      type: object
+      required:
+        - name
   identity:
     input:
-      identity:
-        id: string
-        roles: [string]
+      properties:
+        identity:
+          properties:
+            id:
+              type: string
+            roles:
+              type: array
+              items:
+                type: string
+          type: object
+      type: object
   parameters:
-    input: &parameters
+    input:
+      type: object
+      properties:
+        a:
+          type: string
+        b:
+          type: string
+    output:
       type: object
       properties:
         a:
           type: string
         b:
           type: string
-    output: *parameters
   echo:
     input:
       type: object
@@ -28,4 +52,5 @@ operations:
     input:
       type: object
       properties:
-        buf: string
+        buf:
+          type: string

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

@@ -3,11 +3,18 @@ name: notify
 operations:
   send:
     input:
-      id: string
-      title: string
-      volume: number
-      price: number
-    output: undefined
+      properties:
+        id:
+          type: string
+        title:
+          type: string
+        volume:
+          type: number
+        price:
+          type: number
+      type: object
+    output:
+      {}
 
 receivers:
   orders.created: send

package/features/steps/components/octets.tester/manifest.toa.yaml

@@ -6,13 +6,27 @@ storages: octets
 operations:
   foo: &operation
     input:
-      authority*: string
-      identity: string
-      storage*: string
-      path*: string
-      entry*: object
-      parameters: object
-      steps: object
+      properties:
+        identity:
+          type: string
+        parameters:
+          type: object
+        steps:
+          type: object
+        authority:
+          type: string
+        storage:
+          type: string
+        path:
+          type: string
+        entry:
+          type: object
+      type: object
+      required:
+        - authority
+        - storage
+        - path
+        - entry
   bar: *operation
   baz: *operation
   err: *operation
@@ -25,18 +39,33 @@ operations:
   identity: *operation
   redirect:
     input:
-      authority*: string
-      path*: string
-      parameters: <string>
+      properties:
+        parameters:
+          type: object
+          patternProperties:
+            ^.+$:
+              type: string
+        authority:
+          type: string
+        path:
+          type: string
+      type: object
+      required:
+        - authority
+        - path
     output:
       type: object
       properties:
-        url: string
+        url:
+          type: string
         options:
           type: object
           properties:
-            method: string
-            headers: object
-            body: string
+            method:
+              type: string
+            headers:
+              type: object
+            body:
+              type: string
       required:
         - url

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

@@ -2,14 +2,31 @@ name: orders
 
 entity:
   schema:
-    title: string
-    volume: number
-    price?: number
+    properties:
+      title:
+        type: string
+      volume:
+        type: number
+      price:
+        type: number
+    type: object
+    required:
+      - title
+      - volume
 
 operations:
   create:
     concurrency: retry
     query: false
     input:
-      title*: .
-      volume*: .
+      properties:
+        title:
+          type: string
+          default: .
+        volume:
+          type: string
+          default: .
+      type: object
+      required:
+        - title
+        - volume