@toa.io/core 1.0.0-alpha.2 → 1.0.0-alpha.200

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/package.json +6 -9
  2. package/src/assignment.js +11 -2
  3. package/src/call.js +6 -0
  4. package/src/cascade.js +2 -3
  5. package/src/component.js +15 -18
  6. package/src/composition.js +1 -1
  7. package/src/connector.js +3 -8
  8. package/src/contract/contract.js +22 -0
  9. package/src/contract/reply.js +26 -9
  10. package/src/contract/request.js +15 -5
  11. package/src/contract/schemas/query.yaml +15 -3
  12. package/src/discovery.js +2 -5
  13. package/src/effect.js +19 -0
  14. package/src/entities/changeset.js +8 -15
  15. package/src/entities/entity.js +51 -12
  16. package/src/entities/factory.js +16 -4
  17. package/src/entities/set.js +13 -0
  18. package/src/exceptions.js +27 -19
  19. package/src/exposition.js +3 -2
  20. package/src/guard.js +17 -0
  21. package/src/index.js +6 -0
  22. package/src/locator.js +7 -2
  23. package/src/observation.js +1 -9
  24. package/src/operation.js +28 -7
  25. package/src/query/criteria.js +3 -3
  26. package/src/query/options.js +3 -2
  27. package/src/query.js +3 -1
  28. package/src/receiver.js +13 -10
  29. package/src/remote.js +5 -7
  30. package/src/state.js +85 -47
  31. package/src/transition.js +10 -8
  32. package/src/transmission.js +12 -3
  33. package/src/unmanaged.js +11 -0
  34. package/test/component.test.js +4 -3
  35. package/test/contract/conditions.test.js +5 -5
  36. package/test/contract/request.test.js +7 -7
  37. package/test/entities/entity.fixtures.js +5 -2
  38. package/test/entities/entity.test.js +6 -45
  39. package/test/state.test.js +0 -6
  40. package/types/bindings.d.ts +7 -5
  41. package/types/component.d.ts +4 -1
  42. package/types/extensions.d.ts +4 -3
  43. package/types/index.ts +1 -0
  44. package/types/locator.d.ts +2 -1
  45. package/types/operations.d.ts +6 -0
  46. package/types/query.d.ts +2 -0
  47. package/types/remote.d.ts +18 -0
  48. package/types/request.d.ts +3 -0
  49. package/types/storages.d.ts +11 -9
  50. package/src/contract/conditions.js +0 -21
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@toa.io/core",
3
- "version": "1.0.0-alpha.2",
3
+ "version": "1.0.0-alpha.200",
4
4
  "description": "Toa Core",
5
5
  "author": "temich <tema.gurtovoy@gmail.com>",
6
6
  "homepage": "https://github.com/toa-io/toa#readme",
@@ -21,13 +21,10 @@
21
21
  },
22
22
  "dependencies": {
23
23
  "@rsql/parser": "1.2.4",
24
- "@toa.io/console": "1.0.0-alpha.2",
25
- "@toa.io/generic": "1.0.0-alpha.2",
26
- "@toa.io/yaml": "1.0.0-alpha.2",
27
- "error-value": "0.3.0"
24
+ "@toa.io/generic": "1.0.0-alpha.173",
25
+ "@toa.io/yaml": "1.0.0-alpha.182",
26
+ "error-value": "0.3.0",
27
+ "openspan": "1.0.0-alpha.173"
28
28
  },
29
- "devDependencies": {
30
- "clone-deep": "4.0.1"
31
- },
32
- "gitHead": "7688e6e980a65c82ac2e459be4e355eebf406cd0"
29
+ "gitHead": "35b4adeedae2e9450ef44a74f42a53eff20ee203"
33
30
  }
package/src/assignment.js CHANGED
@@ -9,13 +9,22 @@ class Assignment extends Operation {
9
9
  }
10
10
 
11
11
  async commit (store) {
12
- const { scope, state, reply } = store
12
+ const {
13
+ scope,
14
+ state,
15
+ reply
16
+ } = store
13
17
 
14
18
  if (reply.error !== undefined) return
15
19
 
16
20
  scope.set(state)
17
21
 
18
- await this.scope.apply(scope)
22
+ const output = await this.scope.apply(scope)
23
+
24
+ // assignment returns new state by default
25
+ if (store.reply.output === undefined) {
26
+ store.reply.output = output
27
+ }
19
28
  }
20
29
  }
21
30
 
package/src/call.js CHANGED
@@ -18,6 +18,8 @@ class Call extends Connector {
18
18
  }
19
19
 
