Merge pull request #162 from bugsnag/releases/v2.2.0

v2.2.0 Release
bugsnag · Aug 3, 2022 · 4e7e7c9 · 4e7e7c9
2 parents ec25daa + 963067b
commit 4e7e7c9
Show file tree

Hide file tree

Showing 44 changed files with 379 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## 2.2.0 (2022-08-03)
+
+- Added `telemetry` option to `bugsnag.start` to allow sending of internal errors to be disabled.
+- Update bugsnag-android from v5.23.1 to [v5.25.0](https://github.com/bugsnag/bugsnag-android/blob/master/CHANGELOG.md#5250-2022-07-19)
+- Update bugsnag-cocoa from v6.18.1 to [v6.21.0](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CHANGELOG.md#6210-2022-07-20)
+- Fixed 'Unhandled Exception' in JSON encoding of metadata containing list objects
+  [#160](https://github.com/bugsnag/bugsnag-flutter/pull/160)
+- Add specific handling for 'invalid Dart instruction address' native stack frames
+  [#161](https://github.com/bugsnag/bugsnag-flutter/pull/161)
+
 ## 2.1.1 (2022-06-28)
 
 - Added `BugsnagFlutterConfiguration` to allow `bugsnag.attach` behaviour to be configured from native code.

diff --git a/examples/native/android/app/src/main/AndroidManifest.xml b/examples/native/android/app/src/main/AndroidManifest.xml
@@ -11,9 +11,7 @@
         android:theme="@style/Theme.BugsnagFlutter"
         android:name=".ExampleApp"
         tools:targetApi="31">
-        <meta-data
-            android:name="com.bugsnag.android.API_KEY"
-            android:value="your-api-key-here" />
+
         <activity
             android:name=".MainActivity"
             android:exported="true"
@@ -30,6 +28,10 @@
             android:hardwareAccelerated="true"
             android:windowSoftInputMode="adjustResize"
             />
+
+        <meta-data
+            android:name="com.bugsnag.android.API_KEY"
+            android:value="your-api-key-here" />
     </application>
 
 </manifest>
diff --git a/examples/native/android/app/src/main/java/com/example/bugsnag/flutter/android/ExampleApp.kt b/examples/native/android/app/src/main/java/com/example/bugsnag/flutter/android/ExampleApp.kt
@@ -2,14 +2,20 @@ package com.example.bugsnag.flutter.android
 
 import android.app.Application
 import com.bugsnag.android.Bugsnag
+import com.bugsnag.android.Configuration
 import com.bugsnag.flutter.BugsnagFlutterConfiguration
 
 class ExampleApp : Application() {
     override fun onCreate() {
         super.onCreate()
 
+        val config = Configuration.load(this)
+
+        // Add the names of Dart packages that should be displayed as "in-project" on your dashboard
+        config.projectPackages = setOf(packageName, "example_flutter")
+
         // Start Bugsnag Android SDK
-        Bugsnag.start(this)
+        Bugsnag.start(this, config)
 
         // Uncomment to disable automatic detection of Dart errors:
         // BugsnagFlutterConfiguration.enabledErrorTypes.dartErrors = false

diff --git a/...ples/native/android/app/src/main/java/com/example/bugsnag/flutter/android/MainActivity.kt b/...ples/native/android/app/src/main/java/com/example/bugsnag/flutter/android/MainActivity.kt
@@ -16,4 +16,8 @@ class MainActivity : AppCompatActivity() {
     fun showFlutterView(view: View) {
         startActivity(FlutterActivity.createDefaultIntent(applicationContext))
     }
+
+    fun unhandledException(view: View) {
+        throw RuntimeException("this is an unhandled crash")
+    }
 }
diff --git a/examples/native/android/app/src/main/res/layout/activity_main.xml b/examples/native/android/app/src/main/res/layout/activity_main.xml
@@ -26,16 +26,27 @@
         android:layout_height="match_parent">
 
         <Button
-            android:id="@+id/button_first"
+            android:id="@+id/showFlutter"
             android:layout_width="wrap_content"
             android:layout_height="wrap_content"
-            android:text="Show Flutter"
             android:onClick="showFlutterView"
+            android:text="Show Flutter"
             app:layout_constraintBottom_toBottomOf="parent"
             app:layout_constraintEnd_toEndOf="parent"
             app:layout_constraintStart_toStartOf="parent"
             app:layout_constraintTop_toTopOf="parent" />
 
+        <Button
+            android:id="@+id/unhandledException"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:layout_marginTop="8dp"
+            android:onClick="unhandledException"
+            android:text="Throw Unhandled Exception"
+            app:layout_constraintEnd_toEndOf="parent"
+            app:layout_constraintStart_toStartOf="parent"
+            app:layout_constraintTop_toBottomOf="@id/showFlutter" />
+
     </androidx.constraintlayout.widget.ConstraintLayout>
 
 </androidx.coordinatorlayout.widget.CoordinatorLayout>
diff --git a/examples/native/example_flutter/lib/main.dart b/examples/native/example_flutter/lib/main.dart
@@ -9,9 +9,14 @@ class MyApp extends StatelessWidget {
   const MyApp({Key? key}) : super(key: key);
 
   @override
-  Widget build(BuildContext context) => const MaterialApp(
+  Widget build(BuildContext context) => MaterialApp(
         title: 'Bugsnag Flutter Example',
-        home: ExampleHomeScreen(),
+        initialRoute: '/',
+        navigatorObservers: [BugsnagNavigatorObserver()],
+        routes: {
+          '/': (context) => const ExampleHomeScreen(),
+          '/login': (context) => LoginScreen(),
+        },
       );
 }
 
@@ -43,7 +48,7 @@ class ExampleHomeScreen extends StatelessWidget {
   // Use leaveBreadcrumb() to log potentially useful events in order to
   // understand what happened in your app before each error.
   void _leaveBreadcrumb() async =>
-      bugsnag.leaveBreadcrumb('This is a custom breadcrumb',
+      bugsnag.leaveBreadcrumb('This is a custom breadcrumb from Flutter',
           // Additional data can be attached to breadcrumbs as metadata
           metadata: {'from': 'a', 'to': 'z'});
 
@@ -76,15 +81,6 @@ class ExampleHomeScreen extends StatelessWidget {
               onPressed: _handledException,
               child: const Text('Notify Handled Error'),
             ),
-            ElevatedButton(
-              child: const Text('Native Errors'),
-              onPressed: () {
-                Navigator.pushNamed(context, '/native-crashes');
-              },
-              style: ElevatedButton.styleFrom(
-                primary: Colors.redAccent.shade200,
-              ),
-            ),
             Padding(
               padding: const EdgeInsets.symmetric(vertical: 16),
               child: Text(
@@ -96,9 +92,57 @@ class ExampleHomeScreen extends StatelessWidget {
               onPressed: _leaveBreadcrumb,
               child: const Text('Leave a breadcrumb'),
             ),
+            ElevatedButton(
+              onPressed: () async {
+                final email = await Navigator.of(context).pushNamed('/login');
+                ScaffoldMessenger.of(context).showSnackBar(SnackBar(
+                  content: Text('User logged in as $email'),
+                ));
+              },
+              child: const Text('Login (bugsnag.setUser)'),
+            ),
           ],
         ),
       ),
     );
   }
 }
+
+class LoginScreen extends StatelessWidget {
+  final TextEditingController _email = TextEditingController();
+
+  LoginScreen({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text('Login'),
+      ),
+      body: Center(
+        child: Padding(
+          padding: const EdgeInsets.symmetric(horizontal: 16),
+          child: Column(
+            children: [
+              TextField(
+                controller: _email,
+                decoration: const InputDecoration(
+                  labelText: 'Email Address',
+                ),
+              ),
+              ElevatedButton(
+                onPressed: () async {
+                  bugsnag.setUser(email: _email.value.text);
+                  bugsnag.leaveBreadcrumb('User has logged in');
+
+                  Navigator.of(context).pop(_email.value.text);
+                },
+                child: const Text('Login'),
+              ),
+            ],
+          ),
+        ),
+      ),
+    );
+  }
+}
diff --git a/examples/native/ios/BugsnagFlutter.xcodeproj/project.pbxproj b/examples/native/ios/BugsnagFlutter.xcodeproj/project.pbxproj
@@ -167,7 +167,7 @@
 			name = "[CP-User] Run Flutter Build example_flutter Script";
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "set -e\nset -u\nsource \"${SRCROOT}/../example_flutter/.ios/Flutter/flutter_export_environment.sh\"\nexport VERBOSE_SCRIPT_LOGGING=1 && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/xcode_backend.sh build\n";
+			shellScript = "set -e\nset -u\nsource \"${SRCROOT}/../example_flutter/.ios/Flutter/flutter_export_environment.sh\"\nexport VERBOSE_SCRIPT_LOGGING=1 && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/xcode_backend.sh build";
 		};
 		E89B3AC476390C585D0BE274 /* [CP] Embed Pods Frameworks */ = {
 			isa = PBXShellScriptBuildPhase;

diff --git a/examples/native/ios/BugsnagFlutter/AppDelegate.swift b/examples/native/ios/BugsnagFlutter/AppDelegate.swift
@@ -17,6 +17,9 @@ class AppDelegate: FlutterAppDelegate {
         // Start Bugsnag iOS SDK
         Bugsnag.start()
 
+        // Specify the names of Dart packages that should be displayed as "in-project" on your dashboard.
+        BugsnagFlutterConfiguration.projectPackages = ["example_flutter"];
+
         // Uncomment to disable automatic detection of Dart errors:
         // BugsnagFlutterConfiguration.enabledErrorTypes.dartErrors = false
 

diff --git a/examples/native/ios/BugsnagFlutter/Base.lproj/Main.storyboard b/examples/native/ios/BugsnagFlutter/Base.lproj/Main.storyboard
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="20037" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="BYZ-38-t0r">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="19529" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="BYZ-38-t0r">
     <device id="retina6_1" orientation="portrait" appearance="light"/>
     <dependencies>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="20020"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="19519"/>
         <capability name="Safe area layout guides" minToolsVersion="9.0"/>
         <capability name="System colors in document resources" minToolsVersion="11.0"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
@@ -30,13 +30,22 @@
                                     <action selector="showFlutter" destination="BYZ-38-t0r" eventType="touchUpInside" id="lc4-pn-mps"/>
                                 </connections>
                             </button>
+                            <button opaque="NO" contentMode="scaleToFill" ambiguous="YES" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="system" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="uOG-q7-gNr">
+                                <rect key="frame" x="138" y="471.5" width="141" height="31"/>
+                                <state key="normal" title="Button"/>
+                                <buttonConfiguration key="configuration" style="filled" title="Trigger Fatal Error"/>
+                                <connections>
+                                    <action selector="unhandledError" destination="BYZ-38-t0r" eventType="touchUpInside" id="0Rr-LM-yLl"/>
+                                </connections>
+                            </button>
                         </subviews>
                         <viewLayoutGuide key="safeArea" id="6Tk-OE-BBY"/>
                         <color key="backgroundColor" systemColor="systemBackgroundColor"/>
                         <constraints>
                             <constraint firstItem="uQu-uc-Imx" firstAttribute="centerX" secondItem="8bC-Xf-vdC" secondAttribute="centerX" id="1Ls-Rs-AB1"/>
                             <constraint firstItem="yfB-10-brY" firstAttribute="top" secondItem="6Tk-OE-BBY" secondAttribute="top" constant="16" id="4TH-EX-e1q"/>
                             <constraint firstItem="yfB-10-brY" firstAttribute="centerX" secondItem="8bC-Xf-vdC" secondAttribute="centerX" id="Crp-8Q-lNX"/>
+                            <constraint firstItem="uOG-q7-gNr" firstAttribute="top" secondItem="uQu-uc-Imx" secondAttribute="bottom" constant="8" id="cuh-Ib-eS8"/>
                             <constraint firstItem="uQu-uc-Imx" firstAttribute="centerY" secondItem="8bC-Xf-vdC" secondAttribute="centerY" id="pez-pw-KGy"/>
                         </constraints>
                     </view>

diff --git a/examples/native/ios/BugsnagFlutter/ViewController.swift b/examples/native/ios/BugsnagFlutter/ViewController.swift
@@ -12,4 +12,8 @@ class ViewController: UIViewController {
         let viewController = FlutterViewController(engine: flutterEngine, nibName: nil, bundle: nil) 
         present(viewController, animated: true, completion: nil)
     }
+
+    @IBAction func unhandledError() {
+        fatalError("oops!")
+    }
 }
diff --git a/examples/native/ios/Podfile b/examples/native/ios/Podfile
@@ -8,9 +8,6 @@ target 'BugsnagFlutter' do
   # Comment the next line if you don't want to use dynamic frameworks
   use_frameworks!
 
-  # Pods for BugsnagFlutter
-  pod 'Bugsnag'
-
   install_all_flutter_pods(flutter_application_path)
 end
 

diff --git a/features/breadcrumbs.feature b/features/breadcrumbs.feature
@@ -9,5 +9,10 @@ Feature: Start Bugsnag from Flutter
     And the error payload field "events.0.breadcrumbs.0.type" equals "state"
     And the error payload field "events.0.breadcrumbs.1.metaData.foo" equals "bar"
     And the error payload field "events.0.breadcrumbs.1.metaData.object.test" equals "hello"
+    And the error payload field "events.0.breadcrumbs.1.metaData.object.bool" is true
+    And the error payload field "events.0.breadcrumbs.1.metaData.object.number" equals 1234
+    And the error payload field "events.0.breadcrumbs.1.metaData.object.list.0" equals 'abc'
+    And the error payload field "events.0.breadcrumbs.1.metaData.object.list.1" equals 4321
+    And the error payload field "events.0.breadcrumbs.1.metaData.object.list.2" is true
     And the error payload field "events.0.breadcrumbs.1.name" equals "Manual breadcrumb"
     And the error payload field "events.0.breadcrumbs.1.type" equals "manual"
diff --git a/...p/android/app/src/main/java/com/bugsnag/flutter/test/app/MazeRunnerMethodCallHandler.java b/...p/android/app/src/main/java/com/bugsnag/flutter/test/app/MazeRunnerMethodCallHandler.java
@@ -14,6 +14,8 @@
 import com.bugsnag.flutter.BugsnagFlutterConfiguration;
 import com.bugsnag.flutter.test.app.scenario.Scenario;
 
+import org.json.JSONException;
+
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.InputStreamReader;
@@ -136,7 +138,7 @@ private void runScenario(@NonNull MethodCall call, @NonNull MethodChannel.Result
         if (scenario != null) {
             // we push all scenarios to the main thread to stop Flutter catching the exceptions
             mainHandler.post(() -> {
-                scenario.run(call.argument("extraConfig"));
+                scenario.run(context, call);
                 result.success(null);
             });
         }

diff --git a/.../android/app/src/main/java/com/bugsnag/flutter/test/app/scenario/NativeCrashScenario.java b/.../android/app/src/main/java/com/bugsnag/flutter/test/app/scenario/NativeCrashScenario.java
@@ -1,10 +1,12 @@
 package com.bugsnag.flutter.test.app.scenario;
 
-import androidx.annotation.Nullable;
+import android.content.Context;
+
+import io.flutter.plugin.common.MethodCall;
 
 public class NativeCrashScenario extends Scenario {
     @Override
-    public void run(@Nullable String extraConfig) {
+    public void run(Context context, MethodCall call) {
         throw new RuntimeException("crash from Java");
     }
 }
diff --git a/...pp/src/main/java/com/bugsnag/flutter/test/app/scenario/NativeProjectPackagesScenario.java b/...pp/src/main/java/com/bugsnag/flutter/test/app/scenario/NativeProjectPackagesScenario.java
@@ -0,0 +1,33 @@
+package com.bugsnag.flutter.test.app.scenario;
+
+import android.content.Context;
+
+import com.bugsnag.android.Bugsnag;
+import com.bugsnag.android.Configuration;
+import com.bugsnag.android.EndpointConfiguration;
+
+import java.util.LinkedHashSet;
+import java.util.Objects;
+import java.util.Set;
+
+import io.flutter.plugin.common.MethodCall;
+
+public class NativeProjectPackagesScenario extends Scenario {
+    @Override
+    public void run(Context context, MethodCall call) {
+
+        Configuration configuration = Configuration.load(context);
+        configuration.setApiKey("abc12312312312312312312312312312");
+        configuration.setEndpoints(new EndpointConfiguration(
+                Objects.requireNonNull(call.argument("notifyEndpoint")),
+                Objects.requireNonNull(call.argument("sessionEndpoint"))));
+
+        Set<String> projectPackages = new LinkedHashSet<>();
+        projectPackages.add("test_package");
+        projectPackages.add("MazeRunner");
+        projectPackages.add("com.bugsnag.flutter.test.app");
+        configuration.setProjectPackages(projectPackages);
+
+        Bugsnag.start(context, configuration);
+    }
+}
diff --git a/...ixtures/app/android/app/src/main/java/com/bugsnag/flutter/test/app/scenario/Scenario.java b/...ixtures/app/android/app/src/main/java/com/bugsnag/flutter/test/app/scenario/Scenario.java
@@ -1,7 +1,9 @@
 package com.bugsnag.flutter.test.app.scenario;
 
-import androidx.annotation.Nullable;
+import android.content.Context;
+
+import io.flutter.plugin.common.MethodCall;
 
 public abstract class Scenario {
-    public abstract void run(@Nullable String extraConfig);
+    public abstract void run(Context context, MethodCall call);
 }