SBERDOMA-266 add UML inside README.md

open-condo-software · May 5, 2021 · a5d436f · a5d436f
1 parent 71865de
commit a5d436f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/apps/condo/domains/notification/README.md b/apps/condo/domains/notification/README.md
@@ -15,6 +15,10 @@ Features:
  - we can delivery message by user preferred transport (not implemented yet)
  - user can ignore some messages types if want (not implemented yet)
 
+Everything you needed is to call `sendMessage` inside your code.
+
+![sendMessage Sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/open-condo-software/condo/master/apps/condo/domains/notification/docs/send-message-sequence-diagram.iuml)
+
 # server side logic example
 
 ```javascript

diff --git a/apps/condo/domains/notification/docs/send-message-sequence-diagram.iuml b/apps/condo/domains/notification/docs/send-message-sequence-diagram.iuml
@@ -0,0 +1,19 @@
+@startuml
+collections WEB
+boundary GQL
+database postgres
+database redis
+collections WORKER
+boundary API
+
+WEB -> GQL: sendMessage (type, meta, to)
+
+GQL -> postgres: 1) create Message record
+GQL -> WEB: OK (answer)
+GQL -> redis: 2) schedule send task
+
+redis //-- WORKER: wait task
+WORKER -> API: 3) choose message transport
+WORKER -> API: 4) render message template with meta data
+WORKER -> API: 5) call remote transport API to send it
+@enduml