fix(feedback): accessibility audit action items

Samples/iOS-ObjectiveC/iOS-ObjectiveC/AppDelegate.m

@@ -57,7 +57,6 @@ - (BOOL)application:(UIApplication *)application
                 config.configureWidget = ^(SentryUserFeedbackWidgetConfiguration *_Nonnull widget) {
                     if ([args containsObject:@"--io.sentry.feedback.auto-inject-widget"]) {
                         widget.labelText = @"Report Jank";
-                        widget.widgetAccessibilityLabel = @"io.sentry.iOS-Swift.button.report-jank";
                         widget.layoutUIOffset = layoutOffset;
                     } else {
                         widget.autoInject = NO;

Samples/iOS-Swift/iOS-Swift-UITests/UserFeedbackUITests.swift

@@ -34,7 +34,7 @@
     func testUIElementsWithDefaults() {
         launchApp(args: ["--io.sentry.feedback.all-defaults"])
         // widget button text
-        XCTAssert(app.staticTexts["Report a Bug"].exists)
+        XCTAssert(app.otherElements["Report a Bug"].exists)
 
         widgetButton.tap()
 
@@ -42,11 +42,11 @@
         XCTAssert(app.staticTexts["Report a Bug"].exists)
 
         // form buttons
         XCTAssert(app.staticTexts["Add a screenshot"].exists)
         XCTAssert(app.staticTexts["Cancel"].exists)
         XCTAssert(app.staticTexts["Send Bug Report"].exists)
 
         addScreenshotButton.tap()
         XCTAssert(app.staticTexts["Remove screenshot"].exists)
 
         // Input field placeholders
@@ -63,10 +63,10 @@
     }
 
     func testUIElementsWithCustomizations() {
-        launchApp()
+        launchApp(args: ["--io.sentry.feedback.auto-inject-widget"])
 
         // widget button text
-        XCTAssert(app.staticTexts["Report Jank"].exists)
+        XCTAssert(app.otherElements["Report Jank"].exists)
 
         widgetButton.tap()
 
@@ -75,10 +75,10 @@
 
         // form buttons
         XCTAssert(app.staticTexts["Report that jank"].exists)
         XCTAssert(app.staticTexts["Show us the jank"].exists)
         XCTAssert(app.staticTexts["What, me worry?"].exists)
 
         addScreenshotButton.tap()
         XCTAssert(app.staticTexts["Oof too nsfl"].exists)
 
         // Input field placeholders
@@ -327,10 +327,10 @@
 
         messageTextView.tap()
         messageTextView.typeText("UITest user feedback")
-        
-        // first swipe down dismisses the keyboard that's still visible from typing the above inputs
+
+        // dismiss the onscreen keyboard
         app.swipeDown(velocity: .fast)
-        
+
         // the modal cancel gesture
         app.swipeDown(velocity: .fast)
 
@@ -353,7 +353,7 @@
     func testAddingAndRemovingScreenshots() {
         launchApp(args: ["--io.sentry.feedback.all-defaults"])
         widgetButton.tap()
         addScreenshotButton.tap()
         XCTAssert(removeScreenshotButton.isHittable)
         XCTAssertFalse(addScreenshotButton.isHittable)
         removeScreenshotButton.tap()
@@ -378,7 +378,7 @@
         XCTAssertEqual(try getMarkerFileContents(type: .onSubmitError), "io.sentry.error;1;The user did not complete the feedback form.;description")
 
         XCTAssert(app.staticTexts["Error"].exists)
-        XCTAssert(app.staticTexts["You must provide all required information. Please check the following field: description."].exists)
+        XCTAssert(app.staticTexts["You must provide all required information before submitting. Please check the following field: description."].exists)
 
         app.buttons["OK"].tap()
     }
@@ -402,7 +402,7 @@
         XCTAssertEqual(try getMarkerFileContents(type: .onSubmitError), "io.sentry.error;1;The user did not complete the feedback form.;thine email;thy complaint")
 
         XCTAssert(app.staticTexts["Error"].exists)
-        XCTAssert(app.staticTexts["You must provide all required information. Please check the following fields: thine email and thy complaint."].exists)
+        XCTAssert(app.staticTexts["You must provide all required information before submitting. Please check the following fields: thine email and thy complaint."].exists)
 
         app.buttons["OK"].tap()
     }
@@ -429,7 +429,7 @@
         XCTAssertEqual(try getMarkerFileContents(type: .onSubmitError), "io.sentry.error;1;The user did not complete the feedback form.;thine email;thy complaint;thy name")
 
         XCTAssert(app.staticTexts["Error"].exists)
-        XCTAssert(app.staticTexts["You must provide all required information. Please check the following fields: thy name, thine email and thy complaint."].exists)
+        XCTAssert(app.staticTexts.element(matching: NSPredicate(format: "label LIKE 'You must provide all required information before submitting. Please check the following fields: thy name, thine email and thy complaint.'")).exists)
 
         app.buttons["OK"].tap()
     }
@@ -448,7 +448,7 @@
         XCTAssertEqual(try getMarkerFileContents(type: .onSubmitError), "io.sentry.error;1;The user did not complete the feedback form.;description")
 
         XCTAssert(app.staticTexts["Error"].exists)
-        XCTAssert(app.staticTexts["You must provide all required information. Please check the following field: description."].exists)
+        XCTAssert(app.staticTexts["You must provide all required information before submitting. Please check the following field: description."].exists)
 
         app.buttons["OK"].tap()
     }
