@toa.io/extensions.exposition 0.20.0-alpha.1 → 0.20.0-alpha.2

package/features/streams.feature

@@ -0,0 +1,26 @@
+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
+      content-type: text/plain
+      accept: text/plain
+
+      3
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      transfer-encoding: chunked
+
+      0
+      1
+      2
+      """

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.exposition",
-  "version": "0.20.0-alpha.1",
+  "version": "0.20.0-alpha.2",
   "description": "Toa Exposition",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -20,10 +20,11 @@
     "nopeable": "*"
   },
   "dependencies": {
-    "@toa.io/core": "0.20.0-alpha.1",
-    "@toa.io/generic": "0.20.0-alpha.1",
-    "@toa.io/http": "0.20.0-alpha.1",
-    "@toa.io/schemas": "0.20.0-alpha.1",
+    "@toa.io/core": "0.20.0-alpha.2",
+    "@toa.io/generic": "0.20.0-alpha.2",
+    "@toa.io/http": "0.20.0-alpha.2",
+    "@toa.io/schemas": "0.20.0-alpha.2",
+    "@toa.io/streams": "0.1.0-alpha.2",
     "bcryptjs": "2.4.3",
     "cors": "2.8.5",
     "express": "4.18.2",
@@ -46,5 +47,5 @@
     "@types/express": "4.17.17",
     "@types/negotiator": "0.6.1"
   },
-  "gitHead": "d1a5369c0ee4ee423f792b83e9753fd2fd943cce"
+  "gitHead": "d6e8c5bdae26e2beb66f4d7f37f71a3494fe9fcb"
 }

package/readme.md

@@ -163,6 +163,7 @@ exposition:
   host: the.example.com
   host@staging: the.example.dev
   class: alb
+  debug@staging: true
   annotations:
     alb.ingress.kubernetes.io/scheme: internet-facing
     alb.ingress.kubernetes.io/target-type: ip
@@ -178,4 +179,5 @@ exposition:
 - [Resource Tree Definition](documentation/tree.md)
 - [Identity authentication](documentation/identity.md)
 - [Access authorization](documentation/access.md)
+- [Components and resources](documentation/components.md)
 - [Features](features)

package/schemas/annotation.cos.yaml

@@ -1,4 +1,5 @@
-host?: string
-class?: string
-annotations?: <string>
-/?: ref:node
+host: string
+class: string
+annotations: <string>
+debug: boolean
+/: ~

package/schemas/method.cos.yaml

@@ -5,5 +5,4 @@ mapping:
   endpoint: string
   query:
     $ref: query
-    default: { }
 directives: [ref:directive]

package/schemas/query.cos.yaml

@@ -1,3 +1,4 @@
+_: true
 id?: string
 criteria?: string
 sort?: string

package/source/Annotation.ts

@@ -2,5 +2,6 @@ export interface Annotation {
   host?: string
   class?: string
   annotations?: Record<string, string>
+  debug: boolean
   '/'?: object // parsed and validated by RTD.syntax.parse
 }

package/source/Composition.ts

@@ -1,6 +1,5 @@
-import { readdirSync } from 'node:fs'
+import { readdirSync, type Dirent } from 'node:fs'
 import { resolve } from 'node:path'
-import { type Dirent } from 'fs'
 import { Connector } from '@toa.io/core'
 import { type Bootloader } from './Factory'
 

package/source/Endpoint.ts

@@ -28,11 +28,11 @@ export class Endpoint implements RTD.Endpoint<Endpoint> {
   public async close (): Promise<void> {
     this.remote ??= await this.discovery
 
-    await this.remote.disconnect()
+    await this.remote.disconnect(INTERRUPT)
   }
 }
 
-export class EndpointFactory implements RTD.EndpointsFactory<Endpoint> {
+export class EndpointsFactory implements RTD.EndpointsFactory<Endpoint> {
   private readonly remotes: Remotes
 
   public constructor (remotes: Remotes) {
@@ -43,7 +43,7 @@ export class EndpointFactory implements RTD.EndpointsFactory<Endpoint> {
     if (method.mapping === undefined)
       throw new Error('Cannot create Endpoint without mapping.')
 
-    const mapping = Mapping.create(method.verb, method.mapping.query)
+    const mapping = Mapping.create(method.mapping.query)
     const namespace = method.mapping.namespace ?? context.extension?.namespace
     const component = method.mapping.component ?? context.extension?.component
 
@@ -55,3 +55,5 @@ export class EndpointFactory implements RTD.EndpointsFactory<Endpoint> {
     return new Endpoint(method.mapping.endpoint, mapping, discovery)
   }
 }
+
+const INTERRUPT = true

package/source/Factory.ts

@@ -3,7 +3,7 @@ import { Gateway } from './Gateway'
 import { Remotes } from './Remotes'
 import { Tree, syntax } from './RTD'
 import { Server } from './HTTP'
-import { type Endpoint, EndpointFactory } from './Endpoint'
+import { type Endpoint, EndpointsFactory } from './Endpoint'
 import * as directives from './directives'
 import { type Directives, DirectivesFactory, type Family } from './Directive'
 import { Composition } from './Composition'
@@ -19,28 +19,26 @@ export class Factory implements extensions.Factory {
     this.families = directives.families
   }
 
-  public tenant (locator: Locator, manifest: syntax.Node): Connector {
+  public tenant (locator: Locator, node: syntax.Node): Connector {
     const broadcast = this.boot.bindings.broadcast(CHANNEL, locator.id)
 
-    return new Tenant(broadcast, locator, manifest)
+    return new Tenant(broadcast, locator, node)
   }
 
   public service (): Connector | null {
-    return this.gateway()
-  }
-
-  private gateway (): Gateway {
+    const debug = process.env.TOA_EXPOSITION_DEBUG === '1'
     const broadcast = this.boot.bindings.broadcast(CHANNEL)
-    const server = Server.create({ methods: syntax.verbs })
+    const server = Server.create({ methods: syntax.verbs, debug })
     const remotes = new Remotes(this.boot)
-    const methods = new EndpointFactory(remotes)
-    const directives = new DirectivesFactory(this.families, remotes)
     const node = root.resolve()
+    const methods = new EndpointsFactory(remotes)
+    const directives = new DirectivesFactory(this.families, remotes)
     const tree = new Tree<Endpoint, Directives>(node, methods, directives)
 
     const composition = new Composition(this.boot)
     const gateway = new Gateway(broadcast, server, tree)
 
+    gateway.depends(remotes)
     gateway.depends(composition)
 
     return gateway

package/source/HTTP/Server.ts

@@ -128,7 +128,7 @@ interface Properties {
 function defaults (): Properties {
   return {
     methods: new Set<string>(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']),
-    debug: process.env.TOA_DEV === '1'
+    debug: false
   }
 }
 

package/source/HTTP/messages.ts

@@ -1,14 +1,15 @@
 import { type IncomingHttpHeaders, type OutgoingHttpHeaders } from 'node:http'
+import { Readable } from 'node:stream'
 import { type Request, type Response } from 'express'
 import Negotiator from 'negotiator'
 import { buffer } from '@toa.io/generic'
+import { map } from '@toa.io/streams'
 import { formats, types } from './formats'
 import { BadRequest, NotAcceptable, UnsupportedMediaType } from './exceptions'
 
 export function write (request: Request, response: Response, body: any): void {
-  const buf = format(body, request, response)
-
-  response.send(buf)
+  if (body instanceof Readable) void pipe(body, request, response)
+  else send(body, request, response)
 }
 
 export async function read (request: Request): Promise<any> {
@@ -29,8 +30,12 @@ export async function read (request: Request): Promise<any> {
   }
 }
 
-function format (body: any, request: Request, response: Response): Buffer | undefined {
-  if (body === undefined || body?.length === 0) return
+function send (body: any, request: Request, response: Response): void {
+  if (body === undefined || body?.length === 0) {
+    response.end()
+
+    return
+  }
 
   const type = negotiate(request)
   const format = formats[type]
@@ -38,8 +43,15 @@ function format (body: any, request: Request, response: Response): Buffer | unde
 
   // content-length and etag are set by Express
   response.set('content-type', type)
+  response.send(buf)
+}
 
-  return buf
+async function pipe (stream: Readable, request: Request, response: Response): Promise<void> {
+  const type = negotiate(request)
+  const format = formats[type]
+
+  response.set('content-type', type)
+  map(stream, format.encode).pipe(response)
 }
 
 function negotiate (request: Request): string {

package/source/Mapping.ts

@@ -5,13 +5,10 @@ import type * as syntax from './RTD/syntax'
 import type * as core from '@toa.io/core'
 
 export abstract class Mapping {
-  public static create (verb: string, query?: syntax.Query): Mapping {
-    if (verb === 'POST')
+  public static create (query?: syntax.Query): Mapping {
+    if (query === undefined || query === null)
       return new InputMapping()
 
-    if (query === undefined)
-      throw new Error(`Query constraints must be defined for ${verb}`)
-
     const q = new Query(query)
 
     return new QueryableMapping(q)
@@ -37,12 +34,18 @@ class QueryableMapping extends Mapping {
 }
 
 class InputMapping extends Mapping {
-  public fit (body: any, _: unknown, parameters: Parameter[]): core.Request {
-    const input = { ...body }
+  public fit (input: any, _: unknown, parameters: Parameter[]): core.Request {
+    if (input === undefined && parameters.length > 0)
+      input = {}
 
-    for (const parameter of parameters)
-      input[parameter.name] = parameter.value
+    if (typeof input === 'object')
+      this.assign(input, parameters)
 
     return { input }
   }
+
+  private assign (input: Record<string, any>, parameters: Parameter[]): void {
+    for (const parameter of parameters)
+      input[parameter.name] = parameter.value
+  }
 }

package/source/RTD/Node.ts

@@ -1,6 +1,6 @@
 import { type Route } from './Route'
 import { type Methods } from './Method'
-import { type Parameter } from './Match'
+import { type Match, type Parameter } from './Match'
 import { type Directives } from './Directives'
 import { type Endpoint } from './Endpoint'
 
@@ -23,12 +23,12 @@ export class Node<
     this.sort()
   }
 
-  public match (fragments: string[], parameters: Parameter[]): Node<TEndpoint, TDirectives> | null {
+  public match (fragments: string[], parameters: Parameter[] = []): Match | null {
     for (const route of this.routes) {
-      const node = route.match(fragments, parameters)
+      const match = route.match(fragments, parameters)
 
-      if (node !== null)
-        return node
+      if (match !== null)
+        return match
     }
 
     return null

package/source/RTD/Route.ts

@@ -1,6 +1,6 @@
 import { type Node } from './Node'
 import { type Segment } from './segment'
-import { type Parameter } from './Match'
+import { type Match, type Parameter } from './Match'
 
 export class Route {
   public readonly root: boolean
@@ -18,7 +18,7 @@ export class Route {
         this.variables++
   }
 
-  public match (fragments: string[], parameters: Parameter[]): Node | null {
+  public match (fragments: string[], parameters: Parameter[]): Match | null {
     for (let i = 0; i < this.segments.length; i++) {
       const segment = this.segments[i]
 
@@ -31,7 +31,7 @@ export class Route {
 
     const exact = this.segments.length === fragments.length
 
-    if (exact && !this.node.intermediate) return this.node
+    if (exact && !this.node.intermediate) return { node: this.node, parameters }
     else return this.matchNested(fragments, parameters)
   }
 
@@ -50,8 +50,9 @@ export class Route {
     this.node.merge(route.node)
   }
 
-  private matchNested (fragments: string[], parameters: Parameter[]): Node | null {
+  private matchNested (fragments: string[], parameters: Parameter[]): Match | null {
     fragments = fragments.slice(this.segments.length)
+    parameters = parameters.slice()
 
     return this.node.match(fragments, parameters)
   }

package/source/RTD/Tree.ts

@@ -1,7 +1,7 @@
 import { type Node } from './Node'
 import { createNode } from './factory'
 import { fragment } from './segment'
-import { type Match, type Parameter } from './Match'
+import { type Match } from './Match'
 import { type Context } from './Context'
 import { type Directives, type DirectivesFactory } from './Directives'
 import { type Endpoint, type EndpointsFactory } from './Endpoint'
@@ -26,11 +26,8 @@ export class Tree<
 
   public match (path: string): Match<TEndpoint, TDirectives> | null {
     const fragments = fragment(path)
-    const parameters: Parameter[] = []
-    const node = this.trunk.match(fragments, parameters)
 
-    if (node === null) return null
-    else return { node, parameters }
+    return this.trunk.match(fragments)
   }
 
   public merge (node: syntax.Node, extension: any): void {

package/source/RTD/syntax/parse.ts

@@ -101,7 +101,7 @@ function parseEndpoint (mapping: Mapping): void {
 function parseQuery (mapping: any): void {
   const query = mapping.query
 
-  if (query === undefined)
+  if (query === undefined || query === null)
     return
 
   if (typeof query.limit === 'number')

package/source/Remotes.test.ts

@@ -10,7 +10,8 @@ jest.mock('@toa.io/boot', () => ({
 
 const boot = {
   remote: jest.fn(async (..._) => ({
-    link: jest.fn((connector: Connector) => undefined)
+    connect: jest.fn(() => undefined),
+    link: jest.fn(() => undefined)
   }))
 } as unknown as jest.MockedObjectDeep<Bootloader>
 

package/source/Remotes.ts

@@ -15,6 +15,8 @@ export class Remotes extends Connector {
 
     this.depends(remote)
 
+    await remote.connect()
+
     return remote
   }
 }

package/source/deployment.ts

@@ -27,14 +27,21 @@ export function deployment (_: unknown, annotation: Annotation | undefined): Dep
     }
 
   if (annotation?.['/'] !== undefined) {
-    annotation['/'] = parse(annotation['/'], shortcuts)
+    const node = { '/': annotation['/'] }
+    const tree = parse(node, shortcuts)
 
     service.variables.push({
       name: 'TOA_EXPOSITION',
-      value: encode(annotation['/'])
+      value: encode(tree)
     })
   }
 
+  if (annotation?.debug === true)
+    service.variables.push({
+      name: 'TOA_EXPOSITION_DEBUG',
+      value: '1'
+    })
+
   if (annotation !== undefined)
     schemas.annotaion.validate(annotation)
 

package/source/directives/dev/Family.ts

@@ -1,5 +1,6 @@
 import { type Input, type Output, type Family } from '../../Directive'
 import { Stub } from './Stub'
+import { Throw } from './Throw'
 import { type Directive } from './types'
 
 class Development implements Family<Directive> {
@@ -28,7 +29,8 @@ class Development implements Family<Directive> {
 }
 
 const constructors: Record<string, new (value: any) => Directive> = {
-  stub: Stub
+  stub: Stub,
+  throw: Throw
 }
 
 export = new Development()

package/source/directives/dev/Throw.ts

@@ -0,0 +1,14 @@
+import { type Output } from '../../Directive'
+import { type Directive } from './types'
+
+export class Throw implements Directive {
+  private readonly message: any
+
+  public constructor (message: any) {
+    this.message = message
+  }
+
+  public apply (): Output {
+    throw new Error(this.message)
+  }
+}

package/source/manifest.test.ts

@@ -7,8 +7,10 @@ const namespace = 'ns' + generate()
 
 let mf: Manifest
 
+const operations = { observe: {} }
+
 beforeEach(() => {
-  mf = { namespace, name } as unknown as Manifest
+  mf = { namespace, name, operations } as unknown as Manifest
 })
 
 const declaration = {

package/source/manifest.ts

@@ -1,5 +1,6 @@
-import { parse, type Node } from './RTD/syntax'
+import { parse, type Node, type Method, type Query } from './RTD/syntax'
 import { shortcuts } from './Directive'
+import * as schemas from './schemas'
 import type { Manifest } from '@toa.io/norm'
 
 export function manifest (declaration: object, manifest: Manifest): Node {
@@ -12,6 +13,8 @@ export function manifest (declaration: object, manifest: Manifest): Node {
 
   concretize(node, manifest)
 
+  schemas.node.validate(node)
+
   return node
 }
 
@@ -21,15 +24,25 @@ function wrap (segment: string, declaration: object): object {
 
 function concretize (node: Node, manifest: Manifest): void {
   for (const route of node.routes) {
-    for (const method of route.node.methods) {
-      // eslint-disable-next-line max-depth
-      if (method.mapping === undefined)
-        continue
-
-      method.mapping.namespace = manifest.namespace
-      method.mapping.component = manifest.name
-    }
+    for (const method of route.node.methods)
+      concretizeMethod(method, manifest)
 
     concretize(route.node, manifest)
   }
 }
+
+function concretizeMethod (method: Method, manifest: Manifest): void {
+  if (method.mapping === undefined)
+    return
+
+  const operation = manifest.operations[method.mapping.endpoint]
+
+  if (operation === undefined)
+    throw new Error(`Operation '${method.mapping.endpoint}' not found`)
+
+  if (method.mapping.query === undefined && operation.query !== false)
+    method.mapping.query = {} as unknown as Query // schema will substitute default values
+
+  method.mapping.namespace = manifest.namespace
+  method.mapping.component = manifest.name
+}

package/transpiled/Annotation.d.ts

@@ -1,6 +0,0 @@
-export interface Annotation {
-    host?: string;
-    class?: string;
-    annotations?: Record<string, string>;
-    '/'?: object;
-}

package/transpiled/Annotation.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Annotation.js.map

package/transpiled/Annotation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Annotation.js","sourceRoot":"","sources":["../source/Annotation.ts"],"names":[],"mappings":""}

package/transpiled/Branch.d.ts

@@ -1,7 +0,0 @@
-import type * as RTD from './RTD/syntax';
-export interface Branch {
-    namespace: string;
-    component: string;
-    isolated: boolean;
-    node: RTD.Node;
-}

package/transpiled/Branch.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Branch.js.map

package/transpiled/Branch.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Branch.js","sourceRoot":"","sources":["../source/Branch.ts"],"names":[],"mappings":""}

package/transpiled/Composition.d.ts

@@ -1,14 +0,0 @@
-import { Connector } from '@toa.io/core';
-import { type Bootloader } from './Factory';
-export declare class Composition extends Connector {
-    private readonly boot;
-    constructor(boot: Bootloader);
-    protected open(): Promise<void>;
-    protected dispose(): void;
-}
-export declare function components(): Components;
-interface Components {
-    labels: string[];
-    paths: string[];
-}
-export {};

package/transpiled/Composition.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.components = exports.Composition = void 0;
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const core_1 = require("@toa.io/core");
-class Composition extends core_1.Connector {
-    boot;
-    constructor(boot) {
-        super();
-        this.boot = boot;
-    }
-    async open() {
-        const paths = find();
-        const composition = await this.boot.composition(paths);
-        await composition.connect();
-        this.depends(composition);
-        console.info('Composition complete.');
-    }
-    dispose() {
-        console.info('Composition shutdown complete.');
-    }
-}
-exports.Composition = Composition;
-function find() {
-    return entries().map((entry) => (0, node_path_1.resolve)(ROOT, entry.name));
-}
-function entries() {
-    const entries = (0, node_fs_1.readdirSync)(ROOT, { withFileTypes: true });
-    return entries.filter((entry) => entry.isDirectory());
-}
-function components() {
-    const labels = [];
-    const paths = [];
-    for (const entry of entries()) {
-        labels.push(entry.name.replace('.', '-'));
-        paths.push((0, node_path_1.resolve)(ROOT, entry.name));
-    }
-    return { labels, paths };
-}
-exports.components = components;
-const ROOT = (0, node_path_1.resolve)(__dirname, '../components/');
-//# sourceMappingURL=Composition.js.map

package/transpiled/Composition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Composition.js","sourceRoot":"","sources":["../source/Composition.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,yCAAmC;AAEnC,uCAAwC;AAGxC,MAAa,WAAY,SAAQ,gBAAS;IACvB,IAAI,CAAY;IAEjC,YAAoB,IAAgB;QAClC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAEkB,KAAK,CAAC,IAAI;QAC3B,MAAM,KAAK,GAAG,IAAI,EAAE,CAAA;QACpB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QAEtD,MAAM,WAAW,CAAC,OAAO,EAAE,CAAA;QAE3B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QAEzB,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;IACvC,CAAC;IAEkB,OAAO;QACxB,OAAO,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAA;IAChD,CAAC;CACF;AAtBD,kCAsBC;AAED,SAAS,IAAI;IACX,OAAO,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,mBAAO,EAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;AAC5D,CAAC;AAED,SAAS,OAAO;IACd,MAAM,OAAO,GAAG,IAAA,qBAAW,EAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;IAE1D,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;AACvD,CAAC;AAED,SAAgB,UAAU;IACxB,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,MAAM,KAAK,GAAa,EAAE,CAAA;IAE1B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,EAAE;QAC7B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;QACzC,KAAK,CAAC,IAAI,CAAC,IAAA,mBAAO,EAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;KACtC;IAED,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;AAC1B,CAAC;AAVD,gCAUC;AAOD,MAAM,IAAI,GAAG,IAAA,mBAAO,EAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA"}

package/transpiled/Context.d.ts

@@ -1,5 +0,0 @@
-import { type Endpoint } from './Endpoint';
-import { type Directives } from './Directive';
-import { type Branch } from './Branch';
-import type * as RTD from './RTD';
-export type Context = RTD.Context<Endpoint, Directives, Branch>;

package/transpiled/Context.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Context.js.map

package/transpiled/Context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Context.js","sourceRoot":"","sources":["../source/Context.ts"],"names":[],"mappings":""}