@sentry/wizard
Version:
Sentry wizard helping you to configure your project
337 lines • 18.8 kB
JavaScript
"use strict";
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.addSentryCommandToBuildCommand = exports.setupNpmScriptInCI = exports.configureSentryCLI = 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 Sentry = __importStar(require("@sentry/node"));
var path = __importStar(require("path"));
var fs = __importStar(require("fs"));
var clack_utils_1 = require("../../utils/clack-utils");
var package_json_1 = require("../../utils/package-json");
var telemetry_1 = require("../../telemetry");
var package_manager_1 = require("../../utils/package-manager");
var SENTRY_NPM_SCRIPT_NAME = 'sentry:sourcemaps';
var addedToBuildCommand = false;
function configureSentryCLI(options, configureSourcemapGenerationFlow) {
if (configureSourcemapGenerationFlow === void 0) { configureSourcemapGenerationFlow = defaultConfigureSourcemapGenerationFlow; }
return __awaiter(this, void 0, void 0, function () {
var packageDotJson, validPath, relativeArtifactPath, rawArtifactPath, _a, relativePosixArtifactPath;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
case 1:
packageDotJson = _b.sent();
return [4 /*yield*/, (0, clack_utils_1.installPackage)({
packageName: '@sentry/cli',
alreadyInstalled: (0, package_json_1.hasPackageInstalled)('@sentry/cli', packageDotJson),
})];
case 2:
_b.sent();
validPath = false;
_b.label = 3;
case 3: return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.text({
message: 'Where are your build artifacts located?',
placeholder: ".".concat(path.sep, "out"),
validate: function (value) {
if (!value) {
return 'Please enter a path.';
}
},
}))];
case 4:
rawArtifactPath = _b.sent();
if (path.isAbsolute(rawArtifactPath)) {
relativeArtifactPath = path.relative(process.cwd(), rawArtifactPath);
}
else {
relativeArtifactPath = rawArtifactPath;
}
_b.label = 5;
case 5:
_b.trys.push([5, 7, , 9]);
return [4 /*yield*/, fs.promises.access(path.join(process.cwd(), relativeArtifactPath))];
case 6:
_b.sent();
validPath = true;
return [3 /*break*/, 9];
case 7:
_a = _b.sent();
return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.select({
message: "We couldn't find artifacts at ".concat(relativeArtifactPath, ". Are you sure that this is the location that contains your build artifacts?"),
options: [
{
label: 'No, let me verify.',
value: false,
},
{ label: 'Yes, I am sure!', value: true },
],
initialValue: false,
}))];
case 8:
validPath = _b.sent();
return [3 /*break*/, 9];
case 9:
if (!validPath) return [3 /*break*/, 3];
_b.label = 10;
case 10:
relativePosixArtifactPath = relativeArtifactPath
.split(path.sep)
.join(path.posix.sep);
return [4 /*yield*/, configureSourcemapGenerationFlow()];
case 11:
_b.sent();
return [4 /*yield*/, createAndAddNpmScript(options, relativePosixArtifactPath)];
case 12:
_b.sent();
return [4 /*yield*/, askShouldAddToBuildCommand()];
case 13:
if (!_b.sent()) return [3 /*break*/, 15];
return [4 /*yield*/, (0, telemetry_1.traceStep)('sentry-cli-add-to-build-cmd', function () {
return addSentryCommandToBuildCommand();
})];
case 14:
_b.sent();
return [3 /*break*/, 16];
case 15:
clack.log.info("No problem, just make sure to run this script ".concat(chalk_1.default.bold('after'), " building your application but ").concat(chalk_1.default.bold('before'), " deploying!"));
_b.label = 16;
case 16: return [4 /*yield*/, (0, clack_utils_1.addSentryCliConfig)({ authToken: options.authToken })];
case 17:
_b.sent();
return [2 /*return*/];
}
});
});
}
exports.configureSentryCLI = configureSentryCLI;
function setupNpmScriptInCI() {
return __awaiter(this, void 0, void 0, function () {
var addedToCI;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (addedToBuildCommand) {
// No need to tell users to add it manually to their CI
// if the script is already added to the build command
return [2 /*return*/];
}
return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.select({
message: "Add a step to your CI pipeline that runs the ".concat(chalk_1.default.cyan(SENTRY_NPM_SCRIPT_NAME), " script ").concat(chalk_1.default.bold('right after'), " building your application."),
options: [
{ label: 'I did, continue!', value: true },
{
label: "I'll do it later...",
value: false,
hint: chalk_1.default.yellow("You need to run ".concat(chalk_1.default.cyan(SENTRY_NPM_SCRIPT_NAME), " after each build for source maps to work properly.")),
},
],
initialValue: true,
}))];
case 1:
addedToCI = _a.sent();
Sentry.setTag('added-ci-script', addedToCI);
if (!addedToCI) {
clack.log.info("Don't forget! :)");
}
return [2 /*return*/];
}
});
});
}
exports.setupNpmScriptInCI = setupNpmScriptInCI;
function createAndAddNpmScript(options, relativePosixArtifactPath) {
return __awaiter(this, void 0, void 0, function () {
var sentryCliNpmScript, packageDotJson;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
sentryCliNpmScript = "sentry-cli sourcemaps inject --org ".concat(options.orgSlug, " --project ").concat(options.projectSlug, " ").concat(relativePosixArtifactPath, " && sentry-cli").concat(options.selfHosted ? " --url ".concat(options.url) : '', " sourcemaps upload --org ").concat(options.orgSlug, " --project ").concat(options.projectSlug, " ").concat(relativePosixArtifactPath);
return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
case 1:
packageDotJson = _a.sent();
packageDotJson.scripts = packageDotJson.scripts || {};
packageDotJson.scripts[SENTRY_NPM_SCRIPT_NAME] = sentryCliNpmScript;
return [4 /*yield*/, fs.promises.writeFile(path.join(process.cwd(), 'package.json'), JSON.stringify(packageDotJson, null, 2))];
case 2:
_a.sent();
clack.log.info("Added a ".concat(chalk_1.default.cyan(SENTRY_NPM_SCRIPT_NAME), " script to your ").concat(chalk_1.default.cyan('package.json'), "."));
return [2 /*return*/];
}
});
});
}
function askShouldAddToBuildCommand() {
return __awaiter(this, void 0, void 0, function () {
var shouldAddToBuildCommand;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.select({
message: "Do you want to automatically run the ".concat(chalk_1.default.cyan(SENTRY_NPM_SCRIPT_NAME), " script after each production build?"),
options: [
{
label: 'Yes',
value: true,
hint: 'This will modify your prod build command',
},
{ label: 'No', value: false },
],
initialValue: true,
}))];
case 1:
shouldAddToBuildCommand = _a.sent();
Sentry.setTag('modify-build-command', shouldAddToBuildCommand);
return [2 /*return*/, shouldAddToBuildCommand];
}
});
});
}
/**
* Add the sentry:sourcemaps command to the prod build command in the package.json
* - Detect the user's build command
* - Append the sentry:sourcemaps command to it
*
* @param packageDotJson The package.json which will be modified.
*/
function addSentryCommandToBuildCommand() {
var _a;
return __awaiter(this, void 0, void 0, function () {
var packageDotJson, allNpmScripts, packageManager, buildCommand, isProdBuildCommand, _b, oldCommand;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
case 1:
packageDotJson = _c.sent();
// This usually shouldn't happen because earlier we added the
// SENTRY_NPM_SCRIPT_NAME script but just to be sure
packageDotJson.scripts = packageDotJson.scripts || {};
allNpmScripts = Object.keys(packageDotJson.scripts).filter(function (s) { return s !== SENTRY_NPM_SCRIPT_NAME; });
packageManager = (_a = (0, package_manager_1.detectPackageManger)()) !== null && _a !== void 0 ? _a : package_manager_1.NPM;
buildCommand = typeof packageDotJson.scripts.build === 'string'
? 'build'
: allNpmScripts.find(function (s) { return s.toLocaleLowerCase().includes('build'); });
_b = !!buildCommand;
if (!_b) return [3 /*break*/, 3];
return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.confirm({
message: "Is ".concat(chalk_1.default.cyan("".concat(packageManager.runScriptCommand, " ").concat(buildCommand)), " your production build command?"),
}))];
case 2:
_b = (_c.sent());
_c.label = 3;
case 3:
isProdBuildCommand = _b;
if (!(allNpmScripts.length && (!buildCommand || !isProdBuildCommand))) return [3 /*break*/, 5];
return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.select({
message: "Which ".concat(packageManager.name, " command in your ").concat(chalk_1.default.cyan('package.json'), " builds your application for production?"),
options: allNpmScripts
.map(function (script) { return ({
label: script,
value: script,
}); })
.concat({ label: 'None of the above', value: 'none' }),
}))];
case 4:
buildCommand = _c.sent();
_c.label = 5;
case 5:
if (!buildCommand || buildCommand === 'none') {
clack.log.warn("We can only add the ".concat(chalk_1.default.cyan(SENTRY_NPM_SCRIPT_NAME), " script to another `script` in your ").concat(chalk_1.default.cyan('package.json'), ".\nPlease add it manually to your prod build command."));
return [2 /*return*/];
}
oldCommand = packageDotJson.scripts[buildCommand];
if (!oldCommand) {
// very unlikely to happen but nevertheless
clack.log.warn("`".concat(buildCommand, "` doesn't seem to be part of your package.json scripts"));
return [2 /*return*/];
}
packageDotJson.scripts[buildCommand] = "".concat(oldCommand, " && ").concat(packageManager.runScriptCommand, " ").concat(SENTRY_NPM_SCRIPT_NAME);
return [4 /*yield*/, fs.promises.writeFile(path.join(process.cwd(), 'package.json'), JSON.stringify(packageDotJson, null, 2))];
case 6:
_c.sent();
addedToBuildCommand = true;
clack.log.info("Added ".concat(chalk_1.default.cyan(SENTRY_NPM_SCRIPT_NAME), " script to your ").concat(chalk_1.default.cyan(buildCommand), " command."));
return [2 /*return*/];
}
});
});
}
exports.addSentryCommandToBuildCommand = addSentryCommandToBuildCommand;
function defaultConfigureSourcemapGenerationFlow() {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.select({
message: "Verify that your build tool is generating source maps. ".concat(chalk_1.default.dim('(Your build output folder should contain .js.map files after a build)')),
options: [{ label: 'I checked. Continue!', value: true }],
initialValue: true,
}))];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
}
//# sourceMappingURL=sentry-cli.js.map