@toa.io/extensions.exposition 0.8.3-dev.9 → 0.20.0-alpha.0

package/src/query/query.js

@@ -1,60 +0,0 @@
-'use strict'
-
-const { merge } = require('@toa.io/generic')
-
-/**
- * @implements {toa.extensions.exposition.Query}
- */
-class Query {
-  #constraints
-
-  constructor (constraints) {
-    this.#constraints = Object.entries(constraints)
-  }
-
-  /** @hot */
-  parse (query, operation) {
-    for (const [key, constraint] of this.#constraints) {
-      const value = constraint.parse(query?.[key], operation)
-
-      if (value !== undefined) {
-        if (query === undefined) query = {}
-
-        query[key] = value
-      }
-    }
-
-    return query
-  }
-
-  /**
-   * @param {toa.extensions.exposition.declarations.Node} node
-   * @returns {toa.extensions.exposition.declarations.Query}
-   */
-  static merge (node) {
-    const query = {}
-    let current = node
-
-    do {
-      if (current.query !== undefined) merge(query, current.query, { ignore: true })
-
-      current = current.parent
-    } while (current !== undefined)
-
-    merge(query, DEFAULTS, { ignore: true })
-
-    return query
-  }
-}
-
-const DEFAULTS = {
-  omit: {
-    range: [0, 1000]
-  },
-  limit: {
-    value: 100,
-    range: [1, 100]
-  }
-}
-
-exports.Query = Query

package/src/query/range.js

@@ -1,28 +0,0 @@
-'use strict'
-
-const { exceptions: { RequestConflictException } } = require('@toa.io/core')
-
-class Range {
-  #value
-  #min
-  #max
-
-  constructor (constraint) {
-    this.#value = constraint.value
-
-    this.#min = constraint.range[0] === undefined ? this.#value : constraint.range[0]
-    this.#max = constraint.range[1] === undefined ? this.#value : constraint.range[1]
-  }
-
-  /** @hot */
-  parse (value, operation) {
-    if (operation.type !== 'observation' || operation.scope !== 'objects') return value
-    if (value === undefined) return this.#value
-
-    if (value > this.#max || value < this.#min) {
-      throw new RequestConflictException(`Query omit/limit value is out of range [${this.#min}, ${this.#max}]`)
-    }
-  }
-}
-
-exports.Range = Range

package/src/query/sort.js

@@ -1,19 +0,0 @@
-'use strict'
-
-class Sort {
-  #value
-
-  constructor (value) {
-    this.#value = value
-  }
-
-  /** @hot */
-  parse (value, operation) {
-    if (operation.query === false) return value
-
-    if (value === undefined) return this.#value
-    else return this.#value.concat(value)
-  }
-}
-
-exports.Sort = Sort

package/src/remote.js

@@ -1,88 +0,0 @@
-'use strict'
-
-const { Connector, exceptions: { NotImplementedException } } = require('@toa.io/core')
-const { console } = require('@toa.io/console')
-
-const translate = require('./translate')
-
-/**
- * @implements {toa.extensions.exposition.Remote}
- */
-class Remote extends Connector {
-  /** @type {toa.core.Component} */
-  #remote
-
-  /** @type {toa.extensions.exposition.Tree} */
-  #tree
-
-  /**
-   * @param {toa.extensions.exposition.Server} server
-   * @param {toa.core.Component} remote
-   * @param {toa.extensions.exposition.Tree} tree
-   */
-  constructor (server, remote, tree) {
-    super()
-
-    const { namespace, name } = remote.locator
-    const route = '/' + (namespace === 'default' ? '' : namespace + '/') + name + '*'
-
-    server.route(route, (req, res) => this.#reply(req, res))
-
-    this.#remote = remote
-    this.#tree = tree
-
-    this.depends(server)
-    this.depends(remote)
-  }
-
-  update (declaration) {
-    console.info(`Updating tree '${this.#remote.locator.id}'`)
-
-    this.#tree.update(declaration)
-  }
-
-  /**
-   * @hot
-   * @param {toa.extensions.exposition.http.Request} req
-   * @param {toa.extensions.exposition.http.Response} res
-   * @return {Promise<void>}
-   */
-  async #reply (req, res) {
-    const match = this.#tree.match(req.params[0])
-
-    if (match !== undefined) {
-      try {
-        const reply = await this.#call(req, match)
-
-        translate.response.ok(reply, res, req)
-      } catch (e) {
-        translate.response.exception(e, res)
-      }
-    } else {
-      translate.response.missed(res)
-    }
-
-    res.end()
-  }
-
-  /**
-   * @param {toa.extensions.exposition.http.Request} req
-   * @param {toa.extensions.exposition.tree.Match} match
-   * @return {Promise<toa.core.Reply>}
-   */
-  async #call (req, match) {
-    const method = req.method === 'HEAD' ? 'GET' : req.method
-    const operation = match.node.operations[method]
-
-    if (operation === undefined) throw new NotImplementedException()
-
-    const request = translate.request(req, match.params)
-    const query = match.node.query.parse(request.query, operation)
-
-    if (query !== undefined) request.query = query
-
-    return this.#remote.invoke(operation.operation, request)
-  }
-}
-
-exports.Remote = Remote

