dal-engine-core-js-lib-dev 0.0.4 → 0.0.6
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.
- package/dist/index.cjs +595 -197
- package/dist/index.esm.js +595 -197
- package/package.json +1 -1
- package/src/Base.js +10 -5
- package/src/BehavioralControlGraph/BehavioralControlGraph.js +76 -37
- package/src/BehavioralControlGraph/GraphNode.js +61 -25
- package/src/BehavioralControlGraph/Graphs.js +113 -11
- package/src/DALEngine.js +154 -53
- package/src/Errors/BehaviorAlreadyExistsError.js +10 -0
- package/src/Errors/GraphWithNameExistsError.js +10 -0
- package/src/Errors/ParticipantAlreadyExistsError.js +10 -0
- package/src/Errors/TransitionAlreadyExistsError.js +11 -0
- package/src/Errors/UnknownGraph.js +10 -0
- package/src/Errors/UnknownParticipantError.js +9 -0
- package/src/Members/Behavior.js +44 -22
- package/src/Members/Invariant.js +37 -22
- package/src/Members/Participant.js +28 -20
- package/src/TYPES.js +2 -3
- package/src/helpers/isLoadedFromFile.js +15 -0
- package/tests/DALEngine.test.js +19 -0
- package/tests/Graphs.test.js +80 -0
- package/tests/Invariant.test.js +1 -0
package/dist/index.esm.js
CHANGED
|
@@ -1,23 +1,49 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
class DALEngineError extends Error {
|
|
2
|
+
constructor (message) {
|
|
3
|
+
super(message);
|
|
4
|
+
}
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
class GraphWithNameExistsError extends DALEngineError {
|
|
8
|
+
constructor (name) {
|
|
9
|
+
let msg = `Graph with name "${name}" already exists.`;
|
|
10
|
+
super(msg);
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
class UnknownGraph extends DALEngineError {
|
|
15
|
+
constructor (name) {
|
|
16
|
+
let msg = `Graph with name "${name}" does not exist.`;
|
|
17
|
+
super(msg);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
|
|
4
21
|
class Base {
|
|
5
22
|
/**
|
|
6
|
-
* Initialize the base class.
|
|
23
|
+
* Initialize the base class of all members of the design.
|
|
24
|
+
* The dal_engine_uid is a unique identifier for each instance.
|
|
25
|
+
* When the design is serialized, the dal_engine_uid is used
|
|
26
|
+
* to identify when the design is being loaded from file.
|
|
7
27
|
* @param {String} name
|
|
8
28
|
*/
|
|
9
29
|
constructor () {
|
|
10
|
-
this.
|
|
30
|
+
this.dal_engine_uid = crypto.randomUUID();
|
|
11
31
|
}
|
|
12
32
|
|
|
33
|
+
/**
|
|
34
|
+
* Returns the type of object as specifed in TYPES.js.
|
|
35
|
+
* (e.g. participant, behavior, invariant, graph node, etc.)
|
|
36
|
+
* @returns {Number} The type of node.
|
|
37
|
+
*/
|
|
13
38
|
getType () {
|
|
14
39
|
return this.type;
|
|
15
40
|
}
|
|
16
41
|
}
|
|
17
42
|
|
|
18
|
-
class
|
|
19
|
-
constructor (
|
|
20
|
-
|
|
43
|
+
class BehaviorAlreadyExistsError extends DALEngineError {
|
|
44
|
+
constructor (name) {
|
|
45
|
+
let msg = `Node with Behavior name "${name}" already exists in the graph.`;
|
|
46
|
+
super(msg);
|
|
21
47
|
}
|
|
22
48
|
}
|
|
23
49
|
|
|
@@ -31,6 +57,18 @@ class InvalidTransitionError extends DALEngineError {
|
|
|
31
57
|
}
|
|
32
58
|
}
|
|
33
59
|
|
|
60
|
+
class MissingAttributes extends DALEngineError {
|
|
61
|
+
constructor (type, attribute) {
|
|
62
|
+
let msg;
|
|
63
|
+
if (Array.isArray(attribute) && attribute.length > 1) {
|
|
64
|
+
msg = `"${type}" must be initialized with the attributes "${attribute}".`;
|
|
65
|
+
} else {
|
|
66
|
+
msg = `"${type}" must be initialized with the attribute "${attribute}".`;
|
|
67
|
+
}
|
|
68
|
+
super(msg);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
34
72
|
class UnknownBehaviorError extends DALEngineError {
|
|
35
73
|
constructor (behaviorName) {
|
|
36
74
|
super(`The behavior named "${behaviorName}" was not found in graph.`);
|
|
@@ -40,38 +78,69 @@ class UnknownBehaviorError extends DALEngineError {
|
|
|
40
78
|
}
|
|
41
79
|
}
|
|
42
80
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
81
|
+
/**
|
|
82
|
+
* Checks if the provided object was loaded from a file. This is determind by
|
|
83
|
+
* checking if the argument is an object and has a "dal_engine_uid" attribute,
|
|
84
|
+
* which is added to all objects when they are created and is written to file
|
|
85
|
+
* when the object is serialized.
|
|
86
|
+
*
|
|
87
|
+
* @param {*} obj The object to check.
|
|
88
|
+
* @returns {Boolean} True if the object was loaded from file, false otherwise.
|
|
89
|
+
*/
|
|
90
|
+
const isLoadedFromFile = (obj) => {
|
|
91
|
+
return typeof obj === "object" && obj !== null
|
|
92
|
+
&& !Array.isArray(obj) && Object.hasOwn(obj, "dal_engine_uid");
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
class ParticipantAlreadyExistsError extends DALEngineError {
|
|
96
|
+
constructor (name) {
|
|
97
|
+
let msg = `Participant with name "${name}" already exists in the behavior.`;
|
|
51
98
|
super(msg);
|
|
52
99
|
}
|
|
53
100
|
}
|
|
54
101
|
|
|
102
|
+
class UnknownParticipantError extends DALEngineError {
|
|
103
|
+
constructor (participantName) {
|
|
104
|
+
super(`The participant named "${participantName}" was not found in the behavior.`);
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
55
108
|
let ENGINE_TYPES$1 = {
|
|
56
109
|
BEHAVIOR: 1,
|
|
57
110
|
INVARIANT: 2,
|
|
58
111
|
PARTICIPANT: 3,
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
GRAPH_NODE: 6,
|
|
112
|
+
BEHAVIORAL_CONTROL_GRAPH: 4,
|
|
113
|
+
GRAPH_NODE: 5,
|
|
62
114
|
};
|
|
63
115
|
ENGINE_TYPES$1 = Object.freeze(ENGINE_TYPES$1);
|
|
64
116
|
|
|
65
117
|
var ENGINE_TYPES = ENGINE_TYPES$1;
|
|
66
118
|
|
|
67
|
-
/**
|
|
68
|
-
* Class representing a Invariant in the design.
|
|
69
|
-
*/
|
|
70
119
|
class Invariant extends Base {
|
|
71
120
|
/**
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
121
|
+
* Class representing a Invariant in the design. Invariants are rules that
|
|
122
|
+
* define a valid world state for participants in behaviors. The invariants
|
|
123
|
+
* are used to check if the design has entered a semantically invalid state
|
|
124
|
+
* during execution.
|
|
125
|
+
*
|
|
126
|
+
* The expected attributes in args are:
|
|
127
|
+
* - name: Name of the invariant.
|
|
128
|
+
* - rule: The rule that defines the how to enforce the invariant. This
|
|
129
|
+
* will be formally defined in a collection of invariant rules that can
|
|
130
|
+
* be chosen from when creating an invariant.
|
|
131
|
+
*
|
|
132
|
+
* Currently, the only supported invariant rule is the string min length
|
|
133
|
+
* rule, which can be specified as follows:
|
|
134
|
+
* {
|
|
135
|
+
* "name": "MinLengthConstraint",
|
|
136
|
+
* "rule": {
|
|
137
|
+
* "type": "minLength",
|
|
138
|
+
* "keys": ["value", "name"],
|
|
139
|
+
* "value": 1,
|
|
140
|
+
* },
|
|
141
|
+
* }
|
|
142
|
+
*
|
|
143
|
+
* @param {Object} args The arguments to initialize the invariant with.
|
|
75
144
|
*/
|
|
76
145
|
constructor (args) {
|
|
77
146
|
super();
|
|
@@ -79,17 +148,13 @@ class Invariant extends Base {
|
|
|
79
148
|
this.invariantViolated = false;
|
|
80
149
|
this.invariantType = null;
|
|
81
150
|
this.traceId = null;
|
|
82
|
-
|
|
83
|
-
this._loadInvariantFromJSON(args);
|
|
84
|
-
} else {
|
|
85
|
-
this._loadArgs(args);
|
|
86
|
-
}
|
|
151
|
+
(isLoadedFromFile(args) ? this._loadFromFile(args) : this._loadArgs(args));
|
|
87
152
|
}
|
|
88
153
|
|
|
89
154
|
/**
|
|
90
|
-
* Loads the provided arguments.
|
|
155
|
+
* Loads the invariant from the provided arguments.
|
|
91
156
|
* @throws {MissingAttributes} Thrown when required attr is not present.
|
|
92
|
-
* @param {Object} args
|
|
157
|
+
* @param {Object} args The arguments to initialize the invariant with.
|
|
93
158
|
*/
|
|
94
159
|
_loadArgs (args) {
|
|
95
160
|
const expectedAttributes = ["name", "rule"];
|
|
@@ -106,10 +171,10 @@ class Invariant extends Base {
|
|
|
106
171
|
}
|
|
107
172
|
|
|
108
173
|
/**
|
|
109
|
-
* Loads the
|
|
110
|
-
* @param {Object} invariantJSON
|
|
174
|
+
* Loads the invariant from file.
|
|
175
|
+
* @param {Object} invariantJSON The JSON object to load the invariant from.
|
|
111
176
|
*/
|
|
112
|
-
|
|
177
|
+
_loadFromFile (invariantJSON) {
|
|
113
178
|
for (const [key, value] of Object.entries(invariantJSON)) {
|
|
114
179
|
this[key] = value;
|
|
115
180
|
} // Reset these because they are set by the execution
|
|
@@ -118,9 +183,10 @@ class Invariant extends Base {
|
|
|
118
183
|
}
|
|
119
184
|
|
|
120
185
|
/**
|
|
121
|
-
* Evaluate the invariant
|
|
122
|
-
*
|
|
123
|
-
* @
|
|
186
|
+
* Evaluate the invariant by applying the invariant rule to the provided
|
|
187
|
+
* value. Returns a flag indicating whether the invariant was violated.
|
|
188
|
+
* @param {*} value The value to evaluate the invariant on.
|
|
189
|
+
* @returns {Boolean} Returns flag indicating if invariant was violated.
|
|
124
190
|
*/
|
|
125
191
|
evaluate (value) {
|
|
126
192
|
this.invariantViolated = false;
|
|
@@ -131,8 +197,8 @@ class Invariant extends Base {
|
|
|
131
197
|
}
|
|
132
198
|
|
|
133
199
|
/**
|
|
134
|
-
* Enforce the string min length invariant
|
|
135
|
-
* @param value
|
|
200
|
+
* Enforce the string min length invariant.
|
|
201
|
+
* @param {*} value The value to enforce the invariant on.
|
|
136
202
|
*/
|
|
137
203
|
enforceMinLength (value) {
|
|
138
204
|
if ("keys" in this.rule) {
|
|
@@ -168,7 +234,7 @@ class Invariant extends Base {
|
|
|
168
234
|
* automated testing.
|
|
169
235
|
*
|
|
170
236
|
* Substrate invariants correspond to a trace that represents
|
|
171
|
-
* an environment
|
|
237
|
+
* an environment which reveals a limitation of the substrate,
|
|
172
238
|
* thus motivating the invariant. It is also the environment
|
|
173
239
|
* in which an implementation can prove that it respects this
|
|
174
240
|
* invariant.
|
|
@@ -185,14 +251,17 @@ class Invariant extends Base {
|
|
|
185
251
|
}
|
|
186
252
|
}
|
|
187
253
|
|
|
188
|
-
/**
|
|
189
|
-
* Class representing a participant in the design.
|
|
190
|
-
*/
|
|
191
254
|
class Participant extends Base {
|
|
192
255
|
/**
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
256
|
+
* Class representing a participant in the design. The participants are
|
|
257
|
+
* entites in deisgn that participate in the behavior. They are mapped onto
|
|
258
|
+
* the implementation and their value is loaded from the execution. The
|
|
259
|
+
* participants define a valid world state for the behavior to happen in
|
|
260
|
+
* through invariants. When the value of the participant violates an
|
|
261
|
+
* invariant, the design has entered a semantically invalid state and is
|
|
262
|
+
* the root cause of downstream failure(s).
|
|
263
|
+
*
|
|
264
|
+
* @param {Object} args The arguments to initialize the participant.
|
|
196
265
|
*/
|
|
197
266
|
constructor (args) {
|
|
198
267
|
super();
|
|
@@ -200,11 +269,7 @@ class Participant extends Base {
|
|
|
200
269
|
this.invariants = [];
|
|
201
270
|
this.abstractionId = null;
|
|
202
271
|
this.invariantViolated = false;
|
|
203
|
-
|
|
204
|
-
this._loadParticipantFromJSON(args);
|
|
205
|
-
} else {
|
|
206
|
-
this._loadArgs(args);
|
|
207
|
-
}
|
|
272
|
+
(isLoadedFromFile(args) ? this._loadFromFile(args) : this._loadArgs(args));
|
|
208
273
|
}
|
|
209
274
|
|
|
210
275
|
/**
|
|
@@ -228,9 +293,9 @@ class Participant extends Base {
|
|
|
228
293
|
|
|
229
294
|
/**
|
|
230
295
|
* Loads the participant from a JSON object.
|
|
231
|
-
* @param {Object} participantJSON
|
|
296
|
+
* @param {Object} participantJSON The JSON object read from file.
|
|
232
297
|
*/
|
|
233
|
-
|
|
298
|
+
_loadFromFile (participantJSON) {
|
|
234
299
|
for (const [key, value] of Object.entries(participantJSON)) {
|
|
235
300
|
if (key === "invariants") {
|
|
236
301
|
value.forEach(node => this.invariants.push(new Invariant(node)));
|
|
@@ -241,8 +306,8 @@ class Participant extends Base {
|
|
|
241
306
|
|
|
242
307
|
/**
|
|
243
308
|
* Adds an invariant to the participant.
|
|
244
|
-
* @param {Invariant} invariant
|
|
245
|
-
* @returns
|
|
309
|
+
* @param {Invariant} invariant The invariant to add.
|
|
310
|
+
* @returns {Invariant} The invariant that was added.
|
|
246
311
|
*/
|
|
247
312
|
addInvariant (invariant) {
|
|
248
313
|
this.invariants.push(invariant);
|
|
@@ -250,16 +315,18 @@ class Participant extends Base {
|
|
|
250
315
|
}
|
|
251
316
|
|
|
252
317
|
/**
|
|
253
|
-
* Sets the value of
|
|
254
|
-
* @param {*} value
|
|
318
|
+
* Sets the value of this participant.
|
|
319
|
+
* @param {*} value The value to set for the participant.
|
|
255
320
|
*/
|
|
256
321
|
setValue (value) {
|
|
257
322
|
this.value = value;
|
|
258
323
|
}
|
|
259
324
|
|
|
260
325
|
/**
|
|
261
|
-
* Enforces the
|
|
262
|
-
*
|
|
326
|
+
* Enforces the participant's invariants. Raises a flag indicating if an
|
|
327
|
+
* invariant was violated and counts the number of invariant violations.
|
|
328
|
+
*
|
|
329
|
+
* @returns {Boolean} Returns flag indicating if any invariant was violated.
|
|
263
330
|
*/
|
|
264
331
|
enforceInvariants () {
|
|
265
332
|
this.invariantViolated = false;
|
|
@@ -279,19 +346,23 @@ class Participant extends Base {
|
|
|
279
346
|
* This abstraction id will be used to assign a value to the
|
|
280
347
|
* participant from the execution using the logged abstraction id.
|
|
281
348
|
*
|
|
282
|
-
* @param {String} abstractionId
|
|
349
|
+
* @param {String} abstractionId The abstraction ID to map to the
|
|
350
|
+
* participant.
|
|
283
351
|
*/
|
|
284
352
|
mapAbstraction (abstractionId) {
|
|
353
|
+
/**
|
|
354
|
+
* TODO: Much like the behavior, I am settling on a clean way to map
|
|
355
|
+
* the participant onto the implementation without introducing new
|
|
356
|
+
* unncessary layers.
|
|
357
|
+
*/
|
|
285
358
|
this.abstractionId = abstractionId;
|
|
286
359
|
}
|
|
287
360
|
}
|
|
288
361
|
|
|
289
|
-
/**
|
|
290
|
-
* Class representing a Behavior in the design.
|
|
291
|
-
*/
|
|
292
362
|
class Behavior extends Base {
|
|
293
363
|
/**
|
|
294
364
|
* Initialize the Behavior.
|
|
365
|
+
*
|
|
295
366
|
* @param {String} name
|
|
296
367
|
* @param args
|
|
297
368
|
*/
|
|
@@ -301,15 +372,12 @@ class Behavior extends Base {
|
|
|
301
372
|
this.participants = [];
|
|
302
373
|
this.abstractionIds = [];
|
|
303
374
|
this.invalidWorldState = false;
|
|
304
|
-
|
|
305
|
-
this._loadBehaviorFromJSON(args);
|
|
306
|
-
} else {
|
|
307
|
-
this._loadArgs(args);
|
|
308
|
-
}
|
|
375
|
+
(isLoadedFromFile(args) ? this._loadFromFile(args) : this._loadArgs(args));
|
|
309
376
|
}
|
|
310
377
|
|
|
311
378
|
/**
|
|
312
379
|
* Loads the provided arguments.
|
|
380
|
+
*
|
|
313
381
|
* @throws {MissingAttributes} Thrown when required attr is not present.
|
|
314
382
|
* @param {Object} args
|
|
315
383
|
*/
|
|
@@ -328,10 +396,12 @@ class Behavior extends Base {
|
|
|
328
396
|
}
|
|
329
397
|
|
|
330
398
|
/**
|
|
331
|
-
* Loads the behavior from a JSON object.
|
|
332
|
-
*
|
|
399
|
+
* Loads the behavior from a JSON object that was read from file.
|
|
400
|
+
*
|
|
401
|
+
* @param {Object} behaviorJSON The JSON object representing the behavior
|
|
402
|
+
* read from file.
|
|
333
403
|
*/
|
|
334
|
-
|
|
404
|
+
_loadFromFile (behaviorJSON) {
|
|
335
405
|
for (const [key, value] of Object.entries(behaviorJSON)) {
|
|
336
406
|
if (key === "participants") {
|
|
337
407
|
value.forEach(node => this.participants.push(new Participant(node)));
|
|
@@ -342,45 +412,73 @@ class Behavior extends Base {
|
|
|
342
412
|
|
|
343
413
|
/**
|
|
344
414
|
* Adds a participant to the behavior.
|
|
345
|
-
*
|
|
346
|
-
* @
|
|
415
|
+
*
|
|
416
|
+
* @param {Participant} participant The participant to add.
|
|
417
|
+
* @returns {Participant} The added participant.
|
|
418
|
+
* @throws {ParticipantAlreadyExistsError} Thrown when a participant with
|
|
419
|
+
* the same name already exists in the behavior.
|
|
347
420
|
*/
|
|
348
421
|
addParticipant (participant) {
|
|
422
|
+
if (this.participants.some(p => p.name === participant.name)) {
|
|
423
|
+
throw new ParticipantAlreadyExistsError(participant.name);
|
|
424
|
+
}
|
|
349
425
|
this.participants.push(participant);
|
|
350
426
|
return participant;
|
|
351
427
|
}
|
|
352
428
|
|
|
353
429
|
/**
|
|
354
|
-
*
|
|
355
|
-
*
|
|
356
|
-
*
|
|
430
|
+
* Sets the value of a participant and checks for invariant violations.
|
|
431
|
+
* If any invariant is violated, the world state for this behavior is
|
|
432
|
+
* marked as invalid.
|
|
433
|
+
*
|
|
434
|
+
* @param {String} name Name of the participant whose value is being set.
|
|
435
|
+
* @param {*} value Value to set for the participant.
|
|
436
|
+
* @throws {UnknownParticipantError} Thrown when a participant with the
|
|
437
|
+
* provided name does not exist in the behavior.
|
|
357
438
|
*/
|
|
358
|
-
setParticipantValue (
|
|
359
|
-
const participant = this.participants.find(obj => obj.name ===
|
|
439
|
+
setParticipantValue (name, value) {
|
|
440
|
+
const participant = this.participants.find(obj => obj.name === name);
|
|
441
|
+
if (!participant) {
|
|
442
|
+
throw new UnknownParticipantError(name);
|
|
443
|
+
}
|
|
360
444
|
participant.value = value;
|
|
361
|
-
|
|
362
|
-
if (violation) {
|
|
445
|
+
if (participant.enforceInvariants()) {
|
|
363
446
|
this.invalidWorldState = true;
|
|
364
447
|
}
|
|
365
448
|
}
|
|
366
449
|
|
|
367
450
|
/**
|
|
368
|
-
* Maps the abstraction id from
|
|
369
|
-
*
|
|
451
|
+
* Maps the abstraction id from implementation to the behavior.
|
|
452
|
+
*
|
|
453
|
+
* @param {String} abstractionId ID of mapped abstraction.
|
|
370
454
|
*/
|
|
371
455
|
addMapping (abstractionId) {
|
|
456
|
+
/**
|
|
457
|
+
* TODO: After some more thinking, it seems to me that the
|
|
458
|
+
* uniqe identifier should be a file name and line number.
|
|
459
|
+
* It doesn't make sense to create a new abstraction id,
|
|
460
|
+
* however, I will resolve this soon and remove this TODO.
|
|
461
|
+
*/
|
|
372
462
|
this.abstractionIds.push(abstractionId);
|
|
373
463
|
}
|
|
374
464
|
}
|
|
375
465
|
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
466
|
+
class TransitionAlreadyExistsError extends DALEngineError {
|
|
467
|
+
constructor (behaviorName, transitionName) {
|
|
468
|
+
let msg = `Node with behavior named "${behaviorName}" already has a transition\
|
|
469
|
+
to behavior "${transitionName}".`;
|
|
470
|
+
super(msg);
|
|
471
|
+
}
|
|
472
|
+
}
|
|
473
|
+
|
|
379
474
|
class GraphNode extends Base {
|
|
380
475
|
/**
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
476
|
+
* Class representing a behavioral control graph node. Each node has a
|
|
477
|
+
* behavior and a list of behaviors it can transition to. The node also
|
|
478
|
+
* has flags to indicate if the behavior is atomic or if the node is a
|
|
479
|
+
* design fork.
|
|
480
|
+
*
|
|
481
|
+
* @param {Object} args The args to initialize the graph node.
|
|
384
482
|
*/
|
|
385
483
|
constructor (args) {
|
|
386
484
|
super();
|
|
@@ -388,28 +486,41 @@ class GraphNode extends Base {
|
|
|
388
486
|
this._behavior = null;
|
|
389
487
|
this._goToBehaviorIds = [];
|
|
390
488
|
this._isAtomic = false;
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
489
|
+
this._isDesignFork = false;
|
|
490
|
+
(isLoadedFromFile(args) ? this._loadFromFile(args) : this._loadArgs(args));
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
/**
|
|
494
|
+
* Loads the provided arguments.
|
|
495
|
+
* @param {Object} args Arguments to initialize the graph node with.
|
|
496
|
+
* @throws {MissingAttributes} Thrown when required attr is not present.
|
|
497
|
+
*/
|
|
498
|
+
_loadArgs (args) {
|
|
499
|
+
const expectedAttributes = ["behavior", "goToBehaviorIds", "isAtomic", "isDesignFork"];
|
|
500
|
+
if (typeof args !== "object" || args === null || Array.isArray(args)) {
|
|
501
|
+
// Not an object, so all attributes are missing.
|
|
502
|
+
throw new MissingAttributes("GraphNode", expectedAttributes);
|
|
398
503
|
}
|
|
504
|
+
expectedAttributes.forEach((attr) => {
|
|
505
|
+
if (!(attr in args)) {
|
|
506
|
+
throw new MissingAttributes("GraphNode", attr);
|
|
507
|
+
}
|
|
508
|
+
this["_" + attr] = args[attr];
|
|
509
|
+
});
|
|
399
510
|
}
|
|
400
511
|
|
|
401
512
|
/**
|
|
402
|
-
* Loads the
|
|
403
|
-
* @param {Object}
|
|
513
|
+
* Loads the node from file.
|
|
514
|
+
* @param {Object} nodeJSON The JSON object read from file.
|
|
404
515
|
*/
|
|
405
|
-
|
|
406
|
-
for (const [key, value] of Object.entries(
|
|
516
|
+
_loadFromFile (nodeJSON) {
|
|
517
|
+
for (const [key, value] of Object.entries(nodeJSON)) {
|
|
407
518
|
if (key === "behavior") {
|
|
408
519
|
this._behavior = new Behavior(value);
|
|
409
|
-
} else if (key === "
|
|
520
|
+
} else if (key === "goToBehaviorIds") {
|
|
410
521
|
value.forEach(behaviorId => this._goToBehaviorIds.push(behaviorId));
|
|
411
522
|
} else {
|
|
412
|
-
this[key] =
|
|
523
|
+
this[key] = nodeJSON[key];
|
|
413
524
|
}
|
|
414
525
|
} }
|
|
415
526
|
|
|
@@ -423,24 +534,27 @@ class GraphNode extends Base {
|
|
|
423
534
|
|
|
424
535
|
/**
|
|
425
536
|
* Returns the list of behavior names that this node transitions to.
|
|
426
|
-
* @returns {Array}
|
|
537
|
+
* @returns {Array} List of behavior names that this node transitions to.
|
|
427
538
|
*/
|
|
428
539
|
getGoToBehaviors () {
|
|
429
540
|
return this._goToBehaviorIds;
|
|
430
541
|
}
|
|
431
542
|
|
|
432
543
|
/**
|
|
433
|
-
* Adds a behavior
|
|
434
|
-
* node transitions to.
|
|
544
|
+
* Adds a behavior to the transitions from this node.
|
|
435
545
|
* @param {String} behaviorId ID of behavior.
|
|
546
|
+
* @throws {TransitionAlreadyExistsError} Raised when a transition to the
|
|
547
|
+
* provided behavior already exists.
|
|
436
548
|
*/
|
|
437
549
|
addGoToBehavior (behaviorId) {
|
|
550
|
+
if (this._goToBehaviorIds.includes(behaviorId)) {
|
|
551
|
+
throw new TransitionAlreadyExistsError(this.behaviorName, behaviorId);
|
|
552
|
+
}
|
|
438
553
|
this._goToBehaviorIds.push(behaviorId);
|
|
439
554
|
}
|
|
440
555
|
|
|
441
556
|
/**
|
|
442
|
-
* Adds
|
|
443
|
-
* node transitions to.
|
|
557
|
+
* Adds list of behaviors to the transitions from this node.
|
|
444
558
|
* @param {Array} behaviorIds IDs of behaviors.
|
|
445
559
|
*/
|
|
446
560
|
addGoToBehaviors (behaviorIds) {
|
|
@@ -462,7 +576,7 @@ class GraphNode extends Base {
|
|
|
462
576
|
* Raises a flag to indicate if the behavior is atomic or not.
|
|
463
577
|
* @param {Boolean} isAtomic Flag indicates if the behavior is atomic.
|
|
464
578
|
*/
|
|
465
|
-
|
|
579
|
+
setIsAtomic (isAtomic) {
|
|
466
580
|
this._isAtomic = isAtomic;
|
|
467
581
|
}
|
|
468
582
|
|
|
@@ -474,6 +588,22 @@ class GraphNode extends Base {
|
|
|
474
588
|
return this._isAtomic;
|
|
475
589
|
}
|
|
476
590
|
|
|
591
|
+
/**
|
|
592
|
+
* Raises a flag to indicate if this node is a fork in the design.
|
|
593
|
+
* @param {Boolean} forks Flag indicates if the node is a fork.
|
|
594
|
+
*/
|
|
595
|
+
setIsDesignFork (forks) {
|
|
596
|
+
this._isDesignFork = forks;
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
/**
|
|
600
|
+
* Returns whether the node is a fork in the design or not.
|
|
601
|
+
* @returns {Boolean}
|
|
602
|
+
*/
|
|
603
|
+
isDesignFork () {
|
|
604
|
+
return this._isDesignFork;
|
|
605
|
+
}
|
|
606
|
+
|
|
477
607
|
/**
|
|
478
608
|
* Checks if the provided behavior name is a valid
|
|
479
609
|
* transition from this node.
|
|
@@ -491,33 +621,60 @@ class GraphNode extends Base {
|
|
|
491
621
|
}
|
|
492
622
|
}
|
|
493
623
|
|
|
494
|
-
/**
|
|
495
|
-
* Class representing the behavioral control graph.
|
|
496
|
-
*/
|
|
497
624
|
class BehavioralControlGraph extends Base {
|
|
498
625
|
/**
|
|
499
|
-
*
|
|
500
|
-
*
|
|
501
|
-
*
|
|
626
|
+
* Class representing the behavioral control graph. The behavioral control
|
|
627
|
+
* graph is a directed graph where nodes represent behaviors and edges
|
|
628
|
+
* represent valid transitions between behaviors.
|
|
629
|
+
*
|
|
630
|
+
* The graph can be used to execute the design by starting at the atomic
|
|
631
|
+
* node and transitioning to observed behaviors. As the design is executed,
|
|
632
|
+
* the values of the participants are set from the observed values and the
|
|
633
|
+
* invariants are checked at each transition to recognize if the design has
|
|
634
|
+
* entered a semantically invalid state.
|
|
635
|
+
*
|
|
636
|
+
* Currently, it only has to be initialized with a name and the remaining
|
|
637
|
+
* attributes can be added using the provided methods. If the graph is being
|
|
638
|
+
* loaded from a file, then the presence of a UID in the args will select
|
|
639
|
+
* the relevant method to load the graph from a JSON object.
|
|
640
|
+
*
|
|
641
|
+
* @param {Object} args The args to initialize the behavioral control graph.
|
|
502
642
|
*/
|
|
503
643
|
constructor (args) {
|
|
504
644
|
super();
|
|
505
645
|
this.type = ENGINE_TYPES.BEHAVIORAL_CONTROL_GRAPH;
|
|
506
646
|
this.nodes = [];
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
647
|
+
(isLoadedFromFile(args) ? this._loadFromFile(args) : this._loadArgs(args));
|
|
648
|
+
}
|
|
649
|
+
|
|
650
|
+
/**
|
|
651
|
+
* Loads the provided arguments.
|
|
652
|
+
* @throws {MissingAttributes} Thrown when required attr is not present.
|
|
653
|
+
* @param {Object} args
|
|
654
|
+
*/
|
|
655
|
+
_loadArgs (args) {
|
|
656
|
+
/**
|
|
657
|
+
* TODO: Move the attributes to private and use getters and setters
|
|
658
|
+
* for them. Repeat for all the other classes.
|
|
659
|
+
*/
|
|
660
|
+
const expectedAttributes = ["name"];
|
|
661
|
+
if (typeof args !== "object" || args === null || Array.isArray(args)) {
|
|
662
|
+
// Not an object, so all attributes are missing.
|
|
663
|
+
throw new MissingAttributes("BehavioralControlGraph", expectedAttributes);
|
|
513
664
|
}
|
|
665
|
+
expectedAttributes.forEach((attr) => {
|
|
666
|
+
if (!(attr in args)) {
|
|
667
|
+
throw new MissingAttributes("BehavioralControlGraph", attr);
|
|
668
|
+
}
|
|
669
|
+
this[attr] = args[attr];
|
|
670
|
+
});
|
|
514
671
|
}
|
|
515
672
|
|
|
516
673
|
/**
|
|
517
674
|
* Loads the graph from a JSON object..
|
|
518
675
|
* @param {Object} graphJson
|
|
519
676
|
*/
|
|
520
|
-
|
|
677
|
+
_loadFromFile (graphJson) {
|
|
521
678
|
for (const [key, value] of Object.entries(graphJson)) {
|
|
522
679
|
if (key === "nodes") {
|
|
523
680
|
value.forEach(node => this.nodes.push(new GraphNode(node)));
|
|
@@ -527,17 +684,27 @@ class BehavioralControlGraph extends Base {
|
|
|
527
684
|
} }
|
|
528
685
|
|
|
529
686
|
/**
|
|
530
|
-
* Adds a node to the graph.
|
|
531
|
-
*
|
|
532
|
-
* @param {
|
|
533
|
-
* @param {
|
|
534
|
-
*
|
|
687
|
+
* Adds a node to the graph with the provided arguments.
|
|
688
|
+
*
|
|
689
|
+
* @param {Behavior} behaviorId ID of the behavior represented by the node.
|
|
690
|
+
* @param {Array} goToBehaviorIds IDs of the behaviors that are valid
|
|
691
|
+
* transitions from this node.
|
|
692
|
+
* @param {Boolean} isAtomic Flag indicating if the behavior represented by
|
|
693
|
+
* the node is atomic.
|
|
694
|
+
* @param {Boolean} isDesignFork Flag indicating if the node is a
|
|
695
|
+
* design fork.
|
|
696
|
+
* @throws {BehaviorAlreadyExistsError} Raised when a node with the provided
|
|
697
|
+
* @returns {GraphNode} The created graph node.
|
|
535
698
|
*/
|
|
536
|
-
|
|
699
|
+
addNode (behaviorId, goToBehaviorIds, isAtomic, isDesignFork) {
|
|
700
|
+
if (this.nodes.some((node) => node.getBehavior().name === behaviorId)) {
|
|
701
|
+
throw new BehaviorAlreadyExistsError(behaviorId);
|
|
702
|
+
}
|
|
537
703
|
const node = new GraphNode({
|
|
538
704
|
behavior: new Behavior({name: behaviorId}),
|
|
539
|
-
|
|
705
|
+
goToBehaviorIds: goToBehaviorIds?goToBehaviorIds:[],
|
|
540
706
|
isAtomic: isAtomic?isAtomic:false,
|
|
707
|
+
isDesignFork: isDesignFork?isDesignFork:false,
|
|
541
708
|
});
|
|
542
709
|
this.nodes.push(node);
|
|
543
710
|
return node;
|
|
@@ -549,29 +716,25 @@ class BehavioralControlGraph extends Base {
|
|
|
549
716
|
* @param {String} behaviorName
|
|
550
717
|
* @throws {UnknownBehaviorError} Raised when the provided behavior
|
|
551
718
|
* does not exist in the graph.
|
|
552
|
-
* @returns
|
|
719
|
+
* @returns {GraphNode} The found graph node.
|
|
553
720
|
*/
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
721
|
+
findNode (behaviorName) {
|
|
722
|
+
const node = this.nodes.find(
|
|
723
|
+
(node) => node.getBehavior().name === behaviorName
|
|
724
|
+
);
|
|
725
|
+
if (!node) {
|
|
726
|
+
throw new UnknownBehaviorError(behaviorName);
|
|
560
727
|
}
|
|
561
|
-
|
|
728
|
+
return node;
|
|
562
729
|
}
|
|
563
730
|
|
|
564
731
|
/**
|
|
565
732
|
* Sets the active node given the behavior name.
|
|
566
|
-
* The execution provides the next observed
|
|
567
|
-
* behavior and the active node indicates if
|
|
568
|
-
* if it is a valid transition.
|
|
569
|
-
*
|
|
570
733
|
*
|
|
571
734
|
* @param {String} behaviorName
|
|
572
735
|
*/
|
|
573
|
-
|
|
574
|
-
const node = this.
|
|
736
|
+
setCurrentBehavior (behaviorName) {
|
|
737
|
+
const node = this.findNode(behaviorName);
|
|
575
738
|
/**
|
|
576
739
|
* TODO: Ensure it is atomic because the execution
|
|
577
740
|
* will only set a behavior when its the first one.
|
|
@@ -583,13 +746,15 @@ class BehavioralControlGraph extends Base {
|
|
|
583
746
|
/**
|
|
584
747
|
* Check if the observed behavior is a valid transition
|
|
585
748
|
* given the current node.
|
|
586
|
-
*
|
|
749
|
+
*
|
|
750
|
+
* @param {String} nextBehaviorName Name of the next behavior to
|
|
751
|
+
* transition to.
|
|
587
752
|
* @throws {InvalidTransitionError} Raised when the provided
|
|
588
753
|
* behavior is not a valid transition.
|
|
589
754
|
*/
|
|
590
|
-
|
|
755
|
+
goToBehavior (nextBehaviorName) {
|
|
591
756
|
if (this.currentNode.isValidTransition(nextBehaviorName)) {
|
|
592
|
-
this.currentNode = this.
|
|
757
|
+
this.currentNode = this.findNode(nextBehaviorName);
|
|
593
758
|
} else {
|
|
594
759
|
throw new InvalidTransitionError(this.currentNode.getBehavior().name, nextBehaviorName);
|
|
595
760
|
}
|
|
@@ -611,31 +776,173 @@ class BehavioralControlGraph extends Base {
|
|
|
611
776
|
}
|
|
612
777
|
|
|
613
778
|
/**
|
|
614
|
-
*
|
|
615
|
-
*
|
|
616
|
-
*
|
|
779
|
+
* Class representing a collection of atomic graphs.
|
|
780
|
+
*
|
|
781
|
+
* These graphs together represent the design. Within each graph, every node
|
|
782
|
+
* must be part of the same tree. There cannot be multiple disconnected trees,
|
|
783
|
+
* if there are, then it is a separate graph in this collection. Each graph
|
|
784
|
+
* is identified by a unique name and is selected as the active graph when the
|
|
785
|
+
* atomic behavior is observed. The atomic behavior is not transitioned to from
|
|
786
|
+
* any other behavior, it is the root of the tree.
|
|
787
|
+
*/
|
|
788
|
+
class Graphs {
|
|
789
|
+
constructor () {
|
|
790
|
+
this._graphs = {};
|
|
791
|
+
this.addGraph("default graph");
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
/**
|
|
795
|
+
* Load the graphs from file.
|
|
796
|
+
*
|
|
797
|
+
* @param {String} jsonText JSON text representing the collection of graphs.
|
|
798
|
+
*/
|
|
799
|
+
loadFromJson (jsonText) {
|
|
800
|
+
const parsed = JSON.parse(jsonText);
|
|
801
|
+
Object.keys(parsed._graphs).forEach(graphId => {
|
|
802
|
+
this._graphs[graphId] = new BehavioralControlGraph(parsed._graphs[graphId]);
|
|
803
|
+
});
|
|
804
|
+
this._activeGraph = this._graphs[Object.keys(this._graphs)[0]];
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* Given a graph ID, creates the graph and adds it to the collection.
|
|
809
|
+
*
|
|
810
|
+
* @param {String} graphId ID of the graph.
|
|
811
|
+
* @returns {BehavioralControlGraph} The graph that was added.
|
|
812
|
+
* @throws {GraphWithNameExistsError} Raised when a graph with the provided
|
|
813
|
+
* name already exists in the collection of graphs.
|
|
814
|
+
*/
|
|
815
|
+
addGraph (graphId) {
|
|
816
|
+
if (graphId in this._graphs) {
|
|
817
|
+
throw new GraphWithNameExistsError(graphId);
|
|
818
|
+
}
|
|
819
|
+
this._graphs[graphId] = new BehavioralControlGraph({name: graphId});
|
|
820
|
+
this._activeGraph = this._graphs[graphId];
|
|
821
|
+
return this._activeGraph;
|
|
822
|
+
}
|
|
823
|
+
|
|
824
|
+
/**
|
|
825
|
+
* Returns the graph with the given graphID from the collection.
|
|
826
|
+
*
|
|
827
|
+
* @param {String} graphId ID of the graph to return.
|
|
828
|
+
* @returns {BehavioralControlGraph} The graph with the given graphId.
|
|
829
|
+
* @throws {UnknownGraph} Raised when a graph with the provided graphId does
|
|
830
|
+
* not exist in the collection of graphs.
|
|
831
|
+
*/
|
|
832
|
+
getGraph (graphId) {
|
|
833
|
+
if (graphId in this._graphs) {
|
|
834
|
+
return this._graphs[graphId];
|
|
835
|
+
} else {
|
|
836
|
+
throw new UnknownGraph(graphId);
|
|
837
|
+
}
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* Removes a graph with the given id from the collection of graphs. After
|
|
842
|
+
* the graph is removed, it selects the first graph in the collection of
|
|
843
|
+
* graphs. If there are no graphs left in the collection, it creates a new
|
|
844
|
+
* graph with the name "default graph" and selects it as the active graph.
|
|
845
|
+
*
|
|
846
|
+
* @param {String} graphId ID of the graph to remove.
|
|
847
|
+
* @throws {UnknownGraph} Raised when the provided graphId does not exist
|
|
848
|
+
* in the collection of graphs.
|
|
849
|
+
*/
|
|
850
|
+
removeGraph (graphId) {
|
|
851
|
+
if (graphId in this._graphs) {
|
|
852
|
+
delete this._graphs[graphId];
|
|
853
|
+
} else {
|
|
854
|
+
throw new UnknownGraph(graphId);
|
|
855
|
+
}
|
|
856
|
+
// TODO: Is there a better policy for which graph to select
|
|
857
|
+
// after the current graph is removed?
|
|
858
|
+
if (Object.keys(this._graphs).length === 0) {
|
|
859
|
+
this.addGraph("default graph");
|
|
860
|
+
} else {
|
|
861
|
+
this._activeGraph = this._graphs[Object.keys(this._graphs)[0]];
|
|
862
|
+
}
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
/**
|
|
866
|
+
* Finds the graph with the given graphId and sets it as the active graph.
|
|
867
|
+
*
|
|
868
|
+
* @param {String} graphId Id of the graph to set as active.
|
|
869
|
+
* @returns {BehavioralControlGraph} The currently active graph.
|
|
870
|
+
* @throws {UnknownGraph} Raised when the provided graphId does not exist
|
|
871
|
+
* in the collection of graphs.
|
|
872
|
+
*/
|
|
873
|
+
setActiveGraph (graphId) {
|
|
874
|
+
if (graphId in this._graphs) {
|
|
875
|
+
this._activeGraph = this._graphs[graphId];
|
|
876
|
+
} else {
|
|
877
|
+
throw new UnknownGraph(graphId);
|
|
878
|
+
}
|
|
879
|
+
return this._activeGraph;
|
|
880
|
+
}
|
|
881
|
+
|
|
882
|
+
/**
|
|
883
|
+
* Returns the active graph.
|
|
884
|
+
*
|
|
885
|
+
* @returns {BehavioralControlGraph} The currently active graph.
|
|
886
|
+
*/
|
|
887
|
+
getActiveGraph () {
|
|
888
|
+
return this._activeGraph;
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
/**
|
|
892
|
+
* Returns a collection of all the graphs in the design.
|
|
893
|
+
*
|
|
894
|
+
* @returns {Object} The collection of all graphs in the design.
|
|
895
|
+
*/
|
|
896
|
+
getGraphs () {
|
|
897
|
+
return this._graphs;
|
|
898
|
+
}
|
|
899
|
+
|
|
900
|
+
/**
|
|
901
|
+
* Returns a list of all the graph names in the design.
|
|
902
|
+
*
|
|
903
|
+
* @returns {Array} A list of all graph names in the design.
|
|
904
|
+
*/
|
|
905
|
+
getGraphNames () {
|
|
906
|
+
return Object.keys(this._graphs);
|
|
907
|
+
}
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
/**
|
|
911
|
+
* This engine can be used to define and execute designs defined in a
|
|
912
|
+
* Design Abstraction Language (DAL).
|
|
913
|
+
*
|
|
914
|
+
* This class is the main interface for users to interact with the
|
|
915
|
+
* engine. It exposes functions to configure the engine and to execute
|
|
916
|
+
* the design. It also exposes functions to serialize and deserialize
|
|
917
|
+
* the engine to and from JSON text.
|
|
617
918
|
*
|
|
618
|
-
*
|
|
619
|
-
*
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
919
|
+
* A design can consist of multiple atomic behavioral control graphs and
|
|
920
|
+
* this class allows users to create, select, and delete graphs. It also
|
|
921
|
+
* allows users to add nodes to the graph and to transition between
|
|
922
|
+
* behaviors in the graph. It also allows users to create participants,
|
|
923
|
+
* behaviors, and invariants and assign them to nodes in the graph.
|
|
924
|
+
*
|
|
925
|
+
* The selected graph is determined by the atomic behavior that is observed.
|
|
926
|
+
* The design is executed by transitioning between behaviors in the graph.
|
|
927
|
+
* The values of the participants are set from the observed values and the
|
|
928
|
+
* invariants are checked at each transition to recognize if the design has
|
|
929
|
+
* entered a semantically invalid state.
|
|
625
930
|
*/
|
|
626
931
|
class DALEngine {
|
|
627
932
|
constructor (args) {
|
|
628
|
-
this.
|
|
629
|
-
this.
|
|
630
|
-
this.
|
|
933
|
+
this.graphs = new Graphs();
|
|
934
|
+
this.graph = this.graphs.getActiveGraph();
|
|
935
|
+
this._loadArgs(args);
|
|
631
936
|
}
|
|
632
937
|
|
|
633
938
|
/**
|
|
634
|
-
*
|
|
635
|
-
*
|
|
636
|
-
* @
|
|
939
|
+
* Sets the provided arguments to the engine.
|
|
940
|
+
*
|
|
941
|
+
* @throws {MissingAttributes} Thrown when required attributes are
|
|
942
|
+
* not present.
|
|
943
|
+
* @param {Object} args Arguments to load.
|
|
637
944
|
*/
|
|
638
|
-
|
|
945
|
+
_loadArgs (args) {
|
|
639
946
|
const expectedAttributes = ["name"];
|
|
640
947
|
if (typeof args !== "object" || args === null || Array.isArray(args)) {
|
|
641
948
|
// Not an object, so all attributes are missing.
|
|
@@ -650,98 +957,189 @@ class DALEngine {
|
|
|
650
957
|
}
|
|
651
958
|
|
|
652
959
|
/**
|
|
653
|
-
*
|
|
654
|
-
*
|
|
960
|
+
* Serializes the behavioral control graphs and returns the JSON text.
|
|
961
|
+
*
|
|
962
|
+
* @returns {String} Returns JSON string representing the control graphs.
|
|
655
963
|
*/
|
|
656
964
|
serialize () {
|
|
657
|
-
return JSON.stringify(this.
|
|
965
|
+
return JSON.stringify(this.graphs);
|
|
658
966
|
}
|
|
659
967
|
|
|
660
968
|
/**
|
|
661
|
-
*
|
|
662
|
-
*
|
|
969
|
+
* Loads the behavioral control graphs from JSON text and sets
|
|
970
|
+
* the active graph to the first graph in the collection of graphs.
|
|
971
|
+
*
|
|
972
|
+
* @param {String} serializedText JSON text representing the control
|
|
973
|
+
* graphs.
|
|
974
|
+
* @throws {SyntaxError|TypeError} Thrown when the JSON text is invalid.
|
|
663
975
|
*/
|
|
664
|
-
deserialize (
|
|
665
|
-
|
|
976
|
+
deserialize (serializedText) {
|
|
977
|
+
// TODO: Improve validation to throw specific error.
|
|
978
|
+
this.graphs = new Graphs();
|
|
979
|
+
this.graphs.loadFromJson(serializedText);
|
|
980
|
+
this.graph = this.graphs.getActiveGraph();
|
|
666
981
|
}
|
|
667
982
|
|
|
668
983
|
/**
|
|
669
|
-
* Creates a
|
|
670
|
-
*
|
|
671
|
-
* @
|
|
984
|
+
* Creates a graph with the given name and sets it as the active graph.
|
|
985
|
+
*
|
|
986
|
+
* @param {String} name Name of the graph to create.
|
|
987
|
+
* @throws {GraphWithNameExistsError} Thrown when a graph with the
|
|
988
|
+
* provided name already exists.
|
|
989
|
+
*/
|
|
990
|
+
createGraph (name) {
|
|
991
|
+
this.graph = this.graphs.addGraph(name);
|
|
992
|
+
}
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* Sets the active graph to the graph with the given graphId.
|
|
996
|
+
*
|
|
997
|
+
* @param {String} graphId ID of the graph to set as active
|
|
998
|
+
* @throws {UnknownGraph} Thrown when the provided graphId does
|
|
999
|
+
* not exist in the collection of graphs.
|
|
1000
|
+
*/
|
|
1001
|
+
selectGraph (graphId) {
|
|
1002
|
+
this.graph = this.graphs.setActiveGraph(graphId);
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Removes the graph with the given graphId
|
|
1007
|
+
*
|
|
1008
|
+
* @param {String} graphId Id of graph to remove.
|
|
1009
|
+
* @throws {UnknownGraph} Thrown when the provided graphId does not
|
|
1010
|
+
* exist in the collection of graphs.
|
|
1011
|
+
*/
|
|
1012
|
+
removeGraph (graphId) {
|
|
1013
|
+
this.graphs.removeGraph(graphId);
|
|
1014
|
+
this.graph = this.graphs.getActiveGraph();
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
/**
|
|
1018
|
+
* Returns the names of all the graphs in the design.
|
|
1019
|
+
*
|
|
1020
|
+
* @returns {Array} Returns an array of graph names.
|
|
1021
|
+
*/
|
|
1022
|
+
getSelectableGraphs () {
|
|
1023
|
+
return this.graphs.getGraphNames();
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
/**
|
|
1027
|
+
* Creates a participant with the provided args and returns it.
|
|
1028
|
+
*
|
|
1029
|
+
* @param {Object} args Arguments to create the participant with.
|
|
1030
|
+
* @returns {Participant} Returns the created participant.
|
|
1031
|
+
* @throws {MissingAttributes} Thrown when required attributes are not
|
|
1032
|
+
* present in the args. See Participant class for required attributes.
|
|
672
1033
|
*/
|
|
673
1034
|
createParticipant (args) {
|
|
674
1035
|
return new Participant(args);
|
|
675
1036
|
}
|
|
676
1037
|
|
|
677
1038
|
/**
|
|
678
|
-
* Creates a behavior.
|
|
679
|
-
*
|
|
680
|
-
* @
|
|
1039
|
+
* Creates a behavior with the provided args and returns it.
|
|
1040
|
+
*
|
|
1041
|
+
* @param {Object} args Arguments to create the behavior with.
|
|
1042
|
+
* @returns {Behavior} Returns the created behavior.
|
|
1043
|
+
* @throws {MissingAttributes} Thrown when required attributes are not
|
|
1044
|
+
* present in the args. See Behavior class for required attributes.
|
|
681
1045
|
*/
|
|
682
1046
|
createBehavior (args) {
|
|
683
1047
|
return new Behavior(args);
|
|
684
1048
|
}
|
|
685
1049
|
|
|
686
1050
|
/**
|
|
687
|
-
* Creates an invariant.
|
|
688
|
-
*
|
|
689
|
-
* @
|
|
1051
|
+
* Creates an invariant with the provided args and returns it.
|
|
1052
|
+
*
|
|
1053
|
+
* @param {Object} args Arguments to create the invariant with.
|
|
1054
|
+
* @returns {Invariant} Returns the created invariant.
|
|
1055
|
+
* @throws {MissingAttributes} Raised when required attributes are not
|
|
1056
|
+
* present in the args. See Invariant class for required attributes.
|
|
690
1057
|
*/
|
|
691
1058
|
createInvariant (args) {
|
|
692
1059
|
return new Invariant(args);
|
|
693
1060
|
}
|
|
694
1061
|
|
|
695
|
-
|
|
696
1062
|
/**
|
|
697
1063
|
* Returns the node in the graph with the given behavior name.
|
|
698
|
-
*
|
|
699
|
-
* @
|
|
1064
|
+
*
|
|
1065
|
+
* @param {String} behaviorId ID of the behavior.
|
|
1066
|
+
* @returns {GraphNode} Returns the node in the graph with the
|
|
1067
|
+
* given behavior name.
|
|
1068
|
+
* @throws {UnknownBehaviorError} Thrown when the provided behaviorId is not
|
|
1069
|
+
* a valid behavior in the graph.
|
|
700
1070
|
*/
|
|
701
1071
|
getNode (behaviorId) {
|
|
702
|
-
return this.graph.
|
|
1072
|
+
return this.graph.findNode(behaviorId);
|
|
703
1073
|
}
|
|
704
1074
|
|
|
705
1075
|
/**
|
|
706
1076
|
* Adds a node to the graph with the given behaviorId and goToBehaviors.
|
|
707
|
-
*
|
|
708
|
-
* @param {
|
|
709
|
-
* @param {
|
|
710
|
-
*
|
|
1077
|
+
*
|
|
1078
|
+
* @param {String} behaviorId ID of the behavior for the node.
|
|
1079
|
+
* @param {Array} goToBehaviorIds IDs of the behaviors that this node
|
|
1080
|
+
* transitions to.
|
|
1081
|
+
* @param {Boolean} isAtomic Flag to indicate if this node contains an
|
|
1082
|
+
* atomic behavior.
|
|
1083
|
+
* @param {Boolean} isDesignFork Flag to indicate if this node
|
|
1084
|
+
* is a fork in the design.
|
|
1085
|
+
* @returns {GraphNode} Returns the created graph node.
|
|
1086
|
+
* @throws {BehaviorAlreadyExistsError} Raised when a node with the provided
|
|
1087
|
+
* behaviorId already exists in the graph.
|
|
711
1088
|
*/
|
|
712
|
-
addNode (behaviorId,
|
|
713
|
-
return this.graph.
|
|
1089
|
+
addNode (behaviorId, goToBehaviorIds, isAtomic, isDesignFork) {
|
|
1090
|
+
return this.graph.addNode(
|
|
1091
|
+
behaviorId,
|
|
1092
|
+
goToBehaviorIds,
|
|
1093
|
+
isAtomic,
|
|
1094
|
+
isDesignFork
|
|
1095
|
+
);
|
|
714
1096
|
}
|
|
715
1097
|
|
|
716
1098
|
/**
|
|
717
1099
|
* Deletes a node from the graph with the given behaviorId and
|
|
718
1100
|
* removes it from the goToBehavior list of all other nodes.
|
|
719
|
-
*
|
|
1101
|
+
*
|
|
1102
|
+
* @param {String} behaviorId Behavior ID of the node to delete.
|
|
1103
|
+
* @returns {GraphNode} Returns the deleted graph node.
|
|
1104
|
+
* @throws {UnknownBehaviorError} Thrown when the provided behaviorId is not
|
|
1105
|
+
* a valid behavior in the graph.
|
|
720
1106
|
*/
|
|
721
1107
|
removeNode (behaviorId) {
|
|
722
|
-
|
|
1108
|
+
// TODO: Move this to graph class, this class shouldn't
|
|
1109
|
+
// modifiy the graph structure directly.
|
|
1110
|
+
const node = this.graph.findNode(behaviorId);
|
|
723
1111
|
const nodeIndex = this.graph.nodes.indexOf(node);
|
|
724
|
-
this.graph.nodes.splice(nodeIndex, 1);
|
|
1112
|
+
const removedNode = this.graph.nodes.splice(nodeIndex, 1);
|
|
725
1113
|
for (const node of this.graph.nodes) {
|
|
726
1114
|
node.removeGoToBehavior(behaviorId);
|
|
727
1115
|
}
|
|
1116
|
+
return removedNode[0];
|
|
728
1117
|
}
|
|
729
1118
|
|
|
730
1119
|
/**
|
|
731
|
-
* Sets the current behavior in the graph.
|
|
732
|
-
*
|
|
1120
|
+
* Sets the current behavior in the graph. Since the behavior is not
|
|
1121
|
+
* being transitioned from another, it must be an atomic behavior.
|
|
1122
|
+
*
|
|
1123
|
+
* @param {String} behaviorId ID of the behavior to set as current.
|
|
1124
|
+
* @throws {UnknownBehaviorError} Thrown when the provided behavior is not
|
|
1125
|
+
* a valid behavior in the graph.
|
|
733
1126
|
*/
|
|
734
1127
|
setCurrentBehavior (behaviorId) {
|
|
735
|
-
this.graph.
|
|
1128
|
+
this.graph.setCurrentBehavior(behaviorId);
|
|
736
1129
|
}
|
|
737
1130
|
|
|
738
1131
|
/**
|
|
739
|
-
*
|
|
740
|
-
*
|
|
1132
|
+
* For the current node in the graph, transitions to the node with the given
|
|
1133
|
+
* behaviorId if it is a valid transition.
|
|
1134
|
+
*
|
|
741
1135
|
* @param {String} nextBehaviorId ID of the next behavior.
|
|
1136
|
+
* @throws {UnknownBehaviorError} Thrown when the provided behavior is not
|
|
1137
|
+
* a valid behavior in the graph.
|
|
1138
|
+
* @throws {InvalidTransitionError} Thrown when the provided behavior is not
|
|
1139
|
+
* a valid transition from the current node.
|
|
742
1140
|
*/
|
|
743
1141
|
goToBehavior (nextBehaviorId) {
|
|
744
|
-
this.graph.
|
|
1142
|
+
this.graph.goToBehavior(nextBehaviorId);
|
|
745
1143
|
}
|
|
746
1144
|
}
|
|
747
1145
|
|