@sentry/wizard
Version:
Sentry wizard helping you to configure your project
226 lines • 13 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.runSvelteKitWizardWithTelemetry = exports.runSvelteKitWizard = 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 clack_utils_1 = require("../utils/clack-utils");
var package_json_1 = require("../utils/package-json");
var sdk_example_1 = require("./sdk-example");
var sdk_setup_1 = require("./sdk-setup");
var telemetry_1 = require("../telemetry");
var utils_1 = require("./utils");
var package_manager_1 = require("../utils/package-manager");
function runSvelteKitWizard(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: 'sveltekit',
}, function () { return runSvelteKitWizardWithTelemetry(options); })];
});
});
}
exports.runSvelteKitWizard = runSvelteKitWizard;
function runSvelteKitWizardWithTelemetry(options) {
return __awaiter(this, void 0, void 0, function () {
var packageJson, kitVersion, kitVersionBucket, shouldContinue, _a, selectedProject, selfHosted, sentryUrl, authToken, sdkAlreadyInstalled, svelteConfig, e_1, shouldCreateExamplePage, e_2;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
(0, clack_utils_1.printWelcome)({
wizardName: 'Sentry SvelteKit Wizard',
promoCode: options.promoCode,
telemetryEnabled: options.telemetryEnabled,
});
return [4 /*yield*/, (0, clack_utils_1.confirmContinueIfNoOrDirtyGitRepo)()];
case 1:
_b.sent();
return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
case 2:
packageJson = _b.sent();
return [4 /*yield*/, (0, clack_utils_1.ensurePackageIsInstalled)(packageJson, '@sveltejs/kit', 'Sveltekit')];
case 3:
_b.sent();
kitVersion = (0, package_json_1.getPackageVersion)('@sveltejs/kit', packageJson);
kitVersionBucket = (0, utils_1.getKitVersionBucket)(kitVersion);
Sentry.setTag('sveltekit-version', kitVersionBucket);
if (!(kitVersionBucket === '0.x')) return [3 /*break*/, 6];
clack.log.warn("It seems you're using a SvelteKit version <1.0.0 which is not supported by Sentry.\nWe recommend upgrading to the latest 1.x version before you continue.");
return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.select({
message: 'Do you want to continue anyway?',
options: [
{
label: 'Yes, continue',
hint: 'The SDK might not work correctly',
value: true,
},
{ label: "No, I'll upgrade first", value: false },
],
}))];
case 4:
shouldContinue = _b.sent();
if (!!shouldContinue) return [3 /*break*/, 6];
return [4 /*yield*/, (0, clack_utils_1.abort)('Exiting Wizard', 0)];
case 5:
_b.sent();
return [2 /*return*/];
case 6:
Sentry.setTag('svelte-version', (0, utils_1.getSvelteVersionBucket)((0, package_json_1.getPackageVersion)('svelte', packageJson)));
return [4 /*yield*/, (0, clack_utils_1.getOrAskForProjectData)(options, 'javascript-sveltekit')];
case 7:
_a = _b.sent(), selectedProject = _a.selectedProject, selfHosted = _a.selfHosted, sentryUrl = _a.sentryUrl, authToken = _a.authToken;
sdkAlreadyInstalled = (0, package_json_1.hasPackageInstalled)('@sentry/sveltekit', packageJson);
Sentry.setTag('sdk-already-installed', sdkAlreadyInstalled);
return [4 /*yield*/, (0, clack_utils_1.installPackage)({
packageName: '@sentry/sveltekit',
alreadyInstalled: sdkAlreadyInstalled,
})];
case 8:
_b.sent();
return [4 /*yield*/, (0, clack_utils_1.addSentryCliConfig)({ authToken: authToken })];
case 9:
_b.sent();
return [4 /*yield*/, (0, telemetry_1.traceStep)('load-svelte-config', sdk_setup_1.loadSvelteConfig)];
case 10:
svelteConfig = _b.sent();
_b.label = 11;
case 11:
_b.trys.push([11, 13, , 15]);
return [4 /*yield*/, (0, telemetry_1.traceStep)('configure-sdk', function () {
return (0, sdk_setup_1.createOrMergeSvelteKitFiles)({
dsn: selectedProject.keys[0].dsn.public,
org: selectedProject.organization.slug,
project: selectedProject.slug,
selfHosted: selfHosted,
url: sentryUrl,
}, svelteConfig);
})];
case 12:
_b.sent();
return [3 /*break*/, 15];
case 13:
e_1 = _b.sent();
clack.log.error('Error while setting up the SvelteKit SDK:');
clack.log.info(chalk_1.default.dim(typeof e_1 === 'object' && e_1 != null && 'toString' in e_1
? e_1.toString()
: typeof e_1 === 'string'
? e_1
: 'Unknown error'));
Sentry.captureException('Error while setting up the SvelteKit SDK');
return [4 /*yield*/, (0, clack_utils_1.abort)('Exiting Wizard')];
case 14:
_b.sent();
return [2 /*return*/];
case 15: return [4 /*yield*/, (0, clack_utils_1.askShouldCreateExamplePage)('/sentry-example')];
case 16:
shouldCreateExamplePage = _b.sent();
if (!shouldCreateExamplePage) return [3 /*break*/, 21];
_b.label = 17;
case 17:
_b.trys.push([17, 19, , 21]);
return [4 /*yield*/, (0, telemetry_1.traceStep)('create-example-page', function () {
return (0, sdk_example_1.createExamplePage)(svelteConfig, {
selfHosted: selfHosted,
url: sentryUrl,
orgSlug: selectedProject.organization.slug,
projectId: selectedProject.id,
});
})];
case 18:
_b.sent();
return [3 /*break*/, 21];
case 19:
e_2 = _b.sent();
clack.log.error('Error while creating an example page to test Sentry:');
clack.log.info(chalk_1.default.dim(typeof e_2 === 'object' && e_2 != null && 'toString' in e_2
? e_2.toString()
: typeof e_2 === 'string'
? e_2
: 'Unknown error'));
Sentry.captureException('Error while creating an example Svelte page to test Sentry');
return [4 /*yield*/, (0, clack_utils_1.abort)('Exiting Wizard')];
case 20:
_b.sent();
return [2 /*return*/];
case 21:
clack.outro(buildOutroMessage(shouldCreateExamplePage));
return [2 /*return*/];
}
});
});
}
exports.runSvelteKitWizardWithTelemetry = runSvelteKitWizardWithTelemetry;
function buildOutroMessage(shouldCreateExamplePage) {
var packageManager = (0, package_manager_1.detectPackageManger)() || package_manager_1.NPM;
var msg = chalk_1.default.green('\nSuccessfully installed the Sentry SvelteKit SDK!');
if (shouldCreateExamplePage) {
msg += "\n\nYou can validate your setup by starting your dev environment (".concat(chalk_1.default.cyan("`".concat(packageManager.runScriptCommand, " dev`")), ") and visiting ").concat(chalk_1.default.cyan('"/sentry-example"'), ".");
}
msg += "\n\nCheck out the SDK documentation for further configuration:\nhttps://docs.sentry.io/platforms/javascript/guides/sveltekit/";
return msg;
}
//# sourceMappingURL=sveltekit-wizard.js.map