feat: implement automatic crash reporting

Author: VictorB00

.github/workflows/test-flutter.yaml

@@ -27,5 +27,27 @@ jobs:
       - name: Set up Flutter
         uses: ./.github/actions/setup-flutter
 
+      - name: Check version consistency
+        run: |
+          # Extract version from pubspec.yaml
+          PUBSPEC_VERSION=$(grep '^version:' pubspec.yaml | sed 's/version: //' | tr -d ' ')
+
+          # Extract version from lib/version.dart
+          VERSION_DART=$(grep 'const String nativebrikFlutterSdkVersion' lib/version.dart | sed "s/.*'\(.*\)'.*/\1/")
+
+          echo "pubspec.yaml version: $PUBSPEC_VERSION"
+          echo "lib/version.dart version: $VERSION_DART"
+
+          if [ "$PUBSPEC_VERSION" != "$VERSION_DART" ]; then
+            echo "Error: Version mismatch between pubspec.yaml ($PUBSPEC_VERSION) and lib/version.dart ($VERSION_DART)"
+            echo "Please run 'make bump-version VERSION=x.y.z' to update both versions consistently"
+            exit 1
+          fi
+
+          echo "Version consistency check passed"
+
+      - name: Run tests
+        run: flutter test
+
       - name: Validate package
         run: dart pub publish --dry-run

CHANGELOG.md

@@ -1,3 +1,46 @@
+## 0.14.0
+
+- **Breaking Change**: Crash reporting is now automatic
+    - Crash reporting is enabled by default when you initialize `NativebrikBridge`
+    - Manual crash reporting setup is no longer needed
+    - `NativebrikCrashReport` class is deprecated and will be removed in a future version
+    - To opt-out: `NativebrikBridge("PROJECT_ID", trackCrashes: false)`
+
+- **Migration Guide**:
+    - **Before**:
+      ```dart
+      void main() {
+        runZonedGuarded(() {
+          WidgetsFlutterBinding.ensureInitialized();
+          NativebrikBridge("PROJECT_ID");
+          FlutterError.onError = (errorDetails) {
+            NativebrikCrashReport.instance.recordFlutterError(errorDetails);
+          };
+          PlatformDispatcher.instance.onError = (error, stack) {
+            NativebrikCrashReport.instance.recordPlatformError(error, stack);
+            return true;
+          };
+          runApp(const MyApp());
+        }, (error, stack) {
+          NativebrikCrashReport.instance.recordPlatformError(error, stack);
+        });
+      }
+      ```
+    - **After**:
+      ```dart
+      void main() {
+        WidgetsFlutterBinding.ensureInitialized();
+        NativebrikBridge("PROJECT_ID"); // Crash tracking enabled by default
+        runApp(const MyApp());
+      }
+      ```
+
+- Update Dependencies
+    - iOS: Nubrick 0.13.0 → 0.14.1
+    - Android: Nubrick 0.8.0 → 0.8.2
+    - Removed Yoga dependency (cleaner dependency tree)
+    - Added stack_trace package for improved crash report parsing
+
 ## 0.13.1
 
 - Enhance tooltip feature
@@ -10,13 +53,8 @@
     - io.nubrick:nubrick to 0.8.1
     - Nubrick to 0.14.0
 
-
 ## 0.12.0
 
-- Update iOS dependencies
-    - Bump version to 0.13.0
-    - Restore CocoaPods support
-
 ## 0.11.0
 
 - Update Dependencies

Makefile

@@ -23,6 +23,7 @@ reinstall-android:
 define bump_version
 	@NEW_VERSION=$$(echo "$(VERSION)" | awk -F. '{print $(1)}') && \
 	sed -i '' "s/^version: .*/version: $$NEW_VERSION/" pubspec.yaml && \
