@toa.io/extensions.exposition 1.0.0-alpha.292 → 1.0.0-alpha.293

package/features/steps/Realtime.ts

@@ -1,175 +0,0 @@
-import { EventEmitter, once } from 'node:events'
-import * as assert from 'node:assert'
-import tsflow from 'cucumber-tsflow'
-
-import { Factory } from '@toa.io/extensions.realtime'
-import * as boot from '@toa.io/boot'
-import { environment, match, timeout } from '@toa.io/generic'
-import { load as parse } from 'js-yaml'
-import { Agent } from '@toa.io/agent'
-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
-  private readonly gateway: Gateway
-  private readonly agent: Agent
-  private readonly events = new EventEmitter()
-  private log: Record<string, unknown[]> = {}
-  private aborted = false
-
-  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> {
-    await Realtime.stop()
-
-    const annotation = parse(yaml) as Record<string, string>
-    const routes = []
-
-    for (const [event, property] of Object.entries(annotation))
-      routes.push({ event, properties: [property] })
-
-    environment.set('TOA_REALTIME', JSON.stringify(routes))
-
-    const factory = new Factory(boot.host())
-
-    Realtime.instance = await factory.service()
-
-    // not awaited: the routes connect to the components that produce the events, and this
-    // scenario starts the producer after the service, so the connection settles later
-    void Realtime.instance.connect()
-  }
-
-  @given('the identity {word} is consuming realtime events')
-  public async connect(name: string): Promise<void> {
-    await this.gateway.start()
-
-    const id = await this.createIdentity(name)
-
-    const parts = await this.open(name)
-
-    void this.consume(id, parts).catch((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> {
-    const id = this.agent.captures.get(`${name}.id`)
-    const tag = `${id}:${label}`
-    const expected = parse(yaml)
-
-    if (this.log[tag] !== undefined)
-      for (const data of this.log[tag])
-        // eslint-disable-next-line max-depth
-        if (match(data, expected)) return
-
-    const [event] = await once(this.events, tag)
-
-    assert.ok(match(event, expected), 'Event does not match')
-  }
-
-  @after()
-  public abort(): void {
-    this.aborted = true
-    this.agent.abort()
-    this.log = {}
-    this.events.removeAllListeners()
-  }
-
-  @afterAll()
-  public static async stop(): Promise<void> {
-    if (this.instance === null) return
-
-    await this.instance.disconnect()
-
-    this.instance = null
-    environment.delete('TOA_REALTIME')
-  }
-
-  /**
-   * 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)
-
-    await this.agent.request(`
-      POST /identity/basic/ HTTP/1.1
-      accept: application/yaml
-      content-type: application/yaml
-
-      username: ${username}
-      password: ${password}
-    `)
-
-    this.agent.responseIncludes(`
-      201 Created
-    `)
-
-    const credentials = Buffer.from(`${username}:${password}`).toString('base64')
-
-    await this.agent.request(`
-      GET /identity/ HTTP/1.1
-      authorization: Basic ${credentials}
-      accept: application/yaml
-    `)
-
-    this.agent.responseIncludes(`
-      200 OK
-      authorization: Token \${{ ${name}.token }}
-
-      id: \${{ ${name}.id }}
-    `)
-
-    return this.agent.captures.get(`${name}.id`) as string
-  }
-
-  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
-
-      const tag = `${id}:${event.event}`
-
-      this.events.emit(tag, event.data)
-      this.log[tag] ??= []
-      this.log[tag].push(event.data)
-    }
-  }
-}
-
-/** 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

@@ -1,48 +0,0 @@
-import { join } from 'node:path'
-import { tmpdir, devNull } from 'node:os'
-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
-
-  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(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)
-
-    return target
-  }
-
-  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
-
-    overwrite(manifest, patch)
-
-    await writeFile(path, dump(manifest, { noRefs: true, lineWidth: -1 }), 'utf8')
-  }
-}

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

@@ -1,20 +0,0 @@
-name: audit
-
-operations:
-  record:
-    input:
-      properties:
-        id:
-          type: string
-        title:
-          type: string
-        volume:
-          type: number
-        price:
-          type: number
-      type: object
-    output:
-      {}
-
-receivers:
-  orders.created: record

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

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

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

@@ -1,59 +0,0 @@
-name: echo
-
-operations:
-  compute:
-    input:
-      properties:
-        name:
-          type: string
-      type: object
-      required:
-        - name
-  affect:
-    input:
-      properties:
-        name:
-          type: string
-      type: object
-      required:
-        - name
-  identity:
-    input:
-      properties:
-        identity:
-          properties:
-            id:
-              type: string
-            roles:
-              type: array
-              items:
-                type: string
-          type: object
-      type: object
-  parameters:
-    description: Answers with what it was given.
-    input:
-      type: object
-      properties:
-        a:
-          type: string
-        b:
-          type: string
-    output:
-      type: object
-      properties:
-        a:
-          type: string
-        b:
-          type: string
-  echo:
-    input:
-      type: object
-  unwrap:
-    input:
-      type: object
-      properties:
-        buf:
-          type: string
-  error:
-    errors: [CODE]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,2 +0,0 @@
-namespace: echo
-name: beacon

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

@@ -1,3 +0,0 @@
-export const computation = () => {
-  return 'Hello!'
-}

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

@@ -1,5 +0,0 @@
-name: greeter
-
-exposition:
-  /:
-    GET: greet

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

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

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

@@ -1,20 +0,0 @@
-name: notify
-
-operations:
-  send:
-    input:
-      properties:
-        id:
-          type: string
-        title:
-          type: string
-        volume:
-          type: number
-        price:
-          type: number
-      type: object
-    output:
-      {}
-
-receivers:
-  orders.created: send

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

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

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

@@ -1,73 +0,0 @@
-namespace: octets
-name: tester
-
-storages: octets
-
-operations:
-  foo: &operation
-    errors: [ERROR, NOT_FOUND]
-    input:
-      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
-  id: *operation
-  echo: *operation
-  concat: *operation
-  yield: *operation
-  yex: *operation
-  authority: *operation
-  identity: *operation
-  redirect:
-    errors: [ERROR]
-    input:
-      properties:
-        parameters:
-          type: object
-          patternProperties:
-            ^.+$:
-              type: string
-        authority:
-          type: string
-        path:
-          type: string
-      type: object
-      required:
-        - authority
-        - path
-    output:
-      type: object
-      properties:
-        url:
-          type: string
-        options:
-          type: object
-          properties:
-            method:
-              type: string
-            headers:
-              type: object
-            body:
-              type: string
-      required:
-        - url

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

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

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

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

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

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

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

@@ -1,5 +0,0 @@
-function concat(input) {
-  return input.parameters.a + ' ' + input.parameters.b
-}
-
-export { concat as computation }

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

@@ -1,5 +0,0 @@
-function echo(input) {
-  return input
-}
-
-export { echo as computation }

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

@@ -1,14 +0,0 @@
-import { setTimeout } from 'node:timers/promises'
-
-async function err(_) {
-  await setTimeout(20)
-
-  const err = Object.create(Error.prototype)
-
-  err.code = 'ERROR'
-  err.message = 'Something went wrong'
-
-  return err
-}
-
-export { err as effect }

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

@@ -1,5 +0,0 @@
-async function foo(input, context) {
-  return { foo: 'bar' }
-}
-
-export { foo as effect }

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

@@ -1,5 +0,0 @@
-function id(input) {
-  return input.entry.id
-}
-
-export { id as computation }

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

@@ -1,5 +0,0 @@
-function identity(input) {
-  return input.identity
-}
-
-export { identity as computation }

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

@@ -1,17 +0,0 @@
-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
-const ERR_UNKNOWN = new (class UnknownError extends Error {
-  code = 'ERROR'
-})()
-
-const urls = {
-  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,14 +0,0 @@
-import { setTimeout } from 'node:timers/promises'
-
-async function* effect(_) {
-  await setTimeout(10)
-  yield 'hello'
-
-  await setTimeout(10)
-  yield 'world'
-
-  await setTimeout(10)
-  throw new Error('Oops!')
-}
-
-export { effect }

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

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

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

@@ -1,30 +0,0 @@
-name: orders
-
-entity:
-  properties:
-    title:
-      type: string
-    volume:
-      type: number
-    price:
-      type: number
-  required:
-    - title
-    - volume
-
-operations:
-  create:
-    concurrency: retry
-    query: false
-    input:
-      properties:
-        title:
-          type: string
-          default: .
-        volume:
-          type: string
-          default: .
-      type: object
-      required:
-        - title
-        - volume

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

@@ -1,7 +0,0 @@
-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 })
-}