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

package/features/octets.download.feature

@@ -18,6 +18,8 @@ Feature: Download external resources
               meta: true
       """
 
+    Given the length of `https://avatars.githubusercontent.com/u/92763022?s=48&v=4` is captured as `length`
+
     When the following request is received:
       """
       POST / HTTP/1.1
@@ -43,7 +45,7 @@ Feature: Download external resources
     Then the following reply is sent:
       """
       200 OK
-      content-length: 1288
+      content-length: ${{ length }}
       content-type: image/png
       etag: "${{ checksum }}"
       """

package/features/probes.feature

@@ -1,14 +1,18 @@
 Feature: Probes
 
-  Scenario: Startup probe
+  # The probe is on a port of its own: kubelet speaks HTTP/1.1, and the gateway may serve h2c.
+  Scenario: The gateway answers its readiness probe
+    Given the Gateway is running
+    When the ready probe is requested
+    Then the ready probe answers 200
+
+  Scenario: The traffic port does not serve the probe
     Given the Gateway is running
-    And after 15 seconds
     When the following request is received:
       """
       GET /.ready HTTP/1.1
       """
     Then the following reply is sent:
       """
-      200 OK
-      cache-control: no-store
+      404 Not Found
       """

package/features/steps/Captures.ts

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

package/features/steps/Common.ts

@@ -1,8 +1,18 @@
-import { binding, given } from 'cucumber-tsflow'
+import * as assert from 'node:assert'
+import tsflow from 'cucumber-tsflow'
 import { timeout } from '@toa.io/generic'
+import { Captures } from './Captures.js'
 
