@sentry/wizard 4.0.0 → 4.0.1

package/src/sveltekit/sveltekit-wizard.ts

@@ -1,192 +0,0 @@
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-import chalk from 'chalk';
-
-import * as Sentry from '@sentry/node';
-
-import {
-  abort,
-  abortIfCancelled,
-  addDotEnvSentryBuildPluginFile,
-  askShouldCreateExamplePage,
-  confirmContinueIfNoOrDirtyGitRepo,
-  ensurePackageIsInstalled,
-  getOrAskForProjectData,
-  getPackageDotJson,
-  installPackage,
-  printWelcome,
-  runPrettierIfInstalled,
-} from '../utils/clack-utils';
-import { getPackageVersion, hasPackageInstalled } from '../utils/package-json';
-import type { WizardOptions } from '../utils/types';
-import { createExamplePage } from './sdk-example';
-import { createOrMergeSvelteKitFiles, loadSvelteConfig } from './sdk-setup';
-import { traceStep, withTelemetry } from '../telemetry';
-import { getKitVersionBucket, getSvelteVersionBucket } from './utils';
-import { NPM, detectPackageManger } from '../utils/package-manager';
-
-export async function runSvelteKitWizard(
-  options: WizardOptions,
-): Promise<void> {
-  return withTelemetry(
-    {
-      enabled: options.telemetryEnabled,
-      integration: 'sveltekit',
-      wizardOptions: options,
-    },
-    () => runSvelteKitWizardWithTelemetry(options),
-  );
-}
-
-export async function runSvelteKitWizardWithTelemetry(
-  options: WizardOptions,
-): Promise<void> {
-  const { promoCode, telemetryEnabled, forceInstall } = options;
-
-  printWelcome({
-    wizardName: 'Sentry SvelteKit Wizard',
-    promoCode,
-    telemetryEnabled,
-  });
-
-  await confirmContinueIfNoOrDirtyGitRepo();
-
-  const packageJson = await getPackageDotJson();
-
-  await ensurePackageIsInstalled(packageJson, '@sveltejs/kit', 'Sveltekit');
-
-  const kitVersion = getPackageVersion('@sveltejs/kit', packageJson);
-  const kitVersionBucket = getKitVersionBucket(kitVersion);
-  Sentry.setTag('sveltekit-version', kitVersionBucket);
-
-  if (kitVersionBucket === '0.x') {
-    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.",
-    );
-    const shouldContinue = await 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 },
-        ],
-      }),
-    );
-    if (!shouldContinue) {
-      await abort('Exiting Wizard', 0);
-      return;
-    }
-  }
-
-  Sentry.setTag(
-    'svelte-version',
-    getSvelteVersionBucket(getPackageVersion('svelte', packageJson)),
-  );
-
-  const { selectedProject, selfHosted, sentryUrl, authToken } =
-    await getOrAskForProjectData(options, 'javascript-sveltekit');
-
-  const sdkAlreadyInstalled = hasPackageInstalled(
-    '@sentry/sveltekit',
-    packageJson,
-  );
-  Sentry.setTag('sdk-already-installed', sdkAlreadyInstalled);
-
-  await installPackage({
-    packageName: '@sentry/sveltekit@^9',
-    packageNameDisplayLabel: '@sentry/sveltekit',
-    alreadyInstalled: sdkAlreadyInstalled,
-    forceInstall,
-  });
-
-  await addDotEnvSentryBuildPluginFile(authToken);
-
-  const svelteConfig = await traceStep('load-svelte-config', loadSvelteConfig);
-
-  try {
-    await traceStep('configure-sdk', () =>
-      createOrMergeSvelteKitFiles(
-        {
-          dsn: selectedProject.keys[0].dsn.public,
-          org: selectedProject.organization.slug,
-          project: selectedProject.slug,
-          selfHosted,
-          url: sentryUrl,
-        },
-        svelteConfig,
-      ),
-    );
-  } catch (e: unknown) {
-    clack.log.error('Error while setting up the SvelteKit SDK:');
-    clack.log.info(
-      chalk.dim(
-        typeof e === 'object' && e != null && 'toString' in e
-          ? e.toString()
-          : typeof e === 'string'
-          ? e
-          : 'Unknown error',
-      ),
-    );
-    Sentry.captureException('Error while setting up the SvelteKit SDK');
-    await abort('Exiting Wizard');
-    return;
-  }
-
-  const shouldCreateExamplePage = await askShouldCreateExamplePage(
-    '/sentry-example',
-  );
-
-  if (shouldCreateExamplePage) {
-    try {
-      await traceStep('create-example-page', () =>
-        createExamplePage(svelteConfig, {
-          selfHosted,
-          url: sentryUrl,
-          orgSlug: selectedProject.organization.slug,
-          projectId: selectedProject.id,
-        }),
-      );
-    } catch (e: unknown) {
-      clack.log.error('Error while creating an example page to test Sentry:');
-      clack.log.info(
-        chalk.dim(
-          typeof e === 'object' && e != null && 'toString' in e
-            ? e.toString()
-            : typeof e === 'string'
-            ? e
-            : 'Unknown error',
-        ),
-      );
-      Sentry.captureException(
-        'Error while creating an example Svelte page to test Sentry',
-      );
-      await abort('Exiting Wizard');
-      return;
-    }
-  }
-
-  await runPrettierIfInstalled();
-
-  clack.outro(buildOutroMessage(shouldCreateExamplePage));
-}
-
-function buildOutroMessage(shouldCreateExamplePage: boolean): string {
-  const packageManager = detectPackageManger() || NPM;
-
-  let msg = chalk.green('\nSuccessfully installed the Sentry SvelteKit SDK!');
-
-  if (shouldCreateExamplePage) {
-    msg += `\n\nYou can validate your setup by starting your dev environment (${chalk.cyan(
-      `\`${packageManager.runScriptCommand} dev\``,
-    )}) and visiting ${chalk.cyan('"/sentry-example"')}.`;
-  }
-
-  msg += `\n\nCheck out the SDK documentation for further configuration:
-https://docs.sentry.io/platforms/javascript/guides/sveltekit/`;
-
-  return msg;
-}

