@toa.io/core 1.0.0-alpha.4 → 1.0.0-alpha.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/core",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.40",
   "description": "Toa Core",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -21,13 +21,13 @@
   },
   "dependencies": {
     "@rsql/parser": "1.2.4",
-    "@toa.io/console": "1.0.0-alpha.4",
-    "@toa.io/generic": "1.0.0-alpha.4",
-    "@toa.io/yaml": "1.0.0-alpha.4",
+    "@toa.io/console": "1.0.0-alpha.40",
+    "@toa.io/generic": "1.0.0-alpha.40",
+    "@toa.io/yaml": "1.0.0-alpha.40",
     "error-value": "0.3.0"
   },
   "devDependencies": {
     "clone-deep": "4.0.1"
   },
-  "gitHead": "80a91c0d9c167484247a91e69a0c0a3c344f90d0"
+  "gitHead": "973a253abb982ddd6cdd7427ef98331d1157180d"
 }

package/src/assignment.js

@@ -9,13 +9,22 @@ class Assignment extends Operation {
   }
 
   async commit (store) {
-    const { scope, state, reply } = store
+    const {
+      scope,
+      state,
+      reply
+    } = store
 
     if (reply.error !== undefined) return
 
     scope.set(state)
 
-    await this.scope.apply(scope)
+    const output = await this.scope.apply(scope)
+
+    // assignment returns new state by default
+    if (store.reply.output === undefined) {
+      store.reply.output = output
+    }
   }
 }
 

package/src/cascade.js

@@ -1,16 +1,15 @@
 'use strict'
 
