Sentry React Native 项目中 Hermes 引擎下的 Sourcemaps 问题分析与解决方案

问题背景

在 React Native 0.68 版本中使用 Sentry React Native SDK 5.20.0 时，当启用 Hermes 引擎后，Android 平台上的错误堆栈跟踪显示不正确。错误信息中出现了不相关的路径信息，如 /home/circleci/consumer-mobile-app/node_modules/@react-native-community/cli-plugin-metro/node_modules/metro-runtime/src/polyfills/require.js，而不是实际的源代码位置。

问题分析

Android 平台问题

在 Android 平台上，当启用 Hermes 引擎时，JavaScript 代码会被编译为字节码，这使得传统的 sourcemaps 处理方式不再适用。开发者尝试了两种不同的构建和上传 sourcemaps 的方法：

1. 使用 Fastlane 构建后直接上传：

   • 通过 compose-source-maps.js 合并打包器和编译器的 sourcemaps
   • 使用 sentry-cli 上传合并后的 sourcemaps

2. 手动构建 Hermes 字节码：

   • 使用 react-native bundle 生成初始 bundle
   • 使用 Hermes 编译器 (hermesc) 将 JS 转换为字节码
   • 合并 JS 和 Hermes 的 sourcemaps
   • 注入 debug ID
   • 上传最终产物

尽管尝试了这两种方法，错误堆栈仍然无法正确映射到源代码。

iOS 平台问题

虽然 iOS 平台没有启用 Hermes，但在手动上传 sourcemaps 时也遇到了问题。虽然堆栈跟踪看起来已经正确符号化，但仍有错误信息显示。

解决方案

Android 平台解决方案

1. 添加 --debug-id-reference 标志： 在上传 sourcemaps 时，必须添加 --debug-id-reference 标志。这个标志对于 Hermes 特别重要，因为 Hermes 生成的 bundle 不是纯文本格式，这个标志允许 CLI 从 sourcemaps 中推断出正确的调试信息。

   修改后的上传命令示例：

   npx sentry-cli releases files $RELEASE upload-sourcemaps \
     /path/to/index.android.bundle \
     /path/to/index.android.bundle.map \
     --dist $SENTRY_DIST \
     --url-prefix 'app:///' \
     --rewrite \
     --strip-prefix '/path/to/' \
     --debug-id-reference
   

2. 确保 Hermes 版本匹配： 确认使用的 Hermes 引擎版本与 React Native 版本兼容。React Native 0.68 应该使用相应版本的 Hermes。

3. 验证 sourcemaps 生成： 在上传前，可以手动检查生成的 sourcemaps 文件，确认它们包含预期的源代码映射信息。

iOS 平台解决方案

1. 检查 bundle 生成参数： 确保 react-native bundle 命令使用了正确的参数，特别是 --dev false 和 --minify true 用于生产环境。

2. 验证上传的 sourcemaps： 使用 sentry-cli releases files $RELEASE list 命令检查上传的文件，确认 sourcemaps 已正确上传。

3. 检查 URL 前缀： 确保 --url-prefix 参数与应用程序中使用的路径匹配。

最佳实践

1. 统一构建环境： 确保 CI 环境（如 CircleCI）中的构建环境与本地开发环境一致，避免因环境差异导致的问题。

2. 版本升级考虑： 考虑升级到较新版本的 Sentry React Native SDK，新版本可能包含对 Hermes 更好的支持。

3. 分阶段验证：

   • 先在开发环境中验证 sourcemaps 的正确性
   • 然后在 CI 环境中逐步实施
   • 最后在生产环境中部署

4. 错误监控： 在实施解决方案后，密切监控 Sentry 中的错误报告，确认堆栈跟踪是否已正确符号化。

总结

在 React Native 项目中使用 Hermes 引擎时，sourcemaps 的处理需要特别注意。通过正确配置构建流程和上传参数，特别是添加 --debug-id-reference 标志，可以解决大多数符号化问题。对于 iOS 平台，虽然问题相对简单，但仍需确保构建和上传流程的正确性。实施这些解决方案后，开发者可以获得准确的错误堆栈跟踪，从而更高效地诊断和修复问题。