Data Migration concurrency overhaul

OBAKit/Onboarding/DataMigration/DataMigrationError+Localization.swift

@@ -0,0 +1,32 @@
+//
+//  DataMigrationError+Localization.swift
+//  OBAKit
+//
+//  Created by Alan Chu on 1/6/23.
+//
+
+import OBAKitCore
+
+extension DataMigrationError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .invalidAPIService(let explanation):
+            return explanation      // Not localized.
+        case .noAPIServiceAvailable:
+            return OBALoc("data_migration_bulletin.errors.no_api_service_available", value: "Check your internet connection and try again.", comment: "An error message that appears when the user needs to have data migrated, but is not connected to the Internet.")
+        case .noDataToMigrate:
+            return OBALoc("data_migration_bulletin.errors.no_data_to_migrate", value: "No data to upgrade", comment: "An error message that appears when the data migrator runs but no data can be migrated.")
+        case .noMigrationPending:
+            return OBALoc("data_migration_bulletin.errors.no_migration_pending", value: "No data migration is pending", comment: "An error message that appears when the data migrator runs without a pending migration.")
+        }
+    }
+}
+
+extension DataMigrationBookmarkError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .noActiveTrips:
+            return "Bookmark has no active trips"   // Not localized.
+        }
+    }
+}

OBAKit/Onboarding/DataMigration/DataMigrationReportView.swift

@@ -0,0 +1,123 @@
+//
+//  DataMigrationReportView.swift
+//  OBAKit
+//
+//  Created by Alan Chu on 1/4/23.
+//
+
+import SwiftUI
+import OBAKitCore
+
+struct DataMigrationReportView: View {
+
+    var reports: [DataMigrationReportGroup]
+
+    var numberOfSuccessItems: Int
+    var numberOfErrorItems: Int
+
+    init(report: DataMigrator.MigrationReport) {
+        self.init(reports: report.viewModel())
+    }
+
+    init(reports: [DataMigrationReportGroup]) {
+        self.reports = reports
+
+        var numberOfSuccessItems = 0
+        var numberOfErrorItems = 0
+        for report in reports {
+            for item in report.items {
+                if item.error == nil {
+                    numberOfSuccessItems += 1
+                } else {
+                    numberOfErrorItems += 1
+                }
+            }
+        }
+
+        self.numberOfSuccessItems = numberOfSuccessItems
+        self.numberOfErrorItems = numberOfErrorItems
+    }
+
+    @Environment(\.dismiss) var dismiss
+    @State var isViewingReport = false
+
+    var body: some View {
+        Group {
+            if isViewingReport {
+                report
+            } else {
+                Spacer()
+            }
+        }
+        .safeAreaInset(edge: .top) {
+            OnboardingHeaderView(imageSystemName: "checkmark", headerText: OBALoc("data_migration_bulletin.finished_loading", value: "Data Upgrade Complete!", comment: "This comment is displayed after the user's data is upgraded in the DataMigrationBulletinPage."))
+        }
+        .safeAreaInset(edge: .bottom) {
+            VStack(spacing: 14) {
+                Button {
+                    dismiss()
+                } label: {
+                    Text(Strings.dismiss)
+                        .frame(maxWidth: .infinity, minHeight: 32)
+                }
+                .buttonStyle(.borderedProminent)
+
+                if !isViewingReport {
+                    Button(OBALoc("data_migration_bulletin.view_report_button", value: "View Report", comment: "Button title to let the user view a data migration report.")) {
+                        isViewingReport = true
+                    }
+                }
+            }
+            .background(.background)
+        }
+        .padding()
+    }
+
+    var report: some View {
+        List {
+            Section(OBALoc("data_migration_bulletin.report_summary_title", value: "Summary", comment: "Title for the Summary section of a data migration report")) {
+                Text(
+                    OBALoc("data_migration_bulletin.report_summary_number_of_successes", format: "%d successful", comment: "Data migration report label for showing the number of successful migration tasks.", numberOfSuccessItems))
+                Text(OBALoc("data_migration_bulletin.report_summary_number_of_failures", format: "%d failures", comment: "Data migration report label for showing the number of failed migration tasks.", numberOfErrorItems))
+            }
+
+            ForEach(reports) { group in
+                Section(group.title) {
+                    ForEach(group.items) { item in
+                        listView(item)
+                    }
+                }
+            }
+        }
+        .listStyle(.plain)
+    }
+
+    @ViewBuilder func listView(_ item: DataMigrationReportItem) -> some View {
+        DisclosureGroup {
+            if let error = item.error {
+                Text(error.localizedDescription)
+            }
+        } label: {
+            Label(item.title, systemImage: item.systemImageName)
+                .symbolVariant(item.error == nil ? .none : .fill)
+                .foregroundColor(item.error == nil ? Color.primary : Color.red)
+        }
+    }
+}
+
+struct DataMigrationReportView_Previews: PreviewProvider {
+    static var previews: some View {
+        NavigationView {
+            DataMigrationReportView(reports: Self.sampleData)
+        }
+    }
+
+    static var sampleData: [DataMigrationReportGroup] {
+        return [
+            .init(title: "Metadata", items: [
+                .init(systemImageName: "checkmark.diamond", title: "User ID", subtitle: nil),
+                .init(systemImageName: "checkmark.diamond", title: "Region", subtitle: nil)
+            ])
+        ]
+    }
+}

