display an error when an electronic publication download fails

Author: danielbarela

CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to this project will be documented in this file.
     * Port Dry Dock field uses the proper enumeration for display
     * Delete Electronic Publications which are not returned from the API 
     * Electronic Publications now sync once a day instead of once a week
+    * Display an error upon failed download of an Electronic Publication
 
 ## 1.0.1
   ### Bug Fixes

Marlin/Marlin/DataSources/ElectronicPublication/DownloadManager.swift

@@ -13,12 +13,14 @@ final class DownloadManager: NSObject {
     var urlToDownloadableMap: [URL: Downloadable] = [:]
 
     static let shared: DownloadManager = DownloadManager()
+    // since it is impossible to stub http requests on a background session, this is purely to be able
+    // to override for testing
+    var sessionConfig: URLSessionConfiguration = URLSessionConfiguration.background(withIdentifier: ElectronicPublication.backgroundDownloadIdentifier)
 
     private lazy var urlSession: URLSession = {
-        let config = URLSessionConfiguration.background(withIdentifier: ElectronicPublication.backgroundDownloadIdentifier)
-        config.isDiscretionary = false
-        config.sessionSendsLaunchEvents = true
-        return URLSession(configuration: config, delegate: self, delegateQueue: nil)
+        sessionConfig.isDiscretionary = false
+        sessionConfig.sessionSendsLaunchEvents = true
+        return URLSession(configuration: sessionConfig, delegate: self, delegateQueue: nil)
     }()
 
     private override init() {
@@ -121,6 +123,12 @@ extension DownloadManager: URLSessionDownloadDelegate {
         guard let httpResponse = downloadTask.response as? HTTPURLResponse,
               (200...299).contains(httpResponse.statusCode) else {
             print ("server error code \(downloadTask.response.debugDescription)")
+            if let httpResponse = downloadTask.response as? HTTPURLResponse {
+                DispatchQueue.main.async {
+                    downloadable.objectWillChange.send()
+                    downloadable.error = "Error downloading (\(httpResponse.statusCode))"
+                }
+            }
             return
         }
 

Marlin/Marlin/DataSources/ElectronicPublication/ElectronicPublication+CoreDataClass.swift

@@ -108,11 +108,14 @@ protocol Downloadable: NSManagedObject {
     var remoteLocation: URL? { get }
     var savePath: String { get }
     var title: String? { get }
+    var error: String? { get set }
     func checkFileExists() -> Bool
     func deleteFile()
 }
 
 class ElectronicPublication: NSManagedObject, Downloadable {
+    
+    var error: String?
 
     var title: String? {
         return sectionDisplayName ?? "Electronic Publication"
@@ -175,6 +178,7 @@ class ElectronicPublication: NSManagedObject, Downloadable {
     }
 
     func downloadFile() {
+        error = nil
         if isDownloaded && checkFileExists() {
             return
         }

Marlin/Marlin/DataSources/ElectronicPublication/Views/ElectronicPublicationActionBar.swift

@@ -19,8 +19,14 @@ struct ElectronicPublicationActionBar: View {
         HStack(spacing:8) {
             Spacer()
             if electronicPublication.isDownloading {
-                ProgressView(value: electronicPublication.downloadProgress)
-                    .tint(Color.primaryColorVariant)
+                if let error = electronicPublication.error {
+                    Text(error)
+                        .secondary()
+                    Spacer()
+                } else {
+                    ProgressView(value: electronicPublication.downloadProgress)
+                        .tint(Color.primaryColorVariant)
+                }
             }
             if electronicPublication.isDownloaded, electronicPublication.checkFileExists(), let url = URL(string: electronicPublication.savePath) {
                 Button("Delete") {

Marlin/Marlin/DataSources/NTM/NoticeToMariners+CoreDataClass.swift

@@ -10,6 +10,7 @@ import CoreData
 import UIKit
 
 class NoticeToMariners: NSManagedObject, Downloadable {
+    var error: String?
 
     var remoteLocation: URL? {
         guard let odsKey else {

Marlin/MarlinTests/DataSources/ElectronicPublication/ElectronicPublicationSummaryViewTests.swift

@@ -20,6 +20,7 @@ final class ElectronicPublicationSummaryViewTests: XCTestCase {
         .receive(on: RunLoop.main)
 
     override func setUp(completion: @escaping (Error?) -> Void) {
+        HTTPStubs.setEnabled(true)
         for item in DataSourceList().allTabs {
             UserDefaults.standard.initialDataLoaded = false
             UserDefaults.standard.clearLastSyncTimeSeconds(item.dataSource as! any BatchImportable.Type)
@@ -34,9 +35,11 @@ final class ElectronicPublicationSummaryViewTests: XCTestCase {
             }
             .store(in: &cancellable)
         persistentStore.reset()
+        HTTPStubs.removeAllStubs()
     }
 
     override func tearDown() {
+        HTTPStubs.removeAllStubs()
     }
 
     func testNotDownloaded() {
@@ -141,6 +144,56 @@ final class ElectronicPublicationSummaryViewTests: XCTestCase {
         XCTAssertFalse(epub.checkFileExists())
     }
 
+    func testDownloadError() {
+        let epub = ElectronicPublication(context: persistentStore.viewContext)
+        
+        epub.pubTypeId = 9
+        epub.pubDownloadId = 3
+        epub.fullPubFlag = false
+        epub.pubDownloadOrder = 1
+        epub.pubDownloadDisplayName = "Pub. 110 - Greenland, East Coasts of North and South America, and West Indies"
+        epub.pubsecId = 129
+        epub.odsEntryId = 22266
+        epub.sectionOrder = 1
+        epub.sectionName = "UpdatedPub110bk"
+        epub.sectionDisplayName = "Pub 110 - Updated to NTM 44/22"
+        epub.sectionLastModified = Date(timeIntervalSince1970: 0)
+        epub.contentId = 16694312
+        epub.internalPath = "NIMA_LOL/Pub110"
+        epub.filenameBase = "UpdatedPub110bk"
+        epub.fileExtension = "pdf"
+        epub.s3Key = "16694312/SFH00000/NIMA_LOL/Pub110/UpdatedPub110bk.pdf"
+        epub.fileSize = 2389496
+        epub.uploadTime = Date(timeIntervalSince1970: 0)
+        epub.fullFilename = "UpdatedPub110bk.pdf"
+        epub.pubsecLastModified = Date(timeIntervalSince1970: 0)
+        epub.isDownloaded = false
+        
+        let summary = epub.summaryView(showMoreDetails: false)
+        
+        let controller = UIHostingController(rootView: summary)
+        let window = TestHelpers.getKeyWindowVisible()
+        window.rootViewController = controller
+        tester().waitForView(withAccessibilityLabel: epub.sectionDisplayName)
+        tester().waitForView(withAccessibilityLabel: "File Size: 2.4 MB")
+        tester().waitForView(withAccessibilityLabel: "Upload Time: \(epub.uploadTime?.formatted() ?? "")")
+        
+        print("all stubs: \(HTTPStubs.allStubs())")
+        let config = URLSessionConfiguration.default
+        DownloadManager.shared.sessionConfig = config
+        
+        stub(condition: isScheme("https") && pathEndsWith("api/publications/download")) { request in
+            let response = HTTPStubsResponse()
+            response.statusCode = 403
+            return response
+        }
+        
+        tester().wait(forTimeInterval: 1)
+        tester().waitForView(withAccessibilityLabel: "Download")
+        tester().tapView(withAccessibilityLabel: "Download")
+        tester().waitForView(withAccessibilityLabel: "Error downloading (403)")
+    }
+    
     func testReDownload() {
         let epub = ElectronicPublication(context: persistentStore.viewContext)