Merge branch 'v.next' into Caleb/Fix-SampleIssues

Author: CalebRas

Samples.xcodeproj/project.pbxproj

@@ -577,6 +577,7 @@
 		D7AE861F2AC39E7F0049B626 /* DisplayAnnotationView.swift in Copy Source Code Files */ = {isa = PBXBuildFile; fileRef = D7AE861D2AC39DC50049B626 /* DisplayAnnotationView.swift */; };
 		D7AE86202AC3A1050049B626 /* AddCustomDynamicEntityDataSourceView.Vessel.swift in Copy Source Code Files */ = {isa = PBXBuildFile; fileRef = 7900C5F52A83FC3F002D430F /* AddCustomDynamicEntityDataSourceView.Vessel.swift */; };
 		D7AE86212AC3A10A0049B626 /* GroupLayersTogetherView.GroupLayerListView.swift in Copy Source Code Files */ = {isa = PBXBuildFile; fileRef = D75C35662AB50338003CD55F /* GroupLayersTogetherView.GroupLayerListView.swift */; };
+		D7AECFDD2E31448100FD312A /* View+OnTeardown.swift in Sources */ = {isa = PBXBuildFile; fileRef = D7AECFDC2E31448100FD312A /* View+OnTeardown.swift */; };
 		D7AECFE72E31699400FD312A /* ControlAnnotationSublayerVisibilityView.Model.swift in Copy Source Code Files */ = {isa = PBXBuildFile; fileRef = 1C8438FA2DDCFCA9005CCBC7 /* ControlAnnotationSublayerVisibilityView.Model.swift */; };
 		D7AECFE82E31699A00FD312A /* GenerateGeodatabaseReplicaFromFeatureServiceView.Model.swift in Copy Source Code Files */ = {isa = PBXBuildFile; fileRef = 1C17E1CB2DE6456B00A012CB /* GenerateGeodatabaseReplicaFromFeatureServiceView.Model.swift */; };
 		D7B759B32B1FFBE300017FDD /* FavoritesView.swift in Sources */ = {isa = PBXBuildFile; fileRef = D7B759B22B1FFBE300017FDD /* FavoritesView.swift */; };
@@ -1346,6 +1347,7 @@
 		D7ABA2F82A32579C0021822B /* MeasureDistanceInSceneView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MeasureDistanceInSceneView.swift; sourceTree = "<group>"; };
 		D7ABA2FE2A32881C0021822B /* ShowViewshedFromGeoelementInSceneView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ShowViewshedFromGeoelementInSceneView.swift; sourceTree = "<group>"; };
 		D7AE861D2AC39DC50049B626 /* DisplayAnnotationView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DisplayAnnotationView.swift; sourceTree = "<group>"; };
+		D7AECFDC2E31448100FD312A /* View+OnTeardown.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "View+OnTeardown.swift"; sourceTree = "<group>"; };
 		D7B759B22B1FFBE300017FDD /* FavoritesView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FavoritesView.swift; sourceTree = "<group>"; };
 		D7BA38902BFBC476009954F5 /* EditFeaturesWithFeatureLinkedAnnotationView.Model.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EditFeaturesWithFeatureLinkedAnnotationView.Model.swift; sourceTree = "<group>"; };
 		D7BA38932BFBFC0F009954F5 /* QueryRelatedFeaturesView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = QueryRelatedFeaturesView.swift; sourceTree = "<group>"; };
@@ -1468,6 +1470,7 @@
 				D7A670D42DADB9630060E327 /* Bundle.swift */,
 				D7A670D62DADBC770060E327 /* EnvironmentValues+RequestReviewModel.swift */,
 				00181B452846AD7100654571 /* View+ErrorAlert.swift */,
+				D7AECFDC2E31448100FD312A /* View+OnTeardown.swift */,
 				D7142BC32DB71082004F87B7 /* View+PagePresentation.swift */,
 			);
 			path = Extensions;
@@ -4653,6 +4656,7 @@
 				00A7A14A2A2FC5B700F035F7 /* DisplayContentOfUtilityNetworkContainerView.Model.swift in Sources */,
 				E004A6F0284E4B9B002A1FE6 /* DownloadVectorTilesToLocalCacheView.swift in Sources */,
 				00ABA94E2BF6721700C0488C /* ShowGridView.swift in Sources */,
+				D7AECFDD2E31448100FD312A /* View+OnTeardown.swift in Sources */,
 				1CAB8D4E2A3CEAB0002AA649 /* RunValveIsolationTraceView.swift in Sources */,
 				D7A737E02BABB9FE00B7C7FC /* AugmentRealityToShowHiddenInfrastructureView.swift in Sources */,
 				4D2ADC4329C26D05003B367F /* AddDynamicEntityLayerView.swift in Sources */,

Scripts/CI/common.py

@@ -275,6 +275,7 @@ def __init__(self, folder_path: str):
 
         # A list of ArcGIS Portal Item IDs.
         self.offline_data = []      # Default to empty list.
+        self.has_teardown = False   # Only applies to samples that require async tear down (e.g., authentication).
 
         self.folder_path = folder_path
         self.folder_name = get_folder_name_from_path(folder_path)
@@ -372,6 +373,9 @@ def flush_to_json_string(self) -> str:
         data["relevant_apis"] = self.relevant_apis
         data["snippets"] = self.snippets
         data["title"] = self.title
+        if self.has_teardown:
+            # Only write has_teardown when it is True.
+            data["has_teardown"] = self.has_teardown
         if self.offline_data:
             # Only write offline_data when it is not empty.
             data["offline_data"] = self.offline_data

Scripts/CI/metadata_checker.py

@@ -52,6 +52,10 @@ def run_check(path: str) -> None:
     # The special rule not to compare the redirect_from.
     checker.redirect_from = json_data['redirect_from']
 
+    # The special rule not to compare has_teardown.
+    if 'has_teardown' in json_data:
+        checker.has_teardown = json_data['has_teardown']
+
     # The special rule not to compare offline_data.
     if 'offline_data' in json_data:
         checker.offline_data = json_data['offline_data']

Scripts/GenerateSampleViewSourceCode.swift

@@ -43,6 +43,9 @@ private struct SampleMetadata: Decodable {
     let keywords: [String]
     /// The relevant APIs of the sample.
     let relevantApis: [String]
+    /// A Boolean value indicating whether a sample has an action that needs to
+    /// be performed when its view disappears.
+    let hasTeardown: Bool? // swiftlint:disable:this discouraged_optional_boolean
 }
 
 extension SampleMetadata {
@@ -130,6 +133,7 @@ private let sampleStructs = sampleMetadata
             var snippets: [String] { \(sample.snippets) }
             var tags: Set<String> { \(sample.tags) }
             \(portalItemIDs.isEmpty ? "" : "var hasDependencies: Bool { true }\n")
+            var hasTeardown: Bool { \(sample.hasTeardown ?? false) }
             func makeBody() -> AnyView { .init(\(sample.viewName)()) }
         }
         """

Scripts/create-metadata-from-README.py

@@ -49,6 +49,9 @@ def flush_to_json_file(self, path_to_json: str) -> None:
         data["relevant_apis"] = self.relevant_apis
         data["snippets"] = self.snippets
         data["title"] = self.title
+        if self.has_teardown:
+            # Only write has_teardown when it is True.
+            data["has_teardown"] = self.has_teardown
         if self.offline_data:
             # Only write offline_data when it is not empty.
             data["offline_data"] = self.offline_data

Shared/Samples/Add KML layer/AddKMLLayerView.swift

@@ -76,7 +76,7 @@ private extension AddKMLLayerView {
 
         /// A KML layer created from a web URL.
         let urlLayer: KMLLayer = {
-            let url = URL(string: "https://www.wpc.ncep.noaa.gov/kml/noaa_chart/WPC_Day1_SigWx.kml")!
+            let url = URL(string: "https://www.spc.noaa.gov/products/outlook/SPC_outlooks.kml")!
             let kmlDataset = KMLDataset(url: url)
             return KMLLayer(dataset: kmlDataset)
         }()

Shared/Samples/Add KML layer/README.md

@@ -32,7 +32,7 @@ This sample uses the [US State Capitals](https://www.arcgis.com/home/item.html?i
 
 This sample displays three different KML files:
 
-* From URL: This is a map of the significant weather outlook produced by NOAA/NWS. It uses KML network links to always show the latest data.
+* From URL: This is a map of the convective outlook produced by NOAA/NWS Storm Prediction Center. It uses KML network links to always show the latest data.
 * From local file: This is a map of U.S. state capitals. It doesn't define an icon, so the default pushpin is used for the points.
 * From portal item: This is a map of U.S. states.
 

Shared/Samples/Add feature layers/AddFeatureLayersView.swift

@@ -53,9 +53,11 @@ struct AddFeatureLayersView: View {
                 // specified credentials and tokens for any challenges.
                 ArcGISEnvironment.authenticationManager.arcGISAuthenticationChallengeHandler = ChallengeHandler()
             }
-            .onDisappear {
-                // Resets the URL session challenge handler to use default handling.
+            .onTeardown {
+                // Resets the URL session challenge handler to use default handling
+                // and removes all credentials.
                 ArcGISEnvironment.authenticationManager.arcGISAuthenticationChallengeHandler = nil
+                ArcGISEnvironment.authenticationManager.arcGISCredentialStore.removeAll()
             }
     }
 }

Shared/Samples/Add feature layers/README.metadata.json

@@ -1,6 +1,7 @@
 {
     "category": "Layers",
     "description": "Display feature layers from various data sources.",
+    "has_teardown": true,
     "ignore": false,
     "images": [
         "add-feature-layers.png"

Shared/Samples/Add items to portal/AddItemsToPortalView.swift

@@ -92,7 +92,7 @@ struct AddItemsToPortalView: View {
             apiKey = ArcGISEnvironment.apiKey
             ArcGISEnvironment.apiKey = nil
         }
-        .onDisappear {
+        .onTeardown {
             // Resetting the challenge handlers and clearing credentials here in
             // `onDisappear` so user is prompted to enter credentials every time
             // trying the sample. In real world applications, do these from
@@ -103,7 +103,7 @@ struct AddItemsToPortalView: View {
 
             // Sets the API key back to the original value.
             ArcGISEnvironment.apiKey = apiKey
-            Task { await signOut() }
+            await signOut()
         }
     }