+	sed -i '' "s/const String nativebrikFlutterSdkVersion = '.*'/const String nativebrikFlutterSdkVersion = '$$NEW_VERSION'/" lib/version.dart && \
 	echo "\n## $$NEW_VERSION\n\n- " >> CHANGELOG.md;
 	make install
 endef

android/build.gradle

@@ -58,7 +58,7 @@ android {
     }
 
     dependencies {
-        implementation 'io.nubrick:nubrick:0.8.1'
+        implementation 'io.nubrick:nubrick:0.8.2'
         implementation 'androidx.activity:activity-compose:1.8.2'
         testImplementation 'org.jetbrains.kotlin:kotlin-test'
         testImplementation 'org.mockito:mockito-core:5.0.0'

android/src/main/kotlin/com/nativebrik/flutter/nativebrik_bridge/Manager.kt

@@ -1,9 +1,13 @@
 package com.nativebrik.flutter.nativebrik_bridge
 
 import android.content.Context
+import io.nubrick.nubrick.FlutterBridgeApi
 import io.nubrick.nubrick.NubrickClient
 import io.nubrick.nubrick.__DO_NOT_USE_THIS_INTERNAL_BRIDGE
+import io.nubrick.nubrick.data.ExceptionRecord
 import io.nubrick.nubrick.data.NotFoundException
+import io.nubrick.nubrick.data.StackFrame
+import io.nubrick.nubrick.data.TrackCrashEvent
 import io.flutter.plugin.platform.PlatformView
 import io.flutter.plugin.platform.PlatformViewFactory
 import io.flutter.plugin.common.StandardMessageCodec
@@ -25,6 +29,7 @@ import kotlinx.coroutines.launch
 
 internal data class ConfigEntity(val variant: RemoteConfigVariant?, val experimentId: String?)
 
+@OptIn(FlutterBridgeApi::class)
 internal class NativebrikBridgeManager(private val binaryMessenger: BinaryMessenger) {
     private var nativebrikClient: NubrickClient? = null
     private var bridgeClient: __DO_NOT_USE_THIS_INTERNAL_BRIDGE? = null
@@ -214,12 +219,54 @@ internal class NativebrikBridgeManager(private val binaryMessenger: BinaryMessen
     }
 
     /**
-     * Records a crash with the given throwable.
+     * Records exceptions from Flutter.
      *
-     * This method forwards the throwable to the Nativebrik SDK for crash reporting.
+     * This method constructs a crash event and forwards it to the Nativebrik SDK for crash reporting
+     * with platform set to "flutter".
      */
-    fun recordCrash(throwable: Throwable) {
-        this.nativebrikClient?.experiment?.record(throwable)
+    fun recordFlutterExceptions(exceptionsList: List<Map<String, Any?>>, flutterSdkVersion: String?) {
+        try {
+            val exceptions = exceptionsList.mapNotNull { exceptionMap ->
+                try {
+                    val type = exceptionMap["type"] as? String
+                    val message = exceptionMap["message"] as? String
+                    val callStacksList = exceptionMap["callStacks"] as? List<*>
+
+                    val callStacks = callStacksList?.mapNotNull { frameMap ->
+                        try {
+                            val frame = frameMap as? Map<*, *>
+                            StackFrame(
+                                fileName = frame?.get("fileName") as? String,
+                                className = frame?.get("className") as? String,
+                                methodName = frame?.get("methodName") as? String,
+                                lineNumber = (frame?.get("lineNumber") as? Number)?.toInt()
+                            )
+                        } catch (e: Exception) {
+                            null
+                        }
+                    }
+
+                    ExceptionRecord(
+                        type = type,
+                        message = message,
+                        callStacks = callStacks
+                    )
+                } catch (e: Exception) {
+                    null
+                }
+            }
+
+            if (exceptions.isNotEmpty()) {
+                val crashEvent = TrackCrashEvent(
+                    exceptions = exceptions,
+                    platform = "flutter",
+                    flutterSdkVersion = flutterSdkVersion
+                )
+                this.nativebrikClient?.experiment?.sendFlutterCrash(crashEvent)
+            }
+        } catch (e: Exception) {
+            // Silently fail to avoid causing crashes in error reporting
+        }
     }
 }
 

android/src/main/kotlin/com/nativebrik/flutter/nativebrik_bridge/NativebrikBridgePlugin.kt

@@ -200,17 +200,22 @@ class NativebrikBridgePlugin: FlutterPlugin, MethodCallHandler {
             }
             "recordCrash" -> {
                 try {
-                    val errorData = call.arguments as Map<*, *>
-                    val exception = errorData["exception"] as String
-                    val stackTrace = errorData["stack"] as String
+                    val errorData = call.arguments as? Map<*, *>
+                    if (errorData == null) {
+                        result.error("CRASH_REPORT_ERROR", "Invalid error data format", null)
+                        return
+                    }
 
-                    // Create a throwable with the Flutter error information
-                    val throwable = Throwable(exception).apply {
-                        this.stackTrace = parseStackTraceElements(stackTrace)
+                    val exceptionsList = errorData["exceptions"] as? List<*>
+                    if (exceptionsList == null) {
+                        result.error("CRASH_REPORT_ERROR", "Missing exceptions list", null)
+                        return
                     }
 
-                    // Record the crash using the Nativebrik SDK
-                    this.manager.recordCrash(throwable)
+                    val exceptions = exceptionsList.mapNotNull { it as? Map<*, *> }
+                        .map { it.mapKeys { entry -> entry.key.toString() } }
+                    val flutterSdkVersion = errorData["flutterSdkVersion"] as? String
+                    this.manager.recordFlutterExceptions(exceptions, flutterSdkVersion)
                     result.success("ok")
                 } catch (e: Exception) {
                     result.error("CRASH_REPORT_ERROR", "Failed to record crash: ${e.message}", null)

e2e/ios/Flutter/AppFrameworkInfo.plist

@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>12.0</string>
+  <string>13.0</string>
 </dict>
 </plist>

e2e/ios/Podfile

@@ -1,5 +1,5 @@
 # Uncomment this line to define a global platform for your project
-# platform :ios, '12.0'
+# platform :ios, '13.0'
 
 # CocoaPods analytics sends network stats synchronously affecting flutter build latency.
 ENV['COCOAPODS_DISABLE_STATS'] = 'true'

e2e/ios/Podfile.lock

@@ -1,16 +1,27 @@
 PODS:
   - Flutter (1.0.0)
+  - nativebrik_bridge (0.0.1):
+    - Flutter
+    - Nubrick (= 0.14.1)
+  - Nubrick (0.14.1)
 
 DEPENDENCIES:
   - Flutter (from `Flutter`)
+  - nativebrik_bridge (from `.symlinks/plugins/nativebrik_bridge/ios`)
+
+SPEC REPOS:
+  trunk:
+    - Nubrick
 
 EXTERNAL SOURCES:
   Flutter:
     :path: Flutter
 
 SPEC CHECKSUMS:
-  Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
+  Flutter: cabc95a1d2626b1b06e7179b784ebcf0c0cde467
+  nativebrik_bridge: 07c281be5ad485adf32670ccd554e9e839e4cf7c
+  Nubrick: 4d4a94ddcc67597abea0552deedeff817ac4bc96
 
-PODFILE CHECKSUM: 4305caec6b40dde0ae97be1573c53de1882a07e5
+PODFILE CHECKSUM: 3c63482e143d1b91d2d2560aee9fb04ecc74ac7e
 
 COCOAPODS: 1.16.2

e2e/ios/Runner.xcodeproj/project.pbxproj

@@ -444,7 +444,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SUPPORTED_PLATFORMS = iphoneos;
@@ -579,7 +579,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
@@ -630,7 +630,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 13.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SUPPORTED_PLATFORMS = iphoneos;