package/src/server.js

@@ -1,83 +0,0 @@
-'use strict'
-
-const express = require('express')
-const cors = require('cors')
-
-const { Connector } = require('@toa.io/core')
-const { console } = require('@toa.io/console')
-
-const { PORT } = require('./constants')
-
-// noinspection JSClosureCompilerSyntax
-/**
- * @implements {toa.extensions.exposition.Server}
- */
-class Server extends Connector {
-  /** @type {import('express').Application} */
-  #app
-  /** @type {import('http').Server} */
-  #server
-
-  constructor () {
-    super()
-
-    // TODO: remove express
-    this.#app = express()
-    this.#app.disable('x-powered-by')
-    this.#app.enable('case sensitive routing')
-    this.#app.enable('strict routing')
-    this.#app.disable('etag')
-    this.#app.use(express.json())
-    this.#app.use(cors({ allowedHeaders: ['content-type'] }))
-
-    this.#app.use((req, res, next) => {
-      req.safe = req.method in SAFE
-
-      if (req.method in METHODS) next()
-      else res.status(501).end()
-    })
-  }
-
-  route (route, callback) {
-    this.#app.use(route, callback)
-  }
-
-  async open () {
-    console.info(`Starting HTTP server at :${PORT} ...`)
-
-    return new Promise((resolve, reject) => {
-      const error = () => reject(new Error(`Error starting HTTP server at :${PORT}`))
-      // noinspection JSCheckFunctionSignatures
-      this.#server = this.#app.listen(PORT, () => {
-        console.info(`HTTP server at :${PORT} started`)
-
-        this.#server.off('error', error)
-        resolve()
-      })
-
-      this.#server.on('error', error)
-    })
-  }
-
-  async close () {
-    console.info(`Stopping HTTP server at :${PORT} ...`)
-
-    return new Promise((resolve, reject) => {
-      const error = () => reject(new Error(`Error stopping HTTP server at :${PORT}`))
-
-      this.#server.close(() => {
-        console.info(`HTTP server at :${PORT} stopped`)
-
-        this.#server.off('error', error)
-        resolve()
-      })
-
-      this.#server.on('error', error)
-    })
-  }
-}
-
-const METHODS = { HEAD: 1, GET: 1, POST: 1, PUT: 1, PATCH: 1 }
-const SAFE = { HEAD: 1, GET: 1 }
-
-exports.Server = Server

package/src/tenant.js

@@ -1,29 +0,0 @@
-'use strict'
-
-const { Connector } = require('@toa.io/core')
-
-class Tenant extends Connector {
-  /** @type {toa.core.bindings.Broadcast} */
-  #binding
-  #declaration
-
-  constructor (binding, { namespace, name }, resources) {
-    super()
-
-    this.#binding = binding
-    this.#declaration = { namespace, name, resources }
-
-    this.depends(binding)
-  }
-
-  async open () {
-    await this.#binding.receive('ping', () => this.#expose())
-    await this.#expose()
-  }
-
-  async #expose () {
-    await this.#binding.transmit('expose', this.#declaration)
-  }
-}
-
-exports.Tenant = Tenant

package/src/translate/etag.js

@@ -1,14 +0,0 @@
-'use strict'
-
-const get = (header) => {
-  const match = header.match(rx)
-  return match === null ? null : match[1]
-}
-
-const set = (value) => '"' + value + '"'
-
-const rx = /^"([^"]+)"$/
-
-exports.get = get
-exports.set = set
-exports.rx = rx

package/src/translate/index.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const { request } = require('./request')
-const response = require('./response')
-
-exports.request = request
-exports.response = response

package/src/translate/request.js

