@sentry/wizard 3.42.1 → 4.0.0

package/e2e-tests/tests/nuxt-3.test.ts

@@ -1,5 +1,8 @@
-import * as path from 'path';
+import * as path from 'node:path';
+import { Integration } from '../../lib/Constants';
 import {
+  KEYS,
+  TEST_ARGS,
   checkEnvBuildPlugin,
   checkFileContents,
   checkFileExists,
@@ -7,12 +10,9 @@ import {
   checkIfRunsOnProdMode,
   checkPackageJson,
   cleanupGit,
-  KEYS,
   revertLocalChanges,
   startWizardInstance,
-  TEST_ARGS,
 } from '../utils';
-import { Integration } from '../../lib/Constants';
 
 describe('Nuxt-3', () => {
   const projectDir = path.resolve(

package/e2e-tests/tests/nuxt-4.test.ts

@@ -1,16 +1,16 @@
-import * as path from 'path';
+import * as path from 'node:path';
 import { Integration } from '../../lib/Constants';
 import { cleanupGit, revertLocalChanges } from '../utils';
 import {
+  KEYS,
+  TEST_ARGS,
   checkEnvBuildPlugin,
   checkFileContents,
   checkFileExists,
   checkIfBuilds,
   checkIfRunsOnProdMode,
   checkPackageJson,
-  KEYS,
   startWizardInstance,
-  TEST_ARGS,
 } from '../utils';
 
 describe('Nuxt-4', () => {

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

@@ -1,6 +1,9 @@
 /* eslint-disable jest/expect-expect */
+import * as path from 'node:path';
 import { Integration } from '../../lib/Constants';
 import {
+  KEYS,
+  TEST_ARGS,
   checkEnvBuildPlugin,
   checkFileContents,
   checkFileExists,
@@ -10,13 +13,10 @@ import {
   checkPackageJson,
   cleanupGit,
   createFile,
-  KEYS,
   modifyFile,
   revertLocalChanges,
   startWizardInstance,
-  TEST_ARGS,
 } from '../utils';
-import * as path from 'path';
 
 const SERVER_TEMPLATE = `import { createRequestHandler } from '@remix-run/express';
 import { installGlobals } from '@remix-run/node';

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

@@ -1,6 +1,9 @@
 /* eslint-disable jest/expect-expect */
+import * as path from 'node:path';
 import { Integration } from '../../lib/Constants';
 import {
+  KEYS,
+  TEST_ARGS,
   checkEnvBuildPlugin,
   checkFileContents,
   checkFileExists,
@@ -10,12 +13,9 @@ import {
   checkPackageJson,
   cleanupGit,
   createFile,
-  KEYS,
   revertLocalChanges,
   startWizardInstance,
-  TEST_ARGS,
 } from '../utils';
-import * as path from 'path';
 
 const SERVER_HOOK_TEMPLATE = `import type { Handle } from '@sveltejs/kit';
 

package/e2e-tests/utils/index.ts

@@ -1,9 +1,9 @@
-import * as fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 
 import type { Integration } from '../../lib/Constants';
-import { spawn, execSync } from 'child_process';
-import type { ChildProcess } from 'child_process';
+import { spawn, execSync } from 'node:child_process';
+import type { ChildProcess } from 'node:child_process';
 import { dim, green, red } from '../../lib/Helper/Logging';
 
 export const KEYS = {
@@ -49,13 +49,13 @@ export class WizardTestEnv {
     this.taskHandle = spawn(cmd, args, { cwd: opts?.cwd, stdio: 'pipe' });
 
     if (opts?.debug) {
-      this.taskHandle.stdout.pipe(process.stdout);
-      this.taskHandle.stderr.pipe(process.stderr);
+      this.taskHandle.stdout?.pipe(process.stdout);
+      this.taskHandle.stderr?.pipe(process.stderr);
     }
   }
 
   sendStdin(input: string) {
-    this.taskHandle.stdin.write(input);
+    this.taskHandle.stdin?.write(input);
   }
 
   /**
@@ -100,9 +100,15 @@ export class WizardTestEnv {
 
     return new Promise<boolean>((resolve, reject) => {
       const timeoutId = setTimeout(() => {
+        this.kill();
         reject(new Error(`Timeout waiting for status code: ${statusCode}`));
       }, timeout);
 
+      this.taskHandle.on('error', (err: Error) => {
+        clearTimeout(timeoutId);
+        reject(err);
+      });
+
       this.taskHandle.on('exit', (code: number | null) => {
         clearTimeout(timeoutId);
         resolve(code === statusCode);
@@ -134,15 +140,25 @@ export class WizardTestEnv {
     return new Promise<boolean>((resolve, reject) => {
       let outputBuffer = '';
       const timeoutId = setTimeout(() => {
+        this.kill();
         if (optional) {
           // The output is not found but it's optional so we can resolve the promise with false
           resolve(false);
         } else {
-          reject(new Error(`Timeout waiting for output: ${output}`));
+          reject(
+            new Error(
+              `Timeout waiting for output: ${output}. Got the following instead: ${outputBuffer}`,
+            ),
+          );
         }
       }, timeout);
 
-      this.taskHandle.stdout.on('data', (data) => {
+      this.taskHandle.on('error', (err: Error) => {
+        clearTimeout(timeoutId);
+        reject(err);
+      });
+
+      this.taskHandle.stdout?.on('data', (data) => {
         outputBuffer += data;
         if (outputBuffer.includes(output)) {
           clearTimeout(timeoutId);
@@ -154,9 +170,9 @@ export class WizardTestEnv {
   }
 
   kill() {
-    this.taskHandle.stdin.destroy();
-    this.taskHandle.stderr.destroy();
-    this.taskHandle.stdout.destroy();
+    this.taskHandle.stdin?.destroy();
+    this.taskHandle.stderr?.destroy();
+    this.taskHandle.stdout?.destroy();
     this.taskHandle.kill('SIGINT');
     this.taskHandle.unref();
   }
@@ -230,16 +246,18 @@ export function startWizardInstance(
   projectDir: string,
   debug = false,
 ): WizardTestEnv {
-  const binPath = path.join(__dirname, '../../dist/bin.js');
+  const binName = process.env.SENTRY_WIZARD_E2E_TEST_BIN
+    ? ['dist-bin', `sentry-wizard-${process.platform}-${process.arch}`]
+    : ['dist', 'bin.js'];
+  const binPath = path.join(__dirname, '..', '..', ...binName);
 
   revertLocalChanges(projectDir);
   cleanupGit(projectDir);
   initGit(projectDir);
 
   return new WizardTestEnv(
-    'node',
+    binPath,
     [
-      binPath,
       '--debug',
       '-i',
       integration,

package/lib/Helper/BottomBar.ts

@@ -4,7 +4,7 @@ import { nl } from './Logging';
 
 export class BottomBar {
   public static bar: typeof ui.BottomBar;
-  public static interval: NodeJS.Timer;
+  public static interval: NodeJS.Timeout;
 
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   public static show(msg: string): void {

package/lib/Helper/Env.ts

@@ -1,4 +1,4 @@
-const readEnv = require('read-env').default;
+import readEnv from 'read-env';
 
 // TODO: move to src/utils (+tests)
 export function readEnvironment(): Record<string, unknown> {

package/lib/Helper/Package.ts

@@ -1,22 +1,25 @@
-import * as _ from 'lodash';
 import { satisfies, subset, valid, validRange } from 'semver';
 
 import { green, red } from './Logging';
 
 export function checkPackageVersion(
-  appPackage: unknown,
+  appPackage: {
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+  },
   packageName: string,
   acceptableVersions: string,
   canBeLatest: boolean,
 ): boolean {
-  const depsVersion = _.get(appPackage, ['dependencies', packageName]);
-  const devDepsVersion = _.get(appPackage, ['devDependencies', packageName]);
+  const depsVersion = appPackage?.dependencies?.[packageName] ?? '';
+  const devDepsVersion = appPackage?.devDependencies?.[packageName] ?? '';
 
   if (!depsVersion && !devDepsVersion) {
     red(`✗ ${packageName} isn't in your dependencies.`);
     red('  Please install it with yarn/npm.');
     return false;
-  } else if (
+  }
+  if (
     !fulfillsVersionRange(depsVersion, acceptableVersions, canBeLatest) &&
     !fulfillsVersionRange(devDepsVersion, acceptableVersions, canBeLatest)
   ) {
@@ -24,12 +27,11 @@ export function checkPackageVersion(
       `✗ Your \`package.json\` specifies a version of \`${packageName}\` outside of the compatible version range ${acceptableVersions}.\n`,
     );
     return false;
-  } else {
-    green(
-      `✓ A compatible version of \`${packageName}\` is specified in \`package.json\`.`,
-    );
-    return true;
   }
+  green(
+    `✓ A compatible version of \`${packageName}\` is specified in \`package.json\`.`,
+  );
+  return true;
 }
 
 function fulfillsVersionRange(

package/lib/Helper/SentryCli.ts

@@ -1,7 +1,6 @@
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 import type { Answers } from 'inquirer';
-import * as _ from 'lodash';
-import * as path from 'path';
+import * as path from 'node:path';
 
 import type { Args } from '../Constants';
 import { addToGitignore } from './Git';
@@ -30,9 +29,9 @@ export class SentryCli {
   public convertAnswersToProperties(answers: Answers): SentryCliProps {
     const props: SentryCliProps = {};
     props['defaults/url'] = this._argv.url;
-    props['defaults/org'] = _.get(answers, 'config.organization.slug', null);
-    props['defaults/project'] = _.get(answers, 'config.project.slug', null);
-    props['auth/token'] = _.get(answers, 'config.auth.token', null);
+    props['defaults/org'] = answers.config?.organization?.slug ?? null;
+    props['defaults/project'] = answers.config?.project?.slug ?? null;
+    props['auth/token'] = answers.config?.auth?.token ?? null;
     try {
       const cliPath = this._resolve('@sentry/cli/bin/sentry-cli', {
         paths: [process.cwd()],
@@ -41,7 +40,7 @@ export class SentryCli {
         .relative(process.cwd(), cliPath)
         .replace(/\\/g, '\\\\');
     } catch (e) {
-      // we do nothing and leave everyting as it is
+      // we do nothing and leave everything as it is
     }
     return props;
   }
@@ -49,17 +48,13 @@ export class SentryCli {
   /** Create the contents of a `sentry.properties` file */
   public dumpProperties(props: SentryCliProps): string {
     const rv = [];
-    for (let key in props) {
-      // eslint-disable-next-line no-prototype-builtins
-      if (props.hasOwnProperty(key)) {
-        const value = props[key];
-        key = key.replace(/\//g, '.');
-        if (value === undefined || value === null) {
-          // comment that property out since it has no value
-          rv.push(`#${key}=`);
-        } else {
-          rv.push(`${key}=${value}`);
-        }
+    for (const [key, value] of Object.entries(props)) {
+      const normalizedKey = key.replace(/\//g, '.');
+      if (value === undefined || value === null) {
+        // comment that property out since it has no value
+        rv.push(`#${normalizedKey}=`);
+      } else {
+        rv.push(`${normalizedKey}=${value}`);
       }
     }
     // eslint-disable-next-line prefer-template
@@ -68,13 +63,10 @@ export class SentryCli {
 
   public dumpConfig(config: SentryCliConfig): string {
     const dumpedSections: string[] = [];
-    for (const sectionName in config) {
-      // eslint-disable-next-line no-prototype-builtins
-      if (config.hasOwnProperty(sectionName)) {
-        const props = this.dumpProperties(config[sectionName]);
-        const section = `[${sectionName}]\n${props}`;
-        dumpedSections.push(section);
-      }
+    for (const [sectionName, val] of Object.entries(config)) {
+      const props = this.dumpProperties(val);
+      const section = `[${sectionName}]\n${props}`;
+      dumpedSections.push(section);
     }
     return dumpedSections.join('\n');
   }
@@ -127,8 +119,7 @@ export class SentryCli {
 
     await addToGitignore(
       SENTRYCLIRC_FILENAME,
-      `⚠ Could not add ${SENTRYCLIRC_FILENAME} to ${GITIGNORE_FILENAME}, ` +
-        'please add it to not commit your auth key.',
+      `⚠ Could not add ${SENTRYCLIRC_FILENAME} to ${GITIGNORE_FILENAME}, please add it to not commit your auth key.`,
     );
 
     try {

package/lib/Helper/Wizard.ts

@@ -1,5 +1,4 @@
 import type { Answers } from 'inquirer';
-import * as _ from 'lodash';
 
 import type { Args } from '../Constants';
 import type { IStep } from '../Steps/BaseStep';
@@ -24,7 +23,7 @@ function sanitizeAndValidateArgs(argv: Args): void {
 }
 
 export function getCurrentIntegration(answers: Answers): BaseIntegration {
-  return _.get(answers, 'integration') as BaseIntegration;
+  return answers.integration as BaseIntegration;
 }
 
 export async function startWizard<M extends IStep>(

package/lib/Setup.ts

@@ -1,4 +1,3 @@
-import * as _ from 'lodash';
 import { enableDebugLogs } from '../src/utils/debug';
 
 import { readEnvironment } from './Helper/Env';
@@ -21,21 +20,21 @@ export async function run(argv: any): Promise<any> {
   if (args.uninstall === undefined) {
     args.uninstall = false;
   }
-  let steps = [
+  const steps = [
     Step.Initial,
     Step.Welcome,
     Step.ChooseIntegration,
     Step.ShouldConfigure,
   ];
   if (args.uninstall === false) {
-    steps = _.concat(
-      steps,
+    steps.push(
       Step.OpenSentry,
       Step.WaitForSentry,
       Step.SentryProjectSelector,
       Step.PromptForParameters,
     );
   }
-  steps = _.concat(steps, Step.ConfigureProject, Step.Result);
+  steps.push(Step.ConfigureProject, Step.Result);
+
   return startWizard(args, ...steps);
 }

package/lib/Steps/ChooseIntegration.ts

@@ -1,25 +1,55 @@
 import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
 
+import { readFileSync } from 'node:fs';
+import { hasPackageInstalled } from '../../src/utils/package-json';
 import {
   Args,
   DEFAULT_URL,
   getIntegrationChoices,
   Integration,
 } from '../Constants';
+import { dim, red } from '../Helper/Logging';
 import { BaseStep } from './BaseStep';
 import { Cordova } from './Integrations/Cordova';
 import { Electron } from './Integrations/Electron';
-import { hasPackageInstalled } from '../../src/utils/package-json';
-import { dim } from '../Helper/Logging';
 
-let projectPackage: any = {};
+function getProjectPackage(): Record<string, unknown> {
+  let projectPackage: Record<string, unknown> = {};
+
+  const projectPackagePathCandidates = [
+    // If we run directly in setup-wizard
+    '../../package.json',
+
+    // If we run from the CLI
+    `${process.cwd()}/package.json`,
+  ];
+
+  for (const pathCandidate of projectPackagePathCandidates) {
+    let data: string;
+    try {
+      data = readFileSync(pathCandidate, 'utf-8');
+    } catch (error) {
+      // If the file does not exist, continue to the next candidate
+      continue;
+    }
 
-try {
-  // If we run directly in setup-wizard
-  projectPackage = require('../../package.json');
-} catch {
-  projectPackage = require(`${process.cwd()}/package.json`);
+    try {
+      projectPackage = JSON.parse(data) as Record<string, unknown>;
+      break;
+    } catch (error) {
+      // If the file exists but is not valid JSON, log an error and continue.
+      // Note: we don't want to crash the wizard if the package.json is invalid,
+      // because it is only use by the integration detection logic.
+      // Furthmore other package managers, i.e. bun, allow JSON-with-comments which might
+      // throw errors with JSON.parse, and will require a different JSON parser in the future.
+      red(
+        `Failed to parse JSON from ${pathCandidate}, is your file a valid package.json?`,
+      );
+    }
+  }
+
+  return projectPackage;
 }
 
 type IntegrationPromptAnswer = {
@@ -44,6 +74,8 @@ export class ChooseIntegration extends BaseStep {
   }
 
   public tryDetectingIntegration(): Integration | undefined {
+    const projectPackage = getProjectPackage();
+
     if (hasPackageInstalled('react-native', projectPackage)) {
       return Integration.reactNative;
     }

package/lib/Steps/Initial.ts

@@ -1,44 +1,35 @@
 import type { Answers } from 'inquirer';
-import * as _ from 'lodash';
-import * as path from 'path';
+import { join, dirname } from 'node:path';
 
 import { dim } from '../Helper/Logging';
 import { BaseStep } from './BaseStep';
+import { readFileSync } from 'node:fs';
 
-let wizardPackage: any = {};
-let sentryCliPackage: any = {};
+type PackageJSON = { version?: string };
+let wizardPackage: PackageJSON = {};
 
 try {
-  wizardPackage = require(path.join(
-    path.dirname(require.resolve('@sentry/wizard')),
-    '..',
-    'package.json',
-  ));
+  wizardPackage = process.env.npm_package_version
+    ? { version: process.env.npm_package_version }
+    : (JSON.parse(
+        readFileSync(
+          join(
+            dirname(require.resolve('@sentry/wizard')),
+            '..',
+            'package.json',
+          ),
+          'utf-8',
+        ),
+      ) as PackageJSON);
 } catch {
   // We don't need to have this
 }
 
-try {
-  sentryCliPackage = require(path.join(
-    path.dirname(require.resolve('@sentry/cli')),
-    '..',
-    'package.json',
-  ));
-} catch {
-  // We don't need to have tahis
-}
-
 export class Initial extends BaseStep {
   // eslint-disable-next-line @typescript-eslint/require-await
   public async emit(_answers: Answers): Promise<Answers> {
     dim('Running Sentry Wizard...');
-    dim(
-      `version: ${_.get(
-        wizardPackage,
-        'version',
-        'DEV',
-      )} | sentry-cli version: ${_.get(sentryCliPackage, 'version', 'DEV')}`,
-    );
+    dim(`version: ${wizardPackage.version ?? 'DEV'}`);
     return {};
   }
 }

package/lib/Steps/Integrations/BaseIntegration.ts

@@ -1,5 +1,4 @@
 import type { Answers } from 'inquirer';
-import * as _ from 'lodash';
 
 import type { Args } from '../../Constants';
 import { BaseStep } from '../BaseStep';
@@ -34,13 +33,8 @@ export abstract class BaseIntegration extends BaseStep {
   }
 
   public async shouldEmit(_answers: Answers): Promise<boolean> {
-    return (
-      _.keys(
-        _.pickBy(
-          await this.shouldConfigure(_answers),
-          (active: boolean) => active,
-        ),
-      ).length > 0
+    return Object.values(await this.shouldConfigure(_answers)).some(
+      (active: boolean) => active,
     );
   }
 

package/lib/Steps/Integrations/Cordova.ts

@@ -1,6 +1,6 @@
-import * as fs from 'fs';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 import type { Answers } from 'inquirer';
-import * as path from 'path';
 
 import type { Args } from '../../Constants';
 import { exists, matchesContent, patchMatchingFile } from '../../Helper/File';
@@ -8,7 +8,8 @@ import { green } from '../../Helper/Logging';
 import { SentryCli } from '../../Helper/SentryCli';
 import { BaseIntegration } from './BaseIntegration';
 
-const xcode = require('xcode');
+import xcode from 'xcode';
+import type { PBXShellScriptBuildPhase } from 'xcode';
 
 export class Cordova extends BaseIntegration {
   protected _sentryCli: SentryCli;
@@ -142,18 +143,11 @@ export class Cordova extends BaseIntegration {
         }
 
         const buildScripts = [];
-        for (const key in proj.hash.project.objects.PBXShellScriptBuildPhase ||
-          {}) {
-          if (
-            // eslint-disable-next-line no-prototype-builtins
-            proj.hash.project.objects.PBXShellScriptBuildPhase.hasOwnProperty(
-              key,
-            )
-          ) {
-            const val = proj.hash.project.objects.PBXShellScriptBuildPhase[key];
-            if (val.isa) {
-              buildScripts.push(val);
-            }
+        for (const val of Object.values(
+          proj.hash.project.objects.PBXShellScriptBuildPhase || {},
+        )) {
+          if ((val as PBXShellScriptBuildPhase).isa) {
+            buildScripts.push(val);
           }
         }