test: sample app feature flag improvements (#5202)

Author: armcknight

Samples/SentrySampleShared/SentrySampleShared.xcconfig

@@ -30,3 +30,5 @@ CODE_SIGN_IDENTITY =
 CODE_SIGN_IDENTITY[sdk=macosx*] =
 PROVISIONING_PROFILE_SPECIFIER =
 DEVELOPMENT_TEAM =
+
+TARGETED_DEVICE_FAMILY = 1,2,3,4,7

Samples/iOS-Swift/iOS-Swift/Tools/DSNDisplayViewController.swift renamed to Samples/SentrySampleShared/SentrySampleShared/DSNDisplayViewController.swift

@@ -1,15 +1,10 @@
-import SentrySampleShared
+#if !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)
+
+import Sentry
 import UIKit
 
 let fontSize: CGFloat = 12
 
-func addDSNDisplay(_ vc: UIViewController, vcview: UIView) {
-    let dsnVC = DSNDisplayViewController(nibName: nil, bundle: nil)
-    vcview.addSubview(dsnVC.view)
-    dsnVC.view.matchEdgeAnchors(from: vcview)
-    vc.addChild(dsnVC)
-}
-
 class DSNDisplayViewController: UIViewController {
     let dispatchQueue = DispatchQueue(label: "io.sentry.iOS-Swift.queue.dsn-management", attributes: .concurrent)
     let label = UILabel(frame: .zero)
@@ -48,7 +43,7 @@ class DSNDisplayViewController: UIViewController {
         ])
 
         view.addSubview(stack)
-        stack.matchEdgeAnchors(from: view, leadingPad: 20)
+        stack.matchEdgeAnchors(from: view)
         buttonStack.translatesAutoresizingMaskIntoConstraints = false
         buttonStack.widthAnchor.constraint(equalTo: view.widthAnchor, multiplier: 0.3).isActive = true
     }
@@ -172,3 +167,5 @@ class DSNDisplayViewController: UIViewController {
         return attributedString
     }
 }
+
+#endif // !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)

Samples/SentrySampleShared/SentrySampleShared/EnvironmentVariableTableViewCell.swift

@@ -18,7 +18,7 @@ class EnvironmentVariableTableViewCell: UITableViewCell, UITextFieldDelegate {
         let stack = UIStackView(arrangedSubviews: [valueField, titleLabel])
         stack.spacing = 8
         contentView.addSubview(stack)
-        stack.matchEdgeAnchors(from: contentView, topPad: 8, bottomPad: 8)
+        stack.matchEdgeAnchors(from: contentView)
 
         valueField.borderStyle = .roundedRect
     }
@@ -50,6 +50,7 @@ class EnvironmentVariableTableViewCell: UITableViewCell, UITextFieldDelegate {
         } else {
             override?.stringValue = textField.text
         }
+        SentrySDKWrapper.shared.startSentry()
     }
 }
 #endif // !os(macOS) && !os(tvOS) && !os(watchOS)

Samples/SentrySampleShared/SentrySampleShared/FeaturesViewController.swift

@@ -1,15 +1,29 @@
-#if !os(macOS) && !os(tvOS) && !os(watchOS)
+#if !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)
 import UIKit
 
