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

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

@@ -1,91 +0,0 @@
-name: pots
-
-entity:
-  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:
-    description: Put a pot on to brew.
-    query: false
-    forward: transit
-    input:
-      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:
-      properties:
-        title:
-          type: string
-          default: .
-        volume:
-          type: string
-          default: .
-        temperature:
-          type: string
-          default: .
-      type: object
-  observe:
-    output:
-      properties:
-        id:
-          type: string
-        title:
-          type: string
-        volume:
-          type: number
-        temperature:
-          type: number
-      type: object
-  enumerate:
-    description: Every pot there is.
-    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/pots/migrations/0002-indexes.yaml

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

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

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

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

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

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

@@ -1,11 +0,0 @@
-name: sequences
-
-operations:
-  numbers:
-    input:
-      type: number
-
-exposition:
-  /tokens:
-    anonymous: true
-    GET: tokens

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

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

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

@@ -1,14 +0,0 @@
-import { randomBytes } from 'node:crypto'
-
-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))
-}
-
-export { computation }

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

@@ -1,30 +0,0 @@
-name: users
-
-entity:
-  properties:
-    name:
-      type: string
-
-operations:
-  transit:
-    concurrency: retry
-    input:
-      properties:
-        name:
-          type: string
-          default: .
-      type: object
-      required:
-        - name
-  create:
-    concurrency: retry
-    query: false
-    errors: [0]
-    input:
-      properties:
-        name:
-          type: string
-          default: .
-      type: object
-      required:
-        - name

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

@@ -1,11 +0,0 @@
-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,22 +0,0 @@
-namespace: users
-name: properties
-
-entity:
-  associated: true
-  properties:
-    newbie:
-      type: boolean
-  blank:
-    newbie: false
-
-operations:
-  transit:
-    concurrency: retry
-    input:
-      properties:
-        newbie:
-          type: string
-          default: .
-      type: object
-      required:
-        - newbie

package/features/steps/map.ts

@@ -1,30 +0,0 @@
-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/steps/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "noEmit": true,
-    "moduleResolution": "node",
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  }
-}

package/features/streams.feature

@@ -1,35 +0,0 @@
-Feature: Reply streams
-
-  Scenario: Getting a Reply stream
-    Given the `sequences` is running with the following manifest:
-      """yaml
-      exposition:
-        /:
-          POST: numbers
-      """
-    When the following request is received:
-      """
-      POST /sequences/ HTTP/1.1
-      host: nex.toa.io
-      content-type: text/plain
-      accept: text/plain
-
-      3
-      """
-    Then the following reply is sent:
-      """
-      201 Created
-      content-type: multipart/text; boundary=cut
-
-      --cut
-      ACK
-      --cut
-      0
-      --cut
-      1
-      --cut
-      2
-      --cut
-      FIN
-      --cut--
-      """

package/features/timestamps.feature

