Release v1.6.0 (#116)

Author: richardelms

.buildkite/pipeline.yml

@@ -66,6 +66,10 @@ steps:
     concurrency: 25
     concurrency_group: 'bitbar'
     concurrency_method: eager
+    retry:
+      automatic:
+        - exit_status: 103  # Appium session failed
+          limit: 2
 
 
   #
@@ -117,3 +121,7 @@ steps:
     concurrency: 25
     concurrency_group: 'bitbar'
     concurrency_method: eager
+    retry:
+      automatic:
+        - exit_status: 103  # Appium session failed
+          limit: 2

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## 1.6.0 (2025-09-10)
+
+### Changes
+
+* Allow customisation of app start spans via new span control API [#113](https://github.com/bugsnag/bugsnag-flutter-performance/pull/113)
+
 ## 1.5.0 (2025-07-17)
 
 ### Changes

Gemfile

@@ -4,7 +4,7 @@ gem 'cocoapods'
 
 # 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', '~> 9.0'
+gem 'bugsnag-maze-runner', '~> 10.0'
 
 # Use a specific branch
 #gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner', branch: 'master'

VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

docker-compose.yml

@@ -1,8 +1,7 @@
-version: '3.6'
 services:
 
   maze-runner:
-    image: 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner-releases:latest-v9-cli
+    image: 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner-releases:latest-v10-cli
     environment:
       DEBUG:
       BITBAR_USERNAME:

features/automatic_spans.feature

@@ -5,7 +5,7 @@ Feature: Automatic instrumentation spans
 
   Scenario: AutoInstrumentAppStartsScenario
     Given I run "AutoInstrumentAppStartsScenario"
-    And I wait for 4 spans
+    And I wait to receive at least 4 spans
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Span-Sampling" header equals "1:4"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
@@ -30,7 +30,7 @@ Feature: Automatic instrumentation spans
 
   Scenario: AutoInstrumentNavigationBasicScenario
     Given I run "AutoInstrumentNavigationBasicScenario"
-    And I wait for 1 span
+    And I wait to receive at least 1 span
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Span-Sampling" header equals "1:1"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
@@ -51,7 +51,7 @@ Feature: Automatic instrumentation spans
     And I wait for 5 seconds
     * no span named "[Navigation]basic_defer_navigation_scenario" exists
     And I invoke "step2"
-    Then I wait for 1 span
+    Then I wait to receive at least 1 span
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Span-Sampling" header equals "1:1"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
@@ -77,7 +77,7 @@ Feature: Automatic instrumentation spans
     And I wait for 3 seconds
     * no span named "[Navigation]complex_defer_navigation_scenario" exists
     Then I invoke "step4"
-    And I wait for 1 span
+    And I wait to receive at least 1 span
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Span-Sampling" header equals "1:1"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
@@ -97,7 +97,7 @@ Feature: Automatic instrumentation spans
     And I wait for 3 seconds
     * no span named "[Navigation]nested_defer_navigation_scenario_parent" exists
     Then I invoke "step2"
-    And I wait for 2 spans
+    And I wait to receive at least 2 spans
     * a span field "name" equals "[Navigation]nested_defer_navigation_scenario_parent"
     * a span string attribute "bugsnag.navigation.route" equals "nested_defer_navigation_scenario_parent"
     * a span string attribute "bugsnag.navigation.triggered_by" equals "push"
@@ -111,15 +111,15 @@ Feature: Automatic instrumentation spans
     * a span string attribute "bugsnag.navigation.previous_route" equals "/"
     * a span string attribute "bugsnag.navigation.navigator" equals "nested_scenario_child_navigator"
     Then I invoke "step3"
-    And I wait for 3 spans
+    And I wait to receive at least 3 spans
     * a span field "name" equals "[Navigation]nested_scenario_child_navigator/nested_scenario_child_route_2"
     * a span string attribute "bugsnag.navigation.route" equals "nested_scenario_child_route_2"
     * a span string attribute "bugsnag.navigation.triggered_by" equals "push"
     * a span string attribute "bugsnag.navigation.ended_by" equals "frame_render"
     * a span string attribute "bugsnag.navigation.previous_route" equals "nested_scenario_child_route_initial"
     * a span string attribute "bugsnag.navigation.navigator" equals "nested_scenario_child_navigator"
     Then I invoke "step4"
-    And I wait for 4 span
+    And I wait to receive at least 4 spans
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
     * a span field "name" equals "[Navigation]nested_scenario_child_navigator/nested_scenario_child_route_3"
@@ -136,14 +136,14 @@ Feature: Automatic instrumentation spans
 
   Scenario: AutoInstrumentNavigationPushAndPopScenario
     Given I run "AutoInstrumentNavigationPushAndPopScenario"
-    And I wait for 1 span
+    And I wait to receive at least 1 span
     * a span field "name" equals "[Navigation]push_and_pop_scenario"
     * a span string attribute "bugsnag.navigation.route" equals "push_and_pop_scenario"
     * a span string attribute "bugsnag.navigation.triggered_by" equals "push"
     * a span string attribute "bugsnag.navigation.ended_by" equals "frame_render"
     * a span string attribute "bugsnag.navigation.previous_route" equals "/"
     And I invoke "step2"
-    Then I wait for 2 spans
+    Then I wait to receive at least 2 spans
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Span-Sampling" header equals "1:1"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
@@ -160,7 +160,7 @@ Feature: Automatic instrumentation spans
 
   Scenario: AutoInstrumentViewLoadBasicScenario
     Given I run "AutoInstrumentViewLoadBasicScenario"
-    And I wait for 3 spans
+    And I wait to receive at least 3 spans
     And I wait for 3 seconds
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Span-Sampling" header equals "1:3"
@@ -183,7 +183,7 @@ Feature: Automatic instrumentation spans
 
   Scenario: AutoInstrumentViewLoadBasicDeferScenario
     Given I run "AutoInstrumentViewLoadBasicDeferScenario"
-    And I wait for 2 spans
+    And I wait to receive at least 2 spans
     And I wait for 3 seconds
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
@@ -195,7 +195,7 @@ Feature: Automatic instrumentation spans
     * no span named "[ViewLoad]FlutterWidget/AutoInstrumentViewLoadBasicDeferScenarioWidget" exists
     * no span named "[ViewLoadPhase]FlutterWidget/AutoInstrumentViewLoadBasicDeferScenarioWidget/loading content" exists
     And I invoke "step2"
-    And I wait for 4 spans
+    And I wait to receive at least 4 spans
     * a span field "name" equals "[ViewLoad]FlutterWidget/AutoInstrumentViewLoadBasicDeferScenarioWidget"
     * a span string attribute "bugsnag.span.category" equals "view_load"
     * a span field "name" equals "[ViewLoadPhase]FlutterWidget/AutoInstrumentViewLoadBasicDeferScenarioWidget/loading content"
@@ -211,7 +211,7 @@ Feature: Automatic instrumentation spans
 
   Scenario: AutoInstrumentViewLoadNestedScenario
     Given I run "AutoInstrumentViewLoadNestedScenario"
-    And I wait for 4 spans
+    And I wait to receive at least 4 spans
     And I wait for 3 seconds
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
@@ -227,7 +227,7 @@ Feature: Automatic instrumentation spans
     * no span named "[ViewLoad]FlutterWidget/AutoInstrumentViewLoadNestedScenarioChildWidget" exists
     * no span named "[ViewLoadPhase]FlutterWidget/AutoInstrumentViewLoadNestedScenarioChildWidget/loading content" exists
     And I invoke "step2"
-    And I wait for 8 spans
+    And I wait to receive at least 8 spans
     * a span field "name" equals "[ViewLoad]FlutterWidget/AutoInstrumentViewLoadNestedScenarioWidget"
     * a span field "name" equals "[ViewLoad]FlutterWidget/AutoInstrumentViewLoadNestedScenarioChildWidget"
     * a span string attribute "bugsnag.span.category" equals "view_load"
@@ -260,7 +260,7 @@ Feature: Automatic instrumentation spans
     * no span named "[Navigation]navigation_view_load_scenario" exists
     * no span named "[ViewLoad]FlutterWidget/AutoInstrumentNavigationWithViewLoadWidget" exists
     Then I invoke "step4"
-    And I wait for 5 spans
+    And I wait to receive at least 5 spans
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Span-Sampling" header equals "1:1"
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"

features/configuration.feature

@@ -7,7 +7,7 @@ Feature: Configuration overrides
     Given I set the sampling probability for the next traces to "0"
     And I enter unmanaged traces mode
     And I run "FixedSamplingProbabilityOneScenario"
-    And I wait for 1 span
+    And I wait to receive at least 1 span
     Then the trace "Content-Type" header equals "application/json"
     * the trace "Bugsnag-Integrity" header matches the regex "^sha1 [A-Fa-f0-9]{40}$"
     * the trace "Bugsnag-Span-Sampling" header is not present
@@ -20,7 +20,7 @@ Feature: Configuration overrides
     Then I discard the oldest trace
     Then I set the sampling probability for the next traces to "0"
     And I invoke "step2"
-    And I wait for 1 span
+    And I wait to receive at least 1 span
     * the trace "Bugsnag-Span-Sampling" header is not present
     * the trace "Bugsnag-Sent-At" header matches the regex "^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\dZ$"
     * every span field "name" equals "FixedSamplingProbabilitySpan2"

features/correlation.feature

@@ -6,7 +6,7 @@ Feature: Error correlation
   Scenario: CorrelationSimpleScenario
     When I run "CorrelationSimpleScenario"
     * I wait to receive an error
-    * I wait for 1 span
+    * I wait to receive at least 1 span
     * the exception "message" equals "CorrelationSimpleScenario"
 
     * the trace payload field "resourceSpans.0.scopeSpans.0.spans.0.spanId" matches the regex "^[A-Fa-f0-9]{16}$"
@@ -21,7 +21,7 @@ Feature: Error correlation
   Scenario: CorrelationNullScenario
     When I run "CorrelationNullScenario"
     * I wait to receive an error
-    * I wait for 1 span
+    * I wait to receive at least 1 span
     * the exception "message" equals "CorrelationNullScenario"
     * the error payload field "events.0.correlation" is null
 

features/fixture_resources/lib/scenarios/clear_custom_app_start_name_scenario.dart

@@ -0,0 +1,20 @@
+import 'package:bugsnag_flutter_performance/bugsnag_flutter_performance.dart';
+
+import '../main.dart';
+import 'scenario.dart';
+
+class ClearCustomAppStartNameScenario extends Scenario {
+  @override
+  Future<void> run() async {
+    bugsnag_performance.setExtraConfig('instrumentAppStart', true);
+    bugsnag_performance.setExtraConfig('probabilityValueExpireTime', 1000);
+    bugsnag_performance.start(
+        apiKey: '12312312312312312312312312312312',
+        endpoint: Uri.parse('${FixtureConfig.MAZE_HOST}/traces'));
+    final control = bugsnag_performance.getSpanControl<AppStartSpanControl>();
+    control?.setType('FirstOpen');
+    control?.clearType();
+    bugsnag_performance.measureRunApp(() async => const Duration(seconds: 1));
+    setMaxBatchSize(4);
+  }
+}

features/fixture_resources/lib/scenarios/scenarios.dart

@@ -49,6 +49,8 @@ import 'check_network_callback_type_scenario.dart';
 import 'custom_span_time_scenario.dart';
 import 'span_with_no_parent_scenario.dart';
 import 'scenario.dart';
+import 'set_custom_app_start_name_scenario.dart';
+import 'clear_custom_app_start_name_scenario.dart';
 
 class ScenarioInfo<T extends Scenario> {
   const ScenarioInfo(this.name, this.init);
@@ -132,5 +134,9 @@ final List<ScenarioInfo<Scenario>> scenarios = [
   ScenarioInfo(
       'CustomSpanAttributesScenario', () => CustomSpanAttributesScenario()),
   ScenarioInfo('CustomSpanAttributesWithLimitsScenario',
-      () => CustomSpanAttributesWithLimitsScenario())
+      () => CustomSpanAttributesWithLimitsScenario()),
+  ScenarioInfo('SetCustomAppStartNameScenario',
+      () => SetCustomAppStartNameScenario()),
+  ScenarioInfo('ClearCustomAppStartNameScenario',
+      () => ClearCustomAppStartNameScenario()),
 ];