package/src/sveltekit/templates.ts

@@ -1,185 +0,0 @@
-export function getClientHooksTemplate(
-  dsn: string,
-  selectedFeatures: {
-    performance: boolean;
-    replay: boolean;
-  },
-) {
-  return `import { handleErrorWithSentry, replayIntegration } from "@sentry/sveltekit";
-import * as Sentry from '@sentry/sveltekit';
-
-Sentry.init({
-  dsn: '${dsn}',
-${
-  selectedFeatures.performance
-    ? `
-  tracesSampleRate: 1.0,
-`
-    : ''
-}
-${
-  selectedFeatures.replay
-    ? `  // 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,
-
-  // If the entire session is not sampled, use the below sample rate to sample
-  // sessions when an error occurs.
-  replaysOnErrorSampleRate: 1.0,
-
-  // If you don't want to use Session Replay, just remove the line below:
-  integrations: [replayIntegration()],`
-    : ''
-}
-});
-
-// If you have a custom error handler, pass it to \`handleErrorWithSentry\`
-export const handleError = handleErrorWithSentry();
-`;
-}
-
-export function getServerHooksTemplate(
-  dsn: string,
-  selectedFeatures: {
-    performance: boolean;
-    replay: boolean;
-  },
-) {
-  return `import { sequence } from "@sveltejs/kit/hooks";
-import { handleErrorWithSentry, sentryHandle } from "@sentry/sveltekit";
-import * as Sentry from '@sentry/sveltekit';
-
-Sentry.init({
-  dsn: '${dsn}',
-${
-  selectedFeatures.performance
-    ? `
-  tracesSampleRate: 1.0,
-`
-    : ''
-}
-  // uncomment the line below to enable Spotlight (https://spotlightjs.com)
-  // spotlight: import.meta.env.DEV,
-});
-
-// If you have custom handlers, make sure to place them after \`sentryHandle()\` in the \`sequence\` function.
-export const handle = sequence(sentryHandle());
-
-// If you have a custom error handler, pass it to \`handleErrorWithSentry\`
-export const handleError = handleErrorWithSentry();
-`;
-}
-
-/**
- * +page.svelte with Sentry example
- */
-export function getSentryExampleSveltePage(options: {
-  selfHosted: boolean;
-  url: string;
-  orgSlug: string;
-  projectId: string;
-}) {
-  const issuesPageLink = options.selfHosted
-    ? `${options.url}organizations/${options.orgSlug}/issues/?project=${options.projectId}`
-    : `https://${options.orgSlug}.sentry.io/issues/?project=${options.projectId}`;
-
-  return `<!--
-This is just a very simple page with a button to throw an example error.
-Feel free to delete this file and the entire sentry route.
--->
-
-<script>
-  import * as Sentry from '@sentry/sveltekit';
-
-  function getSentryData() {
-    Sentry.startSpan(
-      {
-        name: 'Example Frontend Span',
-        op: 'test'
-      },
-      async () => {
-        const res = await fetch('/sentry-example');
-        if (!res.ok) {
-          throw new Error('Sentry Example Frontend Error');
-        }
-      }
-    );
-  }
-</script>
-
-<title>Sentry Onboarding</title>
-
-<div>
-  <main>
-    <svg 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"
-      />
-    </svg>
-    <p>
-      Get Started with this <strong>simple Example:</strong>
-    </p>
-
-    <p>1. Send us a sample error:</p>
-    <button type="button" on:click={getSentryData}> Throw error! </button>
-
-    <p>
-      2. Look for the error on the
-      <a href="${issuesPageLink}">Issues Page</a>.
-    </p>
-    <p style="margin-top: 24px;">
-      For more information, take a look at the
-      <a href="https://docs.sentry.io/platforms/javascript/guides/sveltekit/">
-        Sentry SvelteKit Documentation
-      </a>
-    </p>
-  </main>
-</div>
-
-<style>
-  main {
-    display: flex;
-    flex-direction: column;
-    justify-content: center;
-    align-items: center;
-  }
-
-  svg {
-    font-size: 4rem;
-    margin: 14px 0;
-    height: 1em;
-  }
-
-  button {
-    padding: 12px;
-    cursor: pointer;
-    background-color: rgb(54, 45, 89);
-    border-radius: 4px;
-    border: none;
-    color: white;
-    font-size: 1em;
-    margin: 1em;
-    transition: all 0.25s ease-in-out;
-  }
-  button:hover {
-    background-color: #8c5393;
-    box-shadow: 4px;
-    box-shadow: 0px 0px 15px 2px rgba(140, 83, 147, 0.5);
-  }
-  button:active {
-    background-color: #c73852;
-  }
-</style>
-`;
-}
-
-export function getSentryExampleApiRoute() {
-  return `// This is just a very simple API route that throws an example error.
-// Feel free to delete this file and the entire sentry route.
-
-export const GET = async () => {
-  throw new Error("Sentry Example API Route Error");
-};
-`;
-}

