Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document QueryStateMachine in developer docs #484

Open
maxalbert opened this issue Mar 15, 2019 · 0 comments
Open

Document QueryStateMachine in developer docs #484

maxalbert opened this issue Mar 15, 2019 · 0 comments
Labels
docs Documentation issues FlowMachine Issues related to FlowMachine

Comments

@maxalbert
Copy link
Contributor

The new QueryStateMachine class introduces in #434 plays a central part in the logic of queries are run and interact with redis and the database.

The key concepts of how this works should be documented in the developer docs. Also, in the comments on #434 @greenape added a state transition diagram which is extremely useful and shouldn't get lost:
2019-03-15__Query_state_transition_diagram

graph LR
A[KNOWN] -->|ENQUEUE| B[QUEUED]
B -->|EXECUTE| C[EXECUTING]
C -->|ERROR| D[ERRORED]
C -->|FINISH| E[COMPLETED]
C -->|CANCEL| F[CANCELLED]
B -->|CANCEL| F[CANCELLED]
D -->|RESET| G[RESETTING]
E -->|RESET| G[RESETTING]
F -->|RESET| G[RESETTING]
G -->|FINISH_RESET| A
H[Blocking]
style B fill:#f9f
style C fill:#f9f
style G fill:#f9f
style H fill:#f9f
@maxalbert maxalbert added docs Documentation issues FlowMachine Issues related to FlowMachine labels Mar 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issues FlowMachine Issues related to FlowMachine
Projects
None yet
Development

No branches or pull requests

1 participant