-const { merge } = require('@toa.io/generic')
 const { Connector } = require('./connector')
 
 class Cascade extends Connector {
-  #bridges
+  // #bridges
   #last
 
   constructor (bridges) {
     super()
 
-    this.#bridges = bridges
+    // this.#bridges = bridges
     this.#last = bridges[bridges.length - 1]
 
     this.depends(bridges)

package/src/contract/schemas/query.yaml

@@ -18,14 +18,13 @@ properties:
     minItems: 1
     items:
       type: string
-      pattern: ^[a-zA-Z]+([-a-zA-Z0-9]*[a-zA-Z0-9]+)?(:(asc|desc))?$
+      pattern: ^\w{1,32}(?::(?:asc|desc))?$
   projection:
     type: array
     uniqueItems: true
     minItems: 1
     items:
       type: string
-      pattern: ^([a-zA-Z]+([-a-zA-Z0-9]*[a-zA-Z0-9]+)?)$
       not:
         const: id
 additionalProperties: false

package/src/effect.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const { Observation } = require('./observation')
+
+class Effect extends Observation {
+
+  async acquire (store) {
+    const { query, entity } = store.request
+
+    if (entity === undefined)
+      return super.acquire(store)
+
+    store.scope = await this.scope.ensure(query, entity)
+    store.state = store.scope.get()
+  }
+
+}
+
+exports.Effect = Effect

package/src/entities/changeset.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const { merge, overwrite, newid } = require('@toa.io/generic')
 const { EntityContractException } = require('../exceptions')
 
 class Changeset {
@@ -26,21 +25,13 @@ class Changeset {
 
     if (error !== null) throw new EntityContractException(error)
 
+    value._updated = Date.now()
+
     this.#state = value
   }
 
   export () {
-    const changeset = this.#state
-    const result = { changeset }
-    const insert = merge({ id: newid() }, changeset)
-    const error = this.#schema.fit(insert)
-
-    if (error === null) {
-      delete insert.id
-      result.insert = overwrite(insert, changeset)
-    }
-
-    return result
+    return this.#state
   }
 }
 

package/src/entities/entity.js

@@ -1,10 +1,6 @@
 'use strict'
 
-const {
-  difference,
-  newid
-} = require('@toa.io/generic')
-
+const { difference, newid } = require('@toa.io/generic')
 const { EntityContractException } = require('../exceptions')
 
 class Entity {
@@ -32,7 +28,8 @@ class Entity {
   set (value) {
     const error = this.#schema.fit(value)
 
-    if (error !== null) throw new EntityContractException(error)
+    if (error !== null)
+      throw new EntityContractException(error)
 
     this.#set(value)
   }
@@ -41,7 +38,8 @@ class Entity {
     return {
       origin: this.#origin,
       state: this.#state,
-      changeset: this.#origin === null ? this.#state : difference(this.#origin, this.#state)
+      changeset: this.#origin === null ? this.#state : difference(this.#origin, this.#state),
+      trailers: this.#state._trailers
     }
   }
 
@@ -55,12 +53,19 @@ class Entity {
   }
 
   #set (value) {
-    Object.defineProperty(value, 'id', {
-      writable: false,
-      configurable: false
-    })
+    if (!('_trailers' in value))
+      Object.defineProperty(value, '_trailers', {
+        writable: false,
+        configurable: false,
+        enumerable: false,
+        value: {}
+      })
+
+    if (!('_created' in value))
+      value._created = Date.now()
 
     if (this.#state !== undefined) {
+      value._updated = Date.now()
       value._version++
     }
 

package/src/entities/factory.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const { newid } = require('@toa.io/generic')
+
 const { Entity } = require('./entity')
 const { EntitySet } = require('./set')
 const { Changeset } = require('./changeset')
@@ -11,6 +13,10 @@ class Factory {
     this.#schema = schema
   }
 
+  fit (values) {
+    this.#schema.validate({ id: newid(), ...values }, 'Entity')
+  }
+
   init (id) {
     return new Entity(this.#schema, id)
   }

package/src/exceptions.js

@@ -19,6 +19,7 @@ const codes = {
   StatePrecondition: 303,
   StateConcurrency: 304,
   StateInitialization: 305,
+  Duplicate: 306,
 
   Communication: 400,
   Transmission: 401
@@ -48,18 +49,13 @@ class SystemException extends Exception {
 }
 
 class ContractException extends Exception {
-  keyword
-  property
-  schema
-  path
-
   constructor (code, error) {
-    super(code || codes.Contract, error.message)
+    super(code || codes.Contract, typeof error === 'string' ? error : error?.message)
 
-    this.keyword = error.keyword
-    this.property = error.property
-    this.schema = error.schema
-    this.path = error.path
+    if (typeof error === 'object' && error !== null)
+      for (const k of ['keyword', 'property', 'schema', 'path'])
+        if (k in error)
+          this[k] = error[k]
   }
 }
 
@@ -88,7 +84,7 @@ for (const [name, code] of Object.entries(codes)) {
   if (exports[classname] === undefined) {
     exports[classname] = class extends Exception {
       constructor (message) {
-        super(code, message || classname)
+        super(code, message ?? classname)
       }
     }
   }

package/src/index.js

@@ -5,6 +5,7 @@ const { Composition } = require('./composition')
 const { Connector } = require('./connector')
 const { Context } = require('./context')
 const { Discovery } = require('./discovery')
+const { Effect } = require('./effect')
 const { Emission } = require('./emission')
 const { Event } = require('./event')
 const { Exposition } = require('./exposition')
@@ -32,6 +33,7 @@ exports.Composition = Composition
 exports.Connector = Connector
 exports.Context = Context
 exports.Discovery = Discovery
+exports.Effect = Effect
 exports.Emission = Emission
 exports.Event = Event
 exports.Exposition = Exposition

package/src/locator.js

@@ -12,6 +12,7 @@ class Locator {
   id
   label
   uppercase
+  lowercase
 
   /**
    * @param {string} name
@@ -26,6 +27,7 @@ class Locator {
     this.id = concat(namespace, '.') + name
     this.label = (concat(namespace, '-') + name).toLowerCase()
     this.uppercase = (concat(namespace, '_') + name).toUpperCase()
+    this.lowercase = (concat(namespace, '_') + name).toLowerCase()
   }
 
   hostname (prefix) {
@@ -39,8 +41,11 @@ class Locator {
   static parse (string) {
     const [namespace, name] = string.split(DOT)
 
-    if (name === undefined) return new Locator(namespace)
-    else return new Locator(name, namespace)
+    if (name === undefined) {
+      return new Locator(namespace)
+    } else {
+      return new Locator(name, namespace)
+    }
   }
 }
 

package/src/observation.js

@@ -3,14 +3,6 @@
 const { Operation } = require('./operation')
 
 class Observation extends Operation {
-  async acquire (store) {
-    const scope = await this.query(store.request.query)
-    const state = scope === null ? null : scope.get()
-
-    store.scope = scope
-    store.state = state
-  }
-
   async run (store) {
     if (store.scope === null) store.reply = null
     else await super.run(store)

package/src/operation.js

@@ -1,7 +1,8 @@
 'use strict'
 
 const { Connector } = require('./connector')
-const { SystemException } = require('./exceptions')
+const { SystemException, RequestContractException } = require('./exceptions')
+const { Readable } = require('node:stream')
 
 class Operation extends Connector {
   scope
@@ -26,13 +27,22 @@ class Operation extends Connector {
 
   async invoke (request) {
     try {
-      if (request.authentic !== true) this.#contracts.request.fit(request)
-      if ('query' in request) request.query = this.#query.parse(request.query)
+      if (request.authentic !== true)
+        this.#contracts.request.fit(request)
+
+      if ('query' in request)
+        request.query = this.#query.parse(request.query)
+
+      // validate entity
+      if ('entity' in request)
+        this.scope.fit(request.entity)
 
       const store = { request }
 
       return await this.process(store)
     } catch (e) {
+      console.error(e)
+
       const exception = e instanceof Error ? new SystemException(e) : e
 
       return { exception }
@@ -47,7 +57,16 @@ class Operation extends Connector {
     return store.reply
   }
 
-  async acquire () {}
+  async acquire (store) {
+    if (this.#scope === 'none')
+      return
+
+    const scope = await this.query(store.request.query)
+    const raw = scope === null || scope instanceof Readable
+
+    store.scope = scope
+    store.state = raw ? scope : scope.get()
+  }
 
   async run (store) {
     const { request, state } = store
@@ -62,6 +81,9 @@ class Operation extends Connector {
   async commit () {}
 
   async query (query) {
+    if (query === undefined)
+      throw new RequestContractException('Request query is required')
+
     return this.scope[this.#scope](query)
   }
 }

package/src/receiver.js

@@ -16,18 +16,13 @@ class Receiver extends Connector {
   /** @type {string} */
   #endpoint
 
-  /** @type {toa.core.Component} */
+  /** @type {unknown[]} */
+  #arguments
+
   #local
 
-  /** @type {toa.core.bridges.Receiver} */
   #bridge
 
-  /**
-   *
-   * @param {toa.norm.component.Receiver} definition
-   * @param {toa.core.Component} local
-   * @param {toa.core.bridges.Receiver} bridge
-   */
   constructor (definition, local, bridge) {
     super()
 
@@ -36,6 +31,7 @@ class Receiver extends Connector {
     this.#conditioned = conditioned
     this.#adaptive = adaptive
     this.#endpoint = operation
+    this.#arguments = definition.arguments
 
     this.#local = local
     this.#bridge = bridge
@@ -58,7 +54,7 @@ class Receiver extends Connector {
   }
 
   async #request (payload) {
-    return this.#adaptive ? await this.#bridge.request(payload) : { input: payload }
+    return this.#adaptive ? await this.#bridge.request(payload, ...(this.#arguments ?? [])) : { input: payload }
   }
 }
 

package/src/state.js

@@ -1,62 +1,79 @@
 'use strict'
 
-const { empty } = require('@toa.io/generic')
+const { empty, newid } = require('@toa.io/generic')
+const { StatePreconditionException, StateNotFoundException } = require('./exceptions')
 
-const {
-  StatePreconditionException,
-  StateNotFoundException,
-  StateInitializationException
-} = require('./exceptions')
-
-/**
- * @implements {toa.core.State}
- */
 class State {
-  /** @type {toa.core.Storage} */
+  #associated
   #storage
-
-  /** @type {toa.core.entity.Factory} */
-  #entity
+  #entities
   #emission
-  #dependent
 
-  constructor (storage, entity, emission, dependent) {
+  constructor (storage, entity, emission, associated) {
     this.#storage = storage
-    this.#entity = entity
+    this.#entities = entity
     this.#emission = emission
-    this.#dependent = dependent === true
+    this.#associated = associated === true
   }
 
   init (id) {
-    return this.#entity.init(id)
+    return this.#entities.init(id)
+  }
+
+  fit (values) {
+    return this.#entities.fit(values)
   }
 
   async object (query) {
     const record = await this.#storage.get(query)
 
     if (record === null) {
-      if (this.#dependent && query.id !== undefined && query.version === undefined) return this.init(query.id)
-      else if (query.version !== undefined) throw new StatePreconditionException()
-    }
-
-    if (record === null) return null
-    else return this.#entity.object(record)
+      if (this.#associated && query.id !== undefined && query.version === undefined)
+        return this.init(query.id)
+      else if (query.version !== undefined)
+        throw new StatePreconditionException()
+
+      return null
+    } else
+      return this.#entities.object(record)
   }
 
   async objects (query) {
     const recordset = await this.#storage.find(query)
 
-    return this.#entity.objects(recordset)
+    return this.#entities.objects(recordset)
+  }
+
+  async stream (query) {
+    return this.#storage.stream(query)
   }
 
   changeset (query) {
-    return this.#entity.changeset(query)
+    return this.#entities.changeset(query)
   }
 
   none () {
     return null
   }
 
+  async ensure (query, properties) {
+    const object = this.#entities.init()
+    const blank = object.get()
+
+    Object.assign(blank, properties)
+
+    object.set(blank)
+
+    const record = await this.#storage.ensure(query, properties, object.get())
+
+    if (record.id !== blank.id) // exists
+      return this.#entities.object(record)
+
+    await this.#emission.emit(object.event())
+
+    return object
+  }
+
   async commit (state) {
     const event = state.event()
 
@@ -68,30 +85,34 @@ class State {
       ok = await this.#storage.store(object)
 
       // #20
-      await this.#emission.emit(event)
+      if (ok === true) {
+        await this.#emission.emit(event)
+      }
     }
 
     return ok
   }
 
   async apply (state) {
-    const { changeset, insert } = state.export()
-
-    let upsert
-
-    if (this.#dependent && state.query.id !== undefined && state.query.version === undefined) {
-      upsert = insert
-    }
+    const changeset = state.export()
 
-    const result = await this.#storage.upsert(state.query, changeset, upsert)
+    const result = await this.#storage.upsert(state.query, changeset)
 
     if (result === null) {
-      if (state.query.version !== undefined) throw new StatePreconditionException()
-      else throw new StateNotFoundException()
+      if (state.query.version !== undefined) {
+        throw new StatePreconditionException()
+      } else {
+        throw new StateNotFoundException()
+      }
+    } else {
+      // same as above
+      await this.#emission.emit({
+        changeset,
+        state: result
+      })
     }
 
-    // same as above
-    await this.#emission.emit({ changeset, state: result })
+    return result
   }
 }
 

package/src/transition.js

@@ -3,7 +3,10 @@
 const { retry } = require('@toa.io/generic')
 
 const { Operation } = require('./operation')
-const { StateConcurrencyException, StateNotFoundException } = require('./exceptions')
+const {
+  StateConcurrencyException,
+  StateNotFoundException
+} = require('./exceptions')
 
 class Transition extends Operation {
   #concurrency
@@ -23,7 +26,9 @@ class Transition extends Operation {
 
     store.scope = request.query ? await this.query(request.query) : this.scope.init()
 
-    if (store.scope === null) throw new StateNotFoundException()
+    if (store.scope === null) {
+      throw new StateNotFoundException()
+    }
 
     store.state = store.scope.get()
   }
@@ -35,11 +40,13 @@ class Transition extends Operation {
 
     scope.set(state)
 
-    const ok = await this.scope.commit(scope)
+    const result = await this.scope.commit(scope)
 
-    if (ok !== true) {
-      if (this.#concurrency === 'retry') retry()
-      else throw new StateConcurrencyException()
+    if (result === false) {
+      if (this.#concurrency === 'retry')
+        return retry()
+      else
+        throw new StateConcurrencyException()
     }
   }
 

package/test/entities/entity.test.js

@@ -33,7 +33,7 @@ describe('argument', () => {
       _version: 0
     }
 
-    expect(entity.get()).toStrictEqual(expected)
+    expect(entity.get()).toStrictEqual(expect.objectContaining(expected))
   })
 
   it('should set state', () => {
@@ -54,29 +54,12 @@ it('should provide event', () => {
 
   const event = entity.event()
 
-  expect(event).toEqual({
+  expect(event).toEqual(expect.objectContaining({
     state,
     origin,
-    changeset: {
+    changeset: expect.objectContaining({
       foo: 'new value',
       _version: 1
-    }
-  })
-})
-
-it('should define `id` as readonly', async () => {
-  const origin = fixtures.state()
-  const entity = new Entity(fixtures.schema, origin)
-  const state = entity.get()
-
-  expect(() => (state.id = 1)).toThrow('assign to read only property')
-})
-
-it('should seal id', async () => {
-  const origin = fixtures.state()
-  const entity = new Entity(fixtures.schema, origin)
-  const state = entity.get()
-  const redefine = () => Object.defineProperty(state, 'id', { writable: true })
-
-  expect(redefine).toThrow('redefine property')
+    })
+  }))
 })

package/types/locator.d.ts

@@ -1,10 +1,11 @@
-export class Locator {
+export class Locator{
   public readonly name: string
   public readonly namespace: string
 
   public readonly id: string
   public readonly label: string
   public readonly uppercase: string
+  public readonly lowercase: string
 
   constructor (name: string, namespace?: string)