@sentry/wizard 3.34.2 → 3.34.3

package/e2e-tests/tests/sveltekit.test.ts

@@ -0,0 +1,154 @@
+/* eslint-disable jest/expect-expect */
+import { Integration } from '../../lib/Constants';
+import {
+  checkEnvBuildPlugin,
+  checkFileContents,
+  checkFileExists,
+  checkIfBuilds,
+  checkIfRunsOnDevMode,
+  checkIfRunsOnProdMode,
+  checkPackageJson,
+  cleanupGit,
+  KEYS,
+  revertLocalChanges,
+  startWizardInstance,
+  TEST_ARGS,
+} from '../utils';
+import * as path from 'path';
+
+describe('Sveltekit', () => {
+  const integration = Integration.sveltekit;
+  const projectDir = path.resolve(
+    __dirname,
+    '../test-applications/sveltekit-test-app',
+  );
+
+  beforeAll(async () => {
+    const wizardInstance = startWizardInstance(integration, projectDir);
+
+    const packageManagerPrompted = await wizardInstance.waitForOutput(
+      'Please select your package manager.',
+      {
+        optional: true,
+      }
+    );
+
+    const tracingOptionPrompted =
+      packageManagerPrompted &&
+      (await wizardInstance.sendStdinAndWaitForOutput(
+        // Selecting `yarn` as the package manager
+        [KEYS.DOWN, KEYS.ENTER],
+        // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold.
+        'to track the performance of your application?',
+        {
+          timeout: 240_000,
+        }
+      ));
+
+    const replayOptionPrompted =
+      tracingOptionPrompted &&
+      (await wizardInstance.sendStdinAndWaitForOutput(
+        [KEYS.ENTER],
+        // "Do you want to enable Sentry Session Replay", sometimes doesn't work as `Sentry Session Replay` can be printed in bold.
+        'to get a video-like reproduction of errors during a user session?',
+      ));
+
+    replayOptionPrompted &&
+      (await wizardInstance.sendStdinAndWaitForOutput(
+        [KEYS.ENTER],
+        'Do you want to create an example page',
+        {
+          optional: true,
+        },
+      ));
+
+    await wizardInstance.sendStdinAndWaitForOutput(
+      [KEYS.ENTER, KEYS.ENTER],
+      'Successfully installed the Sentry SvelteKit SDK!',
+    );
+
+    wizardInstance.kill();
+  });
+
+  afterAll(() => {
+    revertLocalChanges(projectDir);
+    cleanupGit(projectDir);
+  });
+
+  test('should have the correct package.json', () => {
+    checkPackageJson(projectDir, integration);
+  });
+
+  test('should have the correct .env.sentry-build-plugin', () => {
+    checkEnvBuildPlugin(projectDir);
+  });
+
+  test('example page exists', () => {
+    checkFileExists(path.resolve(projectDir, 'src/routes/sentry-example/+page.svelte'));
+    checkFileExists(path.resolve(projectDir, 'src/routes/sentry-example/+server.js'));
+  });
+
+  test('vite.config contains sentry plugin', () => {
+    checkFileContents(path.resolve(projectDir, 'vite.config.ts'), `plugins: [sentrySvelteKit({
+        sourceMapsUploadOptions: {
+`);
+  });
+
+  test('hook files created', () => {
+    checkFileExists(path.resolve(projectDir, 'src/hooks.server.ts'));
+    checkFileExists(path.resolve(projectDir, 'src/hooks.client.ts'));
+  });
+
+  test('hooks.client.ts contains sentry import', () => {
+    checkFileContents(
+      path.resolve(projectDir, 'src/hooks.client.ts'),
+      [`import * as Sentry from '@sentry/sveltekit';`,
+        `Sentry.init({
+  dsn: '${TEST_ARGS.PROJECT_DSN}',
+
+  tracesSampleRate: 1.0,
+
+  // 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()],
+});`]);
+  });
+
+
+  test('hooks.server.ts contains sentry import', () => {
+    checkFileContents(
+      path.resolve(projectDir, 'src/hooks.server.ts'),
+      [
+        `import * as Sentry from '@sentry/sveltekit';`,
+        `Sentry.init({
+  dsn: '${TEST_ARGS.PROJECT_DSN}',
+
+  tracesSampleRate: 1.0,
+
+  // uncomment the line below to enable Spotlight (https://spotlightjs.com)
+  // spotlight: import.meta.env.DEV,
+});`])
+  });
+
+
+  test('runs on dev mode correctly', async () => {
+    await checkIfRunsOnDevMode(projectDir, 'ready in');
+  });
+
+  test('should build successfully', async () => {
+    await checkIfBuilds(projectDir, 'Successfully uploaded source maps to Sentry');
+  });
+
+  test('runs on prod mode correctly', async () => {
+    // We can't use the full prompt `Network: use--host to expose` as `--host` can be printed in bold.
+    await checkIfRunsOnProdMode(projectDir, 'to expose', "preview");
+  });
+});
+

