@sentry/wizard 4.0.0 → 4.0.1

package/test/sveltekit/templates.test.ts

@@ -1,152 +0,0 @@
-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();
-      "
-    `);
-  });
-});

package/test/utils/ast-utils.test.ts

@@ -1,264 +0,0 @@
-import {
-  getObjectProperty,
-  getOrSetObjectProperty,
-  hasSentryContent,
-  parseJsonC,
-  printJsonC,
-  setOrUpdateObjectProperty,
-} from '../../src/utils/ast-utils';
-
-import * as recast from 'recast';
-const b = recast.types.builders;
-
-describe('hasSentryContent', () => {
-  it.each([
-    `
-      const { sentryVitePlugin } = require("@sentry/vite-plugin");
-      const somethingelse = require('gs');
-    `,
-    `
-        import { sentryVitePlugin } from "@sentry/vite-plugin";
-        import * as somethingelse from 'gs';
-
-        export default {
-            plugins: [sentryVitePlugin()]
-        }
-      `,
-  ])(
-    "returns true if a require('@sentry/') call was found in the parsed module",
-    (code) => {
-      // recast.parse returns a Program node (or fails) but it's badly typed as any
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      const program = recast.parse(code)
-        .program as recast.types.namedTypes.Program;
-      expect(hasSentryContent(program)).toBe(true);
-    },
-  );
-
-  it.each([
-    `const whatever = require('something')`,
-    `// const {sentryWebpackPlugin} = require('@sentry/webpack-plugin')`,
-    `const {sAntryWebpackPlugin} = require('webpack-plugin-@sentry')`,
-    `
-      import * as somethingelse from 'gs';
-      export default {
-          plugins: []
-      }
-      `,
-    `import * as somethingelse from 'gs';
-       // import { sentryVitePlugin } from "@sentry/vite-plugin"
-      export default {
-          plugins: []
-      }
-      `,
-    `import * as thirdPartyVitePlugin from "vite-plugin-@sentry"
-      export default {
-        plugins: [thirdPartyVitePlugin()]
-      }
-      `,
-  ])(
-    "returns false if the file doesn't contain any require('@sentry/') calls",
-    (code) => {
-      // recast.parse returns a Program node (or fails) but it's badly typed as any
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      const program = recast.parse(code)
-        .program as recast.types.namedTypes.Program;
-      expect(hasSentryContent(program)).toBe(false);
-    },
-  );
-});
-
-describe('getObjectProperty', () => {
-  it.each([
-    [
-      'literal',
-      b.objectExpression([
-        b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-        b.objectProperty(
-          b.stringLiteral('needle'),
-          b.stringLiteral('haystack'),
-        ),
-      ]),
-    ],
-    [
-      'stringLiteral',
-      b.objectExpression([
-        b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-        b.objectProperty(b.literal('needle'), b.stringLiteral('haystack')),
-      ]),
-    ],
-    [
-      'identifier',
-      b.objectExpression([
-        b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-        b.objectProperty(b.identifier('needle'), b.stringLiteral('haystack')),
-      ]),
-    ],
-  ])('returns the poperty (%s) if it exists', (_, object) => {
-    const property = getObjectProperty(object, 'needle');
-    expect(property).toBeDefined();
-    // @ts-expect-error we know it's defined due to the expect above
-    expect(recast.print(property).code).toEqual(
-      expect.stringContaining('needle'),
-    );
-  });
-
-  it('returns undefined if the property does not exist', () => {
-    const object = b.objectExpression([
-      b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-    ]);
-    const property = getObjectProperty(object, 'needle');
-    expect(property).toBeUndefined();
-  });
-
-  it('handles objects without simple properties', () => {
-    const object = b.objectExpression([b.spreadElement(b.identifier('foo'))]);
-    const property = getObjectProperty(object, 'needle');
-    expect(property).toBeUndefined();
-  });
-});
-
-describe('getOrSetObjectProperty', () => {
-  it('returns the property if it exists', () => {
-    const object = b.objectExpression([
-      b.objectProperty(b.identifier('needle'), b.stringLiteral('haystack')),
-    ]);
-
-    const property = getOrSetObjectProperty(
-      object,
-      'needle',
-      b.stringLiteral('nope'),
-    );
-
-    expect(property).toBeDefined();
-    expect(property.type).toBe('ObjectProperty');
-    // @ts-expect-error we know its type
-    expect(property.key.name).toBe('needle');
-    // @ts-expect-error we know its type
-    expect(property.value.value).toBe('haystack');
-  });
-
-  it('adds the property if it does not exist', () => {
-    const object = b.objectExpression([
-      b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-    ]);
-
-    const property = getOrSetObjectProperty(
-      object,
-      'needle',
-      b.stringLiteral('haystack'),
-    );
-
-    expect(property).toBeDefined();
-    expect(property.type).toBe('Property');
-    // @ts-expect-error we know its type
-    expect(property.key.value).toBe('needle');
-    // @ts-expect-error we know its type
-    expect(property.value.value).toBe('haystack');
-  });
-});
-
-describe('setOrUpdateObjectProperty', () => {
-  it('sets a new property if it does not exist yet', () => {
-    const object = b.objectExpression([
-      b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-    ]);
-
-    setOrUpdateObjectProperty(object, 'needle', b.stringLiteral('haystack'));
-
-    expect(getObjectProperty(object, 'needle')).toBeDefined();
-  });
-
-  it('updates an existing property if it exists', () => {
-    const object = b.objectExpression([
-      b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-      b.objectProperty(b.identifier('needle'), b.stringLiteral('haystack')),
-    ]);
-
-    setOrUpdateObjectProperty(object, 'needle', b.stringLiteral('haystack2'));
-
-    const property = getObjectProperty(object, 'needle');
-    // @ts-expect-error it must be defiend, otherwise we fail anyway
-    expect(property?.value.value).toBe('haystack2');
-  });
-
-  it('adds a comment to the existing property if provided', () => {
-    const object = b.objectExpression([
-      b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-    ]);
-
-    setOrUpdateObjectProperty(
-      object,
-      'needle',
-      b.stringLiteral('haystack'),
-      'This is a comment',
-    );
-
-    const property = getObjectProperty(object, 'needle');
-    expect(property?.comments).toHaveLength(1);
-    // @ts-expect-error it must be defiend, otherwise we fail anyway
-    expect(property?.comments[0].value).toBe(' This is a comment');
-  });
-
-  it('adds a comment to the new property if provided', () => {
-    const object = b.objectExpression([
-      b.objectProperty(b.identifier('foo'), b.stringLiteral('bar')),
-    ]);
-
-    setOrUpdateObjectProperty(
-      object,
-      'needle',
-      b.stringLiteral('haystack'),
-      'This is a comment',
-    );
-
-    const property = getObjectProperty(object, 'needle');
-    expect(property?.comments).toHaveLength(1);
-    // @ts-expect-error it must be defiend, otherwise we fail anyway
-    expect(property?.comments[0].value).toBe(' This is a comment');
-  });
-});
-
-describe('parse and print JSON-C', () => {
-  it.each([
-    ['simple JSON', "{'foo': 'bar'}"],
-    [
-      'JSON-C with inline comment',
-      `
-    {
-      "foo": "bar" // with an inline comment
-    }
-    `,
-    ],
-    [
-      'JSON-C with multiple comments',
-      `
-    /*
-     * let's throw in a block comment for good measure
-     */  
-    {
-      // one line comment
-      "foo": "bar", // another inline comment
-      /* one more here */
-      "dogs": /* and here */ "awesome",
-    }
-    /* and here */
-    `,
-    ],
-  ])(`parses and prints JSON-C (%s)`, (_, json) => {
-    const { ast, jsonObject } = parseJsonC(json);
-    expect(ast?.type).toBe('Program');
-    expect(jsonObject).toBeDefined();
-    expect(jsonObject?.type).toBe('ObjectExpression');
-    // @ts-expect-error we know it's defined due to the expect above
-    expect(printJsonC(ast)).toEqual(json);
-  });
-
-  it('returns undefined if the input is not valid JSON-C', () => {
-    const { ast, jsonObject } = parseJsonC(`{
-      "invalid": // "json"
-    }`);
-    expect(ast).toBeUndefined();
-    expect(jsonObject).toBeUndefined();
-  });
-});

