Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 32 commits into
base: capture-app-start-errors
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
313e844
useNativeInit Android implementation
antonis Mar 7, 2025
2e97acc
Adds changelog
antonis Mar 7, 2025
6eedaae
useNativeInit iOS implementation
antonis Mar 7, 2025
9ae5475
Fix indentation
antonis Mar 7, 2025
566550e
Extend test cases with realistic data
antonis Mar 7, 2025
770c9f4
Adds code sample in the changelog
antonis Mar 7, 2025
f8b37b5
Fix CHANGELOG.md
antonis Apr 4, 2025
d25db30
Warn if RESentySDK.init/start wasn't injected
antonis Apr 4, 2025
adc81a5
Make useNativeInit opt-in
antonis Apr 15, 2025
8c2cd73
Make Android failure warning more clear
antonis Apr 15, 2025
a2b5575
Make Android no update warning more clear
antonis Apr 15, 2025
5f4f7c5
Use path.basename to get last path component
antonis Apr 15, 2025
0431cc3
Update tests to account for the new warnings
antonis Apr 15, 2025
62d39cc
Explicitly check for kotlin
antonis Apr 16, 2025
235f3ef
Add filename in the warning message
antonis Apr 16, 2025
369cce7
Import only if init injection succeeds
antonis Apr 16, 2025
a53c7f4
Explicitly check for Objective-C
antonis Apr 16, 2025
5e4a98f
Add filename in the warning
antonis Apr 16, 2025
dce74b2
Make iOS file not found warning more clear
antonis Apr 16, 2025
0ffd26c
Import only if init injection succeeds
antonis Apr 16, 2025
744993c
Reset test mock config in a function
antonis Apr 16, 2025
5447be9
Lint issue
antonis Apr 16, 2025
0b3423f
Add missing quote
antonis Apr 24, 2025
5c615fd
Remove unneeded async
antonis Jun 10, 2025
c356288
Set useNativeInit = false by default
antonis Jun 10, 2025
8e32556
dynamically fill white spaces
antonis Jun 10, 2025
a20984c
Add unsupported language in warning message
antonis Jun 11, 2025
d1db4fa
Add objcpp in detected languages
antonis Jun 11, 2025
7c25c2c
Merge branch 'antonis/4625-expo-useNativeInit' of https://github.com/…
antonis Jun 11, 2025
1918baf
Update tests for objcpp
antonis Jun 11, 2025
b2a89f2
ref(expo-plugin): Split utils to logger, version and utils (#4906)
krystofwoldrich Jun 16, 2025
3885d70
Merge branch 'capture-app-start-errors' into antonis/4625-expo-useNat…
lucas-zimerman Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,7 @@
### Features

- Add RNSentrySDK APIs support to @sentry/react-native/expo plugin ([#4633](https://github.com/getsentry/sentry-react-native/pull/4633))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit. It would be nice to include an example code snippet and a small summary of what will the flag do.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 🚫 The changelog entry seems to be part of an already released section ## 6.15.1.
    Consider moving the entry to the ## Unreleased section, please.

- 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()`.
Expand Down
41 changes: 41 additions & 0 deletions packages/core/plugin/src/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`;
}
39 changes: 0 additions & 39 deletions packages/core/plugin/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 };
8 changes: 8 additions & 0 deletions packages/core/plugin/src/version.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
10 changes: 6 additions & 4 deletions packages/core/plugin/src/withSentry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
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';
Expand All @@ -12,6 +13,7 @@ interface PluginProps {
project?: string;
authToken?: string;
url?: string;
useNativeInit?: boolean;
experimental_android?: SentryAndroidGradlePluginOptions;
}

Expand All @@ -26,7 +28,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}`);
}
Expand All @@ -39,7 +41,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}`);
}
Expand Down Expand Up @@ -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 };
74 changes: 69 additions & 5 deletions packages/core/plugin/src/withSentryAndroid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
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, config => {
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 config;
});
return withDangerousMod(cfg, [

const mainApplicationCfg = useNativeInit ? modifyMainApplication(appBuildGradleCfg) : appBuildGradleCfg;

return withDangerousMod(mainApplicationCfg, [
'android',
config => {
writeSentryPropertiesTo(path.resolve(config.modRequest.projectRoot, 'android'), sentryProperties);
Expand Down Expand Up @@ -49,3 +57,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 || !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`,
);
Comment on lines +78 to +81
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex pattern /(super\.onCreate\(\)[;\n]*)([ \t]*)/ may not handle all edge cases properly. For example, if there are multiple spaces or tabs before the next line, or if there are comments immediately after super.onCreate(), the insertion might not be placed correctly. Consider adding a test case for files with unusual formatting.

Did we get this right? 👍 / 👎 to inform future reviews.

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;
Comment on lines +82 to +93
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the regex replacement fails and the contents remain unchanged, only a warning is logged but the import statement might still be added in the else block. This could result in an orphaned import statement without the corresponding initialization call. Consider checking if the replacement was successful before adding the import statement.

Did we get this right? 👍 / 👎 to inform future reviews.

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;
});
}
2 changes: 1 addition & 1 deletion packages/core/plugin/src/withSentryAndroidGradlePlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { withAppBuildGradle, withProjectBuildGradle } from '@expo/config-plugins';

import { warnOnce } from './utils';
import { warnOnce } from './logger';

export interface SentryAndroidGradlePluginOptions {
enableAndroidGradlePlugin?: boolean;
Expand Down
73 changes: 68 additions & 5 deletions packages/core/plugin/src/withSentryIOS.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
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 };

Expand All @@ -12,8 +14,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(
Expand All @@ -36,7 +41,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);
Expand Down Expand Up @@ -79,3 +86,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 || !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`,
);
Comment on lines +107 to +109
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex pattern /(func application\([^)]*\) -> Bool \{)\s*\n(\s*)/s may fail to match if the function signature is split across multiple lines or has different whitespace patterns. Consider making the pattern more robust to handle multi-line function signatures:

/(func application\([^)]*\)\s*->\s*Bool\s*\{)\s*\n(\s*)/s

Did we get this right? 👍 / 👎 to inform future reviews.

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`);
}
Comment on lines +109 to +115
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the regex replacement fails and the contents remain unchanged, only a warning is logged but the import statement might still be added in the else block. This could result in an orphaned import statement without the corresponding initialization call. Consider checking if the replacement was successful before adding the import statement.

Did we get this right? 👍 / 👎 to inform future reviews.

} 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`,
Comment on lines +123 to +125
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex pattern /(- \(BOOL\)application:[\s\S]*?didFinishLaunchingWithOptions:[\s\S]*?\{\n)(\s*)/s is overly greedy and could potentially match unintended content if there are multiple methods with similar signatures. Consider making it more specific by including the method return or limiting the character classes:

/(- \(BOOL\)application:\(UIApplication \*\)\w+\s+didFinishLaunchingWithOptions:\(NSDictionary \*\)\w+\s*\{\n)(\s*)/s

Did we get this right? 👍 / 👎 to inform future reviews.

);
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;
});
}
4 changes: 2 additions & 2 deletions packages/core/test/expo-plugin/modifyAppBuildGradle.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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")
Expand Down
Loading
Loading