@sentry/wizard
Version:
Sentry wizard helping you to configure your project
195 lines • 10.8 kB
JavaScript
;
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.getSentryAppConfigJsonCodeSnippet = exports.addWithSentryToAppConfigJson = exports.patchExpoAppConfig = exports.printSentryExpoMigrationOutro = exports.SENTRY_PLUGIN_FUNCTION_NAME = exports.DEPRECATED_SENTRY_EXPO_PLUGIN_NAME = exports.SENTRY_EXPO_PLUGIN_NAME = void 0;
// @ts-ignore - clack is ESM and TS complains about that. It works though
var clack = __importStar(require("@clack/prompts"));
var chalk_1 = __importDefault(require("chalk"));
var fs = __importStar(require("fs"));
var os_1 = require("os");
var utils_1 = require("@sentry/utils");
var Sentry = __importStar(require("@sentry/node"));
var clack_utils_1 = require("../utils/clack-utils");
var telemetry_1 = require("../telemetry");
exports.SENTRY_EXPO_PLUGIN_NAME = '@sentry/react-native/expo';
exports.DEPRECATED_SENTRY_EXPO_PLUGIN_NAME = 'sentry-expo';
exports.SENTRY_PLUGIN_FUNCTION_NAME = 'withSentry';
var APP_CONFIG_JSON = "app.json";
function printSentryExpoMigrationOutro() {
clack.outro("Deprecated ".concat(chalk_1.default.cyan('sentry-expo'), " package installed in your dependencies. Please follow the migration guide at ").concat(chalk_1.default.cyan('https://docs.sentry.io/platforms/react-native/migration/sentry-expo/')));
}
exports.printSentryExpoMigrationOutro = printSentryExpoMigrationOutro;
/**
* Finds app.json in the project root and add Sentry Expo `withSentry` plugin.
*/
function patchExpoAppConfig(options) {
return __awaiter(this, void 0, void 0, function () {
function showInstructions() {
return (0, clack_utils_1.showCopyPasteInstructions)(APP_CONFIG_JSON, getSentryAppConfigJsonCodeSnippet(options), 'This ensures auto upload of source maps during native app build.');
}
var appConfigJsonExists, patched;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
appConfigJsonExists = fs.existsSync(APP_CONFIG_JSON);
Sentry.setTag('app-config-file-status', appConfigJsonExists ? 'found' : 'not-found');
if (!!appConfigJsonExists) return [3 /*break*/, 2];
return [4 /*yield*/, showInstructions()];
case 1: return [2 /*return*/, _a.sent()];
case 2: return [4 /*yield*/, patchAppConfigJson(APP_CONFIG_JSON, options)];
case 3:
patched = _a.sent();
if (!!patched) return [3 /*break*/, 5];
return [4 /*yield*/, showInstructions()];
case 4: return [2 /*return*/, _a.sent()];
case 5: return [2 /*return*/];
}
});
});
}
exports.patchExpoAppConfig = patchExpoAppConfig;
function patchAppConfigJson(path, options) {
return __awaiter(this, void 0, void 0, function () {
var appConfigContent, patchedContent, error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, fs.promises.readFile(path, { encoding: 'utf-8' })];
case 1:
appConfigContent = (_a.sent()).toString();
patchedContent = (0, telemetry_1.traceStep)('app-config-json-patch', function () {
return addWithSentryToAppConfigJson(appConfigContent, options);
});
if (patchedContent === null) {
return [2 /*return*/, false];
}
_a.label = 2;
case 2:
_a.trys.push([2, 4, , 5]);
return [4 /*yield*/, fs.promises.writeFile(path, patchedContent)];
case 3:
_a.sent();
return [3 /*break*/, 5];
case 4:
error_1 = _a.sent();
Sentry.setTag('app-config-file-status', 'json-write-error');
clack.log.error("Unable to write ".concat(chalk_1.default.cyan('app.config.json'), "."));
return [2 /*return*/, false];
case 5:
Sentry.setTag('app-config-file-status', 'json-write-success');
clack.log.success("Added Sentry Expo plugin to ".concat(chalk_1.default.cyan('app.config.json'), "."));
return [2 /*return*/, true];
}
});
});
}
function addWithSentryToAppConfigJson(appConfigContent, options) {
var _a, _b;
try {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
var parsedAppConfig = JSON.parse(appConfigContent);
var includesWithSentry = appConfigContent.includes(exports.SENTRY_EXPO_PLUGIN_NAME) ||
appConfigContent.includes(exports.DEPRECATED_SENTRY_EXPO_PLUGIN_NAME);
if (includesWithSentry) {
Sentry.setTag('app-config-file-status', 'already-patched');
clack.log.warn("Your ".concat(chalk_1.default.cyan('app.config.json'), " already includes the Sentry Expo plugin."));
return null;
}
if (parsedAppConfig.expo !== undefined &&
!(0, utils_1.isPlainObject)(parsedAppConfig.expo)) {
Sentry.setTag('app-config-file-status', 'invalid-json');
return null;
}
if (parsedAppConfig.expo &&
parsedAppConfig.expo.plugins !== undefined &&
!Array.isArray(parsedAppConfig.expo.plugins)) {
Sentry.setTag('app-config-file-status', 'invalid-json');
return null;
}
parsedAppConfig.expo = (_a = parsedAppConfig.expo) !== null && _a !== void 0 ? _a : {};
parsedAppConfig.expo.plugins = (_b = parsedAppConfig.expo.plugins) !== null && _b !== void 0 ? _b : [];
parsedAppConfig.expo.plugins.push([
exports.SENTRY_EXPO_PLUGIN_NAME,
{
url: options.url,
project: options.project,
organization: options.org,
},
]);
return JSON.stringify(parsedAppConfig, null, 2) + os_1.EOL;
}
catch (error) {
Sentry.setTag('app-config-file-status', 'invalid-json');
clack.log.error("Unable to parse your ".concat(chalk_1.default.cyan('app.config.json'), ". Make sure it has a valid format!"));
return null;
}
}
exports.addWithSentryToAppConfigJson = addWithSentryToAppConfigJson;
function getSentryAppConfigJsonCodeSnippet(_a) {
var url = _a.url, project = _a.project, org = _a.org;
return (0, clack_utils_1.makeCodeSnippet)(true, function (unchanged, plus, _minus) {
return unchanged("{\n \"name\": \"my app\",\n \"plugins\": [\n ".concat(plus("[\n \"@sentry/react-native/expo\",\n {\n \"url\": \"".concat(url, "\",\n \"project\": \"").concat(project, "\",\n \"organization\": \"").concat(org, "\"\n }\n ]")), "\n ],\n}"));
});
}
exports.getSentryAppConfigJsonCodeSnippet = getSentryAppConfigJsonCodeSnippet;
//# sourceMappingURL=expo.js.map