Skip to content

Draw sequence diagram#69

Merged
delvh merged 6 commits intomainfrom
documentation/sequenz-diagram
Jul 9, 2022
Merged

Draw sequence diagram#69
delvh merged 6 commits intomainfrom
documentation/sequenz-diagram

Conversation

@madebyTimo
Copy link
Contributor

@madebyTimo madebyTimo commented Jul 7, 2022

Closes Gamify-IT/issues#70

Please review and comment if something is wrong or missing

@LeviUniAcc
Copy link
Member

LeviUniAcc commented Jul 7, 2022

how does the backend know the configuration for the minigame with just the authorization cookie? i thought the cookie is only for the authorization!

@delvh
Copy link
Contributor

delvh commented Jul 7, 2022

From the top down:

  1. According to my (limited) knowledge of sequence diagrams, the two return cookie instructions at the beginning can be omitted, resulting in the extra lifeline-part being obsolete as well.
  2. @LeviUniAcc if I understand the configuration part correctly, it is not the one you're thinking about: You're thinking about the global configuration, right? But in this case, it seems to be the player-specific one.
  3. return <x> should always be able to be deleted. You don't mention explicit return values in a sequence diagram. Arrows that only reference their own lifeline then without any text can be deleted as well.
  4. load configuratiion
  5. Why can't calls end on the same lifeline?
  6. Perhaps, when the player progress is sent to the Overworld Backend, there should also be an (asynchronous) call from the Bugfinder Backend to itself to update the player stats as well (even if it isn't needed exactly for the Bugfinder, as it is used as an example on how all minigame backends should behave)

@delvh delvh changed the title sequenz diagram Draw sequence diagram Jul 7, 2022
@LeviUniAcc

This comment was marked as resolved.

@delvh

This comment was marked as resolved.

@LeviUniAcc

This comment was marked as resolved.

@madebyTimo
Copy link
Contributor Author

To clarify the call from the Overworld Frontend to the Overworld Backend.
The Overworld Frontend sends a request to get the configuration from the overworld backend with the cookie attached. Then the backend identifies the user with the cookie and sends the overall and user specific configuration back to the frontend.

@madebyTimo
Copy link
Contributor Author

I think we leave the return values in the diagram till we surely know if they necessary.

@madebyTimo
Copy link
Contributor Author

madebyTimo commented Jul 7, 2022

Why can't calls end on the same lifeline?

I think because this is UML

Copy link
Collaborator

@cdingm cdingm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please rename the file to sequence-diagram instead of sequenz :D

@delvh
Copy link
Contributor

delvh commented Jul 8, 2022

I think you still forgot the arrow from the bugfinder backend to itself to save the results of each minigame run.

@madebyTimo
Copy link
Contributor Author

Yes that's still on my Todo-List. I will add it this evening

@madebyTimo
Copy link
Contributor Author

I specified the forwarding of the minigame configuration id like we discussed it and added the save of game runs in the minigame backend
grafik
grafik

@delvh
Copy link
Contributor

delvh commented Jul 9, 2022

It's after the deadline, no new reviews are present.
Let's get it finally merged.

@delvh delvh merged commit 6f50e77 into main Jul 9, 2022
@delvh delvh deleted the documentation/sequenz-diagram branch July 9, 2022 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Draw Sequence Diagram on how the minigame lifecycle looks like

9 participants