package/src/sveltekit/utils.ts

@@ -1,50 +0,0 @@
-import { lt, minVersion } from 'semver';
-
-export function getKitVersionBucket(
-  version: string | undefined,
-): 'none' | 'invalid' | '0.x' | '>=1.0.0 <1.24.0' | '>=1.24.0' {
-  if (!version) {
-    return 'none';
-  }
-
-  const minVer = minVersion(version);
-  if (!minVer) {
-    return 'invalid';
-  }
-
-  if (lt(minVer, '1.0.0')) {
-    return '0.x';
-  } else if (lt(minVer, '1.24.0')) {
-    return '>=1.0.0 <1.24.0';
-  } else {
-    // This is the version when the client-side invalidation fix was released
-    // https://github.com/sveltejs/kit/releases/tag/%40sveltejs%2Fkit%401.24.0
-    // https://github.com/sveltejs/kit/pull/10576
-    return '>=1.24.0';
-  }
-}
-
-export function getSvelteVersionBucket(
-  version: string | undefined,
-): 'none' | 'invalid' | '<3.0.0' | '3.x' | '4.x' | '>4.x' {
-  if (!version) {
-    return 'none';
-  }
-
-  const minVer = minVersion(version);
-  if (!minVer) {
-    return 'invalid';
-  }
-
-  if (lt(minVer, '3.0.0')) {
-    return '<3.0.0';
-  }
-  if (lt(minVer, '4.0.0')) {
-    return '3.x';
-  }
-  if (lt(minVer, '5.0.0')) {
-    return '4.x';
-  }
-  // Svelte 5 isn't released yet but it's being worked on
-  return '>4.x';
-}

