@sentry/wizard 3.42.1 → 4.0.0

package/lib/Steps/Integrations/Electron.ts

@@ -1,8 +1,7 @@
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
-import * as _ from 'lodash';
-import * as path from 'path';
+import * as path from 'node:path';
 
 import type { Args } from '../../Constants';
 import { dim, green, l, nl, red } from '../../Helper/Logging';
@@ -31,7 +30,11 @@ const Sentry = require('@sentry/electron/renderer');
 
 Sentry.init({});`;
 
-let appPackage: any = {};
+type PackageJSON = {
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+};
+let appPackage: PackageJSON = {};
 
 function printExample(example: string, title = ''): void {
   if (title) {
@@ -44,7 +47,9 @@ function printExample(example: string, title = ''): void {
 }
 
 try {
-  appPackage = require(path.join(process.cwd(), 'package.json'));
+  appPackage = JSON.parse(
+    fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
+  ) as PackageJSON;
 } catch {
   // We don't need to have this
 }
@@ -59,7 +64,7 @@ export class Electron extends BaseIntegration {
 
   // eslint-disable-next-line @typescript-eslint/require-await
   public async emit(answers: Answers): Promise<Answers> {
-    const dsn = _.get(answers, ['config', 'dsn', 'public'], null);
+    const dsn = answers.config?.dsn?.public ?? null;
     nl();
 
     const sentryCliProps = this._sentryCli.convertAnswersToProperties(answers);
@@ -112,7 +117,7 @@ export class Electron extends BaseIntegration {
 
     nl();
 
-    if (!_.get(continued, 'continue', false)) {
+    if (!continued?.continue) {
       throw new Error('Please install the required dependencies to continue.');
     }
 
@@ -123,25 +128,23 @@ export class Electron extends BaseIntegration {
 
   private _checkDep(packageName: string, minVersion?: string): boolean {
     const depVersion = parseInt(
-      _.get(appPackage, ['dependencies', packageName], '0').replace(/\D+/g, ''),
+      (appPackage.dependencies?.[packageName] || '0').replace(/\D+/g, ''),
       10,
     );
     const devDepVersion = parseInt(
-      _.get(appPackage, ['devDependencies', packageName], '0').replace(
-        /\D+/g,
-        '',
-      ),
+      (appPackage.devDependencies?.[packageName] || '0').replace(/\D+/g, ''),
       10,
     );
 
     if (
-      !_.get(appPackage, `dependencies.${packageName}`, false) &&
-      !_.get(appPackage, `devDependencies.${packageName}`, false)
+      !appPackage.dependencies?.[packageName] &&
+      !appPackage.devDependencies?.[packageName]
     ) {
       red(`✗ ${packageName} isn't in your dependencies`);
       red('  please install it with yarn/npm');
       return false;
-    } else if (
+    }
+    if (
       minVersion &&
       depVersion < MIN_ELECTRON_VERSION &&
       devDepVersion < MIN_ELECTRON_VERSION
@@ -150,12 +153,12 @@ export class Electron extends BaseIntegration {
         `✗ Your installed version of ${packageName} is to old, >${MIN_ELECTRON_VERSION_STRING} needed`,
       );
       return false;
+    }
+    if (minVersion) {
+      green(`✓ ${packageName} > ${minVersion} is installed`);
     } else {
-      // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-      minVersion
-        ? green(`✓ ${packageName} > ${minVersion} is installed`)
-        : green(`✓ ${packageName} is installed`);
-      return true;
+      green(`✓ ${packageName} is installed`);
     }
+    return true;
   }
 }

package/lib/Steps/Integrations/MobileProject.ts

@@ -1,6 +1,5 @@
 import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
-import * as _ from 'lodash';
 
 import { getPlatformChoices, Platform } from '../../Constants';
 import { dim } from '../../Helper/Logging';
