Add sensible defaults for initFatalIssueReporting (#437)

Author: murki

platform/jvm/capture/src/main/kotlin/io/bitdrift/capture/Capture.kt

@@ -102,6 +102,7 @@ object Capture {
         /**
          * Initializes fatal issue (ANR, JVM Crash, Native crash) reporting mechanism.
          *
+         * @param fatalIssueMechanism the [FatalIssueMechanism] to use for crash detection
          * @param context an optional context reference. You should provide the context if called from a [android.content.ContentProvider]
          *
          * This should be called prior to Capture.Logger.start()
@@ -111,8 +112,8 @@ object Capture {
         @JvmStatic
         @JvmOverloads
         fun initFatalIssueReporting(
+            fatalIssueMechanism: FatalIssueMechanism = FatalIssueMechanism.BuiltIn,
             context: Context? = null,
-            fatalIssueMechanism: FatalIssueMechanism,
         ) {
             if (context == null && !ContextHolder.isInitialized) {
                 Log.w(LOG_TAG, "Attempted to initialize Fatal Issue Reporting with a null context. Skipping enabling crash tracking.")

platform/swift/source/Capture.swift

@@ -97,7 +97,7 @@ extension Logger {
     /// This API is experimental and subject to change
     ///
     /// - parameter type: mechanism for crash detection
-    public static func initFatalIssueReporting(_ type: IssueReporterType = .customConfig) {
+    public static func initFatalIssueReporting(_ type: IssueReporterType = .builtIn) {
         if issueReporterInitResult.0 != .notInitialized {
             log(level: .warning, message: "Fatal issue reporting already being initialized")
             return

test/platform/swift/unit_integration/core/FatalIssueReporterTests.swift

@@ -42,7 +42,7 @@ final class FatalIssueReporterTests: XCTestCase {
     }
 
     func testNoConfig() {
-        Logger.initFatalIssueReporting()
+        Logger.initFatalIssueReporting(.customConfig)
         let result = Logger.issueReporterInitResult
         XCTAssertEqual(IssueReporterInitState.initialized(.missingConfigFile), result.0)
 
@@ -53,7 +53,7 @@ final class FatalIssueReporterTests: XCTestCase {
 
     func testNoConfigDir() {
         try! FileManager.default.removeItem(at: reportDir)
-        Logger.initFatalIssueReporting()
+        Logger.initFatalIssueReporting(.customConfig)
         let result = Logger.issueReporterInitResult
         XCTAssertEqual(IssueReporterInitState.initialized(.missingConfigFile), result.0)
 
@@ -64,7 +64,7 @@ final class FatalIssueReporterTests: XCTestCase {
 
     func testBrokenConfig() {
         createConfig("some nonsense")
-        Logger.initFatalIssueReporting()
+        Logger.initFatalIssueReporting(.customConfig)
         let result = Logger.issueReporterInitResult
         XCTAssertEqual(IssueReporterInitState.initialized(.malformedConfigFile), result.0)
 
@@ -79,7 +79,7 @@ final class FatalIssueReporterTests: XCTestCase {
                     directory: "the-files/special",
                     filename: "something.yam",
                     contents: String(repeating: "<stuff>", count: 100))
-        Logger.initFatalIssueReporting()
+        Logger.initFatalIssueReporting(.customConfig)
         let result = Logger.issueReporterInitResult
         XCTAssertEqual(IssueReporterInitState.initialized(.withoutPriorCrash), result.0)
 
@@ -97,7 +97,7 @@ final class FatalIssueReporterTests: XCTestCase {
                     filename: "something.json",
                     contents: initContents,
                     attributes: [.modificationDate: modDate])
-        Logger.initFatalIssueReporting()
+        Logger.initFatalIssueReporting(.customConfig)
         let result = Logger.issueReporterInitResult
         XCTAssertEqual(IssueReporterInitState.initialized(.sent), result.0)
         XCTAssertLessThan(result.1, 50)
@@ -140,7 +140,7 @@ final class FatalIssueReporterTests: XCTestCase {
                     filename: "old-and-ignore.json",
                     contents: String(repeating: "<bad stuff>", count: 100),
                     attributes: [.modificationDate: modDate - TimeInterval(200)])
-        Logger.initFatalIssueReporting()
+        Logger.initFatalIssueReporting(.customConfig)
         let result = Logger.issueReporterInitResult
         XCTAssertEqual(IssueReporterInitState.initialized(.sent), result.0)
         XCTAssertLessThan(result.1, 50)