-@binding()
+const { binding, given } = tsflow
+
+@binding([Captures])
 export class Common {
+  private readonly captures: Captures
+
+  public constructor (captures: Captures) {
+    this.captures = captures
+  }
+
   @given('after {float} second(s)')
   public async timeout (interval: number): Promise<void> {
     await timeout(interval * 1000)
@@ -11,4 +21,19 @@ export class Common {
   @given('the process is running')
   public async noop (): Promise<void> {
   }
+
+  /**
+   * A remote resource is whatever it is today. A scenario downloading one compares the reply
+   * against what the origin actually serves, not against a literal that goes stale when it changes.
+   */
+  @given('the length of `{}` is captured as `{word}`')
+  public async length (url: string, name: string): Promise<void> {
+    const response = await fetch(url)
+
+    assert.equal(response.status, 200, `${url} answered ${response.status}`)
+
+    const body = await response.arrayBuffer()
+
+    this.captures.set(name, String(body.byteLength))
+  }
 }

package/features/steps/Components.ts

@@ -1,13 +1,19 @@
+import { createRequire } from 'node:module'
 import * as assert from 'node:assert'
 import { dirname, join } from 'node:path'
-import { after, binding, given } from 'cucumber-tsflow'
+import tsflow from 'cucumber-tsflow'
+
 import * as boot from '@toa.io/boot'
 import { timeout } from '@toa.io/generic'
 import { type Connector } from '@toa.io/core'
 import { load as parse } from 'js-yaml'
-import { Gateway } from './Gateway'
-import { Workspace } from './Workspace'
-import { components as map } from './map'
+import { Gateway } from './Gateway.js'
+import { Workspace } from './Workspace.js'
+import { components as map } from './map.js'
+
+const { after, binding, given } = tsflow
+
+const require = createRequire(import.meta.url)
 
 const MAP = 'introspection'
 const VALUES = 'configuration'

package/features/steps/Database.ts

@@ -1,8 +1,11 @@
-import { afterAll, beforeAll, binding, given } from 'cucumber-tsflow'
+import tsflow from 'cucumber-tsflow'
+
 import { MongoClient } from 'mongodb'
 import type { Collection } from 'mongodb'
 import type { DataTable } from '@cucumber/cucumber'
 
+const { afterAll, beforeAll, binding, given } = tsflow
+
 @binding()
 export class Database {
   private static client: MongoClient

package/features/steps/Gateway.ts

@@ -1,13 +1,16 @@
-import { after, afterAll, binding, given } from 'cucumber-tsflow'
+import tsflow from 'cucumber-tsflow'
+
 import * as boot from '@toa.io/boot'
 import { type Connector } from '@toa.io/core'
 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'
-import { manifests } from './map'
-import type * as http from '../../source/HTTP'
+import { Factory } from '../../source/index.js'
+import * as syntax from '../../source/RTD/syntax/index.js'
+import { shortcuts } from '../../source/Directive.js'
+import { manifests } from './map.js'
+import type * as http from '../../source/HTTP/index.js'
+
+const { after, afterAll, binding, given } = tsflow
 
 let instance: Connector | null = null
 
@@ -83,6 +86,9 @@ export class Gateway {
     const patch = parse(yaml) as object
     const configuration = Object.assign({}, def, patch)
 
+    // scenario-scoped, as the secrets it may refer to are: a configuration left behind
+    // outlives the secrets it points at, and the next scenario cannot resolve them
+    this.written.push(key)
     process.env[key] = JSON.stringify(configuration)
 
     await Gateway.stop()
@@ -125,7 +131,7 @@ export class Gateway {
     this.writeConfiguration()
 
     const factory = new Factory(boot)
-    const service = factory.service()
+    const service = await factory.service()
 
     if (service === null)
       throw new Error('?')
@@ -191,12 +197,17 @@ const DEFAULT_TREE = JSON.stringify({
 const DEFAULT_PROPERTIES: Partial<http.Options> = {
   authorities: {
     nex: 'nex.toa.io'
-  }
+  },
+  // `npm run features:h2c` runs the whole suite over cleartext HTTP/2
+  protocol: process.env.TOA_EXPOSITION_PROTOCOL === 'h2c' ? 'h2c' : 'h1'
 }
 
 // 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> = {
+  // a component declaring configuration waits for `configuration.values`, which these
+  // features do not run; the variable is the local override that stands in for it
+  'realtime.streams': {},
   'identity.basic': {},
   'identity.federation': {},
   'identity.otp': {},

package/features/steps/HTTP.ts

@@ -1,15 +1,18 @@
 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 tsflow 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 { Captures } from './Captures.js'
+import { Parameters } from './Parameters.js'
+import { Gateway } from './Gateway.js'
 import type { Readable } from 'node:stream'
 
+const { binding, then, when } = tsflow
+
 @binding([Gateway, Parameters, Captures])
 export class HTTP extends http.Agent {
   private readonly gateway: Gateway
@@ -85,7 +88,7 @@ export class HTTP extends http.Agent {
   }
 }
 
-const FILES_DIR = path.resolve(__dirname, '../../../storages/source/test')
+const FILES_DIR = path.resolve(import.meta.dirname, '../../../storages/source/test')
 
 function open (filename: string): Readable {
   return fs.createReadStream(path.join(FILES_DIR, filename))

package/features/steps/IDP.ts

@@ -4,11 +4,14 @@ import * as http from 'node:http'
 import * as assert from 'node:assert'
 import * as util from 'node:util'
 import { buffer } from 'node:stream/consumers'
-import { binding, given, afterAll } from 'cucumber-tsflow'
-import { Captures } from './Captures'
+import tsflow from 'cucumber-tsflow'
+
+import { Captures } from './Captures.js'
 
 import type { AddressInfo } from 'node:net'
 
+const { binding, given, afterAll } = tsflow
+
 @binding([Captures])
 export class IDP {
   private static server?: http.Server

package/features/steps/Identity.ts

@@ -1,8 +1,11 @@
-import { binding, given } from 'cucumber-tsflow'
+import tsflow from 'cucumber-tsflow'
+
 import * as http from '@toa.io/agent'
-import { Parameters } from './Parameters'
-import { Captures } from './Captures'
-import { Gateway } from './Gateway'
+import { Parameters } from './Parameters.js'
+import { Captures } from './Captures.js'
+import { Gateway } from './Gateway.js'
+
+const { binding, given } = tsflow
 
 @binding([Gateway, Parameters, Captures])
 export class Identity {

package/features/steps/OTP.ts

@@ -1,8 +1,11 @@
 import * as assert from 'node:assert'
-import { binding, given } from 'cucumber-tsflow'
+import tsflow from 'cucumber-tsflow'
+
 import * as boot from '@toa.io/boot'
 import { Locator, type Remote } from '@toa.io/core'
-import { Captures } from './Captures'
+import { Captures } from './Captures.js'
+
+const { binding, given } = tsflow
 
 @binding([Captures])
 export class OTP {

package/features/steps/Parameters.ts

@@ -2,7 +2,7 @@ import { join } from 'node:path'
 import * as dotenv from 'dotenv'
 import { setDefaultTimeout } from '@cucumber/cucumber'
 
-dotenv.config({ path: join(__dirname, '.env') })
+dotenv.config({ path: join(import.meta.dirname, '.env') })
 
 export class Parameters {
   public readonly origin: string
@@ -16,6 +16,10 @@ setDefaultTimeout(60 * 1000)
 
 process.env.TOA_DEV = '1'
 
+// the gateway answers for itself, as it does in a deployment: telemetry's probe tracks the
+// nested composition, which connects before route discovery settles
+process.env.TOA_TELEMETRY_READY ??= JSON.stringify(false)
+
 // export traces to the local Tempo (`docker compose up tempo grafana`),
 // unavailability of the endpoint is harmless
 process.env.TOA_TELEMETRY_TRACES ??= JSON.stringify({

package/features/steps/Probe.ts

@@ -0,0 +1,36 @@
+import assert from 'node:assert'
+import { Agent, request } from 'undici'
+import tsflow from 'cucumber-tsflow'
+import { PATH, PROBE } from '../../source/HTTP/index.js'
+
+const { after, binding, then, when } = tsflow
+
+@binding()
+export class Probe {
+  private readonly agent = new Agent()
+  private status: number | null = null
+  private headers: Record<string, string> = {}
+
+  @when('the ready probe is requested')
+  public async request (): Promise<void> {
+    const response = await request(`http://127.0.0.1:${PROBE}${PATH}`, { dispatcher: this.agent })
+
+    this.status = response.statusCode
+    this.headers = response.headers as Record<string, string>
+
+    await response.body.dump()
+  }
+
+  @then('the ready probe answers {int}')
+  public answers (status: number): void {
+    assert.equal(this.status, status)
+
+    if (status === 200)
+      assert.equal(this.headers['cache-control'], 'no-store')
+  }
+
+  @after()
+  public async close (): Promise<void> {
+    await this.agent.close()
+  }
+}

package/features/steps/Realtime.ts

@@ -1,16 +1,19 @@
 import { EventEmitter, once } from 'node:events'
 import * as assert from 'node:assert'
-import { after, binding, given, afterAll, then } from 'cucumber-tsflow'
+import tsflow from 'cucumber-tsflow'
+
 import { Factory } from '@toa.io/extensions.realtime'
 import * as boot from '@toa.io/boot'
 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'
-import { Captures } from './Captures'
+import { Parameters } from './Parameters.js'
+import { Gateway } from './Gateway.js'
+import { Captures } from './Captures.js'
 import type { Connector } from '@toa.io/core'
 
+const { after, binding, given, afterAll, then } = tsflow
+
 @binding([Gateway, Parameters, Captures])
 export class Realtime {
   private static instance: Connector | null = null
@@ -39,7 +42,7 @@ export class Realtime {
 
     const factory = new Factory(boot)
 
-    Realtime.instance = factory.service()
+    Realtime.instance = await factory.service()
 
     void Realtime.instance.connect()
   }

package/features/steps/Workspace.ts

@@ -22,7 +22,7 @@ export class Workspace {
 
   @Workspace.exists
   public async addComponent (name: string, patch?: object): Promise<string> {
-    const source = join(__dirname, 'components', name)
+    const source = join(import.meta.dirname, 'components', name)
     const target = join(this.root, name)
 
     await cp(source, target, { force: true, recursive: true })

package/features/steps/components/audit/operations/record.js

@@ -1,9 +1,5 @@
-'use strict'
-
-async function effect (input) {
+export async function effect (input) {
   await new Promise((resolve) => setTimeout(resolve, 500))
 
   return null
 }
-
-exports.effect = effect

package/features/steps/components/echo/operations/affect.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function effect (input) {
+export function effect (input) {
   return `Hello ${input.name}`
 }
-
-exports.effect = effect

package/features/steps/components/echo/operations/compute.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation (input) {
+export function computation (input) {
   return `Hello ${input.name}`
 }
-
-exports.computation = computation

package/features/steps/components/echo/operations/echo.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation (input) {
+export function computation (input) {
   return input
 }
-
-exports.computation = computation

package/features/steps/components/echo/operations/error.js

@@ -1,11 +1,7 @@
-'use strict'
-
-function computation () {
+export function computation () {
   const err = { code: 'CODE', message: 'message' }
 
   Object.setPrototypeOf(err, Error.prototype)
 
   return err
 }
-
-exports.computation = computation

package/features/steps/components/echo/operations/identity.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation (input) {
+export function computation (input) {
   return input
 }
-
-exports.computation = computation

package/features/steps/components/echo/operations/parameters.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation (input) {
+export function computation (input) {
   return input
 }
-
-exports.computation = computation

package/features/steps/components/echo/operations/ping.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation () {
+export function computation () {
   return 'pong'
 }
-
-exports.computation = computation

package/features/steps/components/echo/operations/unwrap.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation (input) {
+export function computation (input) {
   return JSON.parse(input.buf)
 }
-
-exports.computation = computation

package/features/steps/components/echo.beacon/operations/hello.js

@@ -1,5 +1,3 @@
-'use strict'
-
-exports.computation = () => {
+export const computation = () => {
   return 'Hello!'
 }

package/features/steps/components/greeter/operations/greet.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation () {
+export function computation () {
   return 'Hello'
 }
-
-exports.computation = computation

package/features/steps/components/notify/operations/send.js

@@ -1,9 +1,5 @@
-'use strict'
-
-async function effect (input) {
+export async function effect (input) {
   await new Promise((resolve) => setTimeout(resolve, 800))
 
   return null
 }
-
-exports.effect = effect

package/features/steps/components/octets.tester/operations/authority.js

@@ -1,7 +1,3 @@
-'use strict'
-
-function computation (input) {
+export function computation (input) {
   return input.authority
 }
-
-exports.computation = computation

package/features/steps/components/octets.tester/operations/bar.js

@@ -1,5 +1,3 @@
-'use strict'
-
 import { setTimeout } from 'node:timers/promises'
 
 async function bar (input, context) {
@@ -8,4 +6,4 @@ async function bar (input, context) {
   return { bar: 'baz' }
 }
 
-exports.effect = bar
+export { bar as effect }

package/features/steps/components/octets.tester/operations/baz.js

@@ -1,5 +1,3 @@
-'use strict'
-
 import { setTimeout } from 'node:timers/promises'
 
 async function baz (input, context) {
@@ -8,4 +6,4 @@ async function baz (input, context) {
   return input.steps ?? null
 }
 
-exports.effect = baz
+export { baz as effect }

package/features/steps/components/octets.tester/operations/concat.js

@@ -1,7 +1,5 @@
-'use strict'
-
 function concat (input) {
   return input.parameters.a + ' ' + input.parameters.b
 }
 
-exports.computation = concat
+export { concat as computation }

package/features/steps/components/octets.tester/operations/echo.js

@@ -1,7 +1,5 @@
-'use strict'
-
 function echo (input) {
   return input
 }
 
-exports.computation = echo
+export { echo as computation }

package/features/steps/components/octets.tester/operations/err.js

@@ -1,5 +1,3 @@
-'use strict'
-
 import { setTimeout } from 'node:timers/promises'
 
 async function err (_) {
@@ -13,4 +11,4 @@ async function err (_) {
   return err
 }
 
-exports.effect = err
+export { err as effect }

package/features/steps/components/octets.tester/operations/foo.js

@@ -1,7 +1,5 @@
-'use strict'
-
 async function foo (input, context) {
   return { foo: 'bar' }
 }
 
-exports.effect = foo
+export { foo as effect }

package/features/steps/components/octets.tester/operations/id.js

@@ -1,7 +1,5 @@
-'use strict'
-
 function id (input) {
   return input.entry.id
 }
 
-exports.computation = id
+export { id as computation }

package/features/steps/components/octets.tester/operations/identity.js

@@ -1,7 +1,5 @@
-'use strict'
-
 function identity (input) {
   return input.identity
 }
 
-exports.computation = identity
+export { identity as computation }

package/features/steps/components/octets.tester/operations/redirect.js

@@ -1,5 +1,3 @@
-'use strict'
-
 function redirect (input) {
   return input.parameters.type in urls ? { url: urls[input.parameters.type] } : new Error()
 }
@@ -9,4 +7,4 @@ const urls = {
   'img': 'https://www.w3.org/assets/logos/w3c/w3c-no-bars.svg'
 }
 
-exports.computation = redirect
+export { redirect as computation }

package/features/steps/components/octets.tester/operations/yex.js

@@ -1,5 +1,3 @@
-'use strict'
-
 import { setTimeout } from 'node:timers/promises'
 
 async function * effect (_) {
@@ -13,4 +11,4 @@ async function * effect (_) {
   throw new Error('Oops!')
 }
 
-exports.effect = effect
+export { effect }

package/features/steps/components/octets.tester/operations/yield.js

@@ -1,5 +1,3 @@
-'use strict'
-
 import { setTimeout } from 'node:timers/promises'
 
 async function * effect (_) {
@@ -10,4 +8,4 @@ async function * effect (_) {
   yield 'world'
 }
 
-exports.effect = effect
+export { effect }

package/features/steps/components/orders/operations/create.js

@@ -1,9 +1,5 @@
-'use strict'
-
-async function transition (input, object, context) {
+export async function transition (input, object, context) {
   const price = await context.remote.default.pricing.quote({ input: { volume: input.volume } })
 
   return Object.assign(object, { ...input, price })
 }
-
-exports.transition = transition