Merge pull request #110 from bugsnag/release-v1.5.0

robert-smartbear · web-flow · commit 0efb021b9bf4 · 2025-07-17T12:16:48.000+02:00
Release v1.5.0
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -1,5 +1,5 @@
 agents:
-  queue: macos-14
+  queue: macos-15
 
 steps:
 
@@ -23,8 +23,6 @@ steps:
   - label: Build iOS Test Fixture
     key: "ios-fixture-3-10-0"
     timeout_in_minutes: 20
-    agents:
-      queue: macos-14
     env:
       FLUTTER_VERSION: "3.19.0"
     commands:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## 1.5.0 (2025-07-17)
+
+### Changes
+
+* Set default endpoints based on API key [#107](https://github.com/bugsnag/bugsnag-flutter-performance/pull/107)
+
 ## 1.4.1 (2025-04-07)
 
 ### Changes
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.4.1
+1.5.0
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -24,6 +24,7 @@ services:
       MAZE_BUGSNAG_API_KEY:
       MAZE_APPIUM_BUGSNAG_API_KEY:
       MAZE_REPEATER_API_KEY:
+      MAZE_HUB_REPEATER_API_KEY:
       MAZE_NO_FAIL_FAST:
     ports:
       - "9000-9499:9339"
diff --git a/features/automatic_spans.feature b/features/automatic_spans.feature
@@ -1,5 +1,8 @@
 Feature: Automatic instrumentation spans
 
+  Background:
+    Given I clear the Bugsnag cache
+
   Scenario: AutoInstrumentAppStartsScenario
     Given I run "AutoInstrumentAppStartsScenario"
     And I wait for 4 spans
diff --git a/features/configuration.feature b/features/configuration.feature
@@ -1,5 +1,8 @@
 Feature: Configuration overrides
 
+  Background:
+    Given I clear the Bugsnag cache
+
   Scenario: Setting fixed sampling probability of 1 with dynamic probability of 0 should send all spans
     Given I set the sampling probability for the next traces to "0"
     And I enter unmanaged traces mode
diff --git a/features/correlation.feature b/features/correlation.feature
@@ -1,5 +1,8 @@
 Feature: Error correlation
 
+  Background:
+    Given I clear the Bugsnag cache
+
   Scenario: CorrelationSimpleScenario
     When I run "CorrelationSimpleScenario"
     * I wait to receive an error
diff --git a/features/initial-p-value.feature b/features/initial-p-value.feature
@@ -1,5 +1,8 @@
 Feature: Initial P values
 
+  Background:
+    Given I clear the Bugsnag cache
+
   Scenario: Initial P value of 0
     Given I set the sampling probability for the next traces to "0"
     And I run "InitialPScenario"
diff --git a/features/manual_span.feature b/features/manual_span.feature
@@ -1,5 +1,8 @@
 Feature: Manual Spans
 
+  Background:
+    Given I clear the Bugsnag cache
+
   Scenario: Manual Span
     When I run "ManualSpanScenario"
     And I wait for 1 span
diff --git a/features/nested_spans.feature b/features/nested_spans.feature
@@ -1,5 +1,8 @@
 Feature: Nested Spans
 
+  Background:
+    Given I clear the Bugsnag cache
+
   Scenario: Simple Nested Span
     When I run "SimpleNestedSpanScenario"
     * I wait for 2 spans
diff --git a/features/network_spans.feature b/features/network_spans.feature
@@ -1,6 +1,7 @@
 Feature: Network Spans
 
-  #HTTP WRAPPER
+  Background:
+    Given I clear the Bugsnag cache
 
   Scenario: HTTP Get
     When I run "HttpGetScenario"
diff --git a/features/persistence.feature b/features/persistence.feature
@@ -1,6 +1,6 @@
 Feature: Persistence
 
-Background:
+  Background:
     Given I clear the Bugsnag cache
 
   Scenario: Device Id Persists Between Launches
diff --git a/features/resource_attributes.feature b/features/resource_attributes.feature
@@ -1,5 +1,8 @@
 Feature: Resource Attributes
 
+  Background:
+    Given I clear the Bugsnag cache
+
   Scenario: Custom release stage
     When I run "CustomReleaseStageScenario"
     And I wait for 1 span
diff --git a/packages/bugsnag_flutter_performance/lib/src/client.dart b/packages/bugsnag_flutter_performance/lib/src/client.dart
@@ -30,8 +30,14 @@ import 'span.dart';
 
 typedef OnSpanEndCallback = Future<bool> Function(BugsnagPerformanceSpan);
 
-String _defaultEndpoint(String? apiKey) =>
-    'https://${apiKey != null ? '$apiKey.' : ''}otlp.bugsnag.com/v1/traces';
+String _defaultEndpoint(String? apiKey) {
+  // InsightHub keys always begin with 00000…
+  final bool isHubKey = apiKey != null && apiKey.startsWith('00000');
+  final String host =
+  isHubKey ? 'otlp.insighthub.smartbear.com' : 'otlp.bugsnag.com';
+  final String subdomain = apiKey != null ? '$apiKey.' : '';
+  return 'https://$subdomain$host/v1/traces';
+}
 
 abstract class BugsnagPerformanceClient {
   Future<void> start({
diff --git a/packages/bugsnag_flutter_performance/lib/src/extensions/resource_attributes.dart b/packages/bugsnag_flutter_performance/lib/src/extensions/resource_attributes.dart
@@ -196,5 +196,5 @@ class ResourceAttributesProviderImpl implements ResourceAttributesProvider {
     return "Unknown";
   }
 
-  static String get _getSDKVersion => '1.4.1';
+  static String get _getSDKVersion => '1.5.0';
 }
diff --git a/packages/bugsnag_flutter_performance/pubspec.yaml b/packages/bugsnag_flutter_performance/pubspec.yaml
@@ -1,6 +1,6 @@
 name: bugsnag_flutter_performance
 description: BugSnag performance monitoring tool for Flutter apps
-version: 1.4.1
+version: 1.5.0
 homepage: https://www.bugsnag.com/
 documentation: https://docs.bugsnag.com/performance/flutter/
 repository: https://github.com/bugsnag/bugsnag-flutter-performance
diff --git a/packages/bugsnag_flutter_performance/test/src/endpoint_test.dart b/packages/bugsnag_flutter_performance/test/src/endpoint_test.dart
@@ -0,0 +1,73 @@
+import 'dart:typed_data';
+import 'package:bugsnag_flutter_performance/src/client.dart';
+import 'package:bugsnag_flutter_performance/src/extensions/bugsnag_lifecycle_listener.dart';
+import 'package:bugsnag_flutter_performance/src/uploader/retry_queue.dart';
+import 'package:bugsnag_flutter_performance/src/uploader/retry_queue_builder.dart';
+import 'package:bugsnag_flutter_performance/src/uploader/uploader.dart';
+import 'package:bugsnag_flutter_performance/src/util/clock.dart';
+import 'package:flutter_test/flutter_test.dart';
+
+class _MockRetryQueue implements RetryQueue {
+  @override
+  Future<void> enqueue(
+      {required Map<String, String> headers, required Uint8List body}) async {}
+  @override
+  Future<void> flush() async {}
+}
+
+class _MockRetryQueueBuilder implements RetryQueueBuilder {
+  @override
+  RetryQueue build(Uploader uploader) => _MockRetryQueue();
+}
+
+class _MockLifecycleListener implements BugsnagLifecycleListener {
+  @override
+  void startObserving({void Function()? onAppBackgrounded}) {
+  }
+}
+
+void main() {
+  const validKey = 'a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6';
+  const hubKey = '00000deadbeefdeadbeefdeadbeef00';
+  final explicitEndpoint = Uri.parse('https://example.com/otel');
+  final defaultBugsnag = Uri.parse('https://otlp.bugsnag.com/v1/traces');
+  final defaultWithKey =
+      Uri.parse('https://$validKey.otlp.bugsnag.com/v1/traces');
+  final defaultHubHost =
+      Uri.parse('https://$hubKey.otlp.insighthub.smartbear.com/v1/traces');
+
+  BugsnagPerformanceClientImpl freshClient(_MockLifecycleListener listener) {
+    final c = BugsnagPerformanceClientImpl(lifecycleListener: listener);
+    c.retryQueueBuilder = _MockRetryQueueBuilder();
+    return c;
+  }
+
+  BugsnagClockImpl.ensureInitialized();
+
+  group('Endpoint selection', () {
+    test('defaults to Bugsnag OTLP when no apiKey supplied', () async {
+      final client = freshClient(_MockLifecycleListener());
+      await client.start();
+      expect(client.configuration!.endpoint, defaultBugsnag);
+    });
+
+    test('prefixes apiKey subdomain when apiKey supplied', () async {
+      final client = freshClient(_MockLifecycleListener());
+      await client.start(apiKey: validKey);
+      expect(client.configuration!.endpoint, defaultWithKey);
+    });
+
+    test('uses caller-supplied endpoint unchanged', () async {
+      final client = freshClient(_MockLifecycleListener());
+      await client.start(apiKey: validKey, endpoint: explicitEndpoint);
+      expect(client.configuration!.endpoint, explicitEndpoint);
+    });
+
+    test('prefixes hub subdomain when InsightHub key (00000…) supplied',
+        () async {
+      final client = freshClient(_MockLifecycleListener());
+      await client.start(apiKey: hubKey);
+      expect(client.configuration!.endpoint, defaultHubHost);
+    });
+  });
+}
