@sentry/wizard
Version:
Sentry wizard helping you to configure your project
337 lines • 21.5 kB
JavaScript
"use strict";
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.runRemixWizard = void 0;
// @ts-expect-error - 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 clack_utils_1 = require("../utils/clack-utils");
var package_json_1 = require("../utils/package-json");
var sdk_setup_1 = require("./sdk-setup");
var debug_1 = require("../utils/debug");
var telemetry_1 = require("../telemetry");
var utils_1 = require("./utils");
var Constants_1 = require("../../lib/Constants");
var ast_utils_1 = require("../utils/ast-utils");
var vite_1 = require("../sourcemaps/tools/vite");
var sdk_example_1 = require("./sdk-example");
function runRemixWizard(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: 'remix',
}, function () { return runRemixWizardWithTelemetry(options); })];
});
});
}
exports.runRemixWizard = runRemixWizard;
function runRemixWizardWithTelemetry(options) {
return __awaiter(this, void 0, void 0, function () {
var remixConfig, packageJson, _a, selectedProject, authToken, sentryUrl, selfHosted, dsn, isTS, isV2, viteConfig, instrumentationFile, serverFileInstrumented, shouldCreateExamplePage;
var _this = this;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
(0, clack_utils_1.printWelcome)({
wizardName: 'Sentry Remix Wizard',
promoCode: options.promoCode,
telemetryEnabled: options.telemetryEnabled,
});
return [4 /*yield*/, (0, clack_utils_1.confirmContinueIfNoOrDirtyGitRepo)()];
case 1:
_b.sent();
return [4 /*yield*/, (0, sdk_setup_1.loadRemixConfig)()];
case 2:
remixConfig = _b.sent();
return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
case 3:
packageJson = _b.sent();
// We expect `@remix-run/dev` to be installed for every Remix project
return [4 /*yield*/, (0, clack_utils_1.ensurePackageIsInstalled)(packageJson, '@remix-run/dev', 'Remix')];
case 4:
// We expect `@remix-run/dev` to be installed for every Remix project
_b.sent();
return [4 /*yield*/, (0, clack_utils_1.getOrAskForProjectData)(options, 'javascript-remix')];
case 5:
_a = _b.sent(), selectedProject = _a.selectedProject, authToken = _a.authToken, sentryUrl = _a.sentryUrl, selfHosted = _a.selfHosted;
return [4 /*yield*/, (0, clack_utils_1.installPackage)({
packageName: '@sentry/remix',
alreadyInstalled: (0, package_json_1.hasPackageInstalled)('@sentry/remix', packageJson),
})];
case 6:
_b.sent();
dsn = selectedProject.keys[0].dsn.public;
isTS = (0, clack_utils_1.isUsingTypeScript)();
isV2 = (0, sdk_setup_1.isRemixV2)(remixConfig, packageJson);
viteConfig = (0, ast_utils_1.findFile)('vite.config');
return [4 /*yield*/, (0, clack_utils_1.addSentryCliConfig)({ authToken: authToken }, clack_utils_1.rcCliSetupConfig)];
case 7:
_b.sent();
if (!viteConfig) return [3 /*break*/, 9];
return [4 /*yield*/, (0, telemetry_1.traceStep)('Update vite configuration for sourcemap uploads', function () { return __awaiter(_this, void 0, void 0, function () {
var e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, vite_1.configureVitePlugin)({
orgSlug: selectedProject.organization.slug,
projectSlug: selectedProject.slug,
url: sentryUrl,
selfHosted: selfHosted,
authToken: authToken,
})];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
e_1 = _a.sent();
prompts_1.default.log
.warn("Could not update vite configuration to generate and upload sourcemaps.\n Please update your vite configuration manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/sourcemaps/");
(0, debug_1.debug)(e_1);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 8:
_b.sent();
return [3 /*break*/, 11];
case 9: return [4 /*yield*/, (0, telemetry_1.traceStep)('Update build script for sourcemap uploads', function () { return __awaiter(_this, void 0, void 0, function () {
var e_2;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, sdk_setup_1.updateBuildScript)({
org: selectedProject.organization.slug,
project: selectedProject.slug,
url: sentryUrl === Constants_1.DEFAULT_URL ? undefined : sentryUrl,
isHydrogen: (0, utils_1.isHydrogenApp)(packageJson),
})];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
e_2 = _a.sent();
prompts_1.default.log
.warn("Could not update build script to generate and upload sourcemaps.\n Please update your build script manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/sourcemaps/");
(0, debug_1.debug)(e_2);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 10:
_b.sent();
_b.label = 11;
case 11: return [4 /*yield*/, (0, telemetry_1.traceStep)('Instrument root route', function () { return __awaiter(_this, void 0, void 0, function () {
var e_3;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, sdk_setup_1.instrumentRootRoute)(isV2, isTS)];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
e_3 = _a.sent();
prompts_1.default.log.warn("Could not instrument root route.\n Please do it manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/manual-setup/");
(0, debug_1.debug)(e_3);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 12:
_b.sent();
(0, telemetry_1.traceStep)('Reveal missing entry files', function () {
try {
(0, sdk_setup_1.runRemixReveal)(isTS);
}
catch (e) {
prompts_1.default.log.warn("Could not run 'npx remix reveal'.\n Please create your entry files manually");
(0, debug_1.debug)(e);
}
});
return [4 /*yield*/, (0, telemetry_1.traceStep)('Initialize Sentry on client entry', function () { return __awaiter(_this, void 0, void 0, function () {
var e_4;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, sdk_setup_1.initializeSentryOnEntryClient)(dsn, isTS)];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
e_4 = _a.sent();
prompts_1.default.log.warn("Could not initialize Sentry on client entry.\n Please do it manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/manual-setup/");
(0, debug_1.debug)(e_4);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 13:
_b.sent();
instrumentationFile = '';
return [4 /*yield*/, (0, telemetry_1.traceStep)('Create server instrumentation file', function () { return __awaiter(_this, void 0, void 0, function () {
var e_5;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, sdk_setup_1.createServerInstrumentationFile)(dsn)];
case 1:
instrumentationFile = _a.sent();
return [3 /*break*/, 3];
case 2:
e_5 = _a.sent();
prompts_1.default.log.warn('Could not create a server instrumentation file. Please do it manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/manual-setup/');
(0, debug_1.debug)(e_5);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 14:
_b.sent();
serverFileInstrumented = false;
return [4 /*yield*/, (0, telemetry_1.traceStep)('Create server instrumentation file and import it', function () { return __awaiter(_this, void 0, void 0, function () {
var e_6;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, sdk_setup_1.insertServerInstrumentationFile)(dsn)];
case 1:
serverFileInstrumented = _a.sent();
return [3 /*break*/, 3];
case 2:
e_6 = _a.sent();
prompts_1.default.log.warn('Could not create a server instrumentation file. Please do it manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/manual-setup/');
(0, debug_1.debug)(e_6);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 15:
_b.sent();
if (!(!serverFileInstrumented && instrumentationFile)) return [3 /*break*/, 17];
return [4 /*yield*/, (0, telemetry_1.traceStep)('Update `start` script to import instrumentation file.', function () { return __awaiter(_this, void 0, void 0, function () {
var e_7;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, sdk_setup_1.updateStartScript)(instrumentationFile)];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
e_7 = _a.sent();
prompts_1.default.log
.warn("Could not automatically add Sentry initialization to server entry.\n Please do it manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/manual-setup/");
(0, debug_1.debug)(e_7);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 16:
_b.sent();
_b.label = 17;
case 17: return [4 /*yield*/, (0, telemetry_1.traceStep)('Instrument server `handleError`', function () { return __awaiter(_this, void 0, void 0, function () {
var e_8;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, (0, sdk_setup_1.instrumentSentryOnEntryServer)(isV2, isTS)];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
e_8 = _a.sent();
prompts_1.default.log.warn("Could not initialize Sentry on server entry.\n Please do it manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/manual-setup/");
(0, debug_1.debug)(e_8);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); })];
case 18:
_b.sent();
return [4 /*yield*/, (0, clack_utils_1.askShouldCreateExamplePage)()];
case 19:
shouldCreateExamplePage = _b.sent();
if (!shouldCreateExamplePage) return [3 /*break*/, 21];
return [4 /*yield*/, (0, telemetry_1.traceStep)('Create example page', function () { return __awaiter(_this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, sdk_example_1.createExamplePage)({
isTS: isTS,
selfHosted: selfHosted,
orgSlug: selectedProject.organization.slug,
projectId: selectedProject.id,
url: sentryUrl,
})];
case 1:
_a.sent();
return [2 /*return*/];
}
});
}); })];
case 20:
_b.sent();
_b.label = 21;
case 21:
prompts_1.default.outro("\n".concat(chalk_1.default.green('Sentry has been successfully configured for your Remix project.'), "\n\n").concat(chalk_1.default.cyan('You can now deploy your project to see Sentry in action.'), "\n\n").concat(chalk_1.default.cyan("To learn more about how to use Sentry with Remix, visit our documentation:\nhttps://docs.sentry.io/platforms/javascript/guides/remix/")));
return [2 /*return*/];
}
});
});
}
//# sourceMappingURL=remix-wizard.js.map