feat(xcode): Dynamically resolve SDK and CLI package paths (#3431)

Author: krystofwoldrich

CHANGELOG.md

@@ -30,6 +30,9 @@
   });
   ```
 
+- Update `sentry-xcode.sh` scripts with Node modules resolution ([#3450](https://github.com/getsentry/sentry-react-native/pull/3450))
+  - RN SDK and Sentry CLI are dynamically resolved if override is not supplied
+
 ### Fixes
 
 - Transform shipped JSX for both react-native and web ([#3428](https://github.com/getsentry/sentry-react-native/pull/3428))

package.json

@@ -31,10 +31,10 @@
     "test:tools": "jest --config jest.config.tools.js",
     "fix": "yarn fix:eslint && yarn fix:prettier",
     "fix:eslint": "eslint --config .eslintrc.js --fix .",
-    "fix:prettier": "prettier --write \"{src,test,scripts}/**/**.ts\"",
+    "fix:prettier": "prettier --write \"{src,test,scripts,plugin/src}/**/**.ts\"",
     "lint": "yarn lint:eslint && yarn lint:prettier",
     "lint:eslint": "eslint --config .eslintrc.js .",
-    "lint:prettier": "prettier --check \"{src,test,scripts}/**/**.ts\"",
+    "lint:prettier": "prettier --check \"{src,test,scripts,plugin/src}/**/**.ts\"",
     "test:watch": "jest --watch",
     "run-ios": "cd sample-new-architecture && yarn react-native run-ios",
     "run-android": "cd sample-new-architecture && yarn react-native run-android",

plugin/src/index.ts

@@ -1,7 +1,5 @@
 import { withSentry } from './withSentry';
 
-export {
-  withSentry,
-};
+export { withSentry };
 
 export default withSentry;

plugin/src/utils.ts

@@ -0,0 +1,20 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+export function writeSentryPropertiesTo(filepath: string, sentryProperties: string): void {
+  if (!fs.existsSync(filepath)) {
+    throw new Error(`Directory '${filepath}' does not exist.`);
+  }
+
+  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;
+
+export { sdkPackage, SDK_PACKAGE_NAME };

plugin/src/withSentry.ts

@@ -1,12 +1,10 @@
 import type { ConfigPlugin } from 'expo/config-plugins';
 import { createRunOncePlugin, WarningAggregator } from 'expo/config-plugins';
 
+import { SDK_PACKAGE_NAME, sdkPackage } from './utils';
 import { withSentryAndroid } from './withSentryAndroid';
 import { withSentryIOS } from './withSentryIOS';
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const pkg = require('../../package.json');
-
 interface PluginProps {
   organization?: string;
   project?: string;
@@ -22,15 +20,15 @@ const withSentryPlugin: ConfigPlugin<PluginProps | void> = (config, props) => {
       cfg = withSentryAndroid(cfg, sentryProperties);
     } catch (e) {
       WarningAggregator.addWarningAndroid(
-        'sentry-expo',
+        SDK_PACKAGE_NAME,
         `There was a problem configuring sentry-expo in your native Android project: ${e}`,
       );
     }
     try {
       cfg = withSentryIOS(cfg, sentryProperties);
     } catch (e) {
       WarningAggregator.addWarningIOS(
-        'sentry-expo',
+        SDK_PACKAGE_NAME,
         `There was a problem configuring sentry-expo in your native iOS project: ${e}`,
       );
     }
@@ -50,25 +48,23 @@ export function getSentryProperties(props: PluginProps | void): string | null {
   if (missingProperties.length) {
     const warningMessage = `Missing Sentry configuration properties: ${missingProperties.join(
       ', ',
-    )} in config plugin. Builds will fall back to environment variables. Refer to @sentry/react-native docs for how to configure this.`;
-    WarningAggregator.addWarningAndroid('sentry-expo', warningMessage);
-    WarningAggregator.addWarningIOS('sentry-expo', warningMessage);
+    )} in config plugin. Builds will fall back to environment variables. See: https://docs.sentry.io/platforms/react-native/manual-setup/.`;
+    WarningAggregator.addWarningAndroid(SDK_PACKAGE_NAME, warningMessage);
+    WarningAggregator.addWarningIOS(SDK_PACKAGE_NAME, warningMessage);
   }
 
   return `defaults.url=${url}
 ${organization ? `defaults.org=${organization}` : missingOrgMessage}
 ${project ? `defaults.project=${project}` : missingProjectMessage}
 ${
   authToken
-    ? `# Configure this value through \`SENTRY_AUTH_TOKEN\` environment variable instead. See:https://docs.expo.dev/guides/using-sentry/#app-configuration\nauth.token=${authToken}`
+    ? `# Configure this value through \`SENTRY_AUTH_TOKEN\` environment variable instead. See: https://docs.sentry.io/platforms/react-native/manual-setup/\nauth.token=${authToken}`
     : missingAuthTokenMessage
 }
 `;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-const withSentry = createRunOncePlugin(withSentryPlugin, pkg.name, pkg.version);
+const withSentry = createRunOncePlugin(withSentryPlugin, sdkPackage.name, sdkPackage.version);
 
-export {
-  withSentry,
-};
+export { withSentry };

plugin/src/withSentryAndroid.ts

@@ -2,7 +2,7 @@ import type { ConfigPlugin } from 'expo/config-plugins';
 import { WarningAggregator, withAppBuildGradle, withDangerousMod } from 'expo/config-plugins';
 import * as path from 'path';
 
-import { writeSentryPropertiesTo } from './withSentryIOS';
+import { SDK_PACKAGE_NAME, writeSentryPropertiesTo } from './utils';
 
 export const withSentryAndroid: ConfigPlugin<string> = (config, sentryProperties: string) => {
   const cfg = withAppBuildGradle(config, config => {
@@ -23,14 +23,14 @@ export const withSentryAndroid: ConfigPlugin<string> = (config, sentryProperties
 };
 
 const resolveSentryReactNativePackageJsonPath =
-  '["node", "--print", "require.resolve(\'@sentry/react-native/package.json\')"].execute().text.trim()';
+  '["node", "--print", "require(\'path\').dirname(require.resolve(\'@sentry/react-native/package.json\'))"].execute().text.trim()';
 
 /**
  * Writes to projectDirectory/android/app/build.gradle,
  * adding the relevant @sentry/react-native script.
  */
 export function modifyAppBuildGradle(buildGradle: string): string {
-  if (buildGradle.includes('/sentry.gradle"')) {
+  if (buildGradle.includes('sentry.gradle')) {
     return buildGradle;
   }
 
@@ -40,15 +40,13 @@ export function modifyAppBuildGradle(buildGradle: string): string {
 
   if (!buildGradle.match(pattern)) {
     WarningAggregator.addWarningAndroid(
-      'sentry-expo',
-      'Could not find react.gradle script in android/app/build.gradle. Please open a bug report at https://github.com/expo/sentry-expo.',
+      SDK_PACKAGE_NAME,
+      'Could not find `^android {` in `android/app/build.gradle`. Please open a bug report at https://github.com/getsentry/sentry-react-native.',
     );
+    return buildGradle;
   }
 
-  const sentryOptions = !buildGradle.includes('project.ext.sentryCli')
-    ? `project.ext.sentryCli=[collectModulesScript: new File(${resolveSentryReactNativePackageJsonPath}, "../dist/js/tools/collectModules.js")]`
-    : '';
-  const applyFrom = `apply from: new File(${resolveSentryReactNativePackageJsonPath}, "../sentry.gradle")`;
+  const applyFrom = `apply from: new File(${resolveSentryReactNativePackageJsonPath}, "sentry.gradle")`;
 
-  return buildGradle.replace(pattern, match => `${sentryOptions}\n\n${applyFrom}\n\n${match}`);
+  return buildGradle.replace(pattern, match => `${applyFrom}\n\n${match}`);
 }

plugin/src/withSentryIOS.ts

@@ -1,10 +1,16 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import type { ConfigPlugin, XcodeProject } from 'expo/config-plugins';
 import { WarningAggregator, withDangerousMod, withXcodeProject } from 'expo/config-plugins';
-import * as fs from 'fs';
 import * as path from 'path';
 
-const SENTRY_CLI = "`node --print \"require.resolve('@sentry/cli/package.json').slice(0, -13) + '/bin/sentry-cli'\"`";
+import { SDK_PACKAGE_NAME, writeSentryPropertiesTo } from './utils';
+
+type BuildPhase = { shellScript: string };
+
+const SENTRY_REACT_NATIVE_XCODE_PATH =
+  "`\"$NODE_BINARY\" --print \"require('path').dirname(require.resolve('@sentry/react-native/package.json')) + '/scripts/sentry-xcode.sh'\"`";
+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 => {
@@ -17,11 +23,7 @@ export const withSentryIOS: ConfigPlugin<string> = (config, sentryProperties: st
     if (!sentryBuildPhase) {
       xcodeProject.addBuildPhase([], 'PBXShellScriptBuildPhase', 'Upload Debug Symbols to Sentry', null, {
         shellPath: '/bin/sh',
-        shellScript: `
-export SENTRY_PROPERTIES=sentry.properties
-[[ $SENTRY_INCLUDE_NATIVE_SOURCES == "true" ]] && INCLUDE_SOURCES_FLAG="--include-sources" || INCLUDE_SOURCES_FLAG=""
-${SENTRY_CLI} debug-files upload --force-foreground "$INCLUDE_SOURCES_FLAG" "$DWARF_DSYM_FOLDER_PATH"
-          `,
+        shellScript: `/bin/sh ${SENTRY_REACT_NATIVE_XCODE_DEBUG_FILES_PATH}`,
       });
     }
 
@@ -43,35 +45,27 @@ ${SENTRY_CLI} debug-files upload --force-foreground "$INCLUDE_SOURCES_FLAG" "$DW
   ]);
 };
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function modifyExistingXcodeBuildScript(script: any): void {
+export function modifyExistingXcodeBuildScript(script: BuildPhase): void {
   if (
     !script.shellScript.match(/(packager|scripts)\/react-native-xcode\.sh\b/) ||
-    script.shellScript.match(/bin\/sentry-cli.*react-native[\s-]xcode/)
+    script.shellScript.includes('sentry-xcode.sh') ||
+    script.shellScript.includes('@sentry')
   ) {
     WarningAggregator.addWarningIOS(
-      'sentry-expo',
+      SDK_PACKAGE_NAME,
       "Unable to modify build script 'Bundle React Native code and images'. Please open a bug report at https://github.com/expo/sentry-expo.",
     );
     return;
   }
-  let code = JSON.parse(script.shellScript);
-  code = `${
-    'export SENTRY_PROPERTIES=sentry.properties\n' +
-    'export EXTRA_PACKAGER_ARGS="--sourcemap-output $DERIVED_FILE_DIR/main.jsbundle.map"\n'
-  }${code.replace(
-    /^.*?(packager|scripts)\/react-native-xcode\.sh\s*(\\'\\\\")?/m,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    (match: any) => `${SENTRY_CLI} react-native xcode --force-foreground ${match}`,
-  )}\n\n\`node --print "require.resolve('@sentry/react-native/package.json').slice(0, -13) + '/scripts/collect-modules.sh'"\``;
 
-  script.shellScript = JSON.stringify(code);
+  const code = JSON.parse(script.shellScript);
+  script.shellScript = JSON.stringify(addSentryWithBundledScriptsToBundleShellScript(code));
 }
 
-export function writeSentryPropertiesTo(filepath: string, sentryProperties: string): void {
-  if (!fs.existsSync(filepath)) {
-    throw new Error(`Directory '${filepath}' does not exist.`);
-  }
-
-  fs.writeFileSync(path.resolve(filepath, 'sentry.properties'), sentryProperties);
+export function addSentryWithBundledScriptsToBundleShellScript(script: string): string {
+  return script.replace(
+    /^.*?(packager|scripts)\/react-native-xcode\.sh\s*(\\'\\\\")?/m,
+    // eslint-disable-next-line no-useless-escape
+    (match: string) => `/bin/sh ${SENTRY_REACT_NATIVE_XCODE_PATH} ${match}`,
+  );
 }

sample-new-architecture/ios/.xcode.env

@@ -17,3 +17,4 @@ export SENTRY_CLI_EXTRA_ARGS="--force-foreground"
 export SENTRY_CLI_DEBUG_FILES_UPLOAD_EXTRA_ARGS=""
 export SENTRY_CLI_RN_XCODE_EXTRA_ARGS=""
 export MODULES_PATHS="$PWD/../node_modules,$PWD/../../.."
+export SENTRY_COLLECT_MODULES="../../scripts/collect-modules.sh"

scripts/sentry-xcode-debug-files.sh

@@ -5,14 +5,18 @@
 # print commands before executing them and stop on first error
 set -x -e
 
+LOCAL_NODE_BINARY=${NODE_BINARY:-node}
+
 # load envs if loader file exists (since rn 0.68)
 WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
 if [ -f "$WITH_ENVIRONMENT" ]; then
     . "$WITH_ENVIRONMENT"
 fi
 
 [ -z "$SENTRY_PROPERTIES" ] && export SENTRY_PROPERTIES=sentry.properties
-[ -z "$SENTRY_CLI_EXECUTABLE" ] && SENTRY_CLI_EXECUTABLE="../node_modules/@sentry/cli/bin/sentry-cli"
+
+[ -z "$SENTRY_CLI_EXECUTABLE" ] && SENTRY_CLI_PACKAGE_PATH=$("$LOCAL_NODE_BINARY" --print "require('path').dirname(require.resolve('@sentry/cli/package.json'))")
+[ -z "$SENTRY_CLI_EXECUTABLE" ] && SENTRY_CLI_EXECUTABLE="${SENTRY_CLI_PACKAGE_PATH}/bin/sentry-cli"
 
 [[ $SENTRY_INCLUDE_NATIVE_SOURCES == "true" ]] && INCLUDE_SOURCES_FLAG="--include-sources" || INCLUDE_SOURCES_FLAG=""
 

scripts/sentry-xcode.sh

@@ -7,9 +7,13 @@ set -x -e
 
 # WITH_ENVIRONMENT is executed by React Native
 
+LOCAL_NODE_BINARY=${NODE_BINARY:-node}
+
 [ -z "$SENTRY_PROPERTIES" ] && export SENTRY_PROPERTIES=sentry.properties
 [ -z "$SOURCEMAP_FILE" ] && export SOURCEMAP_FILE="$DERIVED_FILE_DIR/main.jsbundle.map"
-[ -z "$SENTRY_CLI_EXECUTABLE" ] && SENTRY_CLI_EXECUTABLE="../node_modules/@sentry/cli/bin/sentry-cli"
+
+[ -z "$SENTRY_CLI_EXECUTABLE" ] && SENTRY_CLI_PACKAGE_PATH=$("$LOCAL_NODE_BINARY" --print "require('path').dirname(require.resolve('@sentry/cli/package.json'))")
+[ -z "$SENTRY_CLI_EXECUTABLE" ] && SENTRY_CLI_EXECUTABLE="${SENTRY_CLI_PACKAGE_PATH}/bin/sentry-cli"
 
 REACT_NATIVE_XCODE=$1
 
@@ -25,7 +29,8 @@ else
   /bin/sh -c "$REACT_NATIVE_XCODE"
 fi
 
-[ -z "$SENTRY_COLLECT_MODULES" ] && SENTRY_COLLECT_MODULES="../../scripts/collect-modules.sh"
+[ -z "$SENTRY_COLLECT_MODULES" ] && SENTRY_RN_PACKAGE_PATH=$("$LOCAL_NODE_BINARY" --print "require('path').dirname(require.resolve('@sentry/react-native/package.json'))")
+[ -z "$SENTRY_COLLECT_MODULES" ] && SENTRY_COLLECT_MODULES="${SENTRY_RN_PACKAGE_PATH}/scripts/collect-modules.sh"
 
 if [ -f "$SENTRY_COLLECT_MODULES" ]; then
   /bin/sh "$SENTRY_COLLECT_MODULES"

test/expo-plugin/modifyAppBuildGradle.test.ts

@@ -11,7 +11,7 @@ jest.mock('@expo/config-plugins', () => {
 });
 
 const buildGradleWithSentry = `
-apply from: new File(["node", "--print", "require.resolve('@sentry/react-native/package.json')"].execute().text.trim(), "../sentry.gradle")
+apply from: new File(["node", "--print", "require('path').dirname(require.resolve('@sentry/react-native/package.json'))"].execute().text.trim(), "sentry.gradle")
 
 android {
 }
@@ -23,7 +23,7 @@ android {
 `;
 
 const monoRepoBuildGradleWithSentry = `
-apply from: new File(["node", "--print", "require.resolve('@sentry/react-native/package.json')"].execute().text.trim(), "../sentry.gradle")
+apply from: new File(["node", "--print", "require('path').dirname(require.resolve('@sentry/react-native/package.json'))"].execute().text.trim(), "sentry.gradle")
 
 android {
 }
@@ -39,19 +39,19 @@ const buildGradleWithOutReactGradleScript = `
 
 describe('Configures Android native project correctly', () => {
   it("Non monorepo: Doesn't modify app/build.gradle if Sentry's already configured", () => {
-    expect(modifyAppBuildGradle(buildGradleWithSentry)).toMatch(buildGradleWithSentry);
+    expect(modifyAppBuildGradle(buildGradleWithSentry)).toStrictEqual(buildGradleWithSentry);
   });
 
   it('Non monorepo: Adds sentry.gradle script if not present already', () => {
-    expect(modifyAppBuildGradle(buildGradleWithOutSentry)).toMatch(buildGradleWithSentry);
+    expect(modifyAppBuildGradle(buildGradleWithOutSentry)).toStrictEqual(buildGradleWithSentry);
   });
 
   it("Monorepo: Doesn't modify app/build.gradle if Sentry's already configured", () => {
-    expect(modifyAppBuildGradle(monoRepoBuildGradleWithSentry)).toMatch(monoRepoBuildGradleWithSentry);
+    expect(modifyAppBuildGradle(monoRepoBuildGradleWithSentry)).toStrictEqual(monoRepoBuildGradleWithSentry);
   });
 
   it('Monorepo: Adds sentry.gradle script if not present already', () => {
-    expect(modifyAppBuildGradle(monoRepoBuildGradleWithOutSentry)).toMatch(monoRepoBuildGradleWithSentry);
+    expect(modifyAppBuildGradle(monoRepoBuildGradleWithOutSentry)).toStrictEqual(monoRepoBuildGradleWithSentry);
   });
 
   it('Warns to file a bug report if no react.gradle is found', () => {