Merge pull request #93 from WeTransfer/feature/improved-error-logging

Improve error logs for GitBuddy GitHub API failures
WeTransfer · Oct 24, 2022 · 9686183 · 9686183
2 parents 340d9d7 + 54cd65b
commit 9686183
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 8 deletions.
diff --git a/Package.resolved b/Package.resolved
@@ -24,8 +24,8 @@
         "repositoryURL": "https://github.com/nerdishbynature/RequestKit.git",
         "state": {
           "branch": null,
-          "revision": "e266fd8ac7d71caf4422ffc56ad98ff368329fde",
-          "version": "3.1.0"
+          "revision": "8b0258ea2a4345cbcac90509b764faacea12efb0",
+          "version": "3.2.1"
         }
       },
       {

diff --git a/Sources/GitBuddyCore/GitHub/IssuesFetcher.swift b/Sources/GitBuddyCore/GitHub/IssuesFetcher.swift
@@ -24,7 +24,7 @@ struct IssuesFetcher {
             case .success(let issues):
                 result = .success(issues)
             case .failure(let error):
-                result = .failure(error)
+                result = .failure(OctoKitError(error: error))
             }
             group.leave()
         }

diff --git a/Sources/GitBuddyCore/GitHub/PullRequestFetcher.swift b/Sources/GitBuddyCore/GitHub/PullRequestFetcher.swift
@@ -35,7 +35,7 @@ struct PullRequestFetcher {
             case .success(let pullRequests):
                 result = .success(pullRequests)
             case .failure(let error):
-                result = .failure(error)
+                result = .failure(OctoKitError(error: error))
             }
             group.leave()
         }

diff --git a/Sources/GitBuddyCore/Helpers/OctoKitError.swift b/Sources/GitBuddyCore/Helpers/OctoKitError.swift
@@ -0,0 +1,28 @@
+//
+//  Created by Antoine van der Lee on 20/10/2022.
+//  Copyright © 2022 WeTransfer. All rights reserved.
+//
+
+import Foundation
+
+/// Ensures rich details become available when GitBuddy fails due to a failing GitHub API request.
+struct OctoKitError: LocalizedError {
+
+    let statusCode: Int
+    let underlyingError: Error
+    let errorDetails: String
+
+    var errorDescription: String? {
+        """
+        GitHub API Request failed (StatusCode: \(statusCode)): \(errorDetails)
+        Underlying error:
+        \(underlyingError)
+        """
+    }
+
+    init(error: Error) {
+        underlyingError = error
+        statusCode = error._code
+        errorDetails = (error as NSError).userInfo.debugDescription
+    }
+}
diff --git a/Sources/GitBuddyCore/Release/ReleaseProducer.swift b/Sources/GitBuddyCore/Release/ReleaseProducer.swift
@@ -207,7 +207,7 @@ final class ReleaseProducer: URLSessionInjectable, ShellInjectable {
             case .success(let release):
                 result = .success(release.htmlURL)
             case .failure(let error):
-                result = .failure(error)
+                result = .failure(OctoKitError(error: error))
             }
             group.leave()
         }

diff --git a/Submodules/WeTransfer-iOS-CI b/Submodules/WeTransfer-iOS-CI
diff --git a/fastlane/Fastfile b/fastlane/Fastfile
@@ -1,8 +1,8 @@
 # Fastlane requirements
 fastlane_version "1.109.0"
 
-import "./../Submodules/WeTransfer-iOS-CI/Fastlane/Fastfile"
-import "./../Submodules/wetransfer-iOS-CI/Fastlane/shared_lanes.rb"
+import "./../Submodules/WeTransfer-iOS-CI/Fastlane/testing_lanes.rb"
+import "./../Submodules/WeTransfer-iOS-CI/Fastlane/shared_lanes.rb"
 
 desc "Run the tests and prepare for Danger"
 lane :test do |options|
+31 −1		.gitignore
+9 −0		Bitrise/tag_releasing_bitrise.yml
+67 −1		Bitrise/testing_bitrise.yml
+1 −1		BuildTools/swiftformat.sh
+5 −180		Fastlane/Fastfile
+112 −90		Fastlane/deployment_lanes.rb
+96 −22		Fastlane/shared_lanes.rb
+182 −0		Fastlane/testing_lanes.rb
+22 −0		WeTransferPRLinter/Sources/WeTransferPRLinter/WeTransferPRLinter.swift
+13 −0		WeTransferPRLinter/Tests/WeTransferPRLinterTests/WeTransferLinterTests.swift
+2 −2		bitrise.yml