Added comments to setup flow controllers

FlowCrypt.xcodeproj/project.pbxproj

@@ -11,16 +11,13 @@
 		04B472951ECE29F600B8266F /* MyMenuViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 04B472921ECE29F600B8266F /* MyMenuViewController.swift */; };
 		04B472961ECE29F600B8266F /* SideMenuNavigationController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 04B472931ECE29F600B8266F /* SideMenuNavigationController.swift */; };
 		211392A5266511E6009202EC /* PubLookup.swift in Sources */ = {isa = PBXBuildFile; fileRef = 211392A4266511E6009202EC /* PubLookup.swift */; };
-		21489B6B267B7BD800BDE4AC /* FilesManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21489B6A267B7BD800BDE4AC /* FilesManagerTests.swift */; };
- 		21489B6C267B7C6A00BDE4AC /* FilesManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 215897E7267A553200423694 /* FilesManager.swift */; };
- 		21489B6E267B7D5000BDE4AC /* FileMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21489B6D267B7D5000BDE4AC /* FileMock.swift */; };
- 		215897E8267A553300423694 /* FilesManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 215897E7267A553200423694 /* FilesManager.swift */; };
-		2196A2202684B9BE001B9E00 /* URLExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2196A21F2684B9BE001B9E00 /* URLExtension.swift */; };
 		21489B78267CB42400BDE4AC /* ClientConfigurationProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21489B77267CB42400BDE4AC /* ClientConfigurationProvider.swift */; };
 		21489B7A267CB4DF00BDE4AC /* ClientConfigurationObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21489B79267CB4DF00BDE4AC /* ClientConfigurationObject.swift */; };
 		21489B7C267CBA0E00BDE4AC /* ClientConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21489B7B267CBA0E00BDE4AC /* ClientConfiguration.swift */; };
 		21489B80267CC39E00BDE4AC /* OrganisationalRulesService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21489B7F267CC39E00BDE4AC /* OrganisationalRulesService.swift */; };
 		21489B83267CC99C00BDE4AC /* OrganisationalRulesServiceError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21489B82267CC99C00BDE4AC /* OrganisationalRulesServiceError.swift */; };
+		215897E8267A553300423694 /* FilesManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 215897E7267A553200423694 /* FilesManager.swift */; };
+		2196A2202684B9BE001B9E00 /* URLExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2196A21F2684B9BE001B9E00 /* URLExtension.swift */; };
 		21C7DEFC26669A3700C44800 /* CalendarExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21C7DEFB26669A3700C44800 /* CalendarExtension.swift */; };
 		21C7DEFE26669CE100C44800 /* DateFormattingExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F56BD3723438C7000A7371A /* DateFormattingExtensions.swift */; };
 		21C7DF0526697DA500C44800 /* PromiseKitExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 21C7DF0426697DA500C44800 /* PromiseKitExtension.swift */; };
@@ -109,7 +106,7 @@
 		9F7E5137267AA51B00CE37C3 /* AlertsFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F7E5136267AA51B00CE37C3 /* AlertsFactory.swift */; };
 		9F8220D526336626004B2009 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F8220D426336626004B2009 /* Logger.swift */; };
 		9F82779823737E0900E19C07 /* MessageViewDecorator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F82779723737E0900E19C07 /* MessageViewDecorator.swift */; };
-		9F82D352256D74FA0069A702 /* InboxViewControllerContainer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F82D351256D74FA0069A702 /* InboxViewControllerContainer.swift */; };
+		9F82D352256D74FA0069A702 /* InboxViewContainerController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F82D351256D74FA0069A702 /* InboxViewContainerController.swift */; };
 		9F92EE72236F165E009BE0D7 /* EncryptedStorage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F92EE71236F165E009BE0D7 /* EncryptedStorage.swift */; };
 		9F9361A52573CE260009912F /* MessageProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F9361A42573CE260009912F /* MessageProvider.swift */; };
 		9F9362062573D0C80009912F /* Gmail+MessagesList.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9F9362052573D0C80009912F /* Gmail+MessagesList.swift */; };
