Merge pull request #91 from bugsnag/release-v1.3.0

Release v1.3.0
bugsnag · Sep 30, 2024 · 5a2e159 · 5a2e159
2 parents beb5406 + 129de80
commit 5a2e159
Show file tree

Hide file tree

Showing 47 changed files with 977 additions and 100 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -55,10 +55,14 @@ steps:
           - "--app=/app/features/fixtures/mazerunner/build/ios/ipa/mazerunner.ipa"
           - "--farm=bb"
           - "--device=IOS_14|IOS_15|IOS_16"
+          - "--fail-fast"
           - "--no-tunnel"
           - "--aws-public-ip"
-          - "--fail-fast"
           - "--appium-version=1.22"
+      test-collector#v1.10.2:
+        files: "reports/TEST-*.xml"
+        format: "junit"
+        branch: "^main|next$$"
     concurrency: 25
     concurrency_group: 'bitbar'
     concurrency_method: eager
@@ -102,10 +106,14 @@ steps:
           - "--app=features/fixtures/mazerunner/build/app/outputs/flutter-apk/app-release.apk"
           - "--farm=bb"
           - "--device=ANDROID_10|ANDROID_11|ANDROID_12|ANDROID_13"
+          - "--fail-fast"
           - "--no-tunnel"
           - "--aws-public-ip"
-          - "--fail-fast"
           - "--appium-version=1.22"
+      test-collector#v1.10.2:
+        files: "reports/TEST-*.xml"
+        format: "junit"
+        branch: "^main|next$$"
     concurrency: 25
     concurrency_group: 'bitbar'
     concurrency_method: eager
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,14 @@
 Changelog
 =========
 
+## 1.3.0 (2024-09-30)
+
+### Enhancements
+
+* Custom attributes can now be set on a span, including as lists of primitives (int, double, bool, String) [88](https://github.com/bugsnag/bugsnag-flutter-performance/pull/88)
+
+* Introduced OnSpanEndCallbacks that allow changes to spans when their end() method is called, but before they are sent [88](https://github.com/bugsnag/bugsnag-flutter-performance/pull/88)
+
 ## 1.2.1 (2024-09-18)
 
 ### Bug fixes

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.2.1
+1.3.0
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -20,14 +20,17 @@ services:
       BUILDKITE_REPO:
       BUILDKITE_RETRY_COUNT:
       BUILDKITE_STEP_KEY:
+      BUILDKITE_ANALYTICS_TOKEN:
       MAZE_BUGSNAG_API_KEY:
       MAZE_REPEATER_API_KEY:
+      MAZE_NO_FAIL_FAST:
     ports:
       - "9000-9499:9339"
     volumes:
       - ./features/:/app/features/
       - ./maze_output:/app/maze_output
       - /var/run/docker.sock:/var/run/docker.sock
+      - ./reports/:/app/reports/
 
 networks:
   default:

diff --git a/features/fixture_resources/lib/channels.dart b/features/fixture_resources/lib/channels.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'package:flutter/services.dart';
 
 class MazeRunnerChannels {

diff --git a/features/fixture_resources/lib/main.dart b/features/fixture_resources/lib/main.dart
@@ -84,7 +84,7 @@ class Command {
 }
 
 class MazeRunnerFlutterApp extends StatelessWidget {
-  const MazeRunnerFlutterApp({Key? key}) : super(key: key);
+  const MazeRunnerFlutterApp({super.key});
 
   @override
   Widget build(BuildContext context) {
@@ -151,9 +151,9 @@ class MazeRunnerHomePage extends StatefulWidget {
   final String mazerunnerUrl;
 
   const MazeRunnerHomePage({
-    Key? key,
+    super.key,
     required this.mazerunnerUrl,
-  }) : super(key: key);
+  });
 
   @override
   State<MazeRunnerHomePage> createState() => _HomePageState();
@@ -332,9 +332,9 @@ class _HomePageState extends State<MazeRunnerHomePage> {
                 height: 400.0,
                 width: double.infinity,
                 child: TextButton(
-                  child: const Text("Run Command"),
                   onPressed: () => _onRunCommand(context),
                   key: const Key("runCommand"),
+                  child: const Text("Run Command"),
                 ),
               ),
               TextField(
@@ -373,14 +373,14 @@ class _HomePageState extends State<MazeRunnerHomePage> {
                 ),
               ),
               TextButton(
-                child: const Text("Start Bugsnag"),
                 onPressed: _onStartBugsnag,
                 key: const Key("startBugsnag"),
+                child: const Text("Start Bugsnag"),
               ),
               TextButton(
-                child: const Text("Run Scenario"),
                 onPressed: () => _onRunScenario(context),
                 key: const Key("startScenario"),
+                child: const Text("Run Scenario"),
               ),
             ],
           ),

diff --git a/features/fixture_resources/lib/scenarios/auto_instrument_app_starts_scenario.dart b/features/fixture_resources/lib/scenarios/auto_instrument_app_starts_scenario.dart
@@ -10,8 +10,8 @@ class AutoInstrumentAppStartsScenario extends Scenario {
     bugsnag_performance.setExtraConfig("probabilityValueExpireTime", 1000);
     bugsnag_performance.start(
         apiKey: '12312312312312312312312312312312',
-        endpoint: Uri.parse(FixtureConfig.MAZE_HOST.toString() + '/traces'));
-    bugsnag_performance.measureRunApp(() async => await Duration(seconds: 1));
+        endpoint: Uri.parse('${FixtureConfig.MAZE_HOST}/traces'));
+    bugsnag_performance.measureRunApp(() async => const Duration(seconds: 1));
     setMaxBatchSize(4);
   }
 }