package/src/telemetry.ts

@@ -1,144 +0,0 @@
-import {
-  Hub,
-  Integrations,
-  NodeClient,
-  type Span,
-  defaultStackParser,
-  flush,
-  makeMain,
-  makeNodeTransport,
-  runWithAsyncContext,
-  setTag,
-  startSpan,
-} from '@sentry/node';
-import { readFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
-import type { WizardOptions } from './utils/types';
-
-export async function withTelemetry<F>(
-  options: {
-    enabled: boolean;
-    integration: string;
-    wizardOptions: WizardOptions;
-  },
-  callback: () => F | Promise<F>,
-): Promise<F> {
-  const { sentryHub, sentryClient } = createSentryInstance(
-    options.enabled,
-    options.integration,
-  );
-
-  makeMain(sentryHub);
-
-  const sentrySession = sentryHub.startSession();
-  sentryHub.captureSession();
-
-  // Set tag for passed CLI args
-  sentryHub.setTag('args.project', !!options.wizardOptions.projectSlug);
-  sentryHub.setTag('args.org', !!options.wizardOptions.orgSlug);
-  sentryHub.setTag('args.saas', !!options.wizardOptions.saas);
-
-  try {
-    return await startSpan(
-      {
-        name: 'sentry-wizard-execution',
-        status: 'ok',
-        op: 'wizard.flow',
-      },
-      async () => {
-        updateProgress('start');
-        const res = await runWithAsyncContext(callback);
-        updateProgress('finished');
-
-        return res;
-      },
-    );
-  } catch (e) {
-    sentryHub.captureException('Error during wizard execution.');
-    sentrySession.status = 'crashed';
-    throw e;
-  } finally {
-    sentryHub.endSession();
-    await sentryClient.flush(3000).then(null, () => {
-      // If telemetry flushing fails we generally don't care
-    });
-    await flush(3000).then(null, () => {
-      // If telemetry flushing fails we generally don't care
-    });
-  }
-}
-
-function createSentryInstance(enabled: boolean, integration: string) {
-  let version: string | undefined = process.env.npm_package_version;
-  if (!version) {
-    try {
-      const pathToPackageJson = join(
-        dirname(require.resolve('@sentry/wizard')),
-        '..',
-        'package.json',
-      );
-      const packageJsonData = readFileSync(pathToPackageJson, 'utf-8');
-      const parsedPackageJson = JSON.parse(packageJsonData) as {
-        version?: string;
-      };
-      version = parsedPackageJson.version;
-    } catch {
-      // If we fail to read the package.json file, we don't want to crash the wizard
-      // so we just don't set the version
-    }
-  }
-
-  const client = new NodeClient({
-    dsn: 'https://8871d3ff64814ed8960c96d1fcc98a27@o1.ingest.sentry.io/4505425820712960',
-    enabled: enabled,
-
-    environment: `production-${integration}`,
-
-    tracesSampleRate: 1,
-    sampleRate: 1,
-
-    release: version,
-    integrations: [new Integrations.Http()],
-    tracePropagationTargets: [/^https:\/\/sentry.io\//],
-
-    stackParser: defaultStackParser,
-
-    beforeSendTransaction: (event) => {
-      delete event.server_name; // Server name might contain PII
-      return event;
-    },
-
-    beforeSend: (event) => {
-      event.exception?.values?.forEach((exception) => {
-        delete exception.stacktrace;
-      });
-
-      delete event.server_name; // Server name might contain PII
-      return event;
-    },
-
-    transport: makeNodeTransport,
-
-    debug: true,
-  });
-
-  const hub = new Hub(client);
-
-  hub.setTag('integration', integration);
-  hub.setTag('node', process.version);
-  hub.setTag('platform', process.platform);
-
-  return { sentryHub: hub, sentryClient: client };
-}
-
-export function traceStep<T>(
-  step: string,
-  callback: (span: Span | undefined) => T,
-): T {
-  updateProgress(step);
-  return startSpan({ name: step, op: 'wizard.step' }, (span) => callback(span));
-}
-
-export function updateProgress(step: string) {
-  setTag('progress', step);
-}