@@ -366,13 +363,13 @@
 		211392A4266511E6009202EC /* PubLookup.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PubLookup.swift; sourceTree = "<group>"; };
 		21489B6A267B7BD800BDE4AC /* FilesManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FilesManagerTests.swift; sourceTree = "<group>"; };
 		21489B6D267B7D5000BDE4AC /* FileMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileMock.swift; sourceTree = "<group>"; };
-		215897E7267A553200423694 /* FilesManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FilesManager.swift; sourceTree = "<group>"; };
-		2196A21F2684B9BE001B9E00 /* URLExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = URLExtension.swift; sourceTree = "<group>"; };
 		21489B77267CB42400BDE4AC /* ClientConfigurationProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ClientConfigurationProvider.swift; sourceTree = "<group>"; };
 		21489B79267CB4DF00BDE4AC /* ClientConfigurationObject.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ClientConfigurationObject.swift; sourceTree = "<group>"; };
 		21489B7B267CBA0E00BDE4AC /* ClientConfiguration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ClientConfiguration.swift; sourceTree = "<group>"; };
 		21489B7F267CC39E00BDE4AC /* OrganisationalRulesService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrganisationalRulesService.swift; sourceTree = "<group>"; };
 		21489B82267CC99C00BDE4AC /* OrganisationalRulesServiceError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrganisationalRulesServiceError.swift; sourceTree = "<group>"; };
+		215897E7267A553200423694 /* FilesManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FilesManager.swift; sourceTree = "<group>"; };
+		2196A21F2684B9BE001B9E00 /* URLExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = URLExtension.swift; sourceTree = "<group>"; };
 		21C7DEFB26669A3700C44800 /* CalendarExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CalendarExtension.swift; sourceTree = "<group>"; };
 		21C7DF0426697DA500C44800 /* PromiseKitExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PromiseKitExtension.swift; sourceTree = "<group>"; };
 		21C7DF08266C0D8F00C44800 /* EnterpriseServerApi.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EnterpriseServerApi.swift; sourceTree = "<group>"; };
@@ -513,7 +510,7 @@
 		9F82779923737E1900E19C07 /* MessageSenderNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageSenderNode.swift; sourceTree = "<group>"; };
 		9F82779B23737E2A00E19C07 /* MessageSubjectNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageSubjectNode.swift; sourceTree = "<group>"; };
 		9F82779D23737E3800E19C07 /* MessageTextSubjectNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageTextSubjectNode.swift; sourceTree = "<group>"; };
-		9F82D351256D74FA0069A702 /* InboxViewControllerContainer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InboxViewControllerContainer.swift; sourceTree = "<group>"; };
+		9F82D351256D74FA0069A702 /* InboxViewContainerController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InboxViewContainerController.swift; sourceTree = "<group>"; };
 		9F8D5E61236B04E300186E43 /* CellNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CellNode.swift; sourceTree = "<group>"; };
 		9F92EE6F236F144C009BE0D7 /* TextFieldCellNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TextFieldCellNode.swift; sourceTree = "<group>"; };
 		9F92EE71236F165E009BE0D7 /* EncryptedStorage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EncryptedStorage.swift; sourceTree = "<group>"; };
@@ -783,14 +780,6 @@
 			path = FilesManager;
 			sourceTree = "<group>";
 		};
-		215897E6267A551300423694 /* FilesManager */ = {
-			isa = PBXGroup;
-			children = (
-				215897E7267A553200423694 /* FilesManager.swift */,
-			);
-			path = FilesManager;
-			sourceTree = "<group>";
-		};
 		21489B81267CC3BC00BDE4AC /* Organisational Rules Service */ = {
 			isa = PBXGroup;
 			children = (
@@ -801,6 +790,14 @@
 			path = "Organisational Rules Service";
 			sourceTree = "<group>";
 		};
+		215897E6267A551300423694 /* FilesManager */ = {
+			isa = PBXGroup;
+			children = (
+				215897E7267A553200423694 /* FilesManager.swift */,
+			);
+			path = FilesManager;
+			sourceTree = "<group>";
+		};
 		21CE25D32650034500ADFF4B /* WKDURLs */ = {
 			isa = PBXGroup;
 			children = (
@@ -931,9 +928,9 @@
 		5A39F43B239ECFA0001F4607 /* KeySettings */ = {
 			isa = PBXGroup;
 			children = (
+				5ADEDCB423A4262600EC495E /* Key List */,
 				D29A0002240C140500C1387D /* Key Detail Info */,
 				D29A0003240C141200C1387D /* Public Key */,
-				5ADEDCB423A4262600EC495E /* Key List */,
 				5ADEDCB723A426E900EC495E /* Key Details */,
 			);
 			path = KeySettings;
@@ -1147,7 +1144,7 @@
 		9F4300A52571016400791CFB /* Container */ = {
 			isa = PBXGroup;
 			children = (
-				9F82D351256D74FA0069A702 /* InboxViewControllerContainer.swift */,
+				9F82D351256D74FA0069A702 /* InboxViewContainerController.swift */,
 				9F4300CB2571045B00791CFB /* InboxViewControllerContainerDecorator.swift */,
 			);
 			path = Container;
@@ -2525,7 +2522,7 @@
 				9FC7EAB3266A404D00F3BF5D /* PassPhraseObject.swift in Sources */,
 				9F31AB8C23298B3F00CF87EA /* Imap+retry.swift in Sources */,
 				9F79229426696B9300DA3D80 /* KeyDataStorage.swift in Sources */,
-				9F82D352256D74FA0069A702 /* InboxViewControllerContainer.swift in Sources */,
+				9F82D352256D74FA0069A702 /* InboxViewContainerController.swift in Sources */,
 				D227C0E3250538100070F805 /* LocalFoldersProvider.swift in Sources */,
 				9FA405C7265AEBA50084D133 /* SetupGenerateKeyViewController.swift in Sources */,
 				9F6EE1552597399D0059BA51 /* BackupProvider.swift in Sources */,

FlowCrypt/Common UI/View Controllers/WebViewController.swift

@@ -9,6 +9,9 @@
 import UIKit
 import WebKit
 
+/**
+ * InApp WebViewController to show web content. Used for showing privacy policy etc in splash screen and settings
+ */
 final class WebViewController: UIViewController {
     private lazy var webView = WKWebView()
 

FlowCrypt/Controllers/Bootstrap/BootstrapViewController.swift

@@ -8,14 +8,14 @@
 
 import UIKit
 
+/**
+ * View controller with activity indicator which is presented before all AppStartup activity finished (setup Core, migration of the DB...)
+ */
 final class BootstrapViewController: UIViewController {
-    let imap = Imap.shared
-    var completion: ((Error?) -> Void)?
-
     override func viewDidLoad() {
         super.viewDidLoad()
         view.backgroundColor = .backgroundColor
-        let activityIndicator = UIActivityIndicatorView(style: .gray)
+        let activityIndicator = UIActivityIndicatorView(style: .medium)
         activityIndicator.startAnimating()
         view.addSubview(activityIndicator)
         activityIndicator.center = view.center

FlowCrypt/Controllers/Compose/ComposeViewController.swift

@@ -7,6 +7,11 @@ import FlowCryptCommon
 import FlowCryptUI
 import Promises
 
+/**
+ * View controller to compose the message and send it
+ * - User can be redirected here from *InboxViewController* by tapping on *+*
+ * - Or from *MessageViewController* controller by tapping on *reply*
+ */
 final class ComposeViewController: TableNodeViewController {
     struct Recipient {
         let email: String

FlowCrypt/Controllers/Inbox/Container/InboxViewControllerContainer.swift → FlowCrypt/Controllers/Inbox/Container/InboxViewContainerController.swift

@@ -10,9 +10,11 @@ import AsyncDisplayKit
 import FlowCryptCommon
 import FlowCryptUI
 
-// MARK: - InboxViewControllerContainer
-// Used to fetch folders and get correct path for "inbox" folder
-final class InboxViewControllerContainer: TableNodeViewController {
+/**
+ * View controller which serves as intermediate controller
+ * - Used to fetch folders and get correct path for "inbox" folder
+ */
+final class InboxViewContainerController: TableNodeViewController {
     private let inbox = "inbox"
 
     private enum InboxViewControllerContainerError: Error {
@@ -102,7 +104,7 @@ final class InboxViewControllerContainer: TableNodeViewController {
     }
 }
 
-extension InboxViewControllerContainer: ASTableDelegate, ASTableDataSource {
+extension InboxViewContainerController: ASTableDelegate, ASTableDataSource {
     func tableNode(_ tableNode: ASTableNode, numberOfRowsInSection section: Int) -> Int {
         switch state {
         case .empty, .loading:

FlowCrypt/Controllers/Inbox/InboxViewController.swift

@@ -7,6 +7,11 @@ import FlowCryptCommon
 import FlowCryptUI
 import Promises
 
+/**
+ * View controller which shows message list of selected folder or inbox
+ * - Initial view controller of the *main flow* when user is already signed in
+ * - User can be redirected here via selecting folder from menu *MyMenuViewController*
+ */
 final class InboxViewController: ASDKViewController<ASDisplayNode> {
     private enum Constants {
         static let numberOfMessagesToLoad = 50

FlowCrypt/Controllers/Msg/MessageViewController.swift

@@ -7,6 +7,10 @@ import FlowCryptCommon
 import FlowCryptUI
 import Promises
 
+/**
+ * View controller to render an email message (sender, subject, message body, attachments)
+ * Also contains buttons to archive, move to trash, move to inbox, mark as unread, and reply
+ */
 final class MessageViewController: TableNodeViewController {
     struct Input {
         var objMessage: Message

FlowCrypt/Controllers/Search/SearchViewController.swift

@@ -10,6 +10,10 @@ import AsyncDisplayKit
 import FlowCryptCommon
 import FlowCryptUI
 
+/**
+ * View controller to search messages in folders
+ * - User can be redirected here from *InboxViewController* by tapping on search icon
+ */
 final class SearchViewController: TableNodeViewController {
     private enum Constants {
         // TODO: - Ticket - Add pagination for SearchViewController

FlowCrypt/Controllers/Settings/Contacts/Contacts List/ContactDetailViewController.swift

@@ -9,6 +9,10 @@
 import AsyncDisplayKit
 import FlowCryptUI
 
+/**
+ * View controller which shows details about a contact and the public key recorded for it
+ * - User can be redirected here from settings *ContactsListViewController* by tapping on a particular contact
+ */
 final class ContactDetailViewController: TableNodeViewController {
     typealias ContactDetailAction = (Action) -> Void
 

FlowCrypt/Controllers/Settings/Contacts/Contacts List/ContactsListViewController.swift

@@ -10,6 +10,11 @@ import AsyncDisplayKit
 import FlowCryptCommon
 import FlowCryptUI
 
+/**
+ * View controller which shows saved user contacts list
+ * - User can be redirected here from settings *SettingsViewController*
+ * - By tapping on a particular contact, user will be forwarded to *ContactDetailViewController*
+ */
 final class ContactsListViewController: TableNodeViewController {
     private let decorator: ContactsListDecoratorType
     private let contactsProvider: LocalContactsProviderType

FlowCrypt/Controllers/Settings/KeyLegal/LegalViewController.swift

@@ -8,6 +8,10 @@
 
 import UIKit
 
+/**
+ * View controller which shows legal information (privacy, license, sources, terms)
+ * - User can be redirected here from settings *SettingsViewController*
+ */
 final class LegalViewController: UIViewController {
     private let provider: LegalViewControllersProviderType
     private lazy var segment: SegmentedViewController = SegmentedViewController(

FlowCrypt/Controllers/Settings/KeySettings/Key Detail Info/KeyDetailInfoViewController.swift

@@ -9,6 +9,10 @@
 import AsyncDisplayKit
 import FlowCryptUI
 
+/**
+ * View controller which shows information about our own private and public key details (key words, fingerprint ...)
+ * - User can be redirected here from *KeyDetailViewController*
+ */
 final class KeyDetailInfoViewController: TableNodeViewController {
     enum Parts: Int, CaseIterable {
         case keyWord, fingerptint, longId, date, users, separator

FlowCrypt/Controllers/Settings/KeySettings/Key Details/KeyDetailViewController.swift

@@ -9,6 +9,10 @@
 import AsyncDisplayKit
 import FlowCryptUI
 
+/**
+ * View controller which shows possible option for the keys, like show it's public part, details, copy or share it.
+ * - User can be redirected here from *KeyDetailViewController*
+ */
 final class KeyDetailViewController: TableNodeViewController {
     enum Parts: Int, CaseIterable {
         case description, publicInfo, keyDetails, copy, save, privateInfo

FlowCrypt/Controllers/Settings/KeySettings/Key List/KeySettingsViewController.swift

@@ -9,6 +9,12 @@
 import AsyncDisplayKit
 import FlowCryptUI
 
+/**
+ * View controller shows list of user keys
+ * - User can be redirected here from settings *SettingsViewController*
+ * - User can proceed to importing keys *SetupManuallyImportKeyViewController*
+ * - User can see detail information for the key in *KeyDetailViewController*
+ */
 final class KeySettingsViewController: TableNodeViewController {
     private var keys: [KeyDetails] = []
     private let decorator: KeySettingsViewDecoratorType

FlowCrypt/Controllers/Settings/KeySettings/Public Key/PublicKeyDetailViewController.swift

@@ -9,6 +9,10 @@
 import AsyncDisplayKit
 import FlowCryptUI
 
+/**
+ * View controller which shows information about public key
+ * - User can be redirected here from *KeyDetailViewController*
+ */
 final class PublicKeyDetailViewController: TableNodeViewController {
     private let text: String
 

FlowCrypt/Controllers/Settings/Settings List/SettingsViewController.swift

@@ -9,6 +9,12 @@
 import AsyncDisplayKit
 import FlowCryptUI
 
+/**
+ * User settings view controller
+ * - Shows list of possible settings(backups, privacy, contacts, keys, atteseter, notifications, legal, experimental)
+ * - User can be redirected here from side menu
+ * - Tap on each row will navigate user to appropriate settings controller
+ */
 final class SettingsViewController: TableNodeViewController {
     private enum Settings: Int, CaseIterable {
         case backups, privacy, contacts, keys, atteseter, notifications, legal, experimental

FlowCrypt/Controllers/Setup/SetupBackupsViewController.swift

@@ -6,6 +6,15 @@ import AsyncDisplayKit
 import FlowCryptUI
 import Promises
 
+/**
+ * Scene which is responsible for recovering user account with backups from inbox and entered pass phrase
+ * (typically used for end-users, enterprises tend to either import manually or with EKM)
+ * - User is sent here from **SetupInitialViewController** if there was key backups found in inbox
+ * - User will be prompted to enter his pass phrase
+ * - Pass phrase can be saved in memory for 4 hours or in encrypted local storage
+ * - In case entered pass phrase matches with backups, user will be redirected to **main flow** (inbox view)
+ */
+
 final class SetupBackupsViewController: TableNodeViewController, PassPhraseSaveable {
     private enum Parts: Int, CaseIterable {
         case title, description, passPhrase, divider, saveLocally, saveInMemory, action, optionalAction

FlowCrypt/Controllers/Setup/SetupGenerateKeyViewController.swift

@@ -22,6 +22,13 @@ enum CreateKeyError: Error {
     case conformingPassPhraseError
 }
 
+/**
+ * Controller which is responsible for generating a new key during setup
+ * - User is sent here from **SetupInitialViewController** in case there are no backups found
+ * - Here user can enter a pass phrase (can be saved in memory or in encrypted storage) and generate a key
+ * - After key is generated, user will be redirected to **main flow** (inbox view)
+ */
+
 final class SetupGenerateKeyViewController: TableNodeViewController, PassPhraseSaveable {
     enum Parts: Int, CaseIterable {
         case title, description, passPhrase, divider, saveLocally, saveInMemory, action, subtitle

FlowCrypt/Controllers/Setup/SetupInitialViewController.swift

@@ -9,6 +9,14 @@
 import AsyncDisplayKit
 import FlowCryptUI
 
+/**
+ * Initial controller for setup flow which is responsible for searching backups and
+ * then redirecting user to appropriate setup flow.
+ * - In case backup keys are found, user will be redirected to **SetupBackupsViewController**
+ * - In case there are no backups, user will have two options presented in this view:
+ *      - Import key - **SetupManuallyImportKeyViewController**
+ *      - Create new key - **SetupGenerateKeyViewController**
+ */
 final class SetupInitialViewController: TableNodeViewController {
     private enum Parts: Int, CaseIterable {
         case title, description, createKey, importKey, anotherAccount