Skip to content

[5pt] Provide state diagram for a task #123

Closed
#145
Closed
[5pt] Provide state diagram for a task#123
#145
Assignees
veod32
Labels
documentationImprovements or additions to documentationgood first issueGood for newcomers

Description

@Totktonada
Totktonada
opened on Jul 7, 2020

Aside of states and task actions we can show how timeout events (ttl, ttr) change a state. Also we can place internal actions that is performed by a queue to keep its guarantees (say, order of tasks): I mean, when exactly queue wake up blocked :take().

I guess this way it will be easier to understand what guarantees we provide and how it is achieved. It should make life easier for users as well as for developers.

https://github.com/tarantool/queue#fields-of-the-space-associated-with-each-queue

Activity

  1. Totktonada
    added
    documentationImprovements or additions to documentation
    on Jul 7, 2020
  2. Totktonada
    added
    good first issueGood for newcomers
    on Aug 18, 2020
  3. artur-barsegyan
    assigned
    veod32
    on Oct 22, 2020
  4. veod32
    changed the title [-]Provide state diagram for a task[/-] [+][32pt] Provide state diagram for a task[/+] on Nov 19, 2020
  5. artur-barsegyan
    unassigned
    veod32
    on Dec 3, 2020
  6. artur-barsegyan
    assigned
    veod32
    on Dec 25, 2020
  7. veod32
    added 3 commits that reference this issue on Dec 30, 2020

    gh-123 Add task state diagram draft

    126d667

    gh-123 Add diagram image as a file

    1dc10d3

    gh-123 Correcting link

    3460778

  8. veod32 commented on Dec 30, 2020

    @veod32
    veod32
    on Dec 30, 2020
    Contributor

    For reference or further updates: below is the plantuml code used for drawing the diagram.

    @startuml
hide empty description
[*] --> READY : put()
[*] --> DELAYED : put('my_task_data', { delay = delay })
READY --> TAKEN : take()
READY --> DONE : delete()
READY --> BURIED : bury()
READY --> DONE : ttl timeout
TAKEN -up-> READY : release()
TAKEN -up-> READY : ttr timeout
TAKEN --> DELAYED : release(id, { delay = delay })
TAKEN --> DONE : ack()
TAKEN --> BURIED : bury()
TAKEN --> DONE : delete()
BURIED --> DONE : delete()
BURIED --> READY : kick()
BURIED --> DONE: ttl timeout
DELAYED --> READY : timeout
DELAYED --> DONE : delete()
DONE --> [*] : remove executed task
@enduml
  9. veod32
    added a commit that references this issue on Dec 30, 2020

    gh-123 Correcting diagram

    2132c18
  10. veod32
    linked a pull request that will close this issuegh-123 Add task state diagram #145on Dec 30, 2020
  11. veod32
    changed the title [-][32pt] Provide state diagram for a task[/-] [+][5pt] Provide state diagram for a task[/+] on Feb 26, 2021
  12. veod32
    added 6 commits that reference this issue on Mar 3, 2021

    documentation: change the way of including plantuml diagram into readme

    11876c7

    documentation: add separate section for the task state diagram and cr…

    d5f6341

    documentation: Correct ToC and reference links

    64ee185

    documentation: change the way of rendering SVG file for task state di…

    7326259

    gh-123 Add task state diagram draft

    002727d

    documentation: add task state diagram

    6c48d16
  13. LeonidVas
    added a commit that references this issue on Mar 11, 2021

    documentation: add task state diagram

    cdd2d71
  14. LeonidVas
    closed this as completedin #145on Mar 11, 2021
  15. LeonidVas
    added a commit that references this issue on Mar 11, 2021

    documentation: add task state diagram

    286ab7d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions