From 1f7da6ab7799aa7e7b051f711c6575816fb1e628 Mon Sep 17 00:00:00 2001
From: jld3103 <jld3103yt@gmail.com>
Date: Fri, 2 Jun 2023 08:15:31 +0200
Subject: [PATCH] docs: Document login user flow

---
 docs/login.md   |  5 +++++
 docs/login.puml | 36 ++++++++++++++++++++++++++++++++++++
 docs/login.svg  |  1 +
 3 files changed, 42 insertions(+)
 create mode 100644 docs/login.md
 create mode 100644 docs/login.puml
 create mode 100644 docs/login.svg

diff --git a/docs/login.md b/docs/login.md
new file mode 100644
index 00000000..46817809
--- /dev/null
+++ b/docs/login.md
@@ -0,0 +1,5 @@
+# Login user flow
+
+This diagram displays the user flow for logging into the app. This is not how it currently works, but how it should work at some point.
+
+![Login user flow diagram](login.svg)
diff --git a/docs/login.puml b/docs/login.puml
new file mode 100644
index 00000000..bbe65592
--- /dev/null
+++ b/docs/login.puml
@@ -0,0 +1,36 @@
+@startuml login
+
+(*) if "Started from QR code scanner?" then
+-[#red]->[Yes] "Validate server details"
+else
+    ->[No] if "Has account?" then
+        -->[Yes] (*)
+    else
+        -->[No] "Login page"
+    endif
+endif
+
+if "Selected login method?" then
+    -[#blue]->[Login flow] "Validate server details"
+    -[#blue]-> "Open login flow page"
+    -[#blue]-> "Initiate login flow"
+    -[#blue]-> "Open web browser"
+    -[#blue]-> "Wait for login flow result"
+    -[#blue]-> "Validate login details"
+else
+    -[#red]->[QR code] "Open QR scan page"
+    -[#red]-> "Scan QR code"
+    -[#red]-> "Validate server details"
+    -[#red]-> "Validate login details"
+endif
+
+-->[Login success] (*)
+
+
+legend left
+    |Color  | Login method |
+    |<#red> | QR Code      |
+    |<#blue>| Login flow   |
+endlegend
+
+@enduml
diff --git a/docs/login.svg b/docs/login.svg
new file mode 100644
index 00000000..d6983c67
--- /dev/null
+++ b/docs/login.svg
@@ -0,0 +1 @@
+<?xml version="1.0" encoding="us-ascii" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="1096px" preserveAspectRatio="none" style="width:414px;height:1096px;background:#FFFFFF;" version="1.1" viewBox="0 0 414 1096" width="414px" zoomAndPan="magnify"><defs/><g><ellipse cx="188.8656" cy="16" fill="#222222" rx="10" ry="10" style="stroke:none;stroke-width:1.0;"/><g id="elem_#3"><polygon fill="#F1F1F1" points="188.8656,67,200.8656,79,188.8656,91,176.8656,79,188.8656,67" style="stroke:#181818;stroke-width:0.5;"/></g><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="144" x="146.8656" y="474.04"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="124" x="156.8656" y="496.8681">Validate server details</text><g id="elem_#8"><polygon fill="#F1F1F1" points="274.8656,67,286.8656,79,274.8656,91,262.8656,79,274.8656,67" style="stroke:#181818;stroke-width:0.5;"/></g><ellipse cx="338.8656" cy="978.1" fill="none" rx="10" ry="10" style="stroke:#222222;stroke-width:1.0;"/><ellipse cx="339.3656" cy="978.6" fill="#222222" rx="6" ry="6" style="stroke:none;stroke-width:1.0;"/><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="81" x="234.3656" y="147"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="61" x="244.3656" y="169.8281">Login page</text><g id="elem_#15"><polygon fill="#F1F1F1" points="274.8656,224.35,286.8656,236.35,274.8656,248.35,262.8656,236.35,274.8656,224.35" style="stroke:#181818;stroke-width:0.5;"/></g><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="137" x="142.3656" y="566.38"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="117" x="152.3656" y="589.2081">Open login flow page</text><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="115" x="151.3656" y="643.72"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="95" x="161.3656" y="666.5481">Initiate login flow</text><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="125" x="146.3656" y="721.07"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="105" x="156.3656" y="743.8981">Open web browser</text><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="155" x="131.3656" y="798.41"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="135" x="141.3656" y="821.2381">Wait for login flow result</text><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="135" x="222.3656" y="875.76"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="115" x="232.3656" y="898.5881">Validate login details</text><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="129" x="154.3656" y="304.35"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="109" x="164.3656" y="327.1781">Open QR scan page</text><rect fill="#F1F1F1" height="36.3441" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="96" x="170.8656" y="396.69"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="76" x="180.8656" y="419.5181">Scan QR code</text><!--link start to #3--><g id="link_start_#3"><path d="M188.8656,26.27 C188.8656,35.38 188.8656,49.51 188.8656,60.7 " fill="none" id="start-to-#3" style="stroke:#181818;stroke-width:1.0;"/><polygon fill="#181818" points="188.8656,65.57,192.8656,56.57,188.8656,60.57,184.8656,56.57,188.8656,65.57" style="stroke:#181818;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="163" x="6" y="59.7125">Started from QR code scanner?</text></g><!--link #3 to Validate server details--><g id="link_#3_Validate server details"><path d="M181.8056,84.32 C164.7756,95.34 122.8656,126.29 122.8656,164.18 C122.8656,164.18 122.8656,164.18 122.8656,415.86 C122.8656,440.77 143.1156,458.7 165.0156,470.79 " fill="none" id="#3-to-Validate server details" style="stroke:#FF0000;stroke-width:1.0;"/><polygon fill="#FF0000" points="169.3056,473.59,163.2311,465.8375,164.8891,471.246,159.4807,472.9039,169.3056,473.59" style="stroke:#FF0000;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="17" x="123.8656" y="281.1089">Yes</text></g><!--link #3 to #8--><g id="link_#3_#8"><path d="M201.5556,79 C216.1156,79 240.1256,79 256.6756,79 " fill="none" id="#3-to-#8" style="stroke:#181818;stroke-width:1.0;"/><polygon fill="#181818" points="261.4056,79,252.4056,75,256.4056,79,252.4056,83,261.4056,79" style="stroke:#181818;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="15" x="224.3656" y="72.7589">No</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="68" x="187.0688" y="100.5703">Has account?</text></g><!--link #8 to end--><g id="link_#8_end"><path d="M284.1956,82.08 C311.4256,88.74 388.8656,112.27 388.8656,164.18 C388.8656,164.18 388.8656,164.18 388.8656,894.93 C388.8656,919.48 387.2556,927.52 373.8656,948.1 C368.3356,956.59 359.5556,963.86 352.1656,968.99 " fill="none" id="#8-to-end" style="stroke:#181818;stroke-width:1.0;"/><polygon fill="#181818" points="348.3356,972.2,358.0468,970.559,352.5025,969.4364,353.6251,963.8921,348.3356,972.2" style="stroke:#181818;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="17" x="389.8656" y="543.1389">Yes</text></g><!--link #8 to Login page--><g id="link_#8_Login page"><path d="M274.8656,91.71 C274.8656,104.42 274.8656,125.05 274.8656,141.06 " fill="none" id="#8-to-Login page" style="stroke:#181818;stroke-width:1.0;"/><polygon fill="#181818" points="274.8656,145.72,278.8656,136.72,274.8656,140.72,270.8656,136.72,274.8656,145.72" style="stroke:#181818;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="15" x="275.8656" y="123.7589">No</text></g><!--link Login page to #15--><g id="link_Login page_#15"><path d="M274.8656,183.63 C274.8656,194.2 274.8656,207.63 274.8656,218.16 " fill="none" id="Login page-to-#15" style="stroke:#181818;stroke-width:1.0;"/><polygon fill="#181818" points="274.8656,222.97,278.8656,213.97,274.8656,217.97,270.8656,213.97,274.8656,222.97" style="stroke:#181818;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="122" x="132.6594" y="215.4719">Selected login method?</text></g><!--link #15 to Validate server details--><g id="link_#15_Validate server details"><path d="M280.7656,242.34 C286.8956,247.94 296.0956,257.65 299.8656,268.35 C324.4656,338.04 311.1856,367.58 276.8656,433.04 C269.4956,447.08 257.5856,459.91 246.4656,469.92 " fill="none" id="#15-to-Validate server details" style="stroke:#0000FF;stroke-width:1.0;"/><polygon fill="#0000FF" points="243.0856,473.75,252.4873,470.8161,246.8423,470.4504,247.208,464.8054,243.0856,473.75" style="stroke:#0000FF;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="56" x="308.8656" y="373.4489">Login flow</text></g><!--link Validate server details to Open login flow page--><g id="link_Validate server details_Open login flow page"><path d="M217.3256,510.63 C216.0756,524.75 214.2956,544.78 212.9256,560.28 " fill="none" id="Validate server details-to-Open login flow page" style="stroke:#0000FF;stroke-width:1.0;"/><polygon fill="#0000FF" points="212.4056,565.19,217.1884,556.5804,212.8493,560.2097,209.22,555.8706,212.4056,565.19" style="stroke:#0000FF;stroke-width:1.0;"/></g><!--link Open login flow page to Initiate login flow--><g id="link_Open login flow page_Initiate login flow"><path d="M210.4056,603.03 C210.1356,613.22 209.7856,626.22 209.4956,637.32 " fill="none" id="Open login flow page-to-Initiate login flow" style="stroke:#0000FF;stroke-width:1.0;"/><polygon fill="#0000FF" points="209.3356,642.25,213.5657,633.3558,209.4642,637.2517,205.5683,633.1502,209.3356,642.25" style="stroke:#0000FF;stroke-width:1.0;"/></g><!--link Initiate login flow to Open web browser--><g id="link_Initiate login flow_Open web browser"><path d="M208.8656,680.37 C208.8656,690.57 208.8656,703.57 208.8656,714.66 " fill="none" id="Initiate login flow-to-Open web browser" style="stroke:#0000FF;stroke-width:1.0;"/><polygon fill="#0000FF" points="208.8656,719.6,212.8656,710.6,208.8656,714.6,204.8656,710.6,208.8656,719.6" style="stroke:#0000FF;stroke-width:1.0;"/></g><!--link Open web browser to Wait for login flow result--><g id="link_Open web browser_Wait for login flow result"><path d="M208.8656,757.71 C208.8656,767.91 208.8656,780.91 208.8656,792.01 " fill="none" id="Open web browser-to-Wait for login flow result" style="stroke:#0000FF;stroke-width:1.0;"/><polygon fill="#0000FF" points="208.8656,796.94,212.8656,787.94,208.8656,791.94,204.8656,787.94,208.8656,796.94" style="stroke:#0000FF;stroke-width:1.0;"/></g><!--link Wait for login flow result to Validate login details--><g id="link_Wait for login flow result_Validate login details"><path d="M227.6556,835.06 C239.3256,845.92 254.4156,859.95 266.8056,871.48 " fill="none" id="Wait for login flow result-to-Validate login details" style="stroke:#0000FF;stroke-width:1.0;"/><polygon fill="#0000FF" points="269.8956,874.29,266.0467,865.2244,266.2408,870.8779,260.5873,871.0721,269.8956,874.29" style="stroke:#0000FF;stroke-width:1.0;"/></g><!--link #15 to Open QR scan page--><g id="link_#15_Open QR scan page"><path d="M270.0556,243.93 C265.5256,250.17 258.6156,259.81 252.8656,268.35 C246.0856,278.41 238.8156,289.71 232.7356,299.3 " fill="none" id="#15-to-Open QR scan page" style="stroke:#FF0000;stroke-width:1.0;"/><polygon fill="#FF0000" points="229.6856,303.14,237.8826,297.6801,232.3626,298.917,231.1257,293.397,229.6856,303.14" style="stroke:#FF0000;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="44" x="253.8656" y="281.1089">QR code</text></g><!--link Open QR scan page to Scan QR code--><g id="link_Open QR scan page_Scan QR code"><path d="M218.8656,340.94 C218.8656,355.06 218.8656,375.09 218.8656,390.59 " fill="none" id="Open QR scan page-to-Scan QR code" style="stroke:#FF0000;stroke-width:1.0;"/><polygon fill="#FF0000" points="218.8656,395.5,222.8656,386.5,218.8656,390.5,214.8656,386.5,218.8656,395.5" style="stroke:#FF0000;stroke-width:1.0;"/></g><!--link Scan QR code to Validate server details--><g id="link_Scan QR code_Validate server details"><path d="M218.8656,433.34 C218.8656,443.54 218.8656,456.53 218.8656,467.63 " fill="none" id="Scan QR code-to-Validate server details" style="stroke:#FF0000;stroke-width:1.0;"/><polygon fill="#FF0000" points="218.8656,472.57,222.8656,463.57,218.8656,467.57,214.8656,463.57,218.8656,472.57" style="stroke:#FF0000;stroke-width:1.0;"/></g><!--link Validate server details to Validate login details--><g id="link_Validate server details_Validate login details"><path d="M259.4156,510.87 C286.7556,525.82 317.8656,550.16 317.8656,583.55 C317.8656,583.55 317.8656,583.55 317.8656,817.58 C317.8656,836.1 310.3456,855.67 303.0956,870.22 " fill="none" id="Validate server details-to-Validate login details" style="stroke:#FF0000;stroke-width:1.0;"/><polygon fill="#FF0000" points="300.4556,874.34,308.1455,868.1864,302.7543,869.8997,301.041,864.5086,300.4556,874.34" style="stroke:#FF0000;stroke-width:1.0;"/></g><!--link Validate login details to end--><g id="link_Validate login details_end"><path d="M289.9656,912.37 C290.7656,923.36 293.1956,937.43 299.8656,948.1 C305.8656,957.7 316.2856,965.2 324.8456,970.17 " fill="none" id="Validate login details-to-end" style="stroke:#181818;stroke-width:1.0;"/><polygon fill="#181818" points="328.8856,972.93,322.9303,965.0856,324.5054,970.5188,319.0723,972.0939,328.8856,972.93" style="stroke:#181818;stroke-width:1.0;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="71" x="300.8656" y="944.8589">Login success</text></g><rect fill="#DDDDDD" height="71.2038" id="_legend" rx="7.5" ry="7.5" style="stroke:#000000;stroke-width:1.0;" width="154" x="12" y="1005.1"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="35" x="17" y="1027.0659">Color</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="93" x="64" y="1027.0659">Login method</text><rect fill="#FF0000" height="19.0679" style="stroke:none;stroke-width:1.0;" width="43" x="17" y="1031.1679"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="4" x="17" y="1046.1339">&#160;</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="58" x="64" y="1046.1339">QR Code</text><rect fill="#0000FF" height="19.0679" style="stroke:none;stroke-width:1.0;" width="43" x="17" y="1050.2358"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="4" x="17" y="1065.2018">&#160;</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="69" x="64" y="1065.2018">Login flow</text><line style="stroke:#000000;stroke-width:1.0;" x1="17" x2="161" y1="1012.1" y2="1012.1"/><line style="stroke:#000000;stroke-width:1.0;" x1="17" x2="161" y1="1031.1679" y2="1031.1679"/><line style="stroke:#000000;stroke-width:1.0;" x1="17" x2="161" y1="1050.2358" y2="1050.2358"/><line style="stroke:#000000;stroke-width:1.0;" x1="17" x2="161" y1="1069.3038" y2="1069.3038"/><line style="stroke:#000000;stroke-width:1.0;" x1="17" x2="17" y1="1012.1" y2="1069.3038"/><line style="stroke:#000000;stroke-width:1.0;" x1="60" x2="60" y1="1012.1" y2="1069.3038"/><line style="stroke:#000000;stroke-width:1.0;" x1="161" x2="161" y1="1012.1" y2="1069.3038"/><!--SRC=[XLBBQiCm4BphAnRraWJy1yKzvD92I6aBBINue4XhHw18GPBhYp- -UjYkK_UXWy6QsTcT7QqsQv0rq1VFh4S1jJLdU7e6RWI2uqnhj7SK_0arAGut5aLLb8TtT1NGLwQaO3xmq7wW1O6UIUKeGUMGG3Y1kZTLQd3F733EJQlzg0V3AKR5rMQTBgVw4OqYT6SQgU726gIPfOMiIVwIv04LycX29UOP_Sc8URDWuAXQZ0woMArCzvUHwoAWZnVKWteidGqpPprewMMK-sB-8jNX4OxMTA7lal76f8VQs7b3YwvLVicT76Jk3qbCsGtXLiC8uJV6V6qbKyD68p8KBC3_jhRWVPyj9rTCQRYMStJ3Eo14OHCeeB3sIRBV6XMs0JtiPlb2dy7RsAyCO1Xt6nzlEXCODrMEbMcL4GpwkGlv1000]--></g></svg>
\ No newline at end of file