From e84fc1aa04d5c8db5a1b11fcf99509e49ec3733d Mon Sep 17 00:00:00 2001
From: Niels Andriesse <andriesseniels@gmail.com>
Date: Thu, 15 Jul 2021 09:47:03 +1000
Subject: [PATCH] Include destination info in error messages

---
 .../ConversationVC+Interaction.swift          | 14 ++++++++++++-
 .../Jobs/AttachmentDownloadJob.swift          |  2 +-
 SessionMessagingKit/Jobs/MessageSendJob.swift |  2 +-
 .../Open Groups/OpenGroupAPIV2.swift          |  2 +-
 SessionSnodeKit/OnionRequestAPI.swift         | 21 ++++++++++++-------
 5 files changed, 30 insertions(+), 11 deletions(-)

diff --git a/Session/Conversations/ConversationVC+Interaction.swift b/Session/Conversations/ConversationVC+Interaction.swift
index 2e8279e16..795cc80ae 100644
--- a/Session/Conversations/ConversationVC+Interaction.swift
+++ b/Session/Conversations/ConversationVC+Interaction.swift
@@ -458,7 +458,8 @@ extension ConversationVC : InputViewDelegate, MessageCellDelegate, ContextMenuAc
 
     func showFailedMessageSheet(for tsMessage: TSOutgoingMessage) {
         let thread = self.thread
-        let sheet = UIAlertController(title: tsMessage.mostRecentFailureText, message: nil, preferredStyle: .actionSheet)
+        let error = tsMessage.mostRecentFailureText
+        let sheet = UIAlertController(title: error, message: nil, preferredStyle: .actionSheet)
         sheet.addAction(UIAlertAction(title: "Cancel", style: .cancel, handler: nil))
         sheet.addAction(UIAlertAction(title: "Delete", style: .destructive, handler: { _ in
             Storage.write { transaction in
@@ -480,6 +481,17 @@ extension ConversationVC : InputViewDelegate, MessageCellDelegate, ContextMenuAc
                 MessageSender.send(message, in: thread, using: transaction)
             }
         }))
+        // HACK: Extracting this info from the error string is pretty dodgy
+        let prefix = "HTTP request failed at destination (Service node "
+        if error.hasPrefix(prefix) {
+            let rest = error.substring(from: prefix.count)
+            if let index = rest.firstIndex(of: ")") {
+                let snodeAddress = String(rest[rest.startIndex..<index])
+                sheet.addAction(UIAlertAction(title: "Copy Service Node Info", style: .default, handler: { _ in
+                    UIPasteboard.general.string = snodeAddress
+                }))
+            }
+        }
         present(sheet, animated: true, completion: nil)
     }
 
diff --git a/SessionMessagingKit/Jobs/AttachmentDownloadJob.swift b/SessionMessagingKit/Jobs/AttachmentDownloadJob.swift
index 872ec24d8..980582e83 100644
--- a/SessionMessagingKit/Jobs/AttachmentDownloadJob.swift
+++ b/SessionMessagingKit/Jobs/AttachmentDownloadJob.swift
@@ -84,7 +84,7 @@ public final class AttachmentDownloadJob : NSObject, Job, NSCoding { // NSObject
                     storage.setAttachmentState(to: .failed, for: pointer, associatedWith: self.tsMessageID, using: transaction)
                 }, completion: { })
                 self.handlePermanentFailure(error: error)