20
20
  async invoke (request = {}) {
21
+ request.input ??= null
22
+
21
23
  this.#contract.fit(request)
22
24
 
23
25
  // avoid validation on the recipient's side
@@ -37,6 +39,10 @@ class Call extends Connector {
37
39
  return reply.output
38
40
  }
39
41
  }
42
+
43
+ explain () {
44
+ return this.#contract.discovery
45
+ }
40
46
  }
41
47
 
42
48
  exports.Call = Call
package/src/cascade.js CHANGED
@@ -1,16 +1,15 @@
1
1
  'use strict'
2
2
 
3
- const { merge } = require('@toa.io/generic')
4
3
  const { Connector } = require('./connector')
5
4
 
6
5
  class Cascade extends Connector {
7
- #bridges
6
+ // #bridges
8
7
  #last
9
8
 
10
9
  constructor (bridges) {
11
10
  super()
12
11
 
13
- this.#bridges = bridges
12
+ // this.#bridges = bridges
14
13
  this.#last = bridges[bridges.length - 1]
15
14
 
16
15
  this.depends(bridges)
package/src/component.js CHANGED
@@ -1,40 +1,37 @@
1
1
  'use strict'
2
2
 
3
- const { console } = require('@toa.io/console')
3
+ const assert = require('node:assert')
4
+ const { console } = require('openspan')
4
5
  const { Connector } = require('./connector')
5
- const { NotImplementedException } = require('./exceptions')
6
6
 
7
- /**
8
- * @implements {toa.core.Component}
9
- */
10
7
  class Component extends Connector {
11
8
  locator
12
9
 
13
- #operations
10
+ /** @protected */
11
+ operations
14
12
 
15
13
  constructor (locator, operations) {
16
14
  super()
17
15
 
18
16
  this.locator = locator
19
- this.#operations = operations
17
+ this.operations = operations
20
18
 
21
19
  Object.values(operations).forEach((operation) => this.depends(operation))
22
20
  }
23
21
 
24
- async open () {
25
- console.info(`Runtime '${this.locator.id}' connected`)
26
- }
22
+ async invoke (endpoint, request) {
23
+ assert.ok(endpoint in this.operations,
24
+ `Endpoint '${endpoint}' is not provided by '${this.locator.id}'`)
27
25
 
28
- async dispose () {
29
- console.info(`Runtime '${this.locator.id}' disconnected`)
30
- }
26
+ const reply = await this.operations[endpoint].invoke(request)
31
27
 
32
- async invoke (endpoint, request) {
33
- if (!(endpoint in this.#operations)) {
34
- throw new NotImplementedException(`Endpoint '${endpoint}' not found in '${this.locator.id}'`)
35
- }
28
+ if (reply?.exception !== undefined)
29
+ console.error('Failed to execute operation', {
30
+ endpoint: `${this.locator.id}.${endpoint}`,
31
+ exception: reply.exception
32
+ })
36
33
 
37
- return this.#operations[endpoint].invoke(request)
34
+ return reply
38
35
  }
39
36
  }
40
37
 
@@ -1,6 +1,6 @@
1
1
  'use strict'
2
2
 
3
- const { console } = require('@toa.io/console')
3
+ const { console } = require('openspan')
4
4
  const { Connector } = require('./connector')
5
5
 
6
6
  class Composition extends Connector {
package/src/connector.js CHANGED
@@ -1,6 +1,6 @@
1
1
  'use strict'
2
2
 
3
- const { console } = require('@toa.io/console')
3
+ const { console } = require('openspan')
4
4
  const { newid } = require('@toa.io/generic')
5
5
 
6
6
  /**
@@ -86,8 +86,6 @@ class Connector {
86
86
 
87
87
  this.#disconnecting = undefined
88
88
 
89
- console.debug(`Connecting '${this.id}' with ${this.#dependencies.length} dependencies...`)
90
-
91
89
  this.#connecting = (async () => {
92
90
  await Promise.all(this.#dependencies.map((connector) => connector.connect()))
93
91
  await this.open()
@@ -100,8 +98,6 @@ class Connector {
100
98
  await this.disconnect(true)
101
99
  throw e
102
100
  }
103
-
104
- console.debug(`Connector '${this.id}' connected`)
105
101
  }
106
102
 
107
103
  /**
@@ -132,7 +128,8 @@ class Connector {
132
128
  const interval = setInterval(() => {
133
129
  const delay = +new Date() - start
134
130
 
135
- if (delay > DELAY) console.warn(`Connector ${this.id} still disconnecting (${delay})`)
131
+ if (delay > DELAY)
132
+ console.warn(`Connector ${this.id} still disconnecting (${delay})`)
136
133
  }, DELAY)
137
134
 
138
135
  if (interrupt !== true) await this.close()
@@ -145,8 +142,6 @@ class Connector {
145
142
  })()
146
143
 
147
144
  await this.#disconnecting
148
-
149
- console.debug(`Connector '${this.id}' disconnected`)
150
145
  }
151
146
 
152
147
  async reconnect () {
@@ -0,0 +1,22 @@
1
+ 'use strict'
2
+
3
+ const { SystemException } = require('../exceptions')
4
+
5
+ class Contract {
6
+ schema
7
+
8
+ constructor (schema) {
9
+ this.schema = schema
10
+ }
11
+
12
+ fit (value) {
13
+ const error = this.schema.fit(value)
14
+
15
+ if (error !== null)
16
+ throw new this.constructor.Exception(error, value)
17
+ }
18
+
19
+ static Exception = SystemException
20
+ }
21
+
22
+ exports.Contract = Contract
@@ -1,22 +1,39 @@
1
1
  'use strict'
2
2
 
3
3
  const schemas = require('./schemas')
4
- const { Conditions } = require('./conditions')
4
+ const { Contract } = require('./contract')
5
5
  const { ResponseContractException } = require('../exceptions')
6
6
 
7
- class Reply extends Conditions {
7
+ class Reply extends Contract {
8
8
  static Exception = ResponseContractException
9
9
 
10
- /**
11
- * @returns {toa.schema.JSON}
12
- */
13
- static schema (output, error) {
10
+ static schema (output, errors) {
14
11
  const schema = { type: 'object', properties: {}, additionalProperties: false }
15
12
 
16
- if (output !== undefined) schema.properties.output = output
13
+ if (output !== undefined) {
14
+ if (output.type === 'object')
15
+ output.additionalProperties = true
16
+ else if (output.type === 'array' && output.items?.type === 'object')
17
+ output.items.additionalProperties = true
17
18
 
18
- if (error !== undefined) schema.properties.error = error
19
- else schema.properties.error = schemas.error
19
+ schema.properties.output = output
20
+ }
21
+
22
+ if (errors !== undefined)
23
+ schema.properties.error = {
24
+ type: 'object',
25
+ properties: {
26
+ code: {
27
+ enum: errors
28
+ },
29
+ message: {
30
+ type: 'string'
31
+ }
32
+ },
33
+ required: ['code']
34
+ }
35
+ else
36
+ schema.properties.error = schemas.error
20
37
 
21
38
  return schema
22
39
  }
@@ -2,9 +2,20 @@
2
2
 
3
3
  const schemas = require('./schemas')
4
4
  const { RequestContractException } = require('../exceptions')
5
- const { Conditions } = require('./conditions')
5
+ const { Contract } = require('./contract')
6
+
7
+ class Request extends Contract {
8
+ /** @readonly */
9
+ discovery = {}
10
+
11
+ constructor (schema, definition) {
12
+ super(schema)
13
+
14
+ for (const key of ['input', 'output', 'errors'])
15
+ if (definition[key] !== undefined)
16
+ this.discovery[key] = definition[key]
17
+ }
6
18
 
7
- class Request extends Conditions {
8
19
  static Exception = RequestContractException
9
20
 
10
21
  /**
@@ -13,7 +24,7 @@ class Request extends Conditions {
13
24
  static schema (definition, entity) {
14
25
  const schema = {
15
26
  type: 'object',
16
- properties: { authentic: { type: 'boolean' } },
27
+ properties: { authentic: { type: 'boolean' }, task: { type: 'boolean' } },
17
28
  additionalProperties: true
18
29
  }
19
30
 
@@ -22,9 +33,8 @@ class Request extends Conditions {
22
33
  if (definition.input !== undefined) {
23
34
  schema.properties.input = definition.input
24
35
  required.push('input')
25
- } else {
36
+ } else
26
37
  schema.properties.input = { type: 'null' }
27
- }
28
38
 
29
39
  if (entity === undefined)
30
40
  definition.query = false
@@ -1,11 +1,22 @@
1
1
  type: object
2
2
  properties:
3
- id: { }
3
+ id:
4
+ type: string
5
+ ids:
6
+ type: array
7
+ uniqueItems: true
8
+ minItems: 1
9
+ items:
10
+ type: string
4
11
  version:
5
12
  type: integer
6
13
  minimum: 0
7
14
  criteria:
8
15
  type: string
16
+ search:
17
+ type: string
18
+ sample:
19
+ type: number
9
20
  omit:
10
21
  type: integer
11
22
  minimum: 0
@@ -18,14 +29,15 @@ properties:
18
29
  minItems: 1
19
30
  items:
20
31
  type: string
21
- pattern: ^[a-zA-Z]+([-a-zA-Z0-9]*[a-zA-Z0-9]+)?(:(asc|desc))?$
32
+ pattern: ^\w{1,32}(?::(?:asc|desc))?$
22
33
  projection:
23
34
  type: array
24
35
  uniqueItems: true
25
36
  minItems: 1
26
37
  items:
27
38
  type: string
28
- pattern: ^([a-zA-Z]+([-a-zA-Z0-9]*[a-zA-Z0-9]+)?)$
29
39
  not:
30
40
  const: id
41
+ deleted:
42
+ type: boolean
31
43
  additionalProperties: false
package/src/discovery.js CHANGED
@@ -1,6 +1,6 @@
1
1
  'use strict'
2
2
 
3
- const { console } = require('@toa.io/console')
3
+ const { console } = require('openspan')
4
4
  const { Connector } = require('./connector')
5
5
 
6
6
  class Discovery extends Connector {
@@ -25,14 +25,11 @@ class Discovery extends Connector {
25
25
  this.depends(this.#lookups[id])
26
26
  }
27
27
 
28
- console.debug(`Sending lookup request to '${id}'`)
29
-
30
- const warning = () => console.warn(`Waiting for lookup response from '${id}'...`)
28
+ const warning = () => console.warn(`Waiting for lookup response`, { component: id })
31
29
  const timeout = setTimeout(warning, TIMEOUT)
32
30
 
33
31
  const output = await this.#lookups[id].invoke()
34
32
 
35
- console.debug(`Lookup response from '${id}' received`)
36
33
  clearTimeout(timeout)
37
34
 
38
35
  return output
package/src/effect.js ADDED
@@ -0,0 +1,19 @@
1
+ 'use strict'
2
+
3
+ const { Observation } = require('./observation')
4
+
5
+ class Effect extends Observation {
6
+
7
+ async acquire (store) {
8
+ const { query, entity, input } = store.request
9
+
10
+ if (entity === undefined)
11
+ return super.acquire(store)
12
+
13
+ store.scope = await this.scope.ensure(query, entity, input)
14
+ store.state = store.scope.get()
15
+ }
16
+
17
+ }
18
+
19
+ exports.Effect = Effect
@@ -1,6 +1,5 @@
1
1
  'use strict'
2
2
 
3
- const { merge, overwrite, newid } = require('@toa.io/generic')
4
3
  const { EntityContractException } = require('../exceptions')
5
4
 
6
5
  class Changeset {
@@ -14,7 +13,7 @@ class Changeset {
14
13
  this.query = query
15
14
 
16
15
  this.#schema = schema
17
- this.#state = schema.system()
16
+ this.#state = {}
18
17
  }
19
18
 
20
19
  get () {
@@ -22,25 +21,19 @@ class Changeset {
22
21
  }
23
22
 
24
23
  set (value) {
25
- const error = this.#schema.adapt(value)
24
+ const error = this.#schema.match(value)
26
25
 
27
- if (error !== null) throw new EntityContractException(error)
26
+ if (error !== null)
27
+ throw new EntityContractException(error, value)
28
+
29
+ delete value._version
30
+ value._updated = Date.now()
28
31
 
29
32
  this.#state = value
30
33
  }
31
34
 
32
35
  export () {
33
- const changeset = this.#state
34
- const result = { changeset }
35
- const insert = merge({ id: newid() }, changeset)
36
- const error = this.#schema.fit(insert)
37
-
38
- if (error === null) {
39
- delete insert.id
40
- result.insert = overwrite(insert, changeset)
41
- }
42
-
43
- return result
36
+ return this.#state
44
37
  }
45
38
  }
46
39
 
@@ -1,20 +1,22 @@
1
1
  'use strict'
2
2
 
3
3
  const { difference, newid } = require('@toa.io/generic')
4
-
5
- const { EntityContractException } = require('../exceptions')
4
+ const { EntityContractException, EntityGuardException } = require('../exceptions')
6
5
 
7
6
  class Entity {
7
+ deleted = false
8
8
  #schema
9
+ #guards
9
10
  #origin = null
10
11
  #state
11
12
 
12
- constructor (schema, argument) {
13
+ constructor (schema, argument, guards) {
13
14
  this.#schema = schema
15
+ this.#guards = guards
14
16
 
15
17
  if (typeof argument === 'object') {
16
18
  const object = structuredClone(argument)
17
- this.set(object)
19
+ this.#set(object)
18
20
  this.#origin = argument
19
21
  } else {
20
22
  const id = argument === undefined ? newid() : argument
@@ -26,30 +28,67 @@ class Entity {
26
28
  return this.#state
27
29
  }
28
30
 
29
- set (value) {
30
- const error = this.#schema.fit(value)
31
+ set (value, optional = false) {
32
+ const error = optional ? this.#schema.fitOptional(value) : this.#schema.fit(value)
33
+
34
+ if (error !== null)
35
+ throw new EntityContractException(error, value)
31
36
 
32
- if (error !== null) throw new EntityContractException(error)
37
+ if (!optional)
38
+ this.#guard(value)
33
39
 
34
40
  this.#set(value)
35
41
  }
36
42
 
37
- event () {
43
+ event (input = undefined) {
38
44
  return {
39
45
  origin: this.#origin,
40
46
  state: this.#state,
41
- changeset: this.#origin === null ? this.#state : difference(this.#origin, this.#state)
47
+ changeset: this.#origin === null ? this.#state : difference(this.#origin, this.#state),
48
+ trailers: this.#state._trailers,
49
+ input
42
50
  }
43
51
  }
44
52
 
45
53
  #init (id) {
46
- const value = { ...this.#schema.defaults({ id }), _version: 0 }
54
+ const value = { id, _version: 0 }
47
55
 
48
- this.#set(value)
56
+ this.set(value, true)
57
+ }
58
+
59
+ #guard (value) {
60
+ if (this.#guards === undefined)
61
+ return
62
+
63
+ for (const guard of this.#guards) {
64
+ const ok = guard.fit(value)
65
+
66
+ if (ok === false)
67
+ throw new EntityGuardException(guard.name, value)
68
+ }
49
69
  }
50
70
 
51
71
  #set (value) {
52
- Object.defineProperty(value, 'id', { writable: false, configurable: false })
72
+ if (!('_trailers' in value))
73
+ Object.defineProperty(value, '_trailers', {
74
+ writable: false,
75
+ configurable: false,
76
+ enumerable: false,
77
+ value: {}
78
+ })
79
+
80
+ if (!('_created' in value)) {
81
+ value._created = Date.now()
82
+ value._updated ??= value._created
83
+ }
84
+
85
+ if ('_deleted' in value && value._deleted !== null)
86
+ this.deleted = true
87
+
88
+ if (this.#state !== undefined) {
89
+ value._updated = Date.now()
90
+ value._version++
91
+ }
53
92
 
54
93
  this.#state = value
55
94
  }
@@ -1,27 +1,39 @@
1
1
  'use strict'
2
2
 
3
+ const { newid } = require('@toa.io/generic')
4
+
3
5
  const { Entity } = require('./entity')
4
6
  const { EntitySet } = require('./set')
5
7
  const { Changeset } = require('./changeset')
6
8
 
7
9
  class Factory {
8
10
  #schema
11
+ #guards
9
12
 
10
- constructor (schema) {
13
+ constructor (schema, guards) {
11
14
  this.#schema = schema
15
+ this.#guards = guards
16
+ }
17
+
18
+ fit (values) {
19
+ this.#schema.validate({ id: newid(), ...values }, 'Entity')
12
20
  }
13
21
 
14
22
  init (id) {
15
- return new Entity(this.#schema, id)
23
+ return new Entity(this.#schema, id, this.#guards)
16
24
  }
17
25
 
18
26
  object (record) {
19
- return new Entity(this.#schema, record)
27
+ return new Entity(this.#schema, record, this.#guards)
20
28
  }
21
29
 
22
- objects (recordset) {
30
+ objects (recordset, init) {
23
31
  const set = recordset.map((record) => this.object(record))
24
32
 
33
+ if (init !== undefined)
34
+ for (const id of init)
35
+ set.unshift(this.init(id))
36
+
25
37
  return new EntitySet(set)
26
38
  }
27
39
 
@@ -1,5 +1,7 @@
1
1
  'use strict'
2
2
 
3
+ const { SystemException } = require("../exceptions")
4
+
3
5
  class EntitySet {
4
6
  #set
5
7
 
@@ -10,6 +12,17 @@ class EntitySet {
10
12
  get () {
11
13
  return this.#set.map((entity) => entity.get())
12
14
  }
15
+
16
+ set (values) {
17
+ if (values.length !== this.#set.length)
18
+ throw new SystemException('Objects array must not be modified')
19
+
20
+ values.forEach((value, index) => this.#set[index].set(value))
21
+ }
22
+
23
+ events (input = undefined) {
24
+ return this.#set.map((entity) => entity.event(input))
25
+ }
13
26
  }
14
27
 
15
28
  exports.EntitySet = EntitySet