package/e2e-tests/utils/index.ts

@@ -16,8 +16,11 @@ export const KEYS = {
 };
 
 export const TEST_ARGS = {
-  AUTH_TOKEN: 'TEST_AUTH_TOKEN',
-  PROJECT_DSN: 'https://public@dsn.ingest.sentry.io/1337',
+  AUTH_TOKEN: process.env.SENTRY_TEST_AUTH_TOKEN || 'TEST_AUTH_TOKEN',
+  PROJECT_DSN:
+    process.env.SENTRY_TEST_DSN || 'https://public@dsn.ingest.sentry.io/1337',
+  ORG_SLUG: process.env.SENTRY_TEST_ORG || 'TEST_ORG_SLUG',
+  PROJECT_SLUG: process.env.SENTRY_TEST_PROJECT || 'TEST_PROJECT_SLUG',
 };
 
 export const log = {
@@ -55,6 +58,28 @@ export class WizardTestEnv {
     this.taskHandle.stdin.write(input);
   }
 
+  /**
+   * Sends the input and waits for the output.
+   * @returns a promise that resolves when the output was found
+   * @throws an error when the output was not found within the timeout
+   */
+  sendStdinAndWaitForOutput(
+    input: string | string[],
+    output: string,
+    options?: { timeout?: number; optional?: boolean },
+  ) {
+    const outputPromise = this.waitForOutput(output, options);
+
+    if (Array.isArray(input)) {
+      for (const i of input) {
+        this.sendStdin(i);
+      }
+    } else {
+      this.sendStdin(input);
+    }
+    return outputPromise;
+  }
+
   /**
    * Waits for the provided output with `.includes()` logic.
    *
@@ -71,7 +96,7 @@ export class WizardTestEnv {
     } = {},
   ) {
     const { timeout, optional } = {
-      timeout: 30_000,
+      timeout: 60_000,
       optional: false,
       ...options,
     };
@@ -122,7 +147,7 @@ export function initGit(projectDir: string): void {
     execSync('git commit -m init', { cwd: projectDir });
   } catch (e) {
     log.error('Error initializing git');
-    throw e;
+    log.error(e);
   }
 }
 
@@ -139,7 +164,7 @@ export function cleanupGit(projectDir: string): void {
     execSync(`rm -rf ${projectDir}/.git`);
   } catch (e) {
     log.error('Error cleaning up git');
-    throw e;
+    log.error(e);
   }
 }
 
@@ -159,7 +184,7 @@ export function revertLocalChanges(projectDir: string): void {
     execSync('git clean -fd .', { cwd: projectDir });
   } catch (e) {
     log.error('Error reverting local changes');
-    throw e;
+    log.error(e);
   }
 }
 
@@ -173,6 +198,7 @@ export function revertLocalChanges(projectDir: string): void {
 export function startWizardInstance(
   integration: Integration,
   projectDir: string,
+  debug = false,
 ): WizardTestEnv {
   const binPath = path.join(__dirname, '../../dist/bin.js');
 
@@ -191,8 +217,12 @@ export function startWizardInstance(
       TEST_ARGS.AUTH_TOKEN,
       '--preSelectedProject.dsn',
       TEST_ARGS.PROJECT_DSN,
+      '--preSelectedProject.orgSlug',
+      TEST_ARGS.ORG_SLUG,
+      '--preSelectedProject.projectSlug',
+      TEST_ARGS.PROJECT_SLUG,
     ],
-    { cwd: projectDir },
+    { cwd: projectDir, debug },
   );
 }
 
@@ -266,7 +296,11 @@ export async function checkIfBuilds(
     cwd: projectDir,
   });
 
-  await expect(testEnv.waitForOutput(expectedOutput)).resolves.toBe(true);
+  await expect(
+    testEnv.waitForOutput(expectedOutput, {
+      timeout: 120_000,
+    }),
+  ).resolves.toBe(true);
 }
 
 /**
@@ -280,7 +314,11 @@ export async function checkIfRunsOnDevMode(
 ) {
   const testEnv = new WizardTestEnv('npm', ['run', 'dev'], { cwd: projectDir });
 
-  await expect(testEnv.waitForOutput(expectedOutput)).resolves.toBe(true);
+  await expect(
+    testEnv.waitForOutput(expectedOutput, {
+      timeout: 120_000,
+    }),
+  ).resolves.toBe(true);
   testEnv.kill();
 }
 
@@ -292,11 +330,16 @@ export async function checkIfRunsOnDevMode(
 export async function checkIfRunsOnProdMode(
   projectDir: string,
   expectedOutput: string,
+  startCommand = 'start',
 ) {
-  const testEnv = new WizardTestEnv('npm', ['run', 'start'], {
+  const testEnv = new WizardTestEnv('npm', ['run', startCommand], {
     cwd: projectDir,
   });
 
-  await expect(testEnv.waitForOutput(expectedOutput)).resolves.toBe(true);
+  await expect(
+    testEnv.waitForOutput(expectedOutput, {
+      timeout: 120_000,
+    }),
+  ).resolves.toBe(true);
   testEnv.kill();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/wizard",
-  "version": "3.34.2",
+  "version": "3.34.3",
   "homepage": "https://github.com/getsentry/sentry-wizard",
   "repository": "https://github.com/getsentry/sentry-wizard",
   "description": "Sentry wizard helping you to configure your project",
@@ -55,6 +55,7 @@
     "@types/yargs": "^16.0.9",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
+    "dotenv": "^16.4.5",
     "eslint": "^8.18.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-jest": "^25.3.0",
@@ -66,9 +67,6 @@
     "tsx": "^3.14.0",
     "typescript": "^5.0.4"
   },
-  "resolutions": {
-    "**/xmldom": "^0.6.0"
-  },
   "engines": {
     "node": ">=14.18.0",
     "npm": ">=3.10.7",
@@ -87,7 +85,7 @@
     "fix:prettier": "prettier --write \"{lib,src,test}/**/*.ts\"",
     "fix:eslint": "eslint . --format stylish --fix",
     "test": "yarn build && jest",
-    "test:e2e": "yarn build && jest -c=\"./e2e-tests/jest.config.ts\" ./e2e-tests/",
+    "test:e2e": "yarn build && ./e2e-tests/run.sh",
     "try": "ts-node bin.ts",
     "try:uninstall": "ts-node bin.ts --uninstall",
     "test:watch": "jest --watch"

package/src/apple/templates.ts

@@ -2,9 +2,13 @@ export function getRunScriptTemplate(
   orgSlug: string,
   projectSlug: string,
   uploadSource = true,
+  includeHomebrewPath = false,
 ): string {
   // eslint-disable-next-line no-useless-escape
-  return `# This script is responsable to upload debug symbols and source context for Sentry.\\nif which sentry-cli >/dev/null; then\\nexport SENTRY_ORG=${orgSlug}\\nexport SENTRY_PROJECT=${projectSlug}\\nERROR=$(sentry-cli debug-files upload ${
+  const includeHomebrew = includeHomebrewPath
+    ? '\\nif [[ "$(uname -m)" == arm64 ]]; then\\nexport PATH="/opt/homebrew/bin:$PATH"\\nfi'
+    : '';
+  return `# This script is responsable to upload debug symbols and source context for Sentry.${includeHomebrew}\\nif which sentry-cli >/dev/null; then\\nexport SENTRY_ORG=${orgSlug}\\nexport SENTRY_PROJECT=${projectSlug}\\nERROR=$(sentry-cli debug-files upload ${
     uploadSource ? '--include-sources ' : ''
   }"$DWARF_DSYM_FOLDER_PATH" 2>&1 >/dev/null)\\nif [ ! $? -eq 0 ]; then\\necho "warning: sentry-cli - $ERROR"\\nfi\\nelse\\necho "warning: sentry-cli not installed, download from https://github.com/getsentry/sentry-cli/releases"\\nfi\\n`;
 }

package/src/apple/xcode-manager.ts

@@ -164,6 +164,7 @@ function addUploadSymbolsScript(
     }
   }
 
+  const isHomebrewInstalled = fs.existsSync('/opt/homebrew/bin/sentry-cli');
   xcodeProject.addBuildPhase(
     [],
     'PBXShellScriptBuildPhase',
@@ -178,6 +179,7 @@ function addUploadSymbolsScript(
         sentryProject.organization.slug,
         sentryProject.slug,
         uploadSource,
+        isHomebrewInstalled,
       ),
     },
   );

package/src/nextjs/nextjs-wizard.ts

@@ -44,6 +44,7 @@ import {
   getSentryExamplePageContents,
   getSimpleUnderscoreErrorCopyPasteSnippet,
   getWithSentryConfigOptionsTemplate,
+  getNextjsConfigMjsTemplate,
 } from './templates';
 import { traceStep, withTelemetry } from '../telemetry';
 import { getPackageVersion, hasPackageInstalled } from '../utils/package-json';
@@ -196,7 +197,7 @@ export async function runNextjsWizardWithTelemetry(
 
       const shouldContinue = await abortIfCancelled(
         clack.confirm({
-          message: `Did add the code to your ${chalk.cyan(
+          message: `Did you add the code to your ${chalk.cyan(
             path.join(...pagesLocation, underscoreErrorPageFile),
           )} file as described above?`,
           active: 'Yes',
@@ -278,7 +279,7 @@ export async function runNextjsWizardWithTelemetry(
 
       const shouldContinue = await abortIfCancelled(
         clack.confirm({
-          message: `Did add the code to your ${chalk.cyan(
+          message: `Did you add the code to your ${chalk.cyan(
             path.join(...appDirLocation, globalErrorPageFile),
           )} file as described above?`,
           active: 'Yes',
@@ -564,15 +565,39 @@ async function createOrMergeNextJsFiles(
     if (!foundNextConfigFile) {
       Sentry.setTag('next-config-strategy', 'create');
 
+      // Try to figure out whether the user prefers ESM
+      let isTypeModule = false;
+      try {
+        const packageJsonText = await fs.promises.readFile(
+          path.join(process.cwd(), 'package.json'),
+          'utf8',
+        );
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const packageJson = JSON.parse(packageJsonText);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        if (packageJson.type === 'module') {
+          isTypeModule = true;
+        }
+      } catch {
+        // noop
+      }
+
+      // We are creating `next.config.(m)js` files by default as they are supported by the most Next.js versions
+      const configFilename = isTypeModule
+        ? nextConfigPossibleFilesMap.mjs
+        : nextConfigPossibleFilesMap.js;
+      const configContent = isTypeModule
+        ? getNextjsConfigMjsTemplate(withSentryConfigOptionsTemplate)
+        : getNextjsConfigCjsTemplate(withSentryConfigOptionsTemplate);
+
       await fs.promises.writeFile(
-        // We are creating a `next.config.js` file by default as it is supported by the most Next.js versions
-        path.join(process.cwd(), nextConfigPossibleFilesMap.js),
-        getNextjsConfigCjsTemplate(withSentryConfigOptionsTemplate),
+        path.join(process.cwd(), configFilename),
+        configContent,
         { encoding: 'utf8', flag: 'w' },
       );
 
       clack.log.success(
-        `Created ${chalk.cyan('next.config.js')} with Sentry configuration.`,
+        `Created ${chalk.cyan(configFilename)} with Sentry configuration.`,
       );
 
       return;

package/src/nextjs/templates.ts

@@ -81,6 +81,21 @@ module.exports = withSentryConfig(
 `;
 }
 
+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 {