@@ -10,19 +9,24 @@ export abstract class MobileProject extends BaseIntegration {
   protected _platforms: Platform[];
 
   public getPlatforms(answers: Answers): string[] {
-    if (!_.has(answers, 'shouldConfigurePlatforms')) {
+    if (!answers.shouldConfigurePlatforms) {
       throw new Error('No platform selected');
     }
-    const shouldConfigurePlatforms = _.get(answers, 'shouldConfigurePlatforms');
-    return _.keys(
-      _.pickBy(shouldConfigurePlatforms, (active: boolean) => active),
-    );
+    const shouldConfigurePlatforms =
+      answers.shouldConfigurePlatforms as Partial<Record<Platform, boolean>>;
+    return Object.entries(shouldConfigurePlatforms)
+      .filter((pair) => pair[1])
+      .map((pair) => pair[0]); // only return the keys
   }
 
   public async shouldConfigure(answers: Answers): Promise<Answers> {
-    if (_.get(answers, 'shouldConfigurePlatforms')) {
-      return _.get(answers, 'shouldConfigurePlatforms');
+    let { shouldConfigurePlatforms } = answers as {
+      shouldConfigurePlatforms?: Partial<Record<Platform, boolean>>;
+    };
+    if (shouldConfigurePlatforms) {
+      return { shouldConfigurePlatforms };
     }
+
     const isPlatformSet =
       this._argv.platform &&
       Array.isArray(this._argv.platform) &&
@@ -32,20 +36,19 @@ export abstract class MobileProject extends BaseIntegration {
       ? this._argv.platform
       : (await this._platformSelector()).platform;
 
-    const shouldConfigurePlatforms: any = {};
+    shouldConfigurePlatforms = {};
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    _.keys(Platform).forEach(async (platform: Platform) => {
-      shouldConfigurePlatforms[platform] =
-        _.indexOf(this._platforms, platform) >= 0
-          ? await this._shouldConfigurePlatform(platform)
-          : false;
+    for (const platform of Object.values(Platform)) {
+      shouldConfigurePlatforms[platform] = this._platforms.includes(platform)
+        ? await this._shouldConfigurePlatform(platform)
+        : false;
       if (
         shouldConfigurePlatforms[platform] === false &&
         this._argv.uninstall === false
       ) {
         dim(`will not configure ${platform}`);
       }
-    });
+    }
     return { shouldConfigurePlatforms };
   }
 

package/lib/Steps/OpenSentry.ts

@@ -1,5 +1,5 @@
+import { URL } from 'node:url';
 import type { Answers } from 'inquirer';
-import { URL } from 'url';
 
 import { mapIntegrationToPlatform } from '../Constants';
 import { BottomBar } from '../Helper/BottomBar';
@@ -7,8 +7,7 @@ import { dim, green, l, nl, red } from '../Helper/Logging';
 import { getCurrentIntegration } from '../Helper/Wizard';
 import { BaseStep } from './BaseStep';
 
-const opn = require('opn');
-const r2 = require('r2');
+import opn from 'opn';
 
 export class OpenSentry extends BaseStep {
   public async emit(answers: Answers): Promise<Answers> {
@@ -27,7 +26,13 @@ export class OpenSentry extends BaseStep {
     this.debug(`Loading wizard for ${baseUrl}`);
 
     try {
-      const data = await r2.get(`${baseUrl}api/0/wizard/`).json;
+      const response = await fetch(`${baseUrl}api/0/wizard/`);
+      if (!response.ok) {
+        throw new Error(
+          `Failed to connect to Sentry: ${response.status} ${response.statusText}`,
+        );
+      }
+      const data = (await response.json()) as { hash: string };
 
       BottomBar.hide();
 
@@ -48,9 +53,9 @@ export class OpenSentry extends BaseStep {
 
       const urlToOpen = urlObj.toString();
 
-      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);
 
       nl();
       l('Please open');

package/lib/Steps/PromptForParameters.ts

@@ -1,6 +1,5 @@
 import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
-import * as _ from 'lodash';
 
 import { dim } from '../Helper/Logging';
 import { getCurrentIntegration } from '../Helper/Wizard';
@@ -80,12 +79,13 @@ export class PromptForParameters extends BaseStep {
     ]);
 
     return {
-      config: _.merge(_.get(answers, 'config'), {
+      config: {
+        ...answers.config,
         auth,
         dsn,
         project,
         organization,
-      }),
+      },
     };
   }
 
@@ -95,26 +95,19 @@ export class PromptForParameters extends BaseStep {
     projectSlug?: string,
   ): string {
     const baseUrl = this._argv.url;
-    const orgSlug = _.get(
-      answers,
-      'config.organization.slug',
-      organizationSlug || 'organization_slug',
-    );
-    const projSlug = _.get(
-      answers,
-      'config.project.slug',
-      projectSlug || 'project_slug',
-    );
+    const orgSlug =
+      answers.config?.organization?.slug ??
+      organizationSlug ??
+      'organization_slug';
+    const projSlug =
+      answers.config?.project?.slug ?? projectSlug ?? 'project_slug';
     return `${baseUrl}${orgSlug}/${projSlug}`;
   }
 
   private _getDSNKeyUrl(answers: Answers, projectSlug?: string): string {
     const baseUrl = this._argv.url;
-    const projSlug = _.get(
-      answers,
-      'config.project.slug',
-      projectSlug || 'project_slug',
-    );
+    const projSlug =
+      answers.config?.project?.slug ?? projectSlug ?? 'project_slug';
     return `${baseUrl}settings/projects/${projSlug}/keys`;
   }
 
@@ -123,7 +116,7 @@ export class PromptForParameters extends BaseStep {
     configKey: string,
     preHook?: () => void,
   ): boolean {
-    const shouldAsk = _.get(answers, configKey, null) === null;
+    const shouldAsk = answers[configKey] != null;
     if (shouldAsk && preHook) {
       preHook();
     }

package/lib/Steps/SentryProjectSelector.ts

@@ -1,9 +1,23 @@
 import type { Answers } from 'inquirer';
 import { prompt } from 'inquirer';
-import * as _ from 'lodash';
 
 import { BaseStep } from './BaseStep';
 
+type Project = {
+  id: string;
+  slug: string;
+  organization?: {
+    name: string;
+    slug: string;
+  };
+  keys: {
+    dsn: {
+      public: string;
+      private: string;
+    };
+  }[];
+};
+
 function sleep(n: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, n));
 }
@@ -12,23 +26,22 @@ export class SentryProjectSelector extends BaseStep {
   public async emit(answers: Answers): Promise<any> {
     this.debug(answers);
 
-    if (!_.has(answers, 'wizard')) {
+    if (!answers.wizard) {
       // we skip this completely because the wizard wasn't running
       return {};
     }
 
-    if (
-      _.has(answers, 'wizard.projects') &&
-      answers.wizard.projects.length === 0
-    ) {
+    if (!answers.wizard.projects || answers.wizard.projects.length === 0) {
       throw new Error(
         'No Projects found. Please create a new Project in Sentry and try again.',
       );
     }
 
-    let selectedProject = null;
+    let selectedProject: { selectedProject: Project } | null = null;
     if (answers.wizard.projects.length === 1) {
-      selectedProject = { selectedProject: answers.wizard.projects[0] };
+      selectedProject = {
+        selectedProject: answers.wizard.projects[0] as Project,
+      };
       // the wizard CLI closes too quickly when we skip the prompt
       // as it will cause the UI to be stuck saying Waiting for wizard to connect
       await sleep(1000);
@@ -47,34 +60,22 @@ export class SentryProjectSelector extends BaseStep {
         },
       ]);
     }
-
+    const dsn = selectedProject?.selectedProject.keys[0]?.dsn ?? {
+      public: null,
+      private: null,
+    };
     return {
       config: {
         auth: {
-          token: _.get(answers, 'wizard.apiKeys.token', null),
-        },
-        dsn: {
-          public: _.get(
-            selectedProject,
-            'selectedProject.keys.0.dsn.public',
-            null,
-          ),
-          secret: _.get(
-            selectedProject,
-            'selectedProject.keys.0.dsn.secret',
-            null,
-          ),
+          token: answers.wizard.apiKeys?.token ?? null,
         },
+        dsn,
         organization: {
-          slug: _.get(
-            selectedProject,
-            'selectedProject.organization.slug',
-            null,
-          ),
+          slug: selectedProject?.selectedProject.organization?.slug ?? null,
         },
         project: {
-          id: _.get(selectedProject, 'selectedProject.id', null),
-          slug: _.get(selectedProject, 'selectedProject.slug', null),
+          id: selectedProject?.selectedProject.id ?? null,
+          slug: selectedProject?.selectedProject.slug ?? null,
         },
       },
     };

package/lib/Steps/WaitForSentry.ts

@@ -4,8 +4,6 @@ import { BottomBar } from '../Helper/BottomBar';
 import { getCurrentIntegration } from '../Helper/Wizard';
 import { BaseStep } from './BaseStep';
 
-const r2 = require('r2');
-
 export class WaitForSentry extends BaseStep {
   public async emit(answers: Answers): Promise<Answers> {
     if (!(await getCurrentIntegration(answers).shouldEmit(answers))) {
@@ -15,36 +13,44 @@ export class WaitForSentry extends BaseStep {
       return {};
     }
 
-    // eslint-disable-next-line no-async-promise-executor
+    if (!answers.hash) {
+      throw new Error(`No wizard hash found ${answers}`);
+    }
+
     return new Promise((resolve, _reject) => {
       this.debug(answers);
 
       BottomBar.show('Waiting for Sentry...');
       const baseUrl = this._argv.url;
 
-      const polling = async (): Promise<void> => {
-        try {
-          this.debug(`Polling: ${baseUrl}api/0/wizard/${answers.hash}/`);
-          const response = await r2.get(
-            `${baseUrl}api/0/wizard/${answers.hash}/`,
-          ).response;
-          this.debug('Polling received data');
-          if (response.status !== 200) {
-            throw new Error(`Received status ${response.status}`);
-          }
-          const data = await response.json();
-          // Delete the wizard hash since we were able to fetch the data
-          await r2.delete(`${baseUrl}api/0/wizard/${answers.hash}/`);
-          BottomBar.hide();
-          this.debug('Polling Success!');
-          resolve({ wizard: data });
-        } catch (e) {
+      const pingSentry = async (): Promise<void> => {
+        const response = await fetch(`${baseUrl}api/0/wizard/${answers.hash}/`);
+        this.debug('Polling received data');
+        if (!response.ok) {
+          throw new Error(
+            `Received status ${response.status} ${response.statusText}`,
+          );
+        }
+        const data = await response.json();
+        // Delete the wizard hash since we were able to fetch the data
+        await fetch(`${baseUrl}api/0/wizard/${answers.hash}/`, {
+          method: 'DELETE',
+        });
+        BottomBar.hide();
+        this.debug('Polling Success!');
+        resolve({ wizard: data });
+      };
+
+      const poll = (): void => {
+        this.debug(`Polling: ${baseUrl}api/0/wizard/${answers.hash}/`);
+        pingSentry().catch((e) => {
           this.debug('Polling received:');
           this.debug(e);
-          setTimeout(polling.bind(this), 1000);
-        }
+          setTimeout(poll, 1000);
+        });
       };
-      polling.bind(this)();
+
+      poll();
     });
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/wizard",
-  "version": "3.42.1",
+  "version": "4.0.0",
   "homepage": "https://github.com/getsentry/sentry-wizard",
   "repository": "https://github.com/getsentry/sentry-wizard",
   "description": "Sentry wizard helping you to configure your project",
@@ -25,16 +25,13 @@
   "dependencies": {
     "@clack/core": "^0.3.4",
     "@clack/prompts": "0.7.0",
-    "@sentry/cli": "^1.77.3",
     "@sentry/node": "^7.119.2",
     "axios": "1.7.4",
     "chalk": "^2.4.1",
     "glob": "9.3.5",
     "inquirer": "^6.2.0",
-    "lodash": "^4.17.15",
     "magicast": "^0.2.10",
     "opn": "^5.4.0",
-    "r2": "^2.0.1",
     "read-env": "^1.3.0",
     "recast": "^0.23.3",
     "semver": "^7.5.3",
@@ -43,13 +40,15 @@
     "yargs": "^16.2.0"
   },
   "devDependencies": {
+    "@babel/types": "~7.21.4",
     "@sentry-internal/eslint-config-sdk": "^7.48.0",
     "@types/chai": "^4.3.17",
     "@types/glob": "^7.2.0",
     "@types/inquirer": "^0.0.43",
     "@types/jest": "^29.5.0",
     "@types/lodash": "^4.14.144",
-    "@types/node": "^10.11.0",
+    "@types/node": "^18.19.76",
+    "@types/opn": "5.1.0",
     "@types/rimraf": "^3.0.2",
     "@types/semver": "^7.3.7",
     "@types/yargs": "^16.0.9",
@@ -59,6 +58,7 @@
     "eslint": "^8.18.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-jest": "^25.3.0",
+    "fossilize": "^0.3.1",
     "jest": "^29.5.0",
     "prettier": "^2.8.7",
     "rimraf": "^3.0.2",
@@ -67,8 +67,11 @@
     "tsx": "^3.14.0",
     "typescript": "^5.0.4"
   },
+  "resolutions": {
+    "simple-plist": "1.4.0-0"
+  },
   "engines": {
-    "node": ">=14.18.0",
+    "node": ">=18.20.6",
     "npm": ">=3.10.7",
     "yarn": ">=1.0.2"
   },
@@ -86,6 +89,7 @@
     "fix:eslint": "eslint . --format stylish --fix",
     "test": "yarn build && jest",
     "test:e2e": "yarn build && ./e2e-tests/run.sh",
+    "test:e2e:bin": "chmod +x ./dist-bin/* && SENTRY_WIZARD_E2E_TEST_BIN=1 ./e2e-tests/run.sh",
     "try": "ts-node bin.ts",
     "try:uninstall": "ts-node bin.ts --uninstall",
     "test:watch": "jest --watch"
@@ -107,7 +111,7 @@
       "json"
     ],
     "modulePathIgnorePatterns": [
-      "<rootDir>/dist/__mocks__"
+      "<rootDir>/dist/"
     ],
     "testPathIgnorePatterns": [
       "/dist/",
@@ -121,7 +125,7 @@
   "author": "Sentry",
   "license": "MIT",
   "volta": {
-    "node": "14.18.3",
+    "node": "18.20.6",
     "yarn": "1.22.19"
   },
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"

package/src/apple/xcode-manager.ts

@@ -4,20 +4,20 @@
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 // @ts-ignore - clack is ESM and TS complains about that. It works though
 import clack from '@clack/prompts';
-import * as fs from 'fs';
-import * as path from 'path';
-import { SentryProjectData } from '../utils/types';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import type { SentryProjectData } from '../utils/types';
 import * as templates from './templates';
 
 import {
   project as createXcodeProject,
-  PBXBuildFile,
-  PBXGroup,
-  PBXNativeTarget,
-  PBXObjects,
-  PBXSourcesBuildPhase,
-  Project,
-  XCConfigurationList,
+  type PBXBuildFile,
+  type PBXGroup,
+  type PBXNativeTarget,
+  type PBXObjects,
+  type PBXSourcesBuildPhase,
+  type Project,
+  type XCConfigurationList,
 } from 'xcode';
 
 interface ProjectFile {

package/src/nextjs/templates.ts

@@ -501,8 +501,8 @@ export default function GlobalError(${chalk.green(
   );
 }
 `;
-  } else {
-    return `"use client";
+  }
+  return `"use client";
 
 ${chalk.green('import * as Sentry from "@sentry/nextjs";')}
 ${chalk.green('import Error from "next/error";')}
@@ -522,5 +522,4 @@ export default function GlobalError(${chalk.green('{ error }')}) {
   );
 }
 `;
-  }
 }

package/src/nuxt/sdk-setup.ts

@@ -1,19 +1,16 @@
+import fs from 'node:fs';
+import path from 'node:path';
 // @ts-expect-error - clack is ESM and TS complains about that. It works though
 import * as clack from '@clack/prompts';
 import * as Sentry from '@sentry/node';
 import chalk from 'chalk';
-import fs from 'fs';
 // @ts-expect-error - magicast is ESM and TS complains about that. It works though
-import { loadFile, generateCode } from 'magicast';
+import { generateCode, loadFile } from 'magicast';
 // @ts-expect-error - magicast is ESM and TS complains about that. It works though
 import { addNuxtModule } from 'magicast/helpers';
-import path from 'path';
-import {
-  getConfigBody,
-  getDefaultNuxtConfig,
-  getNuxtModuleFallbackTemplate,
-  getSentryConfigContents,
-} from './templates';
+import opn from 'opn';
+import { type SemVer, lt } from 'semver';
+import { traceStep } from '../telemetry';
 import {
   abortIfCancelled,
   askShouldAddPackageOverride,
@@ -21,13 +18,19 @@ import {
   featureSelectionPrompt,
   installPackage,
   isUsingTypeScript,
-  opn,
 } from '../utils/clack-utils';
-import { traceStep } from '../telemetry';
-import { lt, SemVer } from 'semver';
-import { PackageManager, PNPM } from '../utils/package-manager';
-import { hasPackageInstalled, PackageDotJson } from '../utils/package-json';
-import { deploymentPlatforms, DeploymentPlatform } from './types';
+import {
+  type PackageDotJson,
+  hasPackageInstalled,
+} from '../utils/package-json';
+import { PNPM, type PackageManager } from '../utils/package-manager';
+import {
+  getConfigBody,
+  getDefaultNuxtConfig,
+  getNuxtModuleFallbackTemplate,
+  getSentryConfigContents,
+} from './templates';
+import { type DeploymentPlatform, deploymentPlatforms } from './types';
 
 const possibleNuxtConfig = [
   'nuxt.config.js',
@@ -342,8 +345,8 @@ export async function confirmReadImportDocs(
   Sentry.setTag('init-with-import-docs-opened', shouldOpenDocs);
 
   if (shouldOpenDocs) {
-    opn(docsUrl, { 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(docsUrl, { wait: false }).then((cp) => cp.on('error', noop), noop);
   }
 }

package/src/react-native/expo-metro.ts

@@ -1,8 +1,8 @@
-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 * as clack from '@clack/prompts';
 // @ts-ignore - magicast is ESM and TS complains about that. It works though
-import { ProxifiedModule } from 'magicast';
+import type { ProxifiedModule } from 'magicast';
 import chalk from 'chalk';
 import * as Sentry from '@sentry/node';