thread error descriptions to squawk throughout app (#2286)

rnystrom · web-flow · commit 3ae609292d71 · 2018-10-13T23:09:45.000-04:00
diff --git a/Classes/Image Upload/ImageUploadTableViewController.swift b/Classes/Image Upload/ImageUploadTableViewController.swift
@@ -189,8 +189,8 @@ class ImageUploadTableViewController: UITableViewController {
                 description: "") { [weak self] result in
 
                 switch result {
-                case .error:
-                    Squawk.showGenericError()
+                case .error(let error):
+                    Squawk.show(error: error)
                     self?.setRightBarItemIdle()
 
                 case .success(let link):
diff --git a/Classes/Issues/AddCommentClient.swift b/Classes/Issues/AddCommentClient.swift
@@ -61,11 +61,11 @@ final class AddCommentClient {
                         viewerCanDelete: fragments.deletableFields.viewerCanDelete
                     )
                 }
-            case .failure:
+            case .failure(let error):
                 for listener in self.listeners {
                     listener.listener?.didFailSendingComment(client: self, subjectId: subjectId, body: body)
                 }
-                Squawk.showGenericError()
+                Squawk.show(error: error)
             }
         }
     }
diff --git a/Classes/Issues/Comments/IssueCommentSectionController.swift b/Classes/Issues/Comments/IssueCommentSectionController.swift
@@ -261,11 +261,10 @@ final class IssueCommentSectionController:
             commentID: "\(number)")
         ) { [weak self] result in
             switch result {
-            case .failure:
+            case .failure(let error):
                 self?.hasBeenDeleted = false
                 self?.update(animated: trueUnlessReduceMotionEnabled)
-
-                Squawk.showGenericError()
+                Squawk.show(error: error)
             case .success: break // Don't need to handle success since updated optimistically
             }
         }
@@ -297,9 +296,9 @@ final class IssueCommentSectionController:
         ) { [weak self] result in
             switch result {
             case .success: break
-            case .failure:
+            case .failure(let error):
                 self?.edit(markdown: originalMarkdown)
-                Squawk.showGenericError()
+                Squawk.show(error: error)
             }
         }
     }
diff --git a/Classes/Issues/EditComment/EditCommentViewController.swift b/Classes/Issues/EditComment/EditCommentViewController.swift
@@ -173,7 +173,9 @@ MessageTextViewListener {
         ) { [weak self] result in
             switch result {
             case .success: self?.didSave(markdown: markdown)
-            case .failure: self?.error()
+            case .failure(let error):
+                self?.setRightBarItemIdle()
+                Squawk.show(error: error)
             }
         }
     }
@@ -183,11 +185,6 @@ MessageTextViewListener {
         delegate?.didEditComment(viewController: self, markdown: markdown)
     }
 
-    func error() {
-        setRightBarItemIdle()
-        Squawk.showGenericError()
-    }
-
     // MARK: MessageTextViewListener
 
     func didChange(textView: MessageTextView) {
diff --git a/Classes/Issues/GithubClient+Issues.swift b/Classes/Issues/GithubClient+Issues.swift
@@ -59,9 +59,9 @@ extension GithubClient {
 
         client.query(query, result: { $0.repository }) { result in
             switch result {
-            case .failure:
-                completion(.error(nil))
-                Squawk.showGenericError()
+            case .failure(let error):
+                completion(.error(error))
+                Squawk.show(error: error)
             case .success(let repository):
                 let issueOrPullRequest = repository.issueOrPullRequest
                 guard let issueType: IssueType = issueOrPullRequest?.asIssue ?? issueOrPullRequest?.asPullRequest else {
@@ -193,13 +193,9 @@ extension GithubClient {
             switch result {
             case .success(let data):
                 completion(createIssueReactions(reactions: data))
-            case .failure(let err):
+            case .failure(let error):
                 completion(nil)
-                if let message = err?.localizedDescription {
-                    Squawk.showError(message: message)
-                } else {
-                    Squawk.showGenericError()
-                }
+                Squawk.show(error: error)
             }
         }
 
@@ -252,9 +248,9 @@ extension GithubClient {
         client.send(V3SetIssueStatusRequest(owner: owner, repo: repo, number: number, state: stateString)) { result in
             switch result {
             case .success: break
-            case .failure:
+            case .failure(let error):
                 cache.set(value: previous)
-                Squawk.showGenericError()
+                Squawk.show(error: error)
             }
         }
     }
@@ -294,10 +290,10 @@ extension GithubClient {
             switch result {
             case .success:
                 completion?(.success(true))
-            case .failure:
+            case .failure(let error):
                 cache.set(value: previous)
-                Squawk.showGenericError()
-                completion?(.error(nil))
+                Squawk.show(error: error)
+                completion?(.error(error))
             }
         }
     }
@@ -405,9 +401,9 @@ extension GithubClient {
         ) { result in
             switch result {
             case .success: break
-            case .failure:
+            case .failure(let error):
                 cache.set(value: previous)
-                Squawk.showGenericError()
+                Squawk.show(error: error)
             }
         }
     }
@@ -503,9 +499,9 @@ extension GithubClient {
             ) { result in
                 switch result {
                 case .success: break
-                case .failure:
+                case .failure(let error):
                     cache.set(value: previous)
-                    Squawk.showGenericError()
+                    Squawk.show(error: error)
                 }
             }
         }
@@ -523,9 +519,9 @@ extension GithubClient {
             ) { result in
                 switch result {
                 case .success: break
-                case .failure:
+                case .failure(let error):
                     cache.set(value: previous)
-                    Squawk.showGenericError()
+                    Squawk.show(error: error)
                 }
             }
         }
diff --git a/Classes/Issues/IssuesViewController.swift b/Classes/Issues/IssuesViewController.swift
@@ -304,8 +304,8 @@ final class IssuesViewController:
                     }
                     // avoid finishLoading() so empty view doesn't appear
                     self?.feed.adapter.performUpdates(animated: trueUnlessReduceMotionEnabled)
-                case .error:
-                    Squawk.showGenericError()
+                case .error(let error):
+                    Squawk.show(error: error)
                 }
             }
         }
diff --git a/Classes/Issues/Merge/GithubClient+Merge.swift b/Classes/Issues/Merge/GithubClient+Merge.swift
@@ -54,8 +54,8 @@ extension GithubClient {
             switch result {
             case .success:
                 cache.set(value: optimisticResult)
-            case .failure:
-                Squawk.showGenericError()
+            case .failure(let err):
+                Squawk.show(error: err)
                 error()
             }
         }
diff --git a/Classes/Labels/LabelsViewController.swift b/Classes/Labels/LabelsViewController.swift
@@ -68,8 +68,8 @@ final class LabelsViewController: BaseListViewController2<String>, BaseListViewC
                     return RepositoryLabel(color: node.color, name: node.name)
                 }.sorted { $0.name < $1.name }
                 self?.update(animated: true)
-            case .failure:
-                Squawk.showGenericError()
+            case .failure(let error):
+                Squawk.show(error: error)
             }
         }
     }
diff --git a/Classes/Milestones/GithubClient+Milestones.swift b/Classes/Milestones/GithubClient+Milestones.swift
@@ -97,9 +97,9 @@ extension GithubClient {
         ) { result in
             switch result {
             case .success: break
-            case .failure:
+            case .failure(let error):
                 cache.set(value: previous)
-                Squawk.showGenericError()
+                Squawk.show(error: error)
             }
         }
     }
diff --git a/Classes/Milestones/MilestonesViewController.swift b/Classes/Milestones/MilestonesViewController.swift
@@ -64,8 +64,8 @@ MilestoneSectionControllerDelegate {
             switch result {
             case .success(let milestones):
                 self?.milestones = milestones
-            case .error:
-                Squawk.showGenericError()
+            case .error(let error):
+                Squawk.show(error: error)
             }
             self?.update(animated: true)
         }
diff --git a/Classes/New Issue/NewIssueTableViewController.swift b/Classes/New Issue/NewIssueTableViewController.swift
@@ -167,8 +167,8 @@ final class NewIssueTableViewController: UITableViewController, UITextFieldDeleg
                 strongSelf.dismiss(animated: trueUnlessReduceMotionEnabled, completion: {
                     delegate?.didDismissAfterCreatingIssue(model: model)
                 })