-public class FeaturesViewController: UITableViewController {
-    public override func viewDidLoad() {
-        super.viewDidLoad()
+public class FeaturesViewController: UIViewController {
+    let tableView = UITableView(frame: .zero, style: .plain)
+
+    public override init(nibName nibNameOrNil: String?, bundle nibBundleOrNil: Bundle?) {
+        super.init(nibName: nibNameOrNil, bundle: nibBundleOrNil)
+
         tableView.register(LaunchArgumentTableViewCell.self, forCellReuseIdentifier: "launchArgumentCell")
         tableView.register(EnvironmentVariableTableViewCell.self, forCellReuseIdentifier: "environmentVariableCell")
-        tableView.tableHeaderView = tableHeader
+        tableView.dataSource = self
+
+        let stack = UIStackView(arrangedSubviews: [headerView, tableView])
+        stack.axis = .vertical
+        view.addSubview(stack)
+        stack.matchEdgeAnchors(from: view, safeArea: true)
+
+        view.backgroundColor = .white
     }
 
-    var tableHeader: UIView {
+    required init?(coder: NSCoder) {
+        fatalError("init(coder:) not supported")
+    }
+
+    var headerView: UIView {
         let resetButton = UIButton(type: .custom)
         resetButton.setTitle("Reset Defaults", for: .normal)
         resetButton.setTitleColor(.blue, for: .normal)
@@ -18,28 +32,29 @@ public class FeaturesViewController: UITableViewController {
         let label = UILabel(frame: .zero)
         label.text = SentrySDKOverrides.schemaPrecedenceForEnvironmentVariables ? "Schema Precedence" : "Defaults Precedence"
 
-        let stack = UIStackView(arrangedSubviews: [label, resetButton])
-        stack.spacing = 8
+        let hstack = UIStackView(arrangedSubviews: [label, resetButton])
+        hstack.spacing = 8
 
-        let header = UIView(frame: .zero)
-        header.addSubview(stack)
+        let dsnVC = DSNDisplayViewController(nibName: nil, bundle: nil)
+        addChild(dsnVC)
 
-        stack.matchEdgeAnchors(from: header)
-        header.heightAnchor.constraint(equalToConstant: 50).isActive = true
-        
-        return header
+        let vStack = UIStackView(arrangedSubviews: [dsnVC.view, hstack])
+        vStack.axis = .vertical
+        return vStack
     }
 
     @objc func resetDefaults() {
         SentrySDKOverrides.resetDefaults()
         tableView.reloadData()
     }
+}
 
-    public override func numberOfSections(in tableView: UITableView) -> Int {
+extension FeaturesViewController: UITableViewDataSource {
+    public func numberOfSections(in tableView: UITableView) -> Int {
         6
     }
 
-    public override func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
+    public func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
         if section == 0 {
             return "Special"
         } else if section == 1 {
@@ -56,7 +71,7 @@ public class FeaturesViewController: UITableViewController {
         return nil
     }
 
-    public override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
+    public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
         if section == 0 {
             return SentrySDKOverrides.Special.allCases.count
         } else if section == 1 {
@@ -73,7 +88,7 @@ public class FeaturesViewController: UITableViewController {
         return 0
     }
 
-    public override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
+    public func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
         if indexPath.section == 2 {
             if SentrySDKOverrides.Tracing.boolValues.contains(SentrySDKOverrides.Tracing.allCases[indexPath.row]) {
                 let cell = tableView.dequeueReusableCell(withIdentifier: "launchArgumentCell", for: indexPath) as! LaunchArgumentTableViewCell
@@ -117,4 +132,4 @@ public class FeaturesViewController: UITableViewController {
         return cell
     }
 }
-#endif // !os(macOS) && !os(tvOS) && !os(watchOS)
+#endif // !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)

Samples/SentrySampleShared/SentrySampleShared/LaunchArgumentTableViewCell.swift

@@ -12,14 +12,15 @@ class LaunchArgumentTableViewCell: UITableViewCell {
 
     @objc func toggleFlag() {
         override?.boolValue = flagSwitch.isOn
+        SentrySDKWrapper.shared.startSentry()
     }
 
     override init(style: UITableViewCell.CellStyle, reuseIdentifier: String?) {
         super.init(style: style, reuseIdentifier: reuseIdentifier)
         let stack = UIStackView(arrangedSubviews: [flagSwitch, titleLabel])
         stack.spacing = 8
         contentView.addSubview(stack)
-        stack.matchEdgeAnchors(from: contentView, topPad: 8, bottomPad: 8)
+        stack.matchEdgeAnchors(from: contentView)
     }
 
     required init?(coder: NSCoder) {

Samples/SentrySampleShared/SentrySampleShared/SampleAppDebugMenu.swift

@@ -0,0 +1,92 @@
+#if !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)
+import UIKit
+
+public class SampleAppDebugMenu: NSObject {
+    public static let shared = SampleAppDebugMenu()
+
+    static var displayingForm = false
+
+    let window = {
+        if #available(iOS 13.0, *) {
+            if let scene = UIApplication.shared.connectedScenes.first as? UIWindowScene {
+                return Window(windowScene: scene)
+            }
+        }
+        return Window()
+    }()
+
+    lazy var rootVC = {
+        let uivc = UIViewController(nibName: nil, bundle: nil)
+        uivc.view.addSubview(button)
+
+        button.translatesAutoresizingMaskIntoConstraints = false
+        NSLayoutConstraint.activate([
+            button.leadingAnchor.constraint(equalTo: uivc.view.safeAreaLayoutGuide.leadingAnchor, constant: 25),
+            button.bottomAnchor.constraint(equalTo: uivc.view.safeAreaLayoutGuide.bottomAnchor, constant: -75)
+        ])
+
+        return uivc
+    }()
+
+    lazy var button = {
+        let button = UIButton(type: .custom)
+        button.addTarget(self, action: #selector(displayDebugMenu), for: .touchUpInside)
+        button.setTitle("SDK Debug", for: .normal)
+        button.setTitleColor(.blue, for: .normal)
+        return button
+    }()
+
+    @objc public func display() {
+        window.rootViewController = rootVC
+        window.isHidden = false
+    }
+
+    @objc func displayDebugMenu() {
+        SampleAppDebugMenu.displayingForm = true
+        rootVC.present(FeaturesViewController(nibName: nil, bundle: nil), animated: true)
+    }
+
+    class Window: UIWindow {
+
+        @available(iOS 13.0, *)
+        override init(windowScene: UIWindowScene) {
+            super.init(windowScene: windowScene)
+            commonInit()
+        }
+
+        init() {
+            super.init(frame: UIScreen.main.bounds)
+            commonInit()
+        }
+
+        func commonInit() {
+            windowLevel = UIWindow.Level.alert + 1
+        }
+
+        required init?(coder: NSCoder) {
+            fatalError("init(coder:) has not been implemented")
+        }
+
+        override func hitTest(_ point: CGPoint, with event: UIEvent?) -> UIView? {
+            guard !SampleAppDebugMenu.displayingForm else {
+                return super.hitTest(point, with: event)
+            }
+
+            guard let result = super.hitTest(point, with: event) else {
+                return nil
+            }
+            guard result.isKind(of: UIButton.self) else {
+                return nil
+            }
+            return result
+        }
+    }
+}
+
+extension SampleAppDebugMenu: UIAdaptivePresentationControllerDelegate {
+    public func presentationControllerDidDismiss(_ presentationController: UIPresentationController) {
+        rootVC.dismiss(animated: true)
+        SampleAppDebugMenu.displayingForm = false
+    }
+}
+#endif // !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)

Samples/SentrySampleShared/SentrySampleShared/SentrySDKOverrides.swift

@@ -33,6 +33,7 @@ public enum SentrySDKOverrides {
     public enum Special: String, SentrySDKOverride {
         case wipeDataOnLaunch = "--io.sentry.wipe-data"
         case disableEverything = "--io.sentry.disable-everything"
+        case skipSDKInit = "--skip-sentry-init"
 
         public var boolValue: Bool {
             get {

Samples/SentrySampleShared/SentrySampleShared/SentrySDKWrapper.swift

@@ -21,7 +21,14 @@ public struct SentrySDKWrapper {
 #endif // !os(macOS) && !os(tvOS)  && !os(watchOS)
 
     public func startSentry() {
-        SentrySDK.start(configureOptions: configureSentryOptions(options:))
+        if SentrySDK.isEnabled {
+            print("SentrySDK already enabled, closing it")
+            SentrySDK.close()
+        }
+
+        if !SentrySDKOverrides.Special.skipSDKInit.boolValue {
+            SentrySDK.start(configureOptions: configureSentryOptions(options:))
+        }
     }
 
     func configureSentryOptions(options: Options) {
@@ -382,15 +389,11 @@ extension SentrySDKWrapper {
     public static let defaultDSN = "https://[email protected]/5428557"
 
     var args: [String] {
-        let args = ProcessInfo.processInfo.arguments
-        print("[iOS-Swift] [debug] launch arguments: \(args)")
-        return args
+        return ProcessInfo.processInfo.arguments
     }
 
     var env: [String: String] {
-        let env = ProcessInfo.processInfo.environment
-        print("[iOS-Swift] [debug] environment: \(env)")
-        return env
+        return ProcessInfo.processInfo.environment
     }
 
     /// For testing purposes, we want to be able to change the DSN and store it to disk. In a real app, you shouldn't need this behavior.

Samples/iOS-Swift/iOS-Swift/Tools/Toasts.swift renamed to Samples/SentrySampleShared/SentrySampleShared/Toasts.swift

@@ -1,3 +1,5 @@
+#if !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)
+
 import UIKit
 
 public enum ToastType {
@@ -40,3 +42,5 @@ public func showToast(in vc: UIViewController, type: ToastType, message: String)
         }
     }
 }
+
+#endif // !os(macOS) && !os(tvOS) && !os(watchOS) && !os(visionOS)

Samples/SentrySampleShared/SentrySampleShared/UIViewExtension.swift

@@ -11,14 +11,15 @@ public extension UIView {
         return self
     }
 
-    func matchEdgeAnchors(from other: UIView, leadingPad: CGFloat = 0, trailingPad: CGFloat = 0, topPad: CGFloat = 0, bottomPad: CGFloat = 0) {
+    func matchEdgeAnchors(from other: UIView, leadingPad: CGFloat = 0, trailingPad: CGFloat = 0, topPad: CGFloat = 0, bottomPad: CGFloat = 0, safeArea: Bool = false) {
         self.translatesAutoresizingMaskIntoConstraints = false
         other.translatesAutoresizingMaskIntoConstraints = false
+        let layoutGuide = safeArea ? other.safeAreaLayoutGuide : other.layoutMarginsGuide
         NSLayoutConstraint.activate([
-            leadingAnchor.constraint(equalTo: other.leadingAnchor, constant: leadingPad),
-            trailingAnchor.constraint(equalTo: other.trailingAnchor, constant: -trailingPad),
-            topAnchor.constraint(equalTo: other.topAnchor, constant: topPad),
-            bottomAnchor.constraint(equalTo: other.bottomAnchor, constant: -bottomPad)
+            leadingAnchor.constraint(equalTo: layoutGuide.leadingAnchor, constant: leadingPad),
+            trailingAnchor.constraint(equalTo: layoutGuide.trailingAnchor, constant: -trailingPad),
+            topAnchor.constraint(equalTo: layoutGuide.topAnchor, constant: topPad),
+            bottomAnchor.constraint(equalTo: layoutGuide.bottomAnchor, constant: -bottomPad)
         ])
     }
 }