@sentry/wizard
Version:
Sentry wizard helping you to configure your project
471 lines • 27.7 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.runReactNativeWizardWithTelemetry = exports.runReactNativeWizard = exports.SDK_SENTRY_METRO_WITH_SENTRY_CONFIG_SUPPORTED_SDK_RANGE = exports.SDK_EXPO_SUPPORTED_SDK_RANGE = exports.SDK_SENTRY_METRO_PLUGIN_SUPPORTED_SDK_RANGE = exports.SDK_XCODE_SCRIPTS_SUPPORTED_SDK_RANGE = exports.SUPPORTED_EXPO_RANGE = exports.SUPPORTED_RN_RANGE = exports.RN_HUMAN_NAME = exports.RN_PACKAGE = exports.RN_SDK_PACKAGE = void 0;
/* eslint-disable max-lines */
// @ts-ignore - clack is ESM and TS complains about that. It works though
var prompts_1 = __importDefault(require("@clack/prompts"));
var chalk_1 = __importDefault(require("chalk"));
var fs = __importStar(require("fs"));
var clack_utils_1 = require("../utils/clack-utils");
var package_json_1 = require("../utils/package-json");
var cocoapod_1 = require("../apple/cocoapod");
var os_1 = require("os");
var xcode_1 = require("./xcode");
var gradle_1 = require("./gradle");
var uninstall_1 = require("./uninstall");
var glob_1 = require("./glob");
var javascript_1 = require("./javascript");
var telemetry_1 = require("../telemetry");
var Sentry = __importStar(require("@sentry/node"));
var semver_1 = require("../utils/semver");
var url_1 = require("../utils/url");
var metro_1 = require("./metro");
var expo_1 = require("./expo");
var expo_metro_1 = require("./expo-metro");
var expo_env_file_1 = require("./expo-env-file");
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
var xcode = require('xcode');
exports.RN_SDK_PACKAGE = '@sentry/react-native';
exports.RN_PACKAGE = 'react-native';
exports.RN_HUMAN_NAME = 'React Native';
exports.SUPPORTED_RN_RANGE = '>=0.69.0';
exports.SUPPORTED_EXPO_RANGE = '>=50.0.0';
/**
* The following SDK version ship with bundled Xcode scripts
* which simplifies the Xcode Build Phases setup.
*/
exports.SDK_XCODE_SCRIPTS_SUPPORTED_SDK_RANGE = '>=5.11.0';
/**
* The following SDK version ship with Sentry Metro plugin
*/
exports.SDK_SENTRY_METRO_PLUGIN_SUPPORTED_SDK_RANGE = '>=5.11.0';
/**
* The following SDK version ship with bundled Expo plugin
*/
exports.SDK_EXPO_SUPPORTED_SDK_RANGE = ">=5.16.0";
// The following SDK version shipped `withSentryConfig`
exports.SDK_SENTRY_METRO_WITH_SENTRY_CONFIG_SUPPORTED_SDK_RANGE = '>=5.17.0';
function runReactNativeWizard(params) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, (0, telemetry_1.withTelemetry)({
enabled: params.telemetryEnabled,
integration: 'react-native',
}, function () { return runReactNativeWizardWithTelemetry(params); })];
});
});
}
exports.runReactNativeWizard = runReactNativeWizard;
function runReactNativeWizardWithTelemetry(options) {
return __awaiter(this, void 0, void 0, function () {
var packageJson, hasInstalled, rnVersion, sdkVersion, _a, _b, expoVersion, isExpo, _c, selectedProject, authToken, sentryUrl, orgSlug, projectSlug, projectId, cliConfig, confirmedFirstException;
return __generator(this, function (_d) {
switch (_d.label) {
case 0:
if (options.uninstall) {
Sentry.setTag('uninstall', true);
return [2 /*return*/, (0, uninstall_1.runReactNativeUninstall)(options)];
}
(0, clack_utils_1.printWelcome)({
wizardName: 'Sentry React Native Wizard',
promoCode: options.promoCode,
telemetryEnabled: options.telemetryEnabled,
});
return [4 /*yield*/, (0, clack_utils_1.confirmContinueIfNoOrDirtyGitRepo)()];
case 1:
_d.sent();
return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
case 2:
packageJson = _d.sent();
hasInstalled = function (dep) { return (0, package_json_1.hasPackageInstalled)(dep, packageJson); };
if (hasInstalled('sentry-expo')) {
Sentry.setTag('has-sentry-expo-installed', true);
(0, expo_1.printSentryExpoMigrationOutro)();
return [2 /*return*/];
}
return [4 /*yield*/, (0, clack_utils_1.ensurePackageIsInstalled)(packageJson, exports.RN_PACKAGE, exports.RN_HUMAN_NAME)];
case 3:
_d.sent();
rnVersion = (0, package_json_1.getPackageVersion)(exports.RN_PACKAGE, packageJson);
if (!rnVersion) return [3 /*break*/, 5];
return [4 /*yield*/, (0, clack_utils_1.confirmContinueIfPackageVersionNotSupported)({
packageName: exports.RN_HUMAN_NAME,
packageVersion: rnVersion,
packageId: exports.RN_PACKAGE,
acceptableVersions: exports.SUPPORTED_RN_RANGE,
note: "Please upgrade to ".concat(exports.SUPPORTED_RN_RANGE, " if you wish to use the Sentry Wizard.\nOr setup using ").concat(chalk_1.default.cyan('https://docs.sentry.io/platforms/react-native/manual-setup/manual-setup/')),
})];
case 4:
_d.sent();
_d.label = 5;
case 5: return [4 /*yield*/, (0, clack_utils_1.installPackage)({
packageName: exports.RN_SDK_PACKAGE,
alreadyInstalled: (0, package_json_1.hasPackageInstalled)(exports.RN_SDK_PACKAGE, packageJson),
})];
case 6:
_d.sent();
_a = package_json_1.getPackageVersion;
_b = [exports.RN_SDK_PACKAGE];
return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
case 7:
sdkVersion = _a.apply(void 0, _b.concat([_d.sent()]));
expoVersion = (0, package_json_1.getPackageVersion)('expo', packageJson);
isExpo = !!expoVersion;
if (!(expoVersion && sdkVersion)) return [3 /*break*/, 10];
return [4 /*yield*/, (0, clack_utils_1.confirmContinueIfPackageVersionNotSupported)({
packageName: 'Sentry React Native SDK',
packageVersion: sdkVersion,
packageId: exports.RN_SDK_PACKAGE,
acceptableVersions: exports.SDK_EXPO_SUPPORTED_SDK_RANGE,
note: "Please upgrade to ".concat(exports.SDK_EXPO_SUPPORTED_SDK_RANGE, " to continue with the wizard in this Expo project."),
})];
case 8:
_d.sent();
return [4 /*yield*/, (0, clack_utils_1.confirmContinueIfPackageVersionNotSupported)({
packageName: 'Expo SDK',
packageVersion: expoVersion,
packageId: 'expo',
acceptableVersions: exports.SUPPORTED_EXPO_RANGE,
note: "Please upgrade to ".concat(exports.SUPPORTED_EXPO_RANGE, " to continue with the wizard in this Expo project."),
})];
case 9:
_d.sent();
_d.label = 10;
case 10: return [4 /*yield*/, (0, clack_utils_1.getOrAskForProjectData)(options, 'react-native')];
case 11:
_c = _d.sent(), selectedProject = _c.selectedProject, authToken = _c.authToken, sentryUrl = _c.sentryUrl;
orgSlug = selectedProject.organization.slug;
projectSlug = selectedProject.slug;
projectId = selectedProject.id;
cliConfig = {
authToken: authToken,
org: orgSlug,
project: projectSlug,
url: sentryUrl,
};
return [4 /*yield*/, (0, telemetry_1.traceStep)('patch-app-js', function () {
return (0, javascript_1.addSentryInit)({ dsn: selectedProject.keys[0].dsn.public });
})];
case 12:
_d.sent();
if (!isExpo) return [3 /*break*/, 15];
return [4 /*yield*/, (0, telemetry_1.traceStep)('patch-expo-app-config', function () {
return (0, expo_1.patchExpoAppConfig)(cliConfig);
})];
case 13:
_d.sent();
return [4 /*yield*/, (0, telemetry_1.traceStep)('add-expo-env-local', function () { return (0, expo_env_file_1.addExpoEnvLocal)(cliConfig); })];
case 14:
_d.sent();
_d.label = 15;
case 15:
if (!isExpo) return [3 /*break*/, 17];
return [4 /*yield*/, (0, telemetry_1.traceStep)('patch-metro-config', expo_metro_1.addSentryToExpoMetroConfig)];
case 16:
_d.sent();
return [3 /*break*/, 19];
case 17: return [4 /*yield*/, (0, telemetry_1.traceStep)('patch-metro-config', function () {
return addSentryToMetroConfig({ sdkVersion: sdkVersion });
})];
case 18:
_d.sent();
_d.label = 19;
case 19:
if (!fs.existsSync('ios')) return [3 /*break*/, 21];
Sentry.setTag('patch-ios', true);
return [4 /*yield*/, (0, telemetry_1.traceStep)('patch-xcode-files', function () {
return patchXcodeFiles(cliConfig, { sdkVersion: sdkVersion });
})];
case 20:
_d.sent();
_d.label = 21;
case 21:
if (!fs.existsSync('android')) return [3 /*break*/, 23];
Sentry.setTag('patch-android', true);
return [4 /*yield*/, (0, telemetry_1.traceStep)('patch-android-files', function () { return patchAndroidFiles(cliConfig); })];
case 22:
_d.sent();
_d.label = 23;
case 23: return [4 /*yield*/, confirmFirstSentryException(sentryUrl, orgSlug, projectId)];
case 24:
confirmedFirstException = _d.sent();
Sentry.setTag('user-confirmed-first-error', confirmedFirstException);
if (confirmedFirstException) {
prompts_1.default.outro("".concat(chalk_1.default.green('Everything is set up!'), "\n\n ").concat(chalk_1.default.dim('If you encounter any issues, let us know here: https://github.com/getsentry/sentry-react-native/issues')));
}
else {
prompts_1.default.outro("".concat(chalk_1.default.dim('Let us know here: https://github.com/getsentry/sentry-react-native/issues')));
}
return [2 /*return*/];
}
});
});
}
exports.runReactNativeWizardWithTelemetry = runReactNativeWizardWithTelemetry;
function addSentryToMetroConfig(_a) {
var sdkVersion = _a.sdkVersion;
if (sdkVersion &&
(0, semver_1.fulfillsVersionRange)({
version: sdkVersion,
acceptableVersions: exports.SDK_SENTRY_METRO_WITH_SENTRY_CONFIG_SUPPORTED_SDK_RANGE,
canBeLatest: true,
})) {
return (0, metro_1.patchMetroWithSentryConfig)();
}
if (sdkVersion &&
(0, semver_1.fulfillsVersionRange)({
version: sdkVersion,
acceptableVersions: exports.SDK_SENTRY_METRO_PLUGIN_SUPPORTED_SDK_RANGE,
canBeLatest: true,
})) {
return (0, metro_1.patchMetroConfigWithSentrySerializer)();
}
}
function confirmFirstSentryException(url, orgSlug, projectId) {
return __awaiter(this, void 0, void 0, function () {
var issuesStreamUrl, firstErrorConfirmed;
return __generator(this, function (_a) {
issuesStreamUrl = (0, url_1.getIssueStreamUrl)({ url: url, orgSlug: orgSlug, projectId: projectId });
prompts_1.default.log
.step("To make sure everything is set up correctly, put the following code snippet into your application.\nThe snippet will create a button that, when tapped, sends a test event to Sentry.\n\nAfter that check your project issues:\n\n".concat(chalk_1.default.cyan(issuesStreamUrl)));
// We want the code snippet to be easily copy-pasteable, without any clack artifacts
// eslint-disable-next-line no-console
console.log(chalk_1.default.greenBright("\n<Button title='Try!' onPress={ () => { Sentry.captureException(new Error('First error')) }}/>\n"));
firstErrorConfirmed = prompts_1.default.confirm({
message: "Have you successfully sent a test event?",
});
return [2 /*return*/, firstErrorConfirmed];
});
});
}
function patchXcodeFiles(config, context) {
return __awaiter(this, void 0, void 0, function () {
var _a, xcodeProjectPath, _b, xcodeProject, buildPhasesMap;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, (0, clack_utils_1.addSentryCliConfig)(config, __assign(__assign({}, clack_utils_1.propertiesCliSetupConfig), { name: 'source maps and iOS debug files', filename: 'ios/sentry.properties', gitignore: false }))];
case 1:
_c.sent();
_a = (0, os_1.platform)() === 'darwin';
if (!_a) return [3 /*break*/, 3];
return [4 /*yield*/, confirmPodInstall()];
case 2:
_a = (_c.sent());
_c.label = 3;
case 3:
if (!_a) return [3 /*break*/, 5];
return [4 /*yield*/, (0, telemetry_1.traceStep)('pod-install', function () { return (0, cocoapod_1.podInstall)('ios'); })];
case 4:
_c.sent();
_c.label = 5;
case 5:
xcodeProjectPath = (0, telemetry_1.traceStep)('find-xcode-project', function () {
return (0, glob_1.getFirstMatchedPath)(glob_1.XCODE_PROJECT);
});
Sentry.setTag('xcode-project-status', xcodeProjectPath ? 'found' : 'not-found');
if (!xcodeProjectPath) {
prompts_1.default.log.warn("Could not find Xcode project file using ".concat(chalk_1.default.cyan(glob_1.XCODE_PROJECT), "."));
return [2 /*return*/];
}
_b = (0, telemetry_1.traceStep)('parse-xcode-project', function () {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
var project = xcode.project(xcodeProjectPath);
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
project.parseSync();
var map = (0, xcode_1.getValidExistingBuildPhases)(project);
return [project, map];
}), xcodeProject = _b[0], buildPhasesMap = _b[1];
Sentry.setTag('xcode-project-status', 'parsed');
(0, telemetry_1.traceStep)('patch-bundle-phase', function () {
var bundlePhase = (0, xcode_1.findBundlePhase)(buildPhasesMap);
Sentry.setTag('xcode-bundle-phase-status', bundlePhase ? 'found' : 'not-found');
if (context.sdkVersion &&
(0, semver_1.fulfillsVersionRange)({
version: context.sdkVersion,
acceptableVersions: exports.SDK_XCODE_SCRIPTS_SUPPORTED_SDK_RANGE,
canBeLatest: true,
})) {
(0, xcode_1.patchBundlePhase)(bundlePhase, xcode_1.addSentryWithBundledScriptsToBundleShellScript);
}
else {
(0, xcode_1.patchBundlePhase)(bundlePhase, xcode_1.addSentryWithCliToBundleShellScript);
}
Sentry.setTag('xcode-bundle-phase-status', 'patched');
});
(0, telemetry_1.traceStep)('add-debug-files-upload-phase', function () {
var debugFilesUploadPhaseExists = !!(0, xcode_1.findDebugFilesUploadPhase)(buildPhasesMap);
Sentry.setTag('xcode-debug-files-upload-phase-status', debugFilesUploadPhaseExists ? 'already-exists' : undefined);
if (context.sdkVersion &&
(0, semver_1.fulfillsVersionRange)({
version: context.sdkVersion,
acceptableVersions: exports.SDK_XCODE_SCRIPTS_SUPPORTED_SDK_RANGE,
canBeLatest: true,
})) {
(0, xcode_1.addDebugFilesUploadPhaseWithBundledScripts)(xcodeProject, {
debugFilesUploadPhaseExists: debugFilesUploadPhaseExists,
});
}
else {
(0, xcode_1.addDebugFilesUploadPhaseWithCli)(xcodeProject, {
debugFilesUploadPhaseExists: debugFilesUploadPhaseExists,
});
}
Sentry.setTag('xcode-debug-files-upload-phase-status', 'added');
});
(0, telemetry_1.traceStep)('write-xcode-project', function () {
(0, xcode_1.writeXcodeProject)(xcodeProjectPath, xcodeProject);
});
Sentry.setTag('xcode-project-status', 'patched');
return [2 /*return*/];
}
});
});
}
function patchAndroidFiles(config) {
return __awaiter(this, void 0, void 0, function () {
var appBuildGradlePath, appBuildGradle, includesSentry, patchedAppBuildGradle;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, clack_utils_1.addSentryCliConfig)(config, __assign(__assign({}, clack_utils_1.propertiesCliSetupConfig), { name: 'source maps and iOS debug files', filename: 'android/sentry.properties', gitignore: false }))];
case 1:
_a.sent();
appBuildGradlePath = (0, telemetry_1.traceStep)('find-app-build-gradle', function () {
return (0, glob_1.getFirstMatchedPath)(glob_1.APP_BUILD_GRADLE);
});
Sentry.setTag('app-build-gradle-status', appBuildGradlePath ? 'found' : 'not-found');
if (!appBuildGradlePath) {
prompts_1.default.log.warn("Could not find Android ".concat(chalk_1.default.cyan('app/build.gradle'), " file using ").concat(chalk_1.default.cyan(glob_1.APP_BUILD_GRADLE), "."));
return [2 /*return*/];
}
appBuildGradle = (0, telemetry_1.traceStep)('read-app-build-gradle', function () {
return fs.readFileSync(appBuildGradlePath, 'utf-8');
});
includesSentry = (0, gradle_1.doesAppBuildGradleIncludeRNSentryGradlePlugin)(appBuildGradle);
if (includesSentry) {
Sentry.setTag('app-build-gradle-status', 'already-includes-sentry');
prompts_1.default.log.warn("Android ".concat(chalk_1.default.cyan('app/build.gradle'), " file already includes Sentry."));
return [2 /*return*/];
}
patchedAppBuildGradle = (0, telemetry_1.traceStep)('add-rn-sentry-gradle-plugin', function () {
return (0, gradle_1.addRNSentryGradlePlugin)(appBuildGradle);
});
if (!(0, gradle_1.doesAppBuildGradleIncludeRNSentryGradlePlugin)(patchedAppBuildGradle)) {
Sentry.setTag('app-build-gradle-status', 'failed-to-add-rn-sentry-gradle-plugin');
prompts_1.default.log.warn("Could not add Sentry RN Gradle Plugin to ".concat(chalk_1.default.cyan('app/build.gradle'), "."));
return [2 /*return*/];
}
Sentry.setTag('app-build-gradle-status', 'added-rn-sentry-gradle-plugin');
prompts_1.default.log.success("Added Sentry RN Gradle Plugin to ".concat(chalk_1.default.bold('app/build.gradle'), "."));
(0, telemetry_1.traceStep)('write-app-build-gradle', function () {
return (0, gradle_1.writeAppBuildGradle)(appBuildGradlePath, patchedAppBuildGradle);
});
prompts_1.default.log.success(chalk_1.default.green("Android ".concat(chalk_1.default.cyan('app/build.gradle'), " saved.")));
return [2 /*return*/];
}
});
});
}
function confirmPodInstall() {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
return [2 /*return*/, (0, telemetry_1.traceStep)('confirm-pod-install', function () { return __awaiter(_this, void 0, void 0, function () {
var continueWithPodInstall;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(prompts_1.default.select({
message: 'Do you want to run `pod install` now?',
options: [
{
value: true,
label: 'Yes',
hint: 'Recommended for smaller projects, this might take several minutes',
},
{ value: false, label: "No, I'll do it later" },
],
initialValue: true,
}))];
case 1:
continueWithPodInstall = _a.sent();
Sentry.setTag('continue-with-pod-install', continueWithPodInstall);
return [2 /*return*/, continueWithPodInstall];
}
});
}); })];
});
});
}
//# sourceMappingURL=react-native-wizard.js.map