-            } else if let error = error as? OnionRequestAPI.Error, case .httpRequestFailedAtDestination(let statusCode, _) = error,
+            } else if let error = error as? OnionRequestAPI.Error, case .httpRequestFailedAtDestination(let statusCode, _, _) = error,
                 statusCode == 400 {
                 // This usually indicates a file that has expired on the server, so there's no need to retry.
                 self.handlePermanentFailure(error: error)
diff --git a/SessionMessagingKit/Jobs/MessageSendJob.swift b/SessionMessagingKit/Jobs/MessageSendJob.swift
index 6c23359ae..e1cbad17d 100644
--- a/SessionMessagingKit/Jobs/MessageSendJob.swift
+++ b/SessionMessagingKit/Jobs/MessageSendJob.swift
@@ -97,7 +97,7 @@ public final class MessageSendJob : NSObject, Job, NSCoding { // NSObject/NSCodi
                 SNLog("Couldn't send message due to error: \(error).")
                 if let error = error as? MessageSender.Error, !error.isRetryable {
                     self.handlePermanentFailure(error: error)
-                } else if let error = error as? OnionRequestAPI.Error, case .httpRequestFailedAtDestination(let statusCode, _) = error,
+                } else if let error = error as? OnionRequestAPI.Error, case .httpRequestFailedAtDestination(let statusCode, _, _) = error,
                     statusCode == 429 { // Rate limited
                     self.handlePermanentFailure(error: error)
                } else {
diff --git a/SessionMessagingKit/Open Groups/OpenGroupAPIV2.swift b/SessionMessagingKit/Open Groups/OpenGroupAPIV2.swift
index 069800c30..f47a30463 100644
--- a/SessionMessagingKit/Open Groups/OpenGroupAPIV2.swift	
+++ b/SessionMessagingKit/Open Groups/OpenGroupAPIV2.swift	
@@ -130,7 +130,7 @@ public final class OpenGroupAPIV2 : NSObject {
                         // A 401 means that we didn't provide a (valid) auth token for a route that required one. We use this as an
                         // indication that the token we're using has expired. Note that a 403 has a different meaning; it means that
                         // we provided a valid token but it doesn't have a high enough permission level for the route in question.
-                        if case OnionRequestAPI.Error.httpRequestFailedAtDestination(let statusCode, _) = error, statusCode == 401 {
+                        if case OnionRequestAPI.Error.httpRequestFailedAtDestination(let statusCode, _, _) = error, statusCode == 401 {
                             let storage = SNMessagingKitConfiguration.shared.storage
                             storage.writeSync { transaction in
                                 storage.removeAuthToken(for: room, on: request.server, using: transaction)
diff --git a/SessionSnodeKit/OnionRequestAPI.swift b/SessionSnodeKit/OnionRequestAPI.swift
index d31f718cf..dc04ae57e 100644
--- a/SessionSnodeKit/OnionRequestAPI.swift
+++ b/SessionSnodeKit/OnionRequestAPI.swift
@@ -28,14 +28,21 @@ public enum OnionRequestAPI {
     private static var targetGuardSnodeCount: UInt { return targetPathCount } // One per path
 
     // MARK: Destination
-    public enum Destination {
+    public enum Destination : CustomStringConvertible {
         case snode(Snode)
         case server(host: String, target: String, x25519PublicKey: String, scheme: String?, port: UInt16?)
+        
+        public var description: String {
+            switch self {
+            case .snode(let snode): return "Service node \(snode.ip):\(snode.port)"
+            case .server(let host, _, _, _, _): return host
+            }
+        }
     }
 
     // MARK: Error
     public enum Error : LocalizedError {
-        case httpRequestFailedAtDestination(statusCode: UInt, json: JSON)
+        case httpRequestFailedAtDestination(statusCode: UInt, json: JSON, destination: Destination)
         case insufficientSnodes
         case invalidURL
         case missingSnodeVersion
@@ -44,11 +51,11 @@ public enum OnionRequestAPI {
 
         public var errorDescription: String? {
             switch self {
-            case .httpRequestFailedAtDestination(let statusCode, _):
+            case .httpRequestFailedAtDestination(let statusCode, _, let destination):
                 if statusCode == 429 {
                     return "Rate limited."
                 } else {
-                    return "HTTP request failed at destination with status code: \(statusCode)."
+                    return "HTTP request failed at destination (\(destination)) with status code: \(statusCode)."
                 }
             case .insufficientSnodes: return "Couldn't find enough Service Nodes to build a path."
             case .invalidURL: return "Invalid URL"
@@ -297,7 +304,7 @@ public enum OnionRequestAPI {
     public static func sendOnionRequest(to snode: Snode, invoking method: Snode.Method, with parameters: JSON, associatedWith publicKey: String? = nil) -> Promise<JSON> {
         let payload: JSON = [ "method" : method.rawValue, "params" : parameters ]
         return sendOnionRequest(with: payload, to: Destination.snode(snode)).recover2 { error -> Promise<JSON> in
-            guard case OnionRequestAPI.Error.httpRequestFailedAtDestination(let statusCode, let json) = error else { throw error }
+            guard case OnionRequestAPI.Error.httpRequestFailedAtDestination(let statusCode, let json, _) = error else { throw error }
             throw SnodeAPI.handleError(withStatusCode: statusCode, json: json, forSnode: snode, associatedWith: publicKey) ?? error
         }
     }
@@ -397,10 +404,10 @@ public enum OnionRequestAPI {
                                 let b = try JSONSerialization.jsonObject(with: bodyAsData, options: [ .fragmentsAllowed ]) as? JSON else { return seal.reject(HTTP.Error.invalidJSON) }
                                 body = b
                             }
-                            guard 200...299 ~= statusCode else { return seal.reject(Error.httpRequestFailedAtDestination(statusCode: UInt(statusCode), json: body)) }
+                            guard 200...299 ~= statusCode else { return seal.reject(Error.httpRequestFailedAtDestination(statusCode: UInt(statusCode), json: body, destination: destination)) }
                             seal.fulfill(body)
                         } else {
-                            guard 200...299 ~= statusCode else { return seal.reject(Error.httpRequestFailedAtDestination(statusCode: UInt(statusCode), json: json)) }
+                            guard 200...299 ~= statusCode else { return seal.reject(Error.httpRequestFailedAtDestination(statusCode: UInt(statusCode), json: json, destination: destination)) }
                             seal.fulfill(json)
                         }
                     } catch {