State execution documentation #439
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of the investigation of state reactivity problems #435, it's helpful to document exactly how our system works (#436).
I started commenting BlocksWorkflowComponent, and added "Compodoc" to help explore Angular component dependencies.
Given a simple Flow of a Mapping Block generating a random UUID, and a Debug Block, I uncommented the console.log's in the BlocksWorkflowComponent, and reviewed them to made this sequence diagram:
sequenceDiagram participant Init as Initialization participant PrepStep as Preparation Step participant MappingBlock as Mapping Block participant DebugBlock as Debug Block Init ->> PrepStep: Initialize blocks PrepStep -->> MappingBlock: Prepare model (modelNumber 2 with {}) MappingBlock -->> DebugBlock: Generate and emit UUID (modelNumber 1) DebugBlock -->> PrepStep: Process and emit UUID (modelNumber 2) Note right of DebugBlock: Workflow completes after Debug Block processingI'm not quite sure where to put this sort of thing yet, obviously we wouldn't want to loose it! It might end up along side the RST files that Read the Docs uses.
It's only part of my investigation and it's not easy to understand yet.