@sentry/wizard 3.42.1 → 4.0.0

package/src/react-native/react-native-wizard.ts

@@ -54,8 +54,7 @@ import { patchExpoAppConfig, printSentryExpoMigrationOutro } from './expo';
 import { addSentryToExpoMetroConfig } from './expo-metro';
 import { addExpoEnvLocal } from './expo-env-file';
 
-// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-const xcode = require('xcode');
+import xcode from 'xcode';
 
 export const RN_SDK_PACKAGE = '@sentry/react-native';
 export const RN_SDK_SUPPORTED_RANGE = '>=5.0.0';

package/src/react-native/uninstall.ts

@@ -23,8 +23,7 @@ import {
 import { ReactNativeWizardOptions } from './options';
 import { unPatchMetroConfig } from './metro';
 
-// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-const xcode = require('xcode');
+import xcode from 'xcode';
 
 export async function runReactNativeUninstall(
   options: ReactNativeWizardOptions,

package/src/react-native/xcode.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 // @ts-ignore - clack is ESM and TS complains about that. It works though
 import clack from '@clack/prompts';
 import chalk from 'chalk';

package/src/run.ts

@@ -16,6 +16,7 @@ import { runSourcemapsWizard } from './sourcemaps/sourcemaps-wizard';
 import { readEnvironment } from '../lib/Helper/Env';
 import type { Platform } from '../lib/Constants';
 import type { PackageDotJson } from './utils/package-json';
+import { readFileSync } from 'node:fs';
 
 type WizardIntegration =
   | 'reactNative'
@@ -195,10 +196,16 @@ export async function run(argv: Args) {
  * TODO: replace with rollup replace whenever we switch to rollup
  */
 function tryGetWizardVersion(): string {
-  try {
-    const wizardPkgJson = require('../package.json') as PackageDotJson;
-    return wizardPkgJson.version ?? '';
-  } catch {
-    return '';
+  let version = process.env.npm_package_version;
+  if (!version) {
+    try {
+      const wizardPkgJson = JSON.parse(
+        readFileSync('../package.json', 'utf-8'),
+      ) as PackageDotJson;
+      version = wizardPkgJson.version;
+    } catch {
+      // ignore
+    }
   }
+  return version ?? '';
 }

package/src/sourcemaps/tools/nextjs.ts

@@ -7,9 +7,9 @@ import {
   abortIfCancelled,
   addDotEnvSentryBuildPluginFile,
 } from '../../utils/clack-utils';
-import { WizardOptions } from '../../utils/types';
+import type { WizardOptions } from '../../utils/types';
 
-import { SourceMapUploadToolConfigurationOptions } from './types';
+import type { SourceMapUploadToolConfigurationOptions } from './types';
 
 import * as Sentry from '@sentry/node';
 

package/src/sourcemaps/tools/webpack.ts

@@ -1,5 +1,5 @@
-import * as path from 'path';
-import * as fs from 'fs';
+import * as path from 'node:path';
+import * as fs from 'node:fs';
 
 // @ts-ignore - clack is ESM and TS complains about that. It works though
 import * as clack from '@clack/prompts';
@@ -23,7 +23,7 @@ import {
 } from '../../utils/clack-utils';
 import { hasPackageInstalled } from '../../utils/package-json';
 
-import {
+import type {
   SourceMapUploadToolConfigurationFunction,
   SourceMapUploadToolConfigurationOptions,
 } from './types';

package/src/telemetry.ts

@@ -1,18 +1,19 @@
 import {
-  defaultStackParser,
   Hub,
   Integrations,
+  NodeClient,
+  type Span,
+  defaultStackParser,
+  flush,
   makeMain,
   makeNodeTransport,
-  NodeClient,
   runWithAsyncContext,
   setTag,
   startSpan,
-  flush,
-  Span,
 } from '@sentry/node';
-import packageJson from '../package.json';
-import { WizardOptions } from './utils/types';
+import { readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import type { WizardOptions } from './utils/types';
 
 export async function withTelemetry<F>(
   options: {
@@ -68,6 +69,25 @@ export async function withTelemetry<F>(
 }
 
 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,
@@ -77,7 +97,7 @@ function createSentryInstance(enabled: boolean, integration: string) {
     tracesSampleRate: 1,
     sampleRate: 1,
 
-    release: packageJson.version,
+    release: version,
     integrations: [new Integrations.Http()],
     tracePropagationTargets: [/^https:\/\/sentry.io\//],
 

package/src/utils/clack-utils.ts

@@ -1,31 +1,25 @@
+import * as childProcess from 'node:child_process';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import { basename, dirname, isAbsolute, join, relative } from 'node:path';
+import { setInterval } from 'node:timers';
+import { URL } from 'node:url';
 // @ts-ignore - clack is ESM and TS complains about that. It works though
 import * as clack from '@clack/prompts';
+import * as Sentry from '@sentry/node';
 import axios from 'axios';
 import chalk from 'chalk';
-import * as childProcess from 'child_process';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import { setInterval } from 'timers';
-import { URL } from 'url';
-import * as Sentry from '@sentry/node';
-import { hasPackageInstalled, PackageDotJson } from './package-json';
-import { Feature, SentryProjectData, WizardOptions } from './types';
+import opn from 'opn';
 import { traceStep } from '../telemetry';
+import { debug } from './debug';
+import { type PackageDotJson, hasPackageInstalled } from './package-json';
 import {
+  type PackageManager,
   detectPackageManger,
-  PackageManager,
   packageManagers,
 } from './package-manager';
-import { debug } from './debug';
 import { fulfillsVersionRange } from './semver';
-
-export const opn = require('opn') as (
-  url: string,
-  options?: {
-    wait?: boolean;
-  },
-) => Promise<childProcess.ChildProcess>;
+import type { Feature, SentryProjectData, WizardOptions } from './types';
 
 export const SENTRY_DOT_ENV_FILE = '.env.sentry-build-plugin';
 export const SENTRY_CLI_RC_FILE = '.sentryclirc';
@@ -145,23 +139,32 @@ export async function abortIfCancelled<T>(
   }
 }
 
+type PackageJSON = { version?: string };
+
 export function printWelcome(options: {
   wizardName: string;
   promoCode?: string;
   message?: string;
   telemetryEnabled?: boolean;
 }): void {
-  let wizardPackage: { version?: string } = {};
-
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    wizardPackage = require(path.join(
-      path.dirname(require.resolve('@sentry/wizard')),
-      '..',
-      'package.json',
-    ));
-  } catch {
-    // We don't need to have this
+  let wizardVersion = process.env.npm_package_version;
+  if (!wizardVersion) {
+    try {
+      wizardVersion = (
+        JSON.parse(
+          fs.readFileSync(
+            join(
+              dirname(require.resolve('@sentry/wizard')),
+              '..',
+              'package.json',
+            ),
+            'utf-8',
+          ),
+        ) as PackageJSON
+      ).version;
+    } catch {
+      // We don't need to have this
+    }
   }
 
   // eslint-disable-next-line no-console
@@ -176,8 +179,8 @@ export function printWelcome(options: {
     welcomeText = `${welcomeText}\n\nUsing promo-code: ${options.promoCode}`;
   }
 
-  if (wizardPackage.version) {
-    welcomeText = `${welcomeText}\n\nVersion: ${wizardPackage.version}`;
+  if (wizardVersion) {
+    welcomeText = `${welcomeText}\n\nVersion: ${wizardVersion}`;
   }
 
   if (options.telemetryEnabled) {
@@ -408,7 +411,7 @@ export async function installPackage({
             if (err) {
               // Write a log file so we can better troubleshoot issues
               fs.writeFileSync(
-                path.join(
+                join(
                   process.cwd(),
                   `sentry-wizard-installation-error-${Date.now()}.log`,
                 ),
@@ -454,7 +457,7 @@ export async function addSentryCliConfig(
   setupConfig: CliSetupConfig = rcCliSetupConfig,
 ): Promise<void> {
   return traceStep('add-sentry-cli-config', async () => {
-    const configPath = path.join(process.cwd(), setupConfig.filename);
+    const configPath = join(process.cwd(), setupConfig.filename);
     const configExists = fs.existsSync(configPath);
 
     let configContents =
@@ -597,7 +600,7 @@ export async function addDotEnvSentryBuildPluginFile(
 SENTRY_AUTH_TOKEN=${authToken}
 `;
 
-  const dotEnvFilePath = path.join(process.cwd(), SENTRY_DOT_ENV_FILE);
+  const dotEnvFilePath = join(process.cwd(), SENTRY_DOT_ENV_FILE);
   const dotEnvFileExists = fs.existsSync(dotEnvFilePath);
 
   if (dotEnvFileExists) {
@@ -658,7 +661,7 @@ SENTRY_AUTH_TOKEN=${authToken}
 }
 
 async function addCliConfigFileToGitIgnore(filename: string): Promise<void> {
-  const gitignorePath = path.join(process.cwd(), '.gitignore');
+  const gitignorePath = join(process.cwd(), '.gitignore');
 
   try {
     const gitignoreContent = await fs.promises.readFile(gitignorePath, 'utf8');
@@ -794,7 +797,7 @@ export async function ensurePackageIsInstalled(
 
 export async function getPackageDotJson(): Promise<PackageDotJson> {
   const packageJsonFileContents = await fs.promises
-    .readFile(path.join(process.cwd(), 'package.json'), 'utf8')
+    .readFile(join(process.cwd(), 'package.json'), 'utf8')
     .catch(() => {
       clack.log.error(
         'Could not find package.json. Make sure to run the wizard in the root of your app!',
@@ -825,7 +828,7 @@ export async function updatePackageDotJson(
 ): Promise<void> {
   try {
     await fs.promises.writeFile(
-      path.join(process.cwd(), 'package.json'),
+      join(process.cwd(), 'package.json'),
       // TODO: maybe figure out the original indentation
       JSON.stringify(packageDotJson, null, 2),
       {
@@ -865,7 +868,7 @@ export async function getPackageManager(): Promise<PackageManager> {
 
 export function isUsingTypeScript() {
   try {
-    return fs.existsSync(path.join(process.cwd(), 'tsconfig.json'));
+    return fs.existsSync(join(process.cwd(), 'tsconfig.json'));
   } catch {
     return false;
   }
@@ -1127,9 +1130,9 @@ async function askForWizardLogin(options: {
     )}\n\n${chalk.cyan(urlToOpen)}`,
   );
 
-  opn(urlToOpen, { wait: false }).catch(() => {
-    // opn throws in environments that don't have a browser (e.g. remote shells) so we just noop here
-  });
+  // opn throws in environments that don't have a browser (e.g. remote shells) so we just noop here
+  const noop = () => {}; // eslint-disable-line @typescript-eslint/no-empty-function
+  opn(urlToOpen, { wait: false }).then((cp) => cp.on('error', noop), noop);
 
   const loginSpinner = clack.spinner();
 
@@ -1276,7 +1279,7 @@ export async function askForToolConfigPath(
   return await abortIfCancelled(
     clack.text({
       message: `Please enter the path to your ${toolName} config file:`,
-      placeholder: path.join('.', configFileName),
+      placeholder: join('.', configFileName),
       validate: (value) => {
         if (!value) {
           return 'Please enter a path.';
@@ -1323,9 +1326,9 @@ export async function showCopyPasteInstructions(
   hint?: string,
 ): Promise<void> {
   clack.log.step(
-    `Add the following code to your ${chalk.cyan(
-      path.basename(filename),
-    )} file:${hint ? chalk.dim(` (${chalk.dim(hint)})`) : ''}`,
+    `Add the following code to your ${chalk.cyan(basename(filename))} file:${
+      hint ? chalk.dim(` (${chalk.dim(hint)})`) : ''
+    }`,
   );
 
   // Padding the code snippet to be printed with a \n at the beginning and end
@@ -1406,12 +1409,12 @@ export async function createNewConfigFile(
   codeSnippet: string,
   moreInformation?: string,
 ): Promise<boolean> {
-  if (!path.isAbsolute(filepath)) {
+  if (!isAbsolute(filepath)) {
     debug(`createNewConfigFile: filepath is not absolute: ${filepath}`);
     return false;
   }
 
-  const prettyFilename = chalk.cyan(path.relative(process.cwd(), filepath));
+  const prettyFilename = chalk.cyan(relative(process.cwd(), filepath));
 
   try {
     await fs.promises.writeFile(filepath, codeSnippet);

package/test/apple/cocoapod.test.ts

@@ -10,6 +10,10 @@ import {
 import * as bash from '../../src/utils/bash';
 // @ts-ignore - clack is ESM and TS complains about that. It works though
 import * as clack from '@clack/prompts';
+jest.mock('@clack/prompts', () => ({
+  __esModule: true,
+  ...jest.requireActual('@clack/prompts'),
+}));
 
 jest.mock('../../src/utils/bash');
 jest.spyOn(Sentry, 'setTag').mockImplementation();

package/test/apple/fastfile.test.ts

@@ -1,6 +1,6 @@
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
 import {
   addSentryToFastlane,
   exportForTesting,
@@ -9,6 +9,11 @@ import {
 // @ts-ignore - clack is ESM and TS complains about that. It works though
 import * as clack from '@clack/prompts';
 
+jest.mock('@clack/prompts', () => ({
+  __esModule: true,
+  ...jest.requireActual('@clack/prompts'),
+}));
+
 describe('fastlane', () => {
   beforeEach(() => {
     jest.spyOn(clack.log, 'warn').mockImplementation();
@@ -422,7 +427,7 @@ end
 platform :ios do
   lane :test do
     puts 'Hello, world!'
-  end   
+  end
 end
 `,
         );
@@ -443,7 +448,7 @@ platform :ios do
       project_slug: 'test-project',
       include_sources: true
     )
-  end   
+  end
 end
 `,
         );
@@ -463,7 +468,7 @@ end
           `platform :ios do
   lane :test do
     puts 'Hello, world!'
-  end   
+  end
 
   lane :beta do
     puts 'Beta lane'
@@ -505,7 +510,7 @@ end
             `platform :ios do
   lane :test do
     puts 'Hello, world!'
-  end   
+  end
 
   lane :beta do
     puts 'Beta lane'

package/test/apple/xcode-manager.test.ts

@@ -1,7 +1,7 @@
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
-import {
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import type {
   PBXFileReference,
   PBXGroup,
   PBXNativeTarget,
@@ -11,15 +11,17 @@ import {
 } from 'xcode';
 import { getRunScriptTemplate } from '../../src/apple/templates';
 import { XcodeProject } from '../../src/apple/xcode-manager';
-import { SentryProjectData } from '../../src/utils/types';
+import type { SentryProjectData } from '../../src/utils/types';
 
+jest.mock('node:fs', () => ({
+  __esModule: true,
+  ...jest.requireActual('node:fs'),
+}));
 jest.mock('@clack/prompts', () => ({
-  default: {
-    log: {
-      info: jest.fn(),
-      success: jest.fn(),
-      step: jest.fn(),
-    },
+  log: {
+    info: jest.fn(),
+    success: jest.fn(),
+    step: jest.fn(),
   },
 }));
 

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

@@ -4,43 +4,33 @@ import {
   installPackage,
 } from '../../src/utils/clack-utils';
 
-import * as fs from 'fs';
-import * as ChildProcess from 'child_process';
-import { PackageManager } from '../../src/utils/package-manager';
-
-type ClackMock = {
-  confirm: jest.Mock;
-  text: jest.Mock;
-  isCancel: jest.Mock;
-  cancel: jest.Mock;
+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.Mock;
-    success: jest.Mock;
-    warn: jest.Mock;
-  };
-  spinner: () => { start: jest.Mock; stop: jest.Mock };
-};
-
-let clackMock: ClackMock;
-
-jest.mock('@clack/prompts', () => {
-  clackMock = {
-    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() })),
-  };
-  return clackMock;
-});
+    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);
@@ -52,11 +42,11 @@ describe('askForToolConfigPath', () => {
   });
 
   it('returns undefined if users have no config file', async () => {
-    mockUserResponse(clackMock.confirm, false);
+    mockUserResponse(clack.confirm as jest.Mock, false);
 
     const result = await askForToolConfigPath('Webpack', 'webpack.config.js');
 
-    expect(clackMock.confirm).toHaveBeenCalledWith(
+    expect(clack.confirm).toHaveBeenCalledWith(
       expect.objectContaining({
         message: expect.stringContaining('have a Webpack config file'),
       }),
@@ -66,18 +56,18 @@ describe('askForToolConfigPath', () => {
   });
 
   it('returns the path if users have a config file and the entered path is valid', async () => {
-    mockUserResponse(clackMock.confirm, true);
-    mockUserResponse(clackMock.text, 'my.webpack.config.js');
+    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(clackMock.confirm).toHaveBeenCalledWith(
+    expect(clack.confirm).toHaveBeenCalledWith(
       expect.objectContaining({
         message: expect.stringContaining('have a Webpack config file'),
       }),
     );
 
-    expect(clackMock.text).toHaveBeenCalledWith(
+    expect(clack.text).toHaveBeenCalledWith(
       expect.objectContaining({
         message: expect.stringContaining(
           'enter the path to your Webpack config file',
@@ -99,8 +89,8 @@ describe('createNewConfigFile', () => {
       .spyOn(fs.promises, 'writeFile')
       .mockImplementation(jest.fn());
 
-    const filename = '/weboack.config.js';
-    const code = `module.exports = {/*config...*/}`;
+    const filename = '/webpack.config.js';
+    const code = 'module.exports = {/*config...*/}';
 
     const result = await createNewConfigFile(filename, code);
 
@@ -111,14 +101,14 @@ describe('createNewConfigFile', () => {
   it('logs more information if provided as an argument', async () => {
     jest.spyOn(fs.promises, 'writeFile').mockImplementation(jest.fn());
 
-    const filename = '/weboack.config.js';
-    const code = `module.exports = {/*config...*/}`;
+    const filename = '/webpack.config.js';
+    const code = 'module.exports = {/*config...*/}';
     const moreInfo = 'More information...';
 
     await createNewConfigFile(filename, code, moreInfo);
 
-    expect(clackMock.log.info).toHaveBeenCalledTimes(1);
-    expect(clackMock.log.info).toHaveBeenCalledWith(
+    expect(clack.log.info).toHaveBeenCalledTimes(1);
+    expect(clack.log.info).toHaveBeenCalledWith(
       expect.stringContaining(moreInfo),
     );
   });
@@ -129,13 +119,13 @@ describe('createNewConfigFile', () => {
       .mockImplementation(() => Promise.reject(new Error('Could not write')));
 
     const filename = '/webpack.config.js';
-    const code = `module.exports = {/*config...*/}`;
+    const code = 'module.exports = {/*config...*/}';
 
     const result = await createNewConfigFile(filename, code);
 
     expect(result).toBe(false);
     expect(writeFileSpy).toHaveBeenCalledWith(filename, code);
-    expect(clackMock.log.warn).toHaveBeenCalledTimes(1);
+    expect(clack.log.warn).toHaveBeenCalledTimes(1);
   });
 
   it('returns false if the passed path is not absolute', async () => {

package/types/read-env.d.ts

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

package/types/xcode.d.ts

@@ -165,6 +165,7 @@ declare module 'xcode' {
   }
 
   export interface PBXShellScriptBuildPhase {
+    isa?: string;
     shellScript: string;
     inputFileListPaths?: string[];
     outputFileListPaths?: string[];