@@ -541,9 +541,9 @@
     func assertFormHookFile(type: HookMarkerFile, exists: Bool) throws {
         let path = try path(for: type)
         if exists {
             XCTAssert(fm.fileExists(atPath: path), "Expected file to exist at \(path)")
         } else {
             XCTAssertFalse(fm.fileExists(atPath: path), "Expected file to not exist at \(path)")
         }
     }
 

Samples/iOS-Swift/iOS-Swift.xcodeproj/project.pbxproj

@@ -1533,6 +1533,7 @@
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match Development io.sentry.iOS-SwiftUITests.xctrunner";
 				"PROVISIONING_PROFILE_SPECIFIER[sdk=macosx*]" = "";
+				SWIFT_ACTIVE_COMPILATION_CONDITIONS = "SENTRY_UI_TEST $(inherited)";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_TARGET_NAME = "iOS-Swift";
@@ -1557,6 +1558,7 @@
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match AppStore io.sentry.iOS-SwiftUITests.xctrunner";
 				"PROVISIONING_PROFILE_SPECIFIER[sdk=macosx*]" = "";
+				SWIFT_ACTIVE_COMPILATION_CONDITIONS = "SENTRY_UI_TEST $(inherited)";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_TARGET_NAME = "iOS-Swift";
@@ -1723,6 +1725,7 @@
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match Development io.sentry.iOS-SwiftUITests.xctrunner";
 				"PROVISIONING_PROFILE_SPECIFIER[sdk=macosx*]" = "";
+				SWIFT_ACTIVE_COMPILATION_CONDITIONS = "SENTRY_UI_TEST $(inherited)";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_TARGET_NAME = "iOS-Swift";
@@ -1962,6 +1965,7 @@
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				PROVISIONING_PROFILE_SPECIFIER = "match Development io.sentry.iOS-SwiftUITests.xctrunner";
 				"PROVISIONING_PROFILE_SPECIFIER[sdk=macosx*]" = "";
+				SWIFT_ACTIVE_COMPILATION_CONDITIONS = "SENTRY_UI_TEST $(inherited)";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				TEST_TARGET_NAME = "iOS-Swift";

Samples/iOS-Swift/iOS-Swift.xcodeproj/xcshareddata/xcschemes/iOS-Swift.xcscheme

@@ -26,7 +26,8 @@
       buildConfiguration = "Test"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
@@ -127,7 +128,7 @@
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--io.sentry.feedback.all-defaults"
-            isEnabled = "NO">
+            isEnabled = "YES">
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--skip-sentry-init"

Samples/iOS-Swift/iOS-Swift/SentrySDKWrapper.swift

@@ -1,3 +1,5 @@
+// swiftlint:disable file_length
+
 import Sentry
 import UIKit
 
@@ -52,7 +54,7 @@
         options.enableNetworkBreadcrumbs = enableNetworkBreadcrumbs
         options.enableSwizzling = enableSwizzling
         options.enableCrashHandler = enableCrashHandling
         options.enableTracing = enableTracing
         options.enablePersistingTracesWhenCrashing = true
         options.attachScreenshot = enableAttachScreenshot
         options.attachViewHierarchy = enableAttachViewHierarchy
@@ -138,7 +140,6 @@
             } else {
                 config.labelText = "Report Jank"
             }
