Merge pull request #741 from Esri/lts.next

[Release] 200.8.1

Author: CalebRas

.swiftlint.yml

@@ -21,8 +21,8 @@ disabled_rules:
   - file_length
   - for_where
   - force_cast
+  - force_try
   - line_length
-  - notification_center_detachment
   - type_body_length
   - type_name
 

Samples.xcodeproj/project.pbxproj

@@ -134,10 +134,10 @@ func uncompressArchive(at sourceURL: URL, to destinationURL: URL) throws {
 ///   - downloadDirectory: The directory to store the downloaded data in.
 /// - Throws: Exceptions when downloading, naming, uncompressing, and moving the file.
 /// - Returns: The name of the downloaded file.
-func downloadFile(from sourceURL: URL, to downloadDirectory: URL) async throws -> String? {
+func downloadFile(from sourceURL: URL, to downloadDirectory: URL) async throws -> String {
     let (temporaryURL, response) = try await URLSession.shared.download(from: sourceURL)
 
-    guard let suggestedFilename = response.suggestedFilename else { return nil }
+    guard let suggestedFilename = response.suggestedFilename else { fatalError("No suggested filename from server.") }
     let isArchive = NSString(string: suggestedFilename).pathExtension == "zip"
 
     let downloadName: String = try {
@@ -153,7 +153,7 @@ func downloadFile(from sourceURL: URL, to downloadDirectory: URL) async throws -
         }
     }()
     let downloadURL = downloadDirectory.appendingPathComponent(downloadName, isDirectory: false)
-    
+    // Optionally removes any existing file without causing error.
     try? FileManager.default.removeItem(at: downloadURL)
 
     if isArchive {
@@ -173,119 +173,203 @@ func downloadFile(from sourceURL: URL, to downloadDirectory: URL) async throws -
 
 // MARK: Script Entry
 
-let arguments = CommandLine.arguments
-
-guard arguments.count == 3 else {
-    print("error: Invalid number of arguments.")
-    exit(1)
-}
-
-/// The samples directory, i.e., $SRCROOT/Shared/Samples.
-let samplesDirectoryURL = URL(fileURLWithPath: arguments[1], isDirectory: true)
-/// The download directory, i.e., $SRCROOT/Portal Data.
-let downloadDirectoryURL = URL(fileURLWithPath: arguments[2], isDirectory: true)
-
-// If the download directory does not exist, create it.
-if !FileManager.default.fileExists(atPath: downloadDirectoryURL.path) {
-    do {
-        try FileManager.default.createDirectory(at: downloadDirectoryURL, withIntermediateDirectories: false)
-    } catch {
-        print("error: Error creating download directory: \(error.localizedDescription).")
-        exit(1)
+/// Error thrown by the script.
+enum ScriptError: Error, LocalizedError {
+    case invalidArguments
+    case cannotCreateDirectory(String)
+    case cannotParseDependencies(String)
+    case downloadFailed
+    
+    var errorDescription: String? {
+        switch self {
+        case .invalidArguments:
+            "Invalid number of arguments."
+        case .cannotCreateDirectory(let path):
+            "Cannot create directory: \(path)"
+        case .cannotParseDependencies(let reason):
+            "Cannot parse dependencies: \(reason)"
+        case .downloadFailed:
+            "Failed to download all items."
+        }
     }
 }
 
-/// Portal Items created from iterating through all metadata's "offline\_data".
-let portalItems: Set<PortalItem> = {
+/// Parses all sample dependencies in the given samples directory.
+/// - Parameter samplesDirectoryURL: The URL to the samples directory.
+/// - Throws: Exceptions when unable to read or decode JSON files.
+/// - Returns: The portal items that represent the offline data.
+func parseSampleDependencies(at samplesDirectoryURL: URL) throws -> [PortalItem] {
     do {
         // Finds all subdirectories under the root Samples directory.
         let sampleSubDirectories = try FileManager.default
-            .contentsOfDirectory(at: samplesDirectoryURL, includingPropertiesForKeys: nil, options: [.skipsHiddenFiles])
+            .contentsOfDirectory(
+                at: samplesDirectoryURL,
+                includingPropertiesForKeys: nil,
+                options: [.skipsHiddenFiles]
+            )
             .filter(\.hasDirectoryPath)
         let sampleJSONs = sampleSubDirectories
             .map { $0.appendingPathComponent("README.metadata.json", isDirectory: false) }
-        // Omit the decoding errors from samples that don't have dependencies.
+        // Omits the decoding errors from samples that don't have dependencies.
         let sampleDependencies = sampleJSONs
             .compactMap { try? parseJSON(at: $0) }
-        return Set(sampleDependencies.lazy.flatMap(\.offlineData))
+        // Some items are used by multiple samples and their IDs appear more
+        // than once.
+        // Removes duplicates by converting to a Set, then back to an Array.
+        return Array(Set(sampleDependencies.lazy.flatMap(\.offlineData)))
     } catch {
-        print("error: Error decoding Samples dependencies: \(error.localizedDescription)")
-        exit(1)
+        throw ScriptError.cannotParseDependencies(error.localizedDescription)
     }
-}()
-
-typealias Identifier = String
-typealias Filename = String
-typealias DownloadedItems = [Identifier: Filename]
+}
 
-/// The URL to a property list that maintains records of downloaded resources.
-let downloadedItemsURL = downloadDirectoryURL.appendingPathComponent(".downloaded_items.plist", isDirectory: false)
-let previousDownloadedItems: DownloadedItems = {
-    do {
-        let data = try Data(contentsOf: downloadedItemsURL)
-        return try PropertyListDecoder().decode(DownloadedItems.self, from: data)
-    } catch {
-        return [:]
+/// The main script function.
+func run() async throws { // swiftlint:disable:this function_body_length cyclomatic_complexity
+    let arguments = CommandLine.arguments
+    guard arguments.count == 3 else {
+        throw ScriptError.invalidArguments
     }
-}()
-var downloadedItems = previousDownloadedItems
-
-await withTaskGroup(of: Void.self) { group in
-    for portalItem in portalItems {
+    
+    /// The samples directory, i.e., $SRCROOT/Shared/Samples.
+    let samplesDirectoryURL = URL(fileURLWithPath: arguments[1], isDirectory: true)
+    /// The download directory, i.e., $SRCROOT/Portal Data.
+    let downloadDirectoryURL = URL(fileURLWithPath: arguments[2], isDirectory: true)
+    
+    // If the download directory does not exist, create it.
+    if !FileManager.default.fileExists(atPath: downloadDirectoryURL.path) {
+        do {
+            try FileManager.default.createDirectory(at: downloadDirectoryURL, withIntermediateDirectories: false)
+        } catch {
+            throw ScriptError.cannotCreateDirectory(downloadDirectoryURL.path)
+        }
+    }
+    
+    /// Portal Items created from iterating through all metadata's "offline_data".
+    let portalItems = try parseSampleDependencies(at: samplesDirectoryURL)
+    
+    typealias Identifier = String
+    typealias Filename = String
+    typealias DownloadedItems = [Identifier: Filename]
+    
+    /// The URL to a property list that maintains records of downloaded resources.
+    let downloadedItemsURL = downloadDirectoryURL.appendingPathComponent(".downloaded_items.plist", isDirectory: false)
+    let previousDownloadedItems: DownloadedItems = {
+        do {
+            let data = try Data(contentsOf: downloadedItemsURL)
+            return try PropertyListDecoder().decode(DownloadedItems.self, from: data)
+        } catch {
+            return [:]
+        }
+    }()
+    var downloadedItems = previousDownloadedItems
+    
+    defer {
+        // Updates the downloaded items property list when there are changes.
+        // It runs at the end of the function, even if there are errors.
+        // Because defer cannot throw, errors are caught and printed.
+        if downloadedItems != previousDownloadedItems {
+            do {
+                let data = try PropertyListEncoder().encode(downloadedItems)
+                try data.write(to: downloadedItemsURL)
+            } catch {
+                print("error: Error recording downloaded items: \(error.localizedDescription)")
+            }
+        }
+    }
+    
+    /// Creates a directory for the portal item in the download directory.
+    /// - Parameter portalItem: The portal item.
+    /// - Throws: `ScriptError.cannotCreateDirectory` when unable to create the
+    /// directory.
+    /// - Returns: The URL to the created directory, or `nil` if the portal item
+    /// is already downloaded.
+    func createDirectory(for portalItem: PortalItem) throws -> URL? {
         let destinationURL = downloadDirectoryURL.appendingPathComponent(
             portalItem.identifier,
             isDirectory: true
         )
 
         // Checks to see if an item needs downloading.
+        // Only skips if the item is in the plist and file exists at the
+        // expected location.
         guard downloadedItems[portalItem.identifier] == nil ||
                 !FileManager.default.fileExists(atPath: destinationURL.path) else {
             print("note: Item already downloaded: \(portalItem.identifier)")
-            continue
+            return nil
         }
 
         // Deletes the directory when the item is not in the plist.
         try? FileManager.default.removeItem(at: destinationURL)
 
         do {
-            // Creates an enclosing directory with the portal item ID as its name.
+            // Creates an enclosing directory with the item ID as its name.
             try FileManager.default.createDirectory(
                 at: destinationURL,
                 withIntermediateDirectories: false
             )
+            return destinationURL
+        } catch {
+            throw ScriptError.cannotCreateDirectory(destinationURL.path)
+        }
+    }
+    
+    /// Handles downloading a portal item to the given destination URL.
+    /// - Parameters:
+    ///   - portalItem: The portal item.
+    ///   - destinationURL: The URL to the portal item download directory.
+    ///   - index: The index of the portal item in the overall list.
+    /// - Throws: `ScriptError.downloadFailed` when unable to download the item.
+    func handleDownload(for portalItem: PortalItem, at destinationURL: URL, index: Int) async throws {
+        do {
+            let downloadName = try await downloadFile(
+                from: portalItem.dataURL,
+                to: destinationURL
+            )
+            downloadedItems.updateValue(downloadName, forKey: portalItem.identifier)
+            print("note: (\(index + 1)/\(portalItems.count)) Downloaded item: \(portalItem.identifier)")
+            fflush(stdout)
         } catch {
-            print("error: Error creating download directory: \(error.localizedDescription)")
-            exit(1)
+            print("error: Failed to download item \(portalItem.identifier), \(error.localizedDescription)")
+            fflush(stdout)
+            // Deletes the directory when the item fails to download.
+            try? FileManager.default.removeItem(at: destinationURL)
+            throw ScriptError.downloadFailed
+        }
+    }
+    
+    /// The maximum number of concurrent download tasks, capped at 4.
+    let maxConcurrentTasks = min(4, portalItems.count)
+    
+    try await withThrowingTaskGroup(of: Void.self) { group in
+        for index in 0 ..< maxConcurrentTasks {
+            group.addTask {
+                let portalItem = portalItems[index]
+                guard let destinationURL = try createDirectory(for: portalItem) else { return }
+                try await handleDownload(for: portalItem, at: destinationURL, index: index)
+            }
         }
 
-        group.addTask {
-            do {
-                guard let downloadName = try await downloadFile(
-                    from: portalItem.dataURL,
-                    to: destinationURL
-                ) else { return }
-                print("note: Downloaded item: \(portalItem.identifier)")
-                fflush(stdout)
-                
-                _ = await MainActor.run {
-                    downloadedItems.updateValue(downloadName, forKey: portalItem.identifier)
+        var nextPortalItemIndex = maxConcurrentTasks
+        // As each task completes, adds a new task until all portal items are
+        // either downloaded, or an error occurs that causes the group to throw
+        // and cancel all remaining tasks.
+        while try await group.next() != nil {
+            if nextPortalItemIndex < portalItems.count {
+                // Captures the next index so it doesn't go out of range.
+                group.addTask { [nextPortalItemIndex] in
+                    let portalItem = portalItems[nextPortalItemIndex]
+                    guard let destinationURL = try createDirectory(for: portalItem) else { return }
+                    try await handleDownload(for: portalItem, at: destinationURL, index: nextPortalItemIndex)
                 }
-            } catch {
-                print("error: Error downloading item \(portalItem.identifier): \(error.localizedDescription)")
-                URLSession.shared.invalidateAndCancel()
-                exit(1)
             }
+            nextPortalItemIndex += 1
         }
     }
 }
 
-// Updates the downloaded items property list record if needed.
-if downloadedItems != previousDownloadedItems {
-    do {
-        let data = try PropertyListEncoder().encode(downloadedItems)
-        try data.write(to: downloadedItemsURL)
-    } catch {
-        print("error: Error recording downloaded items: \(error.localizedDescription)")
-        exit(1)
-    }
+do {
+    try await run()
+} catch {
+    print("error: \(error.localizedDescription)")
+    fflush(stdout)
+    exit(1)
 }

Scripts/DownloadPortalItemData.swift

@@ -63,7 +63,7 @@ struct AddWFSLayerView: View {
     @State private var isPopulating = false
 
     /// The error shown in the error alert.
-    @State private var error: Error?
+    @State private var error: (any Error)?
 
     var body: some View {
         MapView(map: map)

Shared/Samples/Add WFS layer/AddWFSLayerView.swift

@@ -23,7 +23,7 @@ struct AddWMTSLayerView: View {
     @State private var selectedLayerSource = WMTSLayerSource.wmtsLayerInfo
 
     /// The error shown in the error alert.
-    @State private var error: Error?
+    @State private var error: (any Error)?
 
     var body: some View {
         MapView(map: model.map)

Shared/Samples/Add WMTS layer/AddWMTSLayerView.swift

@@ -12,19 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import ArcGIS
+
 extension AddCustomDynamicEntityDataSourceView {
     /// A marine vessel that can be decoded from the vessel JSON.
     struct Vessel {
-        /// A geometry that gives the location of the vessel.
-        struct Geometry: Decodable { // swiftlint:disable:this nesting
-            /// The x coordinate of the geometry.
-            let x: Double
-            /// The y coordinate of the geometry.
-            let y: Double
-        }
-        
         /// The location of the vessel.
-        let geometry: Geometry
+        let geometry: Point
         /// The attributes of the vessel.
         let attributes: [String: any Sendable]
     }
@@ -56,7 +50,7 @@ extension AddCustomDynamicEntityDataSourceView.Vessel: Decodable {
 
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
-        let geometry = try container.decode(Geometry.self, forKey: .geometry)
+        let geometry = try container.decode(Point.self, forKey: .geometry)
         let attributes: [String: any Sendable] = try {
             let attributes = try container.decode(Attributes.self, forKey: .attributes)
             return [

Shared/Samples/Add custom dynamic entity data source/AddCustomDynamicEntityDataSourceView.Vessel.swift

@@ -127,13 +127,10 @@ private struct VesselFeed: CustomDynamicEntityFeed {
             from: line.data(using: .utf8)!
         )
 
-        // The location of the vessel that was decoded from the JSON.
-        let location = vessel.geometry
-        
         // We successfully decoded the vessel JSON so we should
         // add that vessel as a new observation.
         return CustomDynamicEntityFeedEvent.newObservation(
-            geometry: Point(x: location.x, y: location.y, spatialReference: .wgs84),
+            geometry: vessel.geometry,
             attributes: vessel.attributes
         )
     }

Shared/Samples/Add custom dynamic entity data source/AddCustomDynamicEntityDataSourceView.swift

@@ -20,7 +20,7 @@ struct AddFeatureCollectionLayerFromPortalItemView: View {
     @State private var map = Map(basemapStyle: .arcGISOceans)
 
     /// The error shown in the error alert.
-    @State private var error: Error?
+    @State private var error: (any Error)?
 
     var body: some View {
         MapView(map: map)

Shared/Samples/Add feature collection layer from portal item/AddFeatureCollectionLayerFromPortalItemView.swift

@@ -20,7 +20,7 @@ struct AddFeatureCollectionLayerFromQueryView: View {
     @State private var map = Map(basemapStyle: .arcGISOceans)
 
     /// The error shown in the error alert.
-    @State private var error: Error?
+    @State private var error: (any Error)?
 
     var body: some View {
         MapView(map: map)

Shared/Samples/Add feature collection layer from query/AddFeatureCollectionLayerFromQueryView.swift

@@ -28,7 +28,7 @@ struct AddFeatureCollectionLayerFromTableView: View {
     }()
 
     /// The error shown in the error alert.
-    @State private var error: Error?
+    @State private var error: (any Error)?
 
     var body: some View {
         MapView(map: map)