refactor: cleanup platform mocking (#2730)

Author: vaind

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 - 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))
+- Cleanup platform mocking ([#2730](https://github.com/getsentry/sentry-dart/pull/2730))
+  - The `PlatformChecker` was renamed to `RuntimeChecker`
+  - Moved `PlatformChecker.platform` to `options.platform`
 
 ## 9.0.0-alpha.1
 
@@ -28,8 +31,7 @@
   - Responses are attached to the `Hint` object, which can be read in `beforeSend`/`beforeSendTransaction` callbacks via `hint.response`.
   - For now, only the `dio` integration is supported.
 - Enable privacy masking for screenshots by default ([#2728](https://github.com/getsentry/sentry-dart/pull/2728))
-
-
+  
 ### Enhancements
 
 - Replay: improve Android native interop performance by using JNI ([#2670](https://github.com/getsentry/sentry-dart/pull/2670))

dart/lib/sentry.dart

@@ -19,7 +19,7 @@ export 'src/integration.dart';
 export 'src/noop_isolate_error_integration.dart'
     if (dart.library.io) 'src/isolate_error_integration.dart';
 export 'src/performance_collector.dart';
-export 'src/platform_checker.dart';
+export 'src/runtime_checker.dart';
 export 'src/protocol.dart';
 export 'src/protocol/sentry_feedback.dart';
 export 'src/protocol/sentry_proxy.dart';

dart/lib/src/environment/environment_variables.dart

@@ -1,4 +1,4 @@
-import '../platform_checker.dart';
+import '../runtime_checker.dart';
 import '_io_environment_variables.dart'
     if (dart.library.js_interop) '_web_environment_variables.dart' as env;
 
@@ -28,7 +28,7 @@ abstract class EnvironmentVariables {
 
   /// Returns an environment based on the compilation mode of Dart or Flutter.
   /// This can be set as [SentryOptions.environment]
-  String environmentForMode(PlatformChecker checker) {
+  String environmentForMode(RuntimeChecker checker) {
     // We infer the environment based on the release/non-release and profile
     // constants.
 

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

@@ -82,7 +82,7 @@ class IoEnricherEventProcessor implements EnricherEventProcessor {
     }
 
     return <String, dynamic>{
-      'compile_mode': _options.platformChecker.compileMode,
+      'compile_mode': _options.runtimeChecker.compileMode,
       if (packageConfig != null) 'package_config': packageConfig,
       // The following information could potentially contain PII
       if (_options.sendDefaultPii) ...{

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

@@ -11,19 +11,19 @@ class PlatformMemory {
   final SentryOptions options;
 
   int? getTotalPhysicalMemory() {
-    if (options.platformChecker.platform.isLinux) {
+    if (options.platform.isLinux) {
       return _getLinuxMemInfoValue('MemTotal');
-    } else if (options.platformChecker.platform.isWindows) {
+    } else if (options.platform.isWindows) {
       return _getWindowsWmicValue('ComputerSystem', 'TotalPhysicalMemory');
     } else {
       return null;
     }
   }
 
   int? getFreePhysicalMemory() {
-    if (options.platformChecker.platform.isLinux) {
+    if (options.platform.isLinux) {
       return _getLinuxMemInfoValue('MemFree');
-    } else if (options.platformChecker.platform.isWindows) {
+    } else if (options.platform.isWindows) {
       return _getWindowsWmicValue('OS', 'FreePhysicalMemory');
     } else {
       return null;

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

@@ -89,7 +89,7 @@ class WebEnricherEventProcessor implements EnricherEventProcessor {
 
   Map<String, dynamic> _getDartContext() {
     return <String, dynamic>{
-      'compile_mode': _options.platformChecker.compileMode,
+      'compile_mode': _options.runtimeChecker.compileMode,
     };
   }
 

dart/lib/src/load_dart_debug_images_integration.dart

@@ -1,8 +1,16 @@
 import 'dart:typed_data';
-
 import 'package:meta/meta.dart';
 
-import '../sentry.dart';
+import 'event_processor.dart';
+import 'hint.dart';
+import 'hub.dart';
+import 'integration.dart';
+import 'protocol/debug_image.dart';
+import 'protocol/debug_meta.dart';
+import 'protocol/sentry_event.dart';
+import 'protocol/sentry_level.dart';
+import 'protocol/sentry_stack_trace.dart';
+import 'sentry_options.dart';
 
 class LoadDartDebugImagesIntegration extends Integration<SentryOptions> {
   @override
@@ -83,11 +91,11 @@ class LoadImageIntegrationEventProcessor implements EventProcessor {
     // It doesn't need to exist and is not used for symbolication.
     late final String codeFile;
 
-    final platform = _options.platformChecker.platform;
+    final platform = _options.platform;
 
     if (platform.isAndroid || platform.isWindows) {
       type = 'elf';
-      debugId = _convertBuildIdToDebugId(stackTrace.buildId!, platform.endian);
+      debugId = _convertBuildIdToDebugId(stackTrace.buildId!, Endian.host);
       if (platform.isAndroid) {
         codeFile = 'libapp.so';
       } else if (platform.isWindows) {

dart/lib/src/platform/_io_platform.dart

@@ -1,20 +1,33 @@
-import 'dart:io' as io show Platform;
+import 'dart:io' as io;
 
 import 'platform.dart';
 
-const Platform instance = IOPlatform();
-
 /// [Platform] implementation that delegates directly to `dart:io`.
-class IOPlatform extends Platform {
-  /// Creates a new [IOPlatform].
-  const IOPlatform();
+class PlatformBase {
+  const PlatformBase();
 
-  @override
-  String get operatingSystem => io.Platform.operatingSystem;
+  OperatingSystem get operatingSystem {
+    switch (io.Platform.operatingSystem) {
+      case 'macos':
+        return OperatingSystem.macos;
+      case 'windows':
+        return OperatingSystem.windows;
+      case 'linux':
+        return OperatingSystem.linux;
+      case 'android':
+        return OperatingSystem.android;
+      case 'ios':
+        return OperatingSystem.ios;
+      case 'fuchsia':
+        return OperatingSystem.fuchsia;
+      default:
+        return OperatingSystem.unknown;
+    }
+  }
 
-  @override
-  String get operatingSystemVersion => io.Platform.operatingSystemVersion;
+  String? get operatingSystemVersion => io.Platform.operatingSystemVersion;
 
-  @override
   String get localHostname => io.Platform.localHostname;
+
+  bool get isWeb => false;
 }

dart/lib/src/platform/_web_platform.dart

@@ -2,40 +2,30 @@ import 'package:web/web.dart' as web;
 
 import 'platform.dart';
 
-const Platform instance = WebPlatform();
-
 /// [Platform] implementation that delegates to `dart:web`.
-class WebPlatform extends Platform {
-  /// Creates a new [Platform].
-  const WebPlatform();
-
-  @override
-  String get operatingSystem => _browserPlatform();
+class PlatformBase {
+  const PlatformBase();
 
-  @override
-  String get operatingSystemVersion => 'unknown';
-
-  @override
-  String get localHostname => web.window.location.hostname;
+  bool get isWeb => true;
 
-  String _browserPlatform() {
+  OperatingSystem get operatingSystem {
     final navigatorPlatform = web.window.navigator.platform.toLowerCase();
     if (navigatorPlatform.startsWith('mac')) {
-      return 'macos';
+      return OperatingSystem.macos;
     }
     if (navigatorPlatform.startsWith('win')) {
-      return 'windows';
+      return OperatingSystem.windows;
     }
     if (navigatorPlatform.contains('iphone') ||
         navigatorPlatform.contains('ipad') ||
         navigatorPlatform.contains('ipod')) {
-      return 'ios';
+      return OperatingSystem.ios;
     }
     if (navigatorPlatform.contains('android')) {
-      return 'android';
+      return OperatingSystem.android;
     }
     if (navigatorPlatform.contains('fuchsia')) {
-      return 'fuchsia';
+      return OperatingSystem.fuchsia;
     }
 
     // Since some phones can report a window.navigator.platform as Linux, fall
@@ -44,8 +34,12 @@ class WebPlatform extends Platform {
     // pointing device, then we'll assume desktop linux, and otherwise we'll
     // assume Android.
     if (web.window.matchMedia('only screen and (pointer: fine)').matches) {
-      return 'linux';
+      return OperatingSystem.linux;
     }
-    return 'android';
+    return OperatingSystem.android;
   }
+
+  String? get operatingSystemVersion => null;
+
+  String get localHostname => web.window.location.hostname;
 }

dart/lib/src/platform/mock_platform.dart

@@ -0,0 +1,52 @@
+import 'platform.dart';
+
+class MockPlatform extends Platform {
+  @override
+  late final bool isWeb;
+
+  @override
+  late final OperatingSystem operatingSystem;
+
+  @override
+  late final String? operatingSystemVersion;
+
+  @override
+  late final bool supportsNativeIntegration;
+
+  MockPlatform(
+      {OperatingSystem? operatingSystem,
+      String? operatingSystemVersion,
+      bool? isWeb,
+      bool? supportsNativeIntegration}) {
+    this.isWeb = isWeb ?? super.isWeb;
+    this.operatingSystem = operatingSystem ?? super.operatingSystem;
+    this.operatingSystemVersion =
+        operatingSystemVersion ?? super.operatingSystemVersion;
+    this.supportsNativeIntegration =
+        supportsNativeIntegration ?? super.supportsNativeIntegration;
+  }
+
+  factory MockPlatform.android({bool isWeb = false}) {
+    return MockPlatform(operatingSystem: OperatingSystem.android, isWeb: isWeb);
+  }
+
+  factory MockPlatform.iOS({bool isWeb = false}) {
+    return MockPlatform(operatingSystem: OperatingSystem.ios, isWeb: isWeb);
+  }
+
+  factory MockPlatform.macOS({bool isWeb = false}) {
+    return MockPlatform(operatingSystem: OperatingSystem.macos, isWeb: isWeb);
+  }
+
+  factory MockPlatform.linux({bool isWeb = false}) {
+    return MockPlatform(operatingSystem: OperatingSystem.linux, isWeb: isWeb);
+  }
+
+  factory MockPlatform.windows({bool isWeb = false}) {
+    return MockPlatform(operatingSystem: OperatingSystem.windows, isWeb: isWeb);
+  }
+
+  factory MockPlatform.fuchsia({bool isWeb = false}) {
+    return MockPlatform(operatingSystem: OperatingSystem.fuchsia, isWeb: isWeb);
+  }
+}

dart/lib/src/platform/platform.dart

@@ -1,41 +1,30 @@
-import 'dart:typed_data';
-
 import '_io_platform.dart' if (dart.library.js_interop) '_web_platform.dart'
-    as platform;
-
-const Platform instance = platform.instance;
+    as impl;
 
-abstract class Platform {
+class Platform extends impl.PlatformBase {
   const Platform();
 
-  /// A string (`linux`, `macos`, `windows`, `android`, `ios`, or `fuchsia`)
-  /// representing the operating system.
-  String get operatingSystem;
-
-  /// A string representing the version of the operating system or platform.
-  String get operatingSystemVersion;
+  bool get isLinux => operatingSystem == OperatingSystem.linux;
 
-  /// Get the local hostname for the system.
-  String get localHostname;
+  bool get isMacOS => operatingSystem == OperatingSystem.macos;
 
-  /// Endianness of this platform.
-  Endian get endian => Endian.host;
+  bool get isWindows => operatingSystem == OperatingSystem.windows;
 
-  /// True if the operating system is Linux.
-  bool get isLinux => (operatingSystem == 'linux');
+  bool get isAndroid => operatingSystem == OperatingSystem.android;
 
-  /// True if the operating system is OS X.
-  bool get isMacOS => (operatingSystem == 'macos');
+  bool get isIOS => operatingSystem == OperatingSystem.ios;
 
-  /// True if the operating system is Windows.
-  bool get isWindows => (operatingSystem == 'windows');
+  bool get isFuchsia => operatingSystem == OperatingSystem.fuchsia;
 
-  /// True if the operating system is Android.
-  bool get isAndroid => (operatingSystem == 'android');
-
-  /// True if the operating system is iOS.
-  bool get isIOS => (operatingSystem == 'ios');
+  bool get supportsNativeIntegration => !isFuchsia;
+}
 
-  /// True if the operating system is Fuchsia
-  bool get isFuchsia => (operatingSystem == 'fuchsia');
+enum OperatingSystem {
+  android,
+  fuchsia,
+  ios,
+  linux,
+  macos,
+  windows,
+  unknown,
 }

dart/lib/src/protocol/sdk_version.dart

@@ -71,6 +71,7 @@ class SdkVersion {
     final json = AccessAwareMap(data);
     final packagesJson = json['packages'] as List<dynamic>?;
     final integrationsJson = json['integrations'] as List<dynamic>?;
+
     return SdkVersion(
       name: json['name'],
       version: json['version'],