feat(symbolication): upload dart symbol mapping file

.github/workflows/integration-test.yml

@@ -47,7 +47,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
 
-      - run: sudo apt-get install ninja-build libgtk-3-dev
+      - run: sudo apt-get update && sudo apt-get install -y ninja-build libgtk-3-dev
         if: runner.os == 'Linux'
 
       - run: (flutter --version)[0] | Out-File flutter.version

lib/sentry_dart_plugin.dart

@@ -5,6 +5,8 @@ import 'package:process/process.dart';
 import 'package:sentry_dart_plugin/src/utils/extensions.dart';
 
 import 'src/configuration.dart';
+import 'src/utils/flutter_debug_files.dart';
+import 'src/utils/dart_symbol_map.dart';
 import 'src/utils/injector.dart';
 import 'src/utils/log.dart';
 
@@ -13,6 +15,8 @@ import 'src/utils/log.dart';
 class SentryDartPlugin {
   late Configuration _configuration;
   final symbolFileRegexp = RegExp(r'[/\\]app[^/\\]+.*\.(dSYM|symbols)$');
+  // Temporary feature flag: guarded no-op until sentry-cli supports Dart symbol map upload.
+  final bool _dartSymbolMapUploadEnabled = false;
 
   /// SentryDartPlugin ctor. that inits the injectors
   SentryDartPlugin() {
@@ -86,7 +90,8 @@ class SentryDartPlugin {
     _addWait(params);
 
     final fs = injector.get<FileSystem>();
-    final debugSymbolPaths = _enumerateDebugSymbolPaths(fs);
+    final debugSymbolPaths =
+        enumerateDebugSearchRoots(fs: fs, config: _configuration);
     await for (final path in debugSymbolPaths) {
       if (await fs.directory(path).exists() || await fs.file(path).exists()) {
         await _executeAndLog('Failed to upload symbols', [...params, path]);
@@ -97,59 +102,9 @@ class SentryDartPlugin {
       await _executeAndLog('Failed to upload symbols', [...params, path]);
     }
 
-    Log.taskCompleted(taskName);
-  }
-
-  Stream<String> _enumerateDebugSymbolPaths(FileSystem fs) async* {
-    final buildDir = _configuration.buildFilesFolder;
-    final projectRoot = fs.currentDirectory.path;
-
-    // Android (apk, appbundle)
-    yield '$buildDir/app/outputs';
-    yield '$buildDir/app/intermediates';
-
-    // Windows
-    for (final subdir in ['', '/x64', '/arm64']) {
-      yield '$buildDir/windows$subdir/runner/Release';
-    }
-    // TODO we should delete this once we have windows symbols collected automatically.
-    // Related to https://github.com/getsentry/sentry-dart-plugin/issues/173
-    yield 'windows/flutter/ephemeral/flutter_windows.dll.pdb';
+    await _tryUploadDartSymbolMap();
 
-    // Linux
-    for (final subdir in ['/x64', '/arm64']) {
-      yield '$buildDir/linux$subdir/release/bundle';
-    }
-
-    // macOS
-    yield '$buildDir/macos/Build/Products/Release';
-
-    // macOS (macOS-framework)
-    yield '$buildDir/macos/framework/Release';
-
-    // iOS
-    yield '$buildDir/ios/iphoneos/Runner.app';
-    if (await fs.directory('$buildDir/ios').exists()) {
-      final regexp = RegExp(r'^Release(-.*)?-iphoneos$');
-      yield* fs
-          .directory('$buildDir/ios')
-          .list()
-          .where((v) => regexp.hasMatch(v.basename))
-          .map((e) => e.path);
-    }
-
-    // iOS (ipa)
-    yield '$buildDir/ios/archive';
-
-    // iOS (ios-framework)
-    yield '$buildDir/ios/framework/Release';
-
-    // iOS in Fastlane
-    if (projectRoot == '/') {
-      yield 'ios/build';
-    } else {
-      yield '$projectRoot/ios/build';
-    }
+    Log.taskCompleted(taskName);
   }
 
   Future<Set<String>> _enumerateSymbolFiles() async {
@@ -194,6 +149,75 @@ class SentryDartPlugin {
     return params;
   }
 
+  /// Guarded implementation for uploading Dart symbol map alongside each relevant debug file.
+  /// Currently a no-op until `_dartSymbolMapUploadEnabled` is flipped to true.
+  Future<void> _tryUploadDartSymbolMap() async {
+    if (!_dartSymbolMapUploadEnabled) {
+      Log.info('Dart symbol map upload is disabled in this version. Skipping.');
+      return;
+    }
+
+    const taskName = 'uploading Dart symbol map(s)';
+    Log.startingTask(taskName);
+
+    try {
+      final fs = injector.get<FileSystem>();
+
+      // Check for explicitly provided and valid Dart symbol map (wire to config in a follow-up).
+      final symbolMapPath = await resolveDartSymbolMapPath(
+        fs: fs,
+        configuredPath: null,
+      );
+      if (symbolMapPath == null) {
+        Log.warn(
+          "No 'dart_symbol_map_path' provided. Set --sentry-define --dart_symbol_map_path=/abs/path/to/map to enable Dart obfuscation map usage. Skipping Dart symbol map uploads.",
+        );
+        Log.taskCompleted(taskName);
+        return;
+      }
+
+      final debugFilePaths = await findFlutterRelevantDebugFilePaths(
+        fs: fs,
+        config: _configuration,
+      );
+
+      if (debugFilePaths.isEmpty) {
+        Log.info(
+            'No Flutter-relevant debug files found for Dart symbol map upload.');
+        Log.taskCompleted(taskName);
+        return;
+      }
+
+      for (final debugFilePath in debugFilePaths) {
+        // Accept both files and directories, mirroring current symbol search behavior.
+        final isFile = await fs.file(debugFilePath).exists();
+        final isDir = await fs.directory(debugFilePath).exists();
+        if (!isFile && !isDir) {
+          continue;
+        }
+
+        final params = <String>[];
+        _setUrlAndTokenAndLog(params);
+        params.add('dart-symbol-map');
+        params.add('upload');
+        _addOrgAndProject(params);
+        _addWait(params);
+        params.add(symbolMapPath);
+        params.add(debugFilePath);
+
+        await _executeAndLog(
+          'Failed to upload Dart symbol map for $debugFilePath',
+          params,
+        );
+      }
+
+      Log.taskCompleted(taskName);
+    } catch (e) {
+      Log.error('Dart symbol map upload failed: $e');
+      Log.taskCompleted(taskName);
+    }
+  }
+
   Future<void> _executeNewRelease(String release) async {
     await _executeAndLog('Failed to create a new release',
         [..._releasesCliParams(), 'new', release]);

lib/src/configuration.dart

@@ -73,6 +73,9 @@ class Configuration {
   /// The directory passed to `--split-debug-info`, defaults to '.'
   late String symbolsFolder;
 
+  /// Explicit path to the Dart obfuscation map file. Optional.
+  late String? dartSymbolMapPath;
+
   /// The URL prefix, defaults to null
   late String? urlPrefix;
 
@@ -154,6 +157,7 @@ class Configuration {
     final webBuildPath = configValues.webBuildPath ?? 'web';
     webBuildFilesFolder = _fs.path.join(buildFilesFolder, webBuildPath);
     symbolsFolder = configValues.symbolsPath ?? '.';
+    dartSymbolMapPath = configValues.dartSymbolMapPath;
 
     project = configValues.project; // or env. var. SENTRY_PROJECT
     org = configValues.org; // or env. var. SENTRY_ORG

lib/src/configuration_values.dart

@@ -20,6 +20,7 @@ class ConfigurationValues {
   final String? buildPath;
   final String? webBuildPath;
   final String? symbolsPath;
+  final String? dartSymbolMapPath;
   final String? commits;
   final bool? ignoreMissing;
   final String? binDir;
@@ -46,6 +47,7 @@ class ConfigurationValues {
     this.buildPath,
     this.webBuildPath,
     this.symbolsPath,
+    this.dartSymbolMapPath,
     this.commits,
     this.ignoreMissing,
     this.binDir,
@@ -99,6 +101,7 @@ class ConfigurationValues {
       buildPath: sentryArguments['build_path'],
       webBuildPath: sentryArguments['web_build_path'],
       symbolsPath: sentryArguments['symbols_path'],
+      dartSymbolMapPath: sentryArguments['dart_symbol_map_path'],
       commits: sentryArguments['commits'],
       ignoreMissing: boolFromString(sentryArguments['ignore_missing']),
       binDir: sentryArguments['bin_dir'],
@@ -136,6 +139,7 @@ class ConfigurationValues {
       buildPath: configReader.getString('build_path'),
       webBuildPath: configReader.getString('web_build_path'),
       symbolsPath: configReader.getString('symbols_path'),
+      dartSymbolMapPath: configReader.getString('dart_symbol_map_path'),
       commits: configReader.getString('commits'),
       ignoreMissing: configReader.getBool('ignore_missing'),
       binDir: configReader.getString('bin_dir'),
@@ -161,10 +165,15 @@ class ConfigurationValues {
     if (envSentryCliCdnUrl?.isEmpty ?? false) {
       envSentryCliCdnUrl = null;
     }
+    String? envDartSymbolMapPath = environment['SENTRY_DART_SYMBOL_MAP_PATH'];
+    if (envDartSymbolMapPath?.isEmpty ?? false) {
+      envDartSymbolMapPath = null;
+    }
     return ConfigurationValues(
       release: envRelease,
       dist: envDist,
       sentryCliCdnUrl: envSentryCliCdnUrl,
+      dartSymbolMapPath: envDartSymbolMapPath,
     );
   }
 
@@ -191,6 +200,9 @@ class ConfigurationValues {
       buildPath: args.buildPath ?? file.buildPath,
       webBuildPath: args.webBuildPath ?? file.webBuildPath,
       symbolsPath: args.symbolsPath ?? file.symbolsPath,
+      dartSymbolMapPath: platformEnv.dartSymbolMapPath ??
+          args.dartSymbolMapPath ??
+          file.dartSymbolMapPath,
       commits: args.commits ?? file.commits,
       ignoreMissing: args.ignoreMissing ?? file.ignoreMissing,
       binDir: args.binDir ?? file.binDir,

lib/src/utils/dart_symbol_map.dart

@@ -0,0 +1,104 @@
+import 'package:file/file.dart';
+
+import '../configuration.dart';
+import 'flutter_debug_files.dart';
+
+/// If [configuredPath] is provided, validates and returns the absolute path to the Dart symbol map.
+/// If not provided, returns null.
+///
+/// Note: we do not scan the filesystem for this file because the file does not
+/// have a special extension so worst case we would have to check every file.
+Future<String?> resolveDartSymbolMapPath({
+  required FileSystem fs,
+  String? configuredPath,
+}) async {
+  if (configuredPath == null || configuredPath.isEmpty) return null;
+
+  final file = fs.file(configuredPath);
+  if (!await file.exists()) {
+    throw StateError(
+      "Dart symbol map file not found at '$configuredPath'. Ensure the path is correct and the file exists.",
+    );
+  }
+
+  return file.absolute.path;
+}
+
+/// Finds Flutter-relevant debug file paths for Android and Apple (iOS/macOS)
+/// that should be paired with a Dart symbol map.
+Future<Set<String>> findFlutterRelevantDebugFilePaths({
+  required FileSystem fs,
+  required Configuration config,
+}) async {
+  final Set<String> foundPaths = <String>{};
+
+  Future<void> collectAndroidSymbolsUnder(String rootPath) async {
+    if (rootPath.isEmpty) return;
+
+    final directory = fs.directory(rootPath);
+    if (await directory.exists()) {
+      await for (final entity
+          in directory.list(recursive: true, followLinks: false)) {
+        if (entity is! File) continue;
+        final String basename = fs.path.basename(entity.path);
+        if (basename.startsWith('app') &&
+            basename.endsWith('.symbols') &&
+            !basename.contains('darwin')) {
+          foundPaths.add(fs.file(entity.path).absolute.path);
+        }
+      }
+      return;
+    }
+
+    final file = fs.file(rootPath);
+    if (await file.exists()) {
+      final String basename = fs.path.basename(file.path);
+      if (basename.startsWith('app') &&
+          basename.endsWith('.symbols') &&
+          !basename.contains('darwin')) {
+        foundPaths.add(file.absolute.path);
+      }
+    }
+  }
+
+  if (config.symbolsFolder.isNotEmpty) {
+    await collectAndroidSymbolsUnder(config.symbolsFolder);
+  }
+
+  if (config.buildFilesFolder != config.symbolsFolder) {
+    await collectAndroidSymbolsUnder(config.buildFilesFolder);
+  }
+
+  Future<void> collectAppleMachOUnder(String rootPath) async {
+    if (rootPath.isEmpty) return;
+    final dir = fs.directory(rootPath);
+    if (!await dir.exists()) return;
+
+    await for (final entity in dir.list(recursive: true, followLinks: false)) {
+      if (entity is! Directory) continue;
+      final String basename = fs.path.basename(entity.path);
+      if (basename == 'App.framework.dSYM') {
+        final String machOPath = fs.path.join(
+          entity.path,
+          'Contents',
+          'Resources',
+          'DWARF',
+          'App',
+        );
+        final File machOFile = fs.file(machOPath);
+        if (await machOFile.exists()) {
+          foundPaths.add(machOFile.absolute.path);
+        }
+      }
+    }
+  }
+
+  await collectAppleMachOUnder(config.buildFilesFolder);
+
+  await for (final root in enumerateDebugSearchRoots(fs: fs, config: config)) {
+    await collectAppleMachOUnder(root);
+    await collectAndroidSymbolsUnder(root);
+  }
+
+  return foundPaths;
+}