-            case .failure:
-                Squawk.showGenericError()
+            case .failure(let error):
+                Squawk.show(error: error)
             }
         }
     }
diff --git a/Classes/Notifications/NotificationSectionController.swift b/Classes/Notifications/NotificationSectionController.swift
@@ -109,8 +109,8 @@ final class NotificationSectionController: ListSwiftSectionController<Notificati
                         repo: model.repo,
                         release: response.data.tagName
                     )
-                case .failure:
-                    Squawk.showGenericError()
+                case .failure(let error):
+                    Squawk.show(error: error)
                 }
         }
     }
diff --git a/Classes/Notifications/NotificationsViewController.swift b/Classes/Notifications/NotificationsViewController.swift
@@ -101,9 +101,9 @@ BaseListViewController2EmptyDataSource {
                 ids.append($0.id)
             }
             rebuildAndUpdate(ids: ids, append: append, page: next, animated: animated)
-        case .error:
+        case .error(let err):
             error(animated: trueUnlessReduceMotionEnabled)
-            Squawk.showNetworkError()
+            Squawk.show(error: err)
         }
 
         // set after updating so self.models has already been changed
diff --git a/Classes/People/PeopleViewController.swift b/Classes/People/PeopleViewController.swift
@@ -135,8 +135,8 @@ PeopleSectionControllerDelegate {
                     nextPage = nil
                 }
                 self?.update(page: nextPage, animated: true)
-            case .failure:
-                Squawk.showGenericError()
+            case .failure(let error):
+                Squawk.show(error: error)
             }
         }
     }
diff --git a/Classes/PullRequestReviews/GithubClient+PullRequestReviewComments.swift b/Classes/PullRequestReviews/GithubClient+PullRequestReviewComments.swift
@@ -35,7 +35,7 @@ extension GithubClient {
         client.send(V3PullRequestCommentsRequest(owner: owner, repo: repo, number: number)) { result in
             switch result {
             case .failure(let error):
-                Squawk.showGenericError()
+                Squawk.show(error: error)
                 completion(.error(error))
             case .success(let response):
                 struct Thread {
@@ -144,7 +144,7 @@ extension GithubClient {
                     completion(.error(nil))
                 }
             case .failure(let error):
-                Squawk.showGenericError()
+                Squawk.show(error: error)
                 completion(.error(error))
             }
         }
diff --git a/Classes/PullRequestReviews/PullRequestReviewCommentsViewController.swift b/Classes/PullRequestReviews/PullRequestReviewCommentsViewController.swift
@@ -128,7 +128,8 @@ final class PullRequestReviewCommentsViewController: MessageViewController,
         width: insetWidth
         ) { [weak self] (result) in
             switch result {
-            case .error: Squawk.showGenericError()
+            case .error(let error):
+                Squawk.show(error: error)
             case .success(let models):
                 self?.results = models
                 self?.feed.finishLoading(dismissRefresh: true, animated: true)
diff --git a/Classes/Repository/RepositoryBranches/RepositoryBranchesViewController.swift b/Classes/Repository/RepositoryBranches/RepositoryBranchesViewController.swift
@@ -84,8 +84,8 @@ RepositoryBranchSectionControllerDelegate
                     branches: branches
                 )
                 
-            case .error:
-                Squawk.showError(message: "Couldn't fetch repository branches")
+            case .error(let error):
+                Squawk.show(error: error)
             }
             self?.update(animated: true)
         }