@@ -1,68 +0,0 @@
-'use strict'
-
-const { exceptions: { RequestSyntaxException, RequestConflictException } } = require('@toa.io/core')
-const { empty } = require('@toa.io/generic')
-
-const etag = require('./etag')
-
-/**
- * @hot
- *
- * @param {import('express').Request} req
- * @param {{[key: string]: string}} params
- * @returns {toa.core.Request}
- */
-const request = (req, params) => {
-  const request = {}
-
-  if (!empty(req.body)) request.input = req.body
-
-  if (!empty(req.query)) {
-    request.query = req.query
-
-    if (request.query.projection !== undefined) request.query.projection = request.query.projection.split(',')
-    if (request.query.sort !== undefined) request.query.sort = request.query.sort.split(',')
-  }
-
-  if (!empty(params)) {
-    if (req.method === 'POST') {
-      if (request.input === undefined) request.input = {}
-
-      for (const [key, value] of Object.entries(params)) {
-        if (request.input[key] === undefined) request.input[key] = value
-        else throw new RequestConflictException(`Input property '${key}' conflicts with path parameter`)
-      }
-    } else {
-      const criteria = []
-
-      if (request.query === undefined) request.query = {}
-
-      for (const [key, value] of Object.entries(params)) {
-        if (key === 'id') request.query.id = value
-        else criteria.push(key + '==' + value)
-      }
-
-      if (criteria.length > 0) {
-        const value = criteria.join(';')
-
-        if (request.query.criteria === undefined) request.query.criteria = value
-        else request.query.criteria = value + ';' + request.query.criteria
-      }
-    }
-  }
-
-  const condition = req.get('if-match')
-
-  if (condition !== undefined && condition !== '*') {
-    const value = etag.get(condition)
-
-    if (value === null) throw new RequestSyntaxException('ETag value must match ' + etag.rx)
-    if (request.query === undefined) request.query = {}
-
-    request.query.version = +value
-  }
-
-  return request
-}
-
-exports.request = request

package/src/translate/response.js

@@ -1,62 +0,0 @@
-'use strict'
-
-const { exceptions: { codes } } = require('@toa.io/core')
-
-const etag = require('./etag')
-
-/**
- * @param {toa.core.Reply} reply
- * @param res
- * @param req
- * @hot
- */
-const ok = (reply, res, req) => {
-  if (reply.output?._version !== undefined) {
-    const { _version, ...output } = reply.output
-    const condition = req.get('if-none-match')
-
-    if (condition !== undefined && req.safe) {
-      const value = etag.get(condition)
-
-      if (value === _version) {
-        res.status(304).end()
-        return
-      }
-    }
-
-    res.set('etag', etag.set(_version))
-    reply.output = output
-  }
-
-  let status
-
-  if (req.method === 'POST') status = 201
-  else if (reply.output !== undefined || reply.error !== undefined) status = 200
-  else status = 204
-
-  res.status(status)
-  if (status !== 204) res.send(reply)
-}
-
-const missed = (response) => response.status(404)
-
-const exception = (exception, response) => {
-  const status = STATUSES[exception.code] || 500
-
-  response.status(status)
-  response.send(exception)
-}
-
-const STATUSES = {
-  [codes.RequestContract]: 400,
-  [codes.RequestSyntax]: 400,
-  [codes.QuerySyntax]: 400,
-  [codes.RequestConflict]: 403,
-  [codes.StateNotFound]: 404,
-  [codes.NotImplemented]: 405,
-  [codes.StatePrecondition]: 412
-}
-
-exports.ok = ok
-exports.missed = missed
-exports.exception = exception

package/src/tree.js

