Merge pull request #257 from bugsnag/releases/v4.0.0

Releases/v4.0.0
bugsnag · Jul 29, 2024 · 3bb2f56 · 3bb2f56
2 parents 7366570 + 6bc5f40
commit 3bb2f56
Show file tree

Hide file tree

Showing 69 changed files with 578 additions and 218 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -53,8 +53,6 @@ steps:
   - label: ':bitbar: iOS 14 end-to-end tests 3.10.0'
     depends_on: "ios-fixture-3-10-0"
     timeout_in_minutes: 20
-    env:
-      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
     agents:
       queue: opensource
     plugins:
@@ -93,11 +91,9 @@ steps:
           from: "features/fixtures/app/build/app/outputs/flutter-apk/app-release.apk"
           to: "features/fixtures/app/build/app/outputs/flutter-apk/app-release-3.10.0.apk"
 
-  - label: ':bitbar: Android 12 end-to-end tests 3.10.0'
+  - label: ':browserstack: Android 12 end-to-end tests 3.10.0'
     depends_on: "android-fixture-3-10-0"
     timeout_in_minutes: 20
-    env:
-      FLUTTER_BIN: "/opt/flutter/3.10.0/bin/flutter"
     agents:
       queue: opensource
     plugins:
@@ -110,11 +106,10 @@ steps:
         service-ports: true
         command:
           - "--app=/app/features/fixtures/app/build/app/outputs/flutter-apk/app-release-3.10.0.apk"
-          - "--farm=bb"
-          - "--device=ANDROID_10|ANDROID_11|ANDROID_12|ANDROID_13"
-          - "--no-tunnel"
-          - "--aws-public-ip"
+          - "--farm=bs"
+          - "--device=ANDROID_12"
+          - "--appium-version=1.22.0"
           - "--fail-fast"
