@toa.io/extensions.exposition 1.0.0-alpha.2 → 1.0.0-alpha.200

package/features/steps/Parameters.ts

@@ -1,6 +1,11 @@
+import { join } from 'node:path'
+import * as dotenv from 'dotenv'
 import { setDefaultTimeout } from '@cucumber/cucumber'
+import { console } from 'openspan'
 import { encode } from '@toa.io/generic'
 
+dotenv.config({ path: join(__dirname, '.env') })
+
 export class Parameters {
   public readonly origin: string
 
@@ -9,13 +14,94 @@ export class Parameters {
   }
 }
 
-setDefaultTimeout(30 * 1000)
+setDefaultTimeout(60 * 1000)
+
+console.configure({ format: 'terminal' })
 
 process.env.TOA_DEV = '1'
 
 process.env.TOA_STORAGES = encode({
   octets: {
     provider: 'tmp',
-    directory: 'exposition'
+    directory: Math.random().toString(36).substring(2)
+  },
+  cloudinary: {
+    provider: 'cloudinary',
+    environment: process.env.CLOUDINARY_ENVIRONMENT ?? 'nope',
+    type: 'image',
+    prefix: 'toa-dev',
+    transformations: [
+      {
+        extension: 'icon',
+        transformation: [{
+          width: 48,
+          height: 48,
+          crop: 'fill'
+        }, {
+          border: '10px_solid_white'
+        }],
+        optional: true
+      },
+      {
+        extension: '(?<width>\\d*)x(?<height>\\d*)(z(?<zoom>\\d*))?',
+        transformation: {
+          width: '<width>',
+          height: '<height>',
+          zoom: '<zoom>',
+          crop: 'thumb',
+          gravity: 'face'
+        },
+        optional: true
+      },
+      {
+        extension: '\\[(?<width>\\d*)x(?<height>\\d*)\\](z(?<zoom>\\d+))?',
+        transformation: {
+          width: '<width>',
+          height: '<height>',
+          zoom: '<zoom>',
+          crop: 'fit'
+        },
+        optional: true
+      },
+      {
+        extension: '(?<format>jpeg|webp)',
+        transformation: {
+          fetch_format: '<format>'
+        },
+        optional: true
+      }
+    ]
+  },
+  cloudinary_video: {
+    provider: 'cloudinary',
+    environment: process.env.CLOUDINARY_ENVIRONMENT ?? 'nope',
+    type: 'video',
+    prefix: 'toa-dev',
+    eager: [
+      {
+        width: 200,
+        height: 200,
+        crop: 'fill'
+      }
+    ],
+    transformations: [
+      {
+        extension: '200x200',
+        transformation: {
+          width: 200,
+          height: 200,
+          crop: 'fill'
+        },
+        optional: true
+      },
+      {
+        extension: '(?<format>mp4|gif)',
+        transformation: {
+          quality: 'auto',
+          fetch_format: '<format>'
+        },
+        optional: true
+      }
+    ]
   }
 })

package/features/steps/Realtime.ts

@@ -0,0 +1,151 @@
+import { EventEmitter, once } from 'node:events'
+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 { Agent } from '@toa.io/agent'
+import { Parameters } from './Parameters'
+import { Gateway } from './Gateway'
+import { Captures } from './Captures'
+import type { Connector } from '@toa.io/core'
+
+@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)
+    const routes = []
+
+    for (const [event, property] of Object.entries(annotation))
+      routes.push({ event, properties: [property] })
+
+    process.env.TOA_REALTIME = encode(routes)
+
+    const factory = new Factory(boot)
+
+    Realtime.instance = factory.service()
+
+    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.agent.parts(`
+      GET /realtime/streams/\${{ ${name}.id }}/ HTTP/1.1
+      authorization: Token \${{ ${name}.token }}
+      accept: application/json
+    `) as AsyncIterable<Uint8Array>
+
+    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
+    process.env.TOA_REALTIME = undefined
+  }
+
+  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)
+    }
+  }
+}

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

@@ -7,3 +7,20 @@ operations:
   affect:
     input:
       name*: string
+  identity:
+    input:
+      identity:
+        id: string
+        roles: [string]
+  parameters:
+    input: &parameters
+      type: object
+      properties:
+        a:
+          type: string
+        b:
+          type: string
+    output: *parameters
+  echo:
+    input:
+      type: object

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -6,13 +6,37 @@ storages: octets
 operations:
   foo: &operation
     input:
+      authority*: string
+      identity: string
       storage*: string
       path*: string
-      entry: object
+      entry*: object
       parameters: object
+      steps: object
   bar: *operation
   baz: *operation
   err: *operation