@@ -1,109 +0,0 @@
-'use strict'
-
-const path = require('path')
-const { match } = require('path-to-regexp')
-
-const { console } = require('@toa.io/console')
-
-/**
- * @implements {toa.extensions.exposition.Tree}
- */
-class Tree {
-  /** @type {toa.extensions.exposition.tree.Node[]} */
-  #nodes
-
-  /** @type {toa.extensions.exposition.query.Factory} */
-  #query
-
-  /**
-   * @param {toa.extensions.exposition.query.Factory} query
-   */
-  constructor (query) {
-    this.#query = query
-  }
-
-  /** @hot */
-  match (path) {
-    // dev only check
-    if (process.env.TOA_ENV === 'local') {
-      const nodes = this.#nodes.filter((node) => node.match(path) !== false)
-
-      if (nodes.length > 1) {
-        const routes = nodes.map((node) => node.route)
-
-        throw new Error('Ambiguous routes ' + routes.join(', '))
-      }
-    }
-
-    let match
-
-    const node = this.#nodes.find((node) => {
-      match = node.match(path)
-      return match !== false
-    })
-
-    return node === undefined ? undefined : { node, params: match.params }
-  }
-
-  update (tree) {
-    this.#nodes = []
-    this.#traverse(tree)
-  }
-
-  /**
-   * @param {toa.extensions.exposition.declarations.Node | any} node
-   * @param {string} route
-   * @param {toa.extensions.exposition.declarations.Node} parent
-   */
-  #traverse (node, route = undefined, parent = undefined) {
-    const current = {}
-
-    if (route === undefined) route = '/'
-    else route = trail(route)
-
-    if (parent !== undefined) node.parent = parent
-
-    if (node.operations) {
-      current.route = route
-      current.match = match(route)
-      current.query = this.#query(node)
-      current.operations = {}
-
-      for (const operation of node.operations) current.operations[method(operation)] = operation
-
-      this.#nodes.push(current)
-    }
-
-    let branches = 0
-
-    for (const [key, value] of Object.entries(node)) {
-      if (key[0] === '/') {
-        branches++
-
-        const branch = path.posix.resolve(route, '.' + key)
-
-        this.#traverse(value, branch, node)
-      }
-    }
-
-    if (branches === 0 && node.operations === undefined) {
-      console.warn(`Resource tree leaf '${route}' has no operations`)
-    }
-  }
-}
-
-const trail = (path) => path[path.length - 1] === '/' ? path : path + '/'
-
-const method = (operation) => {
-  if (operation.type === 'transition') {
-    if (operation.query === false) return 'POST'
-    else return 'PUT'
-  }
-
-  if (operation.type === 'observation') return 'GET'
-  if (operation.type === 'assignment') return 'PATCH'
-  if (operation.type === 'computation') return 'GET'
-  if (operation.type === 'effect') return 'POST'
-}
-
-exports.Tree = Tree

package/test/manifest.normalize.fixtures.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const manifest = {
-  operations: {
-    one: {
-      type: 'transition',
-      scope: 'object',
-      query: false
-    },
-    two: {
-      type: 'observation',
-      scope: 'objects'
-    },
-    three: {
-      type: 'observation',
-      scope: 'objects'
-    }
-  }
-}
-
-const resources = {
-  '/': ['one', 'two'],
-  '/top': {
-    operations: ['one'],
-    '/nested': {
-      operations: ['two'],
-      '/deeper': {
-        operations: [{
-          operation: 'three'
-        }]
-      }
-    }
-  }
-}
-
-exports.manifest = manifest
-exports.resources = resources

package/test/manifest.normalize.test.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const clone = require('clone-deep')
-
-const { normalize } = require('../src/.manifest')
-const fixtures = require('./manifest.normalize.fixtures')
-
-describe('normalize', () => {
-  let manifest, resources
-
-  const map = (operation) => ({
-    ...fixtures.manifest.operations[operation],
-    operation
-  })
-
-  beforeEach(() => {
-    manifest = clone(fixtures.manifest)
-    resources = clone(fixtures.resources)
-  })
-
-  it('should expand array', () => {
-    normalize(resources, manifest)
-
-    expect(resources['/'].operations)
-      .toStrictEqual(fixtures.resources['/'].map(map))
-  })
-
-  it('should expand operations', () => {
-    normalize(resources, manifest)
-
-    expect(resources['/top'].operations)
-      .toStrictEqual(fixtures.resources['/top'].operations.map(map))
-
-    expect(resources['/top']['/nested'].operations)
-      .toStrictEqual(fixtures.resources['/top']['/nested'].operations.map(map))
-  })
-})

package/test/manifest.validate.test.js

@@ -1,40 +0,0 @@
-'use strict'
-
-const { validate } = require('../src/.manifest')
-
-it('should validate', () => {
-  const resources = {
-    '/path/to': {
-      operations: [
-        {
-          operation: 'foo',
-          type: 'observation'
-        }
-      ],
-      '/deeper/': {
-        operations: [{
-          operation: 'bar',
-          type: 'transition',
-          query: false
-        }]
-      }
-    }
-  }
-
-  expect(() => validate(resources)).not.toThrow()
-})
-
-it.each(['computation', 'effect'])('should allow %s operation', async (type) => {
-  const resources = {
-    '/path/to': {
-      operations: [
-        {
-          operation: 'foo',
-          type
-        }
-      ]
-    }
-  }
-
-  expect(() => validate(resources)).not.toThrow()
-})