@sentry/react-native 5.19.0 → 5.19.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 5.19.1
+
+### Fixes
+
+- Don't add Expo Plugin option `authToken` to application bundle ([#3630](https://github.com/getsentry/sentry-react-native/pull/3630))
+  - Expo plugin configurations are generelly stored in plain text, and are also automatically added to built app bundles, and are therefore considered insecure.
+  - You should not set the auth token in the plugin config except for local testing. Instead, use the `SENTRY_AUTH_TOKEN` env variable, as pointed out in our [docs](https://docs.sentry.io/platforms/react-native/manual-setup/expo/).
+  - In addition to showing a warning, we are now actively removing an `authToken` from the plugin config if it was set.
+  - If you had set the auth token in the plugin config previously, **and** built and published an app with that config, you should [rotate your token](https://docs.sentry.io/product/accounts/auth-tokens/).
+- Reduce waning messages spam when a property in Expo plugin configuration is missing ([#3631](https://github.com/getsentry/sentry-react-native/pull/3631))
+
 ## 5.19.0
 
 This release contains upgrade of `sentry-android` dependency to major version 7. There are no breaking changes in the JS API. If you are using the Android API please check [the migration guide](https://docs.sentry.io/platforms/android/migration/#migrating-from-iosentrysentry-android-6x-to-iosentrysentry-android-700).

package/dist/js/version.d.ts

@@ -1,4 +1,4 @@
 export declare const SDK_PACKAGE_NAME = "npm:@sentry/react-native";
 export declare const SDK_NAME = "sentry.javascript.react-native";
-export declare const SDK_VERSION = "5.19.0";
+export declare const SDK_VERSION = "5.19.1";
 //# sourceMappingURL=version.d.ts.map

package/dist/js/version.js

@@ -1,4 +1,4 @@
 export const SDK_PACKAGE_NAME = 'npm:@sentry/react-native';
 export const SDK_NAME = 'sentry.javascript.react-native';
-export const SDK_VERSION = '5.19.0';
+export const SDK_VERSION = '5.19.1';
 //# sourceMappingURL=version.js.map

package/dist/js/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/js/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AAC3D,MAAM,CAAC,MAAM,QAAQ,GAAG,gCAAgC,CAAC;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC","sourcesContent":["export const SDK_PACKAGE_NAME = 'npm:@sentry/react-native';\nexport const SDK_NAME = 'sentry.javascript.react-native';\nexport const SDK_VERSION = '5.19.0';\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/js/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AAC3D,MAAM,CAAC,MAAM,QAAQ,GAAG,gCAAgC,CAAC;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC","sourcesContent":["export const SDK_PACKAGE_NAME = 'npm:@sentry/react-native';\nexport const SDK_NAME = 'sentry.javascript.react-native';\nexport const SDK_VERSION = '5.19.1';\n"]}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sentry/react-native",
   "homepage": "https://github.com/getsentry/sentry-react-native",
   "repository": "https://github.com/getsentry/sentry-react-native",
-  "version": "5.19.0",
+  "version": "5.19.1",
   "description": "Official Sentry SDK for react-native",
   "typings": "dist/js/index.d.ts",
   "types": "dist/js/index.d.ts",

package/plugin/build/utils.d.ts

@@ -4,4 +4,16 @@ declare const sdkPackage: {
     version: string;
 };
 declare const SDK_PACKAGE_NAME: string;
+export declare function warnOnce(message: string): void;
+export declare function logPrefix(): string;
+/**
+ * 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 declare function yellow(message: string): string;
+/**
+ * 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 declare function bold(message: string): string;
 export { sdkPackage, SDK_PACKAGE_NAME };

package/plugin/build/utils.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SDK_PACKAGE_NAME = exports.sdkPackage = exports.writeSentryPropertiesTo = void 0;
+exports.SDK_PACKAGE_NAME = exports.sdkPackage = exports.bold = exports.yellow = exports.logPrefix = exports.warnOnce = exports.writeSentryPropertiesTo = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 function writeSentryPropertiesTo(filepath, sentryProperties) {
@@ -35,5 +35,34 @@ function writeSentryPropertiesTo(filepath, sentryProperties) {
 exports.writeSentryPropertiesTo = writeSentryPropertiesTo;
 const sdkPackage = require('../../package.json');
 exports.sdkPackage = sdkPackage;
-const SDK_PACKAGE_NAME = sdkPackage.name;
+const SDK_PACKAGE_NAME = `${sdkPackage.name}/expo`;
 exports.SDK_PACKAGE_NAME = SDK_PACKAGE_NAME;
+const warningMap = new Map();
+function warnOnce(message) {
+    if (!warningMap.has(message)) {
+        warningMap.set(message, true);
+        // eslint-disable-next-line no-console
+        console.warn(yellow(`${logPrefix()} ${message}`));
+    }
+}
+exports.warnOnce = warnOnce;
+function logPrefix() {
+    return `› ${bold('[@sentry/react-native/expo]')}`;
+}
+exports.logPrefix = logPrefix;
+/**
+ * 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.
+ */
+function yellow(message) {
+    return `\x1b[33m${message}\x1b[0m`;
+}
+exports.yellow = yellow;
+/**
+ * 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.
+ */
+function bold(message) {
+    return `\x1b[1m${message}\x1b[22m`;
+}
+exports.bold = bold;

package/plugin/build/withSentry.js

@@ -7,42 +7,47 @@ const withSentryAndroid_1 = require("./withSentryAndroid");
 const withSentryIOS_1 = require("./withSentryIOS");
 const withSentryPlugin = (config, props) => {
     const sentryProperties = getSentryProperties(props);
+    if (props && props.authToken) {
+        // If not removed, the plugin config with the authToken will be written to the application package
+        delete props.authToken;
+    }
     let cfg = config;
     if (sentryProperties !== null) {
         try {
             cfg = (0, withSentryAndroid_1.withSentryAndroid)(cfg, sentryProperties);
         }
         catch (e) {
-            config_plugins_1.WarningAggregator.addWarningAndroid(utils_1.SDK_PACKAGE_NAME, `There was a problem configuring sentry-expo in your native Android project: ${e}`);
+            (0, utils_1.warnOnce)(`There was a problem with configuring your native Android project: ${e}`);
         }
         try {
             cfg = (0, withSentryIOS_1.withSentryIOS)(cfg, sentryProperties);
         }
         catch (e) {
-            config_plugins_1.WarningAggregator.addWarningIOS(utils_1.SDK_PACKAGE_NAME, `There was a problem configuring sentry-expo in your native iOS project: ${e}`);
+            (0, utils_1.warnOnce)(`There was a problem with configuring your native iOS project: ${e}`);
         }
     }
     return cfg;
 };
-const missingAuthTokenMessage = '# auth.token is configured through SENTRY_AUTH_TOKEN environment variable';
 const missingProjectMessage = '# no project found, falling back to SENTRY_PROJECT environment variable';
 const missingOrgMessage = '# no org found, falling back to SENTRY_ORG environment variable';
+const existingAuthTokenMessage = `# DO NOT COMMIT the auth token, use SENTRY_AUTH_TOKEN instead, see https://docs.sentry.io/platforms/react-native/manual-setup/`;
+const missingAuthTokenMessage = `# Using SENTRY_AUTH_TOKEN environment variable`;
 function getSentryProperties(props) {
     const { organization, project, authToken, url = 'https://sentry.io/' } = props ?? {};
     // eslint-disable-next-line no-prototype-builtins
     const missingProperties = ['organization', 'project'].filter(each => !props?.hasOwnProperty(each));
     if (missingProperties.length) {
-        const warningMessage = `Missing Sentry configuration properties: ${missingProperties.join(', ')} in config plugin. Builds will fall back to environment variables. See: https://docs.sentry.io/platforms/react-native/manual-setup/.`;
-        config_plugins_1.WarningAggregator.addWarningAndroid(utils_1.SDK_PACKAGE_NAME, warningMessage);
-        config_plugins_1.WarningAggregator.addWarningIOS(utils_1.SDK_PACKAGE_NAME, warningMessage);
+        const missingPropertiesString = (0, utils_1.bold)(missingProperties.join(', '));
+        const warningMessage = `Missing config for ${missingPropertiesString}. Environment variables will be used as a fallback during the build. https://docs.sentry.io/platforms/react-native/manual-setup/`;
+        (0, utils_1.warnOnce)(warningMessage);
+    }
+    if (authToken) {
+        (0, utils_1.warnOnce)(`Detected unsecure use of 'authToken' in Sentry plugin configuration. To avoid exposing the token use ${(0, utils_1.bold)('SENTRY_AUTH_TOKEN')} environment variable instead. https://docs.sentry.io/platforms/react-native/manual-setup/`);
     }
     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.sentry.io/platforms/react-native/manual-setup/\nauth.token=${authToken}`
-        : missingAuthTokenMessage}
-`;
+${authToken ? `${existingAuthTokenMessage}\nauth.token=${authToken}` : missingAuthTokenMessage}`;
 }
 exports.getSentryProperties = getSentryProperties;
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access

package/plugin/build/withSentryAndroid.js

@@ -59,7 +59,7 @@ function modifyAppBuildGradle(buildGradle) {
     // See: https://github.com/getsentry/sentry-wizard/blob/e9b4522f27a852069c862bd458bdf9b07cab6e33/lib/Steps/Integrations/ReactNative.ts#L232
     const pattern = /^android {/m;
     if (!buildGradle.match(pattern)) {
-        config_plugins_1.WarningAggregator.addWarningAndroid(utils_1.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.');
+        (0, utils_1.warnOnce)('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 applyFrom = `apply from: new File(${resolveSentryReactNativePackageJsonPath}, "sentry.gradle")`;

package/plugin/build/withSentryIOS.js

@@ -53,10 +53,19 @@ const withSentryIOS = (config, sentryProperties) => {
 };
 exports.withSentryIOS = withSentryIOS;
 function modifyExistingXcodeBuildScript(script) {
-    if (!script.shellScript.match(/(packager|scripts)\/react-native-xcode\.sh\b/) ||
-        script.shellScript.includes('sentry-xcode.sh') ||
-        script.shellScript.includes('@sentry')) {
-        config_plugins_1.WarningAggregator.addWarningIOS(utils_1.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.");
+    if (!script.shellScript.match(/(packager|scripts)\/react-native-xcode\.sh\b/)) {
+        (0, utils_1.warnOnce)(`'react-native-xcode.sh' not found in 'Bundle React Native code and images'.
+Please open a bug report at https://github.com/getsentry/sentry-react-native`);
+        return;
+    }
+    if (script.shellScript.includes('sentry-xcode.sh')) {
+        (0, utils_1.warnOnce)("The latest 'sentry-xcode.sh' script already exists in 'Bundle React Native code and images'.");
+        return;
+    }
+    if (script.shellScript.includes('@sentry')) {
+        (0, utils_1.warnOnce)(`Outdated or custom Sentry script found in 'Bundle React Native code and images'.
+Regenerate the native project to use the latest script.
+Run npx expo prebuild --clean`);
         return;
     }
     const code = JSON.parse(script.shellScript);

package/ts3.8/dist/js/version.d.ts

@@ -1,4 +1,4 @@
 export declare const SDK_PACKAGE_NAME = "npm:@sentry/react-native";
 export declare const SDK_NAME = "sentry.javascript.react-native";
-export declare const SDK_VERSION = "5.19.0";
+export declare const SDK_VERSION = "5.19.1";
 //# sourceMappingURL=version.d.ts.map