package/test/utils/clack-utils.test.ts

@@ -1,224 +0,0 @@
-import {
-  askForToolConfigPath,
-  createNewConfigFile,
-  installPackage,
-} from '../../src/utils/clack-utils';
-
-import * as fs from 'node:fs';
-import * as ChildProcess from 'node:child_process';
-import type { PackageManager } from '../../src/utils/package-manager';
-
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import * as clack from '@clack/prompts';
-
-jest.mock('node:child_process', () => ({
-  __esModule: true,
-  ...jest.requireActual('node:child_process'),
-}));
-
-jest.mock('@clack/prompts', () => ({
-  log: {
-    info: jest.fn(),
-    success: jest.fn(),
-    warn: jest.fn(),
-  },
-  text: jest.fn(),
-  confirm: jest.fn(),
-  cancel: jest.fn(),
-  // passthrough for abortIfCancelled
-  isCancel: jest.fn().mockReturnValue(false),
-  spinner: jest
-    .fn()
-    .mockImplementation(() => ({ start: jest.fn(), stop: jest.fn() })),
-}));
-
-function mockUserResponse(fn: jest.Mock, response: any) {
-  fn.mockReturnValueOnce(response);
-}
-
-describe('askForToolConfigPath', () => {
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it('returns undefined if users have no config file', async () => {
-    mockUserResponse(clack.confirm as jest.Mock, false);
-
-    const result = await askForToolConfigPath('Webpack', 'webpack.config.js');
-
-    expect(clack.confirm).toHaveBeenCalledWith(
-      expect.objectContaining({
-        message: expect.stringContaining('have a Webpack config file'),
-      }),
-    );
-
-    expect(result).toBeUndefined();
-  });
-
-  it('returns the path if users have a config file and the entered path is valid', async () => {
-    mockUserResponse(clack.confirm as jest.Mock, true);
-    mockUserResponse(clack.text as jest.Mock, 'my.webpack.config.js');
-
-    const result = await askForToolConfigPath('Webpack', 'webpack.config.js');
-
-    expect(clack.confirm).toHaveBeenCalledWith(
-      expect.objectContaining({
-        message: expect.stringContaining('have a Webpack config file'),
-      }),
-    );
-
-    expect(clack.text).toHaveBeenCalledWith(
-      expect.objectContaining({
-        message: expect.stringContaining(
-          'enter the path to your Webpack config file',
-        ),
-      }),
-    );
-
-    expect(result).toBe('my.webpack.config.js');
-  });
-});
-
-describe('createNewConfigFile', () => {
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it('writes the file to disk and returns true if the file was created successfully', async () => {
-    const writeFileSpy = jest
-      .spyOn(fs.promises, 'writeFile')
-      .mockImplementation(jest.fn());
-
-    const filename = '/webpack.config.js';
-    const code = 'module.exports = {/*config...*/}';
-
-    const result = await createNewConfigFile(filename, code);
-
-    expect(result).toBe(true);
-    expect(writeFileSpy).toHaveBeenCalledWith(filename, code);
-  });
-
-  it('logs more information if provided as an argument', async () => {
-    jest.spyOn(fs.promises, 'writeFile').mockImplementation(jest.fn());
-
-    const filename = '/webpack.config.js';
-    const code = 'module.exports = {/*config...*/}';
-    const moreInfo = 'More information...';
-
-    await createNewConfigFile(filename, code, moreInfo);
-
-    expect(clack.log.info).toHaveBeenCalledTimes(1);
-    expect(clack.log.info).toHaveBeenCalledWith(
-      expect.stringContaining(moreInfo),
-    );
-  });
-
-  it('returns false and logs a warning if the file could not be created', async () => {
-    const writeFileSpy = jest
-      .spyOn(fs.promises, 'writeFile')
-      .mockImplementation(() => Promise.reject(new Error('Could not write')));
-
-    const filename = '/webpack.config.js';
-    const code = 'module.exports = {/*config...*/}';
-
-    const result = await createNewConfigFile(filename, code);
-
-    expect(result).toBe(false);
-    expect(writeFileSpy).toHaveBeenCalledWith(filename, code);
-    expect(clack.log.warn).toHaveBeenCalledTimes(1);
-  });
-
-  it('returns false if the passed path is not absolute', async () => {
-    const result = await createNewConfigFile(
-      './relative/webpack.config.js',
-      '',
-    );
-
-    expect(result).toBe(false);
-  });
-});
-
-describe('installPackage', () => {
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it('force-installs a package if the forceInstall flag is set', async () => {
-    const packageManagerMock: PackageManager = {
-      name: 'npm',
-      label: 'NPM',
-      installCommand: 'npm install',
-      buildCommand: 'npm run build',
-      runScriptCommand: 'npm run',
-      flags: '',
-      forceInstallFlag: '--force',
-      detect: jest.fn(),
-      addOverride: jest.fn(),
-    };
-
-    const execSpy = jest
-      .spyOn(ChildProcess, 'exec')
-      // @ts-expect-error - don't care about the return value
-      .mockImplementationOnce((cmd, cb) => {
-        if (cb) {
-          // @ts-expect-error - don't care about the options value
-          cb(null, '', '');
-        }
-      });
-
-    await installPackage({
-      alreadyInstalled: false,
-      packageName: '@sentry/sveltekit',
-      packageNameDisplayLabel: '@sentry/sveltekit',
-      forceInstall: true,
-      askBeforeUpdating: false,
-      packageManager: packageManagerMock,
-    });
-
-    expect(execSpy).toHaveBeenCalledWith(
-      'npm install @sentry/sveltekit  --force',
-      expect.any(Function),
-    );
-  });
-
-  it.each([false, undefined])(
-    "doesn't force-install a package if the forceInstall flag is %s",
-    async (flag) => {
-      const packageManagerMock: PackageManager = {
-        name: 'npm',
-        label: 'NPM',
-        installCommand: 'npm install',
-        buildCommand: 'npm run build',
-        runScriptCommand: 'npm run',
-        flags: '',
-        forceInstallFlag: '--force',
-        detect: jest.fn(),
-        addOverride: jest.fn(),
-      };
-
-      const execSpy = jest
-        .spyOn(ChildProcess, 'exec')
-        // @ts-expect-error - don't care about the return value
-        .mockImplementationOnce((cmd, cb) => {
-          if (cb) {
-            // @ts-expect-error - don't care about the options value
-            cb(null, '', '');
-          }
-        });
-
-      await installPackage({
-        alreadyInstalled: false,
-        packageName: '@sentry/sveltekit',
-        packageNameDisplayLabel: '@sentry/sveltekit',
-        forceInstall: flag,
-        askBeforeUpdating: false,
-        packageManager: packageManagerMock,
-      });
-
-      expect(execSpy).toHaveBeenCalledWith(
-        'npm install @sentry/sveltekit  ',
-        expect.any(Function),
-      );
-    },
-  );
-});

package/types/read-env.d.ts

@@ -1,3 +0,0 @@
-declare module "read-env" {
-  export default function readEnv(name: string): Record<string, unknown>;
-}