+  id: *operation
   echo: *operation
   concat: *operation
-  diversify: *operation
+  yield: *operation
+  yex: *operation
+  authority: *operation
+  identity: *operation
+  redirect:
+    input:
+      authority*: string
+      path*: string
+      parameters: <string>
+    output:
+      type: object
+      properties:
+        url: string
+        options:
+          type: object
+          properties:
+            method: string
+            headers: object
+            body: string
+      required:
+        - url

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

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

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

@@ -4,7 +4,6 @@ import { setTimeout } from 'node:timers/promises'
 
 async function bar (input, context) {
   await setTimeout(10)
-  await context.storages.octets.annotate(input.path, 'bar', 'baz')
 
   return { bar: 'baz' }
 }

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

@@ -5,7 +5,7 @@ import { setTimeout } from 'node:timers/promises'
 async function baz (input, context) {
   await setTimeout(30)
 
-  return context.storages.octets.annotate(input.path, 'baz', 'qux')
+  return input.steps ?? null
 }
 
 exports.effect = baz

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

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

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

@@ -1,7 +1,7 @@
 'use strict'
 
-function foo (input, context) {
-  return context.storages.octets.annotate(input.path, 'foo', 'bar')
+async function foo (input, context) {
+  return { foo: 'bar' }
 }
 
 exports.effect = foo

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

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

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

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

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

@@ -0,0 +1,12 @@
+'use strict'
+
+function redirect (input) {
+  return input.parameters.type in urls ? { url: urls[input.parameters.type] } : new Error()
+}
+
+const urls = {
+  'rfc': 'https://www.rfc-editor.org/rfc/rfc9564.txt',
+  'img': 'https://www.w3.org/assets/logos/w3c/w3c-no-bars.svg'
+}
+
+exports.computation = redirect

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

@@ -0,0 +1,16 @@
+'use strict'
+
+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!')
+}
+
+exports.effect = effect

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

@@ -0,0 +1,13 @@
+'use strict'
+
+import { setTimeout } from 'node:timers/promises'
+
+async function * effect (_) {
+  await setTimeout(10)
+  yield 'hello'
+
+  await setTimeout(10)
+  yield 'world'
+}
+
+exports.effect = effect

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

@@ -2,19 +2,39 @@ name: pots
 
 entity:
   schema:
-    title: string
-    volume: number
-    temperature?: number
+    title: string(64)
+    volume: number(0, 1000]
+    temperature?: number(0, 300]
+  index:
+    text:
+      title: text
 
 operations:
-  transit:
+  create:
     query: false
+    forward: transit
+    input:
+      title*: .
+      volume*: .
+      temperature: .
+    errors:
+      - NO_WAY
+      - WONT_CREATE
+  transit:
+    concurrency: retry
     input:
-      title*: ~
-      volume*: ~
+      title: .
+      volume: .
+      temperature: .
   observe:
     output:
       id: string
       title: string
       volume: number
       temperature: number
+  enumerate:
+    output:
+      - id: .
+        title: .
+        volume: .
+        temperature?: .

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

@@ -8,7 +8,9 @@ operations:
   transit:
     concurrency: retry
     input:
-      name*: ~
+      name*: .
   create:
+    concurrency: retry
     query: false
-    forward: transit
+    input:
+      name*: .

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

@@ -0,0 +1,15 @@
+'use strict'
+
+function transition (input, object) {
+  if (input.name === 'return_error') {
+    const e = new Error()
+
+    e.code = 0
+
+    return e
+  }
+
+  return Object.assign(object, input)
+}
+
+exports.transition = transition

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

@@ -4,7 +4,7 @@ name: properties
 entity:
   schema:
     newbie: false
-  dependent: true
+  associated: true
 
 operations:
   transit:

package/features/streams.feature

@@ -10,6 +10,7 @@ Feature: Reply streams
     When the following request is received:
       """
       POST /sequences/ HTTP/1.1
+      host: nex.toa.io
       content-type: text/plain
       accept: text/plain
 
@@ -20,11 +21,15 @@ Feature: Reply streams
       201 Created
       content-type: multipart/text; boundary=cut
 
+      --cut
+      ACK
       --cut
       0
       --cut
       1
       --cut
       2
+      --cut
+      FIN
       --cut--
       """

package/features/timestamps.feature

@@ -0,0 +1,41 @@
+Feature: Entity timestamp
+
+  Scenario: Last-Modified
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          POST: create
+          /:id:
+            GET: observe
+            PUT: transit
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      last-modified: #{{ utc | set created }}
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      HEAD /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      last-modified: ${{ created }}
+      content-length: 149
+      """