feat(expo): Add RNSentrySDK APIs support to @sentry/react-native/expo plugin

CHANGELOG.md

@@ -1168,6 +1168,7 @@ We apologize for any inconvenience caused!
 
 ### Features
 
+- Add RNSentrySDK APIs support to @sentry/react-native/expo plugin ([#4633](https://github.com/getsentry/sentry-react-native/pull/4633))
 - User Feedback Widget Beta ([#4435](https://github.com/getsentry/sentry-react-native/pull/4435))
 
   To collect user feedback from inside your application call `Sentry.showFeedbackWidget()`.

packages/core/plugin/src/logger.ts

@@ -0,0 +1,41 @@
+const warningMap = new Map<string, boolean>();
+
+/**
+ * Log a warning message only once per run.
+ * This is used to avoid spamming the console with the same message.
+ */
+export function warnOnce(message: string): void {
+  if (!warningMap.has(message)) {
+    warningMap.set(message, true);
+    // eslint-disable-next-line no-console
+    console.warn(yellow(prefix(message)));
+  }
+}
+
+/**
+ * Prefix message with `› [value]`.
+ *
+ * Example:
+ * ```
+ * › [@sentry/react-native/expo] This is a warning message
+ * ```
+ */
+export function prefix(value: string): string {
+  return `› ${bold('[@sentry/react-native/expo]')} ${value}`;
+}
+
+/**
+ * The same as `chalk.yellow`
+ * This code is part of the SDK, we don't want to introduce a dependency on `chalk` just for this.
+ */
+export function yellow(message: string): string {
+  return `\x1b[33m${message}\x1b[0m`;
+}
+
+/**
+ * The same as `chalk.bold`
+ * This code is part of the SDK, we don't want to introduce a dependency on `chalk` just for this.
+ */
+export function bold(message: string): string {
+  return `\x1b[1m${message}\x1b[22m`;
+}

packages/core/plugin/src/utils.ts

@@ -8,42 +8,3 @@ export function writeSentryPropertiesTo(filepath: string, sentryProperties: stri
 
   fs.writeFileSync(path.resolve(filepath, 'sentry.properties'), sentryProperties);
 }
-
-const sdkPackage: {
-  name: string;
-  version: string;
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-} = require('../../package.json');
-
-const SDK_PACKAGE_NAME = `${sdkPackage.name}/expo`;
-
-const warningMap = new Map<string, boolean>();
-export function warnOnce(message: string): void {
-  if (!warningMap.has(message)) {
-    warningMap.set(message, true);
-    // eslint-disable-next-line no-console
-    console.warn(yellow(`${logPrefix()} ${message}`));
-  }
-}
-
-export function logPrefix(): string {
-  return `› ${bold('[@sentry/react-native/expo]')}`;
-}
-
-/**
- * The same as `chalk.yellow`
- * This code is part of the SDK, we don't want to introduce a dependency on `chalk` just for this.
- */
-export function yellow(message: string): string {
-  return `\x1b[33m${message}\x1b[0m`;
-}
-
-/**
- * The same as `chalk.bold`
- * This code is part of the SDK, we don't want to introduce a dependency on `chalk` just for this.
- */
-export function bold(message: string): string {
-  return `\x1b[1m${message}\x1b[22m`;
-}
-
-export { sdkPackage, SDK_PACKAGE_NAME };

packages/core/plugin/src/version.ts

@@ -0,0 +1,8 @@
+const packageJson: {
+  name: string;
+  version: string;
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+} = require('../../package.json');
+
+export const PLUGIN_NAME = `${packageJson.name}/expo`;
+export const PLUGIN_VERSION = packageJson.version;

packages/core/plugin/src/withSentry.ts

@@ -1,6 +1,7 @@
 import type { ConfigPlugin } from 'expo/config-plugins';
 import { createRunOncePlugin } from 'expo/config-plugins';
-import { bold, sdkPackage, warnOnce } from './utils';
+import { bold, warnOnce } from './logger';
+import { PLUGIN_NAME, PLUGIN_VERSION } from './version';
 import { withSentryAndroid } from './withSentryAndroid';
 import type { SentryAndroidGradlePluginOptions } from './withSentryAndroidGradlePlugin';
 import { withSentryAndroidGradlePlugin } from './withSentryAndroidGradlePlugin';
@@ -11,6 +12,7 @@ interface PluginProps {
   project?: string;
   authToken?: string;
   url?: string;
+  useNativeInit?: boolean;
   experimental_android?: SentryAndroidGradlePluginOptions;
 }
 
@@ -25,7 +27,7 @@ const withSentryPlugin: ConfigPlugin<PluginProps | void> = (config, props) => {
   let cfg = config;
   if (sentryProperties !== null) {
     try {
-      cfg = withSentryAndroid(cfg, sentryProperties);
+      cfg = withSentryAndroid(cfg, { sentryProperties, useNativeInit: props?.useNativeInit });
     } catch (e) {
       warnOnce(`There was a problem with configuring your native Android project: ${e}`);
     }
@@ -38,7 +40,7 @@ const withSentryPlugin: ConfigPlugin<PluginProps | void> = (config, props) => {
       }
     }
     try {
-      cfg = withSentryIOS(cfg, sentryProperties);
+      cfg = withSentryIOS(cfg, { sentryProperties, useNativeInit: props?.useNativeInit });
     } catch (e) {
       warnOnce(`There was a problem with configuring your native iOS project: ${e}`);
     }
@@ -79,6 +81,6 @@ ${authToken ? `${existingAuthTokenMessage}\nauth.token=${authToken}` : missingAu
 }
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-const withSentry = createRunOncePlugin(withSentryPlugin, sdkPackage.name, sdkPackage.version);
+const withSentry = createRunOncePlugin(withSentryPlugin, PLUGIN_NAME, PLUGIN_VERSION);
 
 export { withSentry };

packages/core/plugin/src/withSentryAndroid.ts

@@ -1,18 +1,26 @@
+import type { ExpoConfig } from '@expo/config-types';
 import type { ConfigPlugin } from 'expo/config-plugins';
-import { withAppBuildGradle, withDangerousMod } from 'expo/config-plugins';
+import { withAppBuildGradle, withDangerousMod, withMainApplication } from 'expo/config-plugins';
 import * as path from 'path';
-import { warnOnce, writeSentryPropertiesTo } from './utils';
+import { warnOnce } from './logger';
+import { writeSentryPropertiesTo } from './utils';
 
-export const withSentryAndroid: ConfigPlugin<string> = (config, sentryProperties: string) => {
-  const cfg = withAppBuildGradle(config, appBuildGradle => {
-    if (appBuildGradle.modResults.language === 'groovy') {
-      appBuildGradle.modResults.contents = modifyAppBuildGradle(appBuildGradle.modResults.contents);
+export const withSentryAndroid: ConfigPlugin<{ sentryProperties: string; useNativeInit: boolean | undefined }> = (
+  config,
+  { sentryProperties, useNativeInit = false },
+) => {
+  const appBuildGradleCfg = withAppBuildGradle(config, config => {
+    if (config.modResults.language === 'groovy') {
+      config.modResults.contents = modifyAppBuildGradle(config.modResults.contents);
     } else {
       throw new Error('Cannot configure Sentry in the app gradle because the build.gradle is not groovy');
     }
-    return appBuildGradle;
+    return config;
   });
-  return withDangerousMod(cfg, [
+
+  const mainApplicationCfg = useNativeInit ? modifyMainApplication(appBuildGradleCfg) : appBuildGradleCfg;
+
+  return withDangerousMod(mainApplicationCfg, [
     'android',
     dangerousMod => {
       writeSentryPropertiesTo(path.resolve(dangerousMod.modRequest.projectRoot, 'android'), sentryProperties);
@@ -48,3 +56,59 @@ export function modifyAppBuildGradle(buildGradle: string): string {
 
   return buildGradle.replace(pattern, match => `${applyFrom}\n\n${match}`);
 }
+
+export function modifyMainApplication(config: ExpoConfig): ExpoConfig {
+  return withMainApplication(config, config => {
+    if (!config.modResults?.path) {
+      warnOnce("Can't add 'RNSentrySDK.init' to Android MainApplication, because the file was not found.");
+      return config;
+    }
+
+    const fileName = path.basename(config.modResults.path);
+
+    if (config.modResults.contents.includes('RNSentrySDK.init')) {
+      warnOnce(`Your '${fileName}' already contains 'RNSentrySDK.init', the native code won't be updated.`);
+      return config;
+    }
+
+    if (config.modResults.language === 'java') {
+      // Add RNSentrySDK.init
+      const originalContents = config.modResults.contents;
+      config.modResults.contents = config.modResults.contents.replace(
+        /(super\.onCreate\(\)[;\n]*)([ \t]*)/,
+        '$1\n$2RNSentrySDK.init(this);\n$2',
+      );
+      if (config.modResults.contents === originalContents) {
+        warnOnce(`Failed to insert 'RNSentrySDK.init' in '${fileName}'.`);
+      } else if (!config.modResults.contents.includes('import io.sentry.react.RNSentrySDK;')) {
+        // Insert import statement after package declaration
+        config.modResults.contents = config.modResults.contents.replace(
+          /(package .*;\n\n?)/,
+          '$1import io.sentry.react.RNSentrySDK;\n',
+        );
+      }
+    } else if (config.modResults.language === 'kt') {
+      // Add RNSentrySDK.init
+      const originalContents = config.modResults.contents;
+      config.modResults.contents = config.modResults.contents.replace(
+        /(super\.onCreate\(\)[;\n]*)([ \t]*)/,
+        '$1\n$2RNSentrySDK.init(this)\n$2',
+      );
+      if (config.modResults.contents === originalContents) {
+        warnOnce(`Failed to insert 'RNSentrySDK.init' in '${fileName}'.`);
+      } else if (!config.modResults.contents.includes('import io.sentry.react.RNSentrySDK')) {
+        // Insert import statement after package declaration
+        config.modResults.contents = config.modResults.contents.replace(
+          /(package .*\n\n?)/,
+          '$1import io.sentry.react.RNSentrySDK\n',
+        );
+      }
+    } else {
+      warnOnce(
+        `Unsupported language '${config.modResults.language}' detected in '${fileName}', the native code won't be updated.`,
+      );
+    }
+
+    return config;
+  });
+}

packages/core/plugin/src/withSentryAndroidGradlePlugin.ts

@@ -1,6 +1,6 @@
 import { withAppBuildGradle, withProjectBuildGradle } from '@expo/config-plugins';
 import type { ExpoConfig } from '@expo/config-types';
-import { warnOnce } from './utils';
+import { warnOnce } from './logger';
 
 export interface SentryAndroidGradlePluginOptions {
   enableAndroidGradlePlugin?: boolean;

packages/core/plugin/src/withSentryIOS.ts

@@ -1,8 +1,10 @@
+import type { ExpoConfig } from '@expo/config-types';
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import type { ConfigPlugin, XcodeProject } from 'expo/config-plugins';
-import { withDangerousMod, withXcodeProject } from 'expo/config-plugins';
+import { withAppDelegate, withDangerousMod, withXcodeProject } from 'expo/config-plugins';
 import * as path from 'path';
-import { warnOnce, writeSentryPropertiesTo } from './utils';
+import { warnOnce } from './logger';
+import { writeSentryPropertiesTo } from './utils';
 
 type BuildPhase = { shellScript: string };
 
@@ -11,8 +13,11 @@ const SENTRY_REACT_NATIVE_XCODE_PATH =
 const SENTRY_REACT_NATIVE_XCODE_DEBUG_FILES_PATH =
   "`${NODE_BINARY:-node} --print \"require('path').dirname(require.resolve('@sentry/react-native/package.json')) + '/scripts/sentry-xcode-debug-files.sh'\"`";
 
-export const withSentryIOS: ConfigPlugin<string> = (config, sentryProperties: string) => {
-  const cfg = withXcodeProject(config, config => {
+export const withSentryIOS: ConfigPlugin<{ sentryProperties: string; useNativeInit: boolean | undefined }> = (
+  config,
+  { sentryProperties, useNativeInit = false },
+) => {
+  const xcodeProjectCfg = withXcodeProject(config, config => {
     const xcodeProject: XcodeProject = config.modResults;
 
     const sentryBuildPhase = xcodeProject.pbxItemByComment(
@@ -35,7 +40,9 @@ export const withSentryIOS: ConfigPlugin<string> = (config, sentryProperties: st
     return config;
   });
 
-  return withDangerousMod(cfg, [
+  const appDelegateCfc = useNativeInit ? modifyAppDelegate(xcodeProjectCfg) : xcodeProjectCfg;
+
+  return withDangerousMod(appDelegateCfc, [
     'ios',
     config => {
       writeSentryPropertiesTo(path.resolve(config.modRequest.projectRoot, 'ios'), sentryProperties);
@@ -78,3 +85,59 @@ export function addSentryWithBundledScriptsToBundleShellScript(script: string):
     (match: string) => `/bin/sh ${SENTRY_REACT_NATIVE_XCODE_PATH} ${match}`,
   );
 }
+
+export function modifyAppDelegate(config: ExpoConfig): ExpoConfig {
+  return withAppDelegate(config, async config => {
+    if (!config.modResults?.path) {
+      warnOnce("Can't add 'RNSentrySDK.start()' to the iOS AppDelegate, because the file was not found.");
+      return config;
+    }
+
+    const fileName = path.basename(config.modResults.path);
+
+    if (config.modResults.language === 'swift') {
+      if (config.modResults.contents.includes('RNSentrySDK.start()')) {
+        warnOnce(`Your '${fileName}' already contains 'RNSentrySDK.start()'.`);
+        return config;
+      }
+      // Add RNSentrySDK.start() at the beginning of application method
+      const originalContents = config.modResults.contents;
+      config.modResults.contents = config.modResults.contents.replace(
+        /(func application\([^)]*\) -> Bool \{)\s*\n(\s*)/s,
+        '$1\n$2RNSentrySDK.start()\n$2',
+      );
+      if (config.modResults.contents === originalContents) {
+        warnOnce(`Failed to insert 'RNSentrySDK.start()' in '${fileName}'.`);
+      } else if (!config.modResults.contents.includes('import RNSentry')) {
+        // Insert import statement after UIKit import
+        config.modResults.contents = config.modResults.contents.replace(/(import UIKit\n)/, '$1import RNSentry\n');
+      }
+    } else if (['objcpp', 'objc'].includes(config.modResults.language)) {
+      if (config.modResults.contents.includes('[RNSentrySDK start]')) {
+        warnOnce(`Your '${fileName}' already contains '[RNSentrySDK start]'.`);
+        return config;
+      }
+      // Add [RNSentrySDK start] at the beginning of application:didFinishLaunchingWithOptions method
+      const originalContents = config.modResults.contents;
+      config.modResults.contents = config.modResults.contents.replace(
+        /(- \(BOOL\)application:[\s\S]*?didFinishLaunchingWithOptions:[\s\S]*?\{\n)(\s*)/s,
+        '$1$2[RNSentrySDK start];\n$2',
+      );
+      if (config.modResults.contents === originalContents) {
+        warnOnce(`Failed to insert '[RNSentrySDK start]' in '${fileName}.`);
+      } else if (!config.modResults.contents.includes('#import <RNSentry/RNSentry.h>')) {
+        // Add import after AppDelegate.h
+        config.modResults.contents = config.modResults.contents.replace(
+          /(#import "AppDelegate.h"\n)/,
+          '$1#import <RNSentry/RNSentry.h>\n',
+        );
+      }
+    } else {
+      warnOnce(
+        `Unsupported language '${config.modResults.language}' detected in '${fileName}', the native code won't be updated.`,
+      );
+    }
+
+    return config;
+  });
+}

packages/core/test/expo-plugin/modifyAppBuildGradle.test.ts

@@ -1,7 +1,7 @@
-import { warnOnce } from '../../plugin/src/utils';
+import { warnOnce } from '../../plugin/src/logger';
 import { modifyAppBuildGradle } from '../../plugin/src/withSentryAndroid';
 
-jest.mock('../../plugin/src/utils');
+jest.mock('../../plugin/src/logger');
 
 const buildGradleWithSentry = `
 apply from: new File(["node", "--print", "require('path').dirname(require.resolve('@sentry/react-native/package.json'))"].execute().text.trim(), "sentry.gradle")