-            config.widgetAccessibilityLabel = "io.sentry.iOS-Swift.button.report-jank"
             config.layoutUIOffset = layoutOffset
         } else {
             config.autoInject = false
@@ -211,72 +212,94 @@
 
     func configureHooks(config: SentryUserFeedbackConfiguration) {
         config.onFormOpen = {
-            createHookFile(name: "onFormOpen")
+            updateHookMarkers(forEvent: "onFormOpen")
         }
         config.onFormClose = {
-            createHookFile(name: "onFormClose")
+            updateHookMarkers(forEvent: "onFormClose")
         }
         config.onSubmitSuccess = { info in
             let name = info["name"] ?? "$shakespearean_insult_name"
             let alert = UIAlertController(title: "Thanks?", message: "We have enough jank of our own, we really didn't need yours too, \(name).", preferredStyle: .alert)
             alert.addAction(.init(title: "Deal with it 🕶️", style: .default))
             UIApplication.shared.delegate?.window??.rootViewController?.present(alert, animated: true)
-            let jsonData = (try? JSONSerialization.data(withJSONObject: info, options: .sortedKeys)) ?? Data()
-            createHookFile(name: "onSubmitSuccess", with: jsonData.base64EncodedString())
+
+            // if there's a screenshot's Data in this dictionary, JSONSerialization crashes _even though_ there's a `try?`, so we'll write the base64 encoding of it
+            var infoToWriteToFile = info
+            if let attachments = info["attachments"] as? [Any], let screenshot = attachments.first as? Data {
+                infoToWriteToFile["attachments"] = [screenshot.base64EncodedString()]
+            }
+
+            let jsonData = (try? JSONSerialization.data(withJSONObject: infoToWriteToFile, options: .sortedKeys)) ?? Data()
+            updateHookMarkers(forEvent: "onSubmitSuccess", with: jsonData.base64EncodedString())
         }
         config.onSubmitError = { error in
             let alert = UIAlertController(title: "D'oh", message: "You tried to report jank, and encountered more jank. The jank has you now: \(error).", preferredStyle: .alert)
             alert.addAction(.init(title: "Derp", style: .default))
             UIApplication.shared.delegate?.window??.rootViewController?.present(alert, animated: true)
             let nserror = error as NSError
             let missingFieldsSorted = (nserror.userInfo["missing_fields"] as? [String])?.sorted().joined(separator: ";") ?? ""
-            createHookFile(name: "onSubmitError", with: "\(nserror.domain);\(nserror.code);\(nserror.localizedDescription);\(missingFieldsSorted)")
+            updateHookMarkers(forEvent: "onSubmitError", with: "\(nserror.domain);\(nserror.code);\(nserror.localizedDescription);\(missingFieldsSorted)")
         }
     }
 
-    func createHookFile(name: String, with contents: String? = nil) {
+    func updateHookMarkers(forEvent name: String, with contents: String? = nil) {
         guard let appSupportDirectory = NSSearchPathForDirectoriesInDomains(.applicationSupportDirectory, .userDomainMask, true).first else {
             print("[iOS-Swift] Couldn't retrieve path to application support directory.")
             return
         }
 
         let fm = FileManager.default
         let dir = "\(appSupportDirectory)/io.sentry/feedback"
-        do {
-            try fm.createDirectory(atPath: dir, withIntermediateDirectories: true)
-        } catch {
-            print("[iOS-Swift] Couldn't create directory structure for user feedback form hook marker files: \(error).")
-            return
+        let isDirectory = UnsafeMutablePointer<ObjCBool>.allocate(capacity: 1)
+        isDirectory.initialize(to: ObjCBool(false))
+        let exists = fm.fileExists(atPath: dir, isDirectory: isDirectory)
+        if exists, !isDirectory.pointee.boolValue {
+            print("[iOS-Swift] Found a file named \(dir) which is not a directory. Removing it...")
+            do {
+                try fm.removeItem(atPath: dir)
+            } catch {
+                print("[iOS-Swift] Couldn't remove existing file \(dir): \(error).")
+                return
+            }
+        } else if !exists {
+            do {
+                try fm.createDirectory(atPath: dir, withIntermediateDirectories: true)
+            } catch {
+                print("[iOS-Swift] Couldn't create directory structure for user feedback form hook marker files: \(error).")
+                return
+            }
         }
 
-        let path = "\(dir)/\(name)"
+        createHookFile(path: "\(dir)/\(name)", contents: contents)
+
+        switch name {
+        case "onFormOpen": removeHookFile(path: "\(dir)/onFormClose")
+        case "onFormClose": removeHookFile(path: "\(dir)/onFormOpen")
+        case "onSubmitSuccess": removeHookFile(path: "\(dir)/onSubmitError")
+        case "onSubmitError": removeHookFile(path: "\(dir)/onSubmitSuccess")
+        default: fatalError("Unexpected marker file name")
+        }
+    }
+
+    func createHookFile(path: String, contents: String?) {
         if let contents = contents {
             do {
                 try contents.write(to: URL(fileURLWithPath: path), atomically: false, encoding: .utf8)
             } catch {
                 print("[iOS-Swift] Couldn't write contents into user feedback form hook marker file at \(path).")
             }
-        } else if !fm.createFile(atPath: path, contents: nil) {
+        } else if !FileManager.default.createFile(atPath: path, contents: nil) {
             print("[iOS-Swift] Couldn't create user feedback form hook marker file at \(path).")
         } else {
             print("[iOS-Swift] Created user feedback form hook marker file at \(path).")
         }
-
-        func removeHookFile(name: String) {
-            let path = "\(dir)/\(name)"
-            do {
-                try fm.removeItem(atPath: path)
-            } catch {
-                print("[iOS-Swift] Couldn't remove user feedback form hook marker file \(path): \(error).")
-            }
-        }
-
-        switch name {
-        case "onFormOpen": removeHookFile(name: "onFormClose")
-        case "onFormClose": removeHookFile(name: "onFormOpen")
-        case "onSubmitSuccess": removeHookFile(name: "onSubmitError")
-        case "onSubmitError": removeHookFile(name: "onSubmitSuccess")
-        default: fatalError("Unexpected marker file name")
+    }
+
+    func removeHookFile(path: String) {
+        do {
+            try FileManager.default.removeItem(atPath: path)
+        } catch {
+            print("[iOS-Swift] Couldn't remove user feedback form hook marker file \(path): \(error).")
         }
     }
 }
@@ -394,3 +417,5 @@
 
     var enableAppLaunchProfiling: Bool { args.contains("--profile-app-launches") }
 }
+
+// swiftlint:enable file_length