@sentry/wizard
Version:
Sentry wizard helping you to configure your project
101 lines • 17.2 kB
JavaScript
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getGlobalErrorCopyPasteSnippet = exports.getSentryDefaultGlobalErrorPage = exports.getInstrumentationHookCopyPasteSnippet = exports.getInstrumentationHookContent = exports.getFullUnderscoreErrorCopyPasteSnippet = exports.getSimpleUnderscoreErrorCopyPasteSnippet = exports.getSentryDefaultUnderscoreErrorPage = exports.getSentryExampleAppDirApiRoute = exports.getSentryExampleApiRoute = exports.getSentryExamplePageContents = exports.getSentryConfigContents = exports.getNextjsConfigEsmCopyPasteSnippet = exports.getNextjsConfigCjsAppendix = exports.getNextjsConfigCjsTemplate = exports.getWithSentryConfigOptionsTemplate = void 0;
var chalk_1 = __importDefault(require("chalk"));
var clack_utils_1 = require("../utils/clack-utils");
function getWithSentryConfigOptionsTemplate(_a) {
var orgSlug = _a.orgSlug, projectSlug = _a.projectSlug, selfHosted = _a.selfHosted, tunnelRoute = _a.tunnelRoute, sentryUrl = _a.sentryUrl;
return "{\n // For all available options, see:\n // https://github.com/getsentry/sentry-webpack-plugin#options\n\n org: \"".concat(orgSlug, "\",\n project: \"").concat(projectSlug, "\",").concat(selfHosted ? "\n sentryUrl: \"".concat(sentryUrl, "\",") : '', "\n\n // Only print logs for uploading source maps in CI\n silent: !process.env.CI,\n\n // For all available options, see:\n // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/\n\n // Upload a larger set of source maps for prettier stack traces (increases build time)\n widenClientFileUpload: true,\n\n // ").concat(tunnelRoute ? 'Route' : 'Uncomment to route', " browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.\n // This can increase your server load as well as your hosting bill.\n // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-\n // side errors will fail.\n ").concat(tunnelRoute ? '' : '// ', "tunnelRoute: \"/monitoring\",\n\n // Hides source maps from generated client bundles\n hideSourceMaps: true,\n\n // Automatically tree-shake Sentry logger statements to reduce bundle size\n disableLogger: true,\n\n // Enables automatic instrumentation of Vercel Cron Monitors. (Does not yet work with App Router route handlers.)\n // See the following for more information:\n // https://docs.sentry.io/product/crons/\n // https://vercel.com/docs/cron-jobs\n automaticVercelMonitors: true,\n }");
}
exports.getWithSentryConfigOptionsTemplate = getWithSentryConfigOptionsTemplate;
function getNextjsConfigCjsTemplate(withSentryConfigOptionsTemplate) {
return "const { withSentryConfig } = require(\"@sentry/nextjs\");\n\n/** @type {import('next').NextConfig} */\nconst nextConfig = {};\n\nmodule.exports = withSentryConfig(\n nextConfig,\n ".concat(withSentryConfigOptionsTemplate, "\n);\n");
}
exports.getNextjsConfigCjsTemplate = getNextjsConfigCjsTemplate;
function getNextjsConfigCjsAppendix(withSentryConfigOptionsTemplate) {
return "\n\n// Injected content via Sentry wizard below\n\nconst { withSentryConfig } = require(\"@sentry/nextjs\");\n\nmodule.exports = withSentryConfig(\n module.exports,\n ".concat(withSentryConfigOptionsTemplate, "\n);\n");
}
exports.getNextjsConfigCjsAppendix = getNextjsConfigCjsAppendix;
function getNextjsConfigEsmCopyPasteSnippet(withSentryConfigOptionsTemplate) {
return "\n\n// next.config.mjs\nimport { withSentryConfig } from \"@sentry/nextjs\";\n\nexport default withSentryConfig(\n yourNextConfig,\n ".concat(withSentryConfigOptionsTemplate, "\n);\n");
}
exports.getNextjsConfigEsmCopyPasteSnippet = getNextjsConfigEsmCopyPasteSnippet;
function getSentryConfigContents(dsn, config) {
var primer;
if (config === 'server') {
primer = "// This file configures the initialization of Sentry on the server.\n// The config you add here will be used whenever the server handles a request.\n// https://docs.sentry.io/platforms/javascript/guides/nextjs/";
}
else if (config === 'client') {
primer = "// This file configures the initialization of Sentry on the client.\n// The config you add here will be used whenever a users loads a page in their browser.\n// https://docs.sentry.io/platforms/javascript/guides/nextjs/";
}
else if (config === 'edge') {
primer = "// This file configures the initialization of Sentry for edge features (middleware, edge routes, and so on).\n// The config you add here will be used whenever one of the edge features is loaded.\n// Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally.\n// https://docs.sentry.io/platforms/javascript/guides/nextjs/";
}
var additionalOptions = '';
if (config === 'client') {
additionalOptions = "\n\n replaysOnErrorSampleRate: 1.0,\n\n // This sets the sample rate to be 10%. You may want this to be 100% while\n // in development and sample at a lower rate in production\n replaysSessionSampleRate: 0.1,\n\n // You can remove this option if you're not planning to use the Sentry Session Replay feature:\n integrations: [\n Sentry.replayIntegration({\n // Additional Replay configuration goes in here, for example:\n maskAllText: true,\n blockAllMedia: true,\n }),\n ],";
}
var spotlightOption = '';
if (config === 'server') {
spotlightOption = "\n\n // Uncomment the line below to enable Spotlight (https://spotlightjs.com)\n // spotlight: process.env.NODE_ENV === 'development',\n ";
}
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
return "".concat(primer, "\n\nimport * as Sentry from \"@sentry/nextjs\";\n\nSentry.init({\n dsn: \"").concat(dsn, "\",\n\n // Adjust this value in production, or use tracesSampler for greater control\n tracesSampleRate: 1,\n\n // Setting this option to true will print useful information to the console while you're setting up Sentry.\n debug: false,").concat(additionalOptions).concat(spotlightOption, "\n});\n");
}
exports.getSentryConfigContents = getSentryConfigContents;
function getSentryExamplePageContents(options) {
var issuesPageLink = options.selfHosted
? "".concat(options.sentryUrl, "organizations/").concat(options.orgSlug, "/issues/?project=").concat(options.projectId)
: "https://".concat(options.orgSlug, ".sentry.io/issues/?project=").concat(options.projectId);
return "".concat(options.useClient ? '"use client";\n\n' : '', "import Head from \"next/head\";\nimport * as Sentry from \"@sentry/nextjs\";\n\nexport default function Page() {\n return (\n <div>\n <Head>\n <title>Sentry Onboarding</title>\n <meta name=\"description\" content=\"Test Sentry for your Next.js app!\" />\n </Head>\n\n <main\n style={{\n minHeight: \"100vh\",\n display: \"flex\",\n flexDirection: \"column\",\n justifyContent: \"center\",\n alignItems: \"center\",\n }}\n >\n <h1 style={{ fontSize: \"4rem\", margin: \"14px 0\" }}>\n <svg\n style={{\n height: \"1em\",\n }}\n xmlns=\"http://www.w3.org/2000/svg\"\n viewBox=\"0 0 200 44\"\n >\n <path\n fill=\"currentColor\"\n d=\"M124.32,28.28,109.56,9.22h-3.68V34.77h3.73V15.19l15.18,19.58h3.26V9.22h-3.73ZM87.15,23.54h13.23V20.22H87.14V12.53h14.93V9.21H83.34V34.77h18.92V31.45H87.14ZM71.59,20.3h0C66.44,19.06,65,18.08,65,15.7c0-2.14,1.89-3.59,4.71-3.59a12.06,12.06,0,0,1,7.07,2.55l2-2.83a14.1,14.1,0,0,0-9-3c-5.06,0-8.59,3-8.59,7.27,0,4.6,3,6.19,8.46,7.52C74.51,24.74,76,25.78,76,28.11s-2,3.77-5.09,3.77a12.34,12.34,0,0,1-8.3-3.26l-2.25,2.69a15.94,15.94,0,0,0,10.42,3.85c5.48,0,9-2.95,9-7.51C79.75,23.79,77.47,21.72,71.59,20.3ZM195.7,9.22l-7.69,12-7.64-12h-4.46L186,24.67V34.78h3.84V24.55L200,9.22Zm-64.63,3.46h8.37v22.1h3.84V12.68h8.37V9.22H131.08ZM169.41,24.8c3.86-1.07,6-3.77,6-7.63,0-4.91-3.59-8-9.38-8H154.67V34.76h3.8V25.58h6.45l6.48,9.2h4.44l-7-9.82Zm-10.95-2.5V12.6h7.17c3.74,0,5.88,1.77,5.88,4.84s-2.29,4.86-5.84,4.86Z M29,2.26a4.67,4.67,0,0,0-8,0L14.42,13.53A32.21,32.21,0,0,1,32.17,40.19H27.55A27.68,27.68,0,0,0,12.09,17.47L6,28a15.92,15.92,0,0,1,9.23,12.17H4.62A.76.76,0,0,1,4,39.06l2.94-5a10.74,10.74,0,0,0-3.36-1.9l-2.91,5a4.54,4.54,0,0,0,1.69,6.24A4.66,4.66,0,0,0,4.62,44H19.15a19.4,19.4,0,0,0-8-17.31l2.31-4A23.87,23.87,0,0,1,23.76,44H36.07a35.88,35.88,0,0,0-16.41-31.8l4.67-8a.77.77,0,0,1,1.05-.27c.53.29,20.29,34.77,20.66,35.17a.76.76,0,0,1-.68,1.13H40.6q.09,1.91,0,3.81h4.78A4.59,4.59,0,0,0,50,39.43a4.49,4.49,0,0,0-.62-2.28Z\"\n ></path>\n </svg>\n </h1>\n\n <p>Get started by sending us a sample error:</p>\n <button\n type=\"button\"\n style={{\n padding: \"12px\",\n cursor: \"pointer\",\n backgroundColor: \"#AD6CAA\",\n borderRadius: \"4px\",\n border: \"none\",\n color: \"white\",\n fontSize: \"14px\",\n margin: \"18px\",\n }}\n onClick={async () => {\n await Sentry.startSpan({\n name: 'Example Frontend Span',\n op: 'test'\n }, async () => {\n const res = await fetch(\"/api/sentry-example-api\");\n if (!res.ok) {\n throw new Error(\"Sentry Example Frontend Error\");\n }\n });\n }}\n >\n Throw error!\n </button>\n\n <p>\n Next, look for the error on the{\" \"}\n <a href=\"").concat(issuesPageLink, "\">Issues Page</a>.\n </p>\n <p style={{ marginTop: \"24px\" }}>\n For more information, see{\" \"}\n <a href=\"https://docs.sentry.io/platforms/javascript/guides/nextjs/\">\n https://docs.sentry.io/platforms/javascript/guides/nextjs/\n </a>\n </p>\n </main>\n </div>\n );\n}\n");
}
exports.getSentryExamplePageContents = getSentryExamplePageContents;
function getSentryExampleApiRoute() {
return "// A faulty API route to test Sentry's error monitoring\nexport default function handler(_req, res) {\n throw new Error(\"Sentry Example API Route Error\");\n res.status(200).json({ name: \"John Doe\" });\n}\n";
}
exports.getSentryExampleApiRoute = getSentryExampleApiRoute;
function getSentryExampleAppDirApiRoute() {
return "import { NextResponse } from \"next/server\";\n\nexport const dynamic = \"force-dynamic\";\n\n// A faulty API route to test Sentry's error monitoring\nexport function GET() {\n throw new Error(\"Sentry Example API Route Error\");\n return NextResponse.json({ data: \"Testing Sentry Error...\" });\n}\n";
}
exports.getSentryExampleAppDirApiRoute = getSentryExampleAppDirApiRoute;
function getSentryDefaultUnderscoreErrorPage() {
return "import * as Sentry from \"@sentry/nextjs\";\nimport Error from \"next/error\";\n\nconst CustomErrorComponent = (props) => {\n return <Error statusCode={props.statusCode} />;\n};\n\nCustomErrorComponent.getInitialProps = async (contextData) => {\n // In case this is running in a serverless function, await this in order to give Sentry\n // time to send the error before the lambda exits\n await Sentry.captureUnderscoreErrorException(contextData);\n\n // This will contain the status code of the response\n return Error.getInitialProps(contextData);\n};\n\nexport default CustomErrorComponent;\n";
}
exports.getSentryDefaultUnderscoreErrorPage = getSentryDefaultUnderscoreErrorPage;
function getSimpleUnderscoreErrorCopyPasteSnippet() {
return "\n".concat(chalk_1.default.green("import * as Sentry from '@sentry/nextjs';"), "\n\n").concat(chalk_1.default.dim('// Replace "YourCustomErrorComponent" with your custom error component!'), "\nYourCustomErrorComponent.getInitialProps = async (").concat(chalk_1.default.green("contextData"), ") => {\n ").concat(chalk_1.default.green('await Sentry.captureUnderscoreErrorException(contextData);'), "\n\n ").concat(chalk_1.default.dim('// ...other getInitialProps code'), "\n};\n");
}
exports.getSimpleUnderscoreErrorCopyPasteSnippet = getSimpleUnderscoreErrorCopyPasteSnippet;
function getFullUnderscoreErrorCopyPasteSnippet(isTs) {
return "\nimport * as Sentry from '@sentry/nextjs';".concat(isTs ? '\nimport type { NextPageContext } from "next";' : '', "\n\n").concat(chalk_1.default.dim('// Replace "YourCustomErrorComponent" with your custom error component!'), "\nYourCustomErrorComponent.getInitialProps = async (contextData").concat(isTs ? ': NextPageContext' : '', ") => {\n await Sentry.captureUnderscoreErrorException(contextData);\n};\n");
}
exports.getFullUnderscoreErrorCopyPasteSnippet = getFullUnderscoreErrorCopyPasteSnippet;
function getInstrumentationHookContent(instrumentationHookLocation) {
return "export async function register() {\n if (process.env.NEXT_RUNTIME === 'nodejs') {\n await import('".concat(instrumentationHookLocation === 'root' ? '.' : '..', "/sentry.server.config');\n }\n\n if (process.env.NEXT_RUNTIME === 'edge') {\n await import('").concat(instrumentationHookLocation === 'root' ? '.' : '..', "/sentry.edge.config');\n }\n}\n");
}
exports.getInstrumentationHookContent = getInstrumentationHookContent;
function getInstrumentationHookCopyPasteSnippet(instrumentationHookLocation) {
return (0, clack_utils_1.makeCodeSnippet)(true, function (unchanged, plus) {
return unchanged("export ".concat(plus('async'), " function register() {\n ").concat(plus("if (process.env.NEXT_RUNTIME === 'nodejs') {\n await import('".concat(instrumentationHookLocation === 'root' ? '.' : '..', "/sentry.server.config');\n }\n\n if (process.env.NEXT_RUNTIME === 'edge') {\n await import('").concat(instrumentationHookLocation === 'root' ? '.' : '..', "/sentry.edge.config');\n }")), "\n}"));
});
}
exports.getInstrumentationHookCopyPasteSnippet = getInstrumentationHookCopyPasteSnippet;
function getSentryDefaultGlobalErrorPage(isTs) {
return isTs
? "\"use client\";\n\nimport * as Sentry from \"@sentry/nextjs\";\nimport NextError from \"next/error\";\nimport { useEffect } from \"react\";\n\nexport default function GlobalError({ error }: { error: Error & { digest?: string } }) {\n useEffect(() => {\n Sentry.captureException(error);\n }, [error]);\n\n return (\n <html>\n <body>\n {/* `NextError` is the default Next.js error page component. Its type\n definition requires a `statusCode` prop. However, since the App Router\n does not expose status codes for errors, we simply pass 0 to render a\n generic error message. */}\n <NextError statusCode={0} />\n </body>\n </html>\n );\n}"
: "\"use client\";\n\nimport * as Sentry from \"@sentry/nextjs\";\nimport NextError from \"next/error\";\nimport { useEffect } from \"react\";\n\nexport default function GlobalError({ error }) {\n useEffect(() => {\n Sentry.captureException(error);\n }, [error]);\n\n return (\n <html>\n <body>\n {/* `NextError` is the default Next.js error page component. Its type\n definition requires a `statusCode` prop. However, since the App Router\n does not expose status codes for errors, we simply pass 0 to render a\n generic error message. */}\n <NextError statusCode={0} />\n </body>\n </html>\n );\n}\n";
}
exports.getSentryDefaultGlobalErrorPage = getSentryDefaultGlobalErrorPage;
function getGlobalErrorCopyPasteSnippet(isTs) {
if (isTs) {
return "\"use client\";\n\n".concat(chalk_1.default.green('import * as Sentry from "@sentry/nextjs";'), "\n").concat(chalk_1.default.green('import Error from "next/error";'), "\n").concat(chalk_1.default.green('import { useEffect } from "react";'), "\n\nexport default function GlobalError(").concat(chalk_1.default.green('{ error }: { error: Error }'), ") {\n ").concat(chalk_1.default.green("useEffect(() => {\n Sentry.captureException(error);\n }, [error]);"), "\n\n return (\n <html>\n <body>\n {/* Your Error component here... */}\n </body>\n </html>\n );\n}\n");
}
else {
return "\"use client\";\n\n".concat(chalk_1.default.green('import * as Sentry from "@sentry/nextjs";'), "\n").concat(chalk_1.default.green('import Error from "next/error";'), "\n").concat(chalk_1.default.green('import { useEffect } from "react";'), "\n\nexport default function GlobalError(").concat(chalk_1.default.green('{ error }'), ") {\n ").concat(chalk_1.default.green("useEffect(() => {\n Sentry.captureException(error);\n }, [error]);"), "\n\n return (\n <html>\n <body>\n {/* Your Error component here... */}\n </body>\n </html>\n );\n}\n");
}
}
exports.getGlobalErrorCopyPasteSnippet = getGlobalErrorCopyPasteSnippet;
//# sourceMappingURL=templates.js.map