RN Sentry 源码分析

sentry-react-native(RN) 版本: 0.43.2
SentryReactNative(iOS): 0.1.5
Sentry(iOS): 4.1.3

一、JS 自定义事件

1. 在sentry初始化时(install方法)调用activateStacktraceMerging，触发原生桥接层的activateStacktraceMerging方法来拦截RN框架里面的invokeWithBridge 或者callNativeModule方法

2. 在_overwriteEnqueueNativeCall方法里面重写了BatchedBridge.enqueueNativeCall方法，在RN框架调用该方法前，通过new Error()生成了一个error对象，主动拿到调用栈并加到params里面，同时加入的还有moduleId

二、JS 异常自动捕获

主要是Raven 这个JS库(https://github.com/getsentry/sentry-javascript)，外面包装了一个RavenClient 。

1. 在RavenClient的install方法里面会调用Raven的一些方法，包括install, addPlugin, setTransport（原本是调用HTTP接口时触发，RN进行了重写）等，setTransport 有个回调函数，里面会调用sentry的_captureEvent方法，这个方法会触发原生的captrueEvent方法，同时也会对外提供captureMessage、captureException等方法。

2. React-native-sentry的install方法里面会初始化一个RavenClient，调用他的install方法，并监听一些事件回调（sentry事件存储和发送成功的回调），这里面还会对外提供captureMessage、captureException等方法，其中captureException就是处理异常的。

3. React-native-sentry的reactNativePlugin方法设置了一个全局的错误处理函数（见ErrorUtils.setGlobalHandler(function(error, isFatal))) ，里面调用了Raven的captureException。我们知道globalHandler 是全局异常处理函数，那么js的崩溃又是怎么捕获的呢？他是在框架底层通过try...catch...方式异常（调用每一个原生桥接方法以及原生调用回来都会有，参见MessageQuque.js 的__guard方法），然后调用reportFatalError把异常送到ErrorUtils里面去，再执行前面设置的globalHandler。

4. ErrorUtils里面有两个方法，reportFatalError是处理崩溃，reportError是一般错误的。fatalError默认会在RN页面红屏展示，error不会。

5. 在raven-js的src里面，可以找到 captureException: function(ex, options)方法，该方法会根据传入的ex类型判断是普通对象还是异常，如果是普通对象会通过new Error(message)生成一个error对象（跟自定义事件一样）,然后message 会设置为 Non-Error exception captured with keys:为开头的字符串；如果是异常的话，则直接取出error，其他情况会调用captureMessage进行上报（本来还有DOM异常要处理，但是RN不涉及）

6. 处理异常后，调用handleStackInfo -> _processException 进行异常的上报，这里面代码比较多，最终会走到(globalOptions.transport || this.makeRequest).call 这一句，使用第1步设置的transport函数进行上报。

   总结起来，流程就是异常产生时调用 React-native-sentry -> RavenClient->Raven-js 处理异常并上报。

三、iOS-存储和上报

1. JS调用原生模块时，会触发RN框架里面一个通用的方法invokeWithBridge:module:arguments: (RN版本>=0.45)或者callNativeModule:method:params:(RN版本<0.45)，在这个方法里面拿到params里传过来的sentry_stack，并写入 NSUserDefault（ key为RNSentry.sentry_stack），同时生成被调用方法的唯一地址（key为RNSentry.__sentry_address）

2. 在桥接层的captureEvent方法内通过sendEvent:withCompletionHandler: 方法，将异常发送给SentryClient.

3. SentryClient拿到异常后，先调用prepareEvent准备事件，这里会调用RNSentry的 injectReactNativeFrames方法拿到RNSentry.sentry_stack和RNSentry.sentry_address，解析callStack，赋值给SentryThread的stacktrace，跟sentryEvent的其他信息整合在一起。

4. 将完整的异常信息序列化，然后存储到本地，并发送给服务器。本地缓存目录是Cache/io.sentry/dsnHash(dsn的哈希值)/events

四、iOS-其他信息

1. 设备和系统的原始信息在 SentryCrashMonitor_System.m文件的初始化方法拿到，其中设备ID是通过 getDeviceAndAppHash方法拿到。然后经过SentryContext的归类，得到os、app、device三个对象，存到字典里面。
2. 在SentryEvent的addSimpleProperties方法里面，除了第1步拿到的设备和系统信息外，其他的信息（如用户、环境等）也会一并拿到，还有我们自定义上报的message、logger、tag等也在这个方法里面获取。