From 46987fd2aed717e025ed61c05a69452cb1114067 Mon Sep 17 00:00:00 2001
From: Stanislas Lange <stanislas.lange@pm.me>
Date: Tue, 6 Jul 2021 10:32:15 +0000
Subject: [PATCH] docs: add submission flowchart

---
 README.md                 |  2 ++
 doc/assets/submission.svg | 31 +++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 doc/assets/submission.svg

diff --git a/README.md b/README.md
index 3abf7bd..d2b191c 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,8 @@ npm start
 
 ### Submission jobs execution flow
 
+![](./doc/assets/submission.svg)
+
 | Component | Action                                                                                                                                  |
 | --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
 | `Worker`  | Launch and maintain pool of X prebooted microVMs in the background                                                                      |
diff --git a/doc/assets/submission.svg b/doc/assets/submission.svg
new file mode 100644
index 0000000..e361a92
--- /dev/null
+++ b/doc/assets/submission.svg
@@ -0,0 +1,31 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="2616" height="903"><defs/><g transform="translate(229.5,63.927353692728325) scale(3,3)" fill="rgb(0,0,0)" fill-opacity="1" stroke="rgb(0,0,0)" stroke-opacity="1" stroke-linejoin="round" stroke-miterlimit="10"><path fill="none" stroke="rgb(0,0,0)" paint-order="fill stroke markers" d=" M 25.499999999999986 113.83923563892215 Q 81.7083200015712 103.08645673462038 137.0388045536235 113.2275597017841" stroke-opacity="1" stroke-linejoin="round" stroke-miterlimit="10"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 128.77699488622403 116.28439580462407 L 138.07160077145613 113.41685305198574 L 130.2008030382062 107.70169399538305 L 133.78024986683562 112.70494897599465 Z" fill-opacity="1"/><g transform="translate(81.48886113919147,108.30992720248676) rotate(-0.21497985137358067,0,0)"><rect fill="#ffffff" stroke="none" x="-27" y="-5" width="54" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">submit code</text><g transform="rotate(0.21497985137358067,0,0) translate(-81.48886113919147,-108.30992720248676)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 443.5886768463642 45.62046932599458 Q 486.71458962112615 69.4717355129018 522.7787966720693 113.20995238366056"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 514.4986592000622 110.2064635203945 L 523.4467802947033 114.02007452253392 L 521.1287964396303 104.57341104553738 L 520.6302540572748 110.70500590274993 Z"/><g transform="translate(484.9491631901715,74.44347318386468) rotate(40.58052638952677,0,0)"><rect fill="#ffffff" stroke="none" x="-18.5" y="-5" width="37" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">pull jobs</text><g transform="rotate(-40.58052638952677,0,0) translate(-484.9491631901715,-74.44347318386468)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 342.73899364480155 55.69088210242388 Q 299.9634406618518 87.97452144221705 240.07409092985606 106.62980320077872"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 245.99306314732425 100.10790622601795 L 239.07160077145613 106.94207468892856 L 248.6918129673055 108.37874351187669 L 243.2070194143855 105.59269977893794 Z"/><g transform="translate(295.6849914745903,84.56743204690918) rotate(-26.30691818340055,0,0)"><rect fill="#ffffff" stroke="none" x="-47" y="-5" width="94" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">listen to jobs updates</text><g transform="rotate(26.30691818340055,0,0) translate(-295.6849914745903,-84.56743204690918)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 238.92128397301877 84.67261330761814 Q 281.6968369559686 52.38897396782494 341.5861866879643 33.73369220926328"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 335.66721447049605 40.25558918402407 L 342.5886768463642 33.42142072111346 L 332.9684646505148 31.98475189816532 L 338.4532582034348 34.77079563110408 Z"/><g transform="translate(285.97528614323005,55.79606336313282) rotate(-26.306918183400548,0,0)"><rect fill="#ffffff" stroke="none" x="-40.5" y="-5" width="81" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">queue submission</text><g transform="rotate(26.306918183400548,0,0) translate(-285.97528614323005,-55.79606336313282)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 233.89840411479864 160.67261330761812 Q 278.427082096234 198.00350007846018 336.89110345956215 219.66858994659702"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 328.1919384188948 220.9487264150725 L 337.87567520304896 220.03344400225131 L 331.3332072022995 212.83562402262072 L 333.8191240068231 218.46280961054896 Z"/><g transform="translate(281.9109179417072,194.08705085278388) rotate(29.722131807612833,0,0)"><rect fill="#ffffff" stroke="none" x="-37" y="-5" width="74" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">save submission</text><g transform="rotate(-29.722131807612833,0,0) translate(-281.9109179417072,-194.08705085278388)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 239.07160077145613 141.38646522590545 Q 298.52019387827113 163.4164091496966 342.24423065957916 200.07272009896064"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 333.55006035495285 198.6532376603271 L 343.0488718597065 200.74729592053865 L 339.02483156502353 191.89181176060882 L 339.66815890984736 198.0099103155033 Z"/><g transform="translate(294.5890547968944,167.0730009060648) rotate(29.722131807612833,0,0)"><rect fill="#ffffff" stroke="none" x="-52" y="-5" width="104" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">save submission status</text><g transform="rotate(-29.722131807612833,0,0) translate(-294.5890547968944,-167.0730009060648)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 138.07160077145613 132.333377668696 Q 81.86328076988494 143.08615657299774 26.532796217832626 132.945053605834"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 34.79460588523209 129.88821750299405 L 25.49999999999997 132.75576025563237 L 33.3707977332499 138.47091931223505 L 29.791350904620483 133.46766433162347 Z"/><g transform="translate(82.08273963226466,137.86268610513136) rotate(-0.21497985137356618,0,0)"><rect fill="#ffffff" stroke="none" x="-31" y="-5" width="62" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">poll job status</text><g transform="rotate(0.21497985137356618,0,0) translate(-82.08273963226466,-137.86268610513136)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 504.2795589487881 124.09048729896323 Q 461.1536461740262 100.23922111205601 425.089439123083 56.50100424129724"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 433.3695765950901 59.50449310456322 L 424.421455500449 55.690882102423885 L 426.7394393555222 65.1375455794204 L 427.2379817378776 59.00595072220785 Z"/><g transform="translate(462.9190726049809,95.26748344109313) rotate(40.58052638952677,0,0)"><rect fill="#ffffff" stroke="none" x="-38.5" y="-5" width="77" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">update job status</text><g transform="rotate(-40.58052638952677,0,0) translate(-462.9190726049809,-95.26748344109313)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 605.2795589487881 121.71489570383295 Q 642.4180318769817 99.42800336437968 691.9908208443627 92.10844239734102"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 685.1436369075229 97.64934180596478 L 693.0295589487881 91.9550698104339 L 683.7425881276042 89.06289537474025 L 688.7363357331759 92.65559420039321 Z"/><g transform="translate(645.5266108867785,103.16983620748334) rotate(-18.734023503322348,0,0)"><rect fill="#ffffff" stroke="none" x="-15.5" y="-5" width="31" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">run job</text><g transform="rotate(18.734023503322348,0,0) translate(-645.5266108867785,-103.16983620748334)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 693.0295589487881 114.80378235932956 Q 655.8910860205946 137.09067469878283 606.3182970532135 144.4102356658215"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 613.1654809900533 138.86933625719774 L 605.2795589487881 144.5636082527286 L 614.5665297699719 147.4557826884223 L 609.5727821644003 143.86308386276932 Z"/><g transform="translate(652.7825070107976,133.34884185567918) rotate(-18.734023503322348,0,0)"><rect fill="#ffffff" stroke="none" x="-27" y="-5" width="54" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">return result</text><g transform="rotate(18.734023503322348,0,0) translate(-652.7825070107976,-133.34884185567918)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 605.2795589487881 164.8668539971825 Q 656.7145471648149 177.951486688122 690.2494085807981 202.4913168429904"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 681.4749049215919 201.68579544924037 L 691.0967648132469 203.11138733521705 L 686.4641223870352 194.5585442903071 L 687.5331392337803 200.6167786024954 Z"/><g transform="translate(652.239515464804,180.81528605410423) rotate(24.020196100164135,0,0)"><rect fill="#ffffff" stroke="none" x="-15.5" y="-5" width="31" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">run job</text><g transform="rotate(-24.020196100164135,0,0) translate(-652.239515464804,-180.81528605410423)"><path fill="none" stroke="" paint-order="fill stroke markers" d=" M 691.0967648132469 227.21902993043884 Q 639.6617765972202 214.13439723949935 606.1269151812369 189.5945670846309"/><path fill="" stroke="" paint-order="stroke fill markers" d=" M 614.9014188404431 190.40008847838095 L 605.2795589487881 188.97449659240425 L 609.9122013749998 197.52733963731418 L 608.8431845282547 191.4691053251259 Z"/><g transform="translate(644.136808297231,211.2705978735171) rotate(24.020196100164153,0,0)"><rect fill="#ffffff" stroke="none" x="-27" y="-5" width="54" height="10"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="0" y="5" text-anchor="middle" dominant-baseline="text-after-edge">return result</text><g transform="rotate(-24.020196100164153,0,0) translate(-644.136808297231,-211.2705978735171)"><path fill="#ffffff" stroke="" paint-order="fill stroke markers" d=" M -74.99999999999999 86 L -75 161 L 24.99999999999998 161 L 25 86.00000000000001 Z"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="-25" y="128.5" text-anchor="middle" dominant-baseline="text-after-edge">React frontend</text><path fill="#ffffff" stroke="" paint-order="fill stroke markers" d=" M 343.0886768463642 -19.8091178975761 L 343.0886768463642 55.19088210242388 L 443.0886768463642 55.19088210242389 L 443.0886768463642 -19.809117897576094 Z"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="393.0886768463642" y="22.690882102423892" text-anchor="middle" dominant-baseline="text-after-edge">RabbitMQ</text><path fill="#ffffff" stroke="" paint-order="fill stroke markers" d=" M 338.37567520304896 201.24729592053865 L 338.37567520304896 276.24729592053865 L 438.37567520304896 276.24729592053865 L 438.37567520304896 201.24729592053865 Z"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="388.37567520304896" y="243.74729592053865" text-anchor="middle" dominant-baseline="text-after-edge">Database</text><path fill="#ffffff" stroke="" paint-order="fill stroke markers" d=" M 138.57160077145613 85.17261330761812 L 138.57160077145613 160.17261330761812 L 238.5716007714561 160.17261330761812 L 238.57160077145613 85.17261330761814 Z"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="188.57160077145613" y="127.67261330761812" text-anchor="middle" dominant-baseline="text-after-edge">NestJS API</text><path fill="#ffffff" stroke="" paint-order="fill stroke markers" d=" M 504.7795589487881 114.52007452253392 L 504.7795589487881 189.5200745225339 L 604.7795589487881 189.52007452253392 L 604.7795589487881 114.52007452253393 Z"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="554.7795589487881" y="157.02007452253392" text-anchor="middle" dominant-baseline="text-after-edge">Worker</text><path fill="#ffffff" stroke="" paint-order="fill stroke markers" d=" M 693.5295589487881 46.998603540628615 L 693.5295589487881 121.9986035406286 L 793.5295589487881 121.99860354062861 L 793.5295589487881 46.99860354062862 Z"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="743.5295589487881" y="89.49860354062861" text-anchor="middle" dominant-baseline="text-after-edge">Agent in microVM</text><path fill="#ffffff" stroke="" paint-order="fill stroke markers" d=" M 691.5967648132469 202.56580940508744 L 691.5967648132469 277.5658094050874 L 791.5967648132469 277.5658094050874 L 791.5967648132469 202.56580940508746 Z"/><text fill="" stroke="none" font-family="-apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="10px" font-style="normal" font-weight="normal" text-decoration="normal" x="741.5967648132469" y="245.06580940508744" text-anchor="middle" dominant-baseline="text-after-edge">Agent in microVM</text><g transform="scale(0.3333333333333333,0.3333333333333333) translate(-229.5,-63.927353692728325)"/></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g></g><!--Original Flowchart Text (flowchart.fun):
+
+~~~
+layout:
+  name: dagre
+  rankDir: LR
+~~~
+React frontend
+  submit code: (NestJS API)
+
+RabbitMQ
+  pull jobs: (Worker)
+  listen to jobs updates: (NestJS API)
+Database
+
+NestJS API
+  queue submission: (RabbitMQ)
+  save submission: (Database)
+  save submission status: (Database)
+  poll job status: (React frontend)
+
+Worker
+  update job status: (RabbitMQ)
+  run job: Agent in microVM
+    return result: (Worker)
+  run job: Agent in microVM
+    return result: (Worker)
+    
+
+
+--></svg>
\ No newline at end of file