@sentry/wizard 4.0.0 → 4.0.1

package/src/nextjs/templates.ts

@@ -1,525 +0,0 @@
-import chalk from 'chalk';
-import { makeCodeSnippet } from '../utils/clack-utils';
-
-type WithSentryConfigOptions = {
-  orgSlug: string;
-  projectSlug: string;
-  selfHosted: boolean;
-  sentryUrl: string;
-  tunnelRoute: boolean;
-  reactComponentAnnotation: boolean;
-};
-
-export function getWithSentryConfigOptionsTemplate({
-  orgSlug,
-  projectSlug,
-  selfHosted,
-  tunnelRoute,
-  reactComponentAnnotation,
-  sentryUrl,
-}: WithSentryConfigOptions): string {
-  return `{
-    // For all available options, see:
-    // https://github.com/getsentry/sentry-webpack-plugin#options
-
-    org: "${orgSlug}",
-    project: "${projectSlug}",${
-    selfHosted ? `\n    sentryUrl: "${sentryUrl}",` : ''
-  }
-
-    // Only print logs for uploading source maps in CI
-    silent: !process.env.CI,
-
-    // For all available options, see:
-    // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
-
-    // Upload a larger set of source maps for prettier stack traces (increases build time)
-    widenClientFileUpload: true,${
-      reactComponentAnnotation
-        ? `\n
-    // Automatically annotate React components to show their full name in breadcrumbs and session replay
-    reactComponentAnnotation: {
-      enabled: true,
-    },`
-        : ''
-    }
-
-    // ${
-      tunnelRoute ? 'Route' : 'Uncomment to route'
-    } browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
-    // This can increase your server load as well as your hosting bill.
-    // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
-    // side errors will fail.
-    ${tunnelRoute ? '' : '// '}tunnelRoute: "/monitoring",
-
-    // Automatically tree-shake Sentry logger statements to reduce bundle size
-    disableLogger: true,
-
-    // Enables automatic instrumentation of Vercel Cron Monitors. (Does not yet work with App Router route handlers.)
-    // See the following for more information:
-    // https://docs.sentry.io/product/crons/
-    // https://vercel.com/docs/cron-jobs
-    automaticVercelMonitors: true,
-  }`;
-}
-
-export function getNextjsConfigCjsTemplate(
-  withSentryConfigOptionsTemplate: string,
-): string {
-  return `const { withSentryConfig } = require("@sentry/nextjs");
-
-/** @type {import('next').NextConfig} */
-const nextConfig = {};
-
-module.exports = withSentryConfig(
-  nextConfig,
-  ${withSentryConfigOptionsTemplate}
-);
-`;
-}
-
-export function getNextjsConfigMjsTemplate(
-  withSentryConfigOptionsTemplate: string,
-): string {
-  return `import { withSentryConfig } from "@sentry/nextjs";
-
-/** @type {import('next').NextConfig} */
-const nextConfig = {};
-
-export default withSentryConfig(
-  nextConfig,
-  ${withSentryConfigOptionsTemplate}
-);
-`;
-}
-
-export function getNextjsConfigCjsAppendix(
-  withSentryConfigOptionsTemplate: string,
-): string {
-  return `
-
-// Injected content via Sentry wizard below
-
-const { withSentryConfig } = require("@sentry/nextjs");
-
-module.exports = withSentryConfig(
-  module.exports,
-  ${withSentryConfigOptionsTemplate}
-);
-`;
-}
-
-export function getNextjsConfigEsmCopyPasteSnippet(
-  withSentryConfigOptionsTemplate: string,
-): string {
-  return `
-
-// next.config.mjs
-import { withSentryConfig } from "@sentry/nextjs";
-
-export default withSentryConfig(
-  yourNextConfig,
-  ${withSentryConfigOptionsTemplate}
-);
-`;
-}
-
-function getClientIntegrationsSnippet(features: { replay: boolean }) {
-  if (features.replay) {
-    return `
-
-  // Add optional integrations for additional features
-  integrations: [
-    Sentry.replayIntegration(),
-  ],`;
-  }
-
-  return '';
-}
-
-export function getSentryConfigContents(
-  dsn: string,
-  config: 'server' | 'client' | 'edge',
-  selectedFeaturesMap: {
-    replay: boolean;
-    performance: boolean;
-  },
-): string {
-  let primer;
-  if (config === 'server') {
-    primer = `// This file configures the initialization of Sentry on the server.
-// The config you add here will be used whenever the server handles a request.
-// https://docs.sentry.io/platforms/javascript/guides/nextjs/`;
-  } else if (config === 'client') {
-    primer = `// This file configures the initialization of Sentry on the client.
-// The config you add here will be used whenever a users loads a page in their browser.
-// 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).
-// The config you add here will be used whenever one of the edge features is loaded.
-// Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally.
-// https://docs.sentry.io/platforms/javascript/guides/nextjs/`;
-  }
-
-  const integrationsOptions = getClientIntegrationsSnippet({
-    replay: config === 'client' && selectedFeaturesMap.replay,
-  });
-
-  let replayOptions = '';
-  if (config === 'client') {
-    if (selectedFeaturesMap.replay) {
-      replayOptions += `
-
-  // Define how likely Replay events are sampled.
-  // This sets the sample rate to be 10%. You may want this to be 100% while
-  // in development and sample at a lower rate in production
-  replaysSessionSampleRate: 0.1,
-
-  // Define how likely Replay events are sampled when an error occurs.
-  replaysOnErrorSampleRate: 1.0,`;
-    }
-  }
-
-  let performanceOptions = '';
-  if (selectedFeaturesMap.performance) {
-    performanceOptions += `
-
-  // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
-  tracesSampleRate: 1,`;
-  }
-
-  // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-  return `${primer}
-
-import * as Sentry from "@sentry/nextjs";
-
-Sentry.init({
-  dsn: "${dsn}",${integrationsOptions}${performanceOptions}${replayOptions}
-
-  // Setting this option to true will print useful information to the console while you're setting up Sentry.
-  debug: false,
-});
-`;
-}
-
-export function getSentryExamplePageContents(options: {
-  selfHosted: boolean;
-  sentryUrl: string;
-  orgSlug: string;
-  projectId: string;
-  useClient: boolean;
-}): string {
-  const issuesPageLink = options.selfHosted
-    ? `${options.sentryUrl}organizations/${options.orgSlug}/issues/?project=${options.projectId}`
-    : `https://${options.orgSlug}.sentry.io/issues/?project=${options.projectId}`;
-
-  return `${
-    options.useClient ? '"use client";\n\n' : ''
-  }import Head from "next/head";
-import * as Sentry from "@sentry/nextjs";
-
-export default function Page() {
-  return (
-    <div>
-      <Head>
-        <title>Sentry Onboarding</title>
-        <meta name="description" content="Test Sentry for your Next.js app!" />
-      </Head>
-
-      <main
-        style={{
-          minHeight: "100vh",
-          display: "flex",
-          flexDirection: "column",
-          justifyContent: "center",
-          alignItems: "center",
-        }}
-      >
-        <h1 style={{ fontSize: "4rem", margin: "14px 0" }}>
-          <svg
-            style={{
-              height: "1em",
-            }}
-            xmlns="http://www.w3.org/2000/svg"
-            viewBox="0 0 200 44"
-          >
-            <path
-              fill="currentColor"
-              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"
-            ></path>
-          </svg>
-        </h1>
-
-        <p>Get started by sending us a sample error:</p>
-        <button
-          type="button"
-          style={{
-            padding: "12px",
-            cursor: "pointer",
-            backgroundColor: "#AD6CAA",
-            borderRadius: "4px",
-            border: "none",
-            color: "white",
-            fontSize: "14px",
-            margin: "18px",
-          }}
-          onClick={async () => {
-            await Sentry.startSpan({
-              name: 'Example Frontend Span',
-              op: 'test'
-            }, async () => {
-              const res = await fetch("/api/sentry-example-api");
-              if (!res.ok) {
-                throw new Error("Sentry Example Frontend Error");
-              }
-            });
-          }}
-        >
-          Throw error!
-        </button>
-
-        <p>
-          Next, look for the error on the{" "}
-          <a href="${issuesPageLink}">Issues Page</a>.
-        </p>
-        <p style={{ marginTop: "24px" }}>
-          For more information, see{" "}
-          <a href="https://docs.sentry.io/platforms/javascript/guides/nextjs/">
-            https://docs.sentry.io/platforms/javascript/guides/nextjs/
-          </a>
-        </p>
-      </main>
-    </div>
-  );
-}
-`;
-}
-
-export function getSentryExamplePagesDirApiRoute() {
-  return `// A faulty API route to test Sentry's error monitoring
-export default function handler(_req, res) {
-  throw new Error("Sentry Example API Route Error");
-  res.status(200).json({ name: "John Doe" });
-}
-`;
-}
-
-export function getSentryExampleAppDirApiRoute() {
-  return `import { NextResponse } from "next/server";
-
-export const dynamic = "force-dynamic";
-
-// A faulty API route to test Sentry's error monitoring
-export function GET() {
-  throw new Error("Sentry Example API Route Error");
-  return NextResponse.json({ data: "Testing Sentry Error..." });
-}
-`;
-}
-
-export function getSentryDefaultUnderscoreErrorPage() {
-  return `import * as Sentry from "@sentry/nextjs";
-import Error from "next/error";
-
-const CustomErrorComponent = (props) => {
-  return <Error statusCode={props.statusCode} />;
-};
-
-CustomErrorComponent.getInitialProps = async (contextData) => {
-  // In case this is running in a serverless function, await this in order to give Sentry
-  // time to send the error before the lambda exits
-  await Sentry.captureUnderscoreErrorException(contextData);
-
-  // This will contain the status code of the response
-  return Error.getInitialProps(contextData);
-};
-
-export default CustomErrorComponent;
-`;
-}
-
-export function getSimpleUnderscoreErrorCopyPasteSnippet() {
-  return `
-${chalk.green(`import * as Sentry from '@sentry/nextjs';`)}
-${chalk.green(`import Error from "next/error";`)}
-
-${chalk.dim(
-  '// Replace "YourCustomErrorComponent" with your custom error component!',
-)}
-YourCustomErrorComponent.getInitialProps = async (${chalk.green(
-    'contextData',
-  )}) => {
-  ${chalk.green('await Sentry.captureUnderscoreErrorException(contextData);')}
-
-  ${chalk.dim('// ...other getInitialProps code')}
-
-  return Error.getInitialProps(contextData);
-};
-`;
-}
-
-export function getFullUnderscoreErrorCopyPasteSnippet(isTs: boolean) {
-  return `
-import * as Sentry from '@sentry/nextjs';${
-    isTs ? '\nimport type { NextPageContext } from "next";' : ''
-  }
-import Error from "next/error";
-
-${chalk.dim(
-  '// Replace "YourCustomErrorComponent" with your custom error component!',
-)}
-YourCustomErrorComponent.getInitialProps = async (contextData${
-    isTs ? ': NextPageContext' : ''
-  }) => {
-  await Sentry.captureUnderscoreErrorException(contextData);
-
-  return Error.getInitialProps(contextData);
-};
-`;
-}
-
-export function getInstrumentationHookContent(
-  instrumentationHookLocation: 'src' | 'root',
-) {
-  return `import * as Sentry from '@sentry/nextjs';
-
-export async function register() {
-  if (process.env.NEXT_RUNTIME === 'nodejs') {
-    await import('${
-      instrumentationHookLocation === 'root' ? '.' : '..'
-    }/sentry.server.config');
-  }
-
-  if (process.env.NEXT_RUNTIME === 'edge') {
-    await import('${
-      instrumentationHookLocation === 'root' ? '.' : '..'
-    }/sentry.edge.config');
-  }
-}
-
-export const onRequestError = Sentry.captureRequestError;
-`;
-}
-
-export function getInstrumentationHookCopyPasteSnippet(
-  instrumentationHookLocation: 'src' | 'root',
-) {
-  return makeCodeSnippet(true, (unchanged, plus) => {
-    return unchanged(`${plus("import * as Sentry from '@sentry/nextjs';")}
-
-export ${plus('async')} function register() {
-  ${plus(`if (process.env.NEXT_RUNTIME === 'nodejs') {
-    await import('${
-      instrumentationHookLocation === 'root' ? '.' : '..'
-    }/sentry.server.config');
-  }
-
-  if (process.env.NEXT_RUNTIME === 'edge') {
-    await import('${
-      instrumentationHookLocation === 'root' ? '.' : '..'
-    }/sentry.edge.config');
-  }`)}
-}
-
-${plus('export const onRequestError = Sentry.captureRequestError;')}
-`);
-  });
-}
-
-export function getSentryDefaultGlobalErrorPage(isTs: boolean) {
-  return isTs
-    ? `"use client";
-
-import * as Sentry from "@sentry/nextjs";
-import NextError from "next/error";
-import { useEffect } from "react";
-
-export default function GlobalError({ error }: { error: Error & { digest?: string } }) {
-  useEffect(() => {
-    Sentry.captureException(error);
-  }, [error]);
-
-  return (
-    <html>
-      <body>
-        {/* \`NextError\` is the default Next.js error page component. Its type
-        definition requires a \`statusCode\` prop. However, since the App Router
-        does not expose status codes for errors, we simply pass 0 to render a
-        generic error message. */}
-        <NextError statusCode={0} />
-      </body>
-    </html>
-  );
-}`
-    : `"use client";
-
-import * as Sentry from "@sentry/nextjs";
-import NextError from "next/error";
-import { useEffect } from "react";
-
-export default function GlobalError({ error }) {
-  useEffect(() => {
-    Sentry.captureException(error);
-  }, [error]);
-
-  return (
-    <html>
-      <body>
-        {/* \`NextError\` is the default Next.js error page component. Its type
-        definition requires a \`statusCode\` prop. However, since the App Router
-        does not expose status codes for errors, we simply pass 0 to render a
-        generic error message. */}
-        <NextError statusCode={0} />
-      </body>
-    </html>
-  );
-}
-`;
-}
-
-export function getGlobalErrorCopyPasteSnippet(isTs: boolean) {
-  if (isTs) {
-    return `"use client";
-
-${chalk.green('import * as Sentry from "@sentry/nextjs";')}
-${chalk.green('import Error from "next/error";')}
-${chalk.green('import { useEffect } from "react";')}
-
-export default function GlobalError(${chalk.green(
-      '{ error }: { error: Error }',
-    )}) {
-  ${chalk.green(`useEffect(() => {
-    Sentry.captureException(error);
-  }, [error]);`)}
-
-  return (
-    <html>
-      <body>
-        {/* Your Error component here... */}
-      </body>
-    </html>
-  );
-}
-`;
-  }
-  return `"use client";
-
-${chalk.green('import * as Sentry from "@sentry/nextjs";')}
-${chalk.green('import Error from "next/error";')}
-${chalk.green('import { useEffect } from "react";')}
-
-export default function GlobalError(${chalk.green('{ error }')}) {
-  ${chalk.green(`useEffect(() => {
-    Sentry.captureException(error);
-  }, [error]);`)}
-
-  return (
-    <html>
-      <body>
-        {/* Your Error component here... */}
-      </body>
-    </html>
-  );
-}
-`;
-}

package/src/nextjs/utils.ts

@@ -1,21 +0,0 @@
-import { major, minVersion } from 'semver';
-
-export function getNextJsVersionBucket(version: string | undefined) {
-  if (!version) {
-    return 'none';
-  }
-
-  try {
-    const minVer = minVersion(version);
-    if (!minVer) {
-      return 'invalid';
-    }
-    const majorVersion = major(minVer);
-    if (majorVersion >= 11) {
-      return `${majorVersion}.x`;
-    }
-    return '<11.0.0';
-  } catch {
-    return 'unknown';
-  }
-}