-    concurrency: 25
-    concurrency_group: 'bitbar'
+    concurrency: 5
+    concurrency_group: 'browserstack-app'
     concurrency_method: eager
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## 4.0.0 (2024-07-29)
+
+### Breaking Changes
+
+- The configuration options `discardClasses` and `redactedKeys` are now `RegExp`s instead of strings. This allows developers to have more control over how they perform.
+  [249](https://github.com/bugsnag/bugsnag-flutter/pull/249)
+
+- Getting the correlation trace ID and span ID through `flutter_bridge` and adding it to events.
+  [251](https://github.com/bugsnag/bugsnag-flutter/pull/251)
+
+Please see our [Upgrading guide](./UPGRADING.MD) for more information on upgrading to v4.x.
+
 ## 3.1.1 (2024-04-24)
 
 - Fixed: Navigator.pushAndRemoveUntil throws exception [#242](https://github.com/bugsnag/bugsnag-flutter/pull/242)

diff --git a/Gemfile b/Gemfile
@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 # A reference to Maze Runner is only needed for running tests locally and if committed it must be
 # portable for CI, e.g. a specific release.  However, leaving it commented out would mean quicker CI.
-gem 'bugsnag-maze-runner', '~> 8.0'
+gem 'bugsnag-maze-runner', '~> 9.0'
 gem 'cocoapods'
 
 # Use a specific branch

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,16 +1,38 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    CFPropertyList (3.0.7)
+      base64
+      nkf
+      rexml
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    algoliasearch (1.27.5)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
     appium_lib (12.0.1)
       appium_lib_core (~> 5.0)
       nokogiri (~> 1.8, >= 1.8.1)
       tomlrb (>= 1.1, < 3.0)
     appium_lib_core (5.4.0)
       faye-websocket (~> 0.11.0)
       selenium-webdriver (~> 4.2, < 4.6)
-    bugsnag (6.26.0)
+    atomos (0.1.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    bugsnag (6.27.1)
       concurrent-ruby (~> 1.0)
-    bugsnag-maze-runner (8.2.0)
+    bugsnag-maze-runner (9.11.1)
       appium_lib (~> 12.0.0)
       appium_lib_core (~> 5.4.0)
       bugsnag (~> 6.24)
@@ -27,9 +49,49 @@ GEM
       selenium-webdriver (~> 4.0)
       test-unit (~> 3.5.2)
       webrick (~> 1.7.0)
-    builder (3.2.4)
+    builder (3.3.0)
     childprocess (4.1.0)
+    claide (1.1.0)
+    cocoapods (1.15.2)
+      addressable (~> 2.8)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.15.2)
+      cocoapods-deintegrate (>= 1.0.3, < 2.0)
+      cocoapods-downloader (>= 2.1, < 3.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.6.0, < 2.0)
+      cocoapods-try (>= 1.1.0, < 2.0)
+      colored2 (~> 3.1)
+      escape (~> 0.0.4)
+      fourflusher (>= 2.3.0, < 3.0)
+      gh_inspector (~> 1.0)
+      molinillo (~> 0.8.0)
+      nap (~> 1.0)
+      ruby-macho (>= 2.3.0, < 3.0)
+      xcodeproj (>= 1.23.0, < 2.0)
+    cocoapods-core (1.15.2)
+      activesupport (>= 5.0, < 8)
+      addressable (~> 2.8)
+      algoliasearch (~> 1.0)
+      concurrent-ruby (~> 1.1)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+      netrc (~> 0.11)
+      public_suffix (~> 4.0)
+      typhoeus (~> 1.0)
+    cocoapods-deintegrate (1.0.5)
+    cocoapods-downloader (2.1)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.1)
+    cocoapods-trunk (1.6.0)
+      nap (>= 0.8, < 2.0)
+      netrc (~> 0.11)
+    cocoapods-try (1.2.0)
+    colored2 (3.1.2)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     cucumber (7.1.0)
       builder (~> 3.2, >= 3.2.4)
       cucumber-core (~> 10.1, >= 10.1.0)
@@ -62,65 +124,97 @@ GEM
       cucumber-core (~> 10.1, >= 10.1.0)
       cucumber-cucumber-expressions (~> 14.0, >= 14.0.0)
     curb (0.9.11)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     dogstatsd-ruby (5.5.0)
+    drb (2.2.1)
     ecma-re-validator (0.4.0)
       regexp_parser (~> 2.2)
+    escape (0.0.4)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
     eventmachine (1.2.7)
     faye-websocket (0.11.3)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     ffi (1.15.5)
+    fourflusher (2.3.1)
+    fuzzy_match (2.0.4)
+    gh_inspector (1.1.3)
     hana (1.3.7)
+    httpclient (2.8.3)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
     json_schemer (0.2.25)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
       uri_template (~> 0.7)
-    mime-types (3.4.1)
+    mime-types (3.5.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2023.0218.1)
+    mime-types-data (3.2024.0702)
+    minitest (5.22.3)
+    molinillo (0.8.0)
     multi_test (0.1.2)
-    nokogiri (1.15.3-x86_64-darwin)
+    mutex_m (0.2.0)
+    nanaimo (0.3.0)
+    nap (1.1.0)
+    netrc (0.11.0)
+    nkf (0.2.0)
+    nokogiri (1.16.6-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.6-x86_64-darwin)
       racc (~> 1.4)
     optimist (3.0.1)
     os (1.0.1)
     power_assert (2.0.3)
-    racc (1.7.1)
-    rack (2.2.8)
+    public_suffix (4.0.7)
+    racc (1.8.0)
+    rack (2.2.9)
     rake (12.3.3)
-    regexp_parser (2.8.1)
+    regexp_parser (2.9.2)
     rexml (3.2.6)
+    ruby-macho (2.5.1)
     rubyzip (2.3.2)
     selenium-webdriver (4.5.0)
       childprocess (>= 0.5, < 5.0)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
       websocket (~> 1.0)
-    simpleidn (0.2.1)
-      unf (~> 0.1.4)
-    sys-uname (1.2.3)
+    simpleidn (0.2.3)
+    sys-uname (1.3.0)
       ffi (~> 1.1)
     test-unit (3.5.9)
       power_assert
     tomlrb (2.0.3)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     uri_template (0.7.0)
     webrick (1.7.0)
-    websocket (1.2.9)
+    websocket (1.2.11)
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
+    xcodeproj (1.24.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.3.0)
+      rexml (~> 3.2.4)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-20
   x86_64-darwin-21
+  x86_64-darwin-23
 
 DEPENDENCIES
-  bugsnag-maze-runner (~> 8.0)
+  bugsnag-maze-runner (~> 9.0)
+  cocoapods
 
 BUNDLED WITH
-   2.4.8
+   2.4.18
diff --git a/Makefile b/Makefile
@@ -31,7 +31,7 @@ staging/bugsnag_flutter:
 	mkdir -p staging/bugsnag_flutter
 	cd packages/bugsnag_flutter && cp -a . ../../staging/bugsnag_flutter
 	rm -f staging/bugsnag_flutter/pubspec.lock
-	cp -r examples staging/bugsnag_flutter/examples
+	cp -r examples/flutter staging/bugsnag_flutter/example
 	cp README.md staging/bugsnag_flutter/.
 	cp LICENSE staging/bugsnag_flutter/.
 	cp CHANGELOG.md staging/bugsnag_flutter/.
@@ -111,4 +111,4 @@ else ifeq ($(SUBMODULE), bugsnag-cocoa)
 	$(MAKE) update-bugsnag-cocoa
 else
 	@$(error SUBMODULE must be one of bugsnag-android or bugsnag-cocoa)
-endif
+endif
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Bugsnag error monitoring & reporting for Flutter apps
 
 [![Documentation](https://img.shields.io/badge/documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/flutter/)
-[![Build status](https://badge.buildkite.com/e5d6c82f7202bbfe7114be8b8cb245b447a29470cd9320658b.svg)](https://buildkite.com/bugsnag/bugsnag-flutter)
+[![Build status](https://badge.buildkite.com/e5d6c82f7202bbfe7114be8b8cb245b447a29470cd9320658b.svg?branch=main)](https://buildkite.com/bugsnag/bugsnag-flutter)
 
 The [Bugsnag](https://www.bugsnag.com) error reporting library automatically detects Dart errors and
 native crashes in Flutter apps running on iOS and Android, collecting diagnostic information and

diff --git a/UPGRADING.MD b/UPGRADING.MD
@@ -1,6 +1,29 @@
 Upgrading
 =========
 
+## 3.x to 4.x
+
+### Key points
+
+- The configuration options `discardClasses` and `redactedKeys` are now `RegExp`s instead of strings. This allows developers to have more control over how they perform. 
+
+### Starting the client
+
+`bugsnag.start` accepts `Set<RegExp>` for `redactedKeys` and `discardClasses`. To specify them use:
+
+```dart
+bugsnag.start(
+  // ...
+  redactedKeys: {
+    RegExp('password'),
+    RegExp('^[A-Fa-f0-9]{16}\$', multiLine: true)
+  },
+  discardClasses: {
+    RegExp('sec', caseSensitive: false),
+  },
+  // ...
+);
+
 ## 2.x to 3.x
 
 A minimum of Flutter version of 3.10.0 is now required.

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,7 +2,7 @@ version: '3.6'
 services:
 
   maze-runner:
-    image: 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner-releases:latest-v8-cli
+    image: 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner-releases:latest-v9-cli
     environment:
       DEBUG:
       BITBAR_USERNAME:
@@ -21,6 +21,8 @@ services:
       BUILDKITE_RETRY_COUNT:
       BUILDKITE_STEP_KEY:
       MAZE_BUGSNAG_API_KEY:
+      BROWSER_STACK_USERNAME:
+      BROWSER_STACK_ACCESS_KEY:
     ports:
       - "9000-9499:9339"
     volumes:

diff --git a/examples/flutter/.metadata b/examples/flutter/.metadata
@@ -1,10 +1,33 @@
 # This file tracks properties of this Flutter project.
 # Used by Flutter tool to assess capabilities and perform upgrades etc.
 #
-# This file should be version controlled and should not be manually edited.
+# This file should be version controlled.
 
 version:
-  revision: 77d935af4db863f6abd0b9c31c7e6df2a13de57b
+  revision: 84a1e904f44f9b0e9c4510138010edcc653163f8
   channel: stable
 
 project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 84a1e904f44f9b0e9c4510138010edcc653163f8
+      base_revision: 84a1e904f44f9b0e9c4510138010edcc653163f8
+    - platform: android
+      create_revision: 84a1e904f44f9b0e9c4510138010edcc653163f8
+      base_revision: 84a1e904f44f9b0e9c4510138010edcc653163f8
+    - platform: ios
+      create_revision: 84a1e904f44f9b0e9c4510138010edcc653163f8
+      base_revision: 84a1e904f44f9b0e9c4510138010edcc653163f8
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'