@toa.io/extensions.exposition 1.0.0-alpha.285 → 1.0.0-alpha.286

package/features/steps/Identity.ts

@@ -13,14 +13,14 @@ export class Identity {
   private readonly http: http.Agent
   private readonly variables: Captures
 
-  public constructor (gateway: Gateway, parameters: Parameters, captures: Captures) {
+  public constructor(gateway: Gateway, parameters: Parameters, captures: Captures) {
     this.gateway = gateway
     this.http = new http.Agent(parameters.origin, captures)
     this.variables = captures
   }
 
   @given('transient identity {word}')
-  public async transient (as: string): Promise<Principal> {
+  public async transient(as: string): Promise<Principal> {
     await this.gateway.start()
 
     await this.http.request(`
@@ -43,7 +43,7 @@ export class Identity {
   }
 
   @given('transient identity')
-  public async anonymous (): Promise<Principal> {
+  public async anonymous(): Promise<Principal> {
     return await this.transient('identity')
   }
 }

package/features/steps/OTP.ts

@@ -12,12 +12,12 @@ export class OTP {
   private captures: Captures
   private otp: Remote | null = null
 
-  public constructor (captures: Captures) {
+  public constructor(captures: Captures) {
     this.captures = captures
   }
 
   @given('OTP for `{word}` in `{word}` authority is issued')
-  public async issue (username: string, authority: string): Promise<void> {
+  public async issue(username: string, authority: string): Promise<void> {
     this.otp ??= await this.connect()
 
     const reply = await this.otp.invoke('issue', {
@@ -34,7 +34,7 @@ export class OTP {
     this.captures.set(`${username}.otp`, credentials)
   }
 
-  private async connect (): Promise<Remote> {
+  private async connect(): Promise<Remote> {
     const locator = new Locator('otp', 'identity')
 
     return await boot.remote(locator)

package/features/steps/Parameters.ts

@@ -4,11 +4,18 @@ import { setDefaultTimeout } from '@cucumber/cucumber'
 
 dotenv.config({ path: join(import.meta.dirname, '.env') })
 
+/**
+ * Not `PORT` and `PROBE`, which a deployment serves the gateway on: an application built on
+ * Toa is served on this machine too, and its own gateway holds those. See CONTRIBUTING.md.
+ */
+export const PORT = 31000
+export const PROBE = 31004
+
 export class Parameters {
   public readonly origin: string
 
-  public constructor () {
-    this.origin = 'http://127.0.0.1:8000'
+  public constructor() {
+    this.origin = `http://127.0.0.1:${PORT}`
   }
 }
 
@@ -29,7 +36,7 @@ process.env.TOA_TELEMETRY_READY ??= JSON.stringify(false)
 process.env.TOA_TELEMETRY_TRACES ??= JSON.stringify({
   exporters: {
     console: null,
-    otlp: { endpoint: 'http://localhost:4318' }
+    otlp: { endpoint: 'http://localhost:31061' }
   }
 })
 
@@ -49,13 +56,16 @@ const CLOUDINARY = {
     transformations: [
       {
         extension: 'icon',
-        transformation: [{
-          width: 48,
-          height: 48,
-          crop: 'fill'
-        }, {
-          border: '10px_solid_white'
-        }],
+        transformation: [
+          {
+            width: 48,
+            height: 48,
+            crop: 'fill'
+          },
+          {
+            border: '10px_solid_white'
+          }
+        ],
         optional: true
       },
       {

package/features/steps/Probe.ts

@@ -1,7 +1,8 @@
 import assert from 'node:assert'
 import { Agent, request } from 'undici'
 import tsflow from 'cucumber-tsflow'
-import { PATH, PROBE } from '../../source/HTTP/index.js'
+import { PATH } from '../../source/HTTP/index.js'
+import { PROBE } from './Parameters.js'
 
 const { after, binding, then, when } = tsflow
 
@@ -12,8 +13,10 @@ export class Probe {
   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 })
+  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>
@@ -22,15 +25,14 @@ export class Probe {
   }
 
   @then('the ready probe answers {int}')
-  public answers (status: number): void {
+  public answers(status: number): void {
     assert.equal(this.status, status)
 
-    if (status === 200)
-      assert.equal(this.headers['cache-control'], 'no-store')
+    if (status === 200) assert.equal(this.headers['cache-control'], 'no-store')
   }
 
   @after()
-  public async close (): Promise<void> {
+  public async close(): Promise<void> {
     await this.agent.close()
   }
 }

package/features/steps/Realtime.ts

@@ -4,7 +4,7 @@ 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 { match, timeout } from '@toa.io/generic'
 import { load as parse } from 'js-yaml'
 import { Agent } from '@toa.io/agent'
 import { Parameters } from './Parameters.js'
@@ -23,13 +23,13 @@ export class Realtime {
   private log: Record<string, unknown[]> = {}
   private aborted = false
 
-  public constructor (gateway: Gateway, parameters: Parameters, captures: Captures) {
+  public constructor(gateway: Gateway, parameters: Parameters, captures: Captures) {
     this.gateway = gateway
     this.agent = new Agent(parameters.origin, captures)
   }
 
   @given('the Realtime is running with the following annotation:')
-  public async start (yaml: string): Promise<void> {
+  public async start(yaml: string): Promise<void> {
     await Realtime.stop()
 
     const annotation = parse(yaml) as Record<string, string>
@@ -50,25 +50,20 @@ export class Realtime {
   }
 
   @given('the identity {word} is consuming realtime events')
-  public async connect (name: string): Promise<void> {
+  public async connect(name: string): Promise<void> {
     await this.gateway.start()
 
     const id = await this.createIdentity(name)
 
-    const parts = await this.agent.parts(`
-      GET /realtime/streams/\${{ ${name}.id }}/ HTTP/1.1
-      authorization: Token \${{ ${name}.token }}
-      accept: application/json
-    `) as AsyncIterable<Uint8Array>
+    const parts = await this.open(name)
 
     void this.consume(id, parts).catch((e) => {
-      if (!this.aborted)
-        console.debug('Consumption interrupted', e)
+      if (!this.aborted) console.debug('Consumption interrupted', e)
     })
   }
 
   @then('the following event `{word}` is received by {word}:')
-  public async received (label: string, name: string, yaml: string): Promise<void> {
+  public async received(label: string, name: string, yaml: string): Promise<void> {
     const id = this.agent.captures.get(`${name}.id`)
     const tag = `${id}:${label}`
     const expected = parse(yaml)
@@ -76,8 +71,7 @@ export class Realtime {
     if (this.log[tag] !== undefined)
       for (const data of this.log[tag])
         // eslint-disable-next-line max-depth
-        if (match(data, expected))
-          return
+        if (match(data, expected)) return
 
     const [event] = await once(this.events, tag)
 
@@ -85,7 +79,7 @@ export class Realtime {
   }
 
   @after()
-  public abort (): void {
+  public abort(): void {
     this.aborted = true
     this.agent.abort()
     this.log = {}
@@ -93,9 +87,8 @@ export class Realtime {
   }
 
   @afterAll()
-  public static async stop (): Promise<void> {
-    if (this.instance === null)
-      return
+  public static async stop(): Promise<void> {
+    if (this.instance === null) return
 
     await this.instance.disconnect()
 
@@ -103,7 +96,30 @@ export class Realtime {
     process.env.TOA_REALTIME = undefined
   }
 
-  private async createIdentity (name: string): Promise<string> {
+  /**
+   * The stream is asked for until the gateway has the route, not once. The realtime service
+   * is started by the step before this one and its `connect` is not awaited there — so the
+   * branch that carries `/realtime/streams` is still being announced while this runs, and
+   * asking too early reads the 404 that precedes the route.
+   */
+  private async open(name: string): Promise<AsyncIterable<Uint8Array>> {
+    const deadline = Date.now() + DISCOVERY
+
+    for (;;)
+      try {
+        return (await this.agent.parts(`
+          GET /realtime/streams/\${{ ${name}.id }}/ HTTP/1.1
+          authorization: Token \${{ ${name}.token }}
+          accept: application/json
+        `)) as AsyncIterable<Uint8Array>
+      } catch (error) {
+        if (Date.now() > deadline) throw error
+
+        await timeout(POLL)
+      }
+  }
+
+  private async createIdentity(name: string): Promise<string> {
     const password = Math.random().toString(36).slice(2)
     const username = name + Math.random().toString(36).slice(2)
 
@@ -138,13 +154,12 @@ export class Realtime {
     return this.agent.captures.get(`${name}.id`) as string
   }
 
-  private async consume (id: string, parts: any): Promise<void> {
+  private async consume(id: string, parts: any): Promise<void> {
     for await (const part of parts) {
       const text = Buffer.from(part.body).toString('utf8')
       const event = JSON.parse(text)
 
-      if (typeof event === 'string')
-        continue
+      if (typeof event === 'string') continue
 
       const tag = `${id}:${event.event}`
 
@@ -155,3 +170,6 @@ export class Realtime {
   }
 }
 
+/** How long the route is waited for, and how often it is asked for. */
+const DISCOVERY = 5000
+const POLL = 50

package/features/steps/Workspace.ts

@@ -7,12 +7,16 @@ import { overwrite } from '@toa.io/generic'
 export class Workspace {
   private root: string = devNull
 
-  public static exists (_0: unknown, _1: unknown, descriptor: PropertyDescriptor): PropertyDescriptor {
+  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)))
+      if (this.root === devNull)
+        this.root = await mkdtemp(join(tmpdir(), Math.random().toString(36).slice(2)))
 
       return method.apply(this, args)
     }
@@ -21,19 +25,18 @@ export class Workspace {
   }
 
   @Workspace.exists
-  public async addComponent (name: string, patch?: object): Promise<string> {
+  public async addComponent(name: string, patch?: object): Promise<string> {
     const source = join(import.meta.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)
+    if (patch !== undefined) await this.patchManifest(target, patch)
 
     return target
   }
 
-  private async patchManifest (target: string, patch: object): Promise<void> {
+  private async patchManifest(target: string, patch: object): Promise<void> {
     const path = join(target, 'manifest.toa.yaml')
 
     const manifest = load(await readFile(path, 'utf8')) as object

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

@@ -1,4 +1,4 @@
-export async function effect (input) {
+export async function effect(input) {
   await new Promise((resolve) => setTimeout(resolve, 500))
 
   return null

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

@@ -1,3 +1,3 @@
-export function effect (input) {
+export function effect(input) {
   return `Hello ${input.name}`
 }

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

@@ -1,3 +1,3 @@
-export function computation (input) {
+export function computation(input) {
   return `Hello ${input.name}`
 }

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

@@ -1,3 +1,3 @@
-export function computation (input) {
+export function computation(input) {
   return input
 }

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

@@ -1,4 +1,4 @@
-export function computation () {
+export function computation() {
   const err = { code: 'CODE', message: 'message' }
 
   Object.setPrototypeOf(err, Error.prototype)

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

@@ -1,3 +1,3 @@
-export function computation (input) {
+export function computation(input) {
   return input
 }

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

@@ -1,3 +1,3 @@
-export function computation (input) {
+export function computation(input) {
   return input
 }

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

@@ -1,3 +1,3 @@
-export function computation () {
+export function computation() {
   return 'pong'
 }

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

@@ -1,3 +1,3 @@
-export function computation (input) {
+export function computation(input) {
   return JSON.parse(input.buf)
 }

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

@@ -1,3 +1,3 @@
-export function computation () {
+export function computation() {
   return 'Hello'
 }

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

@@ -1,4 +1,4 @@
-export async function effect (input) {
+export async function effect(input) {
   await new Promise((resolve) => setTimeout(resolve, 800))
 
   return null

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

@@ -1,3 +1,3 @@
-export function computation (input) {
+export function computation(input) {
   return input.authority
 }

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

@@ -1,6 +1,6 @@
 import { setTimeout } from 'node:timers/promises'
 
-async function bar (input, context) {
+async function bar(input, context) {
   await setTimeout(10)
 
   return { bar: 'baz' }

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

@@ -1,6 +1,6 @@
 import { setTimeout } from 'node:timers/promises'
 
-async function baz (input, context) {
+async function baz(input, context) {
   await setTimeout(30)
 
   return input.steps ?? null

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

@@ -1,4 +1,4 @@
-function concat (input) {
+function concat(input) {
   return input.parameters.a + ' ' + input.parameters.b
 }
 

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

@@ -1,4 +1,4 @@
-function echo (input) {
+function echo(input) {
   return input
 }
 

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

@@ -1,6 +1,6 @@
 import { setTimeout } from 'node:timers/promises'
 
-async function err (_) {
+async function err(_) {
   await setTimeout(20)
 
   const err = Object.create(Error.prototype)

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

@@ -1,4 +1,4 @@
-async function foo (input, context) {
+async function foo(input, context) {
   return { foo: 'bar' }
 }
 

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

@@ -1,4 +1,4 @@
-function id (input) {
+function id(input) {
   return input.entry.id
 }
 

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

@@ -1,4 +1,4 @@
-function identity (input) {
+function identity(input) {
   return input.identity
 }
 

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

@@ -1,5 +1,7 @@
-function redirect (input) {
-  return input.parameters.type in urls ? { url: urls[input.parameters.type] } : ERR_UNKNOWN
+function redirect(input) {
+  return input.parameters.type in urls
+    ? { url: urls[input.parameters.type] }
+    : ERR_UNKNOWN
 }
 
 // an error a caller is meant to see carries a code, always
@@ -8,8 +10,8 @@ const ERR_UNKNOWN = new (class UnknownError extends Error {
 })()
 
 const urls = {
-  'rfc': 'https://www.rfc-editor.org/rfc/rfc9564.txt',
-  'img': 'https://www.w3.org/assets/logos/w3c/w3c-no-bars.svg'
+  rfc: 'https://www.rfc-editor.org/rfc/rfc9564.txt',
+  img: 'https://www.w3.org/assets/logos/w3c/w3c-no-bars.svg'
 }
 
 export { redirect as computation }

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

@@ -1,6 +1,6 @@
 import { setTimeout } from 'node:timers/promises'
 
-async function * effect (_) {
+async function* effect(_) {
   await setTimeout(10)
   yield 'hello'
 

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

@@ -1,6 +1,6 @@
 import { setTimeout } from 'node:timers/promises'
 
-async function * effect (_) {
+async function* effect(_) {
   await setTimeout(10)
   yield 'hello'
 

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

@@ -1,18 +1,16 @@
 name: orders
 
 entity:
-  schema:
-    properties:
-      title:
-        type: string
-      volume:
-        type: number
-      price:
-        type: number
-    type: object
-    required:
-      - title
-      - volume
+  properties:
+    title:
+      type: string
+    volume:
+      type: number
+    price:
+      type: number
+  required:
+    - title
+    - volume
 
 operations:
   create:

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

@@ -1,5 +1,7 @@
-export async function transition (input, object, context) {
-  const price = await context.remote.default.pricing.quote({ input: { volume: input.volume } })
+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 })
 }

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

@@ -1,26 +1,21 @@
 name: pots
 
 entity:
-  schema:
-    properties:
-      title:
-        type: string
-        maxLength: 64
-      volume:
-        type: number
-        exclusiveMinimum: 0
-        maximum: 1000
-      temperature:
-        type: number
-        exclusiveMinimum: 0
-        maximum: 300
-    type: object
-    required:
-      - title
-      - volume
-  index:
-    text:
-      title: text
+  properties:
+    title:
+      type: string
+      maxLength: 64
+    volume:
+      type: number
+      exclusiveMinimum: 0
+      maximum: 1000
+    temperature:
+      type: number
+      exclusiveMinimum: 0
+      maximum: 300
+  required:
+    - title
+    - volume
 
 operations:
   create:

package/features/steps/components/pots/migrations/0002-indexes.yaml

@@ -0,0 +1,4 @@
+- index:
+    name: index_text
+    keys:
+      title: text

package/features/steps/components/pricing/operations/quote.js

@@ -1,3 +1,3 @@
-export async function computation (input) {
+export async function computation(input) {
   return input.volume * 42
 }

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

@@ -4,7 +4,6 @@ operations:
   numbers:
     input:
       type: number
-      default: 5
 
 exposition:
   /tokens:

package/features/steps/components/sequences/operations/numbers.js

@@ -1,4 +1,4 @@
-function * effect (amount) {
+function* effect(amount) {
   for (let i = 0; i < amount; i++) yield i
 }
 

package/features/steps/components/sequences/operations/tokens.js

@@ -1,14 +1,14 @@
 import { randomBytes } from 'node:crypto'
 
-async function * computation () {
+async function* computation() {
   while (true) {
     await timeout(Math.floor(Math.random() * 100) + 10)
     yield randomBytes(4).toString('hex')
   }
 }
 
-function timeout (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
+function timeout(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms))
 }
 
 export { computation }

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

@@ -1,11 +1,9 @@
 name: users
 
 entity:
-  schema:
-    properties:
-      name:
-        type: string
-    type: object
+  properties:
+    name:
+      type: string
 
 operations:
   transit: