test: Add SwiftUI test to reproduce SwiftUI lifecycle only bugs (#6268)

* test: Add SwiftUI test

* Updates

Author: noahsmartin

Samples/iOS-SwiftUI/iOS-SwiftUI-UITests/LaunchUITests.swift

@@ -1,3 +1,4 @@
+import Sentry
 import SentrySampleShared
 import SentrySampleUITestShared
 import XCTest
@@ -48,6 +49,15 @@ class LaunchUITests: XCTestCase {
 
         XCTAssertEqual(app.staticTexts["TTDInfo"].label, "TTID and TTFD found")
     }
+  
+  func testCaptureErrorReturnsValidId() {
+    let app = newAppSession()
+    app.safelyLaunch()
+    app.buttons["Capture Error"].tap()
+    let errorId = app.staticTexts["errorId"].label
+    let sentryErrorId = SentryId(uuidString: errorId)
+    XCTAssertNotEqual(sentryErrorId.sentryIdString, SentryId.empty.sentryIdString, "The id should not be empty, since empty is used to indicate the capture did not work.")
+  }
 
     func newAppSession() -> XCUIApplication {
         let app = XCUIApplication()

Samples/iOS-SwiftUI/iOS-SwiftUI/ContentView.swift

@@ -16,6 +16,7 @@ class DataBag {
 struct ContentView: View {
 
     @State var TTDInfo: String = ""
+    @State var errorId: SentryId?
 
     var addBreadcrumbAction: () -> Void = {
         let crumb = Breadcrumb(level: SentryLevel.info, category: "Debug")
@@ -46,9 +47,9 @@ struct ContentView: View {
       #endif // SDK_V9
     }
 
-    var captureErrorAction: () -> Void = {
+    func captureErrorAction() {
         let error = NSError(domain: "SampleErrorDomain", code: 1, userInfo: [NSLocalizedDescriptionKey: "Object does not exist"])
-        SentrySDK.capture(error: error) { (scope) in
+        errorId = SentrySDK.capture(error: error) { (scope) in
             scope.setTag(value: "value", key: "myTag")
         }
     }
@@ -239,7 +240,10 @@ struct ContentView: View {
                         .background(Color.white)
                     }
                     SecondView()
-
+                  if let errorId {
+                    Text(errorId.sentryIdString)
+                      .accessibilityIdentifier("errorId")
+                  }
                     Text(TTDInfo)
                         .accessibilityIdentifier("TTDInfo")
                 }