Merge branch 'main' into enha/rel-platfomr-cause

Author: denrase

CHANGELOG.md

@@ -1,20 +1,48 @@
 # Changelog
 
-## Unreleased
+## 9.0.0-alpha.2
+
+### Features
+
+- Add support for Flutter Web release health ([#2794](https://github.com/getsentry/sentry-dart/pull/2794))
+  - Requires using `SentryNavigatorObserver`;
+ 
+### Dependencies
+
+- Bump Native SDK from v0.7.20 to v0.8.2 ([#2761](https://github.com/getsentry/sentry-dart/pull/2761), [#2807](https://github.com/getsentry/sentry-dart/pull/2807))
+  - [changelog](https://github.com/getsentry/sentry-native/blob/master/CHANGELOG.md#082)
+  - [diff](https://github.com/getsentry/sentry-native/compare/0.7.20...0.8.2)
+- Bump Javascript SDK from v8.42.0 to v9.5.0 ([#2784](https://github.com/getsentry/sentry-dart/pull/2784))
+  - [changelog](https://github.com/getsentry/sentry-javascript/blob/main/CHANGELOG.md#950)
+  - [diff](https://github.com/getsentry/sentry-javascript/compare/8.42.0...9.5.0)
+ 
+### Behavioral changes
 
-- Bump Native SDK from v0.7.20 to v0.8.1 ([#2761](https://github.com/getsentry/sentry-dart/pull/2761))
-  - [changelog](https://github.com/getsentry/sentry-native/blob/master/CHANGELOG.md#081)
-  - [diff](https://github.com/getsentry/sentry-native/compare/0.7.20...0.8.1)
 - Set sentry-native backend to `crashpad` by default and `breakpad` for Windows ARM64 ([#2791](https://github.com/getsentry/sentry-dart/pull/2791))
   - Setting the `SENTRY_NATIVE_BACKEND` environment variable will override the defaults.
-- Move replay and privacy from experimental to options ([#2755](https://github.com/getsentry/sentry-dart/pull/2755))
 - Remove renderer from `flutter_context` ([#2751](https://github.com/getsentry/sentry-dart/pull/2751))
+
+### API changes
+
+- Move replay and privacy from experimental to options ([#2755](https://github.com/getsentry/sentry-dart/pull/2755))
 - Cleanup platform mocking ([#2730](https://github.com/getsentry/sentry-dart/pull/2730))
   - The `PlatformChecker` was renamed to `RuntimeChecker`
   - Moved `PlatformChecker.platform` to `options.platform`
-- Bump Javascript SDK from v8.42.0 to v9.5.0 ([#2784](https://github.com/getsentry/sentry-dart/pull/2784))
-  - [changelog](https://github.com/getsentry/sentry-javascript/blob/main/CHANGELOG.md#950)
-  - [diff](https://github.com/getsentry/sentry-javascript/compare/8.42.0...9.5.0)
+
+## 8.14.1
+
+### Fixes
+
+- Improve platform memory collection on windows/linux ([#2798](https://github.com/getsentry/sentry-dart/pull/2798))
+  - Fixes an issue where total memory on windows was not read.
+  - Free memory collection was removed on windows/linux, due to performance issues.
+- Fix adding runtime to contexts ([#2813](https://github.com/getsentry/sentry-dart/pull/2813))
+
+### Dependencies
+
+- Bump Android SDK from v7.22.1 to v7.22.4 ([#2810](https://github.com/getsentry/sentry-dart/pull/2810))
+  - [changelog](https://github.com/getsentry/sentry-java/blob/7.x.x/CHANGELOG.md#7224)
+  - [diff](https://github.com/getsentry/sentry-java/compare/7.22.1...7.22.4)
 
 ## 8.14.0
 

dart/lib/sentry.dart

@@ -5,6 +5,8 @@
 /// A pure Dart client for Sentry.io crash reporting.
 library;
 
+// ignore: invalid_export_of_internal_element
+export 'src/constants.dart';
 export 'src/event_processor.dart';
 export 'src/exception_cause.dart';
 export 'src/exception_cause_extractor.dart';
@@ -18,12 +20,14 @@ export 'src/hub_adapter.dart';
 export 'src/integration.dart';
 export 'src/noop_isolate_error_integration.dart'
     if (dart.library.io) 'src/isolate_error_integration.dart';
+// ignore: invalid_export_of_internal_element
+export 'src/observers.dart';
 export 'src/performance_collector.dart';
-export 'src/runtime_checker.dart';
 export 'src/protocol.dart';
 export 'src/protocol/sentry_feedback.dart';
 export 'src/protocol/sentry_proxy.dart';
 export 'src/run_zoned_guarded_integration.dart';
+export 'src/runtime_checker.dart';
 export 'src/scope.dart';
 export 'src/scope_observer.dart';
 export 'src/sentry.dart';
@@ -34,8 +38,6 @@ export 'src/sentry_envelope.dart';
 export 'src/sentry_envelope_item.dart';
 export 'src/sentry_options.dart';
 // ignore: invalid_export_of_internal_element
-export 'src/constants.dart';
-// ignore: invalid_export_of_internal_element
 export 'src/sentry_trace_origins.dart';
 export 'src/span_data_convention.dart';
 export 'src/spotlight.dart';

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

@@ -20,7 +20,11 @@ class IoEnricherEventProcessor implements EnricherEventProcessor {
   final SentryOptions _options;
   late final String _dartVersion = _extractDartVersion(Platform.version);
   late final SentryOperatingSystem _os = extractOperatingSystem(
-      Platform.operatingSystem, Platform.operatingSystemVersion);
+    Platform.operatingSystem,
+    Platform.operatingSystemVersion,
+  );
+  bool _fetchedTotalPhysicalMemory = false;
+  int? _totalPhysicalMemory;
 
   /// Extracts the semantic version and channel from the full version string.
   ///
@@ -37,17 +41,15 @@ class IoEnricherEventProcessor implements EnricherEventProcessor {
   }
 
   @override
-  SentryEvent? apply(SentryEvent event, Hint hint) {
-    // Amend app with current memory usage, as this is not available on native.
-    final app = _getApp(event.contexts.app);
-
-    final contexts = event.contexts.copyWith(
-      device: _getDevice(event.contexts.device),
-      operatingSystem: _getOperatingSystem(event.contexts.operatingSystem),
-      runtimes: _getRuntimes(event.contexts.runtimes),
-      app: app,
-      culture: _getSentryCulture(event.contexts.culture),
-    );
+  Future<SentryEvent?> apply(SentryEvent event, Hint hint) async {
+    final contexts = event.contexts;
+
+    contexts.device = await _getDevice(event.contexts.device);
+    contexts.operatingSystem =
+        _getOperatingSystem(event.contexts.operatingSystem);
+    contexts.runtimes = _getRuntimes(event.contexts.runtimes);
+    contexts.app = _getApp(event.contexts.app);
+    contexts.culture = _getSentryCulture(event.contexts.culture);
 
     contexts['dart_context'] = _getDartContext();
 
@@ -99,17 +101,25 @@ class IoEnricherEventProcessor implements EnricherEventProcessor {
     };
   }
 
-  SentryDevice _getDevice(SentryDevice? device) {
-    final platformMemory = PlatformMemory(_options);
+  Future<SentryDevice> _getDevice(SentryDevice? device) async {
     return (device ?? SentryDevice()).copyWith(
       name: device?.name ??
           (_options.sendDefaultPii ? Platform.localHostname : null),
       processorCount: device?.processorCount ?? Platform.numberOfProcessors,
-      memorySize: device?.memorySize ?? platformMemory.getTotalPhysicalMemory(),
-      freeMemory: device?.freeMemory ?? platformMemory.getFreePhysicalMemory(),
+      memorySize: device?.memorySize ?? await _getTotalPhysicalMemory(),
+      freeMemory: device?.freeMemory,
     );
   }
 
+  Future<int?> _getTotalPhysicalMemory() async {
+    if (!_fetchedTotalPhysicalMemory) {
+      _totalPhysicalMemory =
+          await PlatformMemory(_options).getTotalPhysicalMemory();
+      _fetchedTotalPhysicalMemory = true;
+    }
+    return _totalPhysicalMemory;
+  }
+
   SentryApp _getApp(SentryApp? app) {
     return (app ?? SentryApp()).copyWith(
       appMemory: app?.appMemory ?? ProcessInfo.currentRss,

dart/lib/src/event_processor/enricher/io_platform_memory.dart

@@ -6,32 +6,47 @@ import '../../sentry_options.dart';
 // Get total & free platform memory (in bytes) for linux and windows operating systems.
 // Source: https://github.com/onepub-dev/system_info/blob/8a9bf6b8eb7c86a09b3c3df4bf6d7fa5a6b50732/lib/src/platform/memory.dart
 class PlatformMemory {
-  PlatformMemory(this.options);
-
-  final SentryOptions options;
-
-  int? getTotalPhysicalMemory() {
-    if (options.platform.isLinux) {
-      return _getLinuxMemInfoValue('MemTotal');
-    } else if (options.platform.isWindows) {
-      return _getWindowsWmicValue('ComputerSystem', 'TotalPhysicalMemory');
+  PlatformMemory(this.options) {
+    if (options.platform.isWindows) {
+      // Check for WMIC (deprecated in newer Windows versions)
+      // https://techcommunity.microsoft.com/blog/windows-itpro-blog/wmi-command-line-wmic-utility-deprecation-next-steps/4039242
+      useWindowsWmci =
+          File('C:\\Windows\\System32\\wbem\\wmic.exe').existsSync();
+      if (!useWindowsWmci) {
+        useWindowsPowerShell = File(
+                'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe')
+            .existsSync();
+      } else {
+        useWindowsPowerShell = false;
+      }
     } else {
-      return null;
+      useWindowsWmci = false;
+      useWindowsPowerShell = false;
     }
   }
 
-  int? getFreePhysicalMemory() {
+  final SentryOptions options;
+  late final bool useWindowsWmci;
+  late final bool useWindowsPowerShell;
+
+  Future<int?> getTotalPhysicalMemory() async {
     if (options.platform.isLinux) {
-      return _getLinuxMemInfoValue('MemFree');
+      return _getLinuxMemInfoValue('MemTotal');
     } else if (options.platform.isWindows) {
-      return _getWindowsWmicValue('OS', 'FreePhysicalMemory');
+      if (useWindowsWmci) {
+        return _getWindowsWmicValue('ComputerSystem', 'TotalPhysicalMemory');
+      } else if (useWindowsPowerShell) {
+        return _getWindowsPowershellTotalMemoryValue();
+      } else {
+        return null;
+      }
     } else {
       return null;
     }
   }
 
-  int? _getWindowsWmicValue(String section, String key) {
-    final os = _wmicGetValueAsMap(section, [key]);
+  Future<int?> _getWindowsWmicValue(String section, String key) async {
+    final os = await _wmicGetValueAsMap(section, [key]);
     final totalPhysicalMemoryValue = os?[key];
     if (totalPhysicalMemoryValue == null) {
       return null;
@@ -43,12 +58,10 @@ class PlatformMemory {
     return size;
   }
 
-  int? _getLinuxMemInfoValue(String key) {
-    final meminfoList = _exec('cat', ['/proc/meminfo'])
-            ?.trim()
-            .replaceAll('\r\n', '\n')
-            .split('\n') ??
-        [];
+  Future<int?> _getLinuxMemInfoValue(String key) async {
+    final result = await _exec('cat', ['/proc/meminfo']);
+    final meminfoList =
+        result?.trim().replaceAll('\r\n', '\n').split('\n') ?? [];
 
     final meminfoMap = _listToMap(meminfoList, ':');
     final memsizeResults = meminfoMap[key]?.split(' ') ?? [];
@@ -65,11 +78,11 @@ class PlatformMemory {
     return memsize;
   }
 
-  String? _exec(String executable, List<String> arguments,
-      {bool runInShell = false}) {
+  Future<String?> _exec(String executable, List<String> arguments,
+      {bool runInShell = false}) async {
     try {
       final result =
-          Process.runSync(executable, arguments, runInShell: runInShell);
+          await Process.run(executable, arguments, runInShell: runInShell);
       if (result.exitCode == 0) {
         return result.stdout.toString();
       }
@@ -82,16 +95,16 @@ class PlatformMemory {
     return null;
   }
 
-  Map<String, String>? _wmicGetValueAsMap(String section, List<String> fields) {
+  Future<Map<String, String>?> _wmicGetValueAsMap(
+      String section, List<String> fields) async {
     final arguments = <String>[section];
     arguments
       ..add('get')
       ..addAll(fields.join(', ').split(' '))
       ..add('/VALUE');
 
-    final list =
-        _exec('wmic', arguments)?.trim().replaceAll('\r\n', '\n').split('\n') ??
-            [];
+    final result = await _exec('wmic', arguments);
+    final list = result?.trim().replaceAll('\r\n', '\n').split('\n') ?? [];
 
     return _listToMap(list, '=');
   }
@@ -108,4 +121,23 @@ class PlatformMemory {
     }
     return map;
   }
+
+  Future<int?> _getWindowsPowershellTotalMemoryValue() async {
+    final command =
+        'Get-CimInstance Win32_ComputerSystem | Select-Object -ExpandProperty TotalPhysicalMemory';
+
+    final result = await _exec('powershell.exe',
+        ['-NoProfile', '-NonInteractive', '-Command', command]);
+    if (result == null) {
+      return null;
+    }
+
+    final value = result.trim();
+    final size = int.tryParse(value);
+    if (size == null) {
+      return null;
+    }
+
+    return size;
+  }
 }

dart/lib/src/observers.dart

@@ -0,0 +1,18 @@
+import 'dart:async';
+
+import 'package:meta/meta.dart';
+
+import '../sentry.dart';
+
+// This file will contain observer definitions that are executed during
+// specific points in the SDK such as as right before an event is sent.
+// Only for internal use, e.g updating sessions only when an event is fully processed.
+// Not to be confused with the public callbacks such as beforeSend.
+// These should not mutate the data that is passed through the observer.
+
+/// Called right before an event is sent, after all processing is complete.
+/// Should not modify the event at this point.
+@internal
+abstract class BeforeSendEventObserver {
+  FutureOr<void> onBeforeSendEvent(SentryEvent event, Hint hint);
+}

dart/lib/src/protocol/contexts.dart

@@ -24,7 +24,7 @@ class Contexts extends MapView<String, dynamic> {
   }) : super({
           SentryDevice.type: device,
           SentryOperatingSystem.type: operatingSystem,
-          SentryRuntime.listType: runtimes ?? [],
+          SentryRuntime.listType: List<SentryRuntime>.from(runtimes ?? []),
           SentryApp.type: app,
           SentryBrowser.type: browser,
           SentryGpu.type: gpu,
@@ -98,6 +98,9 @@ class Contexts extends MapView<String, dynamic> {
   List<SentryRuntime> get runtimes =>
       List.unmodifiable(this[SentryRuntime.listType] ?? []);
 
+  set runtimes(List<SentryRuntime> runtimes) =>
+      this[SentryRuntime.listType] = List<SentryRuntime>.from(runtimes);
+
   void addRuntime(SentryRuntime runtime) =>
       this[SentryRuntime.listType].add(runtime);
 
@@ -291,7 +294,8 @@ class Contexts extends MapView<String, dynamic> {
       Contexts(
         device: device ?? this.device,
         operatingSystem: operatingSystem ?? this.operatingSystem,
-        runtimes: runtimes ?? this.runtimes,
+        runtimes: runtimes ??
+            List<SentryRuntime>.from(this[SentryRuntime.listType] ?? []),
         app: app ?? this.app,
         browser: browser ?? this.browser,
         gpu: gpu ?? this.gpu,

dart/lib/src/scope.dart

@@ -317,7 +317,7 @@ class Scope {
           level: level ?? event.level);
     }
 
-    _contexts.clone().forEach((key, value) {
+    _contexts.forEach((key, value) {
       // add the contexts runtime list to the event.contexts.runtimes
       if (key == SentryRuntime.listType &&
           value is List<SentryRuntime> &&

dart/lib/src/sentry_client.dart

@@ -160,6 +160,9 @@ class SentryClient {
       return _emptySentryId;
     }
 
+    // Event is fully processed and ready to be sent, emit beforeSendEvent observer
+    await _emitBeforeSendEventObserver(preparedEvent, hint);
+
     var attachments = List<SentryAttachment>.from(scope?.attachments ?? []);
     attachments.addAll(hint.attachments);
     var screenshot = hint.screenshot;
@@ -563,4 +566,26 @@ class SentryClient {
     }
     return DataCategory.error;
   }
+
+  FutureOr<void> _emitBeforeSendEventObserver(
+      SentryEvent event, Hint hint) async {
+    for (final observer in _options.beforeSendEventObservers) {
+      try {
+        final result = observer.onBeforeSendEvent(event, hint);
+        if (result is Future) {
+          await result;
+        }
+      } catch (exception, stackTrace) {
+        _options.logger(
+          SentryLevel.error,
+          'Error while running beforeSendEvent observer',
+          exception: exception,
+          stackTrace: stackTrace,
+        );
+        if (_options.automatedTestMode) {
+          rethrow;
+        }
+      }
+    }
+  }
 }