OBAKit/Onboarding/DataMigration/DataMigrationReportViewModels.swift

@@ -0,0 +1,84 @@
+//
+//  DataMigrationResultViewModel.swift
+//  OBAKit
+//
+//  Created by Alan Chu on 1/4/23.
+//
+
+import OBAKitCore
+
+struct DataMigrationReportItem: Identifiable {
+    let id = UUID()
+    var systemImageName: String
+    var title: String
+    var subtitle: String?
+    var error: Error?
+}
+
+struct DataMigrationReportGroup: Identifiable {
+    let id = UUID()
+    var title: String
+    var items: [DataMigrationReportItem] = []
+}
+
+extension DataMigrator.MigrationReport {
+    func viewModel() -> [DataMigrationReportGroup] {
+        var groups: [DataMigrationReportGroup] = []
+
+        // Metadata
+        var metadata = DataMigrationReportGroup(title: "Metadata")
+        metadata.items.append(resultToItem(title: "User ID", result: userIDMigrationResult))
+        metadata.items.append(resultToItem(title: "Region", result: regionMigrationResult))
+
+        groups.append(metadata)
+
+        // Recent Stops
+        var recentStops = DataMigrationReportGroup(title: "Recent Stops")
+        for recentStopResult in recentStopsMigrationResult {
+            let title = recentStopResult.key.title
+            recentStops.items.append(resultToItem(title: title, result: recentStopResult.value))
+        }
+        groups.append(recentStops)
+
+        // Loose bookmarks
+        var bookmarks = DataMigrationReportGroup(title: "Bookmarks")
+        for bookmarkResult in bookmarksMigrationResult {
+            let title = bookmarkResult.key.name
+            bookmarks.items.append(resultToItem(title: title, result: bookmarkResult.value))
+        }
+        groups.append(bookmarks)
+
+        // Bookmark groups, each bookmark group is its own section.
+        var bookmarkGroups: [DataMigrationReportGroup] = []
+        for bookmarkGroupResult in bookmarkGroupsMigrationResult {
+            var groupViewModel = DataMigrationReportGroup(title: bookmarkGroupResult.key.name ?? "<unnamed group>")
+            let bookmarks = bookmarkGroupResult.value.bookmarks
+            for bookmark in bookmarks {
+                groupViewModel.items.append(resultToItem(title: bookmark.key.name, result: bookmark.value))
+            }
+
+            bookmarkGroups.append(groupViewModel)
+        }
+        groups.append(contentsOf: bookmarkGroups)
+
+        return groups
+    }
+
+    private func resultToItem<T>(title: String, subtitle: String? = nil, result: Result<T, any Error>?) -> DataMigrationReportItem {
+        let systemImage: String
+        let error: Error?
+        switch result {
+        case .success:
+            systemImage = "checkmark.diamond"
+            error = nil
+        case .failure(let _error):
+            systemImage = "xmark.diamond"
+            error = _error
+        case .none:             // Did not do anything.
+            systemImage = "minus.diamond"
+            error = nil
+        }
+
+        return .init(systemImageName: systemImage, title: title, subtitle: subtitle, error: error)
+    }
+}