diff --git a/Classes/Repository/RepositoryClient.swift b/Classes/Repository/RepositoryClient.swift
@@ -130,9 +130,9 @@ final class RepositoryClient {
         let contentSizeCategory = UIContentSizeCategory.preferred
         githubClient.client.query(query, result: { $0 }) { result in
             switch result {
-            case .failure:
-                Squawk.showGenericError()
-                completion(.error(nil))
+            case .failure(let error):
+                Squawk.show(error: error)
+                completion(.error(error))
             case .success(let data):
                 DispatchQueue.global().async {
                     // jump to a bg queue to parse models and presize text
diff --git a/Classes/Repository/RepositoryCodeBlobViewController.swift b/Classes/Repository/RepositoryCodeBlobViewController.swift
@@ -147,9 +147,9 @@ final class RepositoryCodeBlobViewController: UIViewController, EmptyViewDelegat
                 self?.handle(text: text)
             case .nonUTF8:
                 self?.error(cannotLoad: true)
-            case .error:
+            case .error(let error):
                 self?.error(cannotLoad: false)
-                Squawk.showGenericError()
+                Squawk.show(error: error)
             }
         }
     }
diff --git a/Classes/Search/GithubClient+Search.swift b/Classes/Search/GithubClient+Search.swift
@@ -30,7 +30,7 @@ extension GithubClient {
             case .failure(let error):
                 completion(.error(error))
                 if !isCancellationError(error) {
-                    Squawk.showGenericError()
+                    Squawk.show(error: error)
                 }
             case .success(let data):
                 DispatchQueue.global().async {
diff --git a/Classes/Systems/Autocomplete/IssueAutocomplete.swift b/Classes/Systems/Autocomplete/IssueAutocomplete.swift
@@ -59,8 +59,8 @@ final class IssueAutocomplete: AutocompleteType {
             result: { $0 }
         ) { [weak self] result in
             switch result {
-            case .failure:
-                Squawk.showGenericError()
+            case .failure(let error):
+                Squawk.show(error: error)
                 completion(false)
             case .success(let data):
                 guard let strongSelf = self else { return }
diff --git a/Classes/Systems/Squawk+GitHawk.swift b/Classes/Systems/Squawk+GitHawk.swift
@@ -42,6 +42,13 @@ extension Squawk {
         triggerHaptic()
     }
 
+    static func show(error: Error?, view: UIView? = window) {
+        let text = error?.localizedDescription
+            ?? NSLocalizedString("Something went wrong.", comment: "")
+        Squawk.shared.show(in: view, config: errorConfig(text: text))
+        triggerHaptic()
+    }
+
     static func showPermissionsError(view: UIView? = window) {
         Squawk.shared.show(in: view, config: errorConfig(text: NSLocalizedString("You must request access.", comment: "")))
         triggerHaptic()
diff --git a/Classes/Views/ShowErrorStatusBar.swift b/Classes/Views/ShowErrorStatusBar.swift
@@ -12,7 +12,7 @@ import Squawk
 func ShowErrorStatusBar(graphQLErrors: [Error]?, networkError: Error?) {
     if networkError != nil {
         Squawk.showNetworkError()
-    } else if graphQLErrors != nil && graphQLErrors!.count > 0 {
-        Squawk.showGenericError()
+    } else if let graphQL = graphQLErrors?.first {
+        Squawk.show(error: graphQL)
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,11 @@ final class AddCommentClient {`
`61`	`61`	`viewerCanDelete: fragments.deletableFields.viewerCanDelete`
`62`	`62`	`)`
`63`	`63`	`}`
`64`		`- case .failure:`
	`64`	`+ case .failure(let error):`
`65`	`65`	`for listener in self.listeners {`
`66`	`66`	`listener.listener?.didFailSendingComment(client: self, subjectId: subjectId, body: body)`
`67`	`67`	`}`
`68`		`- Squawk.showGenericError()`
	`68`	`+ Squawk.show(error: error)`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -261,11 +261,10 @@ final class IssueCommentSectionController:`
`261`	`261`	`commentID: "\(number)")`
`262`	`262`	`) { [weak self] result in`
`263`	`263`	`switch result {`
`264`		`- case .failure:`
	`264`	`+ case .failure(let error):`
`265`	`265`	`self?.hasBeenDeleted = false`
`266`	`266`	`self?.update(animated: trueUnlessReduceMotionEnabled)`
`267`		`-`
`268`		`- Squawk.showGenericError()`
	`267`	`+ Squawk.show(error: error)`
`269`	`268`	`case .success: break // Don't need to handle success since updated optimistically`
`270`	`269`	`}`
`271`	`270`	`}`
`@@ -297,9 +296,9 @@ final class IssueCommentSectionController:`
`297`	`296`	`) { [weak self] result in`
`298`	`297`	`switch result {`
`299`	`298`	`case .success: break`
`300`		`- case .failure:`
	`299`	`+ case .failure(let error):`
`301`	`300`	`self?.edit(markdown: originalMarkdown)`
`302`		`- Squawk.showGenericError()`
	`301`	`+ Squawk.show(error: error)`
`303`	`302`	`}`
`304`	`303`	`}`
`305`	`304`	`}`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,9 @@ MessageTextViewListener {`
`173`	`173`	`) { [weak self] result in`
`174`	`174`	`switch result {`
`175`	`175`	`case .success: self?.didSave(markdown: markdown)`
`176`		`- case .failure: self?.error()`
	`176`	`+ case .failure(let error):`
	`177`	`+ self?.setRightBarItemIdle()`
	`178`	`+ Squawk.show(error: error)`
`177`	`179`	`}`
`178`	`180`	`}`
`179`	`181`	`}`
`@@ -183,11 +185,6 @@ MessageTextViewListener {`
`183`	`185`	`delegate?.didEditComment(viewController: self, markdown: markdown)`
`184`	`186`	`}`
`185`	`187`
`186`		`- func error() {`
`187`		`- setRightBarItemIdle()`
`188`		`- Squawk.showGenericError()`
`189`		`- }`
`190`		`-`
`191`	`188`	`// MARK: MessageTextViewListener`
`192`	`189`
`193`	`190`	`func didChange(textView: MessageTextView) {`
Original file line number	Diff line number	Diff line change
`@@ -59,9 +59,9 @@ extension GithubClient {`
`59`	`59`
`60`	`60`	`client.query(query, result: { $0.repository }) { result in`
`61`	`61`	`switch result {`
`62`		`- case .failure:`
`63`		`- completion(.error(nil))`
`64`		`- Squawk.showGenericError()`
	`62`	`+ case .failure(let error):`
	`63`	`+ completion(.error(error))`
	`64`	`+ Squawk.show(error: error)`
`65`	`65`	`case .success(let repository):`
`66`	`66`	`let issueOrPullRequest = repository.issueOrPullRequest`
`67`	`67`	`guard let issueType: IssueType = issueOrPullRequest?.asIssue ?? issueOrPullRequest?.asPullRequest else {`
`@@ -193,13 +193,9 @@ extension GithubClient {`
`193`	`193`	`switch result {`
`194`	`194`	`case .success(let data):`
`195`	`195`	`completion(createIssueReactions(reactions: data))`
`196`		`- case .failure(let err):`
	`196`	`+ case .failure(let error):`
`197`	`197`	`completion(nil)`
`198`		`- if let message = err?.localizedDescription {`
`199`		`- Squawk.showError(message: message)`
`200`		`- } else {`
`201`		`- Squawk.showGenericError()`
`202`		`- }`
	`198`	`+ Squawk.show(error: error)`
`203`	`199`	`}`
`204`	`200`	`}`
`205`	`201`
`@@ -252,9 +248,9 @@ extension GithubClient {`
`252`	`248`	`client.send(V3SetIssueStatusRequest(owner: owner, repo: repo, number: number, state: stateString)) { result in`
`253`	`249`	`switch result {`
`254`	`250`	`case .success: break`
`255`		`- case .failure:`
	`251`	`+ case .failure(let error):`
`256`	`252`	`cache.set(value: previous)`
`257`		`- Squawk.showGenericError()`
	`253`	`+ Squawk.show(error: error)`
`258`	`254`	`}`
`259`	`255`	`}`
`260`	`256`	`}`
`@@ -294,10 +290,10 @@ extension GithubClient {`
`294`	`290`	`switch result {`
`295`	`291`	`case .success:`
`296`	`292`	`completion?(.success(true))`
`297`		`- case .failure:`
	`293`	`+ case .failure(let error):`
`298`	`294`	`cache.set(value: previous)`
`299`		`- Squawk.showGenericError()`
`300`		`- completion?(.error(nil))`
	`295`	`+ Squawk.show(error: error)`
	`296`	`+ completion?(.error(error))`
`301`	`297`	`}`
`302`	`298`	`}`
`303`	`299`	`}`
`@@ -405,9 +401,9 @@ extension GithubClient {`
`405`	`401`	`) { result in`
`406`	`402`	`switch result {`
`407`	`403`	`case .success: break`
`408`		`- case .failure:`
	`404`	`+ case .failure(let error):`
`409`	`405`	`cache.set(value: previous)`
`410`		`- Squawk.showGenericError()`
	`406`	`+ Squawk.show(error: error)`
`411`	`407`	`}`
`412`	`408`	`}`
`413`	`409`	`}`
`@@ -503,9 +499,9 @@ extension GithubClient {`
`503`	`499`	`) { result in`
`504`	`500`	`switch result {`
`505`	`501`	`case .success: break`
`506`		`- case .failure:`
	`502`	`+ case .failure(let error):`
`507`	`503`	`cache.set(value: previous)`
`508`		`- Squawk.showGenericError()`
	`504`	`+ Squawk.show(error: error)`
`509`	`505`	`}`
`510`	`506`	`}`
`511`	`507`	`}`
`@@ -523,9 +519,9 @@ extension GithubClient {`
`523`	`519`	`) { result in`
`524`	`520`	`switch result {`
`525`	`521`	`case .success: break`
`526`		`- case .failure:`
	`522`	`+ case .failure(let error):`
`527`	`523`	`cache.set(value: previous)`
`528`		`- Squawk.showGenericError()`
	`524`	`+ Squawk.show(error: error)`
`529`	`525`	`}`
`530`	`526`	`}`
`531`	`527`	`}`
Original file line number	Diff line number	Diff line change
`@@ -304,8 +304,8 @@ final class IssuesViewController:`
`304`	`304`	`}`
`305`	`305`	`// avoid finishLoading() so empty view doesn't appear`
`306`	`306`	`self?.feed.adapter.performUpdates(animated: trueUnlessReduceMotionEnabled)`
`307`		`- case .error:`
`308`		`- Squawk.showGenericError()`
	`307`	`+ case .error(let error):`
	`308`	`+ Squawk.show(error: error)`
`309`	`309`	`}`
`310`	`310`	`}`
`311`	`311`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,8 @@ extension GithubClient {`
`54`	`54`	`switch result {`
`55`	`55`	`case .success:`
`56`	`56`	`cache.set(value: optimisticResult)`
`57`		`- case .failure:`
`58`		`- Squawk.showGenericError()`
	`57`	`+ case .failure(let err):`
	`58`	`+ Squawk.show(error: err)`
`59`	`59`	`error()`
`60`	`60`	`}`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,8 +68,8 @@ final class LabelsViewController: BaseListViewController2<String>, BaseListViewC`
`68`	`68`	`return RepositoryLabel(color: node.color, name: node.name)`
`69`	`69`	`}.sorted { $0.name < $1.name }`
`70`	`70`	`self?.update(animated: true)`
`71`		`- case .failure:`
`72`		`- Squawk.showGenericError()`
	`71`	`+ case .failure(let error):`
	`72`	`+ Squawk.show(error: error)`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -97,9 +97,9 @@ extension GithubClient {`
`97`	`97`	`) { result in`
`98`	`98`	`switch result {`
`99`	`99`	`case .success: break`
`100`		`- case .failure:`
	`100`	`+ case .failure(let error):`
`101`	`101`	`cache.set(value: previous)`
`102`		`- Squawk.showGenericError()`
	`102`	`+ Squawk.show(error: error)`
`103`	`103`	`}`
`104`	`104`	`}`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -64,8 +64,8 @@ MilestoneSectionControllerDelegate {`
`64`	`64`	`switch result {`
`65`	`65`	`case .success(let milestones):`
`66`	`66`	`self?.milestones = milestones`
`67`		`- case .error:`
`68`		`- Squawk.showGenericError()`
	`67`	`+ case .error(let error):`
	`68`	`+ Squawk.show(error: error)`
`69`	`69`	`}`
`70`	`70`	`self?.update(animated: true)`
`71`	`71`	`}`