@sentry/react-native 5.0.0-alpha.8 → 5.0.0-beta.1

package/sentry.gradle

@@ -34,13 +34,18 @@ gradle.projectsEvaluated {
     // separately we then hook into the bundle task of react native to inject
     // sourcemap generation parameters.  In case for whatever reason no release
     // was found for the asset folder we just bail.
-    def bundleTasks = tasks.findAll { task -> task.name.startsWith("bundle") && task.name.endsWith("JsAndAssets") && !task.name.contains("Debug") && task.enabled }
+    def bundleTasks = tasks.findAll { task -> (task.name.startsWith("createBundle") || task.name.startsWith("bundle")) && task.name.endsWith("JsAndAssets") && !task.name.contains("Debug") && task.enabled }
     bundleTasks.each { bundleTask ->
         def shouldCleanUp
         def sourcemapOutput
         def bundleOutput
         def props = bundleTask.getProperties()
         def reactRoot = props.get("workingDir")
+        if (reactRoot == null) {
+            reactRoot = props.get("root").get() // RN 0.71 and above
+        }
+        def modulesOutput = "$reactRoot/android/app/src/main/assets/modules.json"
+        def modulesTask = null
 
         (shouldCleanUp, bundleOutput, sourcemapOutput) = forceSourceMapOutputFromBundleTask(bundleTask)
 
@@ -60,6 +65,7 @@ gradle.projectsEvaluated {
         def previousCliTask = null
 
         def nameCleanup = "${bundleTask.name}_SentryUploadCleanUp"
+        def nameModulesCleanup = "${bundleTask.name}_SentryCollectModulesCleanUp"
         // Upload the source map several times if necessary: once for each release and versionCode.
         currentVariants.each { key, currentVariant ->
           variant = currentVariant[0]
@@ -79,6 +85,7 @@ gradle.projectsEvaluated {
           // below) and distribution identifier (`--dist` below).  Give the task a unique name
           // based on where we're uploading to.
           def nameCliTask = "${bundleTask.name}_SentryUpload_${releaseName}_${versionCode}"
+          def nameModulesTask = "${bundleTask.name}_SentryCollectModules_${releaseName}_${versionCode}"
 
           // If several outputs have the same releaseName and versionCode, we'd do the exact same
           // upload for each of them.  No need to repeat.
@@ -153,6 +160,34 @@ gradle.projectsEvaluated {
               enabled true
           }
 
+          modulesTask = tasks.create(nameModulesTask, Exec) {
+              description = "collect javascript modules from bundle source map"
+              group = 'sentry.io'
+
+              workingDir reactRoot
+
+              def collectModulesScript = config.collectModulesScript
+                  ? file(config.collectModulesScript).getAbsolutePath()
+                  : "$reactRoot/node_modules/@sentry/react-native/dist/js/tools/collectModules.js"
+              def modulesPaths = config.modulesPaths
+                  ? config.modulesPaths.join(',')
+                  : "$reactRoot/node_modules"
+              def args = ["node",
+                          collectModulesScript,
+                          sourcemapOutput,
+                          modulesOutput,
+                          modulesPaths
+              ]
+
+              project.logger.info("Sentry-CollectModules arguments: ${args}")
+              commandLine(*args)
+
+              def skip = config.skipCollectModules
+                  ? config.skipCollectModules == true
+                  : false
+              enabled !skip
+          }
+
           // chain the upload tasks so they run sequentially in order to run
           // the cliCleanUpTask after the final upload task is run
           if (previousCliTask != null) {
@@ -161,6 +196,25 @@ gradle.projectsEvaluated {
             bundleTask.finalizedBy cliTask
           }
           previousCliTask = cliTask
+          cliTask.finalizedBy modulesTask
+        }
+
+        def modulesCleanUpTask = tasks.create(name: nameModulesCleanup, type: Delete) {
+            description = "clean up collected modules generated file"
+            group = 'sentry.io'
+
+            delete modulesOutput
+        }
+
+        def variantTaskName = variant.replaceAll("[\\s\\-()]", "") // variant is dev-release beta-release etc.
+        // task.name could be packageDev-debugRelease but in that case currentVariants == null
+        // because of the regex in `extractCurrentVariants` and this code doesn't run
+        def packageTasks = tasks.findAll {
+          task -> "package${variantTaskName}".equalsIgnoreCase(task.name) && task.enabled
+        }
+        packageTasks.each { packageTask ->
+            packageTask.dependsOn modulesTask
+            packageTask.finalizedBy modulesCleanUpTask
         }
 
         /** Delete sourcemap files */
@@ -169,7 +223,8 @@ gradle.projectsEvaluated {
             group = 'sentry.io'
 
             delete sourcemapOutput
-            delete "$buildDir/intermediates/assets/release/index.android.bundle.map" // react native default bundle dir
+            delete "$buildDir/intermediates/assets/release/index.android.bundle.map"
+            // react native default bundle dir
         }
 
         // register clean task extension
@@ -204,7 +259,7 @@ def extractReleasesInfo() {
 }
 
 /** Extract from arguments collection bundle and sourcemap files output names. */
-static extractBundleTaskArguments(cmdArgs, Project project) {
+static extractBundleTaskArgumentsLegacy(cmdArgs, Project project) {
     def bundleOutput = null
     def sourcemapOutput = null
 
@@ -248,6 +303,26 @@ static extractBundleTaskArguments(cmdArgs, Project project) {
     return [bundleOutput, sourcemapOutput]
 }
 
+/** Extract bundle and sourcemap paths from bundle task props.
+  * Based on https://github.dev/facebook/react-native/blob/473eb1dd870a4f62c4ebcba27e12bde1e99e3d07/packages/react-native-gradle-plugin/src/main/kotlin/com/facebook/react/tasks/BundleHermesCTask.kt#L109
+  * Output source map path is the same for both Hermes and JSC.
+  */
+static extractBundleTaskArgumentsRN71AndAbove(bundleTask, logger) {
+    def props = bundleTask.getProperties()
+    def bundleAssetName = props.bundleAssetName?.get()
+
+    if (bundleAssetName == null) {
+        return [null, null]
+    }
+
+    def bundleFile = new File(props.jsBundleDir.get().asFile.absolutePath, bundleAssetName)
+    def outputSourceMap = new File(props.jsSourceMapsDir.get().asFile.absolutePath, "${bundleAssetName}.map")
+
+    logger.info("bundleFile: `${bundleFile}`")
+    logger.info("outputSourceMap: `${outputSourceMap}`")
+    return [bundleFile, outputSourceMap]
+}
+
 /** Force Bundle task to produce sourcemap files if they are not pre-configured by user yet. */
 def forceSourceMapOutputFromBundleTask(bundleTask) {
     def props = bundleTask.getProperties()
@@ -257,7 +332,10 @@ def forceSourceMapOutputFromBundleTask(bundleTask) {
     def bundleOutput = null
     def sourcemapOutput = null
 
-    (bundleOutput, sourcemapOutput) = extractBundleTaskArguments(cmdArgs, project)
+    (bundleOutput, sourcemapOutput) = extractBundleTaskArgumentsRN71AndAbove(bundleTask, logger)
+    if (bundleOutput == null) {
+        (bundleOutput, sourcemapOutput) = extractBundleTaskArgumentsLegacy(cmdArgs, project)
+    }
 
     if (sourcemapOutput == null) {
         sourcemapOutput = bundleOutput + ".map"
@@ -280,8 +358,8 @@ def forceSourceMapOutputFromBundleTask(bundleTask) {
 
 /** compose array with one item - current build flavor name */
 static extractCurrentVariants(bundleTask, releases) {
-    // examples: bundleLocalReleaseJsAndAssets, bundleYellowDebugJsAndAssets
-    def pattern = Pattern.compile("bundle([A-Z][A-Za-z0-9_]+)JsAndAssets")
+    // examples: bundleLocalReleaseJsAndAssets, createBundleYellowDebugJsAndAssets
+    def pattern = Pattern.compile("(?:create)?(?:B|b)undle([A-Z][A-Za-z0-9_]+)JsAndAssets")
 
     def currentRelease = ""
 

package/src/js/NativeRNSentry.ts

@@ -0,0 +1,94 @@
+import type { Package } from '@sentry/types';
+import type { TurboModule} from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
+
+// There has to be only one interface and it has to be named `Spec`
+// Only extra allowed definitions are types (probably codegen bug)
+export interface Spec extends TurboModule {
+  addBreadcrumb(breadcrumb: UnsafeObject): void;
+  captureEnvelope(
+    bytes: number[],
+    options: {
+      store: boolean,
+    },
+  ): Promise<boolean>;
+  captureScreenshot(): Promise<NativeScreenshot[]>;
+  clearBreadcrumbs(): void;
+  crash(): void;
+  closeNativeSdk(): Promise<void>;
+  disableNativeFramesTracking(): void;
+  fetchNativeRelease(): Promise<NativeReleaseResponse>;
+  fetchNativeSdkInfo(): Promise<Package>;
+  fetchNativeDeviceContexts(): Promise<NativeDeviceContextsResponse>;
+  fetchNativeAppStart(): Promise<NativeAppStartResponse | null>;
+  fetchNativeFrames(): Promise<NativeFramesResponse | null>;
+  initNativeSdk(options: UnsafeObject): Promise<boolean>;
+  setUser(
+    defaultUserKeys: UnsafeObject | null,
+    otherUserKeys: UnsafeObject | null
+  ): void;
+  setContext(key: string, value: UnsafeObject | null): void;
+  setExtra(key: string, value: string): void;
+  setTag(key: string, value: string): void;
+  enableNativeFramesTracking(): void;
+  fetchModules(): Promise<string | undefined | null>;
+}
+
+export type NativeAppStartResponse = {
+  isColdStart: boolean;
+  appStartTime: number;
+  didFetchAppStart: boolean;
+};
+
+export type NativeFramesResponse = {
+  totalFrames: number;
+  slowFrames: number;
+  frozenFrames: number;
+};
+
+export type NativeReleaseResponse = {
+  build: string;
+  id: string;
+  version: string;
+};
+
+/**
+ * This type describes serialized scope from sentry-cocoa. (This is not used for Android)
+ * https://github.com/getsentry/sentry-cocoa/blob/master/Sources/Sentry/SentryScope.m
+ */
+export type NativeDeviceContextsResponse = {
+  [key: string]: unknown;
+  tags?: Record<string, string>;
+  extra?: Record<string, unknown>;
+  context?: Record<string, Record<string, unknown>>;
+  user?: {
+    userId?: string;
+    email?: string;
+    username?: string;
+    ipAddress?: string;
+    segment?: string;
+    data?: Record<string, unknown>;
+  };
+  dist?: string;
+  environment?: string;
+  fingerprint?: string[];
+  level?: string;
+  breadcrumbs?: {
+    level?: string;
+    timestamp?: string;
+    category?: string;
+    type?: string;
+    message?: string;
+    data?: Record<string, unknown>;
+  }[];
+};
+
+export type NativeScreenshot = {
+  data: number[];
+  contentType: string;
+  filename: string;
+}
+
+// The export must be here to pass codegen even if not used
+export default TurboModuleRegistry.getEnforcing<Spec>('RNSentry');