diff --git a/...ures/fixture_resources/lib/scenarios/auto_instrument_navigation_basic_defer_scenario.dart b/...ures/fixture_resources/lib/scenarios/auto_instrument_navigation_basic_defer_scenario.dart
@@ -1,6 +1,5 @@
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'package:flutter/material.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 
@@ -68,7 +67,7 @@ class _AutoInstrumentNavigationBasicDeferScenarioScreenState
         onTap: () => widget.runCommandCallback(),
       );
     }
-    return Text('AutoInstrumentNavigationBasicDeferScenarioScreen');
+    return const Text('AutoInstrumentNavigationBasicDeferScenarioScreen');
   }
 
   void setStage(int stage) {

diff --git a/features/fixture_resources/lib/scenarios/auto_instrument_navigation_basic_scenario.dart b/features/fixture_resources/lib/scenarios/auto_instrument_navigation_basic_scenario.dart
@@ -1,7 +1,5 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 
@@ -15,11 +13,11 @@ class AutoInstrumentNavigationBasicScenario extends Scenario {
 
   @override
   Widget? createWidget() {
-    return Text('AutoInstrumentNavigationBasicScenario');
+    return const Text('AutoInstrumentNavigationBasicScenario');
   }
 
   @override
   RouteSettings? routeSettings() {
-    return RouteSettings(name: 'basic_navigation_scenario');
+    return const RouteSettings(name: 'basic_navigation_scenario');
   }
 }
diff --git a/...es/fixture_resources/lib/scenarios/auto_instrument_navigation_complex_defer_scenario.dart b/...es/fixture_resources/lib/scenarios/auto_instrument_navigation_complex_defer_scenario.dart
@@ -1,6 +1,5 @@
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'package:flutter/material.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 

diff --git a/...ixture_resources/lib/scenarios/auto_instrument_navigation_nested_navigation_scenario.dart b/...ixture_resources/lib/scenarios/auto_instrument_navigation_nested_navigation_scenario.dart
@@ -1,7 +1,6 @@
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 
 import 'package:flutter/material.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 

diff --git a/...res/fixture_resources/lib/scenarios/auto_instrument_navigation_push_and_pop_scenario.dart b/...res/fixture_resources/lib/scenarios/auto_instrument_navigation_push_and_pop_scenario.dart
@@ -1,6 +1,4 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'package:flutter/material.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 
@@ -62,8 +60,8 @@ class AutoInstrumentNavigationPushAndPopScenarioScreenState
   Widget build(BuildContext context) {
     return GestureDetector(
       child: Container(
-        child: Text('AutoInstrumentNavigationPushAndPopScenarioScreen'),
         color: Colors.white,
+        child: Text('AutoInstrumentNavigationPushAndPopScenarioScreen'),
       ),
       onTap: () => widget.runCommandCallback(),
     );

diff --git a/...s/fixture_resources/lib/scenarios/auto_instrument_navigation_with_view_load_scenario.dart b/...s/fixture_resources/lib/scenarios/auto_instrument_navigation_with_view_load_scenario.dart
@@ -1,6 +1,5 @@
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'package:flutter/material.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 

diff --git a/features/fixture_resources/lib/scenarios/correlation_null_scenario.dart b/features/fixture_resources/lib/scenarios/correlation_null_scenario.dart
@@ -1,6 +1,5 @@
 import 'package:bugsnag_flutter/bugsnag_flutter.dart';
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 

diff --git a/features/fixture_resources/lib/scenarios/correlation_simple_scenario.dart b/features/fixture_resources/lib/scenarios/correlation_simple_scenario.dart
@@ -1,6 +1,5 @@
 import 'package:bugsnag_flutter/bugsnag_flutter.dart';
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
-import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
 

diff --git a/features/fixture_resources/lib/scenarios/custom_app_version_scenario.dart b/features/fixture_resources/lib/scenarios/custom_app_version_scenario.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'scenario.dart';
 
 class CustomAppVersionScenario extends Scenario {

diff --git a/features/fixture_resources/lib/scenarios/custom_enabled_release_stage_scenario.dart b/features/fixture_resources/lib/scenarios/custom_enabled_release_stage_scenario.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'scenario.dart';
 
 class CustomEnabledReleaseStageScenario extends Scenario {

diff --git a/features/fixture_resources/lib/scenarios/custom_release_stage_scenario.dart b/features/fixture_resources/lib/scenarios/custom_release_stage_scenario.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'scenario.dart';
 
 class CustomReleaseStageScenario extends Scenario {

diff --git a/features/fixture_resources/lib/scenarios/custom_service_name_scenario.dart b/features/fixture_resources/lib/scenarios/custom_service_name_scenario.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'scenario.dart';
 
 class CustomServiceNameScenario extends Scenario {

diff --git a/features/fixture_resources/lib/scenarios/custom_span_attributes_scenario.dart b/features/fixture_resources/lib/scenarios/custom_span_attributes_scenario.dart
@@ -0,0 +1,49 @@
+import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
+
+import 'scenario.dart';
+
+class CustomSpanAttributesScenario extends Scenario {
+  @override
+  Future<void> run() async {
+    await startBugsnag(onSpanEndCallbacks: [
+      _setAttributesAndThrow,
+      _discardUnwantedSpan,
+      _setAttributes,
+    ]);
+    setMaxBatchSize(1);
+    doSimpleSpan('CustomSpanAttributesScenarioDiscaredSpan');
+    final span =
+        bugsnag_performance.startSpan('CustomSpanAttributesScenarioSpan');
+    span.setAttribute('customAttribute1', 42);
+    span.setAttribute('customAttribute2', 'Test');
+    span.setAttribute('customAttribute3', 1);
+    span.end();
+    span.setAttribute('customAttribute6', 'T');
+  }
+
+  Future<bool> _setAttributesAndThrow(BugsnagPerformanceSpan span) async {
+    span.setAttribute('customAttribute1', 'C');
+    throw Exception('');
+  }
+
+  Future<bool> _discardUnwantedSpan(BugsnagPerformanceSpan span) async {
+    if (span.name == 'CustomSpanAttributesScenarioDiscaredSpan') {
+      return false;
+    }
+    return true;
+  }
+
+  Future<bool> _setAttributes(BugsnagPerformanceSpan span) async {
+    span.setAttribute('customAttribute3', 2);
+    span.setAttribute('customAttribute3', 3);
+    span.setAttribute('customAttribute2', null);
+    span.setAttribute('customAttribute4', 42.0);
+    span.setAttribute('customAttribute5', [
+      'customString',
+      42,
+      true,
+      43.0,
+    ]);
+    return true;
+  }
+}
diff --git a/features/fixture_resources/lib/scenarios/custom_span_attributes_with_limits_scenario.dart b/features/fixture_resources/lib/scenarios/custom_span_attributes_with_limits_scenario.dart
@@ -0,0 +1,35 @@
+import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
+
+import 'scenario.dart';
+
+class CustomSpanAttributesWithLimitsScenario extends Scenario {
+  @override
+  Future<void> run() async {
+    await startBugsnag(
+        attributeCountLimit: 8,
+        attributeStringValueLimit: 20,
+        attributeArrayLengthLimit: 6,
+        onSpanEndCallbacks: [
+          _setAttributes,
+        ]);
+    setMaxBatchSize(1);
+    final span = bugsnag_performance
+        .startSpan('CustomSpanAttributesWithLimitsScenarioSpan');
+    final tooLongKey = 'a' * 129;
+    span.setAttribute('customAttribute1', 42);
+    span.setAttribute(tooLongKey, 'Test');
+    span.setAttribute('customAttribute2', 1);
+    span.setAttribute('customAttribute3', [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+    span.setAttribute(
+        'customAttribute4', 'VeryLongStringAttributeValueThatExceedsTheLimit');
+    span.setAttribute('customAttribute5', 42.0);
+    span.setAttribute('customAttribute6', 'Dropped');
+    span.end();
+  }
+
+  Future<bool> _setAttributes(BugsnagPerformanceSpan span) async {
+    span.setAttribute('customAttribute7', 'Droppedtoo');
+    span.setAttribute('customAttribute2', 'NotDropped');
+    return true;
+  }
+}
diff --git a/features/fixture_resources/lib/scenarios/dio_callback_cancel_span.dart b/features/fixture_resources/lib/scenarios/dio_callback_cancel_span.dart
@@ -1,5 +1,4 @@
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
-import 'package:bugsnag_http_client/bugsnag_http_client.dart';
 import 'package:dio/io.dart';
 import '../main.dart';
 import 'scenario.dart';

diff --git a/features/fixture_resources/lib/scenarios/dio_callback_edit_scenario.dart b/features/fixture_resources/lib/scenarios/dio_callback_edit_scenario.dart
@@ -1,5 +1,4 @@
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
-import 'package:bugsnag_http_client/bugsnag_http_client.dart';
 import 'package:dio/io.dart';
 import '../main.dart';
 import 'scenario.dart';

diff --git a/features/fixture_resources/lib/scenarios/disable_custom_release_stage_scenario.dart b/features/fixture_resources/lib/scenarios/disable_custom_release_stage_scenario.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'scenario.dart';
 
 class DisableCustomReleaseStageScenario extends Scenario {

diff --git a/features/fixture_resources/lib/scenarios/http_client_trace_propagation_urls_scenario.dart b/features/fixture_resources/lib/scenarios/http_client_trace_propagation_urls_scenario.dart
@@ -11,7 +11,7 @@ class HttpClientTracePropagationUrlsScenario extends Scenario {
     http.addSubscriber(bugsnag_performance.networkInstrumentation);
     http.get(
         Uri.parse('${FixtureConfig.MAZE_HOST.toString()}/reflect?dontsend'));
-    await Future.delayed(Duration(seconds: 1));
+    await Future.delayed(const Duration(seconds: 1));
     http.get(Uri.parse('${FixtureConfig.MAZE_HOST.toString()}/reflect?dosend'));
   }
 }
diff --git a/features/fixture_resources/lib/scenarios/initial_p_scenario.dart b/features/fixture_resources/lib/scenarios/initial_p_scenario.dart
@@ -1,10 +1,7 @@
-import 'dart:convert';
-
 import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'package:mazerunner/main.dart';
 
 import 'scenario.dart';
-import 'package:http/http.dart' as http;
 
 class InitialPScenario extends Scenario {
   @override
@@ -15,7 +12,7 @@ class InitialPScenario extends Scenario {
     bugsnag_performance.setExtraConfig("probabilityValueExpireTime", 25000);
     bugsnag_performance.start(
         apiKey: '12312312312312312312312312312312',
-        endpoint: Uri.parse(FixtureConfig.MAZE_HOST.toString() + '/traces'));
+        endpoint: Uri.parse('${FixtureConfig.MAZE_HOST}/traces'));
     setMaxBatchSize(1);
     doSimpleSpan('First');
   }

diff --git a/features/fixture_resources/lib/scenarios/manual_span_scenario.dart b/features/fixture_resources/lib/scenarios/manual_span_scenario.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'scenario.dart';
 
 class ManualSpanScenario extends Scenario {

diff --git a/features/fixture_resources/lib/scenarios/max_batch_age_scenario.dart b/features/fixture_resources/lib/scenarios/max_batch_age_scenario.dart
@@ -1,4 +1,3 @@
-import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
 import 'scenario.dart';
 
 class MaxBatchAgeScenario extends Scenario {