@toa.io/extensions.exposition 1.0.0-alpha.27 → 1.0.0-alpha.270

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

@@ -0,0 +1,13 @@
+name: audit
+
+operations:
+  record:
+    input:
+      id: string
+      title: string
+      volume: number
+      price: number
+    output: undefined
+
+receivers:
+  orders.created: record

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

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

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

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

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/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/operations/unwrap.js

@@ -0,0 +1,7 @@
+'use strict'
+
+function computation (input) {
+  return JSON.parse(input.buf)
+}
+
+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/greeter/manifest.toa.yaml

@@ -1,5 +1,4 @@
 name: greeter
-version: 0.0.0
 
 exposition:
   /:

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

@@ -0,0 +1,13 @@
+name: notify
+
+operations:
+  send:
+    input:
+      id: string
+      title: string
+      volume: number
+      price: number
+    output: undefined
+
+receivers:
+  orders.created: send

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

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

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

@@ -1,19 +1,42 @@
 namespace: octets
 name: tester
-version: 0.0.0
 
 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/orders/manifest.toa.yaml

@@ -0,0 +1,15 @@
+name: orders
+
+entity:
+  schema:
+    title: string
+    volume: number
+    price?: number
+
+operations:
+  create:
+    concurrency: retry
+    query: false
+    input:
+      title*: .
+      volume*: .

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

@@ -0,0 +1,9 @@
+'use strict'
+
+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

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

@@ -1,11 +1,13 @@
 name: pots
-version: 0.0.0
 
 entity:
   schema:
-    title: string
-    volume: number
-    temperature?: number
+    title: string(64)
+    volume: number(0, 1000]
+    temperature?: number(0, 300]
+  index:
+    text:
+      title: text
 
 operations:
   create:
@@ -15,6 +17,9 @@ operations:
       title*: .
       volume*: .
       temperature: .
+    errors:
+      - NO_WAY
+      - WONT_CREATE
   transit:
     concurrency: retry
     input:
@@ -27,3 +32,9 @@ operations:
       title: string
       volume: number
       temperature: number
+  enumerate:
+    output:
+      - id: .
+        title: .
+        volume: .
+        temperature?: .

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

@@ -0,0 +1,7 @@
+name: pricing
+
+operations:
+  quote:
+    input:
+      volume*: number
+    output: number

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

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

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

@@ -1,5 +1,4 @@
 name: sequences
-version: 0.0.0
 
 operations:
   numbers:

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

@@ -1,6 +1,5 @@
 namespace: users
 name: properties
-version: 0.0.0
 
 entity:
   schema:

package/features/steps/map.ts

@@ -0,0 +1,26 @@
+import { dirname, join } from 'node:path'
+import type { Manifest } from '@toa.io/norm'
+
+const PACKAGE = '@toa.io/extensions.introspection'
+const COMPONENTS = ['introspection.nodes', 'introspection.edges']
+
+/**
+ * The map's own components, as the introspection package ships them. Mounted rather
+ * than copied on purpose: a scenario about a manifest must read that manifest.
+ */
+export function components (): string[] {
+  const root = dirname(require.resolve(PACKAGE + '/package.json'))
+
+  return COMPONENTS.map((name) => join(root, 'components', name))
+}
+
+/** `norm` declares `component` as a namespace of types; the runtime export is a function. */
+export async function manifests (): Promise<Manifest[]> {
+  const { component } = require('@toa.io/norm') as Norm
+
+  return await Promise.all(components().map(async (path) => await component(path)))
+}
+
+interface Norm {
+  component: (path: string) => Promise<Manifest>
+}

package/features/streams.feature

@@ -21,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
+      """

package/features/timing.feature

@@ -8,26 +8,7 @@ Feature: Server timing
           POST: create
       """
 
-  Scenario: Server timing is not available by default
-    When the following request is received:
-      """
-      POST /pots/ HTTP/1.1
-      host: nex.toa.io
-      content-type: application/yaml
-
-      title: Hello
-      volume: 1.5
-      """
-    Then the reply does not contain:
-      """
-      server-timing:
-      """
-
-  Scenario: Server timing is sent when `trace` is enabled
-    Given the annotation:
-      """
-      trace: true
-      """
+  Scenario: Server timing is sent
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
@@ -47,13 +28,12 @@ Feature: Server timing
   Scenario: Octets timing
     Given the annotation:
       """yaml
-      trace: true
       /:
         io:output: true
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
+          octets:put: ~
       """
     When the stream of `lenna.png` is received with the following headers:
       """

package/features/tracing.feature

@@ -0,0 +1,123 @@
+Feature: Distributed tracing
+
+  Background:
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          POST: create
+      """
+
+  Scenario: Response carries the `ray` header
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      ray:
+      """
+
+  Scenario: Trace is continued from the `traceparent` request header
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      traceparent: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      ray: 0af7651916cd43dd8448eb211c80319c
+      """
+
+  Scenario: Trace is continued from the `ray` request header
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      ray: 4bf92f3577b34da6a3ce929d0e0e4736
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      ray: 4bf92f3577b34da6a3ce929d0e0e4736
+      """
+
+  Scenario: Trace spans remote calls, storage and events
+    Given the `identity.basic` database is empty
+    And the `pricing` is running
+    And the `orders` is running with the following manifest:
+      """yaml
+      exposition:
+        /:id:
+          auth:id: id
+          POST: create
+      """
+    And the `audit` is running
+    And the `notify` is running
+    When the following request is received:
+      """
+      POST /identity/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic dXNlcjpwYXNzMTIzNA==
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      authorization: Token ${{ token }}
+
+      id: ${{ id }}
+      roles: []
+      """
+    When the following request is received:
+      """
+      POST /orders/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ token }}
+      content-type: application/yaml
+
+      title: Kettle
+      volume: 2
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      ray:
+      """
+
+  Scenario: Invalid `traceparent` starts a new trace
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      traceparent: not-a-valid-traceparent
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      ray:
+      """
+    And the reply does not contain:
+      """
+      ray: 0af7651916cd43dd8448eb211c80319c
+      """