Add Flutter runtime information (#2742)

* Add Flutter runtime

* add explaining comment

* add changelog

* Update CHANGELOG.md

* make things const

* fix changelog

* more doc comments

* Fix formatting

* add test and requested changes

* move tests to flutter package

* skip if environment is missing

* add ignore

---------

Co-authored-by: Denis Andrašec <[email protected]>

Author: ueman

CHANGELOG.md

@@ -2,10 +2,17 @@
 
 ## Unreleased
 
+
+### Enhancements
+
+- Add Flutter runtime information ([#2742](https://github.com/getsentry/sentry-dart/pull/2742))
+  - This works if the version of Flutter you're using includes [this code](https://github.com/flutter/flutter/pull/163761).
+
 ### Fixes
 
 - Pass missing `captureFailedRequests` param to `FailedRequestInterceptor` ([#2744](https://github.com/getsentry/sentry-dart/pull/2744))
 
+
 ## 8.14.0-beta.1
 
 ### Behavioral changes

dart/lib/src/event_processor/enricher/flutter_runtime.dart

@@ -0,0 +1,76 @@
+import '../../protocol/sentry_runtime.dart';
+
+// The Flutter version information can be fetched via Dart defines,
+// see
+//  - https://github.com/flutter/flutter/pull/140783
+//  - https://github.com/flutter/flutter/pull/163761
+//
+// This code lives in the Dart only Sentry code, since the code
+// doesn't require any Flutter dependency.
+// Additionally, this makes it work on background isolates in
+// Flutter, where one may not initialize the whole Flutter Sentry
+// SDK.
+// The const-ness of the properties below ensure that the code
+// is tree shaken in a non-Flutter environment.
+
+const _isFlutterRuntimeInformationAbsent = FlutterVersion.version == null ||
+    FlutterVersion.channel == null ||
+    FlutterVersion.frameworkRevision == null;
+
+const SentryRuntime? flutterRuntime = _isFlutterRuntimeInformationAbsent
+    ? null
+    : SentryRuntime(
+        name: 'Flutter',
+        version: '${FlutterVersion.version} (${FlutterVersion.channel})',
+        build: FlutterVersion.frameworkRevision,
+        rawDescription: '${FlutterVersion.version} (${FlutterVersion.channel}) '
+            '- Git hash ${FlutterVersion.frameworkRevision} '
+            '- Git URL ${FlutterVersion.gitUrl}',
+      );
+
+const SentryRuntime? dartFlutterRuntime = FlutterVersion.dartVersion == null
+    ? null
+    : SentryRuntime(name: 'Dart', version: FlutterVersion.dartVersion);
+
+/// Details about the Flutter version this app was compiled with,
+/// corresponding to the output of `flutter --version`.
+///
+/// When this Flutter version was build from a fork, or when Flutter runs in a
+/// custom embedder, these values might be unreliable.
+abstract class FlutterVersion {
+  const FlutterVersion._();
+
+  /// The Flutter version used to compile the app.
+  static const String? version = bool.hasEnvironment('FLUTTER_VERSION')
+      ? String.fromEnvironment('FLUTTER_VERSION')
+      : null;
+
+  /// The Flutter channel used to compile the app.
+  static const String? channel = bool.hasEnvironment('FLUTTER_CHANNEL')
+      ? String.fromEnvironment('FLUTTER_CHANNEL')
+      : null;
+
+  /// The URL of the Git repository from which Flutter was obtained.
+  static const String? gitUrl = bool.hasEnvironment('FLUTTER_GIT_URL')
+      ? String.fromEnvironment('FLUTTER_GIT_URL')
+      : null;
+
+  /// The Flutter framework revision, as a (short) Git commit ID.
+  static const String? frameworkRevision =
+      bool.hasEnvironment('FLUTTER_FRAMEWORK_REVISION')
+          ? String.fromEnvironment('FLUTTER_FRAMEWORK_REVISION')
+          : null;
+
+  /// The Flutter engine revision.
+  static const String? engineRevision =
+      bool.hasEnvironment('FLUTTER_ENGINE_REVISION')
+          ? String.fromEnvironment('FLUTTER_ENGINE_REVISION')
+          : null;
+
+  // This is included since [Platform.version](https://api.dart.dev/stable/dart-io/Platform/version.html)
+  // is not included on web platforms.
+  /// The Dart version used to compile the app.
+  static const String? dartVersion = bool.hasEnvironment('FLUTTER_DART_VERSION')
+      ? String.fromEnvironment('FLUTTER_DART_VERSION')
+      : null;
+}

dart/lib/src/event_processor/enricher/io_enricher_event_processor.dart

@@ -4,6 +4,7 @@ import 'package:meta/meta.dart';
 
 import '../../../sentry.dart';
 import 'enricher_event_processor.dart';
+import 'flutter_runtime.dart';
 import 'io_platform_memory.dart';
 
 EnricherEventProcessor enricherEventProcessor(SentryOptions options) {
@@ -63,12 +64,15 @@ class IoEnricherEventProcessor implements EnricherEventProcessor {
       version: _dartVersion,
       rawDescription: Platform.version,
     );
+    final flRuntime = flutterRuntime;
+
     if (runtimes == null) {
-      return [dartRuntime];
+      return [dartRuntime, if (flRuntime != null) flRuntime];
     }
     return [
       ...runtimes,
       dartRuntime,
+      if (flRuntime != null) flRuntime,
     ];
   }
 

dart/lib/src/event_processor/enricher/web_enricher_event_processor.dart

@@ -4,6 +4,7 @@ import 'package:web/web.dart' as web show window, Window, Navigator;
 
 import '../../../sentry.dart';
 import 'enricher_event_processor.dart';
+import 'flutter_runtime.dart';
 
 EnricherEventProcessor enricherEventProcessor(SentryOptions options) {
   return WebEnricherEventProcessor(
@@ -29,6 +30,7 @@ class WebEnricherEventProcessor implements EnricherEventProcessor {
     final contexts = event.contexts.copyWith(
       device: _getDevice(event.contexts.device),
       culture: _getSentryCulture(event.contexts.culture),
+      runtimes: _getRuntimes(event.contexts.runtimes),
     );
 
     contexts['dart_context'] = _getDartContext();
@@ -100,6 +102,23 @@ class WebEnricherEventProcessor implements EnricherEventProcessor {
       timezone: culture?.timezone ?? DateTime.now().timeZoneName,
     );
   }
+
+  List<SentryRuntime> _getRuntimes(List<SentryRuntime>? runtimes) {
+    final flRuntime = flutterRuntime;
+    final dartFlRuntime = dartFlutterRuntime;
+
+    if (runtimes == null) {
+      return [
+        if (flRuntime != null) flRuntime,
+        if (dartFlRuntime != null) dartFlRuntime,
+      ];
+    }
+    return [
+      ...runtimes,
+      if (flRuntime != null) flRuntime,
+      if (dartFlRuntime != null) dartFlRuntime,
+    ];
+  }
 }
 
 extension on web.Navigator {

flutter/test/flutter_version_test.dart

@@ -0,0 +1,41 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:sentry/src/event_processor/enricher/flutter_runtime.dart';
+
+void main() {
+  group(FlutterVersion, () {
+    test('FlutterVersion.version contains the current version', () {
+      expect(FlutterVersion.version,
+          const String.fromEnvironment('FLUTTER_VERSION'));
+    });
+
+    test('FlutterVersion.channel contains the current channel', () {
+      expect(FlutterVersion.channel,
+          const String.fromEnvironment('FLUTTER_CHANNEL'));
+    });
+
+    test('FlutterVersion.gitUrl contains the current git URL', () {
+      expect(FlutterVersion.gitUrl,
+          const String.fromEnvironment('FLUTTER_GIT_URL'));
+    });
+
+    test(
+        'FlutterVersion.frameworkRevision contains the current framework revision',
+        () {
+      expect(
+        FlutterVersion.frameworkRevision,
+        const String.fromEnvironment('FLUTTER_FRAMEWORK_REVISION'),
+      );
+    });
+
+    test('FlutterVersion.engineRevision contains the current engine revision',
+        () {
+      expect(FlutterVersion.engineRevision,
+          const String.fromEnvironment('FLUTTER_ENGINE_REVISION'));
+    });
+
+    test('FlutterVersion.dartVersion contains the current Dart version', () {
+      expect(FlutterVersion.dartVersion,
+          const String.fromEnvironment('FLUTTER_DART_VERSION'));
+    });
+  }, skip: !(const bool.hasEnvironment('FLUTTER_VERSION')));
+}