Replace legacy image downloader with new actor-based implementation (#…

…4588)

* Replace legacy image downloader with new actor-based implementation

* Remove failed tasks from inflightRequests array

* add changelog entry

* small refactoring

CHANGELOG.md

@@ -21,6 +21,7 @@
 
 * Added PrivacyInfo.xcprivacy support. ([#4573](https://github.com/mapbox/mapbox-navigation-ios/pull/4573))
 * Removed `NavigationEventsManager.init(activeNavigationDataSource:passiveNavigationDataSource:accessToken:mobileEventsManager:)` in favor of `NavigationEventsManager.init(activeNavigationDataSource:passiveNavigationDataSource:accessToken:)`. ([#4572](https://github.com/mapbox/mapbox-navigation-ios/pull/4572))
+* Fixed a rare issue that could lead to memory corruption under specific conditions. This was resolved by replacing the internal image downloader with brand new actor-based implementation. ([#4588](https://github.com/mapbox/mapbox-navigation-ios/pull/4588))
 
 ## v2.17.0
 

Sources/MapboxNavigation/ImageDownloader/ImageDownloader.swift

@@ -0,0 +1,47 @@
+import Foundation
+
+enum DownloadError: Error {
+    case serverError
+    case clientError
+    case noImageData
+}
+
+@available(iOS 13.0, *)
+actor ImageDownloader: ImageDownloaderProtocol {
+    private let urlSession: URLSession
+
+    private var inflightRequests: [URL: Task<CachedURLResponse, Error>] = [:]
+
+    init(configuration: URLSessionConfiguration? = nil) {
+        let defaultConfiguration = URLSessionConfiguration.default
+        defaultConfiguration.urlCache = URLCache(memoryCapacity: 5 * 1024 * 1024, diskCapacity: 20 * 1024 * 1024)
+        self.urlSession = URLSession(configuration: configuration ?? defaultConfiguration)
+    }
+
+    nonisolated func download(with url: URL, completion: @escaping (Result<CachedURLResponse, Error>) -> Void) {
+        Task {
+            do {
+                let response = try await self.fetch(url)
+                completion(.success(response))
+            } catch {
+                completion(.failure(error))
+            }
+        }
+    }
+
+    private func fetch(_ url: URL) async throws -> CachedURLResponse {
+        if let inflightTask = inflightRequests[url] {
+            return try await inflightTask.value
+        }
+
+        let downloadTask = Task<CachedURLResponse, Error> {
+            let (data, response) = try await urlSession.data(from: url)
+            return CachedURLResponse(response: response, data: data)
+        }
+
+        inflightRequests[url] = downloadTask
+        defer { inflightRequests[url] = nil }
+
+        return try await downloadTask.value
+    }
+}

Sources/MapboxNavigation/ImageDownloader/ImageDownloaderProtocol.swift

@@ -0,0 +1,5 @@
+import Foundation
+
+protocol ImageDownloaderProtocol {
+    func download(with url: URL, completion: @escaping (Result<CachedURLResponse, Error>) -> Void)
+}

Sources/MapboxNavigation/ImageDownloader/LegacyImageDownloader.swift

@@ -0,0 +1,22 @@
+import Foundation
+
+@available(iOS, deprecated: 13.0, message: "Use ImageDownloader instead.")
+final class LegacyImageDownloader: ImageDownloaderProtocol {
+    private let urlSession: URLSession
+
+    init(configuration: URLSessionConfiguration? = nil) {
+        let defaultConfiguration = URLSessionConfiguration.default
+        defaultConfiguration.urlCache = URLCache(memoryCapacity: 5 * 1024 * 1024, diskCapacity: 20 * 1024 * 1024, diskPath: nil)
+        self.urlSession = URLSession(configuration: configuration ?? defaultConfiguration)
+    }
+
+    func download(with url: URL, completion: @escaping (Result<CachedURLResponse, Error>) -> Void) {
+        urlSession.dataTask(with: URLRequest(url)) { data, response, error in
+            if let response, let data {
+                completion(.success(CachedURLResponse(response: response, data: data)))
+            } else if let error {
+                completion(.failure(error))
+            }
+        }.resume()
+    }
+}