Fix background task reconnection route string format (#427)

Julian Locke · web-flow · commit 40885da7333e · 2024-07-24T18:50:59.000-04:00
diff --git a/Source/SwiftyDropbox/Shared/Generated/AppAuthReconnectionHelpers.swift b/Source/SwiftyDropbox/Shared/Generated/AppAuthReconnectionHelpers.swift
@@ -9,7 +9,7 @@ enum AppAuthReconnectionHelpers: ReconnectionHelpersShared {
         let info = try persistedRequestInfo(from: apiRequest)
 
         switch info.routeName {
-        case "getThumbnailV2":
+        case "get_thumbnail_v2":
             return .getThumbnailV2(
                 rebuildRequest(
                     apiRequest: apiRequest,
diff --git a/Source/SwiftyDropbox/Shared/Generated/DropboxAppBaseRequestBox.swift b/Source/SwiftyDropbox/Shared/Generated/DropboxAppBaseRequestBox.swift
@@ -7,6 +7,13 @@
 import Foundation
 
 /// Allows for heterogenous collections of typed requests
-public enum DropboxAppBaseRequestBox {
+public enum DropboxAppBaseRequestBox: CustomStringConvertible {
     case getThumbnailV2(DownloadRequestFile<Files.PreviewResultSerializer, Files.ThumbnailV2ErrorSerializer>)
-}
+
+    public var description: String {
+        switch self {
+        case .getThumbnailV2:
+            return "getThumbnailV2"
+        }
+    }
+}
diff --git a/Source/SwiftyDropbox/Shared/Generated/DropboxBaseRequestBox.swift b/Source/SwiftyDropbox/Shared/Generated/DropboxBaseRequestBox.swift
@@ -7,7 +7,7 @@
 import Foundation
 
 /// Allows for heterogenous collections of typed requests
-public enum DropboxBaseRequestBox {
+public enum DropboxBaseRequestBox: CustomStringConvertible {
     case alphaUpload(UploadRequest<Files.FileMetadataSerializer, Files.UploadErrorSerializer>)
     case download(DownloadRequestFile<Files.FileMetadataSerializer, Files.DownloadErrorSerializer>)
     case downloadZip(DownloadRequestFile<Files.DownloadZipResultSerializer, Files.DownloadZipErrorSerializer>)
@@ -26,4 +26,45 @@ public enum DropboxBaseRequestBox {
     case docsDownload(DownloadRequestFile<Paper.PaperDocExportResultSerializer, Paper.DocLookupErrorSerializer>)
     case docsUpdate(UploadRequest<Paper.PaperDocCreateUpdateResultSerializer, Paper.PaperDocUpdateErrorSerializer>)
     case getSharedLinkFile(DownloadRequestFile<Sharing.SharedLinkMetadataSerializer, Sharing.GetSharedLinkFileErrorSerializer>)
-}
+
+    public var description: String {
+        switch self {
+        case .alphaUpload:
+            return "alphaUpload"
+        case .download:
+            return "download"
+        case .downloadZip:
+            return "downloadZip"
+        case .export:
+            return "export"
+        case .getPreview:
+            return "getPreview"
+        case .getThumbnail:
+            return "getThumbnail"
+        case .getThumbnailV2:
+            return "getThumbnailV2"
+        case .paperCreate:
+            return "paperCreate"
+        case .paperUpdate:
+            return "paperUpdate"
+        case .upload:
+            return "upload"
+        case .uploadSessionAppendV2:
+            return "uploadSessionAppendV2"
+        case .uploadSessionAppend:
+            return "uploadSessionAppend"
+        case .uploadSessionFinish:
+            return "uploadSessionFinish"
+        case .uploadSessionStart:
+            return "uploadSessionStart"
+        case .docsCreate:
+            return "docsCreate"
+        case .docsDownload:
+            return "docsDownload"
+        case .docsUpdate:
+            return "docsUpdate"
+        case .getSharedLinkFile:
+            return "getSharedLinkFile"
+        }
+    }
+}
diff --git a/Source/SwiftyDropbox/Shared/Generated/ReconnectionHelpers.swift b/Source/SwiftyDropbox/Shared/Generated/ReconnectionHelpers.swift
@@ -9,7 +9,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
         let info = try persistedRequestInfo(from: apiRequest)
 
         switch info.routeName {
-        case "alphaUpload":
+        case "alpha/upload":
             return .alphaUpload(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -27,7 +27,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "downloadZip":
+        case "download_zip":
             return .downloadZip(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -45,7 +45,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "getPreview":
+        case "get_preview":
             return .getPreview(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -54,7 +54,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "getThumbnail":
+        case "get_thumbnail":
             return .getThumbnail(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -63,7 +63,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "getThumbnailV2":
+        case "get_thumbnail_v2":
             return .getThumbnailV2(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -72,7 +72,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "paperCreate":
+        case "paper/create":
             return .paperCreate(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -81,7 +81,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "paperUpdate":
+        case "paper/update":
             return .paperUpdate(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -99,7 +99,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "uploadSessionAppendV2":
+        case "upload_session/append_v2":
             return .uploadSessionAppendV2(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -108,7 +108,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "uploadSessionAppend":
+        case "upload_session/append":
             return .uploadSessionAppend(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -117,7 +117,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "uploadSessionFinish":
+        case "upload_session/finish":
             return .uploadSessionFinish(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -126,7 +126,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "uploadSessionStart":
+        case "upload_session/start":
             return .uploadSessionStart(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -135,7 +135,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "docsCreate":
+        case "docs/create":
             return .docsCreate(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -144,7 +144,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "docsDownload":
+        case "docs/download":
             return .docsDownload(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -153,7 +153,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "docsUpdate":
+        case "docs/update":
             return .docsUpdate(
                 rebuildRequest(
                     apiRequest: apiRequest,
@@ -162,7 +162,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {
                     client: client
                 )
             )
-        case "getSharedLinkFile":
+        case "get_shared_link_file":
             return .getSharedLinkFile(
                 rebuildRequest(
                     apiRequest: apiRequest,
diff --git a/Source/SwiftyDropbox/Shared/Handwritten/MockDropboxTransportClient.swift b/Source/SwiftyDropbox/Shared/Handwritten/MockDropboxTransportClient.swift
@@ -142,7 +142,9 @@ class MockDropboxTransportClient: DropboxTransportClient {
 
     func reconnectRequest<ASerial, RSerial, ESerial>(_ route: Route<ASerial, RSerial, ESerial>, apiRequest: ApiRequest) -> UploadRequest<RSerial, ESerial>
         where ASerial: JSONSerializer, RSerial: JSONSerializer, ESerial: JSONSerializer {
-        fatalError("unimplemented")
+        UploadRequest(
+            request: apiRequest, responseSerializer: route.responseSerializer, errorSerializer: route.errorSerializer
+        )
     }
 
     func reconnectRequest<ASerial, RSerial, ESerial>(
@@ -151,12 +153,28 @@ class MockDropboxTransportClient: DropboxTransportClient {
         overwrite: Bool,
         destination: URL
     ) -> DownloadRequestFile<RSerial, ESerial> where ASerial: JSONSerializer, RSerial: JSONSerializer, ESerial: JSONSerializer {
-        fatalError("unimplemented")
+        DownloadRequestFile(
+            request: apiRequest,
+            responseSerializer: route.responseSerializer,
+            errorSerializer: route.errorSerializer,
+            moveToDestination: { _ in fatalError() },
+            errorDataFromLocation: { _ in fatalError() }
+        )
     }
 
     func shutdown() {}
 }
 
+extension MockDropboxTransportClient: DropboxTransportClientInternal {
+    var manager: NetworkSessionManager {
+        fatalError("unimplemented")
+    }
+
+    var longpollManager: NetworkSessionManager {
+        fatalError("unimplemented")
+    }
+}
+
 private class Requests {
     var allRequests: [(String, MockApiRequest)] = []
 
diff --git a/Source/SwiftyDropboxUnitTests/ReconnectionHelperRouteNameTests.swift b/Source/SwiftyDropboxUnitTests/ReconnectionHelperRouteNameTests.swift
@@ -0,0 +1,30 @@
+///
+/// Copyright (c) 2024 Dropbox, Inc. All rights reserved.
+///
+
+import Foundation
+
+@testable import SwiftyDropbox
+import XCTest
+
+final class TestReconnectionHelperRouteNameMatching: XCTestCase {
+    func testMatching() throws {
+        let route = Files.uploadSessionAppendV2
+        let persistedInfo = ReconnectionHelpers.PersistedRequestInfo.upload(
+            .init(
+                originalSDKVersion: DropboxClientsManager.sdkVersion,
+                routeName: route.name,
+                routeNamespace: route.namespace,
+                clientProvidedInfo: nil
+            )
+        )
+
+        let request = MockApiRequest(identifier: 0)
+        request.taskDescription = try persistedInfo.asJsonString()
+
+        let rebuiltRequest = try ReconnectionHelpers.rebuildRequest(apiRequest: request, client: MockDropboxTransportClient())
+
+        // Assert that request was successfully rebuilt
+        XCTAssertEqual(rebuiltRequest.description, "uploadSessionAppendV2")
+    }
+}
diff --git a/stone b/stone
@@ -1 +1 @@
-Subproject commit be8bf9b27929b969f069acc04d4f82b8ffc931bb
+Subproject commit a51d760cdf271025ae90074275edfa156ca5aaf0

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`9`	`9`	`let info = try persistedRequestInfo(from: apiRequest)`
`10`	`10`
`11`	`11`	`switch info.routeName {`
`12`		`- case "alphaUpload":`
	`12`	`+ case "alpha/upload":`
`13`	`13`	`return .alphaUpload(`
`14`	`14`	`rebuildRequest(`
`15`	`15`	`apiRequest: apiRequest,`
`@@ -27,7 +27,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`27`	`27`	`client: client`
`28`	`28`	`)`
`29`	`29`	`)`
`30`		`- case "downloadZip":`
	`30`	`+ case "download_zip":`
`31`	`31`	`return .downloadZip(`
`32`	`32`	`rebuildRequest(`
`33`	`33`	`apiRequest: apiRequest,`
`@@ -45,7 +45,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`45`	`45`	`client: client`
`46`	`46`	`)`
`47`	`47`	`)`
`48`		`- case "getPreview":`
	`48`	`+ case "get_preview":`
`49`	`49`	`return .getPreview(`
`50`	`50`	`rebuildRequest(`
`51`	`51`	`apiRequest: apiRequest,`
`@@ -54,7 +54,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`54`	`54`	`client: client`
`55`	`55`	`)`
`56`	`56`	`)`
`57`		`- case "getThumbnail":`
	`57`	`+ case "get_thumbnail":`
`58`	`58`	`return .getThumbnail(`
`59`	`59`	`rebuildRequest(`
`60`	`60`	`apiRequest: apiRequest,`
`@@ -63,7 +63,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`63`	`63`	`client: client`
`64`	`64`	`)`
`65`	`65`	`)`
`66`		`- case "getThumbnailV2":`
	`66`	`+ case "get_thumbnail_v2":`
`67`	`67`	`return .getThumbnailV2(`
`68`	`68`	`rebuildRequest(`
`69`	`69`	`apiRequest: apiRequest,`
`@@ -72,7 +72,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`72`	`72`	`client: client`
`73`	`73`	`)`
`74`	`74`	`)`
`75`		`- case "paperCreate":`
	`75`	`+ case "paper/create":`
`76`	`76`	`return .paperCreate(`
`77`	`77`	`rebuildRequest(`
`78`	`78`	`apiRequest: apiRequest,`
`@@ -81,7 +81,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`81`	`81`	`client: client`
`82`	`82`	`)`
`83`	`83`	`)`
`84`		`- case "paperUpdate":`
	`84`	`+ case "paper/update":`
`85`	`85`	`return .paperUpdate(`
`86`	`86`	`rebuildRequest(`
`87`	`87`	`apiRequest: apiRequest,`
`@@ -99,7 +99,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`99`	`99`	`client: client`
`100`	`100`	`)`
`101`	`101`	`)`
`102`		`- case "uploadSessionAppendV2":`
	`102`	`+ case "upload_session/append_v2":`
`103`	`103`	`return .uploadSessionAppendV2(`
`104`	`104`	`rebuildRequest(`
`105`	`105`	`apiRequest: apiRequest,`
`@@ -108,7 +108,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`108`	`108`	`client: client`
`109`	`109`	`)`
`110`	`110`	`)`
`111`		`- case "uploadSessionAppend":`
	`111`	`+ case "upload_session/append":`
`112`	`112`	`return .uploadSessionAppend(`
`113`	`113`	`rebuildRequest(`
`114`	`114`	`apiRequest: apiRequest,`
`@@ -117,7 +117,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`117`	`117`	`client: client`
`118`	`118`	`)`
`119`	`119`	`)`
`120`		`- case "uploadSessionFinish":`
	`120`	`+ case "upload_session/finish":`
`121`	`121`	`return .uploadSessionFinish(`
`122`	`122`	`rebuildRequest(`
`123`	`123`	`apiRequest: apiRequest,`
`@@ -126,7 +126,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`126`	`126`	`client: client`
`127`	`127`	`)`
`128`	`128`	`)`
`129`		`- case "uploadSessionStart":`
	`129`	`+ case "upload_session/start":`
`130`	`130`	`return .uploadSessionStart(`
`131`	`131`	`rebuildRequest(`
`132`	`132`	`apiRequest: apiRequest,`
`@@ -135,7 +135,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`135`	`135`	`client: client`
`136`	`136`	`)`
`137`	`137`	`)`
`138`		`- case "docsCreate":`
	`138`	`+ case "docs/create":`
`139`	`139`	`return .docsCreate(`
`140`	`140`	`rebuildRequest(`
`141`	`141`	`apiRequest: apiRequest,`
`@@ -144,7 +144,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`144`	`144`	`client: client`
`145`	`145`	`)`
`146`	`146`	`)`
`147`		`- case "docsDownload":`
	`147`	`+ case "docs/download":`
`148`	`148`	`return .docsDownload(`
`149`	`149`	`rebuildRequest(`
`150`	`150`	`apiRequest: apiRequest,`
`@@ -153,7 +153,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`153`	`153`	`client: client`
`154`	`154`	`)`
`155`	`155`	`)`
`156`		`- case "docsUpdate":`
	`156`	`+ case "docs/update":`
`157`	`157`	`return .docsUpdate(`
`158`	`158`	`rebuildRequest(`
`159`	`159`	`apiRequest: apiRequest,`
`@@ -162,7 +162,7 @@ enum ReconnectionHelpers: ReconnectionHelpersShared {`
`162`	`162`	`client: client`
`163`	`163`	`)`
`164`	`164`	`)`
`165`		`- case "getSharedLinkFile":`
	`165`	`+ case "get_shared_link_file":`
`166`	`166`	`return .getSharedLinkFile(`
`167`	`167`	`rebuildRequest(`
`168`	`168`	`apiRequest: apiRequest,`