show special alert for FORBIDDEN graphQL errors (#2567)

Author: rnystrom

Classes/Issues/Comments/IssueCommentSectionController.swift

@@ -208,9 +208,12 @@ final class IssueCommentSectionController: ListBindingSectionController<IssueCom
         update(animated: trueUnlessReduceMotionEnabled)
         generator.impactOccurred()
         client.react(subjectID: object.id, content: content, isAdd: isAdd) { [weak self] result in
-            if result == nil {
+            switch result {
+            case .success:
                 self?.reactionMutation = previousReaction
                 self?.update(animated: trueUnlessReduceMotionEnabled)
+            case .error(let error):
+                Squawk.show(error: error)
             }
         }
     }

Classes/Issues/GithubClient+Issues.swift

@@ -185,16 +185,15 @@ extension GithubClient {
         subjectID: String,
         content: ReactionContent,
         isAdd: Bool,
-        completion: @escaping (IssueCommentReactionViewModel?) -> Void
+        completion: @escaping (Result<IssueCommentReactionViewModel>) -> Void
         ) {
 
         let handler: (GitHubAPI.Result<ReactionFields>) -> Void = { result in
             switch result {
             case .success(let data):
-                completion(createIssueReactions(reactions: data))
+                completion(.success(createIssueReactions(reactions: data)))
             case .failure(let error):
-                completion(nil)
-                Squawk.show(error: error)
+                completion(.error(error))
             }
         }
 

Classes/Systems/Squawk+GitHawk.swift

@@ -59,8 +59,16 @@ extension Squawk {
     }
 
     static func show(error: Error?, view: UIView? = window) {
-        let text = error?.localizedDescription
-            ?? NSLocalizedString("Something went wrong.", comment: "")
+        let text: String
+        if error?.isGraphQLForbidden == true {
+            text = NSLocalizedString(
+                "Some repositories or organizations you browse may require Personal Access Tokens for access. You can add a PAT in Settings>Accounts.",
+                comment: ""
+            )
+        } else {
+            text = error?.localizedDescription
+                ?? NSLocalizedString("Something went wrong.", comment: "")
+        }
         Squawk.shared.show(in: view, config: errorConfig(text: text))
         triggerHaptic()
     }

Classes/Utility/Error+GraphQLForbidden.swift

@@ -0,0 +1,19 @@
+//
+//  Error+GraphQLForbidden.swift
+//  Freetime
+//
+//  Created by Ryan Nystrom on 12/29/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+
+import Foundation
+import Apollo
+
+extension Error {
+
+    var isGraphQLForbidden: Bool {
+        guard let error = self as? Apollo.GraphQLError else { return false }
+        return (error["type"] as? String)?.uppercased() == "FORBIDDEN"
+    }
+
+}

Freetime.xcodeproj/project.pbxproj

@@ -302,6 +302,7 @@
 		298BA0971EC947F100B01946 /* SegmentedControlCell.swift in Sources */ = {isa = PBXBuildFile; fileRef = 298BA0951EC947F100B01946 /* SegmentedControlCell.swift */; };
 		298BA0981EC947F100B01946 /* SegmentedControlSectionController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 298BA0961EC947F100B01946 /* SegmentedControlSectionController.swift */; };
 		298BA09A1EC947FC00B01946 /* SegmentedControlModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 298BA0991EC947FC00B01946 /* SegmentedControlModel.swift */; };
+		298C7E2821D80BAF00DD2A60 /* Error+GraphQLForbidden.swift in Sources */ = {isa = PBXBuildFile; fileRef = 298C7E2721D80BAF00DD2A60 /* Error+GraphQLForbidden.swift */; };
 		298C7E2621D7F56600DD2A60 /* SettingsAccountCell.swift in Sources */ = {isa = PBXBuildFile; fileRef = 298C7E2521D7F56600DD2A60 /* SettingsAccountCell.swift */; };
 		2990B9DB218BF23D009865EB /* Router.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2990B9DA218BF23D009865EB /* Router.swift */; };
 		29921BCC1EF624D400C1E848 /* UIFont+MutableTraits.swift in Sources */ = {isa = PBXBuildFile; fileRef = 29921BCB1EF624D400C1E848 /* UIFont+MutableTraits.swift */; };
@@ -894,6 +895,7 @@
 		298BA0951EC947F100B01946 /* SegmentedControlCell.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SegmentedControlCell.swift; sourceTree = "<group>"; };
 		298BA0961EC947F100B01946 /* SegmentedControlSectionController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SegmentedControlSectionController.swift; sourceTree = "<group>"; };
 		298BA0991EC947FC00B01946 /* SegmentedControlModel.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SegmentedControlModel.swift; sourceTree = "<group>"; };
+		298C7E2721D80BAF00DD2A60 /* Error+GraphQLForbidden.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Error+GraphQLForbidden.swift"; sourceTree = "<group>"; };
 		298C7E2521D7F56600DD2A60 /* SettingsAccountCell.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SettingsAccountCell.swift; sourceTree = "<group>"; };
 		2990B9DA218BF23D009865EB /* Router.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Router.swift; sourceTree = "<group>"; };
 		29921BCB1EF624D400C1E848 /* UIFont+MutableTraits.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "UIFont+MutableTraits.swift"; sourceTree = "<group>"; };
@@ -2285,6 +2287,7 @@
 				291E988021975FCB00E5EED9 /* UIApplication+WriteReview.swift */,
 				C0E3CD4A21BAE49B00185B57 /* NSRegularExpression+StaticString.swift */,
 				C0E3CD4C21BAE65000185B57 /* UIImage+StaticString.swift */,
+				298C7E2721D80BAF00DD2A60 /* Error+GraphQLForbidden.swift */,
 			);
 			path = Utility;
 			sourceTree = "<group>";
@@ -2984,6 +2987,7 @@
 				296B4E311F7C805600C16887 /* GraphQLIDDecode.swift in Sources */,
 				294B11241F7B37D300E04F2D /* ImageCellHeightCache.swift in Sources */,
 				294563EC1EE5012100DBCD35 /* Issue+IssueType.swift in Sources */,
+				298C7E2821D80BAF00DD2A60 /* Error+GraphQLForbidden.swift in Sources */,
 				290CA7642169799600DE04F8 /* AppController.swift in Sources */,
 				2955D4A821B46B3D00A393D3 /* InboxFilterRepoSectionController.swift in Sources */,
 				2996543C21A76F3A006B2CA9 /* NewFeaturesSectionController.swift in Sources */,