@sentry/wizard 4.0.0 → 4.0.1

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

@@ -1,277 +0,0 @@
-/* eslint-disable jest/expect-expect */
-import * as path from 'node:path';
-import { Integration } from '../../lib/Constants';
-import {
-  KEYS,
-  TEST_ARGS,
-  checkEnvBuildPlugin,
-  checkFileContents,
-  checkFileExists,
-  checkIfBuilds,
-  checkIfRunsOnDevMode,
-  checkIfRunsOnProdMode,
-  checkPackageJson,
-  cleanupGit,
-  createFile,
-  modifyFile,
-  revertLocalChanges,
-  startWizardInstance,
-} from '../utils';
-
-const SERVER_TEMPLATE = `import { createRequestHandler } from '@remix-run/express';
-import { installGlobals } from '@remix-run/node';
-import compression from 'compression';
-import express from 'express';
-import morgan from 'morgan';
-
-installGlobals();
-
-const viteDevServer =
-  process.env.NODE_ENV === 'production'
-    ? undefined
-    : await import('vite').then(vite =>
-        vite.createServer({
-          server: { middlewareMode: true },
-        }),
-      );
-
-const app = express();
-
-app.use(compression());
-app.disable('x-powered-by');
-
-if (viteDevServer) {
-  app.use(viteDevServer.middlewares);
-} else {
-  app.use('/assets', express.static('build/client/assets', { immutable: true, maxAge: '1y' }));
-}
-
-app.use(express.static('build/client', { maxAge: '1h' }));
-app.use(morgan('tiny'));
-
-app.all(
-  '*',
-  createRequestHandler({
-    build: viteDevServer
-      ? () => viteDevServer.ssrLoadModule('virtual:remix/server-build')
-      : await import('./build/server/index.js'),
-  }),
-);
-
-app.listen(0, () => console.log('Express server listening'));
-`;
-
-async function runWizardOnRemixProject(
-  projectDir: string,
-  integration: Integration,
-  fileModificationFn?: (
-    projectDir: string,
-    integration: Integration,
-  ) => unknown,
-) {
-  const wizardInstance = startWizardInstance(integration, projectDir);
-  let packageManagerPrompted = false;
-
-  if (fileModificationFn) {
-    fileModificationFn(projectDir, integration);
-
-    await wizardInstance.waitForOutput('Do you want to continue anyway?');
-
-    packageManagerPrompted = await wizardInstance.sendStdinAndWaitForOutput(
-      [KEYS.ENTER],
-      'Please select your package manager.',
-    );
-  } else {
-    packageManagerPrompted = await wizardInstance.waitForOutput(
-      'Please select your package manager.',
-    );
-  }
-
-  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],
-    'Sentry has been successfully configured for your Remix project',
-  );
-
-  wizardInstance.kill();
-}
-
-function checkRemixProject(
-  projectDir: string,
-  integration: Integration,
-  options?: {
-    devModeExpectedOutput?: string;
-    prodModeExpectedOutput?: string;
-  },
-) {
-  test('package.json is updated correctly', () => {
-    checkPackageJson(projectDir, integration);
-  });
-
-  test('.env-sentry-build-plugin is created and contains the auth token', () => {
-    checkEnvBuildPlugin(projectDir);
-  });
-
-  test('example page exists', () => {
-    checkFileExists(`${projectDir}/app/routes/sentry-example-page.tsx`);
-  });
-
-  test('instrumentation.server file exists', () => {
-    checkFileExists(`${projectDir}/instrumentation.server.mjs`);
-  });
-
-  test('entry.client file contains Sentry initialization', () => {
-    checkFileContents(`${projectDir}/app/entry.client.tsx`, [
-      'import * as Sentry from "@sentry/remix";',
-      `Sentry.init({
-    dsn: "${TEST_ARGS.PROJECT_DSN}",
-    tracesSampleRate: 1,
-
-    integrations: [Sentry.browserTracingIntegration({
-      useEffect,
-      useLocation,
-      useMatches
-    }), Sentry.replayIntegration({
-        maskAllText: true,
-        blockAllMedia: true
-    })],
-
-    replaysSessionSampleRate: 0.1,
-    replaysOnErrorSampleRate: 1
-})`,
-    ]);
-  });
-
-  test('entry.server file contains Sentry code', () => {
-    checkFileContents(`${projectDir}/app/entry.server.tsx`, [
-      'import * as Sentry from "@sentry/remix";',
-      `export const handleError = Sentry.wrapHandleErrorWithSentry((error, { request }) => {
-  // Custom handleError implementation
-});`,
-    ]);
-  });
-
-  test('instrumentation.server file contains Sentry initialization', () => {
-    checkFileContents(`${projectDir}/instrumentation.server.mjs`, [
-      'import * as Sentry from "@sentry/remix";',
-      `Sentry.init({
-    dsn: "${TEST_ARGS.PROJECT_DSN}",
-    tracesSampleRate: 1
-})`,
-    ]);
-  });
-
-  test('root file contains Sentry ErrorBoundary', () => {
-    checkFileContents(`${projectDir}/app/root.tsx`, [
-      'import { captureRemixErrorBoundaryError } from "@sentry/remix";',
-      `export const ErrorBoundary = () => {
-  const error = useRouteError();
-  captureRemixErrorBoundaryError(error);
-  return <div>Something went wrong</div>;
-};`,
-    ]);
-  });
-
-  test('builds successfully', async () => {
-    await checkIfBuilds(projectDir);
-  });
-
-  test('runs on dev mode correctly', async () => {
-    await checkIfRunsOnDevMode(
-      projectDir,
-      options?.devModeExpectedOutput || 'to expose',
-    );
-  });
-
-  test('runs on prod mode correctly', async () => {
-    await checkIfRunsOnProdMode(
-      projectDir,
-      options?.prodModeExpectedOutput || '[remix-serve]',
-    );
-  });
-}
-
-describe('Remix', () => {
-  describe('with empty project', () => {
-    const integration = Integration.remix;
-    const projectDir = path.resolve(
-      __dirname,
-      '../test-applications/remix-test-app',
-    );
-
-    beforeAll(async () => {
-      await runWizardOnRemixProject(projectDir, integration);
-    });
-
-    afterAll(() => {
-      revertLocalChanges(projectDir);
-      cleanupGit(projectDir);
-    });
-
-    checkRemixProject(projectDir, integration);
-  });
-
-  describe('with existing custom Express server', () => {
-    const integration = Integration.remix;
-    const projectDir = path.resolve(
-      __dirname,
-      '../test-applications/remix-test-app',
-    );
-
-    beforeAll(async () => {
-      await runWizardOnRemixProject(projectDir, integration, (projectDir) => {
-        createFile(`${projectDir}/server.mjs`, SERVER_TEMPLATE);
-
-        modifyFile(`${projectDir}/package.json`, {
-          '"start": "remix-serve ./build/server/index.js"':
-            '"start": "node ./server.mjs"',
-          '"dev": "remix vite:dev"': '"dev": "node ./server.mjs"',
-        });
-      });
-    });
-
-    afterAll(() => {
-      revertLocalChanges(projectDir);
-      cleanupGit(projectDir);
-    });
-
-    checkRemixProject(projectDir, integration, {
-      devModeExpectedOutput: 'Express server listening',
-      prodModeExpectedOutput: 'Express server listening',
-    });
-
-    test('server.mjs contains instrumentation file import', () => {
-      checkFileContents(`${projectDir}/server.mjs`, [
-        "import './instrumentation.server.mjs';",
-      ]);
-    });
-  });
-});

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

@@ -1,284 +0,0 @@
-/* eslint-disable jest/expect-expect */
-import * as path from 'node:path';
-import { Integration } from '../../lib/Constants';
-import {
-  KEYS,
-  TEST_ARGS,
-  checkEnvBuildPlugin,
-  checkFileContents,
-  checkFileExists,
-  checkIfBuilds,
-  checkIfRunsOnDevMode,
-  checkIfRunsOnProdMode,
-  checkPackageJson,
-  cleanupGit,
-  createFile,
-  revertLocalChanges,
-  startWizardInstance,
-} from '../utils';
-
-const SERVER_HOOK_TEMPLATE = `import type { Handle } from '@sveltejs/kit';
-
-export const handle: Handle = async ({ event, resolve }) => {
-	if (event.url.pathname.startsWith('/custom')) {
-		return new Response('custom response');
-	}
-
-	const response = await resolve(event);
-	return response;
-};
-`;
-const CLIENT_HOOK_TEMPLATE = `
-export async function handleError({ error, event }) {
-  // you can capture the \`error\` and \`event\` from the client
-  // but it only runs if the unexpected error comes from \`+ page.ts\`
-  console.log(error)
-
-  return {
-    // don't show sensitive data to the user
-    message: 'Yikes! 💩',
-  }
-}
-`;
-
-async function runWizardOnSvelteKitProject(
-  projectDir: string,
-  integration: Integration,
-  fileModificationFn?: (
-    projectDir: string,
-    integration: Integration,
-  ) => unknown,
-) {
-  const wizardInstance = startWizardInstance(integration, projectDir);
-  let packageManagerPrompted = false;
-
-  if (fileModificationFn) {
-    fileModificationFn(projectDir, integration);
-
-    // As we modified project, we have a warning prompt before we get the package manager prompt
-    await wizardInstance.waitForOutput('Do you want to continue anyway?');
-
-    packageManagerPrompted = await wizardInstance.sendStdinAndWaitForOutput(
-      [KEYS.ENTER],
-      'Please select your package manager.',
-    );
-  } else {
-    packageManagerPrompted = await wizardInstance.waitForOutput(
-      'Please select your package manager',
-    );
-  }
-
-  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();
-}
-
-function checkSvelteKitProject(
-  projectDir: string,
-  integration: Integration,
-  options?: {
-    devModeExpectedOutput: string;
-    prodModeExpectedOutput: string;
-  },
-) {
-  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('builds successfully', async () => {
-    await checkIfBuilds(projectDir);
-  });
-
-  test('runs on dev mode correctly', async () => {
-    await checkIfRunsOnDevMode(
-      projectDir,
-      options?.devModeExpectedOutput || 'ready in',
-    );
-  });
-
-  test('runs on prod mode correctly', async () => {
-    await checkIfRunsOnProdMode(
-      projectDir,
-      options?.prodModeExpectedOutput || 'to expose',
-      'preview',
-    );
-  });
-}
-
-describe('Sveltekit', () => {
-  describe('without existing hooks', () => {
-    const integration = Integration.sveltekit;
-    const projectDir = path.resolve(
-      __dirname,
-      '../test-applications/sveltekit-test-app',
-    );
-
-    beforeAll(async () => {
-      await runWizardOnSvelteKitProject(projectDir, integration);
-    });
-
-    afterAll(() => {
-      revertLocalChanges(projectDir);
-      cleanupGit(projectDir);
-    });
-
-    checkSvelteKitProject(projectDir, integration);
-
-    test('hooks.client.ts contains sentry', () => {
-      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()],
-});`,
-        'export const handleError = handleErrorWithSentry(',
-      ]);
-    });
-
-    test('hooks.server.ts contains sentry', () => {
-      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,
-});`,
-        'export const handleError = handleErrorWithSentry();',
-      ]);
-    });
-  });
-
-  describe('with existing hooks', () => {
-    const integration = Integration.sveltekit;
-    const projectDir = path.resolve(
-      __dirname,
-      '../test-applications/sveltekit-test-app',
-    );
-
-    beforeAll(async () => {
-      await runWizardOnSvelteKitProject(
-        projectDir,
-        integration,
-        (projectDir) => {
-          createFile(
-            path.resolve(projectDir, 'src/hooks.server.ts'),
-            SERVER_HOOK_TEMPLATE,
-          );
-
-          createFile(
-            path.resolve(projectDir, 'src/hooks.client.ts'),
-            CLIENT_HOOK_TEMPLATE,
-          );
-        },
-      );
-    });
-
-    afterAll(() => {
-      revertLocalChanges(projectDir);
-      cleanupGit(projectDir);
-    });
-
-    checkSvelteKitProject(projectDir, integration);
-
-    // These are removed from the common tests as the content is different
-    // when the hooks are merged instead of created from the template
-    test('hooks.client.ts contains sentry instrumentation', () => {
-      checkFileContents(path.resolve(projectDir, 'src/hooks.client.ts'), [
-        `import * as Sentry from '@sentry/sveltekit';`,
-        `Sentry.init({
-    dsn: "${TEST_ARGS.PROJECT_DSN}",
-    tracesSampleRate: 1,
-    replaysSessionSampleRate: 0.1,
-    replaysOnErrorSampleRate: 1,
-    integrations: [Sentry.replayIntegration()]
-})`,
-        'export const handleError = Sentry.handleErrorWithSentry(',
-      ]);
-    });
-
-    test('hooks.server.ts contains sentry init', () => {
-      checkFileContents(path.resolve(projectDir, 'src/hooks.server.ts'), [
-        `import * as Sentry from '@sentry/sveltekit';`,
-        `Sentry.init({
-    dsn: "${TEST_ARGS.PROJECT_DSN}",
-    tracesSampleRate: 1
-})`,
-        'export const handleError = Sentry.handleErrorWithSentry();',
-      ]);
-    });
-  });
-});