Fixed additional headers not making it into http requests (#736)

zotero · Aug 3, 2023 · 5101122 · 5101122
1 parent a5f7364
commit 5101122
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 11 deletions.
diff --git a/Zotero/Controllers/API/ZoteroApiClient.swift b/Zotero/Controllers/API/ZoteroApiClient.swift
@@ -80,7 +80,7 @@ final class ZoteroApiClient: ApiClient {
 
     /// Creates and starts a data request, takes care of retrying request in case of failure.
     func send(request: ApiRequest, queue: DispatchQueue) -> Single<(Data?, HTTPURLResponse)> {
-        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint))
+        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint), additionalHeaders: self.manager.sessionConfiguration.httpAdditionalHeaders)
         return self.createRequestSingle(for: request.endpoint) { $0.request(convertible).validate(acceptableStatusCodes: request.acceptableStatusCodes) }
                    .flatMap({ (dataRequest: DataRequest) -> Single<(Data?, HTTPURLResponse)> in
                        return dataRequest.rx.loggedResponseDataWithResponseError(queue: queue, encoding: request.encoding, logParams: request.logParams)
@@ -121,7 +121,7 @@ final class ZoteroApiClient: ApiClient {
 
     /// Creates download request. Request needs to be started manually.
     func download(request: ApiDownloadRequest, queue: DispatchQueue) -> Observable<DownloadRequest> {
-        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint))
+        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint), additionalHeaders: self.manager.sessionConfiguration.httpAdditionalHeaders)
         return self.createRequestSingle(for: request.endpoint) { manager -> DownloadRequest in
             return manager.download(convertible) { _, _ in (request.downloadUrl, [.createIntermediateDirectories, .removePreviousFile]) }
                 .validate(statusCode: request.acceptableStatusCodes)
@@ -133,21 +133,21 @@ final class ZoteroApiClient: ApiClient {
     }
 
     func upload(request: ApiRequest, data: Data, queue: DispatchQueue) -> Single<(Data?, HTTPURLResponse)> {
-        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint))
+        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint), additionalHeaders: self.manager.sessionConfiguration.httpAdditionalHeaders)
         let method = HTTPMethod(rawValue: request.httpMethod.rawValue)
         let headers = HTTPHeaders(convertible.allHeaders)
         return self.createUploadRequest(request: request, queue: queue) { $0.upload(data, to: convertible, method: method, headers: headers) }
     }
 
     func upload(request: ApiRequest, queue: DispatchQueue, multipartFormData: @escaping (MultipartFormData) -> Void) -> Single<(Data?, HTTPURLResponse)> {
-        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint))
+        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint), additionalHeaders: self.manager.sessionConfiguration.httpAdditionalHeaders)
         let method = HTTPMethod(rawValue: request.httpMethod.rawValue)
         let headers = HTTPHeaders(convertible.allHeaders)
         return self.createUploadRequest(request: request, queue: queue) { $0.upload(multipartFormData: multipartFormData, to: convertible, method: method, headers: headers) }
     }
 
     func upload(request: ApiRequest, fromFile file: File, queue: DispatchQueue) -> Single<(Data?, HTTPURLResponse)> {
-        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint))
+        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint), additionalHeaders: self.manager.sessionConfiguration.httpAdditionalHeaders)
         let method = HTTPMethod(rawValue: request.httpMethod.rawValue)
         let headers = HTTPHeaders(convertible.allHeaders)
         return self.createUploadRequest(request: request, queue: queue) { $0.upload(file.createUrl(), to: convertible, method: method, headers: headers) }
@@ -204,7 +204,7 @@ final class ZoteroApiClient: ApiClient {
 
 extension ZoteroApiClient: ApiRequestCreator {
     func dataRequest(for request: ApiRequest) -> DataRequest {
-        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint))
+        let convertible = Convertible(request: request, baseUrl: self.url, token: self.token(for: request.endpoint), additionalHeaders: self.manager.sessionConfiguration.httpAdditionalHeaders)
         return self.createRequest(for: request.endpoint) { $0.request(convertible).validate(acceptableStatusCodes: request.acceptableStatusCodes) }
     }
 }

diff --git a/Zotero/Controllers/Sync/SyncController.swift b/Zotero/Controllers/Sync/SyncController.swift
@@ -1524,11 +1524,11 @@ final class SyncController: SynchronizationController {
         action.result
               .subscribe(on: self.workScheduler)
               .subscribe(with: self, onSuccess: { `self`, _ in
-                  self?.accessQueue.async(flags: .barrier) { [weak self] in
+                  self.accessQueue.async(flags: .barrier) { [weak self] in
                       self?.processNextAction()
                   }
               }, onFailure: { `self`, _ in
-                  self?.accessQueue.async(flags: .barrier) { [weak self] in
+                  self.accessQueue.async(flags: .barrier) { [weak self] in
                       self?.abort(error: .uploadObjectConflict(data: SyncError.ErrorData(itemKeys: [key], libraryId: libraryId)))
                   }
               })

diff --git a/Zotero/Models/Convertible.swift b/Zotero/Models/Convertible.swift
@@ -19,7 +19,7 @@ struct Convertible {
     private let headers: [String: String]
     private let timeout: Double
 
-    init(request: ApiRequest, baseUrl: URL, token: String?) {
+    init(request: ApiRequest, baseUrl: URL, token: String?, additionalHeaders: [AnyHashable: Any]?) {
         switch request.endpoint {
         case .zotero(let path):
             self.url = baseUrl.appendingPathComponent(path)
@@ -31,10 +31,25 @@ struct Convertible {
         self.httpMethod = request.httpMethod
         self.encoding = request.encoding.alamoEncoding
         self.parameters = request.parameters
-        self.headers = request.headers ?? [:]
+        self.headers = Convertible.merge(headers: request.headers ?? [:], with: additionalHeaders)
         self.timeout = request.timeout
     }
 
+    private static func merge(headers: [String: String], with additional: [AnyHashable: Any]?) -> [String: String] {
+        guard let additional, !additional.isEmpty else { return headers }
+
+        let mappedToString = Dictionary(
+            additional.map({ key, value -> (String, String) in
+                let stringKey = (key as? String) ?? "\(key)"
+                let stringValue = (value as? String) ?? "\(value)"
+                return (stringKey, stringValue)
+            }),
+            uniquingKeysWith: { left, _ in left }
+        )
+
+        return headers.merging(mappedToString, uniquingKeysWith: { left, _ in left })
+    }
+
     var allHeaders: [String: String] {
         var headers = self.headers
         if let token = self.token {

diff --git a/ZoteroTests/Extensions/OHHTTPStubs+Helpers.swift b/ZoteroTests/Extensions/OHHTTPStubs+Helpers.swift
@@ -41,7 +41,7 @@ func createStub(for request: ApiRequest, ignoreBody: Bool = false, baseUrl: URL,
 
 extension ApiRequest {
     func stubCondition(with baseUrl: URL, ignoreBody: Bool = false) -> HTTPStubsTestBlock {
-        guard let urlRequest = (try? Convertible(request: self, baseUrl: baseUrl, token: nil).asURLRequest()),
+        guard let urlRequest = (try? Convertible(request: self, baseUrl: baseUrl, token: nil, additionalHeaders: nil).asURLRequest()),
               let url = urlRequest.url,
               let host = url.host else {
             return { _ in false }