@@ -1,41 +0,0 @@
-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: 145
-      """

package/features/timing.feature

@@ -1,49 +0,0 @@
-Feature: Server timing
-
-  Background:
-    Given the `pots` is running with the following manifest:
-      """yaml
-      exposition:
-        /:
-          POST: create
-      """
-
-  Scenario: Server timing is sent
-    When the following request is received:
-      """
-      POST /pots/ HTTP/1.1
-      host: nex.toa.io
-      content-type: application/yaml
-
-      title: Hello
-      volume: 1.5
-      """
-    # to debug, break it and look at the console
-    Then the following reply is sent:
-      """
-      201 Created
-      server-timing:
-      """
-
-  Scenario: Octets timing
-    Given the annotation:
-      """yaml
-      /:
-        io:output: true
-        auth:anonymous: true
-        octets:context: octets
-        POST:
-          octets:put: ~
-      """
-    When the stream of `lenna.png` is received with the following headers:
-      """
-      POST / HTTP/1.1
-      host: nex.toa.io
-      content-type: application/octet-stream
-      """
-    # to debug, break it and look at the console
-    Then the following reply is sent:
-      """
-      201 Created
-      server-timing:
-      """

package/features/tracing.feature

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

package/source/Branch.test.ts

@@ -1,40 +0,0 @@
-import { it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import { decide } from './Branch.js'
-import type { Branch, Exposed } from './Branch.js'
-
-function branch(version: string, timestamp: number): Branch {
-  return {
-    namespace: 'default',
-    component: 'one',
-    isolated: false,
-    node: { routes: [], methods: [], directives: [] },
-    version,
-    timestamp
-  }
-}
-
-function exposed(version: string, timestamp: number): Exposed {
-  return { version, timestamp, nodes: [] }
-}
-
-it('should refresh the same version', () => {
-  assert.deepStrictEqual(decide(exposed('a', 1), branch('a', 2)), 'refresh')
-})
-
-it('should refresh the same version announced by an older tenant', () => {
-  assert.deepStrictEqual(decide(exposed('a', 2), branch('a', 1)), 'refresh')
-})
-
-it('should merge a newer tenant', () => {
-  assert.deepStrictEqual(decide(exposed('a', 1), branch('b', 2)), 'merge')
-})
-
-it('should not merge a tenant that started earlier', () => {
-  assert.deepStrictEqual(decide(exposed('b', 2), branch('a', 1)), 'superseded')
-})
-
-it('should merge when tenants started at the same time', () => {
-  assert.deepStrictEqual(decide(exposed('a', 1), branch('b', 1)), 'merge')
-})

package/source/Branch.ts

@@ -1,44 +0,0 @@
-import type * as RTD from './RTD/syntax/index.js'
-import type { Node } from './RTD/index.js'
-
-export interface Branch {
-  namespace: string
-  component: string
-  isolated: boolean
-  node: RTD.Node
-  version: string
-
-  /**
-   * When the tenant that announced it started, by its own clock. A replica on its way
-   * out announces the same component with an older stamp than the one replacing it, and
-   * that is what tells the two apart when their versions differ.
-   */
-  timestamp: number
-}
-
-/** A branch the gateway has merged, and the tenant it came from. */
-export interface Exposed {
-  version: string
-
-  /** The start time of the tenant this branch came from. */
-  timestamp: number
-
-  nodes: Node[]
-}
-
-/**
- * What to do with an announcement about a component that already has a branch exposed.
- *
- * - `refresh`: the same version, so its expiration is extended and its endpoints left alone
- * - `superseded`: it came from a tenant that started before the one exposed now
- * - `merge`: everything else
- */
-export function decide(exposed: Exposed, branch: Branch): Decision {
-  if (exposed.version === branch.version) return 'refresh'
-
-  if (branch.timestamp < exposed.timestamp) return 'superseded'
-
-  return 'merge'
-}
-
-export type Decision = 'merge' | 'refresh' | 'superseded'

package/source/Composition.ts

@@ -1,51 +0,0 @@
-import { readdirSync, type Dirent } from 'node:fs'
-import { resolve } from 'node:path'
-import { Connector } from '@toa.io/core'
-import { type Host } from './Factory.js'
-
-export class Composition extends Connector {
-  private readonly host: Host
-
-  public constructor(host: Host) {
-    super()
-    this.host = host
-  }
-
-  protected override async open(): Promise<void> {
-    const paths = find()
-    const composition = await this.host.composition(paths)
-
-    await composition.connect()
-
-    this.depends(composition)
-  }
-}
-
-function find(): string[] {
-  return entries().map((entry) => resolve(ROOT, entry.name))
-}
-
-function entries(): Dirent[] {
-  const entries = readdirSync(ROOT, { withFileTypes: true })
-
-  return entries.filter((entry) => entry.isDirectory())
-}
-
-export function components(): Components {
-  const labels: string[] = []
-  const paths: string[] = []
-
-  for (const entry of entries()) {
-    labels.push(entry.name.replace('.', '-'))
-    paths.push(resolve(ROOT, entry.name))
-  }
-
-  return { labels, paths }
-}
-
-interface Components {
-  labels: string[]
-  paths: string[]
-}
-
-const ROOT = resolve(import.meta.dirname, '../components/')

package/source/Context.ts

@@ -1,11 +0,0 @@
-import type * as RTD from './RTD/index.js'
-
-// the trunk is built from the context annotation and belongs to no branch,
-// thus its endpoints must be fully qualified and are not versioned
-export type Context = RTD.Context<Extension | undefined>
-
-interface Extension {
-  namespace: string
-  component: string
-  version: string
-}