@sentry/wizard
Version:
Sentry wizard helping you to configure your project
220 lines • 13.7 kB
JavaScript
;
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.runAndroidWizard = void 0;
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
var fs = __importStar(require("fs"));
// @ts-ignore - clack is ESM and TS complains about that. It works though
var clack = __importStar(require("@clack/prompts"));
var path = __importStar(require("path"));
var Sentry = __importStar(require("@sentry/node"));
var gradle = __importStar(require("./gradle"));
var manifest = __importStar(require("./manifest"));
var codetools = __importStar(require("./code-tools"));
var clack_utils_1 = require("../utils/clack-utils");
var telemetry_1 = require("../telemetry");
var chalk_1 = __importDefault(require("chalk"));
var proguardMappingCliSetupConfig = __assign(__assign({}, clack_utils_1.propertiesCliSetupConfig), { name: 'proguard mappings' });
function runAndroidWizard(options) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, (0, telemetry_1.withTelemetry)({
enabled: options.telemetryEnabled,
integration: 'android',
}, function () { return runAndroidWizardWithTelemetry(options); })];
});
});
}
exports.runAndroidWizard = runAndroidWizard;
function runAndroidWizardWithTelemetry(options) {
return __awaiter(this, void 0, void 0, function () {
var projectDir, buildGradleFiles, appFile, _a, selectedProject, selfHosted, sentryUrl, authToken, pluginAdded, appDir, manifestFile, manifestUpdated, mainActivity, packageName, activityName, packageNameStable_1, activityFile_1, activityPatched, issuesPageLink;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
(0, clack_utils_1.printWelcome)({
wizardName: 'Sentry Android Wizard',
promoCode: options.promoCode,
});
return [4 /*yield*/, (0, clack_utils_1.confirmContinueIfNoOrDirtyGitRepo)()];
case 1:
_b.sent();
projectDir = process.cwd();
buildGradleFiles = findFilesWithExtensions(projectDir, [
'.gradle',
'gradle.kts',
]);
if (!(!buildGradleFiles || buildGradleFiles.length === 0)) return [3 /*break*/, 3];
clack.log.error('No Gradle project found. Please run this command from the root of your project.');
Sentry.captureException('No Gradle project found');
return [4 /*yield*/, (0, clack_utils_1.abort)()];
case 2:
_b.sent();
return [2 /*return*/];
case 3: return [4 /*yield*/, (0, telemetry_1.traceStep)('Select App File', function () {
return gradle.selectAppFile(buildGradleFiles);
})];
case 4:
appFile = _b.sent();
return [4 /*yield*/, (0, clack_utils_1.getOrAskForProjectData)(options, 'android')];
case 5:
_a = _b.sent(), selectedProject = _a.selectedProject, selfHosted = _a.selfHosted, sentryUrl = _a.sentryUrl, authToken = _a.authToken;
// ======== STEP 1. Add Sentry Gradle Plugin to build.gradle(.kts) ============
clack.log.step("Adding ".concat(chalk_1.default.bold('Sentry Gradle plugin'), " to your app's ").concat(chalk_1.default.cyan('build.gradle'), " file."));
return [4 /*yield*/, (0, telemetry_1.traceStep)('Add Gradle Plugin', function () {
return gradle.addGradlePlugin(appFile, selectedProject.organization.slug, selectedProject.slug);
})];
case 6:
pluginAdded = _b.sent();
if (!pluginAdded) {
clack.log.warn("Could not add Sentry Gradle plugin to your app's build.gradle file. You'll have to add it manually.\nPlease follow the instructions at https://docs.sentry.io/platforms/android/#install");
}
Sentry.setTag('gradle-plugin-added', pluginAdded);
// ======== STEP 2. Configure Sentry SDK via AndroidManifest ============
clack.log.step("Configuring Sentry SDK via ".concat(chalk_1.default.cyan('AndroidManifest.xml')));
appDir = path.dirname(appFile);
manifestFile = path.join(appDir, 'src', 'main', 'AndroidManifest.xml');
manifestUpdated = (0, telemetry_1.traceStep)('Update Android Manifest', function () {
return manifest.addManifestSnippet(manifestFile, selectedProject.keys[0].dsn.public);
});
if (!manifestUpdated) {
clack.log.warn("Could not configure the Sentry SDK. You'll have to do it manually.\nPlease follow the instructions at https://docs.sentry.io/platforms/android/#configure");
}
Sentry.setTag('android-manifest-updated', manifestUpdated);
// ======== STEP 3. Patch Main Activity with a test error snippet ============
clack.log.step("Patching ".concat(chalk_1.default.bold('Main Activity'), " with a test error snippet."));
mainActivity = (0, telemetry_1.traceStep)('Find Main Activity', function () {
return manifest.getMainActivity(manifestFile);
});
packageName = mainActivity.packageName;
if (!packageName) {
// if no package name in AndroidManifest, look into gradle script
packageName = gradle.getNamespace(appFile);
}
activityName = mainActivity.activityName;
Sentry.setTag('has-activity-name', !!activityName);
Sentry.setTag('has-package-name', !!packageName);
if (!activityName || !packageName) {
clack.log.warn("Could not find Activity with intent action MAIN. You'll have to manually verify the setup.\nPlease follow the instructions at https://docs.sentry.io/platforms/android/#verify");
Sentry.captureException('Could not find Main Activity');
}
else {
packageNameStable_1 = packageName;
activityFile_1 = (0, telemetry_1.traceStep)('Find Main Activity Source File', function () {
return codetools.findActivitySourceFile(appDir, packageNameStable_1, activityName);
});
activityPatched = (0, telemetry_1.traceStep)('Patch Main Activity', function () {
return codetools.patchMainActivity(activityFile_1);
});
if (!activityPatched) {
clack.log.warn("Could not patch main activity. You'll have to manually verify the setup.\nPlease follow the instructions at https://docs.sentry.io/platforms/android/#verify");
}
Sentry.setTag('main-activity-patched', activityPatched);
}
// ======== STEP 4. Add sentry-cli config file ============
clack.log.step("Configuring ".concat(chalk_1.default.bold('proguard mappings upload'), " via the ").concat(chalk_1.default.cyan('sentry.properties'), " file."));
return [4 /*yield*/, (0, clack_utils_1.addSentryCliConfig)({ authToken: authToken }, proguardMappingCliSetupConfig)];
case 7:
_b.sent();
issuesPageLink = selfHosted
? "".concat(sentryUrl, "organizations/").concat(selectedProject.organization.slug, "/issues/?project=").concat(selectedProject.id)
: "https://".concat(selectedProject.organization.slug, ".sentry.io/issues/?project=").concat(selectedProject.id);
clack.outro("\n".concat(chalk_1.default.greenBright('Successfully installed the Sentry Android SDK!'), "\n\n").concat(chalk_1.default.cyan("You can validate your setup by launching your application and checking Sentry issues page afterwards\n".concat(issuesPageLink)), "\n\nCheck out the SDK documentation for further configuration:\nhttps://docs.sentry.io/platforms/android/\n "));
return [2 /*return*/];
}
});
});
}
//find files with the given extension
function findFilesWithExtensions(dir, extensions, filesWithExtensions) {
if (filesWithExtensions === void 0) { filesWithExtensions = []; }
var cwd = process.cwd();
var files = fs.readdirSync(dir, { withFileTypes: true });
var _loop_1 = function (file) {
if (file.isDirectory()) {
var childDir = path.join(dir, file.name);
findFilesWithExtensions(childDir, extensions, filesWithExtensions);
}
else if (extensions.some(function (ext) { return file.name.endsWith(ext); })) {
filesWithExtensions.push(path.relative(cwd, path.join(dir, file.name)));
}
};
for (var _i = 0, files_1 = files; _i < files_1.length; _i++) {
var file = files_1[_i];
_loop_1(file);
}
return filesWithExtensions;
}
//# sourceMappingURL=android-wizard.js.map