Merge pull request #960 from kiwix/959-show-user-error-when-libkiwixo…

…rg-is-not-available Error handling for catalog not available 503
kiwix · Sep 2, 2024 · 58bfb76 · 58bfb76
2 parents 2fdfacb + d27282f
commit 58bfb76
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 22 deletions.
diff --git a/Tests/LibraryRefreshViewModelTest.swift b/Tests/LibraryRefreshViewModelTest.swift
@@ -45,7 +45,7 @@ final class LibraryRefreshViewModelTest: XCTestCase {
 
         HTTPTestingURLProtocol.handler = { urlProtocol in
             let response = HTTPURLResponse(
-                url: URL(string: "https://library.kiwix.org/catalog/v2/entries?count=-1")!,
+                url: URL.mock(),
                 statusCode: 200, httpVersion: nil, headerFields: [:]
             )!
             let data = self.makeOPDSData(zimFileID: UUID()).data(using: .utf8)!
@@ -112,7 +112,7 @@ final class LibraryRefreshViewModelTest: XCTestCase {
     func testFetchBadStatusCode() async {
         HTTPTestingURLProtocol.handler = { urlProtocol in
             let response = HTTPURLResponse(
-                url: URL(string: "https://library.kiwix.org/catalog/v2/entries?count=-1")!,
+                url: URL.mock(),
                 statusCode: 404, httpVersion: nil, headerFields: [:]
             )!
             urlProtocol.client?.urlProtocol(urlProtocol, didReceive: response, cacheStoragePolicy: .notAllowed)
@@ -134,7 +134,7 @@ final class LibraryRefreshViewModelTest: XCTestCase {
     func testInvalidOPDSData() async {
         HTTPTestingURLProtocol.handler = { urlProtocol in
             let response = HTTPURLResponse(
-                url: URL(string: "https://library.kiwix.org/catalog/v2/entries?count=-1")!,
+                url: URL.mock(),
                 statusCode: 200, httpVersion: nil, headerFields: [:]
             )!
             urlProtocol.client?.urlProtocol(urlProtocol, didLoad: "Invalid OPDS Data".data(using: .utf8)!)
@@ -158,7 +158,7 @@ final class LibraryRefreshViewModelTest: XCTestCase {
         let zimFileID = UUID()
         HTTPTestingURLProtocol.handler = { urlProtocol in
             let response = HTTPURLResponse(
-                url: URL(string: "https://library.kiwix.org/catalog/v2/entries?count=-1")!,
+                url: URL.mock(),
                 statusCode: 200, httpVersion: nil, headerFields: [:]
             )!
             let data = self.makeOPDSData(zimFileID: zimFileID).data(using: .utf8)!
@@ -243,3 +243,9 @@ final class LibraryRefreshViewModelTest: XCTestCase {
         XCTAssertEqual(zimFiles.filter({ $0.fileID == zimFile2.fileID }).count, 1)
     }
 }
+
+private extension URL {
+    static func mock() -> URL {
+        URL(string: "https://test.com")!
+    }
+}
diff --git a/ViewModel/LibraryViewModel.swift b/ViewModel/LibraryViewModel.swift
@@ -22,6 +22,7 @@ enum LibraryState {
     case initial
     case inProgress
     case complete
+    case error
 
     static func defaultState() -> LibraryState {
         if Defaults[.libraryLastRefresh] == nil {
@@ -55,6 +56,8 @@ final class LibraryViewModel: ObservableObject {
     private let urlSession: URLSession
     private var insertionCount = 0
     private var deletionCount = 0
+
+    private static let catalogURL = URL(string: "https://library.kiwix.org/catalog/v2/entries?count=-1")!
 
     @MainActor
     init(urlSession: URLSession? = nil, processFactory: @MainActor () -> LibraryProcess = { .shared }) {
@@ -85,7 +88,6 @@ final class LibraryViewModel: ObservableObject {
 
             // refresh library
             guard let data = try await fetchData() else {
-                process.state = oldState
                 return
             }
             let parser = try await parse(data: data)
@@ -114,7 +116,7 @@ final class LibraryViewModel: ObservableObject {
                    log: Log.OPDS, type: .default, insertionCount, deletionCount, parser.zimFileIDs.count)
         } catch {
             self.error = error
-            process.state = oldState
+            process.state = .error
         }
     }
 
@@ -169,9 +171,8 @@ final class LibraryViewModel: ObservableObject {
     }
 
     private func fetchData() async throws -> Data? {
-        guard let url = URL(string: "https://library.kiwix.org/catalog/v2/entries?count=-1") else { return nil }
         do {
-            let request = URLRequest(url: url, timeoutInterval: 20)
+            let request = URLRequest(url: Self.catalogURL, timeoutInterval: 20)
             let (data, response) = try await self.urlSession.data(for: request)
             guard let response = response as? HTTPURLResponse else { return nil }
             guard response.statusCode == 200 else {

diff --git a/Views/BuildingBlocks/Message.swift b/Views/BuildingBlocks/Message.swift
@@ -16,14 +16,20 @@
 import SwiftUI
 
 struct Message: View {
-    let text: String
+    private let text: String
+    private let foregroundColor: Color
+
+    init(text: String, color: Color = .secondary) {
+        self.text = text
+        foregroundColor = color
+    }
 
     var body: some View {
         VStack {
             Spacer()
             HStack {
                 Spacer()
-                Text(text).font(.title2).foregroundColor(.secondary)
+                Text(text).font(.title2).foregroundColor(foregroundColor)
                 Spacer()
             }
             Spacer()

diff --git a/Views/Library/ZimFilesCategories.swift b/Views/Library/ZimFilesCategories.swift
@@ -119,9 +119,12 @@ private struct CategoryGrid: View {
     var body: some View {
         Group {
             if sections.isEmpty {
-                if viewModel.state == .inProgress {
+                switch viewModel.state {
+                case .inProgress:
                     Message(text: "zim_file_catalog.fetching.message".localized)
-                } else {
+                case .error:
+                    Message(text: "library_refresh_error.retrieve.description".localized, color: .red)
+                case .initial, .complete:
                     Message(text: "zim_file_category.section.empty.message".localized)
                 }
             } else {
@@ -224,9 +227,12 @@ private struct CategoryList: View {
     var body: some View {
         Group {
             if zimFiles.isEmpty {
-                if viewModel.state == .inProgress {
+                switch viewModel.state {
+                case .inProgress:
                     Message(text: "zim_file_catalog.fetching.message".localized)
-                } else {
+                case .error:
+                    Message(text: "library_refresh_error.retrieve.description".localized, color: .red)
+                case .initial, .complete:
                     Message(text: "zim_file_category.section.empty.message".localized)
                 }
             } else {

diff --git a/Views/Library/ZimFilesNew.swift b/Views/Library/ZimFilesNew.swift
@@ -60,9 +60,12 @@ struct ZimFilesNew: View {
         }
         .overlay {
             if zimFiles.isEmpty {
-                if viewModel.state == .inProgress {
+                switch viewModel.state {
+                case .inProgress:
                     Message(text: "zim_file_catalog.fetching.message".localized)
-                } else {
+                case .error:
+                    Message(text: "library_refresh_error.retrieve.description".localized, color: .red)
+                case .initial, .complete:
                     Message(text: "zim_file_new_overlay.empty".localized)
                 }
             }

diff --git a/Views/Settings/Settings.swift b/Views/Settings/Settings.swift
@@ -77,8 +77,13 @@ struct LibrarySettings: View {
                         ProgressView().progressViewStyle(.circular).scaleEffect(0.5).frame(height: 1)
                     }
                     Spacer()
-                    Text("library_settings.last_refresh.text".localized + ":").foregroundColor(.secondary)
-                    LibraryLastRefreshTime().foregroundColor(.secondary)
+                    if library.state == .error {
+                        Text("library_refresh_error.retrieve.description".localized).foregroundColor(.red)
+                    } else {
+                        Text("library_settings.last_refresh.text".localized + ":").foregroundColor(.secondary)
+                        LibraryLastRefreshTime().foregroundColor(.secondary)
+                    }
+
                 }
                 VStack(alignment: .leading) {
                     Toggle("library_settings.auto_refresh.toggle".localized, isOn: $libraryAutoRefresh)
@@ -200,9 +205,13 @@ struct Settings: View {
     var catalogSettings: some View {
         Section {
             HStack {
-                Text("catalog_settings.last_refresh.text".localized)
-                Spacer()
-                LibraryLastRefreshTime().foregroundColor(.secondary)
+                if library.state == .error {
+                    Text("library_refresh_error.retrieve.description".localized).foregroundColor(.red)
+                } else {
+                    Text("catalog_settings.last_refresh.text".localized)
+                    Spacer()
+                    LibraryLastRefreshTime().foregroundColor(.secondary)
+                }
             }
             if library.state == .inProgress {
                 HStack {

diff --git a/Views/Welcome.swift b/Views/Welcome.swift
@@ -41,6 +41,9 @@ struct Welcome: View {
                     logo
                     Divider()
                     actions
+                    Text("library_refresh_error.retrieve.description".localized)
+                        .foregroundColor(.red)
+                        .opacity(library.state == .error ? 1 : 0)
                     Spacer()
                 }
                 #if os(macOS)
@@ -53,7 +56,7 @@ struct Welcome: View {
             .padding()
             .ignoresSafeArea()
             .onChange(of: library.state) { state in
-                guard state != .inProgress else { return }
+                guard state == .complete else { return }
                 #if os(macOS)
                 navigation.currentItem = .categories
                 #elseif os(iOS)