@toa.io/extensions.exposition 1.0.0-alpha.28 → 1.0.0-alpha.283

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

@@ -1,12 +1,9 @@
-'use strict'
-
 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' }
 }
 
-exports.effect = bar
+export { bar as effect }

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

@@ -1,11 +1,9 @@
-'use strict'
-
 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
+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.entry.id
+  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'
-
-function foo (input, context) {
-  return context.storages.octets.annotate(input.path, 'foo', 'bar')
+async function foo (input, context) {
+  return { foo: 'bar' }
 }
 
-exports.effect = foo
+export { foo as effect }

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

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

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

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

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

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

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

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

@@ -0,0 +1,32 @@
+name: orders
+
+entity:
+  schema:
+    properties:
+      title:
+        type: string
+      volume:
+        type: number
+      price:
+        type: number
+    type: object
+    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

@@ -0,0 +1,5 @@
+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,29 +1,94 @@
 name: pots
-version: 0.0.0
 
 entity:
   schema:
-    title: string
-    volume: number
-    temperature?: number
+    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
 
 operations:
   create:
     query: false
     forward: transit
     input:
-      title*: .
-      volume*: .
-      temperature: .
+      properties:
+        temperature:
+          type: string
+          default: .
+        title:
+          type: string
+          default: .
+        volume:
+          type: string
+          default: .
+      type: object
+      required:
+        - title
+        - volume
+    errors:
+      - NO_WAY
+      - WONT_CREATE
   transit:
     concurrency: retry
     input:
-      title: .
-      volume: .
-      temperature: .
+      properties:
+        title:
+          type: string
+          default: .
+        volume:
+          type: string
+          default: .
+        temperature:
+          type: string
+          default: .
+      type: object
   observe:
     output:
-      id: string
-      title: string
-      volume: number
-      temperature: number
+      properties:
+        id:
+          type: string
+        title:
+          type: string
+        volume:
+          type: number
+        temperature:
+          type: number
+      type: object
+  enumerate:
+    output:
+      type: array
+      items:
+        properties:
+          id:
+            type: string
+            default: .
+          title:
+            type: string
+            default: .
+          volume:
+            type: string
+            default: .
+          temperature:
+            type: string
+            default: .
+        type: object
+        required:
+          - id
+          - title
+          - volume

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

@@ -0,0 +1,13 @@
+name: pricing
+
+operations:
+  quote:
+    input:
+      properties:
+        volume:
+          type: number
+      type: object
+      required:
+        - volume
+    output:
+      type: number

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

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

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

@@ -1,9 +1,10 @@
 name: sequences
-version: 0.0.0
 
 operations:
   numbers:
-    input: 5
+    input:
+      type: number
+      default: 5
 
 exposition:
   /tokens:

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

@@ -1,7 +1,5 @@
-'use strict'
-
 function * effect (amount) {
   for (let i = 0; i < amount; i++) yield i
 }
 
-exports.effect = effect
+export { effect }

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

@@ -1,6 +1,4 @@
-'use strict'
-
-const { randomBytes } = require('node:crypto')
+import { randomBytes } from 'node:crypto'
 
 async function * computation () {
   while (true) {
@@ -13,4 +11,4 @@ function timeout (ms) {
   return new Promise(resolve => setTimeout(resolve, ms))
 }
 
-exports.computation = computation
+export { computation }

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

@@ -2,13 +2,31 @@ name: users
 
 entity:
   schema:
-    name: string
+    properties:
+      name:
+        type: string
+    type: object
 
 operations:
   transit:
     concurrency: retry
     input:
-      name*: ~
+      properties:
+        name:
+          type: string
+          default: .
+      type: object
+      required:
+        - name
   create:
+    concurrency: retry
     query: false
-    forward: transit
+    errors: [0]
+    input:
+      properties:
+        name:
+          type: string
+          default: .
+      type: object
+      required:
+        - name

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

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

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

@@ -1,14 +1,23 @@
 namespace: users
 name: properties
-version: 0.0.0
 
 entity:
   schema:
-    newbie: false
+    properties:
+      newbie:
+        type: boolean
+        default: false
+    type: object
   associated: true
 
 operations:
   transit:
     concurrency: retry
     input:
-      newbie*: .
+      properties:
+        newbie:
+          type: string
+          default: .
+      type: object
+      required:
+        - newbie

package/features/steps/map.ts

@@ -0,0 +1,30 @@
+import { createRequire } from 'node:module'
+import * as norm from '@toa.io/norm'
+import { dirname, join } from 'node:path'
+import type { Manifest } from '@toa.io/norm'
+
+const require = createRequire(import.meta.url)
+
+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 } = norm as unknown 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
+      """