@sentry/wizard 3.26.0 → 3.28.0

package/test/nextjs/templates.test.ts

@@ -1,6 +1,244 @@
-import { getWithSentryConfigOptionsTemplate } from '../../src/nextjs/templates';
+import {
+  getSentryConfigContents,
+  getWithSentryConfigOptionsTemplate,
+} from '../../src/nextjs/templates';
+
+describe('Next.js code templates', () => {
+  describe('getSentryConfigContents', () => {
+    describe('client-side', () => {
+      it('generates client-side Sentry config with all features enabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'client', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Add optional integrations for additional features
+            integrations: [
+              Sentry.replayIntegration(),
+            ],
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // 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,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates client-side Sentry config with performance monitoring disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'client', {
+          performance: false,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Add optional integrations for additional features
+            integrations: [
+              Sentry.replayIntegration(),
+            ],
+
+            // 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,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates client-side Sentry config with session replay disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'client', {
+          performance: true,
+          replay: false,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+    });
+
+    describe('server-side', () => {
+      it('generates server-side Sentry config with all features enabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'server', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates server-side Sentry config with performance monitoring disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'server', {
+          performance: false,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates server-side Sentry config with spotlight disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'server', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+    });
+
+    describe('edge', () => {
+      it('generates edge Sentry config with all features enabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'edge', {
+          performance: true,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+            tracesSampleRate: 1,
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+
+      it('generates edge Sentry config with performance monitoring disabled', () => {
+        const template = getSentryConfigContents('my-dsn', 'edge', {
+          performance: false,
+          replay: true,
+        });
+
+        expect(template).toMatchInlineSnapshot(`
+          "// 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/
+
+          import * as Sentry from "@sentry/nextjs";
+
+          Sentry.init({
+            dsn: "my-dsn",
+
+            // Setting this option to true will print useful information to the console while you're setting up Sentry.
+            debug: false,
+          });
+          "
+        `);
+      });
+    });
+  });
 
-describe('NextJS code templates', () => {
   describe('getWithSentryConfigOptionsTemplate', () => {
     it('generates options for SaaS', () => {
       const template = getWithSentryConfigOptionsTemplate({

package/test/sourcemaps/tools/sentry-cli.test.ts

@@ -38,7 +38,8 @@ describe('addSentryCommandToBuildCommand', () => {
     [
       packageManagerHelpers.NPM,
       packageManagerHelpers.PNPM,
-      packageManagerHelpers.YARN,
+      packageManagerHelpers.YARN_V1,
+      packageManagerHelpers.YARN_V2,
       packageManagerHelpers.BUN,
     ],
   ])('adds the cli command to the script command (%s)', async (_, pacMan) => {

package/test/sveltekit/templates.test.ts

@@ -0,0 +1,152 @@
+import {
+  getClientHooksTemplate,
+  getServerHooksTemplate,
+} from '../../src/sveltekit/templates';
+
+describe('getClientHooksTemplate', () => {
+  it('should generate client hooks template with all features enabled', () => {
+    const result = getClientHooksTemplate('https://sentry.io/123', {
+      performance: true,
+      replay: true,
+    });
+
+    expect(result).toMatchInlineSnapshot(`
+      "import { handleErrorWithSentry, replayIntegration } from "@sentry/sveltekit";
+      import * as Sentry from '@sentry/sveltekit';
+
+      Sentry.init({
+        dsn: 'https://sentry.io/123',
+
+        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()],
+      });
+
+      // If you have a custom error handler, pass it to \`handleErrorWithSentry\`
+      export const handleError = handleErrorWithSentry();
+      "
+    `);
+  });
+
+  it('should generate client hooks template when performance disabled', () => {
+    const result = getClientHooksTemplate('https://sentry.io/123', {
+      performance: false,
+      replay: true,
+    });
+
+    expect(result).toMatchInlineSnapshot(`
+      "import { handleErrorWithSentry, replayIntegration } from "@sentry/sveltekit";
+      import * as Sentry from '@sentry/sveltekit';
+
+      Sentry.init({
+        dsn: 'https://sentry.io/123',
+
+        // 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();
+      "
+    `);
+  });
+
+  it('should generate client hooks template when replay disabled', () => {
+    const result = getClientHooksTemplate('https://sentry.io/123', {
+      performance: true,
+      replay: false,
+    });
+
+    expect(result).toMatchInlineSnapshot(`
+      "import { handleErrorWithSentry, replayIntegration } from "@sentry/sveltekit";
+      import * as Sentry from '@sentry/sveltekit';
+
+      Sentry.init({
+        dsn: 'https://sentry.io/123',
+
+        tracesSampleRate: 1.0,
+
+
+      });
+
+      // If you have a custom error handler, pass it to \`handleErrorWithSentry\`
+      export const handleError = handleErrorWithSentry();
+      "
+    `);
+  });
+});
+
+describe('getServerHooksTemplate', () => {
+  it('should generate server hooks template with all features enabled', () => {
+    const result = getServerHooksTemplate('https://sentry.io/123', {
+      performance: true,
+      replay: true,
+    });
+
+    expect(result).toMatchInlineSnapshot(`
+      "import { sequence } from "@sveltejs/kit/hooks";
+      import { handleErrorWithSentry, sentryHandle } from "@sentry/sveltekit";
+      import * as Sentry from '@sentry/sveltekit';
+
+      Sentry.init({
+        dsn: 'https://sentry.io/123',
+
+        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();
+      "
+    `);
+  });
+
+  it('should generate server hooks template when performance disabled', () => {
+    const result = getServerHooksTemplate('https://sentry.io/123', {
+      performance: false,
+      replay: true,
+    });
+
+    expect(result).toMatchInlineSnapshot(`
+      "import { sequence } from "@sveltejs/kit/hooks";
+      import { handleErrorWithSentry, sentryHandle } from "@sentry/sveltekit";
+      import * as Sentry from '@sentry/sveltekit';
+
+      Sentry.init({
+        dsn: 'https://sentry.io/123',
+
+        